mojodna-fireeagle 0.7.0.1 → 0.8.0.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.8.0.0
+
+* Update recent method
+
+== 0.7.1.0
+
+* Fix OAuth Dependency Issue
+
 == 0.6.3
 
 * Bugfix for Ruby 1.9

data/config/requirements.rb

@@ -2,7 +2,7 @@ require 'fileutils'
 include FileUtils
 
 require 'rubygems'
-%w[rake hoe newgem rubigen oauth GeoRuby].each do |req_gem|
+%w[rake hoe newgem rubigen oauth geo_ruby].each do |req_gem|
   begin
     require req_gem
   rescue LoadError
@@ -15,4 +15,4 @@ end
 
 $:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
 
-require 'fireeagle'
+require 'fireeagle'

data/lib/fireeagle/client.rb

@@ -1,4 +1,4 @@
-class FireEagle
+module FireEagle
   class Client
     # TODO add access_token=() and request_token=() methods that check whether the tokens are usable
     
@@ -114,7 +114,7 @@ class FireEagle
       "#{FireEagle::MOBILE_AUTH_URL}#{@app_id}"
     end
 
-    # The URL the user must access to authorize this token. request_token must be called first. For use by web-based and desktop-based applications.
+    # The URL the user must access to authorize this token. get_request_token must be called first. For use by web-based and desktop-based applications.
     def authorization_url
       raise FireEagle::ArgumentError, "call #get_request_token first" if @request_token.nil?
       request_token.authorize_url
@@ -154,7 +154,7 @@ class FireEagle
     # * <tt>plazes_id</tt>
     def lookup(params)
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
-      response = get(FireEagle::LOOKUP_API_PATH + ".#{format}", :params => params)
+      response = get(FireEagle::LOOKUP_API_PATH, :params => params)
       FireEagle::Response.new(response.body).locations
     end
 
@@ -186,14 +186,14 @@ class FireEagle
     def update(location = {})
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
       location = sanitize_location_hash(location)
-      response = post(FireEagle::UPDATE_API_PATH + ".#{format}", :params => location)
+      response = post(FireEagle::UPDATE_API_PATH, :params => location)
       FireEagle::Response.new(response.body)
     end
 
     # Returns the Location of a User.
     def user
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
-      response = get(FireEagle::USER_API_PATH + ".#{format}")
+      response = get(FireEagle::USER_API_PATH)
       FireEagle::Response.new(response.body).users.first
     end
     alias_method :location, :user
@@ -203,13 +203,13 @@ class FireEagle
     #
     # == Optional parameters:
     #
-    # <tt>count</tt>  Number of users to return per page. (default: 10)
-    # <tt>start</tt>  The page number at which to start returning the list of users. Pages are 0-indexed, each page contains the per_page number of users. (default: 0)
     # <tt>time</tt>   The time to start looking at recent updates from. Value is flexible, supported forms are 'now', 'yesterday', '12:00', '13:00', '1:00pm' and '2008-03-12 12:34:56'. (default: 'now')
-    def recent(count = 10, start = 0, time = 'now')
+    # <tt>count</tt>  Number of users to return per page. (default: 10)
+    # <tt>start</tt>  The page number at which to start returning the list of users.
+    def recent(time = 'now', count = 10, start = 1)
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
       params = { :count => count, :start => start, :time => time }
-      response = get(FireEagle::RECENT_API_PATH + ".#{format}", :params => params)
+      response = get(FireEagle::RECENT_API_PATH, :params => params)
       FireEagle::Response.new(response.body).users
     end
 
@@ -233,11 +233,11 @@ class FireEagle
     # * <tt>upcoming_venue_id</tt>
     # * <tt>yahoo_local_id</tt>
     # * <tt>plazes_id</tt>
-    def within(location = {}, count = 10, start = 0)
+    def within(location = {}, count = 10, start = 1)
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
       location = sanitize_location_hash(location)
       params = { :count => count, :start => start }.merge(location)
