spark_api 1.3.16 → 1.3.17

data/README.md

@@ -21,6 +21,7 @@ Usage Examples
 ------------------------
 
 ```ruby
+require 'spark_api'
 SparkApi.configure do |config|
   config.endpoint   = 'https://sparkapi.com'
   # Using Spark API Authentication, refer to the Authentication documentation for OAuth2

data/VERSION

@@ -1 +1 @@
-1.3.16
+1.3.17

data/lib/spark_api.rb

@@ -29,6 +29,10 @@ module SparkApi
     end
     @logger
   end
+
+  def self.logger= logger
+    @logger = logger
+  end
   #:nocov:
 
   def self.client(opts={})

data/lib/spark_api/authentication.rb

@@ -22,8 +22,8 @@ module SparkApi
       start_time = Time.now
       request_time = Time.now - start_time
       new_session = @authenticator.authenticate
-      SparkApi.logger.info("[#{(request_time * 1000).to_i}ms]")
-      SparkApi.logger.debug("Session: #{new_session.inspect}")
+      SparkApi.logger.info { "[#{(request_time * 1000).to_i}ms]" }
+      SparkApi.logger.debug { "Session: #{new_session.inspect}" }
       new_session
     end
 
@@ -34,7 +34,7 @@ module SparkApi
     
     # Delete the current session
     def logout
-      SparkApi.logger.info("Logging out.")
+      SparkApi.logger.info { "Logging out." }
       @authenticator.logout
     end
 

data/lib/spark_api/authentication/api_auth.rb

@@ -17,15 +17,15 @@ module SparkApi
       
       def authenticate
         sig = sign("#{@client.api_secret}ApiKey#{@client.api_key}")
-        SparkApi.logger.debug("Authenticating to #{@client.endpoint}")
+        SparkApi.logger.debug { "Authenticating to #{@client.endpoint}" }
         start_time = Time.now
         request_path = "/#{@client.version}/session?ApiKey=#{@client.api_key}&ApiSig=#{sig}"
         resp = @client.connection(true).post request_path, ""
         request_time = Time.now - start_time
-        SparkApi.logger.info("[#{(request_time * 1000).to_i}ms] Api: POST #{request_path}")
-        SparkApi.logger.debug("Authentication Response: #{resp.inspect}")
+        SparkApi.logger.info { "[#{(request_time * 1000).to_i}ms] Api: POST #{request_path}" }
+        SparkApi.logger.debug { "Authentication Response: #{resp.inspect}" }
         @session = Session.new(resp.body.results.first)
-        SparkApi.logger.debug("Authentication: #{@session.inspect}")
+        SparkApi.logger.debug { "Authentication: #{@session.inspect}" }
         @session
       end
       
@@ -74,11 +74,11 @@ module SparkApi
         request_opts.merge!(options)
         sig = sign_token(escaped_path, request_opts, body)
         request_path = "#{escaped_path}?#{build_url_parameters({"ApiSig"=>sig}.merge(request_opts))}"
-        SparkApi.logger.debug("Request: #{request_path}")
+        SparkApi.logger.debug { "Request: #{request_path}" }
         if body.nil?
           response = @client.connection.send(method, request_path)
         else
-          SparkApi.logger.debug("Data: #{body}")
+          SparkApi.logger.debug { "Data: #{body}" }
           response = @client.connection.send(method, request_path, body)
         end
         response

data/lib/spark_api/authentication/oauth2.rb

@@ -50,11 +50,11 @@ module SparkApi
 
         parameter_string = options.size > 0 ? "?#{build_url_parameters(options)}" : ""
         request_path = "#{escaped_path}#{parameter_string}"
-        SparkApi.logger.debug("Request: #{request_path}")
+        SparkApi.logger.debug { "Request: #{request_path}" }
         if body.nil?
           response = connection.send(method, request_path)
         else
-          SparkApi.logger.debug("Data: #{body}")
+          SparkApi.logger.debug { "Data: #{body}" }
           response = connection.send(method, request_path, body)
         end
         response
@@ -76,14 +76,14 @@ module SparkApi
       # Create a sparkbar token based on the current user's access token
       def sparkbar_token()
         raise ClientError, "OAuth2Provider must configure the sparkbar_uri to use sparkbar tokens" if provider.sparkbar_uri.nil?
-        SparkApi.logger.debug("[sparkbar] create token to #{provider.sparkbar_uri}")
+        SparkApi.logger.debug { "[sparkbar] create token to #{provider.sparkbar_uri}" }
         uri = URI.parse(provider.sparkbar_uri)
         request_path = "#{uri.path}"
         
-        SparkApi.logger.info("[sparkbar] create token to #{request_path}, #{session.access_token.inspect}")
+        SparkApi.logger.info { "[sparkbar] create token to #{request_path}, #{session.access_token.inspect}" }
         response = sparkbar_connection("#{uri.scheme}://#{uri.host}").post(request_path, "access_token=#{session.access_token}").body
         token = response["token"]
-        SparkApi.logger.debug("[sparkbar] New token created #{token}")
+        SparkApi.logger.debug { "[sparkbar] New token created #{token}" }
         token
       end
       

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

@@ -14,22 +14,22 @@ module SparkApi
 
         def on_complete(env)
           body = MultiJson.decode(env[:body])
-          SparkApi.logger.debug("[oauth2] Response Body: #{body.inspect}")
+          SparkApi.logger.debug { "[oauth2] Response Body: #{body.inspect}" }
           unless body.is_a?(Hash)
             raise InvalidResponse, "The server response could not be understood"
           end
           case env[:status]
           when 200..299
-            SparkApi.logger.debug("[oauth2] Success!")
+            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 = env[:request_headers]["WWW-Authenticate"]
-            SparkApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
+            SparkApi.logger.warn { "Authentication error #{auth_header_error}" } unless auth_header_error.nil?
             raise ClientError, {:message => body["error"], :code =>0, :status => env[:status]}
           end
-          SparkApi.logger.debug("[oauth2] Session=#{session.inspect}")
+          SparkApi.logger.debug { "[oauth2] Session=#{session.inspect}" }
           env[:body] = session
         end
 
@@ -46,13 +46,13 @@ module SparkApi
   
         def on_complete(env)
           body = MultiJson.decode(env[:body])
-          SparkApi.logger.debug("[sparkbar] Response Body: #{body.inspect}")
+          SparkApi.logger.debug{ "[sparkbar] Response Body: #{body.inspect}" }
           unless body.is_a?(Hash)
             raise InvalidResponse, "The server response could not be understood"
           end
           case env[:status]
           when 200..299
-            SparkApi.logger.debug("[sparkbar] Success!")
+            SparkApi.logger.debug{ "[sparkbar] Success!" }
             if body.include?("token")
               env[:body] = body
               return

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

@@ -17,7 +17,7 @@ module SparkApi
           else
             raise ClientError, "Unsupported grant type [#{provider.grant_type}]"
           end
-          SparkApi.logger.debug("[oauth2] setup #{granter.class.name}")
+          SparkApi.logger.debug { "[oauth2] setup #{granter.class.name}" }
           granter
         end
         
@@ -38,16 +38,16 @@ module SparkApi
         protected
 
         def create_session(token_params)
-          SparkApi.logger.debug("[oauth2] create_session to #{provider.access_uri} params #{token_params}")
+          SparkApi.logger.debug { "[oauth2] create_session to #{provider.access_uri} params #{token_params}" }
           uri = URI.parse(provider.access_uri)
           request_path = "#{uri.path}"
           response = oauth_access_connection("#{uri.scheme}://#{uri.host}").post(request_path, "#{token_params}").body
           response.expires_in = provider.session_timeout if response.expires_in.nil?
-          SparkApi.logger.debug("[oauth2] New session created #{response}")
+          SparkApi.logger.debug { "[oauth2] New session created #{response}" }
           response
         rescue Faraday::Error::ConnectionFailed => e
           if @client.ssl_verify && e.message =~ /certificate verify failed/
-            SparkApi.logger.error(SparkApi::Errors.ssl_verification_error)
+            SparkApi.logger.error { SparkApi::Errors.ssl_verification_error }
           end
           raise e
         end

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

@@ -10,7 +10,7 @@ module SparkApi
         end
         def authenticate
           if(provider.code.nil?)
-            SparkApi.logger.debug("[oauth2] No authoriztion code present. Redirecting to #{authorization_url}.")
+            SparkApi.logger.debug { "[oauth2] No authoriztion code present. Redirecting to #{authorization_url}." }
             provider.redirect(authorization_url)
           end
           if needs_refreshing?
@@ -21,12 +21,12 @@ module SparkApi
         end
         
         def refresh()
-          SparkApi.logger.debug("[oauth2] Refresh oauth session.")
+          SparkApi.logger.debug { "[oauth2] Refresh oauth session." }
           refresher = GrantTypeRefresh.new(client,provider,session)
           refresher.params = {"redirect_uri" => @provider.redirect_uri}
           refresher.authenticate
         rescue ClientError => e
-          SparkApi.logger.info("[oauth2] Refreshing token failed, the library will try and authenticate from scratch: #{e.message}")
+          SparkApi.logger.info { "[oauth2] Refreshing token failed, the library will try and authenticate from scratch: #{e.message}" }
           nil
         end
 

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

@@ -12,7 +12,7 @@ module SparkApi
         def authenticate
           new_session = nil
           unless @session.refresh_token.nil?
-            SparkApi.logger.debug("[oauth2] Refreshing authentication to #{provider.access_uri} using [#{session.refresh_token}]")
+            SparkApi.logger.debug { "[oauth2] Refreshing authentication to #{provider.access_uri} using [#{session.refresh_token}]" }
             new_session = create_session(token_params)
           end
           new_session 

data/lib/spark_api/connection.rb

@@ -27,7 +27,7 @@ module SparkApi
         conn.options[:timeout] = self.timeout
         conn.adapter Faraday.default_adapter
       end
-      SparkApi.logger.debug("Connection: #{conn.inspect}")
+      SparkApi.logger.debug { "Connection: #{conn.inspect}" }
       conn
     end
     

data/lib/spark_api/faraday_middleware.rb

@@ -19,7 +19,7 @@ module SparkApi
       env[:body] = decompress_body(env)
 
       body = MultiJson.decode(env[:body])
-      SparkApi.logger.debug("Response Body: #{body.inspect}")
+      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
@@ -60,7 +60,7 @@ module SparkApi
       when 500
         raise ClientError, {:message => response.message, :code => response.code, :status => env[:status]}
       when 200..299
-        SparkApi.logger.debug("Success!")
+        SparkApi.logger.debug { "Success!" }
       else 
         raise ClientError, {:message => response.message, :code => response.code, :status => env[:status]}
       end

data/lib/spark_api/models/listing.rb

@@ -111,7 +111,6 @@ module SparkApi
         Note.build_subclass.tap do |note|
           note.prefix = "/listings/#{self.ListingKey}"
           note.element_name = "/my/notes"
-          SparkApi.logger.info("Note.path: #{note.path}")
         end
       end
 
@@ -148,7 +147,6 @@ module SparkApi
           return save!(arguments)
         rescue BadResourceRequest => e
           self.errors << {:code => e.code, :message => e.message}
-          SparkApi.logger.debug("BHDEBUG: #{e.inspect}")
           if e.code == 1053
             @constraints = []
             e.details.each do |detail|
@@ -157,16 +155,16 @@ module SparkApi
               end
             end
           end
-          SparkApi.logger.warn("Failed to save resource #{self}: #{e.message}")
+          SparkApi.logger.warn { "Failed to save resource #{self}: #{e.message}" }
         rescue NotFound => e
-          SparkApi.logger.error("Failed to save resource #{self}: #{e.message}")
+          SparkApi.logger.error { "Failed to save resource #{self}: #{e.message}" }
         end
         false
       end
       def save!(arguments={})
         writable_changed_keys = changed & WRITEABLE_FIELDS
         if writable_changed_keys.empty?
-          SparkApi.logger.warn("No supported listing change detected")
+          SparkApi.logger.warn { "No supported listing change detected" }
         else
           results = connection.put "#{self.class.path}/#{self.Id}", build_hash(writable_changed_keys), arguments
           @contstraints = []
@@ -183,9 +181,9 @@ module SparkApi
         begin
           return reorder_photos!(arguments)
         rescue BadResourceRequest => e
-          SparkApi.logger.warn("Failed to save resource #{self}: #{e.message}")
+          SparkApi.logger.warn { "Failed to save resource #{self}: #{e.message}" }
         rescue NotFound => e
-          SparkApi.logger.error("Failed to save resource #{self}: #{e.message}")
+          SparkApi.logger.error { "Failed to save resource #{self}: #{e.message}" }
         end
         false
       end
@@ -209,7 +207,14 @@ module SparkApi
       def ExpirationDate=(value)
         write_attribute("ExpirationDate", value)
       end
-      
+
+      def respond_to?(method_symbol, include_all=false)
+        if super
+          true
+        else
+          attributes['StandardFields'].include?(method_symbol.to_s) rescue false
+        end
+      end
       
       private
 

data/lib/spark_api/models/listing_cart.rb

@@ -13,10 +13,10 @@ module SparkApi
       end
 
       def ListingIds=(listing_ids)
-        attributes["ListingIds"] = Array(listing_ids)
+        write_attribute("ListingIds", Array(listing_ids))
       end
       def Name=(name)
-        attributes["Name"] = name
+        write_attribute("Name", name)
       end
 
       def path

data/lib/spark_api/multi_client.rb

@@ -43,7 +43,7 @@ module SparkApi
     end
     
     def activate_client_from_config(symbol)
-      SparkApi.logger.debug("Loading multiclient [#{symbol.to_s}] from config")
+      SparkApi.logger.debug { "Loading multiclient [#{symbol.to_s}] from config" }
       yaml = YamlConfig.build(symbol.to_s)
       if(yaml.oauth2?)
         Client.new(yaml.client_keys.merge({

data/lib/spark_api/request.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'cgi'
 
 module SparkApi
@@ -70,27 +71,27 @@ module SparkApi
           response = authenticator.request(method, request_path, nil, request_opts)
         else
           post_data = process_request_body(body)
-          SparkApi.logger.debug("#{method.to_s.upcase} Data:   #{post_data}")
+          SparkApi.logger.debug { "#{method.to_s.upcase} Data:   #{post_data}" }
           response = authenticator.request(method, request_path, post_data, request_opts)
         end
         request_time = Time.now - start_time
-        SparkApi.logger.debug("[#{(request_time * 1000).to_i}ms] Api: #{method.to_s.upcase} #{request_path}")
+        SparkApi.logger.debug { "[#{(request_time * 1000).to_i}ms] Api: #{method.to_s.upcase} #{request_path}" }
       rescue PermissionDenied => e
         if(ResponseCodes::SESSION_TOKEN_EXPIRED == e.code)
           unless (attempts +=1) > 1
-            SparkApi.logger.debug("Retrying authentication")
+            SparkApi.logger.debug { "Retrying authentication" }
             authenticate
             retry
           end
         end
         # No luck authenticating... KABOOM!
-        SparkApi.logger.error("Authentication failed or server is sending us expired tokens, nothing we can do here.")
+        SparkApi.logger.error { "Authentication failed or server is sending us expired tokens, nothing we can do here." }
         raise
       end
       response.body
     rescue Faraday::Error::ConnectionFailed => e
       if self.ssl_verify && e.message =~ /certificate verify failed/
-        SparkApi.logger.error(SparkApi::Errors.ssl_verification_error)
+        SparkApi.logger.error { SparkApi::Errors.ssl_verification_error }
       end
       raise e
     end

data/spec/fixtures/listing_carts/put.json

@@ -0,0 +1,9 @@
+{
+    "D": {
+        "ListingIds": [
+            "20110112234857732941000000",
+            "20110302120238448431000000",
+            "20110510011212354751000000"
+        ]
+  }
+}

data/spec/fixtures/listing_carts/put_ids.json

@@ -0,0 +1,9 @@
+{
+    "D": {
+        "ListingIds": [
+            "20110112234857732941000000",
+            "20110302120238448431000000",
+            "20110510011212354751000000"
+        ]
+  }
+}

data/spec/fixtures/listing_carts/put_name.json

@@ -0,0 +1,5 @@
+{
+    "D": {
+        "Name": "My Cart's Name"
+  }
+}

data/spec/spec_helper.rb

@@ -14,7 +14,6 @@ require 'spark_api'
 
 FileUtils.mkdir 'log' unless File.exists? 'log'
 
-# TODO, really we should change the library to support configuration without overriding
 module SparkApi
   def self.logger
     if @logger.nil?

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

@@ -43,14 +43,24 @@ describe ListingCart do
       resource.ListingCount.should eq(10)
     end
 
-    on_put_it "should save a listing cart" do
+    on_put_it "should save a listing cart Name" do
       stub_api_get("/#{subject.class.element_name}", 'listing_carts/listing_cart.json')
       resource = subject.class.get.first
-      stub_api_put("/#{subject.class.element_name}/#{resource.Id}", 'listing_carts/new.json', 'success.json')
+      stub_api_put("/#{subject.class.element_name}/#{resource.Id}", 'listing_carts/put_name.json', 'success.json')
       resource.Name = "My Cart's Name"
+      resource.changed?.should be(true)
+      resource.save.should be(true)
+      resource.ResourceUri.should eq("/v1/listingcarts/20100912153422758914000000")
+    end
+
+    on_put_it "should save a listing cart ListingIds" do
+      stub_api_get("/#{subject.class.element_name}", 'listing_carts/listing_cart.json')
+      resource = subject.class.get.first
+      stub_api_put("/#{subject.class.element_name}/#{resource.Id}", 'listing_carts/put_ids.json', 'success.json')
       resource.ListingIds = ['20110112234857732941000000',
                              '20110302120238448431000000',
                              '20110510011212354751000000']
+      resource.changed?.should be(true)
       resource.save.should be(true)
       resource.ResourceUri.should eq("/v1/listingcarts/20100912153422758914000000")
     end

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

@@ -97,6 +97,28 @@ describe Listing do
     it "should return full address" do
       @listing.full_address.should eq("100 Someone's St, Fargo, ND 55320")
     end
+
+    it "should provide shortcut methods to standard fields" do
+      @listing.StreetName.should eq("Someone's")
+      @listing.YearBuilt.should eq(nil)
+      @listing.BuildingAreaTotal.should eq("1321.0")
+      @listing.PublicRemarks.should eq(nil)
+      @listing.PostalCode.should eq("55320")
+      @listing.ListPrice.should eq("100000.0")
+    end
+
+    it "should report that it responds to shortcut methods to standard fields" do
+      @listing.should respond_to(:StreetName)
+      @listing.should respond_to(:YearBuilt)
+      @listing.should respond_to(:BuildingAreaTotal)
+      @listing.should respond_to(:PublicRemarks)
+      @listing.should respond_to(:PostalCode)
+      @listing.should respond_to(:ListPrice)
+
+      @listing.should_not respond_to(:BogusField)
+      @listing.StandardFields['BogusField'] = 'bogus'
+      @listing.should respond_to(:BogusField)
+    end
   end
 
   describe "class methods" do