flexmls_api 0.3.6 → 0.4.5

data/spec/fixtures/standardfields_nearby.json

@@ -0,0 +1,53 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [{
+            "City": {
+                "ResourceUri": "/v1/standardfields/nearby/A/City",
+                "HasList": true,
+                "FieldList": [{
+                    "Name": "Fargo",
+                    "Value": "'Fargo'"
+                },
+                {
+                    "Name": "Moorhead",
+                    "Value": "'Moorhead'"
+                }],
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "PostalCode": {
+                "ResourceUri": "/v1/standardfields/nearby/A/PostalCode",
+                "HasList": true,
+                "FieldList": [{
+                    "Name": "56560",
+                    "Value": "'56560'"
+                },
+                {
+                    "Name": "58102",
+                    "Value": "'58102'"
+                },
+                {
+                    "Name": "58103",
+                    "Value": "'58103'"
+                }],
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "StateOrProvince": {
+                "ResourceUri": "/v1/standardfields/nearby/A/StateOrProvince",
+                "HasList": true,
+                "FieldList": [{
+                    "Name": "MN",
+                    "Value": "'MN'"
+                },
+                {
+                    "Name": "ND",
+                    "Value": "'ND'"
+                }],
+                "Searchable": true,
+                "Type": "Character"
+            }
+        }]
+    }
+}

data/spec/fixtures/standardfields_stateorprovince.json

@@ -0,0 +1,36 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [{
+            "StateOrProvince": {
+                "ResourceUri": "/v1/standardfields/StateOrProvince",
+                "FieldList": [{
+                    "Name": "IA",
+                    "Applies To": ["A", "B", "G", "I", "J", "K", "M"],
+                    "Value": "IA"
+                },
+                {
+                    "Name": "MN",
+                    "Value": "MN"
+                },
+                {
+                    "Name": "ND",
+                    "Value": "ND"
+                },
+                {
+                    "Name": "SD",
+                    "Applies To": ["A", "B", "G", "I", "J", "K", "M"],
+                    "Value": "SD"
+                },
+                {
+                    "Name": "WI",
+                    "Applies To": ["A", "B", "G", "I", "J", "K", "M"],
+                    "Value": "WI"
+                }],
+                "HasList": true,
+                "Searchable": true,
+                "Type": "Character"
+            }
+        }]
+    }
+}

data/spec/fixtures/tour_of_homes.json

@@ -0,0 +1,23 @@
+{
+    "D": {
+        "Results": [
+	        {"ResourceUri":"/listings/20060725224713296297000000/tourofhomes/20101127153422574618000000",
+	         "Id": "20101127153422574618000000",
+	         "Date": "10/01/2010",
+	         "StartTime": "09:00 AM",
+	         "EndTime": "12:00 PM",
+	         "Comments": "Wonderful home; must see!",
+	         "AdditionalInfo": [{"Hosted By": "Joe Smith"}, {"Host Phone": "123-456-7890"}, {"Tour Area": "North-Central"}]
+	        },
+	        {"ResourceUri":"/listings/20060725224713296297000000/tourofhomes/20101127153422174618000000",
+	         "Id": "20101127153422174618000000",
+	         "Date": "10/08/2010",
+	         "StartTime": "09:00 AM",
+	         "EndTime": "12:00 PM",
+	         "Comments": "Wonderful home; must see!",
+	         "AdditionalInfo": [{"Hosted By": "Joe Smith"}, {"Host Phone": "123-456-7890"}, {"Tour Area": "North-Central"}]
+	        }        
+        ],
+        "Success": true
+    }
+}

data/spec/spec_helper.rb

@@ -36,9 +36,23 @@ def mock_session()
   FlexmlsApi::Authentication::Session.new("AuthToken" => "1234", "Expires" => (Time.now + 3600).to_s, "Roles" => "['idx']")
 end
 
+def mock_oauth_session()
+  FlexmlsApi::Authentication::OAuthSession.new("access_token" => "1234", "expires_in" => 3600, "scope" => nil, "refresh_token"=> "1000refresh")
+end
 
 class MockClient < FlexmlsApi::Client
-  attr_accessor :connection, :session
+  attr_accessor :connection
+  
+  def connection(ssl = false)
+    @connection
+  end
+end
+
+class MockApiAuthenticator < FlexmlsApi::Authentication::ApiAuth
+  # Sign a request
+  def sign(sig)
+    "SignedToken"
+  end
 end
 
 def mock_client(stubs)
@@ -60,19 +74,22 @@ def test_connection(stubs)
   end
 end
 
