geocaching 0.2.1 → 0.2.3

data/geocaching.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "geocaching"
-  s.version = "0.2.1"
+  s.version = "0.2.3"
 
   s.summary = "API for geocaching.com"
   s.description = "A Ruby library that provides an API for information on geocaching.com"

data/lib/geocaching.rb

@@ -69,5 +69,7 @@ module Geocaching
 
   autoload :HTTP, "geocaching/http"
   autoload :Cache, "geocaching/cache"
+  autoload :CacheType, "geocaching/cache_type"
   autoload :Log, "geocaching/log"
+  autoload :MyLogs, "geocaching/mylogs"
 end

data/lib/geocaching/cache.rb

@@ -1,7 +1,5 @@
 # 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
@@ -140,6 +138,10 @@ module Geocaching
       end
     end
 
+    def type
+      CacheType.for_id(type_id)
+    end
+
     # The cache’s name.
     #
     # @return [String] Name
@@ -202,7 +204,7 @@ module Geocaching
         raise NotFetchedError unless fetched?
 
         if @data =~ /<strong>\s*?Hidden\s*?:\s*?<\/strong>\s*?(\d{1,2})\/(\d{1,2})\/(\d{4})/
-          Time.parse([$3, $1, $2].join("-"))
+          Time.mktime($3, $1, $2)
         else
           raise ExtractError, "Could not extract hidden date from website"
         end
@@ -314,7 +316,9 @@ module Geocaching
     def pmonly?
       @is_pmonly ||= begin
         raise NotFetchedError unless fetched?
-        !!(@data =~ /<p class="Warning">Sorry, the owner of this listing has made it viewable to Premium Members only\./)
+
+        @doc.search("#ctl00_ContentBody_basicMemberMsg").size == 1 ||
+          !!(@data =~ /<p class="Warning">This is a Premium Member Only cache\.<\/p>/)
       end
     end
 

data/lib/geocaching/cache_type.rb

@@ -0,0 +1,46 @@
+module Geocaching
+  class CacheType
+    MAPPING = {
+      :traditional  => [2, "Traditional Cache"],
+      :multi        => [3, "Multi Cache"],
+      :mystery      => [8, "Mystery Cache"],
+      :letterbox    => [5, "Letterbox Hybrid"],
+      :wherigo      => [1858, "Wherigo"],
+      :event        => [6, "Event Cache"],
+      :megaevent    => [453, "Mega Event Cache"],
+      :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
+    }
+
+    def self.for_id(id)
+      if info = MAPPING.to_a.select { |(k,v)| v[0] == id } and info.size == 1
+        new(info.first)
+      end
+    end
+
+    def initialize(info)
+      @info = info
+    end
+
+    def id
+      @info[1][0]
+    end
+
+    def name
+      @info[1][1]
+    end
+
+    def to_sym
+      @info[0]
+    end
+
+    def ==(s)
+      to_sym == s
+    end
+  end
+end

data/lib/geocaching/log_type.rb

@@ -0,0 +1,72 @@
+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
+      :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
+    }
+
+    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
+      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
+      end
+    end
+  end
+end

data/lib/geocaching/mylogs.rb

@@ -0,0 +1,63 @@
+module Geocaching
+  class MyLogs
+    def self.fetch
+      mylogs = new
+      mylogs.fetch
+      mylogs
+    end
+
+    def initialize
+    end
+
+    def fetch
+      raise LoginError, "Need to be logged in to fetch log information" unless HTTP.loggedin?
+
+      resp, @data = HTTP.get(path)
+      @doc = Nokogiri::HTML.parse(@data)
+    end
+
+    def logs
+      @logs ||= begin
+        rows = @doc.search("table.Table tr")
+        logs = []
+
+        rows.each do |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
+
+          # Log GUID
+          elements = row.search("td:nth-child(5) a")
+          if elements.size == 1
+            url = elements.first["href"]
+            if url and url =~ /LUID=([a-f0-9-]{36})/
+              info[:log_guid] = $1
+            end
+          end
+
+          if info.size == 2
+            cache = Cache.new(:guid => info[:cache_guid])
+            log = Log.new(:guid => info[:log_guid], :cache => cache)
+
+            logs << log
+          end
+        end
+
+        logs
+      end
+    end
+
+  private
+
+    def path
+      "/my/logs.aspx?s=1"
+    end
+  end
+end

data/spec/cache_spec.rb

@@ -39,7 +39,7 @@ share_as :GCF00 do
   end
 
   it "should return the correct hidden at date" do
-    @cache.hidden_at.should == Time.parse("2001-07-05")
+    @cache.hidden_at.should == Time.mktime(2001, 07, 05)
   end
 
   it "should return the correct location" do
@@ -57,6 +57,10 @@ share_as :GCF00 do
   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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Thomas Cyron
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 +02:00
+date: 2010-08-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,8 +58,11 @@ files:
 - Rakefile
 - geocaching.gemspec
 - lib/geocaching/cache.rb
+- lib/geocaching/cache_type.rb
 - lib/geocaching/http.rb
 - lib/geocaching/log.rb
+- lib/geocaching/log_type.rb
+- lib/geocaching/mylogs.rb
 - lib/geocaching.rb
 - spec/cache_spec.rb
 - spec/helper.rb