geocaching 0.2.3 → 0.3.0

data/README.markdown

@@ -1,10 +1,9 @@
-Ruby library for accessing geocaching.com information
-=====================================================
-
-This Ruby library provides access to cache and log information
-on geocaching.com.  It works by parsing the website’s content as
-Groundspeak does not offer an API yet.
+Ruby API for geocaching.com
+===========================
 
+This Ruby library provides an API for geocaching.com.  As Groundspeak
+doesn’t offer an official API yet, this library parses the website’s
+HTML code.
 
 Example
 -------
@@ -29,7 +28,6 @@ Example
 Altough some cache information are available without being logged in,
 most information will only be accessible after a successful login.
 
-
 Tests
 -----
 

data/geocaching.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name = "geocaching"
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
-  s.summary = "API for geocaching.com"
-  s.description = "A Ruby library that provides an API for information on geocaching.com"
+  s.summary = "Ruby API for geocaching.com"
+  s.description = "A Ruby library that provides an API for geocaching.com"
 
   s.author = "Thomas Cyron"
-  s.email = "nano@fooo.org"
+  s.email = "thomas@thcyron.de"
   s.homepage = "http://nano.github.com/ruby-geocaching"
 
   s.files  = %w(README.markdown Rakefile geocaching.gemspec)

data/lib/geocaching/cache.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require "time"
+
 module Geocaching
   # This class is subclass of Array and is used to store all logs
   # that belong to a cache.  It implements the {#fetch_all} method to
@@ -138,8 +140,13 @@ module Geocaching
       end
     end
 
+    # The cache’s type.
+    #
+    # @return [Geocaching::CacheType] Type
+    # @raise [Geocaching::NotFetchedError] Need to call {#fetch} first
+    # @raise [Geocaching::ExtractError] Could not extract cache type ID from website
     def type
-      CacheType.for_id(type_id)
+      @type ||= CacheType.for_id(type_id)
     end
 
     # The cache’s name.
@@ -211,6 +218,24 @@ module Geocaching
       end
     end
 
+    # The date the event has been held.
+    #
+    # @return [Time] Event date
+    # @raise [Geocaching::NotFetchedError] Need to call {#fetch} first
+    # @raise [Geocaching::ExtractError] Could not extract event date from website
+    def event_date
+      @event_date ||= begin
+        raise NotFetchedError unless fetched?
+        return nil unless [:event, :megaevent, :cito, :lfevent].include?(type.to_sym)
+
+        if @data =~ /<strong>\s*?Event Date:\s*?<\/strong>\s*?\w+, (\d+) (\w+) (\d{4})/
+          Time.parse([$1, $2, $3].join)
+        else
+          raise ExtractError, "Could not extract event date from website"
+        end
+      end
+    end
+
     # The cache’s container size.
     #
     # @return [Symbol] Cache container size
@@ -222,7 +247,7 @@ module Geocaching
         size = nil
 
         if @data =~ /<img src="\/images\/icons\/container\/(.*?)\.gif" alt="Size: .*?" \/>/
-          size = $1.to_sym if %w(micro small regular large other not_chosen).include?($1)
+          size = $1.to_sym if %w(micro small regular large other not_chosen virtual).include?($1)
         end
 
         size || begin
@@ -239,6 +264,7 @@ module Geocaching
     def latitude
       @latitude ||= begin
         raise NotFetchedError unless fetched?
+        return nil if type == :locationless
 
         latitude = nil
         elements = @doc.search("a#ctl00_ContentBody_lnkConversions")
@@ -261,6 +287,7 @@ module Geocaching
     def longitude
       @longitude ||= begin
         raise NotFetchedError unless fetched?
+        return nil if type == :locationless
 
         longitude = nil
         elements = @doc.search("a#ctl00_ContentBody_lnkConversions")
@@ -283,6 +310,7 @@ module Geocaching
     def location
       @location ||= begin
         raise NotFetchedError unless fetched?
+        return nil if type == :locationless
 
         location = nil
         elements = @doc.search("span#ctl00_ContentBody_Location")
