geocaching 0.6.1 → 0.7.0

data/lib/geocaching/trackable_type.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Geocaching
+  class TrackableType
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    alias :to_s :name
+
+    def ==(name)
+      @name == name
+    end
+  end
+end

data/lib/geocaching/user.rb

@@ -1,217 +1,25 @@
 # encoding: utf-8
 
-require "time"
-
 module Geocaching
-  # The {User} class represents a user on geocaching.com.
-  #
-  # == Usage
-  #
-  #  user = Geocaching::User.fetch(:guid => "...")
-  #  puts user.name #=> "Jack"
-  #
   class User
-    # Creates a new instance and calls the {fetch} method afterwards.
-    # +:guid+ must be given as an attribute.
-    #
-    # @param [Hash] attributes A hash of attributes
-    # @raise [ArgumentError] No GUID given
-    # @return [Geocaching::User]
-    def self.fetch(attributes)
-      user = new(attributes)
-      user.fetch
-      user
-    end
+    attr_accessor :guid
+    attr_accessor :name
 
-    # Creates a new instance.  The following attributes may be specified
-    # as parameters:
-    #
-    # * +:guid+ — The user’s Globally Unique Identifier (GUID)
-    # * +:name+ — The user‘s name
-    #
-    # @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, :name].include?(key)
-          instance_variable_set("@#{key}", value)
-        else
-          raise ArgumentError, "Trying to set unknown attribute `#{key}'"
-        end
-      end
-    end
-
-    # Fetches user information from geocaching.com.
-    #
-    # @return [void]
-    # @raise [ArgumentError] No GUID given
-    def fetch
-      raise ArgumentError, "No GUID given" unless @guid
-
-      resp, @data = HTTP.get("/profile/?guid=#{guid}")
-      @doc = Nokogiri::HTML.parse(@data)
-    end
-
-    # Returns whether user information have successfully been fetched
-    # from geocaching.com.
-    #
-    # @return [Boolean] Have user information been fetched?
-    def fetched?
-      @data and @doc
-    end
-
-    # Returns the user’s Globally Unique Identifier (GUID).
-    #
-    # @return [String]
-    def guid
-      @guid
-    end
-
-    # Returns the user’s name.
-    #
-    # @return [String]
-    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)
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
         else
-          raise ParseError, "Could not extract name from website"
+          raise ArgumentError, "Unknown attribute `#{key}'"
         end
       end
     end
 
-    # Returns the user’s occupation.
-    #
-    # @return [String] Occupation
-    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 ParseError, "Could not extract occupation from website"
-        end
-      end
-    end
-
-    # Returns the user’s location.
-    #
-    # @return [String] Location
-    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 ParseError, "Could not extract location from website"
-        end
-      end
-    end
-
-    # Returns the user’s forum title.
-    #
-    # @return [String] Forum title
-    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 ParseError, "Could not extract forum title from website"
-        end
-      end
-    end
-
-    # Returns the user’s homepage.
-    #
-    # @return [String] Homepage
-    def homepage
-      @homepage ||= begin
-        raise NotFetchedError unless fetched?
-
-        elements = @doc.search("#ctl00_ContentBody_ProfilePanel1_lnkHomePage")
-        elements.first["href"] if elements.size == 1
-      end
-    end
-
-    # Returns the user’s statuses.
-    #
-    # @return [Array<String>] Array of statuses
-    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 ParseError, "Could not extract status from website"
-        end
-      end
-    end
-
-    # Returns the user’s last visit date.
-    #
-    # @return [Time] Last visit date
-    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 ParseError, "Could not extract last visit date from website"
-        end
-      end
-    end
-
-    # Returns the user’s member since date.
-    #
-    # @return [Time] Member since date
-    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 ParseError, "Could not extract member since date from website"
-        end
-      end
-    end
-
-    # Returns whether the user is a reviewer.
-    #
-    # @return [Boolean] Is user a reviewer?
-    def reviewer?
-      status.include?("Reviewer")
-    end
-
-    # Returns whether the user is a Premium Member.
-    #
-    # @return [Boolean] Is user a Premium Member?
-    def premium_member?
-      status.include?("Premium Member")
+    def to_hash
+      {
+        :guid => guid,
+        :name => name
+      }
     end
   end
 end

