pezra-fireeagle 0.9.0.1

data/spec/fireeagle_location_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+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
+    @location.should_not be_best_guess
+  end
+
+  it "should represent the level" do
+    @location.level.should == 3
+  end
+
+  it "should represent the level name" do
+    @location.level_name.should == 'city'
+  end
+
+  it "should represent the location name" do
+    @location.name.should == 'Davis, CA'
+  end
+
+  it "should represent the location place id" do
+    @location.place_id.should == 'u4L9ZOObApTdx1q3'
+  end
+
+  it "should represent the location's timestamp" do
+    @location.located_at.should == Time.parse("2008-01-22T14:23:11-08:00")
+  end
+
+  it "should use the name for #to_s" 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
+      location = Hpricot.XML(XML_LOCATION_CHUNK)
+      @location = FireEagle::Location.new(location)
+      @location.geom.should be_an_instance_of(GeoRuby::SimpleFeatures::Envelope)
+    end
+
+    it "should represent an exact point as a GeoRuby Point" do
+      location = Hpricot.XML(XML_EXACT_LOCATION_CHUNK)
+      @location = FireEagle::Location.new(location)
+      @location.geom.should be_an_instance_of(GeoRuby::SimpleFeatures::Point)
+    end
+
+    it "should be aliased as 'geo'" do
+      location = Hpricot.XML(XML_EXACT_LOCATION_CHUNK)
+      @location = FireEagle::Location.new(location)
+      @location.geo.should be_an_instance_of(GeoRuby::SimpleFeatures::Point)
+    end
+
+  end
+
+end

data/spec/fireeagle_response_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "FireEagle Response" do
+
+  describe "user / location parsing" do
+
+    before(:each) do
+      @response = FireEagle::Response.new(XML_LOCATION_RESPONSE)
+    end
+
+    it "should indicate success" do
+      @response.should be_success
+    end
+
+    it "should have an array of users" do
+      @response.should have(1).users
+    end
+
+    it "should have each users' token" do
+      @response.users.first.token.should == "16w3z6ysudxt"
+    end
+
+    it "should flag the best guess" do
+      @response.users.first.best_guess.name.should == "Yolo County, California"
+    end
+
+    it "should have users' locations" do
+      @response.users.first.should have(4).locations
+    end
+
+  end
+
+  describe "location parsing" do
+
+    before(:each) do
+      @response = FireEagle::Response.new(XML_LOOKUP_RESPONSE)
+    end
+
+    it "should indicate success" do
+      @response.should be_success
+    end
+
+    it "should have an array of locations" do
+      @response.should have(9).locations
+    end
+
+    it "should have each location's place_id" do
+      @response.locations.first.place_id.should == "IrhZMHuYA5s1fFi4Qw"
+    end
+
+    it "should have each location's name" do
+      @response.locations.first.name.should == "Alpharetta, GA 30022"
+    end
+
+  end
+
+  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)
+    end
+
+  end
+
+end

data/spec/fireeagle_spec.rb

@@ -0,0 +1,190 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "FireEagle" do
+
+  describe "being initialized" do
+
+    it "should require OAuth Consumer Key and Secret" do
+      lambda do
+        client = FireEagle::Client.new({})
+      end.should raise_error(FireEagle::ArgumentError)
+    end
+
+    it "should initialize an OAuth::Consumer" do
+      @consumer = mock(OAuth::Consumer)
+      OAuth::Consumer.should_receive(:new).with('key', 'sekret', :site => FireEagle::API_SERVER, :authorize_url => FireEagle::AUTHORIZATION_URL).and_return(@consumer)
+      client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
+    end
+
+  end
+
+  describe "web app authentication scenario" do
+
+    it "should initialize an OAuth::AccessToken if given its token and secret" do
+      @access_token = mock(OAuth::AccessToken)
+      OAuth::AccessToken.stub!(:new).and_return(@access_token)
+      client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      client.access_token.should == @access_token
+    end
+
+    it "should initialize an OAuth::RequestToken if given its token and secret" do
+      @request_token = mock(OAuth::RequestToken)
+      OAuth::RequestToken.stub!(:new).and_return(@request_token)
+      client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :request_token => 'toke', :request_token_secret => 'sekret')
+      client.request_token.should == @request_token
+    end
+  end
+
+  describe "request token scenario" do
+    it "shouldn't initialize with a access_token" do
+      client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
+      client.access_token.should be_nil
+    end
+
+    it "should require token exchange before calling any API methods" do
+      client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
+      lambda do
+        client.user
+      end.should raise_error(FireEagle::ArgumentError)
+    end
+
+    it "should generate a Request Token URL" do
+      consumer = mock(OAuth::Consumer)
+      token    = mock(OAuth::RequestToken)
+      consumer.should_receive(:get_request_token).and_return(token)
+      token.should_receive(:authorize_url)
+
+      client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
+      client.should_receive(:consumer).and_return(consumer)
+      client.get_request_token
+      client.authorization_url
+    end
+
+    it "should require #get_request_token be called before #convert_to_access_token" do
+      lambda do
+        client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
+        client.convert_to_access_token("oauth-verifier-from-authorized-callback")
+      end.should raise_error(FireEagle::ArgumentError)
+    end
+
+    it "should require #get_request_token be called before #authorization_url" do
+      lambda do
+        client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
+        client.authorization_url
+      end.should raise_error(FireEagle::ArgumentError)
+    end
+
+    it "should generate an Access Token" do
+      consumer  = mock(OAuth::Consumer)
+      req_token = mock(OAuth::RequestToken)
+      acc_token = mock(OAuth::AccessToken)
+      consumer.should_receive(:get_request_token).and_return(req_token)
+      req_token.should_receive(:get_access_token).and_return(acc_token)
+
+      client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
+      client.should_receive(:consumer).and_return(consumer)
+
+      client.get_request_token
+      client.convert_to_access_token("oauth-verifier-from-authorized-callback")
+      client.access_token.should == acc_token
+    end
+
+  end
+
+  describe "update 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_SUCCESS_RESPONSE)
+      @client.stub!(:request).and_return(@response)
+    end
+
+    it "requires all or none of :lat, :lon" do
+      lambda { @client.update(:lat => 1) }.should raise_error(FireEagle::ArgumentError)
+      lambda { @client.update(:lat => 1, :lon => 2) }.should_not raise_error(FireEagle::ArgumentError)
+    end
+
+    it "requires all or none of :mnc, :mcc, :lac, :cellid" do
+      lambda { @client.update(:mcc => 123, :lac => "whatever", :cellid => true) }.should raise_error(FireEagle::ArgumentError)
+      lambda { @client.update(:mcc => 123, :mnc => 123123, :lac => "whatever", :cellid => true) }.should_not raise_error(FireEagle::ArgumentError)
+    end
+
+    it "should wrap the result" do
+      @client.update(:mcc => 123, :mnc => 123123, :lac => "whatever", :cellid => true).users.first.token.should == "16w3z6ysudxt"
+    end
+
+  end
+
+  describe "user 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_LOCATION_RESPONSE)
+      @client.stub!(:request).and_return(response)
+    end
+
+    it "should return a best guess" do
+      @client.user.best_guess.name.should == "Yolo County, California"
+    end
+
+    it "should return several locations" do
+      @client.user.should have(4).locations
+    end
+
+  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)
+    end
+
+    it "should return an array of Locations" do
+      @client.lookup(:q => "30022").should have(9).items
+    end
+
+    it "should return a place id for each" do
+      @client.lookup(:q => "30022").first.place_id.should == "IrhZMHuYA5s1fFi4Qw"
+    end
+
+    it "should return a name for each" do
+      @client.lookup(:q => "30022").first.name.should == "Alpharetta, GA 30022"
+    end
+
+  end
+
+  describe "within method" do
+    before do
+      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      @response = stub('response', :body => XML_WITHIN_RESPONSE)
+      @client.stub!(:request).and_return(@response)
+    end
+
+    it "should return an array of Users" do
+      @client.within(:woe => "12796255").should have(2).users
+    end
+
+    it "should return an array of Locations for each" do
+      @client.within(:woe => "12796255").first.should have(5).locations
+    end
+  end
+
+  describe "recent method" do
+    before do
+      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      @response = stub('response', :body => XML_RECENT_RESPONSE)
+      @client.stub!(:request).and_return(@response)
+    end
+
+    it "should return an array of Users" do
+      @client.recent('yesterday', 3, 1).should have(3).users
+    end
+
+    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
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,280 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+require 'time'
+
+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_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>
+</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
+
+XML_WITHIN_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp 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="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>
+  </users>
+</rsp>
+RESPONSE
+
+XML_RECENT_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp xmlns:georss="http://www.georss.org/georss" stat="ok">
+  <users>
+    <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'