@@ -333,18 +361,29 @@ module Geocaching
         raise NotFetchedError unless fetched?
 
         logs = LogsArray.new
-        elements = @doc.search("table.Table.LogsTable > tr > td > strong")
+        tds = @doc.search("table.Table.LogsTable > tr > td")
 
-        if elements.size == 0
+        if tds.size == 0
           raise ExtractError, "Could not extract logs from website"
         end
 
-        elements.each do |node|
-          img = node.search("img")
-          a = node.search("a")
+        tds.each do |td|
+          strongs = td.search("strong")
+          next unless strongs.size > 0
+
+          imgs = strongs.first.search("img")
+          as = strongs.first.search("a")
+
+          unless imgs.size == 1 and as.size == 1
+            raise ExtractError, "Could not extract logs from website"
+          end
+
+          title = imgs.first["title"]
+          guid = as.first["href"] =~ /guid=([a-f0-9-]{36})/ ? $1 : nil
 
-          title = img[0]["title"] if img.size == 1 and img[0]["title"]
-          guid = $1 if a.size == 1 and a[0]["href"] and a[0]["href"] =~ /guid=([a-f0-9-]{36})/
+          unless title and guid
+            raise ExtractError, "Could not extract logs from website"
+          end
 
           logs << Log.new(:guid => guid, :title => title, :cache => self)
         end

data/lib/geocaching/cache_type.rb

@@ -1,6 +1,6 @@
 module Geocaching
   class CacheType
