konduto-ruby 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d1bbfcf9c8de674af2c94ae36cb389533e433a8
-  data.tar.gz: d54dc74d9e525e5c88a00f330bd1417c965d0bbd
+  metadata.gz: 2e6c731cc451c876728e72d78c83d3ad377594e8
+  data.tar.gz: e23494d79a6eb309cd9df9559ce6fa23b90568e1
 SHA512:
-  metadata.gz: 023c74c910075008db964a84d25761a28ad905f5dacc88c417b94398e51959480ada84d53e878ac1c205b3b3cdcd7558e52f884f1fd5bd8e2229721e78ffe265
-  data.tar.gz: 67ae56a33a059d4c53ae1e82c9ba0f60e512ca2d4ed89ac6c0e33ea8ce9479d736712de13f946952d1e02757a8fa51e3484be61843aa5a17c4c843218214dce2
+  metadata.gz: c91ec72c7626b8825d3253b53ffa492ae3b4871046a6f22746d8f9d5c2a1f473dab2f964e31d3b6b0b37676f900cc406c0dbc57cebb2bd429d96d1f738998b1b
+  data.tar.gz: a0dd0e4746672156586de32a7744e1342e10872f0736d4fed1712796ae936b5766af6f9f1b97bdbb1e7d4f78eeddfeed2e2cbc2c3317723390d4527211716c47

data/README.md

@@ -0,0 +1,236 @@
+## 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.
+
+## Intro
+
+Welcome! This document will explain how to integrate with Konduto's anti-fraud service so you can begin to spot fraud on your e-commerce website.
+
+Our service uses the visitor's behavior to analyze browsing patterns and detect fraud. You will need to add a **JavaScript** snippet to your website and tag your pages, so we can see your visitors, and call our **REST API** to send purchases, so we can analyze them.
+
+This document refers to the **Ruby SDK** used for our API.
+
+## Requirements
+
+* This API was tested with Ruby MRI version 2.
+
+## Installation
+
+To get started add Konduto's gem as a dependency in your **Gemfile**:
+
+    gem 'konduto-ruby'
+
+After that, run **bundle install**. If your are not using a Gemfile, run the following command
+
+    $ gem install konduto-ruby
+
+## Getting Started
+
+When a customer makes a purchase you must send the order information to us so we can analyze it. We perform a real-time analysis and return you a **recommendation** of what to do next and a score, a numeric confidence level about that order.
+
+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.
+
+```ruby
+# creates a Konduto instance, which is a class that communicates with our API by using HTTP methods.
+konduto = KondutoRuby.new('T738D516F09CAB3A2C1EE') # T738D516F09CAB3A2C1EE is the API key
+```
+
+## Creating an order
+
+`KondutoOrder` is a class that models the attributes and behavior of an order.
+
+All entities involved in Konduto's analysis process (e.g customer, shopping cart, payment, etc.) inherit
+from KondutoBase and you can get access to them by calling their name and passing a hash of attributes, as shown below.
+
+```ruby
+order = KondutoOrder.new({
+          id: '123',
+          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
+order = KondutoOrder.new
+order.id = "123"
+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.
+>
+
+### 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.
+
+#### 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.
+
+
+#### 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.
+
+
+#### 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)
+
+
+#### 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)
+
+
+#### 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.
+
+### Seller
+
+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.
+
+After creating the order, sending it to Konduto's analysis is very simple.
+
+```ruby
+if order.valid?
+  begin
+    konduto.analyze(order);
+    # A RuntimeError will be thrown if the response is anything other than 200 OK.
+  rescue RuntimeError => e
+    # Put any exception handling here.
+    p e.message
+  end
+else
+  p order.errors.messages
+end
+```
+
+Notice that if the analysis fails, a **RuntimError** will be thrown. Handle it as you wish.
+
+After the analysis, some order attributes will be filled. For example the recommendation.
+
+```ruby
+# The command below should print something like "Konduto recommendation is to APPROVE".
+p "Konduto recommendation is to: #{order.recommendation}";
+```
+
+## Querying an order from our servers.
+
+In order to do that use the Konduto class in the following way:
+
+```ruby
+order = konduto.get_order order_id # orderId is a String
+```
+
+## Updating an order status
+
+```ruby
+# the order status will be set to newStatus if the request succeeds.
+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.
+
+## 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
+konduto = KondutoRuby.new(API_KEY)
+konduto.proxy = 'http://server-ip:port/'
+# Or, using username and password
+konduto.proxy = 'http://USERNAME:PASSWORD@proxy-server:port/'
+# use Konduto's API as usual
+konduto.get_order(ORDER_ID)
+```
+
+## Reference Tables
+
+Please [click here](http://docs.konduto.com/#n-tables) for the Currency and Category reference tables.
+
+## Troubleshooting
+
+If you experience problems sending orders for analysis, querying orders or updating order status, it might be a good idea
+to call `konduto.debug()`. This will print out the API Key, the endpoint, ~~the request body and the response body~~.
+
+## Support
+
+Feel free to end us a feedback via email or open an issue if you have some doubts or find out bugs. You can also contact konduto's [support team](mailto:support@konduto.com) if you have any questions or suggestions!

data/lib/konduto-ruby.rb

@@ -1,9 +1,11 @@
+require 'json'
+require 'konduto-ruby/konduto_base'
+Dir[__dir__ + '/konduto-ruby/*.rb'].each { |file| require file }
+
 class KondutoRuby
-  require 'json'
   require 'uri'
   require 'base64'
   require 'net/http'
-  require 'konduto-ruby/konduto_order'
   attr_accessor :request_body, :response_body, :endpoint
   attr_reader :api_key
 
@@ -98,4 +100,8 @@ class KondutoRuby
       raise (JSON.parse(response.body)['message']).to_s
     end
   end
+
+  def debug
+    "API Key: #{@api_key}\nEndpoint: #{@endpoint}\n"
+  end
 end

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

@@ -0,0 +1,51 @@
+module Konduto
+  module Associations
+
+    def has_one(model, options = {})
+      name = options[:alias] || model
+
+      self.send(:define_method, name) do
+        instance_variable_get("@#{name}")
+      end
+
+      self.send(:define_method, "#{name}=".to_sym) do |value|
+        klass = "Konduto#{model.to_s.gsub(/_/, ' ').split.map(&:capitalize).join('')}"
+
+        if value.class.to_s == klass
+          instance_variable_set("@#{name}", value)
+        elsif value.is_a? Hash
+          instance_variable_set("@#{name}", Object::const_get(klass).new(value))
+        else
+          raise ArgumentError, "Expected class #{klass}, got #{value.class} at #{self.class}"
+        end
+      end
+    end
+
+    def has_many(model, options = {})
+      name = options[:alias] || model
+
+      self.send(:define_method, name) do
+        instance_variable_set("@#{name}", []) if instance_variable_get("@#{name}").nil?
+
+        instance_variable_get("@#{name}")
+      end
+
+      self.send(:define_method, "#{name}=".to_sym) do |arr|
+        klass = "Konduto#{model.to_s.gsub(/_/, ' ').split.map(&:capitalize).join('')}"
+        temp_arr = []
+
+        arr.each do |value|
+          if value.class.to_s == klass
+            temp_arr << value
+          elsif value.is_a? Hash
+            temp_arr << Object::const_get(klass).new(value)
+          else
+            raise ArgumentError, "Expected class #{klass}, got #{value.class} at #{self.class}"
+          end
+        end
+
+        instance_variable_set("@#{name}", temp_arr)
+      end
+    end
+  end
+end

data/lib/konduto-ruby/attributes.rb

@@ -0,0 +1,32 @@
+module Konduto
+  module Attributes
+    def attributes(*attributes)
+      attributes.each do |attribute|
+        if attribute.is_a? Hash
+          klass = attribute.values[0].to_s.gsub(/_/, ' ').split.map(&:capitalize).join('')
+          type = Object::const_get(klass)
+          name = attribute.keys[0]
+        else
+          name = attribute
+        end
+
+        self.send(:define_method, "#{name}=".to_sym) do |value|
+          unless type.nil?
+            if value.is_a?(String)
+              value = type.parse(value) if type == Date || type == DateTime
+              value = value.to_sym if type == Symbol
+            end
+          end
+
+          instance_variable_set("@#{name.to_s.gsub(/[?|!]$/, '')}", value)
+        end
+
+        self.send(:define_method, name) do
+          instance_variable_get("@#{name.to_s.gsub(/[?|!]$/, '')}")
+        end
+      end
+    end
+
+    alias :attribute :attributes
+  end
+end

data/lib/konduto-ruby/konduto_address.rb

@@ -1,28 +1,3 @@
-class KondutoAddress
-  attr_accessor :name, :address1, :address2, :city, :state, :country, :zip
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        name: self.name,
-        address1: self.address1,
-        address2: self.address2,
-        city: self.city,
-        state: self.state,
-        country: self.country,
-        zip: self.zip
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+class KondutoAddress < KondutoBase
+  attributes :name, :address1, :address2, :zip, :city, :state, :country
 end

data/lib/konduto-ruby/konduto_base.rb

@@ -0,0 +1,56 @@
+require_relative 'associations/associations'
+require_relative 'validations/validations'
+require_relative 'attributes'
+
+class KondutoBase
+  extend Konduto::Associations
+  extend Konduto::Attributes
+  include Konduto::Validations
+
+  def initialize(*args)
+    unless args[0].nil?
+      args[0].each do |key, value|
+        unless value.nil?
+          if respond_to? "#{key}=".to_sym
+            send("#{key}=", value)
+          elsif key == 'class'
+            send('klass=', value)
+          else
+            instance_variable_set("@#{key}", value)
+          end
+        end
+      end
+    end
+  end
+
+  def to_hash
+    Hash[
+      instance_variables.map do |name|
+        value = instance_variable_get(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)
+          value = value.to_s
+        end
+
+        [name == :@klass ? 'class' : name.to_s.gsub(/^@/, ''), value]
+      end
+    ]
+  end
+
+  def to_json
+    raise RuntimeError, 'Invalid object for serialization' unless self.valid?
+    self.to_hash.to_json
+  end
+
+  def ==(other)
+    self.instance_variables.each do |name|
+      return false unless self.instance_variable_get(name) == other.instance_variable_get(name)
+    end
+
+    true
+  end
+end

data/lib/konduto-ruby/konduto_bus_leg.rb

@@ -0,0 +1,4 @@
+class KondutoBusLeg < KondutoTravelLeg
+  attributes :origin_city, :destination_city
+  validates_presence_of :origin_city, :destination_city
+end

data/lib/konduto-ruby/konduto_customer.rb

@@ -1,31 +1,6 @@
-class KondutoCustomer
-  attr_accessor :id, :name, :email, :dob, :tax_id, :phone1, :phone2, :created_at, :new, :vip
+class KondutoCustomer < KondutoBase
+  attributes :id, :name, :email, :new?, :vip?, :phone1, :phone2, :tax_id
+  attribute created_at: :date
 
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        id: self.id,
-        name: self.name,
-        email: self.email,
-        dob: self.dob,
-        tax_id: self.tax_id,
-        phone1: self.phone1,
-        phone2: self.phone2,
-        created_at: self.created_at,
-        new: self.new,
-        vip: self.vip
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+  validates_presence_of :id, :name, :email
 end

data/lib/konduto-ruby/konduto_device.rb

@@ -1,31 +1,4 @@
-class KondutoDevice
-  attr_accessor :user_id, :fingerprint, :platform, :browser, :language, :timezone, :cookie, :javascript, :flash, :ip
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        user_id: self.user_id,
-        fingerprint: self.fingerprint,
-        platform: self.platform,
-        browser: self.browser,
-        language: self.language,
-        timezone: self.timezone,
-        cookie: self.cookie,
-        javascript: self.javascript,
-        flash: self.flash,
-        ip: self.ip
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+class KondutoDevice < KondutoBase
+  attributes :user_id, :fingerprint, :platform, :browser, :language, :timezone, \
+             :cookie, :javascript, :flash, :ip
 end

data/lib/konduto-ruby/konduto_flight_leg.rb

@@ -0,0 +1,8 @@
+class KondutoFlightLeg < KondutoTravelLeg
+  attributes :origin_airport, :origin_city, :destination_airport, :destination_city
+  validates_presence_of :origin_airport, :destination_airport
+
+  validates(:origin_airport, :destination_airport) do |attr|
+    attr.match(/[a-zA-Z]{3}/)
+  end
+end

data/lib/konduto-ruby/konduto_geolocation.rb

@@ -1,24 +1,3 @@
-class KondutoGeolocation
-  attr_accessor :city, :state, :country
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        city: self.city,
-        state: self.state,
-        country: self.country
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+class KondutoGeolocation < KondutoBase
+  attributes :city, :state, :country
 end

data/lib/konduto-ruby/konduto_item.rb

@@ -1,30 +1,4 @@
-class KondutoItem
-  attr_accessor :sku, :category, :name, :description, :product_code, :unit_cost, :quantity, :discount, :created_at
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        sku: self.sku,
-        category: self.category,
-        name: self.name,
-        description: self.description,
-        product_code: self.product_code,
-        unit_cost: self.unit_cost,
-        quantity: self.quantity,
-        discount: self.discount,
-        created_at: self.created_at
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+class KondutoItem < KondutoBase
+  attributes :sku, :category, :name, :description, :product_code, :unit_cost, :quantity, :discount
+  attribute created_at: :date
 end

data/lib/konduto-ruby/konduto_loyalty.rb

@@ -1,23 +1,3 @@
-class KondutoLoyalty
-  attr_accessor :program, :category
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        program: self.program,
-        category: self.category
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+class KondutoLoyalty < KondutoBase
+  attributes :program, :category
 end

data/lib/konduto-ruby/konduto_navigation_info.rb

@@ -0,0 +1,5 @@
+class KondutoNavigationInfo < 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
+end

data/lib/konduto-ruby/konduto_order.rb

@@ -1,153 +1,23 @@
-class KondutoOrder
-  require 'konduto-ruby/konduto_address'
-  require 'konduto-ruby/konduto_customer'
-  require 'konduto-ruby/konduto_device'
-  require 'konduto-ruby/konduto_geolocation'
-  require 'konduto-ruby/konduto_item'
-  require 'konduto-ruby/konduto_loyalty'
-  require 'konduto-ruby/konduto_navigation'
-  require 'konduto-ruby/konduto_order_status'
-  require 'konduto-ruby/konduto_passenger'
-  require 'konduto-ruby/konduto_payment'
-  require 'konduto-ruby/konduto_seller'
-  require 'konduto-ruby/konduto_travel'
-  require 'konduto-ruby/konduto_travel_info'
-  require 'konduto-ruby/konduto_utils'
-
-  attr_accessor :id, :visitor, :timestamp, :total_amount, :shipping_amount, :tax_amount, :customer, :currency, \
-                :installments, :ip, :score, :shipping_address, :billing_address, :recommendation, :status, \
-                :geolocation, :analyze, :messages_enchanged, :first_message, :purchased_at, :seller, :payment, \
-                :shopping_cart, :device, :navigation, :travel
-
-  def initialize(*args)
-    params = args[0]
-    self.shopping_cart = []
-    self.payment = []
-    if params.nil?
-      self.shipping_address = KondutoAddress.new
-      self.billing_address = KondutoAddress.new
-      self.customer = KondutoCustomer.new
-      self.seller = KondutoSeller.new
-      self.travel = KondutoTravel.new
-      self.device = KondutoDevice.new
-      self.geolocation = KondutoGeolocation.new
-      self.navigation = KondutoNavigation.new
-    else
-      params = KondutoUtils.deep_symbolize_keys params
-      if params[shipping_address].nil?
-        self.shipping_address = KondutoAddress.new
-      else
-        self.shipping_address = KondutoAddress.new params[:shipping_address]
-        params.delete :shipping_address
-      end
-
-      if params[:billing_address].nil?
-        self.billing_address = KondutoAddress.new
-      else
-        self.billing_address = KondutoAddress.new params[:billing_address]
-        params.delete :billing_address
-      end
-
-      if params[:customer].nil?
-        self.customer = KondutoCustomer.new
-      else
-        self.customer = KondutoCustomer.new params[:customer]
-        params.delete :customer
-      end
-
-      if params[:seller].nil?
-        self.seller = KondutoSeller.new
-      else
-        self.seller = KondutoSeller.new params[:seller]
-        params.delete :seller
-      end
-
-      if params[:travel].nil?
-        self.travel = KondutoTravel.new
-      else
-        self.travel = KondutoTravel.new params[:travel]
-        params.delete :travel
-      end
-
-      if params[:device].nil?
-        self.device = KondutoDevice.new
-      else
-        self.device = KondutoDevice.new params[:device]
-        params.delete :device
-      end
-
-      if params[:geolocation].nil?
-        self.geolocation = KondutoGeolocation.new
-      else
-        self.geolocation = KondutoGeolocation.new params[:geolocation]
-        params.delete :geolocation
-      end
-
-      if params[:navigation].nil?
-        self.navigation = KondutoNavigation.new
-      else
-        self.navigation = KondutoNavigation.new params[:navigation]
-        params.delete :navigation
-      end
-
-      unless params[:payment].nil? || params[:payment].empty?
-        params[:payment].each do |p|
-          self.payment << KondutoPayment.new(p)
-        end
-        params.delete :payment
-      end
-
-      unless params[:shopping_cart].nil? || params[:shopping_cart].empty?
-        params[:shopping_cart].each do |i|
-          self.shopping_cart << KondutoItem.new(i)
-        end
-        params.delete :shopping_cart
-      end
-
-      params.each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def add_item (product)
-    self.shopping_cart << product
-  end
-
-  def add_payment (payment)
-    self.payment << payment
-  end
-
-  def to_hash
-    hash = {
-        id:self.id,
-        visitor:self.visitor,
-        total_amount:self.total_amount,
-        shipping_amount:self.shipping_amount,
-        tax_amount:self.tax_amount,
-        currency:self.currency,
-        installments:self.installments,
-        ip:self.ip,
-        first_message:self.first_message,
-        messages_exchanged:self.messages_enchanged,
-        purchased_at:self.purchased_at,
-        analyze:self.analyze,
-        customer:self.customer.to_hash,
-        payment: KondutoUtils.array_to_hash(self.payment),
-        billing:self.billing_address.to_hash,
-        shipping:self.shipping_address.to_hash,
-        shopping_cart:KondutoUtils.array_to_hash(self.shopping_cart),
-        travel:self.travel.to_hash,
-        seller:self.seller.to_hash,
-        device:self.device.to_hash,
-        geolocation:self.geolocation.to_hash,
-        navigation:self.navigation.to_hash
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
-
+class KondutoOrder < KondutoBase
+  has_many :item, alias: :shopping_cart
+  has_many :payment
+
+  has_one :address, alias: :shipping
+  has_one :address, alias: :billing
+  has_one :customer
+  has_one :seller
+  has_one :travel
+  has_one :device
+  has_one :geolocation
+  has_one :navigation
+
+  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 status: :symbol
+  attribute recommendation: :symbol
+
+  validates_presence_of :id, :total_amount, :customer
 end

data/lib/konduto-ruby/konduto_order_status.rb

@@ -1,26 +1,7 @@
-class KondutoOrderStatus
-  attr_accessor :status, :comments
+class KondutoOrderStatus < KondutoBase
+  attributes :status, :comments
 
   def self.allowed_status
     %w(APPROVED DECLINED NOT_AUTHORIZED CANCELLED FRAUD)
   end
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        status: self.status,
-        comments: self.comments
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
 end

data/lib/konduto-ruby/konduto_passenger.rb

@@ -1,40 +1,12 @@
-class KondutoPassenger
-  require 'konduto-ruby/konduto_loyalty'
+class KondutoPassenger < KondutoBase
+  attributes :name, :document, :nationality, :frequent_traveler, :special_needs, \
+             :loyalty, :loyalty_program, :loyalty_category
+  attribute dob: :date
+  attribute document_type: :symbol
 
-  attr_accessor :name, :document, :document_type, :dob, :nationality, :frequent_traveller, :special_needs, :loyalty
+  validates_presence_of :name, :document, :document_type, :nationality
 
-  TYPE_DOCUMENT = [:passport, :id]
-  def initialize(*args)
-    if args[0].nil?
-      self.loyalty = KondutoLoyalty.new
-    else
-      if args[0][:loyalty].nil?
-        self.loyalty = KondutoLoyalty.new
-      else
-        self.loyalty = KondutoLoyalty.new args[0][:loyalty]
-        args[0].delete :loyalty
-      end
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        name: self.name,
-        document: self.document,
-        document_type: self.document_type,
-        dob: self.dob,
-        nationality: self.nationality,
-        frequent_traveller: self.frequent_traveller,
-        special_needs: self.special_needs,
-        loyalty: self.loyalty.to_hash
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
+  validates(:nationality) do |attr|
+    attr.match(/[a-zA-Z]{2}/)
   end
 end

data/lib/konduto-ruby/konduto_payment.rb

@@ -1,29 +1,8 @@
-class KondutoPayment
-  attr_accessor :type, :status, :bin, :last4, :expiration_date
+class KondutoPayment < KondutoBase
+  attributes :expiration_date, :bin, :last4
+  attribute type: :symbol
+  attribute status: :symbol
 
   TYPE_PAYMENT = [:credit, :boleto, :debit, :transfer, :voucher]
   TYPE_STATUS = [:approved, :declined, :pending]
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        type: self.type,
-        status: self.status,
-        bin: self.bin,
-        last4: self.last4,
-        expiration_date: self.expiration_date
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
 end

data/lib/konduto-ruby/konduto_seller.rb

@@ -1,24 +1,4 @@
-class KondutoSeller
-  attr_accessor :id, :name, :created_at
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        id: self.id,
-        name: self.name,
-        created_at: self.created_at
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+class KondutoSeller < KondutoBase
+  attributes :id, :name
+  attribute created_at: :date
 end

data/lib/konduto-ruby/konduto_travel.rb

@@ -1,51 +1,9 @@
-class KondutoTravel
-  require 'konduto-ruby/konduto_travel_info'
-  require 'konduto-ruby/konduto_passenger'
-  require 'konduto-ruby/konduto_utils'
-  attr_accessor :type, :departure, :return, :passengers
-  TYPE_TRAVEL = [:flight, :bus]
+class KondutoTravel < KondutoBase
+  has_one :flight_leg, alias: :departure
+  has_one :flight_leg, alias: :return
+  has_many :passenger, alias: :passengers
 
-  def initialize(*args)
-    self.passengers = []
+  attribute type: :symbol
 
-    if args[0].nil?
-      self.departure = KondutoTravelInfo.new
-      self.return = KondutoTravelInfo.new
-    else
-      if args[0][:departure].nil?
-        self.departure = KondutoTravelInfo.new
-      else
-        self.departure = KondutoTravelInfo.new args[0][:departure]
-        args[0].delete :departure
-      end
-      if args[0][:return].nil?
-        self.return = KondutoTravelInfo.new
-      else
-        self.return = KondutoTravelInfo.new args[0][:return]
-        args[0].delete :return
-      end
-
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def add_passenger (passenger)
-    self.passengers << passenger
-  end
-
-  def to_hash
-    hash = {
-        type: self.type,
-        departure: self.departure.to_hash,
-        return: self.return.to_hash,
-        passengers: KondutoUtils.array_to_hash(self.passengers)
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
+  validates_presence_of :type, :departure, :passengers
 end

data/lib/konduto-ruby/konduto_travel_info.rb

@@ -1,27 +1,6 @@
-class KondutoTravelInfo
-  attr_accessor :date, :number_of_connections, :class, :fare_basis
+class KondutoTravelInfo < KondutoBase
+  attributes :number_of_connections, :class, :fare_basis
+  attribute date: :date
 
   TRAVEL_CLASS = [:economy, :business, :first]
-
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        date: self.date,
-        number_of_connections: self.number_of_connections,
-        class: self.class,
-        fare_basis: self.fare_basis
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
 end

data/lib/konduto-ruby/konduto_travel_leg.rb

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

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

@@ -0,0 +1,15 @@
+module ClassMethods
+  def validates_presence_of(*attributes)
+    self.send(:define_method, :required_attr) do
+      attributes
+    end
+  end
+
+  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

@@ -0,0 +1,28 @@
+require_relative 'class_methods'
+
+module Konduto
+  module Validations
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    def valid?
+      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
+
+      if respond_to? :custom_validations
+        custom_validations.each do |block, attrs|
+          attrs.each { |attr| return false unless block.call(send(attr)) } if attrs.is_a? Array
+        end
+      end
+
+      true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konduto-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Gabriel Custodio
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
-dependencies: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 description: A wrapper for konduto antifraud API
 email:
 - gcmartins93@gmail.com jonathancardosodecampos@gmail.com
@@ -18,14 +32,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/konduto-ruby.rb
+- lib/konduto-ruby/associations/associations.rb
+- lib/konduto-ruby/attributes.rb
 - lib/konduto-ruby/konduto_address.rb
+- lib/konduto-ruby/konduto_base.rb
+- lib/konduto-ruby/konduto_bus_leg.rb
 - lib/konduto-ruby/konduto_customer.rb
 - lib/konduto-ruby/konduto_device.rb
+- lib/konduto-ruby/konduto_flight_leg.rb
 - lib/konduto-ruby/konduto_geolocation.rb
 - lib/konduto-ruby/konduto_item.rb
 - lib/konduto-ruby/konduto_loyalty.rb
-- lib/konduto-ruby/konduto_navigation.rb
+- lib/konduto-ruby/konduto_navigation_info.rb
 - lib/konduto-ruby/konduto_order.rb
 - lib/konduto-ruby/konduto_order_status.rb
 - lib/konduto-ruby/konduto_passenger.rb
@@ -33,7 +53,10 @@ files:
 - lib/konduto-ruby/konduto_seller.rb
 - lib/konduto-ruby/konduto_travel.rb
 - lib/konduto-ruby/konduto_travel_info.rb
+- lib/konduto-ruby/konduto_travel_leg.rb
 - lib/konduto-ruby/konduto_utils.rb
+- lib/konduto-ruby/validations/class_methods.rb
+- lib/konduto-ruby/validations/validations.rb
 homepage: https://github.com/jonathan0211/konduto-ruby
 licenses:
 - MIT
@@ -57,5 +80,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: ''
+summary: This project aims to help ruby users of konduto API by offering a easy to
+  use interface
 test_files: []

data/lib/konduto-ruby/konduto_navigation.rb

@@ -1,37 +0,0 @@
-class KondutoNavigation
-  attr_accessor :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
-  def initialize(*args)
-    unless args[0].nil?
-      args[0].each do |k,v|
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-    end
-  end
-
-  def to_hash
-    hash = {
-        session_time: self.session_time,
-        referrer: self.referrer,
-        time_site_1d: self.time_site_1d,
-        new_accounts_1d: self.new_accounts_1d,
-        password_resets_1d: self.password_resets_1d,
-        sales_declined_1d: self.sales_declined_1d,
-        sessions_1d: self.sessions_1d,
-        time_since_last_sale: self.time_since_last_sale,
-        time_site_7d: self.time_site_7d,
-        time_per_page_7d: self.time_per_page_7d,
-        new_accounts_7d: self.new_accounts_7d,
-        password_resets_7d: self.password_resets_7d,
-        checkout_count_7d: self.checkout_count_7d,
-        sales_declined_7d: self.sales_declined_7d,
-        sessions_7d: self.sessions_7d,
-    }
-    KondutoUtils.remove_nil_keys_from_hash(hash)
-  end
-
-  def to_json
-    self.to_hash.to_json
-  end
-end