-
 def stub_auth_request()
   stub_request(:post, "https://api.flexmls.com/#{FlexmlsApi.version}/session").
               with(:query => {:ApiKey => "", :ApiSig => "806737984ab19be2fd08ba36030549ac"}).
               to_return(:body => fixture("session.json"))
 end
 
-
-
-
 def fixture(file)
   File.new(File.expand_path("../fixtures", __FILE__) + '/' + file)
 end
 
+def reset_config()
+  FlexmlsApi.reset
+  FlexmlsApi.configure do |config|
+    config.api_user = "foobar"
+  end
+end
+reset_config
 
 include FlexmlsApi::Models

data/spec/unit/flexmls_api/authentication/api_auth_spec.rb

@@ -0,0 +1,159 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi::Authentication::ApiAuth  do
+  subject {FlexmlsApi::Authentication::ApiAuth.new(nil) }
+  describe "build_param_hash" do
+    it "should return a blank string when passed nil" do
+      subject.build_param_string(nil).should be_empty
+    end
+    it "should return a correct param string for one item" do
+      subject.build_param_string({:foo => "bar"}).should match("foobar")
+    end
+    it "should alphabatize the param names by key first, then by value" do
+      subject.build_param_string({:zoo => "zar", :ooo => "car"}).should match("ooocarzoozar")
+      subject.build_param_string({:Akey => "aValue", :aNotherkey => "AnotherValue"}).should 
+           match "AkeyaValueaNotherkeyAnotherValue"
+    end
+  end
+  
+  describe "authenticate" do
+    let(:client) { FlexmlsApi::Client.new({:api_key => "my_key", :api_secret => "my_secret"}) }
+    subject do
+      s = FlexmlsApi::Authentication::ApiAuth.new(client)
+      client.authenticator = s
+      s
+    end
+    it "should authenticate the api credentials" do
+      stub_request(:post, "https://api.flexmls.com/#{FlexmlsApi.version}/session").
+                  with(:query => {:ApiKey => "my_key", :ApiSig => "c731cf2455fbc7a4ef937b2301108d7a"}).
+                  to_return(:body => fixture("session.json"))
+      subject.authenticate()
+    end
+    it "should raise an error when api credentials are invalid" do
+      stub_request(:post, "https://api.flexmls.com/#{FlexmlsApi.version}/session").
+                  with(:query => {:ApiKey => "my_key", :ApiSig => "c731cf2455fbc7a4ef937b2301108d7a"}).
+                  to_return(:body => fixture("authentication_failure.json"), :status=>401)
+      expect {subject.authenticate()}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 401 }
+    end
+  end
+
+  describe "authenticated?" do
+    let(:session) { Object.new }
+    it "should return true when session is active" do
+      subject.session = session
+      session.stub(:expired?) { false }
+      subject.authenticated?.should eq(true)
+    end
+    it "should return false when session is expired" do
+      subject.session = session
+      session.stub(:expired?) { true }
+      subject.authenticated?.should eq(false)
+    end
+    it "should return false when session is uninitialized" do
+      subject.authenticated?.should eq(false)
+    end
+  end
+
+  describe "logout" do
+    let(:session) { mock_session }
+    let(:client) { Object.new }
+    subject {FlexmlsApi::Authentication::ApiAuth.new(client) }
+    it "should logout when there is an active session" do
+      logged_out = false
+      subject.session = session
+      client.stub(:delete).with("/session/1234") { logged_out = true }
+      subject.logout
+      subject.session.should eq(nil)
+      logged_out.should eq(true)
+    end
+    it "should skip logging out when there is no active session information" do 
+      client.stub(:delete) { raise "Should not be called" }
+      subject.logout.should eq(nil)
+    end
+  end
+  
+  # Since the request method is overly complex, the following tests just go through the whole stack
+  # with some semi realistic requests.  Performing this type of test here should allow us to safely
+  # mock out authentication for the rest of our unit tests and still have some decent coverage.
+  describe "request" do
+    let(:client) { FlexmlsApi::Client.new({:api_key => "my_key", :api_secret => "my_secret"}) }
+    let(:session) { mock_session }
+    subject do
+      s = FlexmlsApi::Authentication::ApiAuth.new(client)
+      client.authenticator = s
+      s.session = session
+      s
+    end
+    it "should handle a get request" do
+      stub_auth_request
+      args = {
+        :ApiUser => "foobar",
+        :_limit => '10',
+        :_page => '1',
+        :_pagination => '1'
+      }
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :ApiSig => "1cb789831f8f4c6925dc708c93762a2c",
+          :AuthToken => "1234"}.merge(args)).
+        to_return(:body => fixture("listing_no_subresources.json"))
+      subject.session = session
+      subject.request(:get, "/#{FlexmlsApi.version}/listings", nil, args).status.should eq(200)
+    end
+    it "should handle a post request" do
+      stub_auth_request
+      args = {:ApiUser => "foobar"}
+      contact = '{"D":{"Contacts":[{"DisplayName":"Contact Four","PrimaryEmail":"contact4@fbsdata.com"}]}}'
+      stub_request(:post, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/contacts").
+        with(:query => {
+          :ApiSig => "82898ef88d22e1b31bd2e2ea6bb8efe7",
+          :AuthToken => "1234"}.merge(args),
+          :body => contact
+          ).
+        to_return(:body => '{"D": {
+          "Success": true, 
+          "Results": [
+            {
+              "ResourceUri":"/v1/contacts/20101230223226074204000000"
+            }]}
+          }', 
+          :status=>201)
+      subject.request(:post, "/#{FlexmlsApi.version}/contacts", contact, args).status.should eq(201)
+    end
+  end
+  
+  describe "sign" do
+    it "should sign the auth parameters correctly" do
+      sign_token = "my_secretApiKeymy_key"
+      subject.sign(sign_token).should eq("c731cf2455fbc7a4ef937b2301108d7a")
+    end
+  end
+  
+  context "when the server says the session is expired (even if we disagree)" do
+    it "should reset the session and reauthenticate" do
+      count = 0
+      # Make sure the auth request goes out twice.
+      stub_request(:post, "https://api.flexmls.com/#{FlexmlsApi.version}/session").
+                  with(:query => {:ApiKey => "", :ApiSig => "806737984ab19be2fd08ba36030549ac"}).
+                  to_return do |r|
+                    count += 1
+                    {:body => fixture("session.json")}
+                  end
+      # Fail the first time, but then return the correct value after reauthentication
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234").
+          with(:query => {
+            :ApiSig => "554b6e2a3efec8719b782647c19d238d",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+            :ApiUser => "foobar",
+            :_expand => "Documents"
+          }).
+          to_return(:body => fixture('errors/expired.json'), :status => 401).times(1).then.
+          to_return(:body => fixture('listing_with_documents.json'))
+      l = Listing.find('1234', :_expand => "Documents")
+      
+      count.should eq(2)
+      FlexmlsApi.client.session.expired?.should eq(false)
+    end
+  end
+  
+end

