spark_api 1.4.24 → 1.4.25

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjU2ZTQ1NGNmOTEyYmMzNmY2MWMzMjg2ZmI4YTc3NGNmNTg3NzkzYw==
+    YWRmNWJhNzE4N2I3MTU1Y2M5MjFlYWFmMGVkMjlhNjg1MTY2NTgyOA==
   data.tar.gz: !binary |-
-    ZGY1YjFkNjBjYTBiOGExZWUwZDIzNzk5ZTMzMGFiMmIzMDg2YzYyNg==
+    MWViOWU1YjgzODg2NjgzZWQyOWI2MTcxZThkY2YxNWVhYmY1NTc5MA==
 SHA512:
   metadata.gz: !binary |-
-    ZDAxMzg0ZmI0ZjYyMzYxOWMzYTcwYTBiMmNlNzJjNWM2ZTkyMWNjNzYxYWU0
-    YzEyNjA4NTM2NGJjY2FiNzIxNzFmZWIyZmNiZTM4MWVkMjg0NjIxNjAyYWRm
-    MDgxN2VhYjU5OWM0NjJjNWU5MGQ1MGViZTUwMzY0OGQ2ODYzNzQ=
+    Y2VlNjczMDNmMjQ2NGUwYmY0ZGNmMjFhOTRiZDg4OTJmYzAzYTgyZmE3ZTcz
+    Mzc4NzZjYTI2MzBmMjAwOGI2MTIzZmI1MTU4MzVjOGRhMTYyY2NhYTc2YjEy
+    NWUzZTNlYzRhMmFlZDhiM2M3NmFhNGVmZTM5ODdiMzcxMGE3NWY=
   data.tar.gz: !binary |-
-    MWExMjNiZGRiOTJhMTU1NTg5ZDI0MjNkNmU5NmMyYjc2ZjcwMWU0MGU3MGIz
-    NTA1MzIzMTY3YjcxZDBlMGQ2YzdlMTg3OTVjMzMzMTQwMTMxZjIwZDViMDAz
-    MDVjMDZhOGI0MjNkNTA5ZjdjYjUxNzllM2M1ZTBlNzc4NDFlNGU=
+    MWQxOWQ0ODM3MTcyMjJkZTBlNTI1MmYyZWVjYzdhNzE2MzQzODNiOGEyZjVk
+    ZGZlNzUwNzg4Y2EyN2EyNTAyM2VmOTNiZjVmZjg0MjRjNDk1Y2YwYTAxZWVm
+    MzgwOTljMDVhZWI0MTE2YmNiMzIzYzBkYzJlNzFlZDRiYmYwY2Q=

data/VERSION

@@ -1 +1 @@
-1.4.24
+1.4.25

data/lib/spark_api/configuration.rb

@@ -11,7 +11,7 @@ module SparkApi
     # valid configuration options
     VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, 
       :user_agent, :version, :ssl, :ssl_verify, :oauth2_provider, :authentication_mode, 
