hasoffersv3 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eefc584486a52827598e4cc0fe17fb050f19b730
-  data.tar.gz: 34ccbf8f939fd76476be45be3a52da41c3cc6b02
+  metadata.gz: 0ae8c8dcc8a60460f3f3a0954be68f9a9a2208b0
+  data.tar.gz: e8c79bdcb82d3806749f5cb3b6cc9c7b541e79df
 SHA512:
-  metadata.gz: e35ea5362691e3621e510894a5ff6baa87f7f64baf7803fae74b3aad34ddadde92e43a276b9cd50c2d74a87c6c60c8a1405b0a68ea3863f470e74bc8c674ff9f
-  data.tar.gz: 5a36c482a56acfb7187fb096c2c7a56d54bc561d4b99e1d3bfefabdcf1ea7cb5ef9319d20df8d82a3d3ce089a058a8fab99e042ac6cc53eb927ada6a90a4238f
+  metadata.gz: 976cb9593dfbed447919aac92021c5a268a696aed5e2627f586b83bd1c59a20614306947093f788aba639131f7aa390d6c5c269f1631bcac9e48c7bfcc720431
+  data.tar.gz: ea19c6886c520a074a274b6710734f17f26b2b97d38d0c12f02aaa40e5010f242910869ef75c070fb911c3c4051792685c18ec7448b079313b92bbe4635996cf

data/.gitignore

@@ -18,3 +18,5 @@ tmp
 .DS_Store
 *.swp
 .ruby-version
+.ruby-gemset
+.idea

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.6.0
+- [#61] Added configurable (via `config.raise_errors = true`) raising of internal exceptions (`HasOffersV3::Error` and its descendants) on various API error conditions.  Incompatible changes: JSON parsing error now raises a `HasOffersV3::ParseError` that wraps the original error from a particular JSON driver used. (@vittorius)
+
 # 0.5.5
 - [#58] Added `AdvertiserBilling::findAllInvoicesByIds`, `AffiliateBilling::findAllInvoicesByIds` methods. (@kamil89)
 - [#59] Added `Advertiser::getSingupAnswers` and `Affiliate::getSingupAnswers` methods. (@kamil89)

data/README.md

@@ -1,6 +1,7 @@
 ### Overview
 
 [![Build status](https://api.travis-ci.org/applift/hasoffersv3.png?branch=master)](http://travis-ci.org/applift/hasoffersv3)
+[![Gem Version](https://badge.fury.io/rb/hasoffersv3.svg)](https://badge.fury.io/rb/hasoffersv3)
 
 ### Synopsis
 
@@ -28,6 +29,7 @@ HasOffersV3.configure do |config|
   config.api_key      = 'Your HasOffers API Key'
   config.network_id   = 'Your HasOffers Network ID'
   config.read_timeout = 10
+  config.raise_errors = true # add this if you want the hasoffersv3 to raise errors upon detected API error messages in responses; defaults to `false`
 
   # Optionally configure a proxy:
   config.proxy_host   = 'yourproxy.com'
@@ -72,6 +74,10 @@ HasOffersV3::Advertiser.signup({
 })
 ```
 
+### Error handling
+
+If `config.raise_errors` was set to `true`, the `hasoffersv3` will raise internal exceptions when error occurs at protocol or business logic level. See the [`HasOffersV3::Error`](https://github.com/applift/hasoffersv3/blob/master/lib/hasoffersv3/error.rb) and its descendants' definitions for more comments and details.
+
 ### Logging
 
 To enable log you can set a logger in configuration. All HTTP requests and responses will be logged.

data/lib/hasoffersv3/api_error.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'hasoffersv3/error'
+
+class HasOffersV3
+  # Any error emitted at business logic level of the HasOffersV3 API that is not fatal but tells that a particular operation cannot be performed.
+  class APIError < ResponseError
+    class << self
+      def from_response(response)
+        error_class_chain.each do |error_class|
+          err_msg = error_class.detect(response)
+          break error_class.new(err_msg, response) if err_msg
+        end
+      end
+
+      protected
+
+      def error_class_chain
+        # the order is important, more "blocker-like" errors go before "lax" ones; don't forget to add any new error classes to this chain
+        @error_class_chain ||= [IPNotWhitelistedError, MissingParamError, FieldError, InternalError, UnknownError]
+      end
+    end
+  end
+
+  class IPNotWhitelistedError < APIError
+    def self.detect(response)
+      response.error_messages.grep(/IP \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3} is not white-listed/).first
+    end
+  end
+
+  class MissingParamError < APIError
+    def self.detect(response)
+      response.error_messages.grep(/Missing required argument/).first
+    end
+  end
+
+  class FieldError < APIError
+    def self.detect(response)
+      response.error_messages.grep(/Field '.*' does not exist or is not allowed to be used./).first
+    end
+  end
+
+  class InternalError < APIError
+    def self.detect(response)
+      # E.g. "There was a database error with the trackable id [SE-5888e90b944af]. Contact support for more assistance."
+      response.error_messages.grep(/error with the trackable id/).first
+    end
+  end
+
+  class UnknownError < APIError
+    def self.detect(response)
+      response.error_messages.first
+    end
+  end
+end

data/lib/hasoffersv3/client.rb

@@ -1,9 +1,10 @@
 require 'net/http' if RUBY_VERSION < '2'
 require 'active_support/core_ext/object/to_query'
+require 'hasoffersv3/error'
+require 'hasoffersv3/api_error'
 
 class HasOffersV3
   class Client
-
     attr_accessor :configuration
 
     def initialize(configuration)
@@ -32,7 +33,9 @@ class HasOffersV3
 
       logger.log_response(http_response)
 
-      Response.new(http_response, @configuration.json_driver)
+      with_error_detection do
+        Response.new(http_response, @configuration.json_driver)
+      end
     end
 
     def execute_request(net_http, raw_request)
@@ -73,5 +76,14 @@ class HasOffersV3
       configuration.http_logger
     end
 
+    def with_error_detection
+      response = yield
+      return response unless configuration.raise_errors
+
+      raise HTTPError.from_response(response) unless response.http_ok?
+      raise APIError.from_response(response) unless response.status_ok?
+
+      response
+    end
   end
 end

data/lib/hasoffersv3/configuration.rb

@@ -20,6 +20,7 @@ class HasOffersV3
       network_id: '',
       api_key: '',
       json_driver: self.default_json_driver,
+      raise_errors: false,
       logger: nil,
       proxy_host: nil,
       proxy_port: nil,

data/lib/hasoffersv3/error.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/module/delegation'
+
+class HasOffersV3
+  class Error < StandardError; end
+
+  class ResponseError < Error
+    attr_reader :response
+    delegate :http_status_code, :http_message, :http_headers, to: :response
+
+    def initialize(message, response)
+      super(message)
+      @response = response
+    end
+  end
+
+  # An error caught when parsing the JSON response body got from API endpoint.
+  # Wraps the original JSON driver error emitted.
+  # Raised always (does not depend on the config settings).
+  class ParseError < ResponseError; end
+
+  # Any HTTP error that has occurred during the call to the API endpoint (gateway timeout, internal server error etc.)
+  class HTTPError < ResponseError
+    def self.from_response(response)
+      new("HTTP error: #{response.http_message}", response)
+    end
+  end
+end

data/lib/hasoffersv3/response.rb

@@ -3,14 +3,27 @@ class HasOffersV3
     attr_reader :body, :http_status_code, :http_message, :http_headers
 
     def initialize(response, json=default_json_driver)
-      @body             = json.load(response.body.to_s)
+      begin
+        @body = json.load(response.body.to_s)
+      rescue
+        raise ParseError.new('Error parsing response body, examine the `cause` property for details', response)
+      end
+
       @http_status_code = response.code
       @http_message     = response.message
       @http_headers     = response.to_hash
     end
 
     def success?
-      @http_status_code.to_s == '200' and status == 1
+      http_ok? && status_ok?
+    end
+
+    def http_ok?
+      @http_status_code.to_s == '200'
+    end
+
+    def status_ok?
+      status == 1
     end
 
     def status

data/lib/hasoffersv3/version.rb

@@ -1,3 +1,3 @@
 class HasOffersV3
-  VERSION = '0.5.5'
+  VERSION = '0.6.0'
 end

data/spec/lib/client_spec.rb

@@ -1,30 +1,150 @@
+# frozen_string_literal: true
+
 describe HasOffersV3::Client do
   let(:config) { HasOffersV3::Configuration.new }
-  subject {  HasOffersV3::Client.new(config) }
+  let(:client) { HasOffersV3::Client.new(config) }
+  subject { client }
 
   describe '#new_http' do
-
     context 'when configuration proxy_host is present' do
-
-      let(:config) {
+      let(:config) do
         result = HasOffersV3::Configuration.new
         result.proxy_host = 'proxy.com'
         result.proxy_port = '8080'
         result
-      }
+      end
 
       it 'generates a connection with proxy' do
         http_client = subject.new_http(URI('http://hasoffers.com:9300/'))
         expect(http_client.proxyaddr).to eq('proxy.com')
         expect(http_client.proxyport).to eq('8080')
       end
-
     end
+  end
+
+  describe '#request' do
+    context 'raising errors' do
+      let(:raise_errors) { true }
+      let(:config) { HasOffersV3::Configuration.new(raise_errors: raise_errors) }
+      let(:url) { api_url 'Advertiser' }
+      let(:response_body) { JSON.load(default_return[:body]) } # it's more convenient for us to have response_body as a Ruby object
+      let(:status) { default_return[:status] }
+      let(:headers) { {} }
+      let(:response) do
+        {
+          body: JSON.dump(response_body),
+          status: status,
+          headers: headers
+        }
+      end
+      let(:http_method) { :post }
+
+      before { stub_call(http_method, response) }
+
+      subject { client.request(http_method, 'Advertiser', 'findAll', {}) }
+
+      shared_examples 'does not raise errors when configured to not raise errors' do
+        let(:raise_errors) { false }
+
+        it 'does not raise errors' do
+          expect { subject }.not_to raise_error
+        end
+      end
+
+      context 'no errors' do
+        it 'does not raise error if no error messages were detected' do
+          expect { subject }.not_to raise_error
+        end
+      end
+
+      context 'HTTP errors' do
+        let(:response_body) { nil }
+        let(:headers) { { 'Content-Length' => 0, 'Connection' => 'Close' } }
+        let(:status) { [504, 'GATEWAY_TIMEOUT'] }
+
+        it 'raises an appropriate error when HTTP failure detected' do
+          expect { subject }.to raise_error do |error|
+            expect(error).to be_a HasOffersV3::HTTPError
+            expect(error).to have_attributes(
+                               message: 'HTTP error: GATEWAY_TIMEOUT',
+                               http_status_code: '504',
+                               http_message: 'GATEWAY_TIMEOUT',
+                               http_headers: {
+                                 'content-length' => ['0'],
+                                 'connection' => ['Close']
+                               }
+                             )
+          end
+        end
+
+        it_behaves_like 'does not raise errors when configured to not raise errors'
+      end
 
+      context 'API errors' do
+        shared_examples 'API error is detected and raised' do
+          let(:response_body) do
+            {
+              'response' => {
+                'status' => -1,
+                'httpStatus' => 200,
+                'data' => '',
+                'errors' => [{'publicMessage' => error_message }],
+                'errorMessage' => error_message
+              }
+            }
+          end
+
+          it 'raises an appropriate error when such an error detected' do
+            expect { subject }.to raise_error(error_class, error_message)
+          end
+
+          it_behaves_like 'does not raise errors when configured to not raise errors'
+        end
+
+        context 'IP is not whitelisted' do
+          let(:error_message) { 'IP 178.161.91.191 is not white-listed. Please enable it in the application, Support => API' }
+          let(:error_class) { HasOffersV3::IPNotWhitelistedError }
+
+          it_behaves_like 'API error is detected and raised'
+        end
+
+        context 'parameter missing' do
+          subject { client.request(http_method, 'Advertiser', 'findById', {}) }
+
+          let(:error_message) { 'Missing required argument: id' }
+          let(:error_class) { HasOffersV3::MissingParamError }
+
+          it_behaves_like 'API error is detected and raised'
+        end
+
+        context 'field error' do
+          let(:url) { api_url 'Report' }
+          subject { client.request(http_method, 'Report', 'getStats', { 'fields[]' => 'Offer.nam' }) }
+
+          let(:error_message) { "Field 'Offer.nam' does not exist or is not allowed to be used." }
+          let(:error_class) { HasOffersV3::FieldError }
+
+          it_behaves_like 'API error is detected and raised'
+        end
+
+        context 'internal error' do
+          let(:error_message) { 'There was a database error with the trackable id [SE-5888e90b944af]. Contact support for more assistance.' }
+          let(:error_class) { HasOffersV3::InternalError }
+
+          it_behaves_like 'API error is detected and raised'
+        end
+
+        context 'unknown error' do
+          let(:error_message) { 'Something went wrong.' }
+          let(:error_class) { HasOffersV3::UnknownError }
+
+          it_behaves_like 'API error is detected and raised'
+        end
+      end
+    end
   end
 
   describe '#base_uri' do
-
     let(:configuration_to_default_host) { HasOffersV3::Configuration.new }
     let(:config_for_proxy) {
       result = HasOffersV3::Configuration.new
@@ -39,7 +159,5 @@ describe HasOffersV3::Client do
       proxy_connection = HasOffersV3::Client.new(config_for_proxy)
       expect(proxy_connection.base_uri).to eq('https://api.applift.com/v3')
     end
-
   end
-
 end

data/spec/lib/response_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'hasoffersv3/error'
+
+describe HasOffersV3::Response do
+  describe '#initialize' do
+    it 'raises an appropriate error on malformed response body' do
+      expect { described_class.new('"') }.to(
+        raise_error(HasOffersV3::ParseError, 'Error parsing response body, examine the `cause` property for details')
+      )
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hasoffersv3
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Maximilian Seifert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,12 +105,14 @@ files:
 - lib/hasoffersv3/affiliate.rb
 - lib/hasoffersv3/affiliate_billing.rb
 - lib/hasoffersv3/affiliate_offer.rb
+- lib/hasoffersv3/api_error.rb
 - lib/hasoffersv3/application.rb
 - lib/hasoffersv3/base.rb
 - lib/hasoffersv3/client.rb
 - lib/hasoffersv3/configuration.rb
 - lib/hasoffersv3/conversion.rb
 - lib/hasoffersv3/employee.rb
+- lib/hasoffersv3/error.rb
 - lib/hasoffersv3/logger.rb
 - lib/hasoffersv3/offer.rb
 - lib/hasoffersv3/offer_pixel.rb
@@ -137,6 +139,7 @@ files:
 - spec/lib/offer_spec.rb
 - spec/lib/raw_log_spec.rb
 - spec/lib/report_spec.rb
+- spec/lib/response_spec.rb
 - spec/spec_helper.rb
 homepage: 
 licenses:
@@ -158,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: REST Client for the HasOffers API, version 3.
@@ -181,4 +184,5 @@ test_files:
 - spec/lib/offer_spec.rb
 - spec/lib/raw_log_spec.rb
 - spec/lib/report_spec.rb
+- spec/lib/response_spec.rb
 - spec/spec_helper.rb