-    MAPPING = {
+    TYPES = {
       :traditional  => [2, "Traditional Cache"],
       :multi        => [3, "Multi Cache"],
       :mystery      => [8, "Mystery Cache"],
@@ -8,17 +8,17 @@ module Geocaching
       :wherigo      => [1858, "Wherigo"],
       :event        => [6, "Event Cache"],
       :megaevent    => [453, "Mega Event Cache"],
-      :cito         => [13, "Cache in Trash out Event"],
+      :cito         => [13, "Cache In Trash Out Event"],
       :earthcache   => [137, "EarthCache"],
       :lfevent      => [3653, "Lost and Found Event Cache"],
       :locationless => [12, "Locationless Reverse Cache"],
       :webcam       => [11, "Webcam Cache"],
       :virtual      => [4, "Virtual Cache"],
-      :ape          => [32, "Project A.P.E. Cache"] # TODO
+      :ape          => [32, "Project A.P.E. Cache"] # XXX
     }
 
     def self.for_id(id)
-      if info = MAPPING.to_a.select { |(k,v)| v[0] == id } and info.size == 1
+      if info = TYPES.to_a.select { |(k,v)| v[0] == id } and info.size == 1
         new(info.first)
       end
     end

data/lib/geocaching/log_type.rb

@@ -1,72 +1,56 @@
 module Geocaching
   class LogType
-    MAPPING = {
-      :cache_published  => ["icon_greenlight", "Published"],
-    CACHE_RETRACTED       = 0x02
-      :dnf              => ["icon_sad", "Didn't find it"],
-      :found            => ["icon_smile", "Found it"],
-    WEBCAM_PHOTO_TAKEN    = 0x05
-    WILL_ATTEND           = 0x06
-    ANNOUNCEMENT          = 0x07
+    TYPES = {
+      :published          => ["icon_greenlight", "Publish Listing"],
+      :retracted          => ["", ""], # TODO
+      :dnf                => ["icon_sad", "Didn't find it"],
+      :found              => ["icon_smile", "Found it"],
+      :webcam_photo_taken => ["", ""], # TODO
+      :will_attend        => ["icon_rsvp", "Will Attend"],
+      :announcement       => ["icon_announcement", "Announcement"],
       :attended           => ["icon_attended", "Attended"],
-    NEEDS_MAINTENANCE     = 0x09
-      :PERFORMED_MAINTENANCE = 0x0a
-      :cache_disabled     => ["icon_disabled", "Temporarily Disable Listing"],
-    CACHE_ENABLED         = 0x0c
-    NOTE                  = 0x0d
-    NEEDS_ARCHIVED        = 0x0e
-      :cache_archived   => ["traffic_cone", "Archive"],
-      :cache_unarchived => ["traffic_cone", "Unarchive"],
-    COORDS_UPDATED        = 0x11
-    REVIEWER_NOTE         = 0x12
+      :needs_maintenance  => ["icon_needsmaint", "Needs Maintenance"],
+      :owner_maintenance  => ["icon_maint", "Owner Maintenance"],
+      :disabled           => ["icon_disabled", "Temporarily Disable Listing"],
+      :enabled            => ["icon_enabled", "Enable Listing"],
+      :note               => ["icon_note", "Write Note"],
+      :needs_archived     => ["icon_remove", "Needs Archived"],
+      :archived           => ["traffic_cone", "Archive"],
+      :unarchived         => ["traffic_cone", "Unarchive"],
+      :coords_updated     => ["coord_update", "Update Coordinates"],
+      :reviewer_note      => ["big_smile", "Post Reviewer Note"]
     }
 
     def self.for_icon(icon)
-      case icon
-        when "" then CACHE_PUBLISHED
-        when "" then CACHE_RETRACTED # TODO
-        when "" then DID_NOT_FOUND
-        when "" then FOUND
-        when "" then WEBCAM_PHOTO_TAKEN # TODO
-        when "icon_rsvp" then WILL_ATTEND
-        when "icon_announcement" then ANNOUNCEMENT
-        when "" then ATTENDED
-        when "icon_needsmaint" then NEEDS_MAINTENANCE
-        when "icon_maint" then PERFORMED_MAINTENANCE
-        when "icon_disabled" then CACHE_DISABLED
-        when "icon_enabled" then CACHE_ENABLED
-        when "icon_note" then NOTE
-        when "icon_remove" then NEEDS_ARCHIVED
-        when "traffic_cone" then CACHE_ARCHIVED
-        when "traffic_cone" then CACHE_UNARCHIVED
-        when "coord_update" then COORDS_UPDATED
-        when "big_smile" then REVIEWER_NOTE
-        else nil
+      if info = TYPES.to_a.select { |(k,v)| v[0] == icon } and info.size == 1
+        new(info.first)
       end
     end
 
     def self.for_title(title)
-      case title
-        when "Publish Listing" then CACHE_PUBLISHED
-        when "" then CACHE_RETRACTED # TODO
-        when "Didn't find it" then DID_NOT_FOUND
-        when "Found it" then FOUND # TODO
-        when "" then WEBCAM_PHOTO_TAKEN
-        when "Will Attend" then WILL_ATTEND
-        when "Announcement" then ANNOUNCEMENT
-        when "Attended" then ATTENDED
-        when "Needs Maintenance" then NEEDS_MAINTENANCE
-        when "Owner Maintenance" then PERFORMED_MAINTENANCE
-        when "Temporarily Disable Listing" then CACHE_DISABLED
-        when "Enable Listing" then CACHE_ENABLE
-        when "Write note" then NOTE
-        when "Needs Archived" then NEEDS_ARCHIVED
-        when "Archive" then CACHE_ARCHIVED
-        when "Unarchive" then CACHE_UNARCHIVE
-        when "Update Coordinates" then COORDS_UPDATED
-        when "Post Reviewer Note" then REVIEWER_NOTE
-        else nil
+      if info = TYPES.to_a.select { |(k,v)| v[1] == title } and info.size == 1
+        new(info.first)
       end
     end
+
+    def new(info)
+      @info = info
+    end
+
+    def icon
+      @info[1][0]
+    end
+
+    def description
+      @info[1][1]
+    end
+
+    def to_sym
+      @info[0]
+    end
+
+    def ==(s)
+      to_sym == s
+    end
   end
 end

data/spec/cache/ape.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+

data/spec/cache/cito.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for c52ff346-4567-4865-a230-c136843049e5 (CITO)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "c52ff346-4567-4865-a230-c136843049e5")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC1W95B"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "1. Dresdner CITO"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :cito
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :not_chosen
+  end
+
+  it "should return the correct event date" do
+    @cache.event_date.should == Time.mktime(2010, 4, 17)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 2.5
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 4.5
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 51.066667
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 13.728333
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Sachsen, Germany"
+  end
+
+  it "should return a plausible number of logs" do
+    @cache.logs.size.should >= 337
+  end
+
+  it "should return cache has been archived" do
+    @cache.archived?.should == true
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/earthcache.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for e34a5b69-51a1-4ed4-838d-e3c3cb75a35a (EarthCache)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "e34a5b69-51a1-4ed4-838d-e3c3cb75a35a")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC26Y3T"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Kniepsand Amrum (Earthcache)"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :earthcache
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :not_chosen
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2010, 4, 17)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 2
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 2
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 54.64475
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 8.321667
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Schleswig-Holstein, Germany"
+  end
+
+  it "should return the correct number of logs" do
+    @cache.logs.size.should >= 57
+  end
+
+  it "should return cache has not been archived" do
+    @cache.archived?.should == false
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/event.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 6cea30b1-7279-43ac-86a8-cdfd1daeb348 (Event)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "6cea30b1-7279-43ac-86a8-cdfd1daeb348")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC211KT"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Weihnachtliches Vorglühen"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :event
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :not_chosen
+  end
+
+  it "should return the correct event date" do
+    @cache.event_date.should == Time.mktime(2009, 12, 23)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 1
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 1
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 49.420667
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 11.1145
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Bayern, Germany"
+  end
+
+  it "should return the correct number of logs" do
+    @cache.logs.size.should == 69
+  end
+
+  it "should return cache has been archived" do
+    @cache.archived?.should == true
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/letterbox.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 01328a57-5a04-4e69-a1cc-ce0eeaa452f5 (Letterbox)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "01328a57-5a04-4e69-a1cc-ce0eeaa452f5")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC1KBJD"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Worzeldorfer Gebirge (Letterbox)"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :letterbox
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :regular
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2009, 1, 3)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 3
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 3
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 49.370417
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 11.116
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Bayern, Germany"
+  end
+
+  it "should return the correct number of logs" do
+    @cache.logs.size.should >= 100
+  end
+
+  it "should return cache has not been archived" do
+    @cache.archived?.should == false
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/lfevent.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 32512f3a-0fc2-45df-943b-af0a6f17f1fa (Lost and Found Event)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "32512f3a-0fc2-45df-943b-af0a6f17f1fa")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC2546Y"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "10 Jahre! Nürnberg, Germany"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :lfevent
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :not_chosen
+  end
+
+  it "should return the correct event date" do
+    @cache.event_date.should == Time.mktime(2010, 5, 1)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 2
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 5
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 49.35475
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 11.20695
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Bayern, Germany"
+  end
+
+  it "should return the correct number of logs" do
+    @cache.logs.size.should == 118
+  end
+
+  it "should return cache has been archived" do
+    @cache.archived?.should == true
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/locationless.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 9ce22167-5a8d-451c-a69b-b19d5ec4f578 (Locationless)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "9ce22167-5a8d-451c-a69b-b19d5ec4f578")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GCB48F"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "die letzte ihrer art?"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :locationless
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :virtual
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2002, 12, 14)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 2.5
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 2.5
+  end
+
+  it "should return no latitude" do
+    @cache.latitude.should == nil
+  end
+
+  it "should return no longitude" do
+    @cache.longitude.should == nil
+  end
+
+  it "should return no location" do
+    @cache.location.should == nil
+  end
+
+  it "should return the correct number of logs" do
+    @cache.logs.size.should == 1330
+  end
+
+  it "should return cache has been archived" do
+    @cache.archived?.should == true
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/megaevent.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for b60781d0-0933-426d-9a67-80eb855e87ef (Mega Event)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "b60781d0-0933-426d-9a67-80eb855e87ef")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC1XEDZ"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Pinzgau 2010"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :megaevent
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :not_chosen
+  end
+
+  it "should return the correct event date" do
+    @cache.event_date.should == Time.mktime(2010, 5, 29)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 1
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 1
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 47.2744
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 12.770883
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Salzburg, Austria"
+  end
+
+  it "should return a plausible number of logs" do
+    @cache.logs.size.should >= 1783
+  end
+
+  it "should return cache has not been archived" do
+    @cache.archived?.should == false
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/multi.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 4ee2c3a1-96e3-4ce0-ad2b-094a51cb3f46 (Multi)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "4ee2c3a1-96e3-4ce0-ad2b-094a51cb3f46")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GCKZ6J"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "MITTELERDE I - DUESTERWALD"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :multi
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :regular
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2004, 10, 31)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 3
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 3.5
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 49.570583
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 11.122083
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Bayern, Germany"
+  end
+
+  it "should return the correct number of logs" do
+    @cache.logs.size.should == 504
+  end
+
+  it "should return cache has been archived" do
+    @cache.archived?.should == true
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/mystery.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 1d86cace-bada-435a-817a-f841718d7754 (Mystery)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "1d86cace-bada-435a-817a-f841718d7754")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC21BBB"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Nordstadt-Matrix"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :mystery
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :small
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2010, 2, 23)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 3.5
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 2
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 49.466133
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 11.07135
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Bayern, Germany"
+  end
+
+  it "should return a plausible number of logs" do
+    @cache.logs.size.should >= 61
+  end
+
+  it "should return cache has not been archived" do
+    @cache.archived?.should == false
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/traditional.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 66274935-40d5-43d8-8cc3-c819e38f9dcc (Traditional)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "66274935-40d5-43d8-8cc3-c819e38f9dcc")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GCF00"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Bridge Over Troubled Waters"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :traditional
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :regular
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2001, 07, 05)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 2.5
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 1.5
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 32.6684
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == -97.436783
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Texas, United States"
+  end
+
+  it "should return a plausible number of logs" do
+    @cache.logs.size.should >= 230
+  end
+
+  it "should return cache has not been archived" do
+    @cache.archived?.should == false
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/virtual.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 4e8b79e1-ffb2-4845-9c24-5ef54137a9b9 (Virtual)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "4e8b79e1-ffb2-4845-9c24-5ef54137a9b9")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GCEB74"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Buecherturm"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :virtual
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :virtual
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2003, 3, 24)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 3
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 1
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 53.553067
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 10.006933
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Hamburg, Germany"
+  end
+
+  it "should return a plausible number of logs" do
+    @cache.logs.size.should >= 856
+  end
+
+  it "should return cache has not been archived" do
+    @cache.archived?.should == false
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/webcam.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 8cd0976c-42cf-40a2-ae02-ed87ad52d5b1 (Webcam)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "8cd0976c-42cf-40a2-ae02-ed87ad52d5b1")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GCQG38"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Versteckte Kamera"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :webcam
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :not_chosen
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2005, 9, 9)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 1.5
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 1
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 49.441
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 11.1065
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Bayern, Germany"
+  end
+
+  it "should return the correct number of logs" do
+    @cache.logs.size.should == 85
+  end
+
+  it "should return cache has been archived" do
+    @cache.archived?.should == true
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache/wherigo.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+describe "Geocaching::Cache for 6128b8a1-2ed3-48f0-9e05-a7117c5faffc (Wherigo)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "6128b8a1-2ed3-48f0-9e05-a7117c5faffc")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC19RVP"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Pegnitztal"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :wherigo
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :small
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2008, 2, 29)
+  end
+
+  it "should return the correct difficulty rating" do
+    @cache.difficulty.should == 1.5
+  end
+
+  it "should return the correct terrain rating" do
+    @cache.terrain.should == 1.5
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 49.466333
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == 11.147267
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Bayern, Germany"
+  end
+
+  it "should return a plausible number of logs" do
+    @cache.logs.size.should >= 182
+  end
+
+  it "should return cache has not been archived" do
+    @cache.archived?.should == false
+  end
+
+  it "should return cache is not PM-only" do
+    @cache.pmonly?.should == false
+  end
+end

