flexmls_api 0.3.2

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require "rubygems"
+require "json"
+require "rspec"
+require 'webmock/rspec'
+
+
+Rspec.configure do |config|
+  config.include WebMock::API
+end
+
+begin require "redgreen" unless ENV['TM_CURRENT_LINE']; rescue LoadError; end
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+require path + '/flexmls_api'
+
+require 'flexmls_api'
+require File.expand_path('../json_helper', __FILE__)
+
+
+FileUtils.mkdir 'log' unless File.exists? 'log'
+
+# TODO, really we should change the library to support configuration without overriding
+module FlexmlsApi
+  def self.logger
+    if @logger.nil?
+      @logger = Logger.new('log/test.log')
+      @logger.level = Logger::DEBUG
+    end
+    @logger
+  end
+end
+
+FlexmlsApi.logger.info("Setup gem for rspec testing")
+
+def mock_session()
+  FlexmlsApi::Authentication::Session.new("AuthToken" => "1234", "Expires" => (Time.now + 3600).to_s, "Roles" => "['idx']")
+end
+
+
+class MockClient < FlexmlsApi::Client
+  attr_accessor :connection, :session
+end
+
+def mock_client(stubs)
+  c = MockClient.new
+  c.session = mock_session()
+  c.connection = test_connection(stubs)
+  c
+end
+
+def mock_expired_session()
+  FlexmlsApi::Authentication::Session.new("AuthToken" => "1234", "Expires" => (Time.now - 60).to_s, "Roles" => "['idx']")
+end
+
+def test_connection(stubs)
+  Faraday::Connection.new(nil, {:headers => FlexmlsApi::Client.new.headers}) do |builder|
+    builder.adapter :test, stubs
+    builder.use Faraday::Response::ParseJson
+    builder.use FlexmlsApi::FaradayExt::FlexmlsMiddleware
+  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
+
+
+include FlexmlsApi::Models

data/spec/unit/flexmls_api/configuration_spec.rb

