geocaching 0.5.0 → 0.6.0

data/lib/geocaching/version.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Geocaching
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/geocaching/watchlist.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+module Geocaching
+  # The {Watchlist} class provides access to the user’s watchlist.
+  #
+  # This method does caching.  That means that multiple calls to, for example,
+  # the {#caches} method do only one HTTP request.  If you want to override
+  # the cached information, call the {#fetch} method manually.  Note that this
+  # only applies to instances of this class, so a HTTP request is made for
+  # every call of the {caches} class method.
+  class Watchlist
+    # Creates a new instance of this class and calls the {#caches} method.
+    #
+    # @return [Array<Geocaching::Cache>]
+    def self.caches
+      new.caches
+    end
+
+    # Returns an array of caches the user has on its watchlist.
+    #
+    # @return [Array<Geocaching::Cache>]
+    def caches
+      @caches ||= begin
+        caches = []
+        fetch unless fetched?
+
+        @doc.search("table.Table > tbody > tr").each do |row|
+          if info = extract_info_from_row(row) and info.size == 3
+            cache = Cache.new \
+              :guid => info[:cache_guid],
+              :name => info[:cache_name],
+              :type => info[:cache_type]
+            caches << cache
+          end
+        end
+
+        caches
+      end
+    end
+
+    # Fetches information from geocaching.com.  Usually, you only call this
+    # method manually if you want to override the cached information.
+    #
+    # @return [void]
+    def fetch
+      unless HTTP.loggedin?
+        raise LoginError, "You need to be logged in to access your watchlist"
+      end
+
+      resp, @data = HTTP.get(path)
+      @doc = Nokogiri::HTML.parse(@data)
+    end
+
+    # Returns whether watchlist information have successfully been fetched
+    # from geocaching.com.
+    #
+    # @return [Boolean] Have watchlist information been fetched?
+    def fetched?
+      @data and @doc
+    end
+
+  private
+
+    # Returns the HTTP request path.
+    #
+    # @return [String] HTTP request path
+    def path
+      "/my/watchlist.aspx"
+    end
+
+    # Returns the information from a HTML table row node.
+    #
+    # @return [Hash] Extracted information
+    def extract_info_from_row(row)
+      info = {}
+
+      # Cache GUID
+      elements = row.search("td:nth-child(3) a")
+      if elements.size == 1
+        url = elements.first["href"]
+        if url and url =~ /guid=([a-f0-9-]{36})/
+          info[:cache_guid] = $1
+        end
+      end
+
+      # Cache type
+      elements = row.search("td:nth-child(2) > img")
+      if elements.size == 1
+        if title = elements.first["alt"]
+          if type = CacheType.for_title(title)
+            info[:cache_type] = type
+          end
+        end
+      end
+
+      # Cache name
+      elements = row.search("td:nth-child(3) a")
+      if elements.size == 1
+        name = elements.first.text
+        info[:cache_name] = name.strip if name
+      end
+
+      info
+    end
+  end
+end

