bayonet_client 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93504f02494147eff6e967c47652aa89a2d8517f
-  data.tar.gz: ddbb28f40b003ac4d3f3e4862b0d1a79e466b87b
+  metadata.gz: 9898dceba28ecd8d1841f018a66ce1246597c890
+  data.tar.gz: 630c301aa4d1df67c9adc7025fe7cbf40099f386
 SHA512:
-  metadata.gz: 03e5cc9eda76fe7c36360d06bb74bab4e4540cfeef69c3983c855fa8b1f72ab385bf2cead1b890cc949ec4504ce90fc313383e01c9e5c9bbadde63bf25ec825a
-  data.tar.gz: 1e61288e327e6ae0193de7447626c38fb53298730fd07dd303aa84e1e0268ab9c42e6abce187865b27532493dead79ae1b970b590091195bf2e65205ebd2d472
+  metadata.gz: 1c0993fc89e3dffa6060ce26466b39def4ff94c7ff4a4c487c51cb440b3224fd885712fb55f9b83edaa55dd56284e17fef4ce850eee9400f81e23a7c8e31afa1
+  data.tar.gz: 48bc50a9289d1677e7e7e497f22c98e41bf888b63e96e53a315e87cf98f238d447e22fbb371a4735998ba24eceea198e3deb03c6dbf76f8347fca7bc11de6c00

data/README.md

@@ -38,9 +38,13 @@ To use this SDK, please make sure:
     ```ruby
     BayonetClient.configure(api_key, api_version)
     ```
+    You can also set a timeout value (in seconds):
+    ```ruby
+    BayonetClient.configure(api_key, api_version, timeout)
+    ```
     
 ## Usage
-Once you have Bayonet's SDK configured, you can call the APIs with the following syntax.Follow the guidelines specific to the product you are integrating:
+Once you have Bayonet's SDK configured, you can call the APIs with the following syntax. Follow the guidelines specific to the product you are integrating:
 
 * [Ecommerce](#ecommerce)
 
@@ -78,7 +82,8 @@ Once you have Bayonet's SDK configured, you can call the APIs with the following
             zip_code: '64000'
         },
         payment_method: 'card',
-        transaction_id: '<your internal ID for this transaction>'
+        order_id: '<your internal ID for this order (mandatory)>',
+        transaction_id: '<your internal ID for this transaction (optional)>',
         payment_gateway: 'stripe',
         coupon: 'discount_buen_fin',
         expedited_shipping: true,
@@ -103,10 +108,13 @@ Once you have Bayonet's SDK configured, you can call the APIs with the following
   
     ```ruby
     BayonetClient::Ecommerce.update-transaction({
+        order_id: '<your internal ID for this order (as sent in the consult step)>',
         transaction_id: '<your internal ID for this transaction (as sent in the consult step)>',
+        bayonet_tracking_id: '<tracking ID returned by the API in the consult step>',
         transaction_status: 'success',
         ...
     })
+    # please note that you can use either one of 'order_id', 'transaction_id', or 'bayonet_tracking_id' to update the status of a transaction
     ```
 * Feedback-historical API
   
@@ -292,7 +300,7 @@ rescue BayonetClient::BayonetError => e
 end
 
 begin
-    BayonetClient::Ecommerce.consulting(params)
+    BayonetClient::Ecommerce.consult(params)
 rescue BayonetClient::BayonetError => e
   puts e.reason_code
   puts e.reason_message

data/lib/bayonet_client.rb

@@ -7,8 +7,9 @@ require_relative './bayonet_client/lending.rb'
 require_relative './bayonet_client/device_fingerprint.rb'
 
 module BayonetClient
+  DEFAULT_HTTP_TIMEOUT = 10
 
-  def self.configure(api_key, version)
+  def self.configure(api_key, version, timeout = DEFAULT_HTTP_TIMEOUT)
     if version.nil? || version.empty?
       message = 'Please specify Api version'
       raise BayonetClient::BayonetError.new(nil, nil, nil, nil, -1, message)
@@ -17,6 +18,10 @@ module BayonetClient
       message = 'Please specify Api key'
       raise BayonetClient::BayonetError.new(nil, nil, nil, nil, -1, message)
     end
+    unless timeout.is_a? Numeric
+      message = 'Please specify a valid timeout value'
+      raise BayonetClient::BayonetError.new(nil, nil, nil, nil, -1, message)
+    end
     unless BayonetClient::SUPPORTED_API_VERSIONS.include?(version)
       message = 'This library does not support the version specified. Please consider updating your dependencies'
       raise BayonetClient::BayonetError.new(nil, nil, nil, nil, -1, message)
@@ -24,11 +29,13 @@ module BayonetClient
 
     @api_key = api_key
     @version = version
+    @timeout = timeout
   end
 
   class << self
     attr_reader :api_key
     attr_reader :version
+    attr_reader :timeout
   end
 
 end

data/lib/bayonet_client/api_helper.rb

@@ -30,10 +30,15 @@ module BayonetClient
       url = "#{fq_hostname}#{route}"
 
       headers = {'User-Agent' => 'OfficialBayonetRubySDK',
-                 'Content-Type' => 'application/json', 'Accept' => 'application/json'}
-
-      raw_resp = HTTParty.post(
-          url, body: request_json_args, headers: headers, verify: false)
+                 'Content-Type' => 'application/json',
+                 'Accept' => 'application/json'}
+
+      begin
+        raw_resp = HTTParty.post(
+            url, body: request_json_args, headers: headers, verify: false, timeout: BayonetClient.timeout)
+      rescue Net::ReadTimeout => e
+        raise BayonetClient::BayonetError.new(request_json_args, headers, nil, nil, -1, 'Request timed out. If you explicitly set a timeout, consider raising the timeout value')
+      end
 
       if raw_resp.code == 200
         BayonetClient::BayonetResponse.new(raw_resp)

data/lib/bayonet_client/version.rb

@@ -1,4 +1,4 @@
 module BayonetClient
-  VERSION = '2.2.1'
+  VERSION = '2.3.0'
   SUPPORTED_API_VERSIONS = ['2']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bayonet_client
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Bayonet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty