oneaccess 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82306ca46cc7a7e935b6529372830fb81a21604c
-  data.tar.gz: 4986da59b1bd7c098d24b397c445d254ec318c58
+  metadata.gz: 839afdde8249236a6efc2785eea68230f972507b
+  data.tar.gz: c178bab91d1fa090d03220d14c0370a26191e72f
 SHA512:
-  metadata.gz: 56c4dc41834ef5daeb61fa09d3b44a03609a7d9266556819cede79addf5f48b59eedfb12f23a70e8c149957734a911ea44c984dcf0f9de478d50f2e3f998045f
-  data.tar.gz: fdfa80e8f2a1670b801bcb7f3bb979f799c523eb839c2fe5e6075e895f7bbae0e33863aa5de895068b3f66250f714afb90890e5133192768762608d6fa320191
+  metadata.gz: 740bfae1d5e4545efba40f1a9406ac0451de90bb272ed2dc3c3d3bd2ff9581d744b5126503f953fcc445fddf4d4a4fcf051c87c2e3469ee9df0aa79d1ebc909b
+  data.tar.gz: 23a0a0f6e43fa55e59ce5dc30b4ef81b389a3070ae28a3b98c020710a7a7013f3656f15dbe9288cde3e1ca3d238ae83912852c2cfe07ab115bc27bbc9d4c985c

data/Gemfile.lock

@@ -2,9 +2,9 @@ PATH
   remote: .
   specs:
     oneaccess (0.0.0)
+      faraday (~> 0.13)
       multi_json (~> 1.12.0)
       representable (~> 3.0.4)
-      rest-client (~> 2.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,18 +20,13 @@ GEM
     declarative-option (0.1.0)
     diff-lcs (1.3)
     docile (1.1.5)
-    domain_name (0.5.20170404)
-      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.15.0)
+      multipart-post (>= 1.2, < 3)
     hashdiff (0.3.5)
     hirb (0.7.3)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
     json (2.1.0)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    multi_json (1.12.1)
-    netrc (0.11.0)
+    multi_json (1.12.2)
+    multipart-post (2.0.0)
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
@@ -43,10 +38,6 @@ GEM
       declarative (< 0.1.0)
       declarative-option (< 0.2.0)
       uber (< 0.2.0)
-    rest-client (2.0.2)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -79,9 +70,6 @@ GEM
       simplecov
     simplecov-html (0.10.2)
     uber (0.1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.4)
     unicode-display_width (1.3.2)
     webmock (3.0.1)
       addressable (>= 2.3.6)

data/lib/oneaccess/api/api_base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "rest-client"
+require "faraday"
 require "json"
 require_relative "../response/api_error"
 require_relative "../error/api_error"
@@ -14,7 +14,7 @@ module ONEAccess
         end
 
         def send_post(method, body)
-          Http::HttpClient.post(api_url(method), body, content_type: :json)
+          Http::HttpClient.post(api_url(method), body, "Content-Type" => "application/json")
         end
 
         def resource_api_path

data/lib/oneaccess/api/v3_0/providers.rb

@@ -19,12 +19,12 @@ module ONEAccess
               receivedate:     receive_date
             }.reject { |_, v| v.nil? }
 
-            resp = send_post("inducements", inducement: params)
-
-            Response::InducementResponse.from_json(resp.body)
+            response = send_post("inducements", inducement: params)
+            Response::InducementResponse.from_json(response.body)
           end
 
-          def users_details( # rubocop:disable Metrics/MethodLength
+          # rubocop:disable Metrics/MethodLength
+          def users_details(
             buy_side_org_id:,
             provider_id:,
             contract_status_id: nil,
@@ -35,8 +35,6 @@ module ONEAccess
             reverse_entitlement_status: nil
           )
 
-            provider_id = comma_separated_values(provider_id)
-
             params = {
               buysideorgid:                 buy_side_org_id,
               contractstatusid:             contract_status_id,
@@ -45,12 +43,12 @@ module ONEAccess
               userreverseentitlementstatus: user_reverse_entitlement_status,
               vendorid:                     vendor_id,
               reverseentitlementstatus:     reverse_entitlement_status
-            }.reject { |_, value| value.nil? }
-
-            resp = send_get("GetProviderUserDetails?providerid=#{provider_id}", params)
+            }.compact!
 
+            resp = send_get("GetProviderUserDetails?providerid=#{comma_separated_values(provider_id)}", params)
             Response::ProvidersUsersDetailsResponse.from_json(resp.body)
           end
+          # rubocop:enable Metrics/MethodLength
 
           private
 

data/lib/oneaccess/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "logger"
+
 module ONEAccess
   class Configuration
     DEFAULT_BASE_URL       = "http://ws.oneaccess.io"
@@ -10,6 +12,7 @@ module ONEAccess
       attr_accessor :base_url
       attr_accessor :api_key
       attr_accessor :master_api_key
+      attr_writer :logger
 
       def base_v1_1_url
         "#{base_url}#{DEFAULT_BASE_V1_1_PATH}"
