spark_api 1.0.0

data/spec/unit/spark_api/faraday_spec.rb

@@ -0,0 +1,90 @@
+require './spec/spec_helper'
+
+# Test out the faraday connection stack.
+describe SparkApi do
+  describe "SparkMiddleware" 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, {}, fixture('errors/expired.json')] 
+        }
+        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(SparkApi::PermissionDenied){ |e| e.code.should == SparkApi::ResponseCodes::SESSION_TOKEN_EXPIRED }
+    end
+
+    it "should raised exception on error" do
+      expect { @connection.get('/methodnotallowed')}.to raise_error(SparkApi::NotAllowed){ |e| e.message.should == "Method Not Allowed" }
+      expect { @connection.get('/epicfail')}.to raise_error(SparkApi::ClientError){ |e| e.status.should be(500) }
+      expect { @connection.get('/unknownerror')}.to raise_error(SparkApi::ClientError){ |e| e.status.should be(499) }
+    end
+
+    it "should raised exception on invalid responses" do
+      expect { @connection.get('/invalidjson')}.to raise_error(SparkApi::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 = SparkApi::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/spark_api/faraday_spec.rb~

@@ -0,0 +1,90 @@
+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, {}, fixture('errors/expired.json')] 
+        }
+        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/spark_api/models/account_spec.rb

@@ -0,0 +1,176 @@
+require './spec/spec_helper'
+
+describe Account do
+  describe "units" do
+    before(:each) do
+      @account = Account.new({
+        "Name"=>"Sample User",
+        "Id"=>"20000426173054342350000000",
+        "Office"=>"Sample Office",
+        "Mls"=>"Sample MLS",
+        "MlsId"=>"20000426143505724628000000",
+        "Emails"=>[
+          {
+            "Type"=>"Work",
+            "Name"=>"My Work E-mail",
+            "Address"=>"work@test.com",
+            "Primary"=>true
+          },
+          {
+            "Type"=>"Home",
+            "Name"=>"My Home E-mail",
+            "Address"=>"home@test.com"
+          }
+        ],
+        "Phones"=>[
+          {
+            "Type"=>"Work",
+            "Name"=>"My Work Phone",
+            "Number"=>"701-555-1212",
+            "Primary"=>true
+          },
+          {
+            "Type"=>"Home",
+            "Name"=>"My Home Phone",
+            "Number"=>"702-555-1313"
+          }
+        ],
+        "Websites"=>[
+          {
+            "Type"=>"Work",
+            "Name"=>"My Work Website",
+            "Uri"=>"http://iamthebestagent.com",
+            "Primary"=>true
+          },
+          {
+            "Type"=>"Home",
+            "Name"=>"My Home Website",
+            "Uri"=>"http://myspace.com/lolcats"
+          }
+        ],
+        "Addresses"=>[
+          {
+            "Type"=>"Work",
+            "Name"=>"My Work Address",
+            "Address"=>"101 Main Ave, Phoenix, AZ 12345",
+            "Primary"=>true
+          },
+          {
+            "Type"=>"Home",
+            "Name"=>"My Home Address",
+            "Address"=>"102 Main Ave, Gilbert, AZ 54321"
+          }
+        ],
+        "Images"=>[
+          {
+            "Type"=>"Photo",
+            "Name"=>"My Photo 1",
+            "Uri"=>"http://photos.flexmls.com/az/...."
+          },
+          {
+            "Type"=>"Photo",
+            "Name"=>"My Photo two",
+            "Uri"=>"http://photos.flexmls.com/az/...."
+          },
+          {
+            "Type"=>"Logo",
+            "Name"=>"1 My Logo",
+            "Uri"=>"http://photos.flexmls.com/az/...."
+          },
+          {
+            "Type"=>"Logo",
+            "Name"=>"My Other Logo",
+            "Uri"=>"http://photos.flexmls.com/az/...."
+          },
+          {
+            "Type"=>"Logo",
+            "Name"=>"My Logo",
+            "Uri"=>"http://photos.flexmls.com/az/...."
+          }
+        ]
+      })
+    end
+
+    it "should respond to attributes" do
+      ['Name','Id','Mls','MlsId','Office'].each do |k|
+        (@account.send k.to_sym).should be_a(String)
+      end
+    end
+
+    it "should have primary subresources" do
+      @account.emails.primary.Address.should eq("work@test.com")
+      @account.phones.primary.Number.should eq("701-555-1212")
+      @account.addresses.primary.Address.should eq("101 Main Ave, Phoenix, AZ 12345")
+      @account.websites.primary.Uri.should eq("http://iamthebestagent.com")
+    end
+
+    it "should be able to provide a primary image" do
+      @account.primary_img("Photo").Name.should == 'My Photo 1'
+      @account.primary_img("Logo").Name.should == '1 My Logo'
+    end
+
+    after(:each) do
+      @acount = nil
+    end
+  end
+
+  describe "functionals" do
+    before(:each) do
+      stub_auth_request
+    end
+
+    context "/my/account", :support do
+      on_get_it "should get my account" do
+        stub_api_get("/my/account", 'accounts/my.json')
+        account = Account.my
+        account.Id.should eq("20000426173054342350000000")
+        account.websites.first.Name.should == 'My Work Website'
+      end
+
+      on_put_it "should save my portal account" do
+        stub_api_get("/my/account", 'accounts/my_portal.json')
+        stub_api_put("/my/account", 'accounts/my_save.json', 'accounts/my_put.json')
+        account = Account.my
+        account.Id.should eq("20110426173054342350000000")
+        account.GetEmailUpdates.should eq(false)
+        account.GetEmailUpdates = true
+        account.save!
+        account.GetEmailUpdates.should eq(true)
+      end
+    end
+
+    context "/accounts" do
+      on_get_it "should get all accounts" do
+        stub_api_get("/accounts", 'accounts/all.json')
+        accounts = Account.get
+        accounts.should be_an(Array)
+        accounts.length.should eq(3)
+        accounts.first.Id.should eq("20000426173054342350000000")
+        accounts.last.Id.should eq("20110126173054382350000000")
+      end
+      on_put_it "should save password" do
+        stub_api_get("/my/account", 'accounts/my.json')
+        account = Account.my
+        stub_api_put("/accounts/#{account.Id}", 'accounts/password_save.json', 'accounts/my.json')
+        account.Password = "1"
+        account.PasswordValidation = "1"
+        account.save.should be(true)
+      end   
+    end
+
+    context "/accounts/by/office/<office_id>" do
+      on_get_it "should all office accounts" do
+        stub_api_get("/accounts/by/office/20030426173014239760000000", 'accounts/office.json')
+        accounts = Account.by_office("20030426173014239760000000")
+        accounts.should be_an(Array)
+        accounts.length.should eq(2)
+        accounts.each do |account|
+          accounts.first.OfficeId.should eq("20030426173014239760000000")
+        end
+      end
+    end
+
+  end
+
+end
+

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

