geocaching 0.6.0 → 0.6.1

data/Rakefile

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-task :default => :test
-
-task :test do
-  sh "rspec -c spec"
-end
-
-task :console do
-  sh "irb -I lib -r geocaching"
-end

data/geocaching.gemspec

@@ -1,24 +0,0 @@
-require "#{File.dirname(__FILE__)}/lib/geocaching/version"
-
-Gem::Specification.new do |s|
-  s.name = "geocaching"
-  s.version = Geocaching::VERSION
-
-  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 = "thomas@thcyron.de"
-  s.homepage = "http://nano.github.com/ruby-geocaching"
-
-  s.files  = %w(README.markdown Rakefile geocaching.gemspec)
-  s.files += Dir.glob("lib/**/*")
-  s.files += Dir.glob("spec/**/*")
-
-  s.has_rdoc = false
-
-  s.add_dependency "nokogiri", ">= 1.4.2"
-  s.add_dependency "json", ">= 1.4.6"
-
-  s.add_development_dependency "rspec", ">= 2.0.0"
-end

data/lib/geocaching/pocket_query.rb

@@ -1,213 +0,0 @@
-# encoding: utf-8
-
-module Geocaching
-  # The {PocketQuery} class represents a Pocket Query.
-  #
-  # == Usage
-  #
-  # === Downloading a Pocket Query
-  #
-  #  avail_pqs = Geocaching::PocketQuery.ready_for_download
-  #  pq = avail_pqs.first
-  #  
-  #  pq.download
-  #  pq.parse
-  #  
-  #  puts "The PQ contains #{pq.caches.size} caches."
-  #
-  # === Reading a Pocket Query from file
-  #
-  #  pq = Geocaching::PocketQuery.from_file("123456.gpx")
-  #  puts "The PQ’s name is #{pq.name}."
-  #
-  class PocketQuery
-    # Reads a Pocket Query from file and parses it.  The file may either be a
-    # GPX file or a zip file containing the GPX file.
-    #
-    # @param [String] file File name
-    # @return [Geocaching::PocketQuery] Pocket Query
-    def self.from_file(file)
-      pq = new(:raw => File.read(file))
-      pq.parse
-      pq
-    end
-
-    # Returns an array of Pocket Queries that are ready for download.  You
-    # need to be logged in and a Premium Member to use this feature.
-    #
-    # @return [Array<Geocaching::PocketQuery>]
-    #   Array of Pocket Queries ready for download
-    def self.ready_for_download
-      raise LoginError unless HTTP.loggedin?
-
-      pqs = []
-      resp, data = HTTP.get("/pocket/default.aspx")
-      doc = Nokogiri::HTML.parse(data)
-
-      elements = doc.search("table#uxOfflinePQTable")
-      raise ParseError unless elements.size == 1
-
-      elements = elements.first.search("tr")[1..-1]
-
-      elements.each do |row|
-        # Name
-        elements = row.search("td:nth-child(3) > a")
-        next unless elements.size == 1
-        name = elements.first.text.strip
-
-        # GUID
-        if elements.first["href"] =~ /g=([a-f0-9-]{36})/
-          guid = $1
-        else
-          next
-        end
-
-        # Number of results
-        elements = row.search("td:nth-child(5)")
-        next unless elements.size == 1
-        results = elements.first.text.to_i
-
-        # Last Generated date
-        elements = row.search("td:nth-child(6)")
-        next unless elements.size == 1
-        if elements.first.text =~ /(\d{2})\/(\d{2})\/(\d{4})/
-          date = Time.mktime($3, $1, $2)
-        end
-
-        if guid and name and results and date
-          pq = PocketQuery.new \
-            :guid              => guid,
-            :name              => name,
-            :results           => results,
-            :last_generated_at => date
-          pqs << pq
-        end
-      end
-
-      pqs
-    end
-
-    class << self
-      alias ready ready_for_download
-    end
-
-    # Adds the ”My Finds“ Pocket Query to the Queue.
-    #
-    # @return [void]
-    def self.schedule_my_finds
-      resp, data = HTTP.post("/pocket/default.aspx", {
-        "ctl00$ContentBody$PQListControl1$btnScheduleNow" => "Yes"
-      })
-
-      !!(data =~ /Your 'My Finds' Pocket Query has been scheduled to run./)
-    end
-
-    # Creates a new instance.  The following attributes may be specified
-    # as parameters:
-    #
-    # * +:guid+ — The Pocket Query’s GUID
-    #
-    # @param [Hash] attributes A hash of attributes
-    # @raise [ArgumentError] Trying to set an unknown attribute
-    def initialize(attributes = {})
-      attributes.each do |key, value|
-        if [:guid, :name, :results, :last_generated_at, :raw].include?(key)
-          if key == :last_generated_at and not value.kind_of?(Time)
-            raise TypeError, \
-              "Attribute `last_generated_at' must be an instance of Time"
-          end
-
-          if key == :results and not value.kind_of?(Fixnum)
-            raise TypeError, "Attribute `results' must be a number"
-          end
-
-          instance_variable_set("@#{key}", value)
-        else
-          raise ArgumentError, "Trying to set unknown attribute `#{key}'"
-        end
-      end
-    end
-
-    # Returns the Pocket Query’s GUID.
-    #
-    # @return [String] GUID
-    def guid
-      @guid
-    end
-
-    # Returns the Pocket Query’s name.
-    #
-    # @return [String] Name
-    def name
-      @name ||= begin
-        @gpx.xpath("/xmlns:gpx/xmlns:name").content if @gpx
-      end
-    end
-
-    # Returns the date the Pocket Query was last generated at.
-    #
-    # @return [Time] Last generated date
-    def last_generated_at
-      @last_generated_at ||= begin
-        if @gpx
-          # ...
-        end
-      end
-    end
-
-    # Returns the number of results inside the Pocket Query.
-    #
-    # @return [Fixnum] Number of results
-    def results
-      @results ||= begin
-        @caches.size if @caches
-      end
-    end
-
-    # Returns the Pocket Query’s raw data.  This may be either zipped data
-    # or a GPX document.
-    #
-    # @return [String] Raw data (zip or gpx)
-    def raw
-      @raw || begin
-        raise NotFetchedError, "You have to download the Pocket Query first"
-      end
-    end
-
-    # Returns the Nokogiri XML document object for the GPX tree.
-    #
-    # @return [Nokogiri::XML::Document] Nokogiri XML document
-    def gpx
-      @gpx || begin
-        raise NotFetchedError, "You have to download the Pocket Query first"
-      end
-    end
-
-    # Downloads and parses the Pocket Query.
-    #
-    # @return [void]
-    def download
-      raise LoginError unless HTTP.loggedin?
-
-      resp, @raw = HTTP.get("/pocket/downloadpq.ashx?g=#{guid}")
-      parse
-    end
-
-  private
-
-    # Parses the Pocket Query’s GPX document.
-    #
-    # @return [void]
-    def parse
-      unless @raw
-        raise NotFetchedError, "You have to download the Pocket Query first"
-      end
-
-      if @raw[0..2] == "PK"
-        raise "Support for zip Pocket Query isn’t implemented yet"
-      else
-        @gpx = Nokogiri::XML.parse(@raw)
-      end
-    end
-  end
-end

