geocaching 0.3.0 → 0.4.0

data/lib/geocaching/my_logs.rb

@@ -0,0 +1,150 @@
+module Geocaching
+  # This class provides access to the logs the user currently logged in
+  # has written.
+  #
+  #  mylogs = Geocaching::MyLogs.fetch
+  #  puts "I've written #{mylogs.size} logs."
+  class MyLogs
+    # Create a new instance and call {fetch} afterwards.
+    #
+    # @return [Geocaching::MyLogs]
+    # @raise [Geocaching::LoginError] Need to be logged in to fetch own logs
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    def self.fetch
+      mylogs = new
+      mylogs.fetch
+      mylogs
+    end
+
+    # Fetch logs from geocaching.com.
+    #
+    # @return [void]
+    # @raise [Geocaching::LoginError] Need to be logged in to fetch own logs
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    def fetch
+      raise LoginError, "Need to be logged in to fetch your logs" unless HTTP.loggedin?
+
+      resp, @data = HTTP.get(path)
+      @doc = Nokogiri::HTML.parse(@data)
+    end
+
+    # Return whether logs have successfully been fetched from
+    # geocaching.com.
+    #
+    # @return [Boolean]
+    def fetched?
+      @data and @doc
+    end
+
+    # Return an array of logs the user you’re logged in with has
+    # written.
+    #
+    # @return [Array<Geocaching::Log>]
+    # @raise [Geocaching::NotFetchedError] Need to call {fetch} first.
+    def logs
+      @logs ||= begin
+        raise NotFetchedError unless fetched?
+
+        rows = @doc.search("table.Table tr")
+        logs = []
+
+        rows.each do |row|
+          if info = extract_info_from_row(row) and info.size == 6
+            cache = Cache.new \
+              :guid => info[:cache_guid],
+              :name => info[:cache_name],
+              :type => info[:cache_type]
+            log = Log.new \
+              :guid  => info[:log_guid],
+              :title => info[:log_title],
+              :date  => info[:log_date],
+              :cache => cache
+
+            logs << log
+          end
+        end
+
+        logs
+      end
+    end
+
+  private
+
+    def path
+      "/my/logs.aspx?s=1"
+    end
+
+    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(3) a > img")
+      if elements.size == 1
+        if title = elements.first["title"]
+          if type = CacheType.for_title(title)
+            info[:cache_type] = type
+          end
+        end
+      end
+
+      # Cache name
+      elements = row.search("td:nth-child(3)")
+      if elements.size == 1
+        archived = elements.first.search("span.Strike.Warning > a > span > strike > font")
+        if archived.size == 1
+          name = archived.first.content
+          info[:cache_name] = name if name
+        else
+          disabled = elements.first.search("strike > a > span > strike")
+          if disabled.size == 1
+            name = disabled.first.content
+            info[:cache_name] = name if name
+          else
+            enabled = elements.first.search("a > span")
+            if enabled.size == 1
+              name = enabled.first.content
+              info[:cache_name] = name if name
+            end
+          end
+        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
+
+      # Log title
+      elements = row.search("td:first-child img")
+      if elements.size == 1
+        title = elements.first["alt"]
+        info[:log_title] = title if title
+      end
+
+      # Log date
+      elements = row.search("td:nth-child(2)")
+      if elements.size == 1
+        if elements.first.content =~ /(\d{2})\/(\d{2})\/(\d{4})/
+          info[:log_date] = Time.mktime($3, $1, $2)
+        end
+      end
+
+      info
+    end
+  end
+end

data/lib/geocaching/user.rb