@@ -24,6 +27,10 @@ module ONEAccess
         self.api_key        = nil
         self.master_api_key = nil
       end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
     end
 
     reset!

data/lib/oneaccess/http/http_client.rb

@@ -4,24 +4,85 @@ module ONEAccess
   module Http
     class HttpClient
       class << self
-        def get(url, params = {})
-          RestClient.get(url, { params: params }.merge(auth_headers))
-        rescue RestClient::Exception => e
+        DEFAULT_TIMEOUT = 10
+
+        def get(url, params = {}, headers = {})
+          response = connection.get do |request|
+            request.url url
+            request.params.merge!(params)
+            request.headers.merge!(headers)
+          end
+          handle_response(response)
+        rescue Faraday::TimeoutError => e
+          raise create_timeout_error(e, url)
+        rescue Faraday::Error => e
           raise create_api_error(e)
         end
 
         def post(url, body, headers = {})
-          RestClient.post(url, body.to_json, headers.merge(auth_headers))
-        rescue RestClient::Exception => e
+          response = connection.post do |request|
+            request.url url
+            request.headers.merge!(headers)
+            request.body = body.to_json
+          end
+          handle_response(response)
+        rescue Faraday::TimeoutError => e
+          raise create_timeout_error(e, url)
+        rescue Faraday::Error => e
           raise create_api_error(e)
         end
 
         private
 
+        def handle_response(response)
+          # make sure we have a valid JSON in the response
+          if response.headers["Content-Type"] == "application/json"
+            begin
+              MultiJson.load(response.body)
+            rescue MultiJson::ParseError
+              raise Error::APIError.new(500, response.code, "Invalid JSON Response:'#{message.body}'")
+            end
+          end
+          response
+        end
+
+        def connection
+          Faraday.new(url:     Configuration.base_url,
+                      headers: auth_headers,
+                      request: { timeout: DEFAULT_TIMEOUT }) do |faraday|
+            faraday.response :raise_error
+            faraday.response :logger, Configuration.logger, bodies: true do |logger|
+              logger.filter(/(Api-Key)([\s:"]*)(.+)(\"{1})/, "[REMOVED]")
+            end
+            faraday.adapter(detect_adapter)
+          end
+        end
+
+        def create_timeout_error(_error, url)
+          Error::APIError.new(408, 408, "Timeout #{DEFAULT_TIMEOUT} at #{url}")
+        end
+
         def create_api_error(error)
+          status = error.response[:status]
+          body = error.response[:body]
+          headers = error.response[:headers]
+          if headers["Content-Type"] == "application/json"
+            handle_json_error(body, status)
+          else
+            Error::APIError.new(status, status, "API Response body:'#{body}'")
+          end
+        end
+
+        def handle_json_error(body, status)
           api_error_data = Response::APIError.new
-          Response::Representer::APIError.new(api_error_data).from_json(error.http_body)
-          Error::APIError.new(error.http_code, api_error_data.api_status_code, api_error_data.api_status_message)
+          Response::Representer::APIError.new(api_error_data).from_json(body)
+          Error::APIError.new(
+            status,
+            api_error_data.api_status_code,
+            api_error_data.api_status_message
+          )
+        rescue MultiJson::ParseError
+          Error::APIError.new(500, 500, "Invalid JSON:'#{body}'")
         end
 
         def auth_headers
@@ -30,6 +91,24 @@ module ONEAccess
             "Authorization"        => "X-One-Access-Master-Api-Key #{Configuration.master_api_key}"
           }
         end
+
+        # Auto-detect the best adapter (HTTP "driver") available, based on libraries
+        # loaded by the user, preferring those with persistent connections ("keep-alive") by default
+        # rubocop:disable Metrics/MethodLength
+        def detect_adapter
+          if defined?(::Patron)
+            :patron
+          elsif defined?(::Typhoeus)
+            :typhoeus
+          elsif defined?(::HTTPClient)
+            :httpclient
+          elsif defined?(::Net::HTTP::Persistent)
+            :net_http_persistent
+          else
+            ::Faraday.default_adapter
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/oneaccess.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = "oneaccess"
-  s.version       = "1.0.0"
-  s.date          = "2018-04-23"
+  s.version       = "1.0.1"
+  s.date          = "2018-05-07"
   s.summary       = "ONEAccess API wrapper"
   s.description   = "Easily communicate with ONEAccess API"
   s.homepage      = "https://github.com/AlphaExchange/oneaccess-rb"
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "simplecov-console"
   s.add_development_dependency "webmock", "~> 3.0.1"
 
+  s.add_runtime_dependency "faraday", "~> 0.13"
   s.add_runtime_dependency "multi_json", "~> 1.12.0"
   s.add_runtime_dependency "representable", "~> 3.0.4"
-  s.add_runtime_dependency "rest-client", "~> 2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneaccess
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Alex Correia Santos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,47 +123,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.1
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: representable
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 1.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: representable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.4
 description: Easily communicate with ONEAccess API
 email:
 - alex@alpha-exchange.com