@@ -0,0 +1,106 @@
+require './spec/spec_helper'
+
+# Sample resource models for testing the base class
+class MyExampleModel < Base
+  self.element_name = "example"
+  self.prefix = "/test/"
+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(:each) do
+        stub_auth_request
+        stub_api_get("/test/example", 'base.json')
+      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
+
+  describe "attribute accessors, setters, and predicates" do
+    before(:each) do
+      stub_auth_request
+      stub_api_get("/test/example", 'base.json')
+      @model = MyExampleModel.first
+    end
+
+    it "should access existing attributes" do
+      @model.Name.should == 'My Example'
+    end
+
+    it "should raise errors on access to non-existant attributes" do
+      lambda { @model.Nonsense }.should raise_error(NoMethodError)
+    end
+
+    it "should set existing attributes" do
+      new_name = 'John Jacob Jingleheimerschmidt'
+      @model.Name = new_name
+      @model.Name.should == new_name
+    end
+
+    it "should set non-existant attributes" do
+      nonsense = 'nonsense'
+      @model.Nonsense = nonsense
+      @model.Nonsense.should == nonsense
+    end
+
+    it "should return a boolean for a predicate for an existing attribute" do
+      @model.Name?.should satisfy { |p| [true, false].include?(p) }
+    end
+
+    it "should raise an Error for a predicate for a non-existant attribute" do
+      lambda { @model.Nonsense? }.should raise_error(NoMethodError)
+    end
+
+    it "should repond_to existing attributes" do
+      @model.should respond_to(:Name)
+    end
+
+    it "should not respond_to non-existant attributes" do
+      @model.should_not respond_to(:Nonsense)
+    end
+
+    it "should respond_to a setter for an existing attribute" do
+      @model.should respond_to(:Name=)
+    end
+
+    it "should respond_to a setter for a non-existant attribute" do
+      @model.should respond_to(:Nonsense=)
+    end
+
+    it "should respond_to a predicate for an existing attribute" do
+      @model.should respond_to(:Name?)
+    end
+
+    it "should not respond_to a predicate for a non-existant attribute" do
+      @model.should_not respond_to(:Nonsense?)
+    end
+
+    it "should respond_to methods inherited from parent classes" do
+      @model.should respond_to(:freeze)
+    end
+
+  end
+
+end