@@ -0,0 +1,251 @@
+require "time"
+
+module Geocaching
+  # This class represents an user on geocaching.com.
+  #
+  #  user = Geocaching::User.fetch(:guid => "...")
+  #  puts user.name #=> "Jack"
+  class User
+    # Create a new instance and call the {fetch} method afterwards.
+    # +:guid+ must be giveb as an attribute.
+    #
+    # @param [Hash] attributes A hash of attributes
+    # @raise [ArgumentError] No GUID given
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @return [Geocaching::User]
+    def self.fetch(attributes)
+      user = new(attributes)
+      user.fetch
+      user
+    end
+
+    # Create a new instance. The following attributes may be specified
+    # as parameters:
+    #
+    # * +:guid+ — The user’s Globally Unique Identifier (GUID)
+    #
+    # @param [Hash] attributes A hash of attributes
+    # @raise [ArgumentError] Trying to set an unknown attribute
+    def initialize(attributes = {})
+      @data, @doc, @guid = nil, nil, nil
+
+      attributes.each do |key, value|
+        if [:guid].include?(key)
+          instance_variable_set("@#{key}", value)
+        else
+          raise ArgumentError, "Trying to set unknown attribute `#{key}'"
+        end
+      end
+    end
+
+    # Fetch user information from geocaching.com.
+    #
+    # @return [void]
+    # @raise [ArgumentError] No GUID given
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    def fetch
+      raise ArgumentError, "No GUID given" unless @guid
+
+      resp, @data = HTTP.get(path)
+      @doc = Nokogiri::HTML.parse(@data)
+    end
+
+    # Return whether user information have successfully been fetched
+    # from geocaching.com.
+    #
+    # @return [Boolean]
+    def fetched?
+      @data and @doc
+    end
+
+    # Return the user’s Globally Unique Identifier (GUID).
+    #
+    # @return [String]
+    def guid
+      @guid
+    end
+
+    # Return the user’s name.
+    #
+    # @return [String]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract name from website
+    def name
+      @name ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_lblUserProfile")
+
+        if elements.size == 1 and elements.first.content =~ /Profile for User|Reviewer: (.+)/
+          HTTP.unescape($1)
+        else
+          raise ExtractError, "Could not extract name from website"
+        end
+      end
+    end
+
+    # Return the user’s occupation.
+    #
+    # @return [String]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def occupation
+      @occupation ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lblOccupationTxt")
+
+        if elements.size == 1
+          HTTP.unescape(elements.first.content)
+        else
+          raise ExtractError, "Could not extract occupation from website"
+        end
+      end
+    end
+
+    # Return the user’s location.
+    #
+    # @return [String]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def location
+      @location ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lblLocationTxt")
+
+        if elements.size == 1
+          HTTP.unescape(elements.first.content)
+        else
+          raise ExtractError, "Could not extract location from website"
+        end
+      end
+    end
+
+    # Return the user’s forum title.
+    #
+    # @return [String]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def forum_title
+      @forum_title ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lblForumTitleTxt")
+
+        if elements.size == 1
+          HTTP.unescape(elements.first.content)
+        else
+          raise ExtractError, "Could not extract forum title from website"
+        end
+      end
+    end
+
+    # Return the user’s homepage.
+    #
+    # @return [String]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def homepage
+      @homepage ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lnkHomePage")
+        elements.first["href"] if elements.size == 1
+      end
+    end
+
+    # Return the user’s statuses.
+    #
+    # @return [Array<String>]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def status
+      @status ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lblStatusText")
+
+        if elements.size == 1
+          HTTP.unescape(elements.first.content).split(",").map(&:strip)
+        else
+          raise ExtractError, "Could not extract status from website"
+        end
+      end
+    end
+
+    # Return the user’s last visit date.
+    #
+    # @return [Time]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def last_visit
+      @last_visit ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lblLastVisitDate")
+
+        if elements.size == 1
+          Time.parse(elements.first.content)
+        else
+          raise ExtractError, "Could not extract last visit date from website"
+        end
+      end
+    end
+
+    # Return the user’s member since date.
+    #
+    # @return [Time]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def member_since
+      @member_since ||= begin
+        raise NotFetchedError unless fetched?
+
+        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lblMemberSinceDate")
+
+        if elements.size == 1
+          Time.parse(elements.first.content)
+        else
+          raise ExtractError, "Could not extract member since date from website"
+        end
+      end
+    end
+
+    # Return whether the user is a reviewer.
+    #
+    # @return [Boolean]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def reviewer?
+      status.include?("Reviewer")
+    end
+
+    # Return whether the user is a premium member.
+    #
+    # @return [Boolean]
+    # @raise [Geocaching::TimeoutError] Timeout hit
+    # @raise [Geocaching::HTTPError] HTTP request failed
+    # @raise [Geocaching::ExtractError] Could not extract information from website
+    def premium_member?
+      status.include?("Premium Member")
+    end
+
+  private
+
+    def path
+      "/profile/?guid=#{guid}"
+    end
+  end
+end

data/lib/geocaching/version.rb

@@ -0,0 +1,3 @@
+module Geocaching
+  VERSION = "0.4.0"
+end

data/spec/cache/ape.rb

@@ -1,2 +1,71 @@
 # encoding: utf-8
 
+describe "Geocaching::Cache for 7d120ae2-855c-430d-9c14-3d7427de4bdd (Project A.P.E. Cache)" do
+  before :all do
+    @cache = Geocaching::Cache.fetch(:guid => "7d120ae2-855c-430d-9c14-3d7427de4bdd")
+  end
+
+  it "should return the correct GC code" do
+    @cache.code.should == "GC1169"
+  end
+
+  it "should return the correct name" do
+    @cache.name.should == "Mission 9: Tunnel of Light"
+  end
+
+  it "should return the correct displayed owner name" do
+    @cache.owner_display_name.should == "Project APE (maintained by Moun10Bike)"
+  end
+
+  it "should return the correct owner GUID" do
+    @cache.owner.guid == "47975ebd-efc1-40d6-94c1-b379a6221a8f"
+  end
+
+  it "should return the correct cache type" do
+    @cache.type.to_sym.should == :ape
+  end
+
+  it "should return the correct size" do
+    @cache.size.should == :large
+  end
+
+  it "should return the correct hidden date" do
+    @cache.hidden_at.should == Time.mktime(2001, 7, 18)
+  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 == 3
+  end
+
+  it "should return the correct latitude" do
+    @cache.latitude.should == 47.3919
+  end
+
+  it "should return the correct longitude" do
+    @cache.longitude.should == -121.455083
+  end
+
+  it "should return the correct location" do
+    @cache.location.should == "Washington, United States"
+  end
+
+  it "should return a plausible number of logs" do
+    @cache.logs.size.should >= 3566
+  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
+
+  it "should return cache is not in review" do
+    @cache.in_review?.should == false
+  end
+end