-      response = get(FireEagle::WITHIN_API_PATH + ".#{format}", :params => params)
+      response = get(FireEagle::WITHIN_API_PATH, :params => params)
       FireEagle::Response.new(response.body).users
     end
 
@@ -265,17 +265,17 @@ class FireEagle
     def request(method, url, options) #:nodoc:
       response = case method
       when :post
-        access_token.request(:post, url, options[:params])
+        access_token.request(:post, "#{url}.#{format}", options[:params])
       when :get
         qs = options[:params].collect { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&") if options[:params]
-        access_token.request(:get, "#{url}?#{qs}")
+        access_token.request(:get, "#{url}.#{format}?#{qs}")
       else
         raise ArgumentError, "method #{method} not supported"
       end
 
       case response.code
+      when '404'; then raise FireEagle::FireEagleException, "Not Found"
       when '500'; then raise FireEagle::FireEagleException, "Internal Server Error"
-      when '400'; then raise FireEagle::FireEagleException, "Method Not Implemented Yet"
       else response
       end
     end

data/lib/fireeagle/location.rb

@@ -1,5 +1,5 @@
 #Describes a location
-class FireEagle
+module FireEagle
   class Location
 
     #Initialize a Location from an XML response
@@ -49,6 +49,21 @@ class FireEagle
       @lower_corner ||= @georss[0..1] rescue nil
     end
 
+    # The actual query that the user used so that it can be geocoded by the
+    # consumer since the Yahoo! geocoder is a little flaky, especially when it
+    # comes to intersections etc.
+    #
+    # Turns something like this:
+    #
+    # <query> "q=333%20W%20Harbor%20Dr,%20San%20Diego,%20CA" </query>
+    # 
+    # into
+    #
+    # 333 W Harbor Dr, San Diego, CA
+    def query
+      @query ||= CGI::unescape((@doc.at("/location/query").innerText).gsub('"', '').split('=')[1]).strip rescue nil
+    end
+
     # The GeoRuby[http://georuby.rubyforge.org/] representation of this location
     def geom
       if @doc.at("/location//georss:box")
@@ -67,4 +82,4 @@ class FireEagle
     end
 
   end
-end
+end

data/lib/fireeagle/response.rb

@@ -1,4 +1,4 @@
-class FireEagle
+module FireEagle
   class Response
 
     #Parses the XML response from FireEagle

data/lib/fireeagle/user.rb

@@ -1,6 +1,5 @@
-class FireEagle
+module FireEagle
   class User
-
     #Parses the XML response from FireEagle.
     def initialize(doc)
       doc = Hpricot(doc) unless doc.is_a?(Hpricot::Doc || Hpricot::Elem)
@@ -12,6 +11,11 @@ class FireEagle
       @token ||= @doc.at("/user").attributes["token"] rescue nil
     end
 
+    #The time at which this user was last located
+    def located_at
+      @located_at ||= Time.parse(@doc.at("/user").attributes["located-at"]) rescue nil
+    end
+
     #FireEagle's "best guess" form this User's Location. This best guess is derived as the most accurate
     #level of the hierarchy with a timestamp in the last half an hour <b>or</b> as the most accurate
     #level of the hierarchy with the most recent timestamp.

data/lib/fireeagle/version.rb

@@ -1,7 +1,7 @@
-class FireEagle #:nodoc:
+module FireEagle #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 7
+    MINOR = 8
     TINY  = 0
     TEENY = 0
 

data/lib/fireeagle.rb

@@ -1,13 +1,14 @@
 require 'time'
 require 'net/https'
 require 'rubygems'
-gem 'oauth', ">= 0.2.1"
+gem 'oauth', ">= 0.2.4"
+require 'oauth/helper'
 require 'oauth/client/helper'
 require 'oauth/request_proxy/net_http'
 require 'hpricot'
 require 'geo_ruby'
 
-class FireEagle
+module FireEagle
   API_SERVER = "https://fireeagle.yahooapis.com"
   AUTH_SERVER = "https://fireeagle.yahoo.net"
   REQUEST_TOKEN_PATH = "/oauth/request_token"

data/spec/fireeagle_location_spec.rb

@@ -5,6 +5,8 @@ describe "FireEagle Location" do
   before(:each) do
     location = Hpricot.XML(XML_LOCATION_CHUNK)
     @location = FireEagle::Location.new(location)
+    location_with_query = Hpricot.XML(XML_QUERY_LOCATION_CHUNK)
+    @location_with_query = FireEagle::Location.new(location_with_query)
   end
 
   it "should know if this is a best guess" do
@@ -35,6 +37,10 @@ describe "FireEagle Location" do
     @location.to_s.should == @location.name
   end
 
+  it "should return the actual query string" do
+    @location_with_query.query.should == "333 W Harbor Dr, San Diego, CA"
+  end
+
   describe "GeoRuby support" do
 
     it "should represent a bounding box as a GeoRuby Envelope" do
@@ -57,4 +63,4 @@ describe "FireEagle Location" do
 
   end
 
-end
+end

data/spec/fireeagle_response_spec.rb

@@ -57,7 +57,7 @@ describe "FireEagle Response" do
   describe "error handling" do
 
     it "should raise an exception when returned xml with a status of fail" do
-      lambda { FireEagle::Response.new(XML_ERROR_RESPONSE) }.should raise_error(FireEagle::FireEagleException)
+      lambda { FireEagle::Response.new(XML_ERROR_RESPONSE) }.should raise_error(FireEagle::FireEagleException, "Something bad happened")
     end
 
   end

data/spec/fireeagle_spec.rb

@@ -134,11 +134,12 @@ describe "FireEagle" do
   end
 
   describe "lookup method" do
-
     before(:each) do
-      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
-      @response = stub('response', :body => XML_LOOKUP_RESPONSE)
-      @client.stub!(:request).and_return(@response)
+      @client       = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      response      = stub('response', :body => XML_LOOKUP_RESPONSE)
+      fail_response = stub('fail response', :body => XML_FAIL_LOOKUP_RESPONSE)
+      @client.stub!(:request).with(:get, FireEagle::LOOKUP_API_PATH, :params => {:q => "30022"}).and_return(response)
+      @client.stub!(:request).with(:get, FireEagle::LOOKUP_API_PATH, :params => {:mnc => 12, :mcc => 502, :lac => 2051, :cellid => 39091}).and_return(fail_response)
     end
 
     it "should return an array of Locations" do
@@ -153,6 +154,11 @@ describe "FireEagle" do
       @client.lookup(:q => "30022").first.name.should == "Alpharetta, GA 30022"
     end
 
+    it "should raise an exception if the lookup failed" do
+      lambda {
+        @client.lookup(:mnc => 12, :mcc => 502, :lac => 2051, :cellid => 39091)
+      }.should raise_error(FireEagle::FireEagleException, "Place can't be identified.")
+    end
   end
 
   describe "within method" do
@@ -179,12 +185,45 @@ describe "FireEagle" do
     end
 
     it "should return an array of Users" do
-      @client.recent(2, 1, 'yesterday').should have(2).users
+      @client.recent('yesterday', 3, 1).should have(3).users
     end
 
-    it "should return an array of Locations for each" do
-      @client.recent(2, 1, 'yesterday').first.should have(5).locations
+    it "should have an 'located_at' timestamp for each user" do
+      @client.recent('yesterday', 3, 1).first.located_at.should == Time.parse('2008-07-31T22:31:37+12:00')
     end
   end
 
+  describe "making a request" do
+    before do
+      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      @access_token = stub('access token')
+      @client.stub!(:access_token).and_return(@access_token)
+    end
+
+    it "should not raise any exception when response is OK" do
+      response = stub('response', :code => '200', :body => XML_RECENT_RESPONSE)
+      @access_token.stub!(:request).and_return(response)
+      lambda { @client.recent }.should_not raise_error
+    end
+
+    it "should raise an exception when requesting to a resource that doesn't exist (404)" do
+      response = stub('response', :code => '404', :body => '')
+      @access_token.stub!(:request).and_return(response)
+      lambda { @client.recent }.should raise_error(FireEagle::FireEagleException, 'Not Found')
+    end
+
+    it "should raise an exception when requesting to a resource that hit an internal server error (500)" do
+      response = stub('response', :code => '500', :body => '')
+      @access_token.stub!(:request).and_return(response)
+      lambda { @client.recent }.should raise_error(FireEagle::FireEagleException, 'Internal Server Error')
+    end
+
+    it "should raise an exception when response is apart from 200, 404 and 500" do
+      %w{401 403 405}.each do |code|
+        response = stub('response', :code => code, :body => XML_ERROR_RESPONSE)
+        @access_token.stub!(:request).and_return(response)
+        lambda { @client.recent }.should raise_error(FireEagle::FireEagleException, 'Something bad happened')
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ rescue LoadError
   gem 'rspec'
   require 'spec'
 end
+require 'time'
 
 XML_ERROR_RESPONSE = <<-RESPONSE
 <?xml version="1.0" encoding="utf-8"?>
@@ -73,6 +74,19 @@ XML_LOCATION_CHUNK = <<-RESPONSE
 </location>
 RESPONSE
 
+XML_QUERY_LOCATION_CHUNK = <<-RESPONSE
+<location best-guess="true">
+  <id>111541</id>
+  <georss:point>32.7093315125 -117.1650772095</georss:point>
+  <level>0</level>
+  <level-name>exact</level-name>
+  <located-at>2008-03-03T09:05:16-08:00</located-at>
+  <name>333 W Harbor Dr, San Diego, CA</name>
+  <query> "q=333%20W%20Harbor%20Dr,%20San%20Diego,%20CA" </query>
+</location>
+RESPONSE
+
+
 XML_EXACT_LOCATION_CHUNK = <<-RESPONSE
 <location>
   <georss:point>38.5351715088 -121.7948684692</georss:box>
@@ -124,6 +138,13 @@ XML_LOOKUP_RESPONSE = <<-RESPONSE
 </rsp>
 RESPONSE
 
+XML_FAIL_LOOKUP_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="fail">
+  <err msg="Place can't be identified." code="6"/>
+</rsp>
+RESPONSE
+
 XML_WITHIN_RESPONSE = <<-RESPONSE
 <?xml version="1.0" encoding="UTF-8"?>
 <rsp stat="ok">
@@ -254,106 +275,13 @@ RESPONSE
 
 XML_RECENT_RESPONSE = <<-RESPONSE
 <?xml version="1.0" encoding="UTF-8"?>
-<rsp stat="ok" xmlns:georss="http://www.georss.org/georss">
+<rsp xmlns:georss="http://www.georss.org/georss" stat="ok">
   <users>
-    <user token="MQdDrJgXMNJi">
-      <location-hierarchy>
-        <location best-guess="true">
-          <id>111541</id>
-          <georss:point>32.7093315125 -117.1650772095</georss:point>
-          <level>0</level>
-          <level-name>exact</level-name>
-          <located-at>2008-03-03T09:05:16-08:00</located-at>
-          <name>333 W Harbor Dr, San Diego, CA</name>
-        </location>
-        <location best-guess="false">
-          <id>111551</id>
-          <georss:box>32.6916618347 -117.2174377441 32.744140625 -117.1458892822</georss:box>
-          <level>1</level>
-          <level-name>postal</level-name>
-          <located-at>2008-03-03T09:05:16-08:00</located-at>
-          <name>San Diego, CA 92101</name>
-          <place-id>NpiXqwmYA5viX3K3Ew</place-id>
-          <woeid>12796255</woeid>
-        </location>
-        <location best-guess="false">
-          <id>111561</id>
-          <georss:box>32.5349388123 -117.2884292603 33.1128082275 -116.9142913818</georss:box>
-          <level>3</level>
-          <level-name>city</level-name>
-          <located-at>2008-03-03T09:05:16-08:00</located-at>
-          <name>San Diego, CA</name>
-          <place-id>Nm4O.DebBZTYKUsu</place-id>
-          <woeid>2487889</woeid>
-        </location>
-        <location best-guess="false">
-          <id>111571</id>
-          <georss:box>32.5342788696 -124.4150238037 42.0093803406 -114.1308135986</georss:box>
-          <level>5</level>
-          <level-name>state</level-name>
-          <located-at>2008-03-03T09:05:16-08:00</located-at>
-          <name>California</name>
-          <place-id>SVrAMtCbAphCLAtP</place-id>
-          <woeid>2347563</woeid>
-        </location>
-        <location best-guess="false">
-          <id>111581</id>
-          <georss:box>18.9108390808 -167.2764129639 72.8960571289 -66.6879425049</georss:box>
-          <level>6</level>
-          <level-name>country</level-name>
-          <located-at>2008-03-03T09:05:16-08:00</located-at>
-          <name>United States</name>
-          <place-id>4KO02SibApitvSBieQ</place-id>
-          <woeid>23424977</woeid>
-        </location>
-      </location-hierarchy>
-    </user>
-    <user token="XMoZaTjZJiOQ">
-      <location-hierarchy>
-        <location best-guess="true">
-          <id>113221</id>
-          <georss:box>32.8155899048 -96.8162918091 32.8511695862 -96.7717132568</georss:box>
-          <level>1</level>
-          <level-name>postal</level-name>
-          <located-at>2008-03-03T10:24:24-08:00</located-at>
-          <name>Dallas, TX 75205</name>
-          <place-id>1KTPxFCYA5vlcics6A</place-id>
-          <woeid>12790441</woeid>
-        </location>
-        <location best-guess="false">
-          <id>113231</id>
-          <georss:box>32.6209487915 -96.9988708496 33.0258712769 -96.4660263062</georss:box>
-          <level>3</level>
-          <level-name>city</level-name>
-          <located-at>2008-03-03T10:24:24-08:00</located-at>
-          <name>Dallas, TX</name>
-          <place-id>bgWooz.bApRFBRNK</place-id>
-          <woeid>2388929</woeid>
-        </location>
-        <location best-guess="false">
-          <id>113241</id>
-          <georss:box>25.8372898102 -106.645652771 36.5006904602 -93.5079269409</georss:box>
-          <level>5</level>
-          <level-name>state</level-name>
-          <located-at>2008-03-03T10:24:24-08:00</located-at>
-          <name>Texas</name>
-          <place-id>b1Yi6qubApjz6jWW</place-id>
-          <woeid>2347602</woeid>
-        </location>
-        <location best-guess="false">
-          <id>113251</id>
-          <georss:box>18.9108390808 -167.2764129639 72.8960571289 -66.6879425049</georss:box>
-          <level>6</level>
-          <level-name>country</level-name>
-          <located-at>2008-03-03T10:24:24-08:00</located-at>
-          <name>United States</name>
-          <place-id>4KO02SibApitvSBieQ</place-id>
-          <woeid>23424977</woeid>
-        </location>
-      </location-hierarchy>
-    </user>
+    <user located-at="2008-07-31T22:31:37+12:00" token="5pyl1xip0uh6"/>
+    <user located-at="2008-07-31T21:49:03+12:00" token="i71yc3myixg3"/>
+    <user located-at="2008-07-30T21:40:54+12:00" token="q1jm8nubnpsi"/>
   </users>
 </rsp>
 RESPONSE
 
-require File.dirname(__FILE__) + '/../lib/fireeagle'
+require File.dirname(__FILE__) + '/../lib/fireeagle'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mojodna-fireeagle
 version: !ruby/object:Gem::Version 
-  version: 0.7.0.1
+  version: 0.8.0.0
 platform: ruby
 authors: 
 - Jesse Newland
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.1
+        version: 0.2.4
     version: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fireeagle
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Ruby wrapper for Yahoo!'s FireEagle