fraudlabspro_ruby 3.2.1 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c39b62485c4d279227a862995de30a27026f2afc326518b39bdb2b038a6a6102
-  data.tar.gz: f00a218900ca763e2ed71df4aa3633097bf1ad72f0627dc55c90dc9dc97e8464
+  metadata.gz: 486c924794b9bc2cbc50600be9217de8b4ca7e6a8e4d4e13e8c6ac0e2d399772
+  data.tar.gz: ffcfc769d26491207132e6f982a49b7c4ec2d566d95b8944579bc20b2f7e65ea
 SHA512:
-  metadata.gz: 77d775dce9da4c15ffdbb6beea005000efee5a436cfbbe333f276d75f3362868d0f002f90a606be6669f0d3eeb4c0b15ccba4eb7b7b972b06aa48e80afc21765
-  data.tar.gz: 1009cef0466e73f615c4cfedf9920a0eb1cb0114baa2eae805aadf090d32bbe8b755f6a445387932802bd88b18327b069f095035f608b558bf241a7678dada0d
+  metadata.gz: eca6230b61d98b13b69e9ff1e80d304e983bbcc9276a66ebfcf736a09ec5852f99fd403a0086896b79617ee7586c000f0ceb61a0a2e09bb26f837769b4576ed7
+  data.tar.gz: f1dc37493073b91b1f48b4e906279b3b85346bc05376688a53a87cce2bdcd101f9ab125f7abcfc42c64ea7b4f79d3991ce1724b0c71555e6f8e65c4ec5b0a441

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 FraudLabsPro.com
+Copyright (c) 2024 FraudLabsPro.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -16,179 +16,8 @@ Below are the features of this Ruby module:
 
 This module requires API key to function. You may subscribe a free API key at https://www.fraudlabspro.com
 