@@ -0,0 +1,97 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi::Client, "Client config"  do
+  after(:each) do
+    FlexmlsApi.reset
+  end
+
+  describe "default settings" do
+    it "should return the proper defaults when called with no arguments" do
+      FlexmlsApi.api_key.should be_nil
+      FlexmlsApi.api_secret.should be_nil
+      FlexmlsApi.version.should match "v1"
+      FlexmlsApi.endpoint.should match "api.flexmls.com"
+
+      FlexmlsApi.api_key = "my_api_key"
+      FlexmlsApi.api_key.should match "my_api_key"
+    end
+  end
+
+  describe "instance config" do
+    it "should return a properly configured client" do
+      client = FlexmlsApi::Client.new(:api_key => "key_of_wade", 
+                                      :api_secret => "TopSecret", 
+                                      :endpoint => "http://api.wade.dev.fbsdata.com")
+ 
+      client.api_key.should match "key_of_wade"
+      client.api_secret.should match "TopSecret"
+      client.endpoint.should match "http://api.wade.dev.fbsdata.com"
+      client.version.should match "v1"
+    end
+  end
+
+  describe "block config" do
+    it "should correctly set up the client" do
+      FlexmlsApi.configure do |config|
+        config.api_key = "my_key"
+        config.api_secret = "my_secret"
+        config.version = "veleventy"
+        config.endpoint = "test.api.flexmls.com"
+        config.user_agent = "my useragent"
+      end
+
+      FlexmlsApi.api_key.should match "my_key"
+      FlexmlsApi.api_secret.should match "my_secret"
+      FlexmlsApi.version.should match "veleventy"
+      FlexmlsApi.endpoint.should match "test.api.flexmls.com"
+      FlexmlsApi.user_agent.should match "my useragent"
+
+    end
+    
+    it "should reset" do
+      FlexmlsApi.configure do |config|
+        config.api_key = "my_key"
+        config.api_secret = "my_secret"
+        config.version = "veleventy"
+        config.endpoint = "test.api.flexmls.com"
+        config.user_agent = "my useragent"
+      end
+      
+      FlexmlsApi.api_key.should match "my_key"
+      FlexmlsApi.reset
+      FlexmlsApi.api_key.should == FlexmlsApi::Configuration::DEFAULT_API_KEY
+    
+    end
+  end
+
+  describe "connections" do
+    it "should use http by default" do
+      stub_auth_request
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/connections").
+          with(:query => {
+            :ApiSig => "951e5ba0496b0758356d3cc7676f8b21",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":false}]}}')
+          
+      FlexmlsApi.client.get('/connections')[0]["SSL"].should eq false
+
+    end
+
+    it "should use https when ssl is enabled" do
+      stub_auth_request
+      stub_request(:get, "https://api.flexmls.com/#{FlexmlsApi.version}/connections").
+          with(:query => {
+            :ApiSig => "951e5ba0496b0758356d3cc7676f8b21",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":true}]}}')
+      c = FlexmlsApi::Client.new(:endpoint => "https://api.flexmls.com",
+                                :ssl => true)
+      c.get('/connections')[0]["SSL"].should eq true
+    end
+    
+  end
+
+end
+

data/spec/unit/flexmls_api/faraday_spec.rb

@@ -0,0 +1,94 @@
+require './spec/spec_helper'
+
+# Test out the faraday connection stack.
+describe FlexmlsApi do
+  describe "FlexmlsMiddleware" do
+    before(:all) do
+      stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('/session') { [200, {}, '{"D": { 
+            "Success": true,
+            "Results": [{
+                "AuthToken": "xxxxx",
+                "Expires": "2010-10-30T15:49:01-05:00",
+                "Roles": ["idx"] 
+                }]
+          }}'] 
+        }
+        stub.get('/system') { [200, {}, '{"D": {
+          "Success": true, 
+          "Results": [{
+            "Name": "My User", 
+            "OfficeId": "20070830184014994915000000", 
+            "Configuration": [], 
+            "Id": "20101202170654111629000000", 
+            "MlsId": "20000426143505724628000000", 
+            "Office": "test office", 
+            "Mls": "flexmls Web Demonstration Database"
+          }]}
+          }'] 
+        }
+        stub.get('/expired') { [401, {}, '{"D": { 
+            "Success": false,
+            "Message": "Session token has expired",
+            "Code": 1020            
+          }}'] 
+        }
+        stub.get('/methodnotallowed') { [405, {}, '{"D": { 
+            "Success": false,
+            "Message": "Method Not Allowed",
+            "Code": "1234"            
+          }}'] 
+        }
+        stub.get('/epicfail') { [500, {}, '{"D": { 
+            "Success": false,
+            "Message": "EPIC FAIL",
+            "Code": "0000"            
+          }}'] 
+        }
+        stub.get('/unknownerror') { [499, {}, '{"D": { 
+            "Success": false,
+            "Message": "Some random status error",
+            "Code": "0000"
+          }}'] 
+        }
+        stub.get('/invalidjson') { [200, {}, '{"OMG": "THIS IS NOT THE API JSON THAT I KNOW AND <3!!!"}'] }
+        stub.get('/garbage') { [200, {}, 'THIS IS TOTAL GARBAGE!'] }
+      end
+
+      @connection = test_connection(stubs)
+
+    end
+    
+    it "should raised exception when token is expired" do
+      expect { @connection.get('/expired')}.to raise_error(FlexmlsApi::PermissionDenied){ |e| e.code.should == FlexmlsApi::ResponseCodes::SESSION_TOKEN_EXPIRED }
+    end
+
+    it "should raised exception on error" do
+      expect { @connection.get('/methodnotallowed')}.to raise_error(FlexmlsApi::NotAllowed){ |e| e.message.should == "Method Not Allowed" }
+      expect { @connection.get('/epicfail')}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should be 500 }
+      expect { @connection.get('/unknownerror')}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should be 499 }
+    end
+
+    it "should raised exception on invalid responses" do
+      expect { @connection.get('/invalidjson')}.to raise_error(FlexmlsApi::InvalidResponse)
+      # This should be caught in the request code
+      expect { @connection.get('/garbage')}.to raise_error(MultiJson::DecodeError)
+    end
+
+    it "should give me a session response" do
+      response = @connection.post('/session').body
+      response.success.should eq(true)
+      session = FlexmlsApi::Authentication::Session.new(response.results[0])
+      session.auth_token.should eq("xxxxx")
+    end
+    
+    it "should give me an api response" do
+      response = @connection.get('/system').body
+      response.success.should eq(true)
+      response.results.length.should be > 0 
+    end
+    
+  end
+  
+end
+

data/spec/unit/flexmls_api/models/base_spec.rb

