spark_api 1.0.0

data/spec/unit/spark_api/multi_client_spec.rb~

@@ -0,0 +1,56 @@
+require './spec/spec_helper'
+
+# Test client implemenations for multi client switching
+module FlexmlsApi
+  def self.test_client_a
+    Thread.current[:test_client_a] ||= Client.new(:api_key => "a")
+  end
+  def self.test_client_b
+    Client.new(:api_key => "b")
+  end
+  def self.test_client_c
+    Client.new(:api_key => "c")
+  end
+end
+
+describe FlexmlsApi::MultiClient do
+  it "should activate a client implemenation when activate()" do
+    FlexmlsApi.activate(:test_client_a)
+    FlexmlsApi.client.api_key.should eq('a')
+    FlexmlsApi.activate(:test_client_b)
+    FlexmlsApi.client.api_key.should eq('b')
+    FlexmlsApi.activate(:test_client_c)
+    FlexmlsApi.client.api_key.should eq('c')
+    FlexmlsApi.activate(:test_client_a)
+    FlexmlsApi.client.api_key.should eq('a')
+  end
+  it "should fail to activate symbols that do not have implementations" do
+    expect { FlexmlsApi.activate(:test_client_d) }.to raise_error(ArgumentError)
+  end
+  
+  it "should temporarily activate a client implemenation when activate() block" do
+    FlexmlsApi.activate(:test_client_a)
+    FlexmlsApi.client.api_key.should eq('a')
+    FlexmlsApi.activate(:test_client_b) do
+      FlexmlsApi.client.api_key.should eq('b')
+    end
+    FlexmlsApi.client.api_key.should eq('a')
+    expect do
+      FlexmlsApi.activate(:test_client_c) do
+        FlexmlsApi.client.api_key.should eq('c')
+        raise "OH MY GOODNESS I BLEW UP!!!"
+      end
+    end.to raise_error
+    FlexmlsApi.client.api_key.should eq('a')
+  end
+
+  context "yaml" do
+    it "should activate a client implemenation when activate()" do
+      FlexmlsApi::Configuration::YamlConfig.stub(:config_path) { "spec/config/flexmls_api" }
+      FlexmlsApi.activate(:test_key)
+      FlexmlsApi.client.api_key.should eq('demo_key')
+    end
+  end
+  
+end
+

data/spec/unit/spark_api/paginate_spec.rb