data/spec/unit/flexmls_api/authentication/oauth2_spec.rb

@@ -0,0 +1,183 @@
+require './spec/spec_helper'
+
+# Lightweight example of an oauth2 provider used by the ruby client.
+class TestOAuth2Provider < FlexmlsApi::Authentication::BaseOAuth2Provider
+  
+  def initialize
+    @authorization_uri = "https://test.fbsdata.com/r/oauth2"
+    @access_uri = "https://api.test.fbsdata.com/v1/oauth2/grant"
+    @redirect_uri = "https://exampleapp.fbsdata.com/oauth-callback"
+    @client_id="example-id"
+    @client_secret="example-password"    
+    @session_cache = {}
+  end
+  
+  def redirect(url)
+    # User redirected to url, signs in, and gets code sent to callback
+    self.code="my_code"
+  end
+  
+  def load_session()
+    @session_cache["test_user_session"]
+  end
+  
+  def save_session(session)
+    @session_cache["test_user_session"] = session
+    nil
+  end
+  
+  def session_timeout; 7200; end
+  
+end
+
+describe FlexmlsApi::Authentication::OAuth2  do
+  let(:provider) { TestOAuth2Provider.new() }
+  let(:client) { FlexmlsApi::Client.new({:authentication_mode => FlexmlsApi::Authentication::OAuth2,:oauth2_provider => provider}) }
+  subject {client.authenticator }  
+  # Make sure the client boostraps the right plugin based on configuration.
+  describe "plugin" do
+    it "should load the oauth2 authenticator" do
+      client.authenticator.class.should eq(FlexmlsApi::Authentication::OAuth2)
+    end
+  end
+  describe "authenticate" do
+    it "should authenticate the api credentials" do
+      stub_request(:post, provider.access_uri).
+        with(:query => {
+            :client_id => provider.client_id,
+            :client_secret => provider.client_secret,
+            :grant_type => "authorization_code",
+            :redirect_uri => provider.redirect_uri,
+            :code => "my_code"
+          }
+        ).
+        to_return(:body => fixture("oauth2_access.json"), :status=>200)
+      subject.authenticate.access_token.should eq("04u7h-4cc355-70k3n")
+      subject.authenticate.expires_in.should eq(7200)
+    end
+    
+    it "should raise an error when api credentials are invalid" do
+      stub_request(:post, provider.access_uri).
+        with(:query => {
+            :client_id => provider.client_id,
+            :client_secret => provider.client_secret,
+            :grant_type => "authorization_code",
+            :redirect_uri => provider.redirect_uri,
+            :code => "my_code"
+          }
+        ).
+        to_return(:body => fixture("oauth2_error.json"), :status=>400)
+      expect {subject.authenticate()}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
+    end
+    
+  end
+
+  describe "authenticated?" do
+    let(:session) { Object.new }
+    it "should return true when session is active" do
+      subject.session = session
+      session.stub(:expired?) { false }
+      subject.authenticated?.should eq(true)
+    end
+    it "should return false when session is expired" do
+      subject.session = session
+      session.stub(:expired?) { true }
+      subject.authenticated?.should eq(false)
+    end
+    it "should return false when session is uninitialized" do
+      subject.authenticated?.should eq(false)
+    end
+  end
+
+  describe "logout" do
+    let(:session) { mock_oauth_session }
+    it "should logout when there is an active session" do
+      subject.session = session
+      subject.logout
+      subject.session.should eq(nil)
+    end
+    it "should skip logging out when there is no active session information" do 
+      client.stub(:delete) { raise "Should not be called" }
+      subject.logout.should eq(nil)
+    end
+  end
+  
+  describe "request" do
+    let(:session) { mock_oauth_session }
+    it "should handle a get request" do
+      subject.session = session
+      args = {
+        :_limit => '10',
+        :_page => '1',
+        :_pagination => '1'
+      }
+      c = stub_request(:get, "https://api.flexmls.com/#{FlexmlsApi.version}/listings").
+        with(:query => {:access_token => "1234"}.merge(args)).
+        to_return(:body => fixture("listing_no_subresources.json"))
+      subject.session = session
+      subject.request(:get, "/#{FlexmlsApi.version}/listings", nil, args).status.should eq(200)
+    end
+    it "should handle a post request" do
+      subject.session = session
+      args = {}
+      contact = '{"D":{"Contacts":[{"DisplayName":"Contact Four","PrimaryEmail":"contact4@fbsdata.com"}]}}'
+      stub_request(:post, "https://api.flexmls.com/#{FlexmlsApi.version}/contacts").
+        with(:query => {:access_token => "1234"}.merge(args),
+          :body => contact
+          ).
+        to_return(:body => '{"D": {
+          "Success": true, 
+          "Results": [
+            {
+              "ResourceUri":"/v1/contacts/20101230223226074204000000"
+            }]}
+          }', 
+          :status=>201)
+      subject.request(:post, "/#{FlexmlsApi.version}/contacts", contact, args).status.should eq(201)
+    end
+  end
+
+  context "when the server says the session is expired (even if we disagree)" do
+    it "should reset the session and reauthenticate" do
+      count = 0
+      stub_request(:post, provider.access_uri).
+        with(:query => {
+            :client_id => provider.client_id,
+            :client_secret => provider.client_secret,
+            :grant_type => "authorization_code",
+            :redirect_uri => provider.redirect_uri,
+            :code => "my_code"
+          }
+        ).
+        to_return do
+          count += 1
+          {:body => fixture("oauth2_access.json"), :status=>200}
+        end
+      # Make sure the auth request goes out twice.
+      # Fail the first time, but then return the correct value after reauthentication
+      stub_request(:get, "https://api.flexmls.com/#{FlexmlsApi.version}/listings/1234").
+        with(:query => {:access_token => "04u7h-4cc355-70k3n"}).
+          to_return(:body => fixture('errors/expired.json'), :status => 401).times(1).then.
+          to_return(:body => fixture('listing_with_documents.json'))
+            
+      client.get("/listings/1234")
+      count.should eq(2)
+      client.session.expired?.should eq(false)
+    end
+  end
+
+end
+
+describe FlexmlsApi::Authentication::BaseOAuth2Provider  do
+  context "session_timeout" do
+    it "should provide a default" do
+      subject.session_timeout.should eq(3600)
+    end
+    describe TestOAuth2Provider do
+      subject { TestOAuth2Provider.new }
+      it "should be able to override the session timeout" do
+        subject.session_timeout.should eq(7200)
+      end
+    end
+  end
+end