trustev 0.3.2 → 0.4.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e9a776e416ec41456e29afd91623c31bb0c6ca9
-  data.tar.gz: c05ff41e28b2471d362f10c11064f1ebcab1091b
+  metadata.gz: 7d80eedb1e622b67a06154a915d1afe37a2e8f23
+  data.tar.gz: 934015dc9d7fdbf540e65aa1d29113a9eb9a3876
 SHA512:
-  metadata.gz: 5ca4704b5609dbc04abccfced2121caaeed7c803f76adfeacbc3915b4df75debe7c9b152092d2e38a34f3c4d6743b625340dfb2e575e9f15bf9ef23b3d1c4a84
-  data.tar.gz: 7d27c2a3e56052f58c30e158b4e00735d8f34ea31a55a140107d2592438ec6f47431edb10a13185860841f13856c1b5cf8f39fc294f95caff92172d92e9156ca
+  metadata.gz: 87c4044fcaa0aa35377fd9e0af4ed11577ff1c28062ce984bb3523fa0200a50dadc19610dd68d714754ba6684572769bda171ae185abfeecb14dfa9c5eb92e27
+  data.tar.gz: 9383f68be6fd2a3e51239c24ee6ec8a29ee213b44ae5ab34c940058266a33b2a56d382c5521608ac82f8c8222fefdc146472bab975679809fa6bed2e771dc09e

data/README.md

@@ -5,337 +5,11 @@ Ruby wrapper for Trustev API
 [![Gem Version](https://badge.fury.io/rb/trustev.svg)](http://badge.fury.io/rb/trustev)
 ![Codeship](https://codeship.com/projects/1e231930-5253-0132-d3ec-72279d09a1d7/status?branch=master)
 
-## Installation
+# Documentation
 
-Add this line to your application's Gemfile:
+See [the wiki](https://github.com/giftcardzen/trustev/wiki) for documentation.
 
-```ruby
-gem 'trustev'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install trustev
-
-## Configuration
- Set the following options
- ```ruby
- # This is your Trustev Site Username (NOTE: different from Reliance Login Username).
- # It is available under the ‘View API Keys’ section of Reliance.
- Trustev.username = 'username'
- # This is your Trustev Site Password (NOTE: different from Reliance Login Password).
- Trustev.password = 'password'
- # This is your Trustev Site Shared Secret, available from Reliance.
- Trustev.shared_secret = '0f0f0f0f'
- #This is your Trustev Site Private Key, available from Reliance.
- Trustev.private_key = 'ffffffff'
- #This is your Trustev Site Public Key, available from Reliance.
- # This parameter is OPTIONAL, but if you do NOT include it, `Trustev::DigitalSignature.valid?`
- # will return FALSE if Trustev's servers are inaccessible
- Trustev.public_key = 'f0f0f0f0'
- ```
-
-## Usage
-
-For more information on the parameters referenced below, see the [trustev API documentation](http://developers.trustev.com/#addtransaction)
-
-### Authentication
-
-Authentication is handled automatically. You never have to request an authentication token manually.
-
-### Validation of Digital Signature
-
-```ruby
- # digital_signature = Trustev::DigitalSignature.new(digital_signature, timestamp, session_id, stage_1)
- # digital_signature.valid?
- # or
- # digital_signature.invalid?
- digital_signature = Trustev::DigitalSignature.new('ae5b0c9ea554fed8080457debed0cccf832c183b3fa7794b497f5492e98a74a2',
-                                                  20141028163912,
-                                                  'f39767e2-0cb5-hk97-a296-4619c269d59d',
-                                                  '123456.joe@bloggs.com')
- digital_signature.valid? # true
- digital_signature.invalid? # false
-```
-
-### Transaction
-
-#### Create a new transaction
-
-Only the following fields are required:
-* transaction_number
-* transaction_data.currency
-* transaction_data.total_transaction_value
-* transaction_data.timestamp
-* customer
-```ruby
- transaction = Trustev::Transaction.new('1234abcd')
- transaction.create(
-   {
-     social_network: {
-       type: Trustev::SOCIAL_NETWORK_TYPES[:facebook],
-       id: '12345678'
-     },
-     transaction_data: {
-       currency_code: 'EUR',
-       total_delivery: 10.0,
-       total_before_tax: 40,
-       total_discount: 10,
-       total_tax: 10,
-       total_transaction_value: 50.00,
-       timestamp: 1391449224000,
-       address: [
-         {
-           type: Trustev::ADDRESS_TYPES[:standard],
-           first_name: 'Joe',
-           last_name: 'Bloggs',
-           address_1: '2011',
-           address_2: 'Imaginary Way',
-           address_3: '',
-           city: 'Anycity',
-           state: 'AnyState',
-           postal_code: '123456',
-           country_code: 'US'
-         }
-       ],
-       item: [
-         {
-           name: 'T-Shirt',
-           url: 'T-shirts.com',
-           image_url: 'T-shirts.com/Trustev-T-Shirt',
-           quantity: 1,
-           total_before_tax: 40.0,
-           total_discount: 0.0,
-           total_tax: 10,
-           total_item_value: 50.0
-         }
-       ]
-     },
-     customer: {
-       first_name: 'John',
-       last_name: 'Doe',
-       phone_number: '00353861658789',
-       date_of_birth: 1403256280325,
-       email: [
-         {
-           is_default: true,
-           email_address: "jondoe@mail.com"
-         }
-       ],
-       address: [
-         {
-           type: Trustev::ADDRESS_TYPES[:standard],
-           first_name: 'Joe',
-           last_name: 'Bloggs',
-           address_1: '2011',
-           address_2: 'Imaginary Way',
-           address_3: '',
-           city: 'Anycity',
-           state: 'AnyState',
-           postal_code: '123456',
-           country_code: 'US',
-           is_default: true
-         }
-       ]
-     },
-     session_id: 'f39767e2-0cb5-hk97-a296-4619c269d59d'
-   }
- )
-```
- 
-#### Update an existing transaction
-
-This takes the same parameters as `Trustev::transaction.create` 
-```ruby
- transaction = Trustev::Transaction.new('1234abcd')
- transaction.update({...})
-```
-
-#### Set transaction status
-
-```ruby
- # transaction.set_status(status, reason, comment)
- transaction = Trustev::Transaction.new('1234abcd')
- transaction.set_status(Trustev::STATUS_TYPES[:refunded],
-                        Trustev::REASON_TYPES[:complaint],
-                        'Transaction was refunded due to a complaint')
-```
-
-| Status Code | Description |
-|-------------|-------------|
-| 0           | Init        |
-| 1           | Placed      |
-| 2           | Refunded    |
-| 3           | Rejected    |
-| 5           | Completed   |
-| 8           | Chargeback  |
-
-| Reason Code | Description |
-|-------------|-------------|
-| 0           | System      |
-| 1           | Fraud       |
-| 2           | Complaint   |
-| 3           | Remorse     |
-| 4           | Other       |
-
-Comment: This allows you to include and extra comment on the status of the transaction
-
-See the [trustev API documentation](http://developers.trustev.com/#addtransactionstatus) for up to date codes.
-
-#### Add transaction BIN
-
-```ruby
- # transaction.set_bin(bin, transaction_number)
- transaction = Trustev::Transaction.new('1234abcd')
- transaction.set_bin(123456)
-```
-
-### Social
-
-#### Add Social
-
-```ruby
- Trustev::Social.create([
-   {
-     type: Trustev::SOCIAL_NETWORK_TYPES[:facebook],
-     id: 780219323,
-     short_term_token: 'CAAGEIkkiTM4BAHR9ar4XH4uTqK6JaOF1aIGbCBrsQgocHUh9',
-     long_term_token: 'CAAGEIkkiTM4BAJyc0pMxQQAprOrNlMRODaVQgQtcvlNO7Rvab',
-     short_term_expiry: 1391448969000,
-     long_term_expiry: 1391449878000,
-     secret: '84bcd7da0e967139652f7ce90k4c859e'
-   }
- ])
-```
-
-| Social Network Type | Name     |
-|---------------------|----------|
-| 0                   | Facebook |
-| 1                   | Twitter  |
-| 2                   | Linkedin |
-| 3                   | Trustev  |
-
-See the [trustev API documentation](http://developers.trustev.com/#addprofile) for up to types.
-
-#### Update Social
-
-This is similar `Trustev::Social.create`, but only accepts ONE hash, instead of an array of hashes.
-```ruby
- Trustev::Social.update({
-   type: Trustev::SOCIAL_NETWORK_TYPES[:facebook],
-   id: 780219323,
-   short_term_token: 'CAAGEIkkiTM4BAHR9ar4XH4uTqK6JaOF1aIGbCBrsQgocHUh9',
-   long_term_token: 'CAAGEIkkiTM4BAJyc0pMxQQAprOrNlMRODaVQgQtcvlNO7Rvab',
-   short_term_expiry: 1391448969000,
-   long_term_expiry: 1391449878000,
-   secret: '84bcd7da0e967139652f7ce90k4c859e'
-  })
-```
-
-#### Delete Social
-```ruby
- # Trustev::Social.delete(social_network_type, social_network_id)
- Trustev::Social.delete(Trustev::SOCIAL_NETWORK_TYPES[:facebook], 780219323)
-``` 
-
-### Profile
-
-#### Retrieve Raw Scores
-```ruby
- # profile = Trustev::Profile.new(transaction_number)
- # profile.retrieve_scores
- profile = Trustev::Profile.new('1234abcd')
- profile.retrieve_scores
-```
-
-This returns a hash with the Trustev Score.
-
-###### Sample Response
-```ruby
- {
-   Code: 200,
-   Message: "Success",
-   Profile: {
-     Sources: [{
-         Scores: [{
-             Confidence : 100,
-             Parameter : 0,
-             Score : 73
-         }],
-         Source : 7
-     }]
-   }
- }
-```
-
-| Response Parameter   | Description                                                                                                                       |
-|----------------------|-----------------------------------------------------------------------------------------------------------------------------------|
-| Code (int)           | This will be a basic HTML response code                                                                                           |
-| Message (string)     | This will be a response string which should give your some basic information on the status of you response eg. “Success” or “NOK” |
-| Sources (array)      | This will be an array of Trustev Scores from different Trustev Sources                                                            |
-| Scores (array)       | This will be an array of Trustev Scores based on different Score parameters                                                       |
-| Confidence (decimal) | This will be a Trustev Confidence which outlines Trustev’s Condfidence in the score it has returned                               |
-| Parameter (int)      | This will be The Trustev parameter which the score is based on                                                                    |
-| Score (decimal)      | This is the Trustev Score                                                                                                         |
-| Source (int)         | This will be the TrustevProfile Score Source on which the Trustev Scores Array was based on                                       |
-
-#### Retrieve Overall Trustev score
-```ruby
- # profile = Trustev::Profile.new(transaction_number)
- # profile.get_overall_score
- profile = Trustev::Profile.new('1234abcd')
- profile.get_overall_score
-```
-
-This returns the overall Trustev score
-
-#### Retrieve A Specific score
-```ruby
- # profile = Trustev::Profile.new(transaction_number)
- # profile.get_score(source_id, parameter_id)
- profile = Trustev::Profile.new('1234abcd')
- profile.get_score(Trustev::SCORE_SOURCES[:trustev], Trustev::SCORE_PARAMETERS[:overall])
-```
-
-This returns a score from a specific source and parameter 
-
-| Score Source | Description |
-|--------------|-------------|
-| 0            | Address     |
-| 1            | Behavior    |
-| 2            | Device      |
-| 3            | Email       |
-| 4            | Facebook    |
-| 5            | IP          |
-| 6            | Transaction |
-| 7            | Trustev     |
-| 8            | Velocity    |
-
-| Parameter Code | Description |
-|----------------|-------------|
-| 0              | Overall     |
-| 1              | Billing     |
-| 2              | Delivery    |
-| 3              | Input       |
-| 4              | Domain      |
-| 5              | Address     |
-| 6              | IP          |
-| 7              | Proxy       |
-| 8              | VPN         |
-| 9              | Value       |
-| 10             | Velocity    |
-| 11             | Legitimacy  |
-| 12             | Pattern     |
-| 13             | Hustle      |
-
-See the [trustev API documentation](http://developers.trustev.com/#getprofile) for up to date response info.
-
-
-## Contributing
+# Contributing
 
 1. Fork it ( https://github.com/giftcardzen/trustev/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/Rakefile

@@ -2,7 +2,6 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList["test/#{ENV['TRUSTEV_VERSION']}/*_test.rb"]
   t.verbose = true
 end

data/lib/trustev.rb

@@ -1,13 +1,9 @@
 require 'httparty'
 require 'multi_json'
+require 'require_all'
 
 require 'trustev/version'
-require 'trustev/authenticate'
-require 'trustev/profile'
-require 'trustev/social'
-require 'trustev/transaction'
 require 'trustev/error'
-require 'trustev/digital_signature'
 
 module Trustev
   @@username = nil
@@ -15,11 +11,12 @@ module Trustev
   @@shared_secret = nil
   @@private_key = nil
   @@public_key = nil
-  @@api_base = 'https://api.trustev.com/v'
-  @@api_version = '1.2'
+  @@api_version = nil
   @@token = nil
   @@token_expire = nil
 
+  API_VERSIONS = %w(1.2 2.0)
+
   ADDRESS_TYPES = {
     standard: 0,
     billing: 1,
@@ -30,53 +27,8 @@ module Trustev
     facebook: 0,
     twitter: 1,
     linkedin: 2,
-    trustev: 3
-  }
-
-  STATUS_TYPES = {
-    init: 0,
-    placed: 1,
-    refunded: 2,
-    rejected: 3,
-    completed: 5,
-    chargeback: 8
-  }
-
-  REASON_TYPES = {
-    system: 0,
-    fraud: 1,
-    complaint: 2,
-    remorse: 3,
-    other: 4
-  }
-
-  SCORE_SOURCES = {
-    address: 0,
-    behaviour: 1,
-    device: 2,
-    email: 3,
-    facebook: 4,
-    IP: 5,
-    transaction: 6,
-    trustev: 7,
-    velocity: 8
-  }
-
-  SCORE_PARAMETERS = {
-    overall: 0,
-    billing: 1,
-    delivery: 2,
-    input: 3,
-    domain: 4,
-    address: 5,
-    IP: 6,
-    proxy: 7,
-    VPN: 8,
-    value: 9,
-    velocity: 10,
-    legitimacy: 11,
-    pattern: 12,
-    hustle: 13
+    trustev: 3,
+    trustev_session: 4
   }
 
   def self.username=(username)
@@ -139,27 +91,33 @@ module Trustev
     @@token_expire
   end
 
-  def self.send_request(path, body, method, expect_json=false, requires_token=true)
+  def self.api_version
+    @@api_version
+  end
 
-    if requires_token && invalid_token?
-      Authenticate.retrieve_token
-    end
+  def self.api_version=(api_version)
+    @@api_version = api_version
+    raise Error.new("API v#{api_version} not supported.") unless API_VERSIONS.include? api_version
+    require_rel "trustev/#{api_version}"
+  end
+
+  def self.do_send_request(path, body, method, expect_json=false, requires_token=true)
+    Authenticate.retrieve_token if requires_token && invalid_token?
 
     raise Error.new('Auth token missing or expired') if requires_token && invalid_token?
 
     headers = { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
     headers['X-Authorization'] = "#{@@username} #{@@token}" if requires_token
 
-    body = { request:  body }
-
     options = { body: body.to_json, headers: headers}
 
     response = HTTParty.post(api_url(path), options) if method == 'POST'
     response = HTTParty.get(api_url(path), options) if method == 'GET'
     response = HTTParty.put(api_url(path), options) if method == 'PUT'
     response = HTTParty.delete(api_url(path), options) if method == 'DELETE'
-
-    raise Error.new('Bad API response', response.code, response.message) if response.code != 200
+    if response.code != 200
+      raise_error response
+    end
 
     if expect_json
       begin
@@ -171,10 +129,4 @@ module Trustev
 
     response
   end
-
-  private
-
-  def self.invalid_token?
-    @@token.nil? || @@token_expire-600 <= Time.now.to_i
-  end
 end