flexmls_api 0.3.2

data/spec/unit/flexmls_api/request_spec.rb

@@ -0,0 +1,288 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi do
+  describe FlexmlsApi::ClientError do
+    subject { FlexmlsApi::ClientError.new("1234", 200) }
+    it "should have an api code" do
+      subject.code.should == "1234"
+    end
+    it "should have an http status" do
+      subject.status.should == 200
+    end
+    it "should raise and exception with attached message" do
+      expect { raise subject, "My Message" }.to raise_error(FlexmlsApi::ClientError){ |e| e.message.should == "My Message" }
+    end
+  end
+
+  describe FlexmlsApi::ApiResponse do
+    it "should asplode if given an invalid  or empty response" do
+      expect { FlexmlsApi::ApiResponse.new("KABOOOM") }.to raise_error(FlexmlsApi::InvalidResponse)
+      expect { FlexmlsApi::ApiResponse.new({"D"=>{}}) }.to raise_error(FlexmlsApi::InvalidResponse)
+    end
+    it "should have results when successful" do
+      r = FlexmlsApi::ApiResponse.new({"D"=>{"Success" => true, "Results" => []}})
+      r.success?.should be true
+      r.results.empty?.should be true
+    end
+    it "should have a message on error" do
+      r = FlexmlsApi::ApiResponse.new({"D"=>{"Success" => false, "Message" => "I am a failure."}})
+      r.success?.should be false
+      r.message.should be == "I am a failure."
+    end
+  end
+  
+  describe FlexmlsApi::Request do
+    before(:all) do
+      stubs = Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('/v1/system?ApiSig=SignedToken&AuthToken=1234') { [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('/v1/marketstatistics/price?ApiSig=SignedToken&AuthToken=1234&Options=ActiveAverageListPrice') { [200, {}, '{"D": {
+          "Success": true, 
+          "Results": [{
+            "Dates": ["11/1/2010","10/1/2010","9/1/2010","8/1/2010","7/1/2010",
+                               "6/1/2010","5/1/2010","4/1/2010","3/1/2010","2/1/2010",
+                               "1/1/2010","12/1/2009"], 
+            "ActiveAverageListPrice": [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000]
+          }]}
+          }'] 
+        }
+        stub.post('/v1/contacts?ApiSig=SignedToken&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"Wades Contact","PrimaryEmail":"wade11@fbsdata.com"}]}}') { [201, {}, '{"D": {
+          "Success": true,
+          "Results": [{"ResourceUri": "1000"}]}}'] 
+        }
+        stub.put('/v1/contacts/1000?ApiSig=SignedToken&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"WLMCEWENS Contact","PrimaryEmail":"wlmcewen789@fbsdata.com"}]}}') { [200, {}, '{"D": {
+          "Success": true}}'] 
+        }
+        stub.delete('/v1/contacts/1000?ApiSig=SignedToken&AuthToken=1234') { [200, {}, '{"D": {
+          "Success": true}}'] 
+        }
+        # EXPIRED RESPONSES
+        stub.get('/v1/system?ApiSig=SignedToken&AuthToken=EXPIRED') { [401 , {}, '{"D": {
+          "Success": false,
+          "Message": "Session token has expired",
+          "Code": 1020
+          }}'] 
+        }
+        stub.post('/v1/contacts?ApiSig=SignedToken&AuthToken=EXPIRED', '{"D":{"Contacts":[{"DisplayName":"Wades Contact","PrimaryEmail":"wade11@fbsdata.com"}]}}') { [401 , {}, '{"D": {
+          "Success": false,
+          "Message": "Session token has expired",
+          "Code": 1020
+          }}'] 
+        }
+        # Test for really long float numbers
+        stub.get('/v1/listings/1000?ApiSig=SignedToken&AuthToken=1234') { [200, {}, '{"D": {
+          "Success": true, 
+          "Results": [{
+            "ResourceUri":"/v1/listings/20101103161209156282000000",
+            "StandardFields":{
+              "BuildingAreaTotal":0.000000000000000000000000001,
+              "ListPrice":9999999999999999999999999.99
+            }
+          }]}
+          }'] 
+        }
+      end
+      @connection = test_connection(stubs)
+    end  
+
+    context "when successfully authenticated" do
+      subject do 
+        class RequestTest
+          include FlexmlsApi::Request
+          def initialize(session)
+            @session = session
+          end
+          def authenticate()
+            raise "Should not be invoked #{@session.inspect}"
+          end
+          def sign_token(path, params = {}, post_data="")
+            "SignedToken"
+          end
+          def version()
+            "v1"
+          end
+          def empty_parameters()
+            build_url_parameters()
+          end
+          attr_accessor :connection
+        end
+        my_s = mock_session()
+        r = RequestTest.new(my_s)
+        r.connection = @connection
+        r
+      end
+      it "should give me empty string when no parameters" do
+        subject.empty_parameters().should == ""
+      end
+      it "should get a service" do
+        subject.get('/system')[0]["Name"].should == "My User"
+      end
+      it "should get a service with parameters" do
+        subject.get('/marketstatistics/price', "Options" => "ActiveAverageListPrice")[0]["ActiveAverageListPrice"].should == [100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000,100000]
+      end
+      it "should post to a service" do
+        data = {"Contacts" => [{"DisplayName"=>"Wades Contact","PrimaryEmail"=>"wade11@fbsdata.com"}]}
+        subject.post('/contacts', data)[0]["ResourceUri"].should == "1000"
+      end
+      it "should put to a service" do
+        # This is a hypothetical unsupported service action at this time
+        data = {"Contacts" => [{"DisplayName"=>"WLMCEWENS Contact","PrimaryEmail"=>"wlmcewen789@fbsdata.com"}]}
+        subject.put('/contacts/1000', data).should be nil
+        # No validation here, if no error is raised, everything is hunky dory
+      end
+      it "should delete from a service" do
+        # This is a hypothetical unsupported service action at this time
+        subject.delete('/contacts/1000').should be nil
+        # No validation here, if no error is raised, everything is hunky dory
+      end
+
+      it "should give me BigDecimal results for large floating point numbers" do
+        MultiJson.default_engine.should eq :yajl
+        result = subject.get('/listings/1000')[0]
+        result["StandardFields"]["BuildingAreaTotal"].class.should eq Float
+        pending("our JSON parser does not support large decimal types.  Anyone feel like writing some c code?") do
+          result["StandardFields"]["BuildingAreaTotal"].class.should eq BigDecimal
+          number = BigDecimal.new(result["StandardFields"]["BuildingAreaTotal"].to_s)
+          number.to_s.should eq BigDecimal.new("0.000000000000000000000000001").to_s
+          number = BigDecimal.new(result["StandardFields"]["ListPrice"].to_s)
+          number.to_s.should eq BigDecimal.new("9999999999999999999999999.99").to_s
+        end
+      end
+      
+    end
+    
+    context "when unauthenticated" do
+      subject do 
+        class RequestAuthTest
+          include FlexmlsApi::Request
+          def authenticate()
+            @session ||= mock_session()
+          end
+          def sign_token(path, params = {}, post_data="")
+            "SignedToken"
+          end
+          def version()
+            "v1"
+          end
+          attr_accessor :connection
+        end
+        r = RequestAuthTest.new
+        r.connection = @connection
+        r
+      end
+      it "should authenticate and then get a service" do
+        subject.get('/system')[0]["Name"].should == "My User"
+      end
+      it "should authenticate and then post to a service" do
+        data = {"Contacts" => [{"DisplayName"=>"Wades Contact","PrimaryEmail"=>"wade11@fbsdata.com"}]}
+        subject.post('/contacts', data)[0]["ResourceUri"].should == "1000"
+      end
+    end
+
+    context "when expired" do
+      subject do 
+        class RequestExpiredTest
+          include FlexmlsApi::Request
+          def initialize(session)
+            @session = session
+            @reauthenticated = false
+          end
+          def authenticate()
+            @reauthenticated = true
+            @session = mock_session()
+          end
+          def sign_token(path, params = {}, post_data="")
+            "SignedToken"
+          end
+          def version()
+            "v1"
+          end
+          def reauthenticated?
+            @reauthenticated == true
+          end
+          attr_accessor :connection
+        end
+        r = RequestExpiredTest.new(mock_expired_session())
+        r.connection = @connection
+        r
+      end
+      it "should reauthenticate and then get a service" do
+        subject.get('/system')[0]["Name"].should == "My User"
+        subject.reauthenticated?.should == true
+      end
+      it "should reauthenticate and then post to a service" do
+        data = {"Contacts" => [{"DisplayName"=>"Wades Contact","PrimaryEmail"=>"wade11@fbsdata.com"}]}
+        subject.post('/contacts', data)[0]["ResourceUri"].should == "1000"
+        subject.reauthenticated?.should == true
+      end
+    end
+
+    context "when expire response" do
+      subject do 
+        session = FlexmlsApi::Authentication::Session.new("AuthToken" => "EXPIRED", "Expires" => (Time.now + 60).to_s, "Roles" => "['idx']")
+        r = RequestExpiredTest.new(session)
+        r.connection = @connection
+        r
+      end
+      it "should reauthenticate and then get a service" do
+        subject.get('/system')[0]["Name"].should == "My User"
+        subject.reauthenticated?.should == true
+      end
+      it "should reauthenticate and then post to a service" do
+        data = {"Contacts" => [{"DisplayName"=>"Wades Contact","PrimaryEmail"=>"wade11@fbsdata.com"}]}
+        subject.post('/contacts', data)[0]["ResourceUri"].should == "1000"
+        subject.reauthenticated?.should == true
+      end
+    end
+
+    context "when the server is being a real jerk on expire response" do
+      subject do 
+        class RequestAlwaysExpiredJerkTest
+          include FlexmlsApi::Request
+          def initialize()
+            @reauthenticated = 0
+          end
+          def authenticate()
+            @reauthenticated += 1
+            @session = session = FlexmlsApi::Authentication::Session.new("AuthToken" => "EXPIRED", "Expires" => (Time.now + 60).to_s, "Roles" => "['idx']")
+          end
+          def sign_token(path, params = {}, post_data="")
+            "SignedToken"
+          end
+          def version()
+            "v1"
+          end
+          def reauthenticated
+            @reauthenticated
+          end
+          attr_accessor :connection
+        end
+        r = RequestAlwaysExpiredJerkTest.new
+        r.connection = @connection
+        r
+      end
+      it "should fail horribly on a get" do
+        expect { subject.get('/system')}.to raise_error(FlexmlsApi::PermissionDenied){ |e| e.code.should == FlexmlsApi::ResponseCodes::SESSION_TOKEN_EXPIRED }
+        subject.reauthenticated.should == 2
+      end
+      it "should fail horribly on a post" do
+        data = {"Contacts" => [{"DisplayName"=>"Wades Contact","PrimaryEmail"=>"wade11@fbsdata.com"}]}
+        expect { subject.post('/contacts', data)}.to raise_error(FlexmlsApi::PermissionDenied){ |e| e.code.should == FlexmlsApi::ResponseCodes::SESSION_TOKEN_EXPIRED }
+        subject.reauthenticated.should == 2
+      end
+    end
+    
+  end
+
+end