@@ -0,0 +1,62 @@
+require './spec/spec_helper'
+
+# Sample resource models for testing the base class
+class MyExampleModel < Base
+  self.element_name = "example"
+  self.prefix = "/test/"
+  def self.connection
+    @connection ||= Base.connection
+  end
+  def self.connection=(con)
+    @connection = con
+  end
+end
+
+class MyDefaultModel < Base
+end
+
+
+describe Base, "Base model" do
+  describe "class methods" do
+    it "should set the element name" do
+      MyExampleModel.element_name.should eq("example")
+      MyDefaultModel.element_name.should eq("resource")
+    end
+    it "should set the prefix" do
+      MyExampleModel.prefix.should eq("/test/")
+      MyDefaultModel.prefix.should eq("/")
+    end
+    it "should set the path" do
+      MyExampleModel.path.should eq("/test/example")
+      MyDefaultModel.path.should eq("/resource")
+    end
+    describe "finders" do
+      before(:all) do
+        stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/v1/test/example?ApiSig=0637dccf93be3774c9c7c554bb0b1d9a&AuthToken=1234') { [200, {}, '{"D": {
+            "Success": true, 
+            "Results": [{
+              "Id": 1,
+              "Name": "My Example", 
+              "Test": true
+            },
+            {
+              "Id": 2, 
+              "Name": "My Example2", 
+              "Test": false
+            }]}
+            }'] 
+          }
+        end
+        MyExampleModel.connection = mock_client(stubs)
+      end
+      it "should get all results" do
+        MyExampleModel.get.length.should == 2
+      end
+      it "should get first result" do
+        MyExampleModel.first.Id.should == 1
+      end
+    end
+  end
+  
+end

data/spec/unit/flexmls_api/models/connect_prefs_spec.rb

@@ -0,0 +1,9 @@
+require './spec/spec_helper'
+
+describe Connect do
+
+  it "should respond to prefs" do
+    Connect.should respond_to(:prefs)
+  end
+
+end

data/spec/unit/flexmls_api/models/contact_spec.rb

@@ -0,0 +1,70 @@
+require './spec/spec_helper'
+
+
+class Contact
+  class << self
+    # Neato trick, using the accessor function nested here acts on the class methods!
+    attr_accessor :connection
+  end
+end
+
+describe Contact do
+  before(:all) do
+    stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+      stub.get('/v1/contacts?ApiSig=735774295be070a27f7cf859fde90740&AuthToken=1234') { [200, {}, fixture('contacts.json')] 
+      }
+      stub.post('/v1/contacts?ApiSig=7f0a7b0f648f87aabd4d4393913a10ba&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"Contact Four","PrimaryEmail":"contact4@fbsdata.com"}]}}') { [201, {}, '{"D": {
+        "Success": true, 
+        "Results": [
+          {
+            "ResourceUri":"/v1/contacts/20101230223226074204000000"
+          }]}
+        }'] 
+      }
+      stub.post('/v1/contacts?ApiSig=76f6ee7032f7038d737f9b73457f06e2&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [400, {}, '{"D": {
+        "Success": false}
+        }'] 
+      }
+    end
+    Contact.connection = mock_client(stubs)
+  end
+  
+  it "should get all my contacts" do
+    contacts = Contact.get
+    contacts.should be_an Array
+    contacts.length.should eq 3
+    contacts.first.Id.should eq "20101230223226074201000000"
+  end
+
+  it "should save a new contact" do
+    c=Contact.new
+    c.attributes["DisplayName"] = "Contact Four"
+    c.attributes["PrimaryEmail"] = "contact4@fbsdata.com"
+    c.save.should be true
+    c.Id.should eq '20101230223226074204000000'
+  end
+
+  it "should fail saving" do
+    c=Contact.new
+    c.save.should be false
+    expect{ c.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
+  end
+  
+  context "on an epic fail" do
+    before(:all) do
+      stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.post('/v1/contacts?ApiSig=76f6ee7032f7038d737f9b73457f06e2&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [500, {}, '{"D": {
+          "Success": false}
+          }'] 
+        }
+      end
+      Contact.connection = mock_client(stubs)
+    end
+    it "should fail saving and asplode" do
+      c=Contact.new()
+      expect{ c.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 500 }
+      expect{ c.save }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 500 }
+    end
+  end
+
+end

data/spec/unit/flexmls_api/models/document_spec.rb

@@ -0,0 +1,39 @@
+require './spec/spec_helper'
+
+describe Document do
+  before(:each) do
+    @document = Document.new({
+      :Uri => "http://images.dev.fbsdata.com/documents/cda/20060725224801143085000000.pdf",
+      :ResourceUri => "/v1/listings/20060725224713296297000000/documents/20060725224801143085000000",
+      :Name => "Disclosure",
+      :Id => "20110105165843978012000000",
+    })
+  end
+
+  it "should respond to a few methods" do
+    Document.should respond_to(:find_by_listing_key)
+  end
+
+
+  it "should get documents for a listing" do
+    stub_auth_request
+    stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/documents").
+          with( :query => { 
+            :ApiSig => "82f62b685e4318a1ab6bc3fc5a031c5a", 
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+            :ApiUser => "foobar"
+          }).
+          to_return(:body => fixture('listing_document_index.json'))
+
+    v = Document.find_by_listing_key('1234', "foobar")
+    v.should be_an Array
+    v.length.should == 2
+  end
+
+
+
+  after(:each) do
+    @document = nil
+  end
+
+end