data/lib/geocaching/waypoint.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module Geocaching
+  class Waypoint
+    attr_accessor :code
+    attr_accessor :name
+    attr_accessor :latitude
+    attr_accessor :longitude
+    attr_accessor :note
+    attr_reader   :type
+    attr_reader   :created_at
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+        else
+          raise ArgumentError, "Unknown attribute `#{key}'"
+        end
+      end
+    end
+
+    def type=(waypoint_type)
+      if waypoint_type.kind_of?(Geocaching::WaypointType)
+        @type = waypoint_type
+      else
+        raise TypeError, "`type' must be an instance of Geocaching::WaypointType"
+      end
+    end
+
+    def created_at=(time)
+      if time.kind_of?(Time)
+        @created_at = time
+      else
+        raise TypeError, "`created_at' must be an instance of Time"
+      end
+    end
+
+    def to_hash
+      {
+        :code       => code,
+        :name       => name,
+        :latitude   => latitude,
+        :longitude  => longitude,
+        :note       => note,
+        :type       => type,
+        :created_at => created_at
+      }
+    end
+  end
+end

data/lib/geocaching/waypoint_type.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Geocaching
+  class WaypointType
+    attr_reader :id
+
+    PARKING_AREA       = 0
+    QUESTION_TO_ANSWER = 1
+    REFERENCE_POINT    = 2
+    STAGE              = 3
+    TRAILHEAD          = 4
+
+    MAPPING = [
+      [PARKING_AREA,       "Parking Area"          ],
+      [QUESTION_TO_ANSWER, "Question to Answer"    ],
+      [REFERENCE_POINT,    "Reference Point"       ],
+      [STAGE,              "Stages of a Multicache"],
+      [TRAILHEAD,          "Trailhead"             ]
+    ]
+
+    def self.from_name(name)
+      if type = MAPPING.find { |_, n| n == name }
+        new(type[0])
+      end
+    end
+
+    def initialize(id)
+      @id = id
+    end
+
+    def name
+      @name ||= MAPPING.find { |id, _| id == @id }[1]
+    end
+
+    alias :to_s :name
+
+    def ==(id)
+      @id = id
+    end
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: geocaching
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 6
-  - 1
-  version: 0.6.1
+  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors: 
 - Thomas Cyron
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 +01:00
+date: 2011-04-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 2
         version: 1.4.2
   type: :runtime
   version_requirements: *id001
@@ -40,14 +32,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 6
         version: 1.4.6
   type: :runtime
   version_requirements: *id002
-description: A Ruby library that provides an API for geocaching.com
+description: A Ruby library providing an API for Geocaching.com
 email: thomas@thcyron.de
 executables: []
 
@@ -59,13 +47,25 @@ files:
 - README.markdown
 - lib/geocaching/cache.rb
 - lib/geocaching/cache_type.rb
-- lib/geocaching/http.rb
+- lib/geocaching/container_type.rb
+- lib/geocaching/errors.rb
 - lib/geocaching/log.rb
 - lib/geocaching/log_type.rb
-- lib/geocaching/my_logs.rb
+- lib/geocaching/parsers/cache_gpx.rb
+- lib/geocaching/parsers/cache_gpx_additional_waypoint.rb
+- lib/geocaching/parsers/cache_gpx_cache_waypoint.rb
+- lib/geocaching/parsers/cache_simple.rb
+- lib/geocaching/parsers/log.rb
+- lib/geocaching/parsers/trackable.rb
+- lib/geocaching/session/caches.rb
+- lib/geocaching/session/logs.rb
+- lib/geocaching/session/trackables.rb
+- lib/geocaching/session.rb
+- lib/geocaching/trackable.rb
+- lib/geocaching/trackable_type.rb
 - lib/geocaching/user.rb
-- lib/geocaching/version.rb
-- lib/geocaching/watchlist.rb
+- lib/geocaching/waypoint.rb
+- lib/geocaching/waypoint_type.rb
 - lib/geocaching.rb
 has_rdoc: false
 homepage: http://nano.github.com/ruby-geocaching