-
-
-
-Usage Example
-============
-### Validate Order
-
-#### Object Properties
-
-| Property Name       | Property Type | Description                                                  |
-| ------------------- | ------------- | ------------------------------------------------------------ |
-| ip                  | string        | IP address of online transaction. It supports both IPv4 and IPv6 address format. |
-| first_name          | string        | User's first name.                                           |
-| last_name           | string        | User's last name.                                            |
-| username            | string        | User's username.                                             |
-| password            | string        | User's password.                                             |
-| email               | string        | User's email address.                                        |
-| phone               | string        | User's phone number.                                         |
-| bill_addr           | string        | Street address of billing address.                           |
-| bill_city           | string        | City of billing address.                                     |
-| bill_state          | string        | State of billing address. It supports state codes, e.g. NY (New York), for state or province of United States or Canada. Please refer to [State & Province Codes](https://www.fraudlabspro.com/developer/reference/state-and-province-codes) for complete list. |
-| bill_zip_code       | string        | Postal or ZIP code of billing address.                       |
-| bill_country        | string        | Country of billing address. It requires the input of ISO-3166 alpha-2 country code, e.g. US for United States. Please refer to [Country Codes](https://www.fraudlabspro.com/developer/reference/country-codes) for complete list. |
-| user_order_id       | string        | Merchant identifier to uniquely identify a transaction. It supports maximum of 15 characters user order id input. |
-| user_order_memo     | string        | Merchant description of an order transaction. It supports maximum of 200 characters. |
-| amount              | float         | Amount of the transaction.                                   |
-| quantity            | integer       | Total quantity of the transaction.                           |
-| currency            | string        | Currency code used in the transaction. It requires the input of ISO-4217 (3 characters) currency code, e.g. USD for US Dollar. Please refer to [Currency Codes](https://www.fraudlabspro.com/developer/reference/currency-codes) for complete list. |
-| department          | string        | Merchant identifier to uniquely identify a product or service department. |
-| payment_mode        | string        | Payment mode of transaction. Valid values: creditcard, affirm, paypal, googlecheckout, bitcoin, cod, moneyorder, wired, bankdeposit, elviauthorized, paymitco, cybersource, sezzle, viabill, amazonpay, pmnts_gateway, giftcard, others.  |
-| card_number         | string        | Billing credit card number or BIN number.                    |
-| card_avs            | string        | The single character AVS result returned by the credit card processor. Please refer to [AVS & CVV2 Response Codes](https://www.fraudlabspro.com/developer/reference/avs-and-cvv2-response-codes) for details. |
-| card_cvv            | string        | The single character CVV2 result returned by the credit card processor. Please refer to [AVS & CVV2 Response Codes](https://www.fraudlabspro.com/developer/reference/avs-and-cvv2-response-codes) for details. |
-| ship_addr           | string        | Street address of shipping address.                          |
-| ship_city           | string        | City of shipping address.                                    |
-| ship_state          | string        | State of shipping address. It supports state codes, e.g. NY - New York, for state or province of United States or Canada. Please refer to [State & Province Codes](https://www.fraudlabspro.com/developer/reference/state-and-province-codes) for complete list. |
-| ship_zip_code       | string        | Postal or ZIP code of shipping address.                      |
-| ship_country        | string        | Country of shipping address. It requires the input of ISO-3166 alpha-2 country code, e.g. US for United States. Please refer to [Country Codes](https://www.fraudlabspro.com/developer/reference/country-codes) for complete list. |
-
-
-```
-require 'fraudlabspro_ruby'
-
-FraudlabsproRuby::Configuration.api_key = 'YOUR_API_KEY'
-
-result = FraudlabsproRuby::Api::Order.validate(
-  ip: '146.112.62.105',
-  first_name: 'Hector',
-  last_name: 'Henderson',
-  email: 'hh5566@gmail.com',
-  phone: '561-628-8674',
-
-  # Billing information
-  bill_addr: '1766 PowderHouse Road',
-  bill_city: 'West Palm Beach',
-  bill_state: 'FL',
-  bill_zip_code: '33401',
-  bill_country: 'US',
-
-  # Order information
-  user_order_id: '67398',
-  user_order_memo: 'Online Shop',
-  amount: '79.89',
-  quantity: '1',
-  currency: 'USD',
-  payment_mode: FraudlabsproRuby::Api::Order::CREDIT_CARD,
-  card_number: '4556553172971283',
-
-  # Shipping information
-  ship_addr: '4469 Chestnut Street',
-  ship_city: 'Tampa',
-  ship_state: 'FL',
-  ship_zip_code: '33602',
-  ship_country: 'US'
-)
-```
-
-
-
-### Get Transaction
-
-#### Parameter Properties
-
-| Parameter Name | Parameter Type | Description                                                  |
-| -------------- | -------------- | ------------------------------------------------------------ |
-| transaction_id | string         | FraudLabs Pro transaction ID or Order ID.                    |
-| id_type        | string         | ID type. Either: **FraudlabsproRuby::Api::Order::FLP_ID** or **FraudlabsproRuby::Api::Order::ORDER_ID** |
-
-```
-require 'fraudlabspro_ruby'
-
-FraudlabsproRuby::Configuration.api_key = 'YOUR_API_KEY'
-
-result = FraudlabsproRuby::Api::Order.getTransaction(
-  transaction_id: '20180713-ZNVPV4',
-  id_type: FraudlabsproRuby::Api::Order::FLP_ID
-)
-```
-
-
-
-### Feedback
-
-#### Object Properties
-
-| Property Name   | Property Type | Description                                                  |
-| --------------- | ------------- | ------------------------------------------------------------ |
-| transaction_id  | string        | Unique transaction ID generated from **Validate** function.  |
-| status          | string        | Perform APPROVE, REJECT, or REJECT_BLACKLIST action to transaction.	Refer to [reference section](#feedback-status) for status code. |
-| note            | string        | Notes for the feedback request.                              |
-
-```
-require 'fraudlabspro_ruby'
-
-FraudlabsproRuby::Configuration.api_key = 'YOUR_API_KEY'
-
-result = FraudlabsproRuby::Api::Order.feedback(
-  transaction_id: '20180713-ZNVPV4',
-  status: FraudlabsproRuby::Api::Order::APPROVE
-)
-```
-
-
-
-
-## SMS Verification
-
-### Send SMS Verification
-
-#### Object Properties
-
-| Property Name | Property Type | Description                                                  |
-| ------------- | ------------- | ------------------------------------------------------------ |
-| tel           |    string     | The recipient mobile phone number in E164 format which is a plus followed by just numbers with no spaces or parentheses. |
-| mesg          |    string     | The message template for the SMS. Add <otp> as placeholder for the actual OTP to be generated. Max length is 140 characters. |
-| otp_timeout   |    integer    | Timeout feature for OTP value in seconds. Default is 3600 seconds(1 hour). Max timeout is 86400 seconds(24 hours). |
-| country_code  |    string     | ISO 3166 country code for the recipient mobile phone number. If parameter is supplied, then some basic telephone number validation is done. |
-
-```
-require 'fraudlabspro_ruby'
-
-FraudlabsproRuby::Configuration.api_key = 'YOUR_API_KEY'
-
-result = FraudlabsproRuby::Api::SMSVerification.sendSMS(
-  tel: '+123456789',
-  mesg: 'Hi, your OTP is <otp>.',
-  otp_timeout: 3600,
-  country_code: 'US'
-)
-```
-
-
-
-### Get SMS Verification Result
-
-#### Object Properties
-
-| Property Name | Property Type | Description                                                  |
-| ------------- | :-----------: | ------------------------------------------------------------ |
-| tran_id       |    string     | The unique ID that was returned by the Send SMS Verification that triggered the OTP sms. |
-| otp           |    string     | The OTP that was sent to the recipient’s phone. |
-
-```
-require 'fraudlabspro_ruby'
-
-FraudlabsproRuby::Configuration.api_key = 'YOUR_API_KEY'
-
-result = FraudlabsproRuby::Api::SMSVerification.verifySMS(
-  tran_id: 'UNIQUE_TRANS_ID',
-  otp: 'OTP_RECEIVED'
-)
-```
-
+# Developer Documentation
+To learn more about installation, usage, and code examples, please visit the developer documentation at [https://fraudlabspro-ruby.readthedocs.io/en/latest/index.html.](https://fraudlabspro-ruby.readthedocs.io/en/latest/index.html)
 
 
 # Reference
@@ -199,12 +28,11 @@ result = FraudlabsproRuby::Api::SMSVerification.verifySMS(
 | ---------------------------------------------- |
 | FraudlabsproRuby::Api::Order::CREDIT_CARD      |
 | FraudlabsproRuby::Api::Order::PAYPAL           |
-| FraudlabsproRuby::Api::Order::GOOGLE_CHECKOUT  |
 | FraudlabsproRuby::Api::Order::CASH_ON_DELIVERY |
-| FraudlabsproRuby::Api::Order::MONEY_ORDER      |
-| FraudlabsproRuby::Api::Order::WIRE_TRANSFER    |
 | FraudlabsproRuby::Api::Order::BANK_DEPOSIT     |
-| FraudlabsproRuby::Api::Order::BITCOIN          |
+| FraudlabsproRuby::Api::Order::GIFT_CARD        |
+| FraudlabsproRuby::Api::Order::CRYPTO           |
+| FraudlabsproRuby::Api::Order::WIRE_TRANSFER    |
 | FraudlabsproRuby::Api::Order::OTHERS           |
 
 

data/lib/fraudlabspro_ruby/api/order.rb

@@ -16,12 +16,11 @@ module FraudlabsproRuby
       # Payment methods.
       CREDIT_CARD = 'CREDITCARD'
       PAYPAL = 'PAYPAL';
-      GOOGLE_CHECKOUT = 'GOOGLECHECKOUT';
       CASH_ON_DELIVERY = 'COD';
-      MONEY_ORDER = 'MONEYORDER';
-      WIRE_TRANSFER = 'WIRED';
       BANK_DEPOSIT = 'BANKDEPOSIT';
-      BITCOIN = 'BITCOIN';
+      GIFT_CARD = 'GIFTCARD';
+      CRYPTO = 'CRYPTO';
+      WIRE_TRANSFER = 'WIRED';
       OTHERS = 'OTHERS';
 
       # ID types.
@@ -47,13 +46,13 @@ module FraudlabsproRuby
           params[:card_number] = params[:card_number][0..5]
         end
 
-        uri = URI.parse("https://api.fraudlabspro.com/v1/order/screen")
+        uri = URI.parse("https://api.fraudlabspro.com/v2/order/screen")
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         request = Net::HTTP::Post.new(uri.request_uri)
         request.set_form_data({
           'key' => FraudlabsproRuby::Configuration.api_key,
-          'format' => params[:format] || 'json',
+          'format' => 'json',
           'source' => 'sdk-ruby',
           'source_version' => FraudlabsproRuby::VERSION,
           'flp_checksum' => params[:flp_checksum] || '',
@@ -63,7 +62,6 @@ module FraudlabsproRuby
           'first_name' => params[:first_name] || '',
           'last_name' => params[:last_name] || '',
           'username_hash' => do_hash(params[:username]) || '',
-          'password_hash' => do_hash(params[:password]) || '',
           'email' => params[:email] || '',
           'email_domain' => email_domain || '',
           'user_phone' => params[:phone] || '',
@@ -80,6 +78,7 @@ module FraudlabsproRuby
           'quantity' => params[:quantity] || 1,
           'currency' => params[:currency] || 'USD',
           'department' => params[:department] || '',
+          'payment_gateway' => params[:payment_gateway] || '',
           'payment_mode' => params[:payment_mode] || '',
 
           # Credit card information.
@@ -89,6 +88,8 @@ module FraudlabsproRuby
           'cvv_result' => params[:card_cvv] || '',
 
           # Shipping information.
+          'ship_first_name' => params[:ship_first_name] || '',
+          'ship_last_name' => params[:ship_last_name] || '',
           'ship_addr' => params[:ship_addr] || '',
           'ship_city' => params[:ship_city] || '',
           'ship_state' => params[:ship_state] || '',
@@ -107,13 +108,13 @@ module FraudlabsproRuby
 
       # Sends feedback back to FraudLabs Pro.
       def self.feedback(params = {})
-        uri = URI.parse("https://api.fraudlabspro.com/v1/order/feedback")
+        uri = URI.parse("https://api.fraudlabspro.com/v2/order/feedback")
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         request = Net::HTTP::Post.new(uri.request_uri)
         request.set_form_data({
           'key' => FraudlabsproRuby::Configuration.api_key,
-          'format' => params[:format] || 'xml',
+          'format' => 'json',
           'id' => params[:transaction_id],
           'action' => params[:status] || '',
           'note' => params[:note] || ''
@@ -130,15 +131,11 @@ module FraudlabsproRuby
 
       # Gets transaction result.
       def self.getTransaction(params = {})
-        if params[:format] == nil
-          params[:format] = 'xml'
-        end
-
         if params[:id_type] == nil
           params[:id_type] = ''
         end
 
-        uri = URI.parse("https://api.fraudlabspro.com/v1/order/result?key=" + FraudlabsproRuby::Configuration.api_key + "&format=" + params[:format] + "&id=" + params[:transaction_id] + "&id_type=" + params[:id_type])
+        uri = URI.parse("https://api.fraudlabspro.com/v2/order/result?key=" + FraudlabsproRuby::Configuration.api_key + "&format=json&id=" + params[:transaction_id] + "&id_type=" + params[:id_type])
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         request = Net::HTTP::Get.new(uri.request_uri)

data/lib/fraudlabspro_ruby/api/smsverification.rb

@@ -13,13 +13,13 @@ module FraudlabsproRuby
           params[:tel] = '+' + params[:tel]
         end
 
-        uri = URI.parse("https://api.fraudlabspro.com/v1/verification/send")
+        uri = URI.parse("https://api.fraudlabspro.com/v2/verification/send")
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         request = Net::HTTP::Post.new(uri.request_uri)
         request.set_form_data({
           'key' => FraudlabsproRuby::Configuration.api_key,
-          'format' => params[:format] || 'json',
+          'format' => 'json',
           'source' => 'sdk-ruby',
           'source_version' => FraudlabsproRuby::VERSION,
           'tel' => params[:tel],
@@ -39,11 +39,7 @@ module FraudlabsproRuby
 
       # Get Verification result.
       def self.verifySMS(params = {})
-        if params[:format] == nil
-          params[:format] = 'json'
-        end
-
-        uri = URI.parse("https://api.fraudlabspro.com/v1/verification/result?key=" + FraudlabsproRuby::Configuration.api_key + "&format=" + params[:format] + "&tran_id=" + params[:tran_id] + "&otp=" + params[:otp])
+        uri = URI.parse("https://api.fraudlabspro.com/v2/verification/result?key=" + FraudlabsproRuby::Configuration.api_key + "&format=json&tran_id=" + params[:tran_id] + "&otp=" + params[:otp])
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true
         request = Net::HTTP::Get.new(uri.request_uri)

data/lib/fraudlabspro_ruby/version.rb

@@ -1,3 +1,3 @@
 module FraudlabsproRuby
-  VERSION = "3.2.1"
+  VERSION = "4.0.1"
 end

data/spec/fraudlabspro_ruby_fraudvalidation_spec.rb

@@ -7,7 +7,7 @@ describe "FraudlabsproRuby" do
       ip: '8.8.8.8'
     )
     data = JSON.parse(result.body)
-    expect(data['fraudlabspro_message']).to eq 'INVALID API KEY'
+    expect(data['error']['error_message']).to eq 'INVALID API KEY'
   end
 
   it "work correctly with Api Key exist" do
@@ -32,9 +32,9 @@ describe "FraudlabsproRuby" do
     )
     data = JSON.parse(result.body)
     if $test_api_key == 'YOUR_API_KEY'
-      expect(data['fraudlabspro_id']).to eq 'NA'
+      expect(data['error']['error_message']).to eq 'INVALID API KEY'
     else
-      expect(data['ip_country']).to eq 'US'
+      expect(data['ip_geolocation']['country_code']).to eq 'US'
     end
   end
 
@@ -45,7 +45,11 @@ describe "FraudlabsproRuby" do
       id_type: FraudlabsproRuby::Api::Order::FLP_ID
     )
     data = JSON.parse(result.body)
-    expect(data['fraudlabspro_id']).to eq 'NA'
+    if $test_api_key == 'YOUR_API_KEY'
+      expect(data['error']['error_message']).to eq 'INVALID API KEY'
+    else
+      expect(data['error']['error_message']).to eq 'TRANSACTION NOT FOUND'
+    end
   end
 
   it "work correctly with validate order" do
@@ -56,9 +60,9 @@ describe "FraudlabsproRuby" do
     )
     data = JSON.parse(result.body)
     if $test_api_key == 'YOUR_API_KEY'
-      expect(data['fraudlabspro_message']).to eq 'INVALID API KEY'
+      expect(data['error']['error_message']).to eq 'INVALID API KEY'
     else
-      expect(data['fraudlabspro_message']).to eq 'INVALID TRANSACTION ID'
+      expect(data['error']['error_message']).to eq 'TRANSACTION NOT FOUND'
     end
   end
 

data/spec/fraudlabspro_ruby_smsverification_spec.rb

@@ -11,9 +11,9 @@ describe "FraudlabsproRuby" do
     )
     data = JSON.parse(result.body)
     if $test_api_key == 'YOUR_API_KEY'
-      expect(data['error']).to eq 'API key not found.'
+      expect(data['error']['error_message']).to eq 'INVALID API KEY'
     else
-      expect(data['error']).to eq 'Invalid phone number.'
+      expect(data['error']['error_message']).to eq 'INVALID PHONE NUMBER'
     end
   end
 
@@ -25,9 +25,9 @@ describe "FraudlabsproRuby" do
     )
     data = JSON.parse(result.body)
     if $test_api_key == 'YOUR_API_KEY'
-      expect(data['error']).to eq 'API key not found.'
+      expect(data['error']['error_message']).to eq 'INVALID API KEY'
     else
-      expect(data['error']).to eq 'Invalid OTP.'
+      expect(data['error']['error_message']).to eq 'INVALID OTP'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fraudlabspro_ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.1
 platform: ruby
 authors:
 - fraudlabspro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby SDK enables user to easily implement fraud detection feature into
   their solution using the API from www.fraudlabspro.com
@@ -54,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: FraudLabs Pro Ruby SDK