data/spec/cache_spec.rb

@@ -5,76 +5,6 @@ $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require "geocaching"
 require "helper"
 
-share_as :GCF00 do
-  it "should return the correct GC code" do
-    @cache.code.should == "GCF00"
-  end
-
-  it "should return the correct GUID" do
-    @cache.guid.should == "66274935-40d5-43d8-8cc3-c819e38f9dcc"
-  end
-
-  it "should return correct cache type ID" do
-    @cache.type_id.should == 2
-  end
-
-  it "should return the correct name" do
-    @cache.name.should == "Bridge Over Troubled Waters"
-  end
-
-  it "should return the correct latitude" do
-    @cache.latitude.should == 32.6684
-  end
-
-  it "should return the correct longitude" do
-    @cache.longitude.should == -97.436783
-  end
-
-  it "should return the correct difficulty rating" do
-    @cache.difficulty.should == 2.5
-  end
-
-  it "should return the correct terrain rating" do
-    @cache.terrain.should == 1.5
-  end
-
-  it "should return the correct hidden at date" do
-    @cache.hidden_at.should == Time.mktime(2001, 07, 05)
-  end
-
-  it "should return the correct location" do
-    @cache.location.should == "Texas, United States"
-  end
-
-  it "should say cache is not archived" do
-    @cache.archived?.should == false
-  end
-
-  it "should say cache is not PM-only" do
-    @cache.pmonly?.should == false
-  end
-
-  it "should return a plausible number of total logs" do
-    @cache.logs.size.should >= 230
-  end
-
-  it "should return the correct type" do
-    @cache.type.to_sym.should == :traditional
-  end
-end
-
-describe "Geocaching::Cache for GCF00" do
-  before :all do
-    @cache = Geocaching::Cache.fetch(:code => "GCF00")
-  end
-
-  include GCF00
-end
-
-describe "Geocaching::Cache for 66274935-40d5-43d8-8cc3-c819e38f9dcc" do
-  before :all do
-    @cache = Geocaching::Cache.fetch(:guid => "66274935-40d5-43d8-8cc3-c819e38f9dcc")
-  end
-
-  include GCF00
+Geocaching::CacheType::TYPES.to_a.map { |a| a[0].to_s }.each do |type|
+  require "cache/#{type}"
 end