-      :auth_endpoint, :callback, :compress, :timeout, :middleware].freeze
+      :auth_endpoint, :callback, :compress, :timeout, :middleware, :request_id_chain].freeze
     OAUTH2_KEYS = [:authorization_uri, :access_uri, :client_id, :client_secret,
       # Requirements for authorization_code grant type
       :redirect_uri,  
@@ -44,6 +44,7 @@ module SparkApi
     DEFAULT_COMPRESS = false
     DEFAULT_TIMEOUT = 5 # seconds
     DEFAULT_MIDDLEWARE = 'spark_api'
+    DEFAULT_REQUEST_ID_CHAIN = nil
     
     X_SPARK_API_USER_AGENT = "X-SparkApi-User-Agent"
 
@@ -78,6 +79,7 @@ module SparkApi
       self.compress    = DEFAULT_COMPRESS
       self.timeout     = DEFAULT_TIMEOUT
       self.middleware = DEFAULT_MIDDLEWARE
+      self.request_id_chain = DEFAULT_REQUEST_ID_CHAIN
       self
     end
   end

data/lib/spark_api/connection.rb

@@ -5,6 +5,15 @@ module SparkApi
   # =Connection
   # Mixin module for handling http connection information
   module Connection
+    REG_HTTP  = /^http:/
+    REG_HTTPS = /^https:/
+    HTTP_SCHEME = 'http:'
+    HTTPS_SCHEME = 'https:'
+    ACCEPT_ENCODING = 'Accept-Encoding'
+    COMPRESS_ACCEPT_ENCODING = 'gzip, deflate'
+    X_REQUEST_ID_CHAIN = 'X-Request-Id-Chain'
+    MIME_JSON = 'application/json'
+    MIME_RESO = 'application/json, application/xml'
     # Main connection object for running requests.  Bootstraps the Faraday abstraction layer with 
     # our client configuration.
     def connection(force_ssl = false)
@@ -13,13 +22,17 @@ module SparkApi
       }
       if(force_ssl || self.ssl)
         opts[:ssl] = {:verify => false } unless self.ssl_verify
-        opts[:url] = @endpoint.sub /^http:/, "https:"
+        opts[:url] = @endpoint.sub REG_HTTP, HTTPS_SCHEME
       else 
-        opts[:url] = @endpoint.sub /^https:/, "http:"
+        opts[:url] = @endpoint.sub REG_HTTPS, HTTP_SCHEME
       end
 
       if self.compress
-        opts[:headers]["Accept-Encoding"] = 'gzip, deflate'
+        opts[:headers][ACCEPT_ENCODING] = COMPRESS_ACCEPT_ENCODING
+      end
+
+      if request_id_chain
+        opts[:headers][X_REQUEST_ID_CHAIN] = request_id_chain
       end
 
       conn = Faraday.new(opts) do |conn|
@@ -42,8 +55,8 @@ module SparkApi
 
     def spark_headers
       {
-        :accept => 'application/json',
-        :content_type => 'application/json',
+        :accept => MIME_JSON,
+        :content_type => MIME_JSON,
         :user_agent => Configuration::DEFAULT_USER_AGENT,
         Configuration::X_SPARK_API_USER_AGENT => user_agent
       }
@@ -51,7 +64,7 @@ module SparkApi
 
     def reso_headers
       {
-        :accept => 'application/json, application/xml',
+        :accept => MIME_RESO,
         :user_agent => Configuration::DEFAULT_USER_AGENT,
         Configuration::X_SPARK_API_USER_AGENT => user_agent
       }

data/lib/spark_api/errors.rb

@@ -21,7 +21,7 @@ module SparkApi
   # Errors built from API responses
   class InvalidResponse < StandardError; end
   class ClientError < StandardError
-    attr_reader :code, :status, :details, :request_path, :errors
+    attr_reader :code, :status, :details, :request_path, :request_id, :errors
     def initialize (options = {})
       # Support the standard initializer for errors
       opts = options.is_a?(Hash) ? options : {:message => options.to_s}
@@ -29,6 +29,7 @@ module SparkApi
       @status = opts[:status]
       @details = opts[:details]
       @request_path = opts[:request_path]
+      @request_id = opts[:request_id]
       @errors = opts[:errors]
       super(opts[:message])
     end

data/lib/spark_api/faraday_middleware.rb

@@ -22,7 +22,8 @@ module SparkApi
       unless body.is_a?(Hash) && body.key?("D")
         raise InvalidResponse, "The server response could not be understood"
       end
-      response = ApiResponse.new body
+      request_id = env[:response_headers]['x-request-id']
+      response = ApiResponse.new body, request_id
       paging = response.pagination
 
       if paging.nil?
@@ -38,6 +39,7 @@ module SparkApi
 
       error_hash = {
         :request_path => env[:url],
+        :request_id => request_id,
         :message => response.message,
         :code => response.code,
         :status => env[:status],

data/lib/spark_api/request.rb

@@ -79,7 +79,7 @@ module SparkApi
           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} request_id=#{response.headers['x-request-id']}" }
       rescue PermissionDenied => e
         if(ResponseCodes::SESSION_TOKEN_EXPIRED == e.code)
           unless (attempts +=1) > 1

data/lib/spark_api/response.rb

@@ -1,7 +1,7 @@
 module SparkApi
   # API Response interface
   module Response
-    ATTRIBUTES = [:code, :message, :results, :success, :pagination, :details, :d, :errors, :sparkql_errors]
+    ATTRIBUTES = [:code, :message, :results, :success, :pagination, :details, :d, :errors, :sparkql_errors, :request_id]
     attr_accessor *ATTRIBUTES
     def success?
       @success
@@ -10,21 +10,31 @@ module SparkApi
   
   # Nice and handy class wrapper for the api response hash
   class ApiResponse < ::Array
+    MAGIC_D = 'D'
+    MESSAGE = 'Message'
+    CODE = 'Code'
+    RESULTS = 'Results'
+    SUCCESS = 'Success'
+    PAGINATION = 'Pagination'
+    DETAILS = 'Details'
+    ERRORS = 'Errors'
+    SPARKQL_ERRORS = 'SparkQLErrors'
     include SparkApi::Response
-    def initialize(d)
+    def initialize d, request_id=nil
       begin
-        self.d = d["D"]
+        self.d = d[MAGIC_D]
         if self.d.nil? || self.d.empty?
           raise InvalidResponse, "The server response could not be understood"
         end
-        self.message    = self.d["Message"]
-        self.code       = self.d["Code"]
-        self.results    = Array(self.d["Results"])
-        self.success    = self.d["Success"]
-        self.pagination = self.d["Pagination"]
-        self.details    = self.d["Details"] || []
-        self.errors     = self.d["Errors"]
-        self.sparkql_errors = self.d['SparkQLErrors']
+        self.message    = self.d[MESSAGE]
+        self.code       = self.d[CODE]
+        self.results    = Array(self.d[RESULTS])
+        self.success    = self.d[SUCCESS]
+        self.pagination = self.d[PAGINATION]
+        self.details    = self.d[DETAILS] || []
+        self.errors     = self.d[ERRORS]
+        self.sparkql_errors = self.d[SPARKQL_ERRORS]
+        self.request_id = request_id
         super(results)
       rescue Exception => e
         SparkApi.logger.error "Unable to understand the response! #{d}"

data/spec/unit/spark_api/configuration_spec.rb

@@ -13,6 +13,7 @@ describe SparkApi::Client, "Client config"  do
       SparkApi.api_key = "my_api_key"
       SparkApi.api_key.should match("my_api_key")
       SparkApi.timeout.should eq(5)
+      SparkApi.request_id_chain.should be_nil
     end
   end
 
@@ -23,7 +24,8 @@ describe SparkApi::Client, "Client config"  do
                                     :api_user => "1234",
                                     :auth_endpoint => "https://login.wade.dev.fbsdata.com",
                                     :endpoint => "http://api.wade.dev.fbsdata.com",
-                                    :timeout => 15)
+                                    :timeout => 15,
+                                    :request_id_chain => 'foobar')
  
       client.api_key.should match("key_of_wade")
       client.api_secret.should match("TopSecret")
@@ -32,6 +34,7 @@ describe SparkApi::Client, "Client config"  do
       client.endpoint.should match("http://api.wade.dev.fbsdata.com")
       client.version.should match("v1")
       client.timeout.should eq(15)
+      client.request_id_chain.should eq('foobar')
     end
     
     it "should allow unverified ssl certificates when verification is off" do
@@ -126,11 +129,14 @@ describe SparkApi::Client, "Client config"  do
         config.version = "veleventy"
         config.endpoint = "test.api.sparkapi.com"
         config.user_agent = "my useragent"
+        config.request_id_chain = 'foobar'
       end
       
       SparkApi.api_key.should match("my_key")