@@ -0,0 +1,224 @@
+require './spec/spec_helper'
+
+class PaginateResponseTester
+  include SparkApi::PaginateHelper
+end
+
+class PaginateModelTester < SparkApi::Models::Base
+  @tester = PaginateResponseTester.new
+  attr_accessor :val
+  def initialize (val)
+    @val = val
+  end
+  class << self
+    attr_accessor :options
+    def get(options)
+      @options = options
+      json = "{#{paginate_json}}"
+      hash = JSON.parse(json)
+      results = @tester.paginate_response([1,2,3,4,5,6,7,8,9,10], hash["Pagination"])
+      collect(results)
+    end
+  end
+end
+
+class PaginateModelTester50 < PaginateModelTester
+  @tester = PaginateResponseTester.new
+  def self.per_page
+      50
+  end
+end
+
+
+describe SparkApi::PaginateResponse do
+
+  describe "paginate_response" do
+    subject { PaginateResponseTester.new } 
+    it "should give me the first page" do
+      json = "{#{paginate_json}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([1,2,3,4,5,6,7,8,9,10], hash["Pagination"])
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(1)
+    end
+    it "should give me the second page" do
+      json = "{#{paginate_json(2)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([11,12,13,14,15,16,17,18,19,20], hash["Pagination"])
+      results.offset.should eq(10)
+      results.next_page.should eq(3)
+      results.previous_page.should eq(1)
+      results.current_page.should eq(2)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(11)
+    end
+    it "should give me the third page" do
+      json = "{#{paginate_json(3)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([21,22,23,24,25,26,27,28,29,30], hash["Pagination"])
+      results.offset.should eq(20)
+      results.next_page.should eq(4)
+      results.previous_page.should eq(2)
+      results.current_page.should eq(3)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(21)
+    end
+    it "should give me the last page" do
+      json = "{#{paginate_json(4)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([31,32,33,34,35,36,37,38], hash["Pagination"])
+      results.offset.should eq(30)
+      results.next_page.should eq(nil)
+      results.previous_page.should eq(3)
+      results.current_page.should eq(4)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(31)
+      results[-1].should eq(38)
+    end
+  end
+end
+
+describe SparkApi::Paginate do
+  describe "paginate" do
+    it "should give me a will paginate collection" do
+      results = PaginateModelTester.paginate(:page => 1)
+      results.should be_a(WillPaginate::Collection)
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      
+      results[0].should be_a(PaginateModelTester)
+      results[0].val.should eq(1)
+      
+    end
+      
+    it "should give me pagination options" do
+      PaginateModelTester.paginate(:page => 1)
+      opts = PaginateModelTester.options
+      opts["_pagination"].should eq(1)
+      opts["_limit"].should eq(25)
+      opts["_page"].should eq(1)
+      opts.has_key?(:page).should eq(false)
+    end
+  end
+
+  describe "per_page" do
+    it "should set the default model max results per page" do
+      results = PaginateModelTester50.paginate(:page => 1)
+      opts = PaginateModelTester50.options
+      opts["_limit"].should eq(50)
+    end
+  end
+  
+  # non unit-y real world test of paginations with listings
+  context "paginating listings" do
+    before do
+      stub_auth_request
+    end
+
+    subject { SparkApi::Models::Listing }
+    it "gives me page one of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(10)}],
+          #{paginate_json}
+        }
+      JSON
+      stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/listings").
+        with(:query => {
+          :ApiSig => "4a00ca0e657c824d85a5fe1007d9c52d",
+          :ApiUser => "foobar",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '1',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>1, :per_page=>10)
+      results.should be_a(WillPaginate::Collection)
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results.length.should eq(10)
+      
+      results[0].should be_a(subject)
+      results[0].ListPrice.should eq(50000.0)
+      
+    end
+    it "gives me page two of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(10)}],
+          #{paginate_json(2)}
+        }
+      JSON
+      stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/listings").
+        with(:query => {
+          :ApiSig => "094d3851a0c4c4563baf70ca45087e30",
+          :ApiUser => "foobar",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '2',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>2, :per_page=>10)
+      results.next_page.should eq(3)
+      results.previous_page.should eq(1)
+      results.current_page.should eq(2)
+    end
+    it "gives me page four of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(8)}],
+          #{paginate_json(4)}
+        }
+      JSON
+      stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/listings").
+        with(:query => {
+          :ApiSig => "dcfce1fe9289c905f8d2d01cbb850edc",
+          :ApiUser => "foobar",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '4',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>4, :per_page=>10)
+      results.next_page.should eq(nil)
+      results.previous_page.should eq(3)
+      results.current_page.should eq(4)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      
+      results.length.should eq(8)
+      results[0].should be_a(subject)
+      results[0].ListPrice.should eq(50000.0)
+    end
+    
+  end
+end

data/spec/unit/spark_api/paginate_spec.rb~

@@ -0,0 +1,224 @@
+require './spec/spec_helper'
+
+class PaginateResponseTester
+  include FlexmlsApi::PaginateHelper
+end
+
+class PaginateModelTester < FlexmlsApi::Models::Base
+  @tester = PaginateResponseTester.new
+  attr_accessor :val
+  def initialize (val)
+    @val = val
+  end
+  class << self
+    attr_accessor :options
+    def get(options)
+      @options = options
+      json = "{#{paginate_json}}"
+      hash = JSON.parse(json)
+      results = @tester.paginate_response([1,2,3,4,5,6,7,8,9,10], hash["Pagination"])
+      collect(results)
+    end
+  end
+end
+
+class PaginateModelTester50 < PaginateModelTester
+  @tester = PaginateResponseTester.new
+  def self.per_page
+      50
+  end
+end
+
+
+describe FlexmlsApi::PaginateResponse do
+
+  describe "paginate_response" do
+    subject { PaginateResponseTester.new } 
+    it "should give me the first page" do
+      json = "{#{paginate_json}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([1,2,3,4,5,6,7,8,9,10], hash["Pagination"])
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(1)
+    end
+    it "should give me the second page" do
+      json = "{#{paginate_json(2)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([11,12,13,14,15,16,17,18,19,20], hash["Pagination"])
+      results.offset.should eq(10)
+      results.next_page.should eq(3)
+      results.previous_page.should eq(1)
+      results.current_page.should eq(2)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(11)
+    end
+    it "should give me the third page" do
+      json = "{#{paginate_json(3)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([21,22,23,24,25,26,27,28,29,30], hash["Pagination"])
+      results.offset.should eq(20)
+      results.next_page.should eq(4)
+      results.previous_page.should eq(2)
+      results.current_page.should eq(3)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(21)
+    end
+    it "should give me the last page" do
+      json = "{#{paginate_json(4)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([31,32,33,34,35,36,37,38], hash["Pagination"])
+      results.offset.should eq(30)
+      results.next_page.should eq(nil)
+      results.previous_page.should eq(3)
+      results.current_page.should eq(4)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(31)
+      results[-1].should eq(38)
+    end
+  end
+end
+
+describe FlexmlsApi::Paginate do
+  describe "paginate" do
+    it "should give me a will paginate collection" do
+      results = PaginateModelTester.paginate(:page => 1)
+      results.should be_a(WillPaginate::Collection)
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      
+      results[0].should be_a(PaginateModelTester)
+      results[0].val.should eq(1)
+      
+    end
+      
+    it "should give me pagination options" do
+      PaginateModelTester.paginate(:page => 1)
+      opts = PaginateModelTester.options
+      opts["_pagination"].should eq(1)
+      opts["_limit"].should eq(25)
+      opts["_page"].should eq(1)
+      opts.has_key?(:page).should eq(false)
+    end
+  end
+
+  describe "per_page" do
+    it "should set the default model max results per page" do
+      results = PaginateModelTester50.paginate(:page => 1)
+      opts = PaginateModelTester50.options
+      opts["_limit"].should eq(50)
+    end
+  end
+  
+  # non unit-y real world test of paginations with listings
+  context "paginating listings" do
+    before do
+      stub_auth_request
+    end
+
+    subject { FlexmlsApi::Models::Listing }
+    it "gives me page one of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(10)}],
+          #{paginate_json}
+        }
+      JSON
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :ApiSig => "4a00ca0e657c824d85a5fe1007d9c52d",
+          :ApiUser => "foobar",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '1',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>1, :per_page=>10)
+      results.should be_a(WillPaginate::Collection)
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results.length.should eq(10)
+      
+      results[0].should be_a(subject)
+      results[0].ListPrice.should eq(50000.0)
+      
+    end
+    it "gives me page two of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(10)}],
+          #{paginate_json(2)}
+        }
+      JSON
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :ApiSig => "094d3851a0c4c4563baf70ca45087e30",
+          :ApiUser => "foobar",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '2',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>2, :per_page=>10)
+      results.next_page.should eq(3)
+      results.previous_page.should eq(1)
+      results.current_page.should eq(2)
+    end
+    it "gives me page four of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(8)}],
+          #{paginate_json(4)}
+        }
+      JSON
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :ApiSig => "dcfce1fe9289c905f8d2d01cbb850edc",
+          :ApiUser => "foobar",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '4',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>4, :per_page=>10)
+      results.next_page.should eq(nil)
+      results.previous_page.should eq(3)
+      results.current_page.should eq(4)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      
+      results.length.should eq(8)
+      results[0].should be_a(subject)
+      results[0].ListPrice.should eq(50000.0)
+    end
+    
+  end
+end