Merge pull request #136 from sparkapi/RUBYAPI-40

Rubyapi 40

Author: codygustafson

lib/spark_api.rb

@@ -13,6 +13,7 @@
 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'

lib/spark_api/authentication/api_auth.rb

@@ -19,7 +19,7 @@ def authenticate
         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}" }

lib/spark_api/cli.rb

@@ -31,6 +31,7 @@ class ConsoleCLI
         :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 @@ def self.setup_options(stdout,arguments)
           :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 @@ def self.setup_options(stdout,arguments)
           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) }

lib/spark_api/cli/api_auth.rb

@@ -6,4 +6,5 @@
   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

lib/spark_api/cli/oauth2.rb

@@ -19,6 +19,7 @@
   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. 

lib/spark_api/configuration.rb

@@ -11,7 +11,7 @@ module Configuration
     # 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 Configuration
     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 @@ def reset_configuration
       self.version     = DEFAULT_VERSION
       self.compress    = DEFAULT_COMPRESS
       self.timeout     = DEFAULT_TIMEOUT
+      self.middleware = DEFAULT_MIDDLEWARE
       self
     end
   end

lib/spark_api/connection.rb

@@ -23,7 +23,7 @@ def connection(force_ssl = false)
       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,13 +33,29 @@ def connection(force_ssl = false)
 
     # 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',
         :user_agent => Configuration::DEFAULT_USER_AGENT,
         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

lib/spark_api/faraday_middleware.rb

@@ -86,6 +86,8 @@ def decompress_body(env)
     end
 
   end
+
   Faraday::Response.register_middleware :spark_api => FaradayMiddleware
 
 end
+

lib/spark_api/request.rb

@@ -65,7 +65,11 @@ def request(method, path, body, options)
       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)

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