@@ -81,21 +81,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Ruby API for geocaching.com

data/lib/geocaching/http.rb

@@ -1,248 +0,0 @@
-# encoding: utf-8
-
-require "cgi"
-require "net/http"
-require "timeout"
-
-module Geocaching
-  # The {HTTP} class handles the HTTP communication with geocaching.com.
-  class HTTP
-    # An array of user agent strings.  A random one is chosen.
-    USER_AGENTS = [
-      "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)",
-      "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0)",
-      "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1)",
-      "Mozilla/5.0 (compatible; Konqueror/3.2; Linux 2.6.2) (KHTML, like Gecko)",
-      "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/125.2 (KHTML, like Gecko) Safari/125.8",
-      "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.13 (KHTML, like Gecko) Chrome/0.A.B.C Safari/525.13",
-      "Mozilla/5.0 (Windows; U; Windows NT 5.1; de; rv:1.9.0.10) Gecko/2009042316 Firefox/3.0.10",
-      "Mozilla/5.0 (X11; U; Linux i586; en-US; rv:1.7.3) Gecko/20040924 Epiphany/1.4.4 (Ubuntu)",
-      "Opera/9.80 (Macintosh; Intel Mac OS X; U; en) Presto/2.2.15 Version/10.00"
-    ]
-
-    # The user agent sent with each request.
-    @user_agent = nil
-
-    # Timeout for sending and receiving HTTP data.
-    @timeout = 8
-
-    class << self
-      attr_accessor :user_agent, :timeout, :username, :password
-
-      # Returns the singleton instance of this class.
-      #
-      # @return [HTTP] Singleton instance of this class
-      def instance
-        @instance ||= new
-      end
-
-      # Alias for:
-      #
-      #  Geocaching::HTTP.username = username
-      #  Geocaching::HTTP.password = password
-      #  Geocaching::HTTP.instance.login
-      def login(username = nil, password = nil)
-        self.username, self.password = username, password if username && password
-        self.instance.login
-      end
-
-      # Alias for +Geocaching::HTTP.instance.logout+.
-      def logout
-        self.instance.logout
-      end
-
-      # Alias for +Geocaching::HTTP.instance.loggedin?+.
-      def loggedin?
-        self.instance.loggedin?
-      end
-
-      # Alias for +Geocaching::HTTP.instance.get+.
-      def get(path)
-        self.instance.get(path)
-      end
-
-      # Alias for +Geocaching::HTTP.instance.post+.
-      def post(path, data = {}, extra_headers = {})
-        self.instance.post(path, data, extra_headers)
-      end
-
-      # Converts HTML entities to the corresponding UTF-8 symbols.
-      #
-      # @return [String] The converted string
-      def unescape(str)
-        str = str.force_encoding("UTF-8") if str.respond_to?(:force_encoding)
-        str = str.gsub(/&#(\d{3});/) { [$1.to_i].pack("U") }
-        CGI.unescapeHTML(str)
-      end
-    end
-
-    # Creates a new instance.
-    def initialize
-      @loggedin = false
-      @cookie = nil
-    end
-
-    # Logs in into geocaching.com.  Username and password need to be set
-    # before calling this method.
-    #
-    #  HTTP.username = "username"
-    #  HTTP.password = "password"
-    #
-    # @return [void]
-    # @raise [ArgumentError] Username or password missing
-    def login
-      raise ArgumentError, "Missing username" unless self.class.username
-      raise ArgumentError, "Missing password" unless self.class.password
-
-      raise LoginError, "Already logged in" if @loggedin
-
-      resp, data = post("/login/default.aspx", {
-        "ctl00$ContentBody$myUsername"  => self.class.username,
-        "ctl00$ContentBody$myPassword"  => self.class.password,
-        "ctl00$ContentBody$Button1"     => "Login",
-        "ctl00$ContentBody$cookie"      => "on"
-      })
-
-      @cookie = resp.response["set-cookie"]
-      @loggedin = true
-    end
-
-    # Logs out from geocaching.com.
-    #
-    # @return [void]
-    def logout
-      raise LoginError, "Not logged in" unless @loggedin
-
-      @loggedin = false
-      @cookie = nil
-
-      get("/login/default.aspx?RESETCOMPLETE=Y")
-    end
-
-    # Returns whether you‘ve already logged in.
-    #
-    # @return [Boolean] Already logged in?
-    def loggedin?
-      @loggedin and @cookie
-    end
-
-    # Sends a GET request to +path+.  The authentication cookie is sent
-    # with the request if available.
-    #
-    # @param [String] path Request path
-    # @return [Net::HTTP::Response] Reponse object from +Net::HTTP+
-    # @return [String] Actual content
-    def get(path)
-      resp = data = nil
-      header = default_header
-      header["Cookie"] = @cookie if @cookie
-
-      begin
-        Timeout::timeout(self.class.timeout) do
-          resp, data = http.get(path, header)
-        end
-      rescue Timeout::Error
-        raise TimeoutError, "Timeout hit for GET #{path}"
-      rescue
-        raise HTTPError
-      end
-
-      unless resp.kind_of?(Net::HTTPSuccess)
-        if resp.kind_of?(Net::HTTPRedirection) and resp.response["location"]
-          resp, data = get(resp.response["location"])
-        else
-          raise HTTPError
-        end
-      end
-
-      [resp, data]
-    end
-
-    # Sends a POST request to +path+ with the data given in the
-    # +params+ hash.  The authentication cookie is sent with the
-    # request if available.
-    #
-    # Before sending the POST request, a GET request is sent to obtain the
-    # information like +__VIEWPORT+ that are used on geocaching.com to protect
-    # from Cross Site Request Forgery.
-    #
-    # @return [Net::HTTP::Response] Reponse object from +Net::HTTP+
-    # @return [String] Actual content
-    # @raise [Geocaching::TimeoutError] Timeout hit
-    # @raise [Geocaching::HTTPError] HTTP request failed
-    def post(path, params = {}, extra_headers = {})
-      if params.kind_of?(Hash)
-        params = params.merge(metadata(path)).map { |k,v| "#{k}=#{v}" }.join("&")
-      end
-
-      resp = data = nil
-
-      header = default_header.merge(extra_headers)
-      header["Cookie"] = @cookie if @cookie
-
-      begin
-        Timeout::timeout(self.class.timeout) do
-          resp, data = http.post(path, params, header)
-        end
-      rescue Timeout::Error
-        raise TimeoutError, "Timeout hit for POST #{path}"
-      rescue
-        raise HTTPError
-      end
-
-      unless resp.kind_of?(Net::HTTPSuccess)
-        if resp.kind_of?(Net::HTTPRedirection) and resp.response["location"]
-          resp, data = get(resp.response["location"])
-        else
-          raise HTTPError
-        end
-      end
-
-      [resp, data]
-    end
-
-  private
-
-    # Sends a GET request to +path+ to obtain form meta data used on
-    # geocaching.com to protect from CSRF.
-    #
-    # @return [Hash] Meta information
-    def metadata(path)
-      resp, data = get(path)
-      meta = {}
-
-      data.scan(/<input type="hidden" name="__([A-Z]+)" id="__[A-Z]+" value="(.*?)" \/>/).each do |match|
-        meta["__#{match[0]}"] = CGI.escape(match[1])
-      end
-
-      meta
-    end
-
-    # Returns the user agent string to use for the HTTP requests.  If no
-    # user agent is set explicitly, a random one is chosen.
-    #
-    # @return [String] User agent
-    def user_agent
-      self.class.user_agent ||= USER_AGENTS.shuffle.first
-    end
-
-    # Returns an hash with the HTTP headers sent with each request.
-    #
-    # @return [Hash] Default HTTP headers
-    def default_header
-      {
-        "User-Agent" => user_agent
-      }
-    end
-
-    # Returns the instance of {Net::HTTP} or creates a new one for
-    # +www.geocaching.com+.
-    #
-    # @return [Net::HTTP]
-    def http
-      @http ||= begin
-        Net::HTTP.new("www.geocaching.com")
-      end
-    end
-  end
-end