data/spec/cache/ape.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 7d120ae2-855c-430d-9c14-3d7427de4bdd (Project A.
     @cache.code.should == "GC1169"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 4457
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Mission 9: Tunnel of Light"
   end

data/spec/cache/cito.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for c52ff346-4567-4865-a230-c136843049e5 (CITO)" do
     @cache.code.should == "GC1W95B"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1325573
+  end
+
   it "should return the correct name" do
     @cache.name.should == "1. Dresdner CITO"
   end

data/spec/cache/earthcache.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for e34a5b69-51a1-4ed4-838d-e3c3cb75a35a (EarthCache
     @cache.code.should == "GC26Y3T"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1642655
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Kniepsand Amrum (Earthcache)"
   end

data/spec/cache/event.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 6cea30b1-7279-43ac-86a8-cdfd1daeb348 (Event)" do
     @cache.code.should == "GC211KT"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1467288
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Weihnachtliches Vorglühen"
   end

data/spec/cache/letterbox.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 01328a57-5a04-4e69-a1cc-ce0eeaa452f5 (Letterbox)
     @cache.code.should == "GC1KBJD"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1089572
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Worzeldorfer Gebirge (Letterbox)"
   end

data/spec/cache/lfevent.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 32512f3a-0fc2-45df-943b-af0a6f17f1fa (Lost and F
     @cache.code.should == "GC2546Y"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1588936
+  end
+
   it "should return the correct name" do
     @cache.name.should == "10 Jahre! Nürnberg, Germany"
   end

data/spec/cache/locationless.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 9ce22167-5a8d-451c-a69b-b19d5ec4f578 (Locationle
     @cache.code.should == "GCB48F"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 46223
+  end
+
   it "should return the correct name" do
     @cache.name.should == "die letzte ihrer art?"
   end

data/spec/cache/megaevent.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for b60781d0-0933-426d-9a67-80eb855e87ef (Mega Event
     @cache.code.should == "GC1XEDZ"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1360436
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Pinzgau 2010"
   end

data/spec/cache/multi.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 07cfab08-dadb-4a8f-a187-2a63404b4d3c (Multi)" do
     @cache.code.should == "GC1V1RH"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1288689
+  end
+
   it "should return the correct name" do
     @cache.name.should == "D1 - Plan-les-Ouates - le défi"
   end

data/spec/cache/mystery.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 1d86cace-bada-435a-817a-f841718d7754 (Mystery)"
     @cache.code.should == "GC21BBB"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 1476636
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Nordstadt-Matrix"
   end

data/spec/cache/traditional.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 66274935-40d5-43d8-8cc3-c819e38f9dcc (Traditiona
     @cache.code.should == "GCF00"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 3840
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Bridge Over Troubled Waters"
   end

data/spec/cache/virtual.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 4e8b79e1-ffb2-4845-9c24-5ef54137a9b9 (Virtual)"
     @cache.code.should == "GCEB74"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 60276
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Buecherturm"
   end

data/spec/cache/webcam.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 8cd0976c-42cf-40a2-ae02-ed87ad52d5b1 (Webcam)" d
     @cache.code.should == "GCQG38"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 289550
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Versteckte Kamera"
   end

data/spec/cache/wherigo.rb

@@ -9,6 +9,10 @@ describe "Geocaching::Cache for 6128b8a1-2ed3-48f0-9e05-a7117c5faffc (Wherigo)"
     @cache.code.should == "GC19RVP"
   end
 
+  it "should return the correct ID" do
+    @cache.id.should == 804412
+  end
+
   it "should return the correct name" do
     @cache.name.should == "Pegnitztal"
   end

data/spec/cache_spec.rb

@@ -6,7 +6,13 @@ dir = File.dirname(__FILE__)
 require "geocaching"
 require "#{dir}/helper"
 
-Geocaching::CacheType::TYPES.to_a.map { |a| a[0].to_s }.each do |type|
+if ENV["GC_CACHE_TYPES"]
+  types = ENV["GC_CACHE_TYPES"].split
+else
+  types = Geocaching::CacheType::TYPES.to_a.map { |a| a[0].to_s }
+end
+
+types.each do |type|
   # Locationless caches have completely been disabled on geocaching.com
   next if type == "locationless"
 

data/spec/log/announcement.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 37ef1827-17a6-436c-b8a1-01f1573186f3 (Announcement
   end
 
   it "should return the correct username" do
-    @log.username.should == "Frank Frank"
+    @log.user.name.should == "Frank Frank"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/archive.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 48a90293-e589-4690-bdcc-de0043d79b6d (Archive)" do
   end
 
   it "should return the correct username" do
-    @log.username.should == "jonny42"
+    @log.user.name.should == "jonny42"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/attended.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 9bf458db-6dc9-4e02-b7ea-9cf056c40ade (Attended)" d
   end
 
   it "should return the correct username" do
-    @log.username.should == "Snooking Good"
+    @log.user.name.should == "Snooking Good"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/coords_update.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 6802b623-f02c-4268-8fb3-7194ea60a686 (Update Coord
   end
 
   it "should return the correct username" do
-    @log.username.should == "Rudisucht"
+    @log.user.name.should == "Rudisucht"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/disable.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 83a3f4f4-7faf-414a-8145-8f334622d20f (Disable List
   end
 
   it "should return the correct username" do
-    @log.username.should == "CacheHasen"
+    @log.user.name.should == "CacheHasen"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/dnf.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 08dab41e-feaf-4f24-a9b5-b87e864f385f (Didn't find
   end
 
   it "should return the correct username" do
-    @log.username.should == "swemil"
+    @log.user.name.should == "swemil"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/enable.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 4e588373-768d-43fb-8cf1-45d2a7d21599 (Enable Listi
   end
 
   it "should return the correct username" do
-    @log.username.should == "Cermak"
+    @log.user.name.should == "Cermak"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/found.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for a3237dec-6931-4221-8f00-5d62923b411a (Found it)" d
   end
 
   it "should return the correct username" do
-    @log.username.should == "CampinCrazy"
+    @log.user.name.should == "CampinCrazy"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/needs_archived.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for d235f46e-cd16-49af-a520-fa52f6c8abf8 (Needs Archiv
   end
 
   it "should return the correct username" do
-    @log.username.should == "Kent_Allard"
+    @log.user.name.should == "Kent_Allard"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/needs_maintenance.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for a572c594-8763-408a-9bec-f29b77a1e50f (Needs Mainte
   end
 
   it "should return the correct username" do
-    @log.username.should == "taroh"
+    @log.user.name.should == "taroh"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/note.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 1eb67c1f-610d-4d1d-9703-10b3e47416e2 (Write Note)"
   end
 
   it "should return the correct username" do
-    @log.username.should == "cache-strapped"
+    @log.user.name.should == "cache-strapped"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/owner_maintenance.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 6eecdf81-3958-4b93-8d63-24f53107f97a (Owner Mainte
   end
 
   it "should return the correct username" do
-    @log.username.should == "pöllö"
+    @log.user.name.should == "pöllö"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/publish.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for d7ae038b-cb26-4b8e-bcca-5effd05870d0 (Publish)" do
   end
 
   it "should return the correct username" do
-    @log.username.should == "geoawareCA"
+    @log.user.name.should == "geoawareCA"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/retract.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 58fa3ddc-6c1a-4ae3-bc19-40009c50a9d5 (Retract List
   end
 
   it "should return the correct username" do
-    @log.username.should == "WGA3"
+    @log.user.name.should == "WGA3"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/reviewer_note.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for 876d4e85-ebe9-4098-8552-151f34d3b4de (Post Reviewe
   end
 
   it "should return the correct username" do
-    @log.username.should == "Prime Reviewer"
+    @log.user.name.should == "Prime Reviewer"
   end
 
   it "should return the correct cache GUID" do

data/spec/log/unarchive.rb

@@ -6,7 +6,7 @@ describe "Geocaching::Log for b70042d7-1411-4f56-950e-d23303e7ab4e (Unarchive)"
   end
 
   it "should return the correct username" do
-    @log.username.should == "Krypton"
+    @log.user.name.should == "Krypton"
   end
 
   it "should return the correct cache GUID" do