data/spec/cache/ape.rb

@@ -1,75 +0,0 @@
-# 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 ID" do
-    @cache.id.should == 4457
-  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

data/spec/cache/cito.rb

@@ -1,75 +0,0 @@
-# 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 ID" do
-    @cache.id.should == 1325573
-  end
-
-  it "should return the correct name" do
-    @cache.name.should == "1. Dresdner CITO"
-  end
-
-  it "should return the correct displayed owner name" do
-    @cache.owner_display_name.should == "GPS-Murmel, afrineo, Karrataka"
-  end
-
-  it "should return the correct owner GUID" do
-    @cache.owner.guid == "b2fcf494-ecb8-4862-a279-03a325f6e1a1"
-  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
-
-  it "should return cache is not in review" do
-    @cache.in_review?.should == false
-  end
-end

data/spec/cache/earthcache.rb

@@ -1,75 +0,0 @@
-# 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 ID" do
-    @cache.id.should == 1642655
-  end
-
-  it "should return the correct name" do
-    @cache.name.should == "Kniepsand Amrum (Earthcache)"
-  end
-
-  it "should return the correct displayed owner name" do
-    @cache.owner_display_name.should == "Ifranipop"
-  end
-
-  it "should return the correct owner GUID" do
-    @cache.owner.guid == "4fcca7ab-b4c7-42ee-86d6-c61056a9263e"
-  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
-
-  it "should return cache is not in review" do
-    @cache.in_review?.should == false
-  end
-end