my_target_api 2.0.2 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4254318b97e9d1f594438694a31a6511ea9461fc
-  data.tar.gz: 69e005cf224551553abdc2c047d84b278a3f3e70
+  metadata.gz: f8a2de4571899340aa8c1e6e6c099c0a6b75e7e6
+  data.tar.gz: f1453fac44237e86a82ff18f54d9bc1a1ca4f706
 SHA512:
-  metadata.gz: '08db4857b6fb49cacdc2050356b43aa94b3998fb2a8f0d31fc133e12554b07d190e0a370363b9b8bc5dfa88a53717c91b449b0ba5de5d1254dab65bfd3e93c38'
-  data.tar.gz: '08966200b98a7df2bfc4fee600650072ee52343e5ff3f83b987a450cd915901ee88b2273aea35e67b6a40f66e50020a75ee68ac35e66b713f14207d5aa12fe3b'
+  metadata.gz: 43618ed32e7313aa0c300391d619e448ed56102429766559f91ed0a4056587b35147fc773d4a293854a521c9f61d2fd9a0b9fbef7f41affff3b3e8b0075aa398
+  data.tar.gz: 9be00939ad2371270df68d053ac5d586a2dab12a09f4e1043e6c24377a4c1562bed461e1daabdfa4b4f3802e12a12f0fa0a4bc9439ff002d19c391585844bb56

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    my_target_api (2.0.1)
+    my_target_api (2.0.7)
       json (~> 2.0, >= 2.0.0)
       rest-client (~> 2.0, >= 2.0.0)
 
@@ -75,7 +75,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.1.4)
+  bundler (~> 2.1, >= 2.1.4)
   my_target_api!
   rake (~> 12.3.0, >= 12.3.0)
   rspec (~> 3.7.0, >= 3.7.0)

data/README.md

@@ -7,7 +7,7 @@
 Add this line to your application's Gemfile:
 
 ```
-gem 'my_target_api', '~> 2.0.1'
+gem 'my_target_api', '~> 2.0.5'
 ```
 
 Or install from command line:
@@ -99,7 +99,7 @@ def read_active_campaigns
 
 rescue MyTargetApi::RequestError => e
 
-  puts e.message, e.params, e.response, e.backtrace
+  puts e.message, e.method, e.url, e.params, e.response, e.backtrace
   # You can access the original exception
   puts e.original_exception&.message, e.original_exception&.backtrace
 

data/lib/my_target_api.rb

@@ -10,6 +10,8 @@ class MyTargetApi
   autoload :RequestError, 'my_target_api/request_error'
   autoload :NetClient, 'my_target_api/net_client'
   autoload :LogRequestParametersDecorator, 'my_target_api/log_request_parameters_decorator'
+  autoload :AddAccessTokenToRequestDecorator, 'my_target_api/add_access_token_to_request_decorator'
+  autoload :PreparePostParamsDecorator, 'my_target_api/prepare_post_params_decorator'
 
   def initialize(access_token, options = {})
     @access_token = access_token
@@ -24,19 +26,19 @@ class MyTargetApi
   end
 
   def get_request(url, params)
-    request_object.get(url, params)
+    request_object.get(url, params, headers)
   end
 
   def post_request(url, params)
-    request_object.post(url, params)
+    request_object.post(url, params, headers)
   end
 
   def delete_request(url, params)
-    request_object.delete(url, params)
+    request_object.delete(url, params, headers)
   end
 
   def upload_request(url, content, params)
-    request_object.upload(url, content, params)
+    request_object.upload(url, content, params, headers)
   end
 
   private
@@ -45,13 +47,16 @@ class MyTargetApi
 
   def request_object
     @_request_object ||= begin
-      options = {
-        logger: self.options[:logger],
-        access_token: access_token,
-        headers: self.options[:headers]
-      }
-      LogRequestParametersDecorator.new(Request.new(options), options)
+      logger = options[:logger]
+      request = Request.new(logger: logger)
+      request = LogRequestParametersDecorator.new(request, { logger: logger }.compact)
+      request = AddAccessTokenToRequestDecorator.new(request, { access_token: access_token })
+      PreparePostParamsDecorator.new(request)
     end
   end
 
+  def headers
+    options[:headers] || {}
+  end
+
 end

data/lib/my_target_api/add_access_token_to_request_decorator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class MyTargetApi
+  # Add Authorization header
+  class AddAccessTokenToRequestDecorator
+
+    CONTENT_OUTPUT_LIMIT = 1000
+
+    def initialize(origin, access_token: nil)
+      @origin = origin
+      @access_token = access_token
+    end
+
+    def get(url, params = {}, headers = {})
+      origin.get(url, params, add_authorization_header(headers))
+    end
+
+    def post(url, params = {}, headers = {})
+      origin.post(url, params, add_authorization_header(headers))
+    end
+
+    def delete(url, params = {}, headers = {})
+      origin.delete(url, params, add_authorization_header(headers))
+    end
+
+    def upload(url, content, params = {}, headers = {})
+      origin.upload(url, content, params, add_authorization_header(headers))
+    end
+
+    private
+
+    attr_reader :origin, :access_token
+
+    def add_authorization_header(headers)
+      if access_token
+        { 'Authorization' => "Bearer #{access_token}" }.merge(headers)
+      else
+        headers
+      end
+    end
+
+  end
+end

data/lib/my_target_api/log_request_parameters_decorator.rb

@@ -1,54 +1,95 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative './response_formatter'
-require_relative './net_client'
+require_relative './nil_logger'
 
 class MyTargetApi
   # Requests
   class LogRequestParametersDecorator
 
-    def initialize(origin, options = {})
+    CONTENT_OUTPUT_LIMIT = 1000
+
+    def initialize(origin, logger: NilLogger)
       @origin = origin
-      @options = options
+      @logger = logger
     end
 
-    def get(url, params = {})
-      log_hash(method: 'Request#get', url: url, params: params)
+    def get(url, params = {}, headers = {})
+      log_request(method: 'GET', url: url, params: params, headers: headers)
 
-      origin.get(url, params)
+      origin.get(url, params, headers)
     end
 
-    def post(url, params = {})
-      log_hash(method: 'Request#post', url: url, params: params)
+    def post(url, params = {}, headers = {})
+      log_request(method: 'POST', url: url, params: params, headers: headers)
 
-      origin.post(url, params)
+      origin.post(url, params, headers)
     end
 
-    def delete(url, params = {})
-      log_hash(method: 'Request#delete', url: url, params: params)
+    def delete(url, params = {}, headers = {})
+      log_request(method: 'DELETE', url: url, params: params, headers: headers)
 
-      origin.delete(url, params)
+      origin.delete(url, params, headers)
     end
 
-    def upload(url, content, params = {})
-      log_hash(method: 'Request#upload', url: url, params: params, content: 'no logging')
+    def upload(url, content, params = {}, headers = {})
+      log_request(method: 'POST', url: url, params: params, headers: headers, content: content)
 
-      origin.upload(url, content, params)
+      origin.upload(url, content, params, headers)
     end
 
     private
 
-    attr_reader :origin, :options
+    attr_reader :origin, :logger
+
+    def log_request(method:, url:, params:, headers:, content: nil)
+      logger <<
+        "#{inspect_request(method: method, url: url, params: params, headers: headers)}"\
+        "#{inspect_content(content)}"
+    end
+
+    def inspect_request(method:, url:, params:, headers:)
+      <<~LOG
+        #{method} #{url}
+        #{inspect_headers(headers)}
+        #{inspect_params(params)}
+      LOG
+    end
+
+    def inspect_content(content)
+      return '' unless content
+
+      result = "Body content:\n"
+      result +=
+        if content.size > CONTENT_OUTPUT_LIMIT
+          <<~LOG
+            << first #{CONTENT_OUTPUT_LIMIT} symbols >>
+            #{content[0...CONTENT_OUTPUT_LIMIT]}
+          LOG
+        else
+          content
+        end
+      result
+    end
+
+    def inspect_headers(params)
+      if params.empty?
+        'Headers: No headers'
+      else
+        "Headers:\n#{params.map { |name, value| "#{name}: #{value}" }.join("\n")}"
+      end
+    end
 
-    def log_hash(hash)
-      log(hash.map do |key, value|
-        "#{key}: #{value.is_a?(String) ? value : value.inspect}"
-      end.join("\n"))
+    def inspect_params(params)
+      if params.empty?
+        'Params: No params'
+      else
+        "Params:\n#{params.map { |name, value| "#{name}: #{inspect_param(value)}" }.join("\n")}"
+      end
     end
 
-    def log(message)
-      options[:logger] << message if options[:logger]
+    def inspect_param(value)
+      value.is_a?(String) ? value : value.inspect
     end
 
   end

data/lib/my_target_api/net_client.rb

@@ -37,19 +37,19 @@ class MyTargetApi
 
       def get(*args)
         RestClient.get(*args) { |response, &block| process_response(response, &block) }
-      rescue StandardError => e
+      rescue RestClient::Exception => e
         raise(Exception.new(e, e.message).tap { e.set_backtrace(caller) })
       end
 
       def post(*args)
         RestClient.post(*args) { |response, &block| process_response(response, &block) }
-      rescue StandardError => e
+      rescue RestClient::Exception => e
         raise(Exception.new(e, e.message).tap { e.set_backtrace(caller) })
       end
 
       def delete(*args)
         RestClient.delete(*args) { |response, &block| process_response(response, &block) }
-      rescue StandardError => e
+      rescue RestClient::Exception => e
         raise(Exception.new(e, e.message).tap { e.set_backtrace(caller) })
       end
 
@@ -64,7 +64,7 @@ class MyTargetApi
             response.return!(&block)
           end
         Response.new(result.body, result.code, format_headers(result.headers))
-      rescue StandardError => e
+      rescue RestClient::Exception => e
         raise(Exception.new(e, e.message).tap { e.set_backtrace(caller) })
       end
 

data/lib/my_target_api/nil_logger.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class MyTargetApi
+  # NULL object
+  class NilLogger
+
+    def self.<<(_message); end
+
+  end
+end

data/lib/my_target_api/prepare_post_params_decorator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'json'
+
+class MyTargetApi
+  # Prepare post params
+  class PreparePostParamsDecorator
+
+    def initialize(origin)
+      @origin = origin
+    end
+
+    def get(url, params = {}, headers = {})
+      origin.get(url, params, headers)
+    end
+
+    def post(url, params = {}, headers = {})
+      prepared = body_parameters(params)
+
+      if prepared.is_a?(String)
+        origin.upload(url, prepared, {}, { 'Content-Type' => 'application/json' }.merge(headers))
+      else
+        origin.post(url, prepared, headers)
+      end
+    end
+
+    def delete(url, params = {}, headers = {})
+      origin.delete(url, params, headers)
+    end
+
+    def upload(url, content, params = {}, headers = {})
+      origin.upload(url, content, params, headers)
+    end
+
+    private
+
+    attr_reader :origin
+
+    def body_parameters(params)
+      result_params = params.dup
+
+      if result_params.values.any? { |param| param.is_a? IO } || result_params[:grant_type]
+        individual_body_parameters(result_params)
+      else
+        result_params.to_json
+      end
+    end
+
+    def individual_body_parameters(params)
+      params.transform_values do |value|
+        value.is_a?(Array) || value.is_a?(Hash) ? value.to_json : value
+      end
+    end
+
+  end
+end

data/lib/my_target_api/request.rb

@@ -3,45 +3,48 @@
 require 'json'
 require_relative './response_formatter'
 require_relative './net_client'
+require_relative './nil_logger'
 
 class MyTargetApi
   # Requests
   class Request
 
-    def initialize(options = {})
-      @options = options
+    def initialize(logger: NilLogger)
+      @logger = logger
     end
 
-    def get(url, params = {})
-      response = with_exception_handling(params) do
+    def get(url, params = {}, headers = {})
+      response = with_exception_handling('GET', url, params) do
         NetClient.get(url, headers.merge(query(params)))
       end
 
       process_response(response)
     end
 
-    def post(url, params = {})
-      response = with_exception_handling(params) do
-        NetClient.post(url, body_parameters(params), headers)
+    def post(url, params = {}, headers = {})
+      response = with_exception_handling('POST', url, params) do
+        NetClient.post(url, params, headers)
       end
 
       process_response(response)
     end
 
-    def delete(url, params = {})
-      response = with_exception_handling(params) do
+    def delete(url, params = {}, headers = {})
+      response = with_exception_handling('DELETE', url, params) do
         NetClient.delete(url, headers.merge(query(params)))
       end
 
       process_response(response)
     end
 
-    def upload(url, content, params = {})
-      response = with_exception_handling(params) do
+    def upload(url, content, params = {}, headers = {})
+      response = with_exception_handling('POST', 'url', params) do
         NetClient.post(
           url,
           content,
-          headers.merge(query(params)).merge('Content-Type' => 'application/octet-stream')
+          { 'Content-Type' => 'application/octet-stream' }
+            .merge(headers)
+            .merge(query(params))
         )
       end
 
@@ -50,82 +53,43 @@ class MyTargetApi
 
     private
 
-    attr_reader :options
-
-    def body_parameters(params)
-      result_params = params.dup
-
-      if result_params.values.any? { |param| param.is_a? IO } || result_params[:grant_type]
-        individual_body_parameters(result_params)
-      else
-        result_params.to_json
-      end
-    end
-
-    def individual_body_parameters(params)
-      params.transform_values do |value|
-        value.is_a?(Array) || value.is_a?(Hash) ? value.to_json : value
-      end
-    end
+    attr_reader :logger
 
     def query(params)
       { params: params }
     end
 
-    def headers
-      if access_token
-        optional_headers.merge('Authorization' => "Bearer #{access_token}")
-      else
-        optional_headers
-      end
-    end
-
     def process_response(response)
       JSON.parse(response.body)
     rescue JSON::ParserError
       response.body
     end
 
-    def with_exception_handling(params)
+    def with_exception_handling(method, url, params)
       response = yield
       log_response(response)
-      raise_with_params(params: params, response: response) if response.code >= 400
+      if response.code >= 400
+        raise_with_params(method: method, url: url, params: params, response: response)
+      end
       response
     rescue NetClient::Exception => e
       original_exception = e.original_exception
-      log("#{original_exception.class.name} #{original_exception.message}")
-      raise_with_params(params: params, original_exception: original_exception)
+      logger << "#{original_exception.class.name} #{original_exception.message}"
+      raise_with_params(method: method, url: url, params: params,
+                        original_exception: original_exception)
     end
 
     def log_response(response)
-      log(ResponseFormatter.new(response).format)
-    end
-
-    def headers_to_string(headers)
-      headers.map do |name, value|
-        "#{name}: #{value}"
-      end.join("\n")
+      logger << ResponseFormatter.new(response).format
     end
 
-    def raise_with_params(params:, response: nil, original_exception: nil)
-      result = MyTargetApi::RequestError.new(params: params,
-                                             response: response,
+    def raise_with_params(method:, url:, params:, response: nil, original_exception: nil)
+      result = MyTargetApi::RequestError.new(method: method, url: url,
+                                             params: params, response: response,
                                              original_exception: original_exception)
       result.set_backtrace(caller)
       raise result
     end
 
-    def log(message)
-      options[:logger] << message if options[:logger]
-    end
-
-    def access_token
-      options[:access_token]
-    end
-
-    def optional_headers
-      options[:headers] || {}
-    end
-
   end
 end

data/lib/my_target_api/request_error.rb

@@ -4,18 +4,16 @@ class MyTargetApi
   # Error for request
   class RequestError < StandardError
 
-    attr_reader :params, :original_exception, :response
+    attr_reader :method, :url, :params, :original_exception, :response
 
-    def initialize(params:, original_exception: nil, response: nil)
+    def initialize(method:, url:, params:, original_exception: nil, response: nil)
+      @method = method
+      @url = url
       @params = params
       @response = response
       @original_exception = original_exception
 
-      message =
-        "#{(response ? "#{response.code}: #{response.body}. " : '')}"\
-        'Inspect #params, #response and #original_exception for more details'
-
-      super(message)
+      super(response ? "#{response.code}: #{response.body}" : 'No response')
     end
 
   end

data/lib/my_target_api/version.rb

@@ -2,6 +2,6 @@
 
 class MyTargetApi
 
-  VERSION = '2.0.2'
+  VERSION = '2.0.7'
 
 end

data/my_target_api.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json', '~> 2.0', '>= 2.0.0'
   spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.4'
   spec.add_development_dependency 'rake', '~> 12.3.0', '>= 12.3.0'
   spec.add_development_dependency 'rspec', '~> 3.7.0', '>= 3.7.0'
   spec.add_development_dependency 'rubocop', '~> 0.89.1'

data/spec/net_client_spec.rb

@@ -47,6 +47,13 @@ describe MyTargetApi::NetClient do
       ).body).to eq('{}')
     end
 
+    it "doesn't catch not RestClient exceptions" do
+      test_exception = Class.new(StandardError)
+      allow(RestClient).to receive(:get).and_raise(test_exception)
+
+      expect { MyTargetApi::NetClient.get('https://api.com') }.to raise_error(test_exception)
+    end
+
     it ':content_type' do
       stub_request(:get, 'https://api.com')
         .with(headers: { 'Content-Type' => 'application/octet-stream' })

data/spec/request_spec.rb

@@ -21,7 +21,7 @@ describe MyTargetApi::Request do
       result = subject.post('https://target.my.com/api/v1/campaigns.json')
 
       expect(MyTargetApi::NetClient).to(
-        have_received(:post).with('https://target.my.com/api/v1/campaigns.json', '{}', {})
+        have_received(:post).with('https://target.my.com/api/v1/campaigns.json', {}, {})
       )
 
       expect(result).to eq('name' => 'Campaign 1')
@@ -84,9 +84,7 @@ describe MyTargetApi::Request do
         .to_return(body: 'Unknown resource', status: 404)
 
       expect { subject.get('https://target.my.com/api/v1/wrong_path.json') }
-        .to raise_error(MyTargetApi::RequestError,
-                        '404: Unknown resource. Inspect #params, #response and #original_exception'\
-                        ' for more details')
+        .to raise_error(MyTargetApi::RequestError, '404: Unknown resource')
     end
 
     it 'sets authorization header' do
@@ -96,7 +94,10 @@ describe MyTargetApi::Request do
                                         headers: {}))
       )
 
-      request = MyTargetApi::Request.new(access_token: 'my_target_token')
+      request = MyTargetApi::AddAccessTokenToRequestDecorator.new(
+        MyTargetApi::Request.new,
+        access_token: 'my_target_token'
+      )
       request.get('https://target.my.com/api/v1/some_path.json')
 
       expect(MyTargetApi::NetClient).to(
@@ -117,7 +118,7 @@ describe MyTargetApi::Request do
       logger = double('Logger double', '<<': nil)
       options = { logger: logger }
       request = MyTargetApi::LogRequestParametersDecorator.new(
-        MyTargetApi::Request.new(options), options
+        MyTargetApi::Request.new(options), logger: logger
       )
       allow(MyTargetApi::NetClient).to(
         receive(:get).and_return(double(code: 200,
@@ -127,9 +128,14 @@ describe MyTargetApi::Request do
 
       request.get('https://target.my.com/api/v1/request.json')
 
-      expect(logger).to(have_received(:<<).with("method: Request#get\n"\
-        "url: https://target.my.com/api/v1/request.json\n"\
-        'params: {}'))
+      expect(logger).to(
+        have_received(:<<)
+          .with(<<~LOG)
+            GET https://target.my.com/api/v1/request.json
+            Headers: No headers
+            Params: No params
+          LOG
+      )
       expect(logger).to(have_received(:<<).with(<<~LOG))
         HTTP Code: 200
         HTTP Body:
@@ -142,7 +148,7 @@ describe MyTargetApi::Request do
       logger = double('Logger double', '<<': nil)
       options = { logger: logger }
       request = MyTargetApi::LogRequestParametersDecorator.new(
-        MyTargetApi::Request.new(options), options
+        MyTargetApi::Request.new(options), logger: logger
       )
       allow(MyTargetApi::NetClient).to(
         receive(:get).and_return(
@@ -155,13 +161,14 @@ describe MyTargetApi::Request do
       )
 
       expect { request.get('https://target.my.com/api/v1/request.json') }
-        .to raise_error(MyTargetApi::RequestError,
-                        '404: Unknown resource. Inspect #params, #response and #original_exception'\
-                        ' for more details')
+        .to raise_error(MyTargetApi::RequestError, '404: Unknown resource')
+
+      expect(logger).to(have_received(:<<).with(<<~LOG))
+        GET https://target.my.com/api/v1/request.json
+        Headers: No headers
+        Params: No params
+      LOG
 
-      expect(logger).to(have_received(:<<).with("method: Request#get\n"\
-        "url: https://target.my.com/api/v1/request.json\n"\
-        'params: {}'))
       expect(logger).to(have_received(:<<).with(<<~LOG))
         HTTP Code: 404
         HTTP Body:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: my_target_api
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.7
 platform: ruby
 authors:
 - OneRetarget.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-01 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -55,6 +55,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.4
   type: :development
@@ -62,6 +65,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.4
 - !ruby/object:Gem::Dependency
@@ -153,8 +159,11 @@ files:
 - LICENSE.txt
 - README.md
 - lib/my_target_api.rb
+- lib/my_target_api/add_access_token_to_request_decorator.rb
 - lib/my_target_api/log_request_parameters_decorator.rb
 - lib/my_target_api/net_client.rb
+- lib/my_target_api/nil_logger.rb
+- lib/my_target_api/prepare_post_params_decorator.rb
 - lib/my_target_api/request.rb
 - lib/my_target_api/request_error.rb
 - lib/my_target_api/resource.rb