data/spec/unit/flexmls_api_spec.rb

@@ -0,0 +1,44 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi do
+  it "should load the version" do
+    subject::VERSION.should match(/\d+\.\d+\.\d+/)
+  end
+
+  it "should give me a client connection" do
+    subject.client.class.should eq FlexmlsApi::Client
+  end
+
+  it "should reset my connection" do
+    c1 = subject.client
+    subject.reset
+    subject.client.should_not eq c1
+  end
+
+end
+
+describe FlexmlsApi::Authentication, "Authentication"  do
+  describe "build_param_hash" do
+    before(:each) do
+      class StubClass
+      end
+      @auth_stub = StubClass.new
+      @auth_stub.extend(FlexmlsApi::Authentication)
+    end
+
+    it "Should return a blank string when passed nil" do
+      @auth_stub.build_param_string(nil).should be_empty
+    end
+
+    it "should return a correct param string for one item" do
+      @auth_stub.build_param_string({:foo => "bar"}).should match "foobar"
+    end
+
+    it "should alphabatize the param names by key first, then by value" do
+      @auth_stub.build_param_string({:zoo => "zar", :ooo => "car"}).should match "ooocarzoozar"
+      @auth_stub.build_param_string({:Akey => "aValue", :aNotherkey => "AnotherValue"}).should 
+           match "AkeyaValueaNotherkeyAnotherValue"
+    end
+  end
+end
+

