spark_api 1.0.0

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/standardfields.json

@@ -0,0 +1,188 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+        {
+            "MLSAreaMinor": {
+                "ResourceUri": "/v1/standardfields/MLSAreaMinor",
+                "HasList": true,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "StreetNumber": {
+                "ResourceUri": "/v1/standardfields/StreetNumber",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "ListingId": {
+                "ResourceUri": "/v1/standardfields/ListingId",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "City": {
+                "ResourceUri": "/v1/standardfields/City",
+                "HasList": true,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "Longitude": {
+                "ResourceUri": "/v1/standardfields/Longitude",
+                "HasList": false,
+                "Searchable": false,
+                "Type": "Decimal"
+            },
+            "StreetName": {
+                "ResourceUri": "/v1/standardfields/StreetName",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "YearBuilt": {
+                "ResourceUri": "/v1/standardfields/YearBuilt",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Integer"
+            },
+            "BuildingAreaTotal": {
+                "ResourceUri": "/v1/standardfields/BuildingAreaTotal",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Decimal"
+            },
+            "PublicRemarks": {
+                "ResourceUri": "/v1/standardfields/PublicRemarks",
+                "HasList": false,
+                "Searchable": false,
+                "Type": "Character"
+            },
+            "PostalCode": {
+                "ResourceUri": "/v1/standardfields/PostalCode",
+                "HasList": true,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "ListPrice": {
+                "ResourceUri": "/v1/standardfields/ListPrice",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Decimal"
+            },
+            "SubdivisionName": {
+                "ResourceUri": "/v1/standardfields/SubdivisionName",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "BathsThreeQuarter": {
+                "ResourceUri": "/v1/standardfields/BathsThreeQuarter",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Integer"
+            },
+            "Latitude": {
+                "ResourceUri": "/v1/standardfields/Latitude",
+                "HasList": false,
+                "Searchable": false,
+                "Type": "Decimal"
+            },
+            "MlsStatusInformation": {
+                "ResourceUri": "/v1/standardfields/MlsStatusInformation",
+                "HasList": true,
+                "Searchable": false,
+                "Type": "Character"
+            },
+            "StreetDirPrefix": {
+                "ResourceUri": "/v1/standardfields/StreetDirPrefix",
+                "HasList": true,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "StreetAdditionalInfo": {
+                "ResourceUri": "/v1/standardfields/StreetAdditionalInfo",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "PropertyType": {
+                "ResourceUri": "/v1/standardfields/PropertyType",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "StateOrProvince": {
+                "ResourceUri": "/v1/standardfields/StateOrProvince",
+                "HasList": true,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "BathsTotal": {
+                "ResourceUri": "/v1/standardfields/BathsTotal",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Decimal"
+            },
+            "BathsFull": {
+                "ResourceUri": "/v1/standardfields/BathsFull",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Integer"
+            },
+            "ListingKey": {
+                "ResourceUri": "/v1/standardfields/ListingKey",
+                "HasList": false,
+                "Searchable": false,
+                "Type": "Character"
+            },
+            "StreetDirSuffix": {
+                "ResourceUri": "/v1/standardfields/StreetDirSuffix",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "BedsTotal": {
+                "ResourceUri": "/v1/standardfields/BedsTotal",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Integer"
+            },
+            "ModificationTimestamp": {
+                "ResourceUri": "/v1/standardfields/ModificationTimestamp",
+                "HasList": false,
+                "Searchable": false,
+                "Type": "Datetime"
+            },
+            "MlsStatus": {
+                "ResourceUri": "/v1/standardfields/MlsStatus",
+                "HasList": true,
+                "Searchable": false,
+                "Type": "Character"
+            },
+            "BathsHalf": {
+                "ResourceUri": "/v1/standardfields/BathsHalf",
+                "HasList": false,
+                "Searchable": true,
+                "Type": "Integer"
+            },
+            "PropertySubType": {
+                "ResourceUri": "/v1/standardfields/PropertySubType",
+                "HasList": true,
+                "Searchable": true,
+                "Type": "Character"
+            },
+            "PrivateRemarks": {
+                "ResourceUri": "/v1/standardfields/PrivateRemarks",
+                "HasList": false,
+                "Searchable": false,
+                "Type": "Character"
+            },
+            "CountyOrParish": {
+                "ResourceUri": "/v1/standardfields/CountyOrParish",
+                "HasList": false,
+                "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/success.json

@@ -0,0 +1,5 @@
+{
+    "D": {
+        "Success": true
+    }
+}

data/spec/json_helper.rb

@@ -0,0 +1,76 @@
+class ListingJson
+  @counter = 0
+  def self.next_tech_id()
+    "#{@counter + 20110101000000000000}000000"
+  end
+  def self.next_list_id()
+    "06-#{@counter + 1000}"
+  end
+  def self.bump()
+    @counter += 1
+  end
+  
+  def self.create
+    bump
+    json = <<-JSON 
+      {
+        "ResourceUri": "/v1/listings/#{next_tech_id}",
+        "StandardFields": #{standard_fields},
+        "Id": "#{next_tech_id}"
+      }
+    JSON
+     
+  end
+  
+  def self.create_all(count = 1)
+    listings = []
+    count.times { listings << create }
+    json = listings * ","
+  end
+  
+  private
+  def self.standard_fields
+    json = <<-JSON 
+        {
+          "StreetNumber": "7298",
+          "Longitude": "-116.3237",
+          "City": "Bonners Ferry",
+          "ListingId": "#{next_list_id}",
+          "PublicRemarks": "Afforadable home in town close to hospital,yet quiet country like setting. Good views. Must see",
+          "BuildingAreaTotal": 924.0,
+          "YearBuilt": 1977,
+          "StreetName": "BIRCH",
+          "ListPrice": 50000.0,
+          "PostalCode": 83805,
+          "Latitude": "48.7001",
+          "BathsThreeQuarter": null,
+          "BathsFull": 1.0,
+          "BathsTotal": 1.0,
+          "StateOrProvince": "ID",
+          "PropertyType": "A",
+          "StreetAdditionalInfo": null,
+          "StreetDirPrefix": null,
+          "BedsTotal": 3,
+          "StreetDirSuffix": null,
+          "ListingKey": "#{next_tech_id}",
+          "ListOfficeName": "Century 21 On The Lake",
+          "BathsHalf": null,
+          "ModificationTimestamp": "2010-11-22T20:47:21Z",
+          "CountyOrParish": "Boundary"        
+        }
+    JSON
+  end
+
+end
+
+def paginate_json(current_page = 1)
+  json = <<-JSON 
+    "Pagination": {
+      "TotalRows": 38,
+      "PageSize": 10,
+      "TotalPages": 4,
+      "CurrentPage": #{current_page}
+    }
+  JSON
+end
+

data/spec/mock_helper.rb

@@ -0,0 +1,124 @@
+RSpec.configure do |config|
+  config.include WebMock::API
+end
+
+$test_client = SparkApi::Client.new({:api_key=>"", :api_secret=>""})
+def stub_api_get(service_path, stub_fixture="success.json", opts={})
+  params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
+  sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params)
+  s=stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
+      with(:query => {
+        :ApiSig => sig        
+        }.merge(params))
+  if(block_given?)
+    yield s
+  else
+    s.to_return(:body => fixture(stub_fixture))
+  end
+  log_stub(s)
+end
+def stub_api_delete(service_path, stub_fixture="success.json", opts={})
+  params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
+  sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params)
+  s=stub_request(:delete, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
+      with(:query => {
+        :ApiSig => sig        
+        }.merge(params))
+  if(block_given?)
+    yield s
+  else
+    s.to_return(:body => fixture(stub_fixture))
+  end
+  log_stub(s)
+end
+def stub_api_post(service_path, body, stub_fixture="success.json", opts={})
+  body_hash = JSON.parse(fixture(body).read)
+  body_str = body_hash.to_json
+  params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
+  sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params, body_str)
+  s=stub_request(:post, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
+      with(:query => {
+        :ApiSig => sig        
+        }.merge(params),
+        :body => body_str
+      )
+  if(block_given?)
+    yield s
+  else
+    s.to_return(:body => fixture(stub_fixture))
+  end
+  log_stub(s)
+end
+def stub_api_put(service_path, body, stub_fixture="success.json", opts={})
+  body_hash = JSON.parse(fixture(body).read)
+  body_str = body_hash.to_json
+  params = {:ApiUser => "foobar", :AuthToken => "c401736bf3d3f754f07c04e460e09573"}.merge(opts)
+  sig = $test_client.authenticator.sign_token("/#{SparkApi.version}#{service_path}", params, body_str)
+  s=stub_request(:put, "#{SparkApi.endpoint}/#{SparkApi.version}#{service_path}").
+      with(:query => {
+        :ApiSig => sig        
+        }.merge(params),
+        :body => body_str
+      )
+  if(block_given?)
+    yield s
+  else
+    s.to_return(:body => fixture(stub_fixture))
+  end
+  log_stub(s)
+end
+
+def log_stub(s)
+  SparkApi.logger.debug("Stubbed Request: #{s.inspect} \n\n")
+end
+
+def mock_session()
+  SparkApi::Authentication::Session.new("AuthToken" => "1234", "Expires" => (Time.now + 3600).to_s, "Roles" => "['idx']")
+end
+
+def mock_oauth_session()
+  SparkApi::Authentication::OAuthSession.new("access_token" => "1234", "expires_in" => 3600, "scope" => nil, "refresh_token"=> "1000refresh")
+end
+
+class MockClient < SparkApi::Client
+  attr_accessor :connection
+  def connection(ssl = false)
+    @connection
+  end
+end
+
+class MockApiAuthenticator < SparkApi::Authentication::ApiAuth
+  # Sign a request
+  def sign(sig)
+    "SignedToken"
+  end
+end
+
+def mock_client(stubs)
+  c = MockClient.new
+  c.session = mock_session()
+  c.connection = test_connection(stubs)
+  c
+end
+
+def mock_expired_session()
+  SparkApi::Authentication::Session.new("AuthToken" => "1234", "Expires" => (Time.now - 60).to_s, "Roles" => "['idx']")
+end
+
+def test_connection(stubs)
+  Faraday::Connection.new(nil, {:headers => SparkApi::Client.new.headers}) do |builder|
+    builder.adapter :test, stubs
+    builder.use SparkApi::FaradayExt::SparkMiddleware
+  end
+end
+
+def stub_auth_request()
+  stub_request(:post, "https://api.sparkapi.com/#{SparkApi.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
+