konduto-ruby 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9f999d7311ada5064ed73af20e309798dc200c88
-  data.tar.gz: e3c0a388cbee50a7b4fae5d6b1e9878b48dbc33d
+SHA256:
+  metadata.gz: 2979ec6a852c1d1aec13ff2fee745918d33ccd68dc60b8a3fb59902cdcc0d12c
+  data.tar.gz: 18724ed8955265a9ee632454d3bc6fe4a1277d268de87d5d86a81318d2b0e53d
 SHA512:
-  metadata.gz: 2c7b2601218b470b752f55d9a72c9c1994f7c51f6a01a47752819243b7b74f1d65fc112ee72303ffe321a39bfe38865db6628c1e2804a6294ab46dabd836a964
-  data.tar.gz: 5fc2b0b07ac1bae002e008773d1fa114990ec7ab57ba8739fe2cca7febedb3265618e4051008d7d2e417aa795edbf2bb2bc3b0d27c8dd130266458006c585a45
+  metadata.gz: adbba6bf4810427c18a3aff47ae11526ca32bc9cef0a09f44920cc71bca4d4b11d56e651c8d1d85197d9f1dba71dffd3265169596254bc39c56a0a1083bf5ca9
+  data.tar.gz: edabb1c41aa2d930240e5897c204f65df269e8a065a8e11d267b20ecd97e543f6d0c007759d0615dc26187289dd25a8ae3e8b808c9966028a77cf57633e03226

data/README.md

@@ -1,6 +1,6 @@
 ## Hey there,
 
