spark_api 1.4.14 → 1.4.15

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Njk4NDliNTI2YjZjZjE1MjViYTk4NzYwYzcxNDJmYThlNzc0NzczMg==
+    YjZlZjMzZmMxM2VhODU0OTVlMGIyZDhhZGQ2ZWE5ZDUzNGU4MDJhMA==
   data.tar.gz: !binary |-
-    NzA5YTA4MTkwYTBiMmMxNmQ2MTExMWYzODllZjgyZGY1Mzg4ODNjZA==
+    N2Y2MGMzODc0YTI5NTJlODE5ZTUwMjc0MzA1NmZhZTE3ZTRmZGMzYw==
 SHA512:
   metadata.gz: !binary |-
-    Y2JmYTY0YmRlYzAxNWNlNDllNTRmODQ2ZDNlZTkxMTIwYWM2ODhkZjc4MmJk
-    MTI2MzIyZGZlN2QwMTUwZTUzOTUxNDIwMTliZjRlYzc5ZDk5YmZlNWI0ZDg2
-    OTMyZmUyZDc3NDM4ZDlkYzI2Yjc1Y2IxNDA5ZmUwNjdiZjU0ZmQ=
+    ZDczNmFhZjM3ODIxZmI4Yzc0ZGEyZDczMTdmMmMyZTljNzYwNmJlYWIyNDhh
+    YTVlNzk4ZGYxNzNkMDRlYzI3OGMwY2ZhZDg3ODE2ZTBjNTY0NmExYjA0YjVj
+    MTJiNTZjNDg2NjhmMDM0MzE0ZjQ3ZDY5MGE1Y2U5Yjc2YWI0Zjc=
   data.tar.gz: !binary |-
-    ZjQ2YTQyMjAwMTJiMzQwZTQ0MWM4MjFjNDQ0MjY3NTdkMDRjN2Y0YTY5Yzcw
-    NzRiYTUwMWY5YTcxOGRlODZjOTc4NDVlMzA3ZWVmZGRmYWU3MzI4YjNjYjky
-    YTJlZGI3MDQwZjRlNTJlNzQ3NzExNzY5ZWM2N2EzZjQ1NDg4M2M=
+    NzEwMzM3YTIwODY1YjQ1MGZjY2Y1OTYyZmQ2MWNkOTI4Njg1MDk4YWI2NDQz
+    YjVjNmUzNjVlNTg1Y2M1MDZkMDk0YTRmNWY3MmU5ZjAwZGM3NDc5MDZjODlj
+    ZjNiNDUxN2ViYTYwNTA2NjhmZDI3ZjAwODFkMzBmODZkZGQ4OGY=

data/VERSION

@@ -1 +1 @@
-1.4.14
+1.4.15

data/lib/spark_api.rb

@@ -13,6 +13,7 @@ require 'spark_api/request'
 require 'spark_api/connection'
 require 'spark_api/client'
 require 'spark_api/faraday_middleware'
+require 'spark_api/reso_faraday_middleware'
 require 'spark_api/primary_array'
 require 'spark_api/options_hash'
 require 'spark_api/models'

data/lib/spark_api/authentication/api_auth.rb

@@ -19,7 +19,7 @@ module SparkApi
         sig = sign("#{@client.api_secret}ApiKey#{@client.api_key}")
         SparkApi.logger.debug { "Authenticating to #{@client.endpoint}" }
         start_time = Time.now
-        request_path = "/#{@client.version}/session?ApiKey=#{@client.api_key}&ApiSig=#{sig}"
+        request_path = "#{SparkApi::Configuration::DEFAULT_SESSION_PATH}?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}" }

data/lib/spark_api/cli.rb

@@ -31,6 +31,7 @@ module SparkApi
         :api_user => "API_USER",
         # OTHER
         :debug=> "DEBUG",
+        :middleware => "SPARK_MIDDLEWARE",
         :console => "SPARK_API_CONSOLE"  # not a public option, meant to distinguish bin/spark_api and script/console
       }
       
@@ -69,7 +70,8 @@ module SparkApi
           :api_secret => ENV[OPTIONS_ENV[:api_secret]],
           :api_user => ENV[OPTIONS_ENV[:api_user]],
           :ssl_verify => ENV.fetch(OPTIONS_ENV[:ssl_verify], true),
-          :console => ENV[OPTIONS_ENV[:console]]
+          :console => ENV[OPTIONS_ENV[:console]],
+          :middleware => ENV[OPTIONS_ENV[:middleware]]
         }
         cli_options = {}
         file_options = {}
@@ -128,7 +130,10 @@ module SparkApi
           opts.on("--api_user API_USER",
                   "ID of the Spark user to run the client as.",
                   "Default: ENV['#{OPTIONS_ENV[:api_user]}']") { |arg| cli_options[:api_user] = arg }
-          
+          opts.on("--middleware SPARK_MIDDLEWARE",
+                  "spark_api for accessing spark, reso_api for accessing reso adapter",
+                  "Default: spark_api") { |arg| cli_options[:middleware] = arg }
+
           # General           
           opts.on("-f", "--file FILE",
                   "Load configuration for yaml file.") { |arg| file_options = parse_file_options(arg) }

data/lib/spark_api/cli/api_auth.rb

@@ -6,4 +6,5 @@ SparkApi.configure do |config|
   config.api_user = ENV["API_USER"] if ENV["API_USER"]
   config.endpoint = ENV["API_ENDPOINT"] if ENV["API_ENDPOINT"]
   config.ssl_verify = ENV["SSL_VERIFY"].downcase != 'false' if ENV["SSL_VERIFY"]
+  config.middleware = ENV["SPARK_MIDDLEWARE"]  if ENV["SPARK_MIDDLEWARE"]
 end

data/lib/spark_api/cli/oauth2.rb

@@ -19,6 +19,7 @@ SparkApi.configure do |config|
   config.authentication_mode = SparkApi::Authentication::OAuth2
   config.endpoint = ENV["API_ENDPOINT"] if ENV["API_ENDPOINT"]
   config.ssl_verify = ENV["SSL_VERIFY"].downcase != 'false' if ENV["SSL_VERIFY"]
+  config.middleware = ENV["SPARK_MIDDLEWARE"]  if ENV["SPARK_MIDDLEWARE"]
 end
 
 # Enables saving and loading serialized oauth2 sessions for the system user. 

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].freeze
+      :auth_endpoint, :callback, :compress, :timeout, :middleware].freeze
     OAUTH2_KEYS = [:authorization_uri, :access_uri, :client_id, :client_secret,
       # Requirements for authorization_code grant type
       :redirect_uri,  
@@ -36,12 +36,14 @@ module SparkApi
     DEFAULT_AUTHORIZATION_URI = 'https://sparkplatform.com/oauth2'
     DEFAULT_VERSION = 'v1'
     DEFAULT_ACCESS_URI = "#{DEFAULT_ENDPOINT}/#{DEFAULT_VERSION}/oauth2/grant"
+    DEFAULT_SESSION_PATH = "/#{DEFAULT_VERSION}/session"
     DEFAULT_USER_AGENT = "Spark API Ruby Gem #{VERSION}"
     DEFAULT_SSL = true
     DEFAULT_SSL_VERIFY = true
     DEFAULT_OAUTH2 = nil
     DEFAULT_COMPRESS = false
     DEFAULT_TIMEOUT = 5 # seconds
+    DEFAULT_MIDDLEWARE = 'spark_api'
     
     X_SPARK_API_USER_AGENT = "X-SparkApi-User-Agent"
 
@@ -75,6 +77,7 @@ module SparkApi
       self.version     = DEFAULT_VERSION
       self.compress    = DEFAULT_COMPRESS
       self.timeout     = DEFAULT_TIMEOUT
+      self.middleware = DEFAULT_MIDDLEWARE
       self
     end
   end

data/lib/spark_api/connection.rb

@@ -23,7 +23,7 @@ module SparkApi
       end
 
       conn = Faraday.new(opts) do |conn|
-        conn.response :spark_api
+        conn.response self.middleware.to_sym
         conn.options[:timeout] = self.timeout
         conn.adapter Faraday.default_adapter
       end
@@ -33,6 +33,14 @@ module SparkApi
     
     # HTTP request headers for client requests
     def headers
+      if self.middleware.to_sym == :reso_api
+        reso_headers
+      else
+        spark_headers
+      end
+    end
+
+    def spark_headers
       {
         :accept => 'application/json',
         :content_type => 'application/json',
@@ -40,6 +48,14 @@ module SparkApi
         Configuration::X_SPARK_API_USER_AGENT => user_agent
       }
     end
+
+    def reso_headers
+      {
+        :accept => 'application/json, application/xml',
+        :user_agent => Configuration::DEFAULT_USER_AGENT,
+        Configuration::X_SPARK_API_USER_AGENT => user_agent
+      }
+    end
     
   end
 end

data/lib/spark_api/faraday_middleware.rb

@@ -86,6 +86,8 @@ module SparkApi
     end
     
   end
+
   Faraday::Response.register_middleware :spark_api => FaradayMiddleware
 
 end
+

data/lib/spark_api/request.rb

@@ -65,7 +65,11 @@ module SparkApi
       begin
         request_opts = {}
         request_opts.merge!(options)
-        request_path = "/#{version}#{path}"
+        request_path = if middleware && middleware.to_sym == :reso_api
+                         "/Reso/OData#{path}"
+                       else
+                         "/#{version}#{path}"
+                       end
         start_time = Time.now
         if [:get, :delete, :head].include?(method.to_sym)
           response = authenticator.request(method, request_path, nil, request_opts)

data/lib/spark_api/reso_faraday_middleware.rb

@@ -0,0 +1,30 @@
+
+module SparkApi
+
+  class ResoFaradayMiddleware < FaradayMiddleware
+
+    def on_complete(env)
+
+      body = decompress_body(env)
+
+      begin
+        body = MultiJson.decode(body)
+
+        if body["D"]
+          super(env)
+          return
+        end
+
+        env[:body] = body
+      rescue MultiJson::ParseError => e
+        # We will allow the client to choose their XML parser, but should do
+        # some minor format verification
+        raise e if body.strip[/\A<\?xml/].nil?
+      end
+
+    end
+
+  end
+
+  Faraday::Response.register_middleware :reso_api => ResoFaradayMiddleware
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spark_api
 version: !ruby/object:Gem::Version
-  version: 1.4.14
+  version: 1.4.15
 platform: ruby
 authors:
 - Brandon Hornseth
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -369,6 +369,7 @@ files:
 - lib/spark_api/paginate.rb
 - lib/spark_api/primary_array.rb
 - lib/spark_api/request.rb
+- lib/spark_api/reso_faraday_middleware.rb
 - lib/spark_api/response.rb
 - lib/spark_api/version.rb
 - script/bootstrap