fireeagle 0.0.2 → 0.6.0

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,128 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+XML_ERROR_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="fail">
+  <err code="11" msg="Something bad happened" />
+</rsp>
+RESPONSE
+
+XML_LOCATION_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok" xmlns:georss="http://www.georss.org/georss">
+  <user token="16w3z6ysudxt">
+    <location-hierarchy>
+      <location best-guess="false">
+        <georss:box>38.5351715088 -121.7948684692 38.575668335 -121.6747894287</georss:box>
+        <level>3</level>
+        <level-name>city</level-name>
+        <located-at>2008-01-22T14:23:11-08:00</located-at>
+        <name>Davis, CA</name>
+        <place-id>u4L9ZOObApTdx1q3</place-id>
+      </location>
+      <location best-guess="true">
+        <georss:box>38.3131217957 -122.4230804443 38.9261016846 -121.5012969971</georss:box>
+        <level>4</level>
+        <level-name>region</level-name>
+        <located-at>2008-01-22T18:45:26-08:00</located-at>
+        <name>Yolo County, California</name>
+        <place-id>YUYMh9CbBJ61mgFe</place-id>
+      </location>
+      <location best-guess="false">
+        <georss:box>32.5342788696 -124.4150238037 42.0093803406 -114.1308135986</georss:box>
+        <level>5</level>
+        <level-name>state</level-name>
+        <located-at>2008-01-22T18:45:26-08:00</located-at>
+        <name>California</name>
+        <place-id>SVrAMtCbAphCLAtP</place-id>
+      </location>
+      <location best-guess="false">
+        <georss:box>18.9108390808 -167.2764129639 72.8960571289 -66.6879425049</georss:box>
+        <level>6</level>
+        <level-name>country</level-name>
+        <located-at>2008-01-22T18:45:26-08:00</located-at>
+        <name>United States</name>
+        <place-id>4KO02SibApitvSBieQ</place-id>
+      </location>
+    </location-hierarchy>
+  </user>
+</rsp>
+RESPONSE
+
+XML_SUCCESS_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok">
+  <user token="16w3z6ysudxt"/>
+</rsp>
+RESPONSE
+
+XML_LOCATION_CHUNK = <<-RESPONSE
+<location best-guess="false">
+  <georss:box>38.5351715088 -121.7948684692 38.575668335 -121.6747894287</georss:box>
+  <level>3</level>
+  <level-name>city</level-name>
+  <located-at>2008-01-22T14:23:11-08:00</located-at>
+  <name>Davis, CA</name>
+  <place-id>u4L9ZOObApTdx1q3</place-id>
+</location>
+RESPONSE
+
+XML_EXACT_LOCATION_CHUNK = <<-RESPONSE
+<location>
+  <georss:point>38.5351715088 -121.7948684692</georss:box>
+</location>
+RESPONSE
+
+XML_LOOKUP_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp stat="ok">
+  <querystring>q=30022</querystring>
+  <locations start="0" total="9" count="9">
+    <location>
+      <name>Alpharetta, GA 30022</name>
+      <place-id>IrhZMHuYA5s1fFi4Qw</place-id>
+    </location>
+    <location>
+      <name>Hannover, Region Hannover, Deutschland</name>
+      <place-id>88Hctc2bBZlhvlwbUg</place-id>
+    </location>
+    <location>
+      <name>N&#238;mes, Gard, France</name>
+      <place-id>Sut8q82bBZkF0s1eTg</place-id>
+    </location>
+    <location>
+      <name>Ceggia, Venezia, Italia</name>
+      <place-id>s9ulRieYA5TkNK9otw</place-id>
+    </location>
+    <location>
+      <name>Comit&#225;n de Dom&#237;nguez, Comitan de Dominguez, M&#233;xico</name>
+      <place-id>.51HvYKbBZnSAeNHWw</place-id>
+    </location>
+    <location>
+      <name>Platanos Aitoloakarnanias, Etolia Kai Akarnania, Greece</name>
+      <place-id>CmfJ2H.YA5QKpS56HQ</place-id>
+    </location>
+    <location>
+      <name>Krak&#243;w, Krak&#243;w, Polska</name>
+      <place-id>9bYc0l.bA5vPTGscQg</place-id>
+    </location>
+    <location>
+      <name>Nakuru, Kenya</name>
+      <place-id>VDprypWYA5sujnZphA</place-id>
+    </location>
+    <location>
+      <name>Fez, Al Magreb</name>
+      <place-id>BxOaGgSYA5R40Nm1RA</place-id>
+    </location>
+  </locations>
+</rsp>
+RESPONSE
+
+
+require File.dirname(__FILE__) + '/../lib/fireeagle'

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end

metadata

@@ -1,80 +1,113 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: fireeagle
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-06-22 00:00:00 -04:00
-summary: Fire Eagle is a site that keeps track of your current location and helps you share it with other sites and services safely. There are hundreds of potential applications. This gem exposes the FireEagle API as Ruby Classes
-require_paths: 
-- lib
-email: jnewland@gmail.com
-homepage: http://fireeagle.rubyforge.org
-rubyforge_project: fireeagle
-description: Fire Eagle is a site that keeps track of your current location and helps you share it with other sites and services safely. There are hundreds of potential applications. This gem exposes the FireEagle API as Ruby Classes
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.6.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Jesse Newland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: GeoRuby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+    version: 
+description: Ruby wrapper for Yahoo!'s FireEagle
+email: 
+- jnewland@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
 files: 
+- config/hoe.rb
+- config/requirements.rb
 - History.txt
 - License.txt
 - Manifest.txt
 - README.txt
 - Rakefile
 - lib/fireeagle.rb
-- lib/fireeagle/application.rb
-- lib/fireeagle/apibase.rb
-- lib/fireeagle/base.rb
+- lib/fireeagle/client.rb
 - lib/fireeagle/location.rb
+- lib/fireeagle/response.rb
 - lib/fireeagle/user.rb
 - lib/fireeagle/version.rb
-- scripts/txt2html
 - setup.rb
-- test/test_fireeagle.rb
-- test/test_fireeagle_application.rb
-- test/test_fireeagle_location.rb
-- test/test_fireeagle_user.rb
-- test/test_helper.rb
-test_files: 
-- test/test_fireeagle.rb
-- test/test_fireeagle_application.rb
-- test/test_fireeagle_location.rb
-- test/test_fireeagle_user.rb
-- test/test_helper.rb
+- spec/fireeagle_location_spec.rb
+- spec/fireeagle_response_spec.rb
+- spec/fireeagle_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/environment.rake
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://fireeagle.rubyforge.org
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- README.txt
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.5.145
-    version: 
+rubyforge_project: fireeagle
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Ruby wrapper for Yahoo!'s FireEagle
+test_files: []
+

data/lib/fireeagle/apibase.rb

@@ -1,6 +0,0 @@
-class FireEagle::APIBase < FireEagle::Base #:nodoc:
-	def initialize(fireeagle)
-	   super(:token => fireeagle.token, :secret => fireeagle.secret)
-	   @fireeagle = fireeagle
-	end
-end

data/lib/fireeagle/application.rb

@@ -1,37 +0,0 @@
-class FireEagle::Application < FireEagle::APIBase
-  #A user must authorize (or grant permissions to) an application before the application can write or read the user's location. This authorization process begins by directing a user to the authorization page, where the user logs in and chooses which permissions to grant to the requesting application. The authorization page generates a user token, specific to the requesting application, which can be returned to the requesting application in several ways:
-  # 
-  #1. User token passed back to requesting application via callback URL (if the callback parameter is supplied)
-  #2. User token displayed onscreen (this is good for testing, but will likely be phased out or modified in the future)
-  #3. User token is exchanged at a later time (good for mobile devices where a user may not want to enter their Yahoo! username/password)
-  #   
-  def authorize_url(callback_url = nil)
-    if callback_url.nil?
-      return "http://#{FireEagle::API_DOMAIN}/authorize.php?appid=#{@fireeagle.token}"
-    else
-      return "http://#{FireEagle::API_DOMAIN}/authorize.php?appid=#{@fireeagle.token}&callback=#{CGI::escape(callback_url)}"
-    end
-  end
-  
-  # URL needed to obtain a token to pass to exchange_token
-  def token_url
-    "http://#{FireEagle::API_DOMAIN}/displayToken.php?appid=#{@fireeagle.token}"
-  end
-  
-  #Applications which do not maintain a user repository (for example, a lightweight mobile application) may not wish to use the callback mechanism described above. These applications still must send users to authorize.php, but do not expect an immediate response (though at the moment, the authorize page will display the user token for easy testing and debugging). After the user has authorized an application, the application can later retrieve the user token in exchange for a short code obtained by the user from the Fire Eagle site. The user would retrieve a short code from the FE site and enter the code into the application which would then use the exchangeToken.php to exchange the short code for a full user token.
-  # 
-  #To obtain a short code users visit http://fireeagle.research.yahoo.com/displayToken.php?appid=TOKEN, where app token is the application token.
-  #
-  #Returnes an instance of FireEagle::User 
-  def exchange_token(shortcode = nil)
-    raise FireEagle::ArgumentError, "Shortcode required" if shortcode.nil?
-    request("exchangeToken", :shortcode => shortcode.to_s)
-  end
-  
-private
-  
-  def parse_response(doc)
-    raise FireEagle::FireEagleException, doc.at("/resultset/errormessage").innerText unless doc.at("/resultset").nil?
-    FireEagle::User.new_from_xml(@fireeagle, doc)
-  end
-end

data/lib/fireeagle/base.rb

@@ -1,89 +0,0 @@
-#The base class for interfacing w/ FireEagle
-#
-#  @fireeagle = Fireagle::Base.new(:token => "foo", :secret => "bar")
-#
-#Fire Eagle (FE) is a system providing centralized management of user location information. FE allows 3rd party developers to update and/or access user's location data.
-#
-#There are 3 data entities at Fire Eagle's core:
-# 
-#* User: Users can grant 3rd party applications privileges to read or write the user's location data. Users identify themselves to the FE system with their Yahoo! username/password. Applications identify a user with an application-specific user token (referred to in the API as a userid) generated by FE.
-#* Application: An application is identified by system-wide application token. Applications use this token (referred to in the API as an appid) and an application-specific secret to identify themselves to FE when reading or writing user location data.
-#* Location: FE stores the most recent location supplied by each application for each user. Applications can specify location in a number of ways: e.g. a latitude/longitude pair, a postal code, a street address, a GSM cell tower identifier, or an identifier from an external system (Plazes, Upcoming.org, etc.). See the Update API section for all possible location input options.
-# 
-#Only one location per user-application pair is stored, thus FE provides access only to a user's current location, not a location history of where the user has been. When a user's location is requested FE combines location info from one or more applications into a current best guess location record which is returned in XML format -- see the Query API Response section, below for details.
-class FireEagle::Base
-  
-  attr_reader :token, :secret
-  
-  #Create a new FireEagle::Base object.
-  #
-  # @fireeagle = Fireagle::Base.new(:token => "foo", :secret => "bar")
-  def initialize(options = {})
-    options = { :token => nil, :secret => nil }.merge(options)
-    raise FireEagle::ArgumentError, "Token and Secret required" if options[:token].nil? || options[:secret].nil?
-    @token = options[:token]
-    @secret = options[:secret]
-    @fireeagle = self
-  end
-  
-  # Return an instance of FireEagle::Application
-  def application() @application ||= FireEagle::Application.new(self) end
-
-private
-
-  # do the required api signing
-  def encode_and_sign(params = {})
-
-    #check for the params
-    raise ArgumentError, "Params required" if params == {} || !params.is_a?(Hash)
-
-    #remove any provided sig
-    params.delete(:sig)
-
-    #add the app token id
-    params[:appid] = @fireeagle.token
-
-    #sort and URL encode the params
-    normalized_params = {}
-    params.each_pair { |name, value| normalized_params[name.to_s] = value.to_s }
-
-    #build the string to sign
-    sig = "#{@fireeagle.secret}"
-    normalized_params.sort.each { |name, value| sig << "#{name}#{value}" } 
-
-    #sign it
-    normalized_params['sig'] = Digest::SHA1.hexdigest(sig)
-
-    #create and return the request string
-    request_string = "?" + normalized_params.sort.collect { |name, value| "#{name}=#{CGI::escape(value)}" }.join('&')
-  end
-
-  # request method which is used by all public methods
-  def request(action = nil,params = {})
-    raise ArgumentError, "Action name required" if action.nil?
-
-    #reject crap
-    params.reject { |key, value| value.nil? or (value.is_a?(String) and value.empty?)}
-    #merge timestamp
-    params.merge!( { :timestamp => Time.now.to_i } )
-
-    path = "#{FireEagle::API_PATH}#{action}.php#{encode_and_sign(params)}"
-    
-    puts path if FireEagle::DEBUG
-
-    response = Net::HTTP.get_response(FireEagle::API_DOMAIN, path)
-    
-    parse_response(Hpricot(response.body))   
-  end
-  
-  def parse_response(doc)
-    raise FireEagleException, doc.at("/resultset/errormessage").innerText unless !doc.at("/resultset").nil? and doc.at("/resultset/error").innerText.to_i == "0"
-    doc.at("/result")
-  end
-  
-  def fireeagle
-    fireeagle
-  end
-  
-  
-end