data/spec/helper.rb

@@ -6,6 +6,8 @@ unless ENV["GC_USERNAME"] and ENV["GC_PASSWORD"]
   exit 1
 end
 
+Geocaching::HTTP.timeout = ENV["GC_TIMEOUT"].to_i if ENV["GC_TIMEOUT"]
+
 begin
   Geocaching::HTTP.login(ENV["GC_USERNAME"], ENV["GC_PASSWORD"])
 rescue Geocaching::Error => e

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Thomas Cyron
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2010-08-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,8 +45,8 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: A Ruby library that provides an API for information on geocaching.com
-email: nano@fooo.org
+description: A Ruby library that provides an API for geocaching.com
+email: thomas@thcyron.de
 executables: []
 
 extensions: []
@@ -64,6 +64,20 @@ files:
 - lib/geocaching/log_type.rb
 - lib/geocaching/mylogs.rb
 - lib/geocaching.rb
+- spec/cache/ape.rb
+- spec/cache/cito.rb
+- spec/cache/earthcache.rb
+- spec/cache/event.rb
+- spec/cache/letterbox.rb
+- spec/cache/lfevent.rb
+- spec/cache/locationless.rb
+- spec/cache/megaevent.rb
+- spec/cache/multi.rb
+- spec/cache/mystery.rb
+- spec/cache/traditional.rb
+- spec/cache/virtual.rb
+- spec/cache/webcam.rb
+- spec/cache/wherigo.rb
 - spec/cache_spec.rb
 - spec/helper.rb
 - spec/log_message.txt
@@ -99,6 +113,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: API for geocaching.com
+summary: Ruby API for geocaching.com
 test_files: []