-This document is a rubyist adaptation of the original README file made for the Java API version. You can get access to it by clicking  [here](https://github.com/konduto/java-sdk/blob/master/README.md). **Konduto is a trademark, all rights reserved**. This project has no intention beyond helping ruby users to get easy access to Konduto's API through a simplified interface.
+This document is a rubyist adaptation of the original README file made for the Java API version. You can get access to it by clicking [here](https://github.com/konduto/java-sdk/blob/master/README.md). **Konduto is a trademark, all rights reserved**. This project has no intention beyond helping ruby users to get easy access to Konduto's API through a simplified interface.
 
 ## Intro
 
@@ -10,9 +10,13 @@ Our service uses the visitor's behavior to analyze browsing patterns and detect
 
 This document refers to the **Ruby SDK** used for our API.
 
+## Migration from 1.0 to 2.0
+
+NavigationInfo class is now Navigation and validation methods are now scopped by Konduto module.
+
 ## Requirements
 
-* This API was tested with Ruby MRI version 2.
+- This API was tested with Ruby MRI version 2.
 
 ## Installation
 
@@ -30,7 +34,6 @@ When a customer makes a purchase you must send the order information to us so we
 
 While many of the parameters we accept are optional we recommend you send all you can, because every data point matters for the analysis. The **billing address** and **credit card information** are specially important, though we understand there are cases where you don't have that information.
 
-
 ## Set your API key
 
 You will need an API key to authenticate the requests. Luckily for you the examples below have been populated with a working key, so you can just copy and paste to see how it works.
@@ -53,7 +56,8 @@ order = KondutoOrder.new({
           totalAmount: 123.4,
           customer: customer # customer is an instance of KondutoCustomer
         })
-```		
+```
+
 One can also use the more conventional set-based approach as seen below.
 
 ```ruby
@@ -63,105 +67,98 @@ order.total_amount = 123.4
 order.customer = customer
 ```
 
->
-**NOTICE**: the order created above is really, really simple. The more detail you provide, more accurate Konduto's analysis will be.
->
+> **NOTICE**: the order created above is really, really simple. The more detail you provide, more accurate Konduto's analysis will be.
 
 ### Order parameters
 
-Parameter | Description
---- | ---
-id | _(required)_ Unique identifier for each order.
-visitor | _(required)_ Visitor identifier obtained from our JavaScript snippet.
-total_amount | _(required)_ Total order amount.
-shipping_amount | _(optional)_ Shipping and handling amount.
-tax_amount | _(optional)_ Taxes amount.
-currency | _(optional)_ Currency code with 3 letters (ISO-4712).
-installments | _(optional)_ Number of installments in the payment plan.
-ip | _(optional)_ Customer's IPv4 address.
-customer | _(required)_ Object containing the customer details.
-payment | _(optional)_ Array containing the payment methods.
-billing | _(optional)_ Object containing the billing information.
-shipping | _(optional)_ Object containing the shipping information.
-shopping_cart | _(optional)_ Array containing the items purchased.
-analyze | _(optional)_ A boolean indicating if the order should be analyzed. Defaults to **true**.
-first_message | _(optional)_ Time when the first message was exchanged between customer and seller.
-messages_exchanged | _(optional)_ Number of messages exchanged between customer and seller.
-purchased_at | _(optional)_ Time when the customer purchased from the seller.
+| Parameter          | Description                                                                              |
+| ------------------ | ---------------------------------------------------------------------------------------- |
+| id                 | _(required)_ Unique identifier for each order.                                           |
+| visitor            | _(required)_ Visitor identifier obtained from our JavaScript snippet.                    |
+| total_amount       | _(required)_ Total order amount.                                                         |
+| shipping_amount    | _(optional)_ Shipping and handling amount.                                               |
+| tax_amount         | _(optional)_ Taxes amount.                                                               |
+| currency           | _(optional)_ Currency code with 3 letters (ISO-4712).                                    |
+| installments       | _(optional)_ Number of installments in the payment plan.                                 |
+| ip                 | _(optional)_ Customer's IPv4 address.                                                    |
+| customer           | _(required)_ Object containing the customer details.                                     |
+| payment            | _(optional)_ Array containing the payment methods.                                       |
+| billing            | _(optional)_ Object containing the billing information.                                  |
+| shipping           | _(optional)_ Object containing the shipping information.                                 |
+| shopping_cart      | _(optional)_ Array containing the items purchased.                                       |
+| analyze            | _(optional)_ A boolean indicating if the order should be analyzed. Defaults to **true**. |
+| first_message      | _(optional)_ Time when the first message was exchanged between customer and seller.      |
+| messages_exchanged | _(optional)_ Number of messages exchanged between customer and seller.                   |
+| purchased_at       | _(optional)_ Time when the customer purchased from the seller.                           |
 
 #### Customer information
 
-Parameter | Description
---- | ---
-id | _(required)_ **Unique** identifier for each customer. Can be anything you like (counter, id, e-mail address) as long as it's consistent in future orders.
-name | _(required)_ Customer's full name.
-email | _(required)_ Customer's e-mail address
-tax_id | _(optional)_ Customer's tax id.
-phone1 | _(optional)_ Customer's primary phone number
-phone 2 | _(optional)_ Customer's secondary phone number
-new | _(optional)_ Boolean indicating if the customer is using a newly created account for this purchase.
-vip | _(optional)_ Boolean indicating if the customer is a VIP or frequent buyer.
-created_at | _(optional)_ Date when customer was created.
-
+| Parameter  | Description                                                                                                                                               |
+| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| id         | _(required)_ **Unique** identifier for each customer. Can be anything you like (counter, id, e-mail address) as long as it's consistent in future orders. |
+| name       | _(required)_ Customer's full name.                                                                                                                        |
+| email      | _(required)_ Customer's e-mail address                                                                                                                    |
+| tax_id     | _(optional)_ Customer's tax id.                                                                                                                           |
+| phone1     | _(optional)_ Customer's primary phone number                                                                                                              |
+| phone 2    | _(optional)_ Customer's secondary phone number                                                                                                            |
+| new        | _(optional)_ Boolean indicating if the customer is using a newly created account for this purchase.                                                       |
+| vip        | _(optional)_ Boolean indicating if the customer is a VIP or frequent buyer.                                                                               |
+| created_at | _(optional)_ Date when customer was created.                                                                                                              |
 
 #### Payment information
 
-Parameter | Description
---- | ---
-status | _(required)_ The status of the transaction returned by the payment processor. Accepts `approved`, `declined` or `pending` if the payment wasn't been processed yet.
-bin | _(optional)_ First six digits of the customer's credit card. Used to identify the type of card being sent.
-last4 | _(optional)_ Four last digits of the customer's credit card number.
-expiration_date | _(optional)_ Card's expiration date under MMYYYY format.
-
+| Parameter       | Description                                                                                                                                                         |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| status          | _(required)_ The status of the transaction returned by the payment processor. Accepts `approved`, `declined` or `pending` if the payment wasn't been processed yet. |
+| bin             | _(optional)_ First six digits of the customer's credit card. Used to identify the type of card being sent.                                                          |
+| last4           | _(optional)_ Four last digits of the customer's credit card number.                                                                                                 |
+| expiration_date | _(optional)_ Card's expiration date under MMYYYY format.                                                                                                            |
 
 #### Billing address
 
-Parameter | Description
---- | ---
-name | _(optional)_ Cardholder's full name.
-address1 | _(optional)_ Cardholder's billing address on file with the bank.
-address2 | _(optional)_ Additional cardholder address information.
-city | _(optional)_ Cardholder's city.
-state | _(optional)_ Cardholder's state.
-zip | _(optional)_ Cardholder's ZIP code.
-country | _(optional)_ Cardholder's country code (ISO 3166-2)
-
+| Parameter | Description                                                      |
+| --------- | ---------------------------------------------------------------- |
+| name      | _(optional)_ Cardholder's full name.                             |
+| address1  | _(optional)_ Cardholder's billing address on file with the bank. |
+| address2  | _(optional)_ Additional cardholder address information.          |
+| city      | _(optional)_ Cardholder's city.                                  |
+| state     | _(optional)_ Cardholder's state.                                 |
+| zip       | _(optional)_ Cardholder's ZIP code.                              |
+| country   | _(optional)_ Cardholder's country code (ISO 3166-2)              |
 
 #### Shipping address
 
-Parameter | Description
---- | ---
-name | _(optional)_ Recipient's full name.
-address1 | _(optional)_ Recipient's shipping address.
-address2 | _(optional)_ Additional recipient address information.
-city | _(optional)_ Recipient's city.
-state | _(optional)_ Recipient's state.
-zip | _(optional)_ Recipient's ZIP code.
-country | _(optional)_ Recipient's country code (ISO 3166-2)
-
+| Parameter | Description                                            |
+| --------- | ------------------------------------------------------ |
+| name      | _(optional)_ Recipient's full name.                    |
+| address1  | _(optional)_ Recipient's shipping address.             |
+| address2  | _(optional)_ Additional recipient address information. |
+| city      | _(optional)_ Recipient's city.                         |
+| state     | _(optional)_ Recipient's state.                        |
+| zip       | _(optional)_ Recipient's ZIP code.                     |
+| country   | _(optional)_ Recipient's country code (ISO 3166-2)     |
 
 #### Shopping cart
 
-Parameter | Description
---- | ---
-sku | _(optional)_ Product or service's SKU or inventory id.
-product_code | _(optional)_ Product or service's UPC, barcode or secondary id.
-category | _(optional)_ Category code for the item purchased. [See here](http://docs.konduto.com/#n-tables) for the list.
-name | _(optional)_ Name of the product or service.
-description | _(optional)_ Detailed description of the item.
-unit_cost | _(optional)_ Cost of a single unit of this item.
-quantity | _(optional)_ Number of units purchased.
-discount | _(optional)_ Discounted amount for this item.
-created_at | _(optional)_ Date when this item was created.
+| Parameter    | Description                                                                                                    |
+| ------------ | -------------------------------------------------------------------------------------------------------------- |
+| sku          | _(optional)_ Product or service's SKU or inventory id.                                                         |
+| product_code | _(optional)_ Product or service's UPC, barcode or secondary id.                                                |
+| category     | _(optional)_ Category code for the item purchased. [See here](http://docs.konduto.com/#n-tables) for the list. |
+| name         | _(optional)_ Name of the product or service.                                                                   |
+| description  | _(optional)_ Detailed description of the item.                                                                 |
+| unit_cost    | _(optional)_ Cost of a single unit of this item.                                                               |
+| quantity     | _(optional)_ Number of units purchased.                                                                        |
+| discount     | _(optional)_ Discounted amount for this item.                                                                  |
+| created_at   | _(optional)_ Date when this item was created.                                                                  |
 
 ### Seller
 
-Parameter | Description
---- | ---
-id | _(required)_ Seller's id
-name | _(optional)_ Sellers's name
-created_at | _(optional)_ Date when the seller was created
-
+| Parameter  | Description                                   |
+| ---------- | --------------------------------------------- |
+| id         | _(required)_ Seller's id                      |
+| name       | _(optional)_ Sellers's name                   |
+| created_at | _(optional)_ Date when the seller was created |
 
 ## Sending an order for analysis.
 
@@ -205,12 +202,13 @@ order = konduto.get_order order_id # orderId is a String
 konduto.update_order_status(order, new_status, 'some comments');
 ```
 
-Parameter | Description
---- | ---
-status | _(required)_ New status for this transaction. Either `approved`, `declined` or `fraud`, when you have identified a fraud or chargeback.
-comments | _(required)_ Reason or comments about the status update.
+| Parameter | Description                                                                                                                             |
+| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| status    | _(required)_ New status for this transaction. Either `approved`, `declined` or `fraud`, when you have identified a fraud or chargeback. |
+| comments  | _(required)_ Reason or comments about the status update.                                                                                |
 
 ## Sending requests through a proxy
+
 To send requests through a proxy just build a new Konduto instance and set the proxy host passing the proxy url as parameters of `proxy=` method. If the proxy requires username and password, just set then at the proxy url you'll pass to `proxy=` method.
 
 ```ruby

data/lib/konduto-ruby.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'konduto-ruby/konduto_base'
 require 'konduto-ruby/konduto_travel_leg'
+
 Dir[__dir__ + '/konduto-ruby/*.rb'].each { |file| require file }
 
 class KondutoRuby

data/lib/konduto-ruby/associations/associations.rb

@@ -5,7 +5,7 @@ module Konduto
       name = options[:alias] || model
 
       self.send(:define_method, name) do
-        instance_variable_get("@#{name}")
+        instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
       end
 
       self.send(:define_method, "#{name}=".to_sym) do |value|
@@ -25,9 +25,7 @@ module Konduto
       name = options[:alias] || model
 
       self.send(:define_method, name) do
-        instance_variable_set("@#{name}", []) if instance_variable_get("@#{name}").nil?
-
-        instance_variable_get("@#{name}")
+        instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
       end
 
       self.send(:define_method, "#{name}=".to_sym) do |arr|

data/lib/konduto-ruby/attributes.rb

@@ -6,6 +6,8 @@ module Konduto
           klass = attribute.values[0].to_s.gsub(/_/, ' ').split.map(&:capitalize).join('')
           type = Object::const_get(klass)
           name = attribute.keys[0]
+
+          define_strftime_pattern(self, name, attribute[:strftime_pattern]) if attribute.has_key?(:strftime_pattern)
         else
           name = attribute
         end
@@ -22,11 +24,17 @@ module Konduto
         end
 
         self.send(:define_method, name) do
-          instance_variable_get("@#{name.to_s.gsub(/[?|!]$/, '')}")
+          instance_variable_get("@#{name.to_s.gsub(/[?|!]$/, '')}") if instance_variable_defined?("@#{name.to_s.gsub(/[?|!]$/, '')}")
         end
       end
     end
 
     alias :attribute :attributes
+
+    def define_strftime_pattern(klass, name, value)
+      klass.send(:define_method, "#{name.to_s.gsub(/[?|!]$/, '')}_strftime_pattern") do
+        value
+      end
+    end
   end
 end

data/lib/konduto-ruby/konduto_base.rb

@@ -28,11 +28,17 @@ class KondutoBase
       instance_variables.map do |name|
         value = instance_variable_get(name)
 
+        strftime_pattern = defined_strftime_pattern(name) if defined_strftime_pattern?(name)
+
         if value.respond_to? :each
           value = value.map {|v| v.to_hash }
         elsif !value.instance_variables.empty?
           value = value.to_hash
-        elsif value.is_a?(Date) || value.is_a?(Symbol)
+        elsif value.is_a?(DateTime)
+          value = value.strftime(strftime_pattern || '%Y-%m-%dT%H:%MZ')
+        elsif value.is_a?(Date)
+          value = value.strftime(strftime_pattern || '%Y-%m-%d')
+        elsif value.is_a?(Symbol)
           value = value.to_s
         end
 
@@ -53,4 +59,12 @@ class KondutoBase
 
     true
   end
+
+  def defined_strftime_pattern?(attr)
+    respond_to? "#{attr.to_s.gsub(/^@/, '')}_strftime_pattern"
+  end
+
+  def defined_strftime_pattern(attr)
+    send("#{attr.to_s.gsub(/^@/, '')}_strftime_pattern") 
+  end
 end

data/lib/konduto-ruby/{konduto_navigation_info.rb → konduto_navigation.rb}

@@ -1,4 +1,4 @@
-class KondutoNavigationInfo < KondutoBase
+class KondutoNavigation < KondutoBase
   attributes :session_time, :referrer, :time_site_1d, :new_accounts_1d, :password_resets_1d, :sales_declined_1d,\
              :sessions_1d, :time_since_last_sale, :time_site_7d, :time_per_page_7d, :new_accounts_7d, \
              :password_resets_7d, :checkout_count_7d, :sales_declined_7d, :sessions_7d

data/lib/konduto-ruby/konduto_order.rb

@@ -14,8 +14,8 @@ class KondutoOrder < KondutoBase
   attributes :id, :visitor, :timestamp, :total_amount, :tax_amount, :currency, :installments,
              :ip, :score, :analyze, :messages_exchanged, :shipping_amount
 
-  attribute first_message: :date_time
-  attribute purchased_at: :date_time
+  attribute first_message: :date_time, strftime_pattern: '%Y-%m-%dT%H:%M:%SZ'
+  attribute purchased_at: :date_time, strftime_pattern: '%Y-%m-%dT%H:%M:%SZ'
   attribute status: :symbol
   attribute recommendation: :symbol
 

data/lib/konduto-ruby/konduto_travel_leg.rb

@@ -1,5 +1,5 @@
 class KondutoTravelLeg < KondutoBase
   attributes :number_of_connections, :fare_basis
-  attribute date: :date
+  attribute date: :date_time
   attribute klass: :symbol
 end

data/lib/konduto-ruby/validations/class_methods.rb

@@ -1,14 +1,16 @@
-module ClassMethods
-  def validates_presence_of(*attributes)
-    self.send(:define_method, :required_attr) do
-      attributes
+module Konduto
+  module ClassMethods
+    def validates_presence_of(*attributes)
+      self.send(:define_method, :required_attr) do
+        attributes
+      end
     end
-  end
 
-  def validates(*attributes, &block)
-    if block_given?
-      self.send(:define_method, :custom_validations) do
-        { Proc.new(&block) => attributes }
+    def validates(*attributes, &block)
+      if block_given?
+        self.send(:define_method, :custom_validations) do
+          { Proc.new(&block) => attributes }
+        end
       end
     end
   end

data/lib/konduto-ruby/validations/validations.rb

@@ -4,7 +4,7 @@ module Konduto
   module Validations
     def self.included(base)
       base.class_eval do
-        extend ClassMethods
+        extend Konduto::ClassMethods
       end
     end
 
@@ -12,7 +12,6 @@ module Konduto
       if respond_to? :required_attr
         required_attr.each do |attr|
           return false if send(attr).nil?
-          return false if send(attr).is_a?(Array) && send(attr).empty?
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konduto-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Gabriel Custodio
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2018-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.10'
 description: A wrapper for konduto antifraud API
 email:
 - gcmartins93@gmail.com jonathancardosodecampos@gmail.com
@@ -45,7 +45,7 @@ files:
 - lib/konduto-ruby/konduto_geolocation.rb
 - lib/konduto-ruby/konduto_item.rb
 - lib/konduto-ruby/konduto_loyalty.rb
-- lib/konduto-ruby/konduto_navigation_info.rb
+- lib/konduto-ruby/konduto_navigation.rb
 - lib/konduto-ruby/konduto_order.rb
 - lib/konduto-ruby/konduto_order_status.rb
 - lib/konduto-ruby/konduto_passenger.rb
@@ -77,9 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: This project aims to help ruby users of konduto API by offering a easy to
-  use interface
+summary: Konduto Ruby SDK
 test_files: []