metadata

@@ -0,0 +1,315 @@
+--- !ruby/object:Gem::Specification 
+name: flexmls_api
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 2
+  version: 0.3.2
+platform: ruby
+authors: 
+- Brandon Hornseth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-28 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: faraday
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  type: :runtime
+  name: curb
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  type: :runtime
+  name: faraday_middleware
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+  type: :runtime
+  name: multi_json
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  prerelease: false
+  type: :runtime
+  name: json
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  prerelease: false
+  type: :runtime
+  name: yajl-ruby
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  requirement: *id007
+  prerelease: false
+  type: :runtime
+  name: builder
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -1876988247
+        segments: 
+        - 3
+        - 0
+        - pre2
+        version: 3.0.pre2
+  requirement: *id008
+  prerelease: false
+  type: :runtime
+  name: will_paginate
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id009
+  prerelease: false
+  type: :development
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id010
+  prerelease: false
+  type: :development
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id011
+  prerelease: false
+  type: :development
+  name: curb
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id012
+  prerelease: false
+  type: :development
+  name: json
+description: A library for interacting with the flexmls web services.
+email: api-support@flexmls.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/flexmls_api.rb
+- lib/flexmls_api/authentication.rb
+- lib/flexmls_api/client.rb
+- lib/flexmls_api/configuration.rb
+- lib/flexmls_api/faraday.rb
+- lib/flexmls_api/models.rb
+- lib/flexmls_api/models/base.rb
+- lib/flexmls_api/models/connect_prefs.rb
+- lib/flexmls_api/models/contact.rb
+- lib/flexmls_api/models/custom_fields.rb
+- lib/flexmls_api/models/document.rb
+- lib/flexmls_api/models/idx_link.rb
+- lib/flexmls_api/models/listing.rb
+- lib/flexmls_api/models/market_statistics.rb
+- lib/flexmls_api/models/photo.rb
+- lib/flexmls_api/models/property_types.rb
+- lib/flexmls_api/models/standard_fields.rb
+- lib/flexmls_api/models/subresource.rb
+- lib/flexmls_api/models/system_info.rb
+- lib/flexmls_api/models/video.rb
+- lib/flexmls_api/models/virtual_tour.rb
+- lib/flexmls_api/paginate.rb
+- lib/flexmls_api/request.rb
+- lib/flexmls_api/version.rb
+- spec/fixtures/contacts.json
+- spec/fixtures/listing_document_index.json
+- spec/fixtures/listing_no_subresources.json
+- spec/fixtures/listing_photos_index.json
+- spec/fixtures/listing_videos_index.json
+- spec/fixtures/listing_virtual_tours_index.json
+- spec/fixtures/listing_with_documents.json
+- spec/fixtures/listing_with_photos.json
+- spec/fixtures/listing_with_supplement.json
+- spec/fixtures/listing_with_videos.json
+- spec/fixtures/listing_with_vtour.json
+- spec/fixtures/session.json
+- spec/json_helper.rb
+- spec/spec_helper.rb
+- spec/unit/flexmls_api/configuration_spec.rb
+- spec/unit/flexmls_api/faraday_spec.rb
+- spec/unit/flexmls_api/models/base_spec.rb
+- spec/unit/flexmls_api/models/connect_prefs_spec.rb
+- spec/unit/flexmls_api/models/contact_spec.rb
+- spec/unit/flexmls_api/models/document_spec.rb
+- spec/unit/flexmls_api/models/listing_spec.rb
+- spec/unit/flexmls_api/models/photo_spec.rb
+- spec/unit/flexmls_api/models/property_types_spec.rb
+- spec/unit/flexmls_api/models/standard_fields_spec.rb
+- spec/unit/flexmls_api/models/system_info_spec.rb
+- spec/unit/flexmls_api/models/video_spec.rb
+- spec/unit/flexmls_api/models/virtual_tour_spec.rb
+- spec/unit/flexmls_api/paginate_spec.rb
+- spec/unit/flexmls_api/request_spec.rb
+- spec/unit/flexmls_api_spec.rb
+has_rdoc: true
+homepage: https://github.com/flexmls/flexmls_api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A library for interacting with the flexmls web services.
+test_files: 
+- spec/json_helper.rb
+- spec/spec_helper.rb
+- spec/unit/flexmls_api/configuration_spec.rb
+- spec/unit/flexmls_api/faraday_spec.rb
+- spec/unit/flexmls_api/models/base_spec.rb
+- spec/unit/flexmls_api/models/connect_prefs_spec.rb
+- spec/unit/flexmls_api/models/contact_spec.rb
+- spec/unit/flexmls_api/models/document_spec.rb
+- spec/unit/flexmls_api/models/listing_spec.rb
+- spec/unit/flexmls_api/models/photo_spec.rb
+- spec/unit/flexmls_api/models/property_types_spec.rb
+- spec/unit/flexmls_api/models/standard_fields_spec.rb
+- spec/unit/flexmls_api/models/system_info_spec.rb
+- spec/unit/flexmls_api/models/video_spec.rb
+- spec/unit/flexmls_api/models/virtual_tour_spec.rb
+- spec/unit/flexmls_api/paginate_spec.rb
+- spec/unit/flexmls_api/request_spec.rb
+- spec/unit/flexmls_api_spec.rb