+      SparkApi.request_id_chain.should eq("foobar")
       SparkApi.reset
       SparkApi.api_key.should == SparkApi::Configuration::DEFAULT_API_KEY
+      SparkApi.request_id_chain.should SparkApi::Configuration::DEFAULT_REQUEST_ID_CHAIN
     
     end
   end
@@ -184,6 +190,31 @@ describe SparkApi::Client, "Client config"  do
         })
     end
 
+    it "should pass along the request_id_chain header if set" do
+      reset_config
+      stub_auth_request
+      stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/headers").
+          with(:query => {
+            :ApiUser => "foobar",
+            :ApiSig => "717a066c4f4302c5ca9507e484db4812",
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+          }).
+          to_return(:body => '{"D":{"Success": true,"Results": []}}')
+      SparkApi.configure do |config|
+        config.user_agent = "my useragent"
+        config.request_id_chain = 'foobar'
+      end
+      SparkApi.client.get '/headers'
+      WebMock.should have_requested(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/headers?ApiUser=foobar&ApiSig=717a066c4f4302c5ca9507e484db4812&AuthToken=c401736bf3d3f754f07c04e460e09573").
+        with(:headers => {
+          'User-Agent' => SparkApi::Configuration::DEFAULT_USER_AGENT,
+          SparkApi::Configuration::X_SPARK_API_USER_AGENT => "my useragent",
+          'Accept'=>'application/json', 
+          'Content-Type'=>'application/json',
+          'X-Request-Id-Chain' => 'foobar'
+        })
+    end
+
     it "should not set gzip header by default" do
       c = SparkApi::Client.new(:endpoint => "https://sparkapi.com")
       c.connection.headers["Accept-Encoding"].should be_nil

data/spec/unit/spark_api/request_spec.rb

@@ -2,7 +2,7 @@ require './spec/spec_helper'
 
 describe SparkApi do
   describe SparkApi::ClientError do
-    subject { SparkApi::ClientError.new({:message=>"OMG FAIL", :code=>1234, :status=>500, :request_path => '/v1/foo'}) }
+    subject { SparkApi::ClientError.new({:message=>"OMG FAIL", :code=>1234, :status=>500, :request_path => '/v1/foo', :request_id => 'deadbeef'}) }
     it "should print a helpful to_s" do
       subject.to_s.should == "OMG FAIL"
       subject.message.should == "OMG FAIL"
@@ -18,6 +18,10 @@ describe SparkApi do
       subject.request_path.should == '/v1/foo'
     end
 
+    it "should have a request_id" do
+      subject.request_id.should == 'deadbeef'
+    end
+
     it "should raise and exception with attached message" do
       expect { raise subject.class, {:message=>"My Message", :code=>1000, :status=>404}}.to raise_error(SparkApi::ClientError)  do |e| 
         e.message.should == "My Message" 
@@ -38,6 +42,7 @@ describe SparkApi do
         e.message.should == "My Message" 
         e.code.should be == nil
         e.status.should be == nil
+        e.request_id.should be == nil
       end
     end
   end
@@ -51,6 +56,13 @@ describe SparkApi do
       r = SparkApi::ApiResponse.new({"D"=>{"Success" => true, "Results" => []}})
       r.success?.should be(true)
       r.results.empty?.should be(true)
+      r.request_id.should eq nil
+    end
+
+    it "should return the request_id" do
+      r = SparkApi::ApiResponse.new({"D"=>{"Success" => true, "Results" => []}}, 'foobar')
+      r.success?.should be(true)
+      r.request_id.should eq('foobar')
     end
     it "should have a message on error" do
       r = SparkApi::ApiResponse.new({"D"=>{"Success" => false, "Message" => "I am a failure."}})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spark_api
 version: !ruby/object:Gem::Version
-  version: 1.4.24
+  version: 1.4.25
 platform: ruby
 authors:
 - Brandon Hornseth
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday