geocaching 0.7.0 → 0.7.1

data/README.markdown

@@ -5,7 +5,7 @@ Ruby API for Geocaching.com
 It doesn’t scrape their website but rather uses the same API the
 iPhone and Android geocaching apps use.
 
-See the [website](https://nano.github.com/ruby-geocaching) for more information.
+See the [website](http://nano.github.com/ruby-geocaching) for more information.
 
 
 Tests

data/lib/geocaching/cache.rb

@@ -26,6 +26,7 @@ module Geocaching
     attr_accessor :long_description
     attr_accessor :hint
     attr_accessor :waypoints
+    attr_accessor :attributes
 
     def self.from_xml(doc)
       Parsers::CacheSimple.new(doc).parse
@@ -37,6 +38,7 @@ module Geocaching
 
     def initialize(attributes = {})
       @waypoints = []
+      @attributes = []
 
       attributes.each do |key, value|
         if respond_to?("#{key}=")
@@ -103,6 +105,7 @@ module Geocaching
         :is_archived       => is_archived,
         :is_premium        => is_premium,
         :waypoints         => waypoints,
+        :attributes        => attributes,
         :short_description => short_description,
         :long_description  => long_description,
         :hint              => hint

data/lib/geocaching/cache_attribute.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require "geocaching/parsers/cache_attribute"
+
+module Geocaching
+  class CacheAttribute
+    attr_accessor :name
+
+    def self.from_xml(doc)
+      Parsers::CacheAttribute.new(doc).parse
+    end
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+        else
+          raise ArgumentError, "Unknown attribute `#{key}'"
+        end
+      end
+    end
+
+    alias :to_s :name
+
+    def ==(name)
+      @name == name
+    end
+  end
+end

data/lib/geocaching/errors.rb

@@ -4,4 +4,16 @@ module Geocaching
   class Error < Exception; end
   class HTTPError < Error; end
   class ParseError < Error; end
+
+  class GeocacheNotPublished < Error
+    def initialize
+      super "The geocache hasn't been published yet"
+    end
+  end
+
+  class GeocacheNotAvailable < Error
+    def initialize
+      super "The geocache is currently unavailable for viewing"
+    end
+  end
 end

data/lib/geocaching/parsers/cache_attribute.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Geocaching
+  module Parsers
+    class CacheAttribute
+      def initialize(doc)
+        @doc = doc
+      end
+
+      def parse
+        attributes = []
+
+        @doc.xpath("//xmlns:AttributeSimpleDataSet/xmlns:Attribute").each do |attribute_node|
+          if node = attribute_node.xpath("./xmlns:Name").first
+            attributes << Geocaching::CacheAttribute.new(:name => node.text)
+          else
+            raise ParseError, "Could not parse cache attribute from XML"
+          end
+        end
+
+        attributes
+      end
+    end
+  end
+end

data/lib/geocaching/parsers/cache_gpx.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 
-require "nokogiri"
-require "time"
-
 require "geocaching/parsers/cache_gpx_cache_waypoint"
 require "geocaching/parsers/cache_gpx_additional_waypoint"
 

data/lib/geocaching/parsers/cache_simple.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 
-require "nokogiri"
-require "time"
-
 module Geocaching
   module Parsers
     class CacheSimple

data/lib/geocaching/parsers/log.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 
-require "nokogiri"
-require "time"
-
 module Geocaching
   module Parsers
     class Log

data/lib/geocaching/parsers/trackable.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 
-require "nokogiri"
-require "time"
-
 module Geocaching
   module Parsers
     class Trackable

data/lib/geocaching/session/attributes.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Geocaching
+  class Session
+    module Attributes
+      def get_attributes_for_cache_by_cache_code(cache_code)
+        response = request("GetAttributesByWptCode", {
+          "sessionToken" => session_token,
+          "wptCode"      => cache_code,
+          "schemaName"   => "AttributeSimpleDataSet.xsd"
+        })
+
+        CacheAttribute.from_xml(response.doc)
+      end
+    end
+  end
+end

data/lib/geocaching/session/caches.rb

@@ -19,6 +19,13 @@ module Geocaching
           "cacheCode"    => code
         })
 
+        case response.status
+        when "GeocacheNotAvailable"
+          raise GeocacheNotAvailable
+        when "GeocacheNotPublished"
+          raise GeocacheNotPublished
+        end
+
         case schema
         when "CacheSimpleDataSet.xsd"
           caches = Cache.from_xml(response.doc)
@@ -56,6 +63,16 @@ module Geocaching
 
         Cache.from_xml(response.doc)
       end
+
+      def get_attributes_for_cache_by_cache_code(cache_code)
+        response = request("GetAttributesByWptCode", {
+          "sessionToken" => session_token,
+          "wptCode"      => cache_code,
+          "schemaName"   => "AttributeSimpleDataSet.xsd"
+        })
+
+        CacheAttribute.from_xml(response.doc)
+      end
     end
   end
 end

data/lib/geocaching/session.rb

@@ -2,6 +2,7 @@
 
 require "cgi"
 require "net/http"
+require "nokogiri"
 
 require "geocaching/session/caches"
 require "geocaching/session/logs"

data/lib/geocaching.rb

@@ -1,6 +1,9 @@
 # encoding: utf-8
 
+require "time"
+
 require "geocaching/cache"
+require "geocaching/cache_attribute"
 require "geocaching/cache_type"
 require "geocaching/container_type"
 require "geocaching/errors"
@@ -14,5 +17,5 @@ require "geocaching/waypoint"
 require "geocaching/waypoint_type"
 
 module Geocaching
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -2,7 +2,7 @@
 name: geocaching
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Thomas Cyron
@@ -46,17 +46,20 @@ extra_rdoc_files: []
 files: 
 - README.markdown
 - lib/geocaching/cache.rb
+- lib/geocaching/cache_attribute.rb
 - lib/geocaching/cache_type.rb
 - lib/geocaching/container_type.rb
 - lib/geocaching/errors.rb
 - lib/geocaching/log.rb
 - lib/geocaching/log_type.rb
+- lib/geocaching/parsers/cache_attribute.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/attributes.rb
 - lib/geocaching/session/caches.rb
 - lib/geocaching/session/logs.rb
 - lib/geocaching/session/trackables.rb