spark_api 1.0.4 → 1.1.0

data/History.txt

@@ -1,139 +1,13 @@
-== v0.7.1 2011-10-13
-* Updated connection dependencies
-* Added messaging model
-* ExpirationDate editable for Listing
-== v0.7.0 2011-10-03
-* Major changes to results object returned from the client (and models). Results are no longer allowed to be nil, and Array is decorated with non result response information.
-* Finished listing photo uploads
-* ListPrice save operation for listings
-* Listing contraints processing
-== v0.6.7 2011-09-02
-* YAML key management
-== v0.6.6 2011-08-30
-* Added methods for returning street, region, and full address for a listing
-== v0.6.5 2011-08-02
-*  Fixed some recursive gemspec issues from jewler by removing jeweler and going with some of our own custom rake tasks.
-== v0.6.4 2011-08-02
-*  added public method for the listing carts service specified
-*  added spec for portal listing cart method
-== v0.6.3 2011-08-02
-*  Fix gemspec error on CLI launch (bundler)
-== v0.6.2 2011-07-29
-*  Added command to make irb sessions rocktastic
-== v0.6.1 2011-07-14
-*  Fixed request headers to match api expectations
-*  OAuth2 grant types redesign
-*  "provided" saved searches
-*  Portal account saving
-== v0.5.9 2011-07-12
-*  Modify Collect to handle FixNums in the case of pagination=count to my/office listings
-== v0.5.8 2011-07-08
-*  Add finders to SharedListing model
-*  fixed log message
-== v0.5.7 2011-07-07
-*  Add /my/contact support
-== v0.5.6 2011-07-07
-*  More build woes.
-== v0.5.5 2011-07-07
-== v0.5.4 2011-07-01
-*  Added the add listing methods to the cart instance.
-*  Added the remove listing methods to the cart instance.
-*  Accounts service by office changes
-== v0.5.3 2011-06-28
-*  API error handling bugfix to log decent messages
-*  Fixed the OAuth flow.
-*  Provide primary image types
-== v0.5.2 2011-06-23
-== v0.5.1 2011-06-03
-*  Upgraded dependencies to latest releases.
-*  Added put / delete functionality.
-*  Make method_missing and respond_to? methods match the expected behavior and add specs to define those behaviors.
-*  Properly escape uri paths when making requests.
-*  SavedSearch resource.
-== v0.4.6 2011-05-13
-*  Added notify option to contacts
-*  Implementation of listing cart resource.
-*  Pass JSON instead of a querystring for the OAuth POST body
-*  API-101 client implementation for sharedlistings service.
-*  Added multiclient support
-*  Change client from sending credentials as request parameters to post data
-== v0.4.5 2011-05-06
-*  Restrict lists larger than 1,000 scroll items
-*  Fixed logging of oauth2 errors, removed redundant access_token from parameters.
-== v0.4.4 2011-05-06
-*  Need to skip spec/reports for CI builds (oops).
-== v0.4.3 2011-05-05
-*  Fixed semi important issue with timeout settings.
-== v0.4.2 2011-05-03
-*  Fixed some nasty session timeout issues that were reported.
-*  Raise proper exceptions for oauth grant errors.
-== v0.4.1 2011-04-11
-*  Removed unnecessary finders from property type model
-*  OAuth2 implementation and general auth redesign
-*  Upgraded ruby version supported.
-*  Add finders to Contact model
-*  Adds an inspect to make debug info easier to read
-*  Standard field support for _expanding and nearby
-== v0.3.9 2011-04-01
-*  Added notes model and specs
-*  Added a primary_logo method to the system info class
-*  Change owner param to arguments hash
-*  Add finders
-== v0.3.8 2011-03-24
-*  Interface change! Remove api user calls that are all over the place.
-*  Fix for empty count response.
-*  Parse date and times for tour
-== v0.3.7 2011-03-11
-*  Fix catch miss.
-*  Added tour of homes model.
-== v0.3.6 2011-03-08
-*  Added account model Also moved finders to a module.
-== v0.3.5 2011-03-08
-*  changing units on API request logging
-== v0.3.4 2011-02-08
-*  Fixed escaping special characters in the client.  This needs to happen after signing.
-== v0.3.3 2011-01-28
-*  Add session features to the api client.
-*  Remove redundant debug log call
-== v0.3.2 2011-01-28
-*  CustomFields class added
-== v0.3.1 2011-01-27
-*  Prep work for rubygems
-*  doc corrections
-== v0.3.0 2011-01-17
-*  Added license for release.
-== v0.2.9 2011-01-12
-*  misc project cleanup
-== v0.2.8 2011-01-10
-*  Fixed client to use http for all requests (except for session auth) by default.  Added :ssl option to enable https for all traffic.
-*  Fixed client connection and resets.
-== v0.2.7 2011-01-10
-*  Build troubles
-== v0.2.6 2011-01-10
-== v0.2.5 2011-01-10
-== v0.2.4 2011-01-10
-== v0.2.3 2011-01-10
-*  Handy startup script picking keys from the environment.
-== v0.2.2 2010-12-29
-*  per_page setting for the client models.
-*  Pagination support for the Spark api client
-*  Added branded? and unbranded? instance methods to Video
-*  Added document model
-*  Added virtual tours model
-*  Added videos model
-*  Contact model and saving
-*  Added `find_by_cart_id' method to Listing model
-*  allow finder to pass thru options
-*  Implemented Listing.find(:all, ...)
-== v0.2.1 2010-12-29
-*  fixed some error code issues.
-*  corrected default endpoint to include the URL scheme
-== v0.2.0 2010-12-27
-*  new gemspec
-*  Session caching 
-*  Major overhaul on the models for code reuse
-*  added Photo.find_by_listing_key
-== v0.1.1 2010-12-23
-*  IDX link and market stat models.
-== v0.1.0 2010-12-13
-* Initial usable release with request interface and models 
+== v1.1.0 2012-08-07
+* Upgraded faraday and other gems, cleand up the middleware
+== v1.0.4 2012-07-26
+* Moved to github for all development
+== v1.0.3 2012-07-09
+* Rental calendar
+== v1.0.2 2012-05-30
+* OpenId/Hybrid flow support
+* OAuthSession does not support symbols as init
+== v1.0.1 2012-04-30
+* Fixed yaml config files
+== v1.0.0 2012-04-20
+* Switch to spark api branding from flexmls_api

data/VERSION

@@ -1 +1 @@
-1.0.4
+1.1.0

data/lib/spark_api.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
-require 'json'
 require 'logger'
+require 'multi_json'
 
 require 'spark_api/version'
 require 'spark_api/configuration'
@@ -11,7 +11,7 @@ require 'spark_api/paginate'
 require 'spark_api/request'
 require 'spark_api/connection'
 require 'spark_api/client'
-require 'spark_api/faraday'
+require 'spark_api/faraday_middleware'
 require 'spark_api/primary_array'
 require 'spark_api/options_hash'
 require 'spark_api/models'

data/lib/spark_api/authentication.rb

@@ -1,7 +1,6 @@
 
 require 'openssl'
 require 'faraday'
-require 'faraday_middleware'
 require 'yajl'
 require 'date'
 

data/lib/spark_api/authentication/oauth2.rb

@@ -217,7 +217,7 @@ module SparkApi
     end
 
     module OAuth2Impl
-      require 'spark_api/authentication/oauth2_impl/middleware'
+      require 'spark_api/authentication/oauth2_impl/faraday_middleware'
       require 'spark_api/authentication/oauth2_impl/grant_type_base'
       require 'spark_api/authentication/oauth2_impl/grant_type_refresh'
       require 'spark_api/authentication/oauth2_impl/grant_type_code'

data/lib/spark_api/authentication/oauth2_impl/{middleware.rb → faraday_middleware.rb}

@@ -1,38 +1,41 @@
-module SparkApi
+require 'faraday'
 
+module SparkApi
   module Authentication
-    
     module OAuth2Impl
-      
+  
       #==OAuth2 Faraday response middleware
       # HTTP Response after filter to package oauth2 responses and bubble up basic api errors.
-      class Middleware < Faraday::Response::ParseJson
-        def on_complete(finished_env)
-          body = parse(finished_env[:body])
+      class FaradayMiddleware < Faraday::Response::Middleware
+
+        def initialize(app)
+          super(app)
+        end
+
+        def on_complete(env)
+          body = MultiJson.decode(env[:body])
           SparkApi.logger.debug("[oauth2] Response Body: #{body.inspect}")
           unless body.is_a?(Hash)
             raise InvalidResponse, "The server response could not be understood"
           end
-          case finished_env[:status]
+          case env[:status]
           when 200..299
             SparkApi.logger.debug("[oauth2] Success!")
             session = OAuthSession.new(body)
           else 
             # Handle the WWW-Authenticate Response Header Field if present. This can be returned by 
             # OAuth2 implementations and wouldn't hurt to log.
-            auth_header_error = finished_env[:request_headers]["WWW-Authenticate"]
+            auth_header_error = env[:request_headers]["WWW-Authenticate"]
             SparkApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
-            raise ClientError, {:message => body["error"], :code =>0, :status => finished_env[:status]}
+            raise ClientError, {:message => body["error"], :code =>0, :status => env[:status]}
           end
           SparkApi.logger.debug("[oauth2] Session=#{session.inspect}")
-          finished_env[:body] = session
-        end
-    
-        def initialize(app)
-          super(app)
+          env[:body] = session
         end
-        
+
       end
+      Faraday.register_middleware :response, :oauth2_impl => FaradayMiddleware
+
     end
   end
 end

data/lib/spark_api/authentication/oauth2_impl/grant_type_base.rb

@@ -68,9 +68,10 @@ module SparkApi
           }
           opts[:ssl] = {:verify => false }
           opts[:url] = endpoint       
-          conn = Faraday::Connection.new(opts) do |builder|
-            builder.adapter Faraday.default_adapter
-            builder.use SparkApi::Authentication::OAuth2Impl::Middleware
+          Faraday.register_middleware :response, :faraday_middleware => FaradayMiddleware
+          conn = Faraday::Connection.new(opts) do |conn|
+            conn.response :oauth2_impl
+            conn.adapter Faraday.default_adapter
           end
         end        
         def build_url_parameters(parameters={})

data/lib/spark_api/configuration.rb

@@ -1,5 +1,7 @@
 module SparkApi
   module Configuration
+
+    MultiJson.engine = "yajl"
     
     # valid configuration options
     VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, 

data/lib/spark_api/connection.rb

@@ -1,7 +1,5 @@
 require 'openssl'
 require 'faraday'
-require 'faraday_middleware'
-require 'yajl'
 
 module SparkApi
   # =Connection
@@ -20,9 +18,10 @@ module SparkApi
       else 
         opts[:url] = @endpoint.sub /^https:/, "http:"
       end
-      conn = Faraday::Connection.new(opts) do |builder|
-        builder.adapter Faraday.default_adapter
-        builder.use SparkApi::FaradayExt::SparkMiddleware
+
+      conn = Faraday.new(opts) do |conn|
+        conn.response :spark_api
+        conn.adapter Faraday.default_adapter
       end
       SparkApi.logger.debug("Connection: #{conn.inspect}")
       conn

data/lib/spark_api/faraday_middleware.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require 'cgi'
+
+module SparkApi
+  #=Spark API Faraday middleware
+  # HTTP Response after filter to package api responses and bubble up basic api errors.
+  class FaradayMiddleware < Faraday::Response::Middleware
+    include SparkApi::PaginateHelper      
+    
+    def initialize(app)
+      super(app)
+    end
+
+    # Handles pretty much all the api response parsing and error handling.  All responses that
+    # indicate a failure will raise a SparkApi::ClientError exception
+    def on_complete(env)
+      body = MultiJson.decode(env[:body])
+      SparkApi.logger.debug("Response Body: #{body.inspect}")
+      unless body.is_a?(Hash) && body.key?("D")
+        raise InvalidResponse, "The server response could not be understood"
+      end
+      response = ApiResponse.new body
+      paging = response.pagination
+      if paging.nil?
+        results = response
+      else
+        q = CGI.parse(env[:url].query)
+        if q.key?("_pagination") && q["_pagination"].first == "count"
+          results = paging['TotalRows']
+        else
+          results = paginate_response(response, paging)
+        end
+      end
+      case env[:status]
+      when 400
+        hash = {:message => response.message, :code => response.code, :status => env[:status]}
+
+        # constraint violation
+        if response.code == 1053
+          details = body['D']['Details']
+          hash[:details] = details
+        end
+        raise BadResourceRequest,hash
+      when 401
+        # Handle the WWW-Authenticate Response Header Field if present. This can be returned by 
+        # OAuth2 implementations and wouldn't hurt to log.
+        auth_header_error = env[:request_headers]["WWW-Authenticate"]
+        SparkApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
+        raise PermissionDenied, {:message => response.message, :code => response.code, :status => env[:status]}
+      when 404
+        raise NotFound, {:message => response.message, :code => response.code, :status => env[:status]}
+      when 405
+        raise NotAllowed, {:message => response.message, :code => response.code, :status => env[:status]}
+      when 409
+        raise BadResourceRequest, {:message => response.message, :code => response.code, :status => env[:status]}
+      when 500
+        raise ClientError, {:message => response.message, :code => response.code, :status => env[:status]}
+      when 200..299
+        SparkApi.logger.debug("Success!")
+      else 
+        raise ClientError, {:message => response.message, :code => response.code, :status => env[:status]}
+      end
+      env[:body] = results
+    end
+    
+  end
+  Faraday.register_middleware :response, :spark_api => FaradayMiddleware
+
+end

data/lib/spark_api/models/photo.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module SparkApi
   module Models
     class Photo < Base

data/spec/mock_helper.rb

@@ -106,9 +106,9 @@ def mock_expired_session()
 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
+  Faraday.new(nil, {:headers => SparkApi::Client.new.headers}) do |conn|
+    conn.response :spark_api
+    conn.adapter :test, stubs
   end
 end
 

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require "rubygems"
 require "json"
+require 'multi_json'
 require "rspec"
 require 'rspec/autorun'
 require 'webmock/rspec'

data/spec/unit/spark_api/paginate_spec.rb

@@ -139,7 +139,7 @@ describe SparkApi::Paginate do
           "Success": true, 
           "Results": [#{ListingJson.create_all(10)}],
           #{paginate_json}
-        }
+        }}
       JSON
       stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/listings").
         with(:query => {
@@ -172,7 +172,7 @@ describe SparkApi::Paginate do
           "Success": true, 
           "Results": [#{ListingJson.create_all(10)}],
           #{paginate_json(2)}
-        }
+        }}
       JSON
       stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/listings").
         with(:query => {
@@ -195,7 +195,7 @@ describe SparkApi::Paginate do
           "Success": true, 
           "Results": [#{ListingJson.create_all(8)}],
           #{paginate_json(4)}
-        }
+        }}
       JSON
       stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/listings").
         with(:query => {

data/spec/unit/spark_api_spec.rb

@@ -5,6 +5,10 @@ describe SparkApi do
     reset_config
   end
 
+  it "should use 'yajl-ruby' for parsing json" do
+    MultiJson.engine.should eq(MultiJson::Adapters::Yajl)
+  end
+
   it "should load the version" do
     subject::VERSION.should match(/\d+\.\d+\.\d+/)
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: spark_api
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 4
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors: 
 - Brandon Hornseth
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-26 00:00:00 Z
+date: 2012-08-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -24,34 +24,18 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 61
         segments: 
         - 0
-        - 7
-        - 5
-        version: 0.7.5
+        - 8
+        - 1
+        version: 0.8.1
   requirement: *id001
   prerelease: false
   name: faraday
   type: :runtime
 - !ruby/object:Gem::Dependency 
   version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 7
-        - 0
-        version: 0.7.0
-  requirement: *id002
-  prerelease: false
-  name: faraday_middleware
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,42 +45,43 @@ dependencies:
         - 1
         - 0
         version: "1.0"
-  requirement: *id003
+  requirement: *id002
   prerelease: false
   name: multi_json
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 1
         segments: 
         - 1
-        - 5
-        version: "1.5"
-  requirement: *id004
+        - 7
+        version: "1.7"
+  requirement: *id003
   prerelease: false
   name: json
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 19
         segments: 
+        - 1
+        - 1
         - 0
-        - 8
-        version: "0.8"
-  requirement: *id005
+        version: 1.1.0
+  requirement: *id004
   prerelease: false
   name: yajl-ruby
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -115,27 +100,12 @@ dependencies:
         - 0
         - 0
         version: 4.0.0
-  requirement: *id006
+  requirement: *id005
   prerelease: false
   name: builder
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 2
-        version: "2.2"
-  requirement: *id007
-  prerelease: false
-  name: addressable
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -155,12 +125,12 @@ dependencies:
         - 0
         - 0
         version: 4.0.0
-  requirement: *id008
+  requirement: *id006
   prerelease: false
   name: will_paginate
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -171,12 +141,12 @@ dependencies:
         - 9
         - 2
         version: 0.9.2
-  requirement: *id009
+  requirement: *id007
   prerelease: false
   name: rake
   type: :development
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -187,12 +157,12 @@ dependencies:
         - 8
         - 0
         version: 2.8.0
-  requirement: *id010
+  requirement: *id008
   prerelease: false
   name: rspec
   type: :development
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -203,12 +173,12 @@ dependencies:
         - 7
         - 5
         version: 1.7.5
-  requirement: *id011
+  requirement: *id009
   prerelease: false
   name: webmock
   type: :development
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -219,12 +189,12 @@ dependencies:
         - 2
         - 4
         version: 0.2.4
-  requirement: *id012
+  requirement: *id010
   prerelease: false
   name: typhoeus
   type: :development
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id013 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -235,12 +205,12 @@ dependencies:
         - 6
         - 3
         version: 1.6.3
-  requirement: *id013
+  requirement: *id011
   prerelease: false
   name: ci_reporter
   type: :development
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id014 !ruby/object:Gem::Requirement 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -251,12 +221,12 @@ dependencies:
         - 9
         - 9
         version: 0.9.9
-  requirement: *id014
+  requirement: *id012
   prerelease: false
   name: rcov
   type: :development
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id015 !ruby/object:Gem::Requirement 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -267,7 +237,7 @@ dependencies:
         - 2
         - 5
         version: 0.2.5
-  requirement: *id015
+  requirement: *id013
   prerelease: false
   name: flexmls_gems
   type: :development
@@ -288,7 +258,7 @@ files:
 - VERSION
 - bin/spark_api
 - lib/spark_api/authentication/api_auth.rb
-- lib/spark_api/authentication/oauth2_impl/middleware.rb
+- lib/spark_api/authentication/oauth2_impl/faraday_middleware.rb
 - lib/spark_api/authentication/oauth2_impl/grant_type_base.rb
 - lib/spark_api/authentication/oauth2_impl/password_provider.rb
 - lib/spark_api/authentication/oauth2_impl/grant_type_code.rb
@@ -297,6 +267,7 @@ files:
 - lib/spark_api/authentication/oauth2_impl/grant_type_password.rb
 - lib/spark_api/authentication/oauth2.rb
 - lib/spark_api/authentication/base_auth.rb
+- lib/spark_api/faraday_middleware.rb
 - lib/spark_api/client.rb
 - lib/spark_api/primary_array.rb
 - lib/spark_api/version.rb
@@ -335,7 +306,6 @@ files:
 - lib/spark_api/cli/api_auth.rb
 - lib/spark_api/cli/setup.rb
 - lib/spark_api/cli/oauth2.rb
-- lib/spark_api/faraday.rb
 - lib/spark_api/request.rb
 - lib/spark_api/options_hash.rb
 - lib/spark_api/cli.rb
@@ -440,7 +410,6 @@ files:
 - spec/unit/spark_api/authentication/oauth2_impl/grant_type_base_spec.rb
 - spec/unit/spark_api/authentication/oauth2_spec.rb
 - spec/unit/spark_api/authentication/api_auth_spec.rb
-- spec/unit/spark_api/faraday_spec.rb
 - spec/unit/spark_api/authentication_spec.rb
 - spec/unit/spark_api/models/open_house_spec.rb
 - spec/unit/spark_api/models/account_spec.rb
@@ -464,6 +433,7 @@ files:
 - spec/unit/spark_api/models/tour_of_home_spec.rb
 - spec/unit/spark_api/models/system_info_spec.rb
 - spec/unit/spark_api/models/standard_fields_spec.rb
+- spec/unit/spark_api/faraday_middleware_spec.rb
 - spec/unit/spark_api/options_hash_spec.rb
 - spec/unit/spark_api/paginate_spec.rb
 - spec/unit/spark_api/primary_array_spec.rb
@@ -602,7 +572,6 @@ test_files:
 - spec/unit/spark_api/authentication/oauth2_impl/grant_type_base_spec.rb
 - spec/unit/spark_api/authentication/oauth2_spec.rb
 - spec/unit/spark_api/authentication/api_auth_spec.rb
-- spec/unit/spark_api/faraday_spec.rb
 - spec/unit/spark_api/authentication_spec.rb
 - spec/unit/spark_api/models/open_house_spec.rb
 - spec/unit/spark_api/models/account_spec.rb
@@ -626,6 +595,7 @@ test_files:
 - spec/unit/spark_api/models/tour_of_home_spec.rb
 - spec/unit/spark_api/models/system_info_spec.rb
 - spec/unit/spark_api/models/standard_fields_spec.rb
+- spec/unit/spark_api/faraday_middleware_spec.rb
 - spec/unit/spark_api/options_hash_spec.rb
 - spec/unit/spark_api/paginate_spec.rb
 - spec/unit/spark_api/primary_array_spec.rb

data/lib/spark_api/faraday.rb

@@ -1,64 +0,0 @@
-module SparkApi
-  module FaradayExt
-    #=Spark API Faraday middleware
-    # HTTP Response after filter to package api responses and bubble up basic api errors.
-    class SparkMiddleware < Faraday::Response::ParseJson
-      include SparkApi::PaginateHelper      
-      # Handles pretty much all the api response parsing and error handling.  All responses that
-      # indicate a failure will raise a SparkApi::ClientError exception
-      def on_complete(finished_env)
-        body = parse(finished_env[:body])
-        SparkApi.logger.debug("Response Body: #{body.inspect}")
-        unless body.is_a?(Hash) && body.key?("D")
-          raise InvalidResponse, "The server response could not be understood"
-        end
-        response = ApiResponse.new body
-        paging = response.pagination
-        if paging.nil?
-          results = response
-        else
-          if finished_env[:url].query_values["_pagination"] == "count"
-            results = paging['TotalRows']
-          else
-            results = paginate_response(response, paging)
-          end
-        end
-        case finished_env[:status]
-        when 400
-          hash = {:message => response.message, :code => response.code, :status => finished_env[:status]}
-
-          # constraint violation
-          if response.code == 1053
-            details = body['D']['Details']
-            hash[:details] = details
-          end
-          raise BadResourceRequest,hash
-        when 401
-          # Handle the WWW-Authenticate Response Header Field if present. This can be returned by 
-          # OAuth2 implementations and wouldn't hurt to log.
-          auth_header_error = finished_env[:request_headers]["WWW-Authenticate"]
-          SparkApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
-          raise PermissionDenied, {:message => response.message, :code => response.code, :status => finished_env[:status]}
-        when 404
-          raise NotFound, {:message => response.message, :code => response.code, :status => finished_env[:status]}
-        when 405
-          raise NotAllowed, {:message => response.message, :code => response.code, :status => finished_env[:status]}
-        when 409
-          raise BadResourceRequest, {:message => response.message, :code => response.code, :status => finished_env[:status]}
-        when 500
-          raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
-        when 200..299
-          SparkApi.logger.debug("Success!")
-        else 
-          raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
-        end
-        finished_env[:body] = results
-      end
-      
-      def initialize(app)
-        super(app)
-      end
-      
-    end
-  end
-end