Added shortcuts

Author: tomasbedrich

pycaching/geocaching.py

@@ -2,17 +2,19 @@
 
 import logging
 import requests
+from urllib.parse import urljoin
 from mechanicalsoup import Browser
 from bs4 import BeautifulSoup
 from pycaching.cache import Cache, Type, Size
 from pycaching.geo import Point
+from pycaching.trackable import Trackable
 from pycaching.errors import Error, NotLoggedInException, LoginFailedException
 from pycaching.util import parse_date
 
 
 class Geocaching(object):
 
-    _baseurl = "http://www.geocaching.com"
+    _baseurl = "https://www.geocaching.com"
     _urls = {
         "login_page":        "login/default.aspx",
         "search":            "play/search",
@@ -28,8 +30,7 @@ def _request(self, url, *, expect="soup", method="GET", login_check=True, **kwar
         if login_check and self._logged_in is False:
             raise NotLoggedInException("Login is needed.")
 
-        # TODO maybe use urljoin()
-        url = url if "//" in url else "/".join([self._baseurl, url])
+        url = url if "//" in url else urljoin(self._baseurl, url)
 
         try:
             res = self._browser.request(method, url, **kwargs)
@@ -206,3 +207,16 @@ def search_quick(self, area, *, strict=False, zoom=None):
                 else:
                     # can yield more caches (which are not exactly in desired area)
                     yield cache
+
+    # add some shortcuts ensure backwards compatibility
+
+    def geocode(self, location):
+        return Point.from_location(self, location)
+
+    def load_cache(self, wp):
+        """Return a cache by its WP."""
+        return Cache(self, wp)
+
+    def load_trackable(self, tid):
+        """Return a cache by its TID."""
+        return Trackable(self, tid)

test/test_geocaching.py

@@ -4,6 +4,7 @@
 import unittest
 import pycaching
 import itertools
+from geopy.distance import great_circle
 from pycaching import Geocaching, Point, Rectangle
 from pycaching.errors import NotLoggedInException, LoginFailedException, PMOnlyException
 
@@ -105,7 +106,24 @@ def test_logout(self):
         self.assertIsNone(self.g.get_logged_user())
 
 
-class TestPackage(unittest.TestCase):
+class TestShortcuts(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls.g = Geocaching()
+        cls.g.login(_username, _password)
 
     def test_login(self):
         pycaching.login(_username, _password)
+
+    def test_load_cache(self):
+        c = self.g.load_cache("GC4808G")
+        self.assertEqual("Nekonecne ticho", c.name)
+
+    def test_load_trackable(self):
+        t = self.g.load_trackable("TB1KEZ9")
+        self.assertEqual("Lilagul #2: SwedenHawk Geocoin", t.name)
+
+    def test_geocode(self):
+        ref_point = Point(49.74774, 13.37752)
+        self.assertLess(great_circle(self.g.geocode("Pilsen"), ref_point).miles, 10)