paysafe 0.9.4 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc7294b85582b6ee37fcdd12dfcabc56d16090f507fd4d8a939cc66a96df5c4e
-  data.tar.gz: f4a2779dd998b06c501ca581b4ec9d0ad68cf56b903cc4301a509da825b1026c
+  metadata.gz: 4803818bdc78d71bc90d2ae9943edc64b0d0c679bfda7bd67347d15ef8e9af7f
+  data.tar.gz: 4dc6d70f206609c6e21e7c1c8020de90d64208e5b5d7f338b78a2a77393431c3
 SHA512:
-  metadata.gz: f4f33d5ca79c2090278ce544941b72f773c778d8ef62e590401d1f5f8da15f8e246d40c8c066330989ded3333a3cb14c4b247a7b27093608552096ab80e61421
-  data.tar.gz: 7a46cdad0e46104317fb942315fa5ea96952b22e0694e182ad053c2747e791015ce2d99a0961d686168730dc8467b9fd9cdf1a984a9f047ac66f737a796cf4b5
+  metadata.gz: 29f506be900bebea1edb04c07efbe80bda334d676dada67c75773765d7b2008df5107d3aa96b9ec77c35756da60cfc3aa39679663b1474216d06d812be0dcf7e
+  data.tar.gz: b4f9aede128b21ff3e1af4a9b7fb810601f45b2c0de2e768f91d8d9cf53f3eb039d96764bbf4f188c710607eacead7b6c332b1826bb1aa0e3853dbf3f02a5a74

data/.env.sample

@@ -4,5 +4,12 @@ PAYSAFE_API_SECRET="YOUR_API_SECRET"
 
 # This is only needed if you want to generate your own Single
 # Use Tokens which utilize a different API key and secret.
-PAYSAFE_SUT_API_KEY="YOUR_SINGLE_USE_TOKEN_API_KEY"
-PAYSAFE_SUT_API_SECRET="YOUR_SINGLE_USE_TOKEN_API_SECRET"
+PAYSAFE_SUT_API_KEY="YOUR_SUT_API_KEY"
+PAYSAFE_SUT_API_SECRET="YOUR_SUT_API_SECRET"
+
+# These are for the Paysafe Payments API which are part of
+# what Paysafe refers to as the Unity platform.
+PAYSAFE_UNITY_API_KEY="YOUR_UNITY_API_KEY"
+PAYSAFE_UNITY_API_SECRET="YOUR_UNITY_API_SECRET"
+PAYSAFE_UNITY_SUT_API_KEY="YOUR_UNITY_SUT_API_KEY"
+PAYSAFE_UNITY_SUT_API_SECRET="YOUR_UNITY_SUT_API_SECRET"

data/.github/workflows/ci.yml

@@ -0,0 +1,51 @@
+name: Paysafe
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
+    - name: Install rubygems
+      run: |
+        gem update --system --no-document
+
+    - name: Install bundler
+      run: |
+        gem install bundler --no-document
+
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Run Tests
+      env:
+        PAYSAFE_ACCOUNT_NUMBER: test
+        PAYSAFE_API_KEY: test
+        PAYSAFE_API_SECRET: test
+        PAYSAFE_SUT_API_KEY: test
+        PAYSAFE_SUT_API_SECRET: test
+        PAYSAFE_UNITY_API_KEY: test
+        PAYSAFE_UNITY_API_SECRET: test
+        PAYSAFE_UNITY_SUT_API_KEY: test
+        PAYSAFE_UNITY_SUT_API_SECRET: test
+      run: |
+        bundle exec rake

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## 0.10.0 (2020-02-24)
+
+* Removed client configuration using a block.
+* Deprecated `Client` object API methods.
+* All API methods are now grouped by API objects, for example:
+  * Customer Vault API: `client.create_profile` is now `client.customer_vault.create_profile`
+  * Card Payments API: `client.create_verification` is now `client.card_payments.create_verification`
+  * Includes some methods for new Payments API through `client.payments` (aka Paysafe Unity Platform)
+* Requires http gem v4.
+* Requires Ruby 2.4 and up.
+* Added Ruby 2.7 build to CI.
+
 ## 0.9.4 (2019-09-24)
 
 * Relax http gem dependency to allow v2 through v4.

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    paysafe (0.10.0)
+      http (>= 4, < 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    builder (3.2.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.5)
+    ffi (1.12.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.0)
+    http (4.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.2.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    minitest (5.14.0)
+    minitest-mock_expectations (1.1.1)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    public_suffix (4.0.3)
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    vcr (5.1.0)
+    webmock (3.8.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dotenv
+  minitest
+  minitest-mock_expectations
+  minitest-reporters
+  paysafe!
+  rake
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -1,9 +1,9 @@
 # The Paysafe Ruby Gem
 
 [![Gem Version](https://badge.fury.io/rb/paysafe.svg)][gem]
-[![Build Status](https://travis-ci.org/javierjulio/paysafe.svg?branch=master)][travis]
+![Build Status](https://github.com/javierjulio/paysafe/workflows/Paysafe/badge.svg?branch=master)
 
-A well tested Ruby interface to the [Paysafe REST API](paysafe_api_reference) (formerly Optimal Payments). Requires Ruby 2.3 and up. Not all API actions are supported yet. Since the Paysafe API uses camelCase, this gem will handle converting to and from snake_case for you.
+A well tested Ruby interface to the [Paysafe REST API](paysafe_api_reference) (formerly Optimal Payments). Requires Ruby 2.4 and up. Not all API actions are supported yet. Since the Paysafe API uses camelCase, this gem will handle converting to and from snake_case for you.
 
 ## Installation
 
@@ -24,23 +24,24 @@ To try out the gem, just follow the Development section instructions as the buil
 Create and configure a client with your API authentication.
 
 ```ruby
-client = Paysafe::REST::Client.new do |config|
-  config.account_number = '1234567890'
-  config.api_key = 'api_key'
-  config.api_secret = 'api_secret'
-  # Enable production requests
-  # config.test_mode = false
-  # Provide explicit timeouts
-  # config.timeouts = { connect: 2, read: 5, write: 10 }
-end
+client = Paysafe::REST::Client.new(
+  api_key: 'your api key',
+  api_secret: 'you api secret',
+  test_mode: false, # to enable Production requests (default is true)
+  account_number: '1234', # used for the Card Payments API
+  # Provide optional timeouts
+  # timeouts: { connect: 2, read: 5, write: 10 }
+)
 ```
 
+At a minimum the following options: `api_key`, `api_secret`, and `test_mode` should be specified. The `account_number` is only necessary for certain API's such as the Card Payments API.
+
 ### Making Requests
 
 Make an API request with a payload in the structure documented by the [Paysafe REST API](paysafe_api_reference) but using snake_case. The request payload will be converted to camelCase for you.
 
 ```ruby
-profile = client.create_profile(
+profile = client.customer_vault.create_profile(
   merchant_customer_id: '123',
   locale: 'en_US',
   card: {
@@ -66,16 +67,14 @@ profile.cards.first.card_expiry.year
 # => 2020
 ```
 
-Further API methods are provided in the `Paysafe::REST::Client` object.
-
 ## Development
 
 1. `git clone https://github.com/javierjulio/paysafe.git`
-2. Run `./bin/setup` to install dependencies and fill out API key info
+2. Run `./bin/setup` to install dependencies and fill out API key/secret info
 3. Run `./bin/console` for an interactive prompt with an authenticated client for you to experiment:
 
     ```ruby
-    profile = client.create_profile(merchant_customer_id: '123', locale: 'en_US')
+    profile = client.customer_vault.create_profile(merchant_customer_id: SecureRandom.uuid, locale: 'en_US')
     puts profile.id
     # => b088ac37...
     ```
@@ -84,7 +83,7 @@ All code is written in snake_case since requests and responses are converted to
 
 ### Tests
 
-Run `bundle exec rake test` or to skip integration tests run with `SKIP_INTEGRATION=true`.
+If the API key/secret info is different from what was used to record the cassettes, you'll need to run `bundle exec rake test RECORD_MODE=all` otherwise run `bundle exec rake test`.
 
 ### Releasing
 
@@ -99,5 +98,4 @@ Bug reports and pull requests for missing API support are welcome on GitHub at h
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 [gem]: https://rubygems.org/gems/paysafe
-[travis]: https://travis-ci.org/javierjulio/paysafe
 [paysafe_api_reference]: https://developer.paysafe.com/en/api-reference/

data/bin/console

@@ -1,25 +1,37 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require "dotenv/load"
 require "paysafe"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+def client
+  Paysafe::REST::Client.new(
+    account_number: ENV['PAYSAFE_ACCOUNT_NUMBER'],
+    api_key: ENV['PAYSAFE_API_KEY'],
+    api_secret: ENV['PAYSAFE_API_SECRET']
+  )
+end
 
-require 'dotenv'
-Dotenv.load
+def sut_client
+  Paysafe::REST::Client.new(
+    api_key: ENV['PAYSAFE_SUT_API_KEY'],
+    api_secret: ENV['PAYSAFE_SUT_API_SECRET']
+  )
+end
 
-def client
-  Paysafe::REST::Client.new do |config|
-    config.account_number = ENV['PAYSAFE_ACCOUNT_NUMBER']
-    config.api_key = ENV['PAYSAFE_API_KEY']
-    config.api_secret = ENV['PAYSAFE_API_SECRET']
-  end
+def unity_client
+  Paysafe::REST::Client.new(
+    api_key: ENV['PAYSAFE_UNITY_API_KEY'],
+    api_secret: ENV['PAYSAFE_UNITY_API_SECRET']
+  )
 end
 
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/bin/setup

@@ -23,10 +23,19 @@ echo "Enter your account credentials below."
 read -p 'Account Number: ' account_number
 read -p 'API Key: ' api_key
 read -p 'API Secret: ' api_secret
+read -p 'Single Use Token API Key: ' sut_api_key
+read -p 'Single Use Token API Secret: ' sut_api_secret
+read -p 'Unity API Key: ' unity_api_key
+read -p 'Unity API Secret: ' unity_api_secret
 
 cp .env.sample .env
+
 sed -i '' -e "s/YOUR_ACCOUNT_NUMBER/$account_number/g" .env
 sed -i '' -e "s/YOUR_API_KEY/$api_key/g" .env
 sed -i '' -e "s/YOUR_API_SECRET/$api_secret/g" .env
+sed -i '' -e "s/YOUR_SUT_API_KEY/$sut_api_key/g" .env
+sed -i '' -e "s/YOUR_SUT_API_SECRET/$sut_api_secret/g" .env
+sed -i '' -e "s/YOUR_UNITY_API_KEY/$unity_api_key/g" .env
+sed -i '' -e "s/YOUR_UNITY_API_SECRET/$unity_api_secret/g" .env
 
 echo "Done."

data/lib/paysafe.rb

@@ -1,7 +1,15 @@
+require "http"
+require "json"
 require "paysafe/version"
 require "paysafe/error"
 require "paysafe/single_use_token"
 require "paysafe/profile"
+require "paysafe/customer"
+require "paysafe/payment"
+require "paysafe/gateway_response"
+require "paysafe/payment_processor"
+require "paysafe/payment_methods"
+require "paysafe/payment_method"
 require "paysafe/birth_date"
 require "paysafe/address"
 require "paysafe/card"
@@ -11,3 +19,8 @@ require "paysafe/authorization"
 require "paysafe/refinements/camel_case"
 require "paysafe/refinements/snake_case"
 require "paysafe/rest/client"
+require "paysafe/configuration"
+require "paysafe/api/base_api"
+require "paysafe/api/card_payments_api"
+require "paysafe/api/customer_vault_api"
+require "paysafe/api/payments_api"

data/lib/paysafe/address.rb

@@ -2,7 +2,7 @@ require 'paysafe/result'
 
 module Paysafe
   class Address < Result
-    attributes :id, :nick_name, :street, :street2, :city,
+    attributes :id, :nick_name, :street, :street1, :street2, :city,
       :country, :state, :zip, :recipient_name, :phone, :status,
       :default_shipping_address_indicator
   end

data/lib/paysafe/api/base_api.rb

@@ -0,0 +1,70 @@
+module Paysafe
+  module Api
+    class BaseApi
+      HEADERS = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => "PaysafeRubyGem/#{Paysafe::VERSION}",
+        'X-Ruby-Version' => RUBY_VERSION,
+        'X-Ruby-Platform' => RUBY_PLATFORM
+      }
+
+      using Refinements::CamelCase
+      using Refinements::SnakeCase
+
+      def initialize(config)
+        @config = config
+      end
+
+      protected
+
+      # Needed for some API URLs
+      def account_number
+        @config.account_number
+      end
+
+      def http_client
+        HTTP
+          .headers(HEADERS)
+          .timeout(@config.timeouts ? @config.timeouts : :null)
+          .basic_auth(user: @config.api_key, pass: @config.api_secret)
+      end
+
+      def perform_post_with_object(path, data, klass)
+        response = http_client.post("#{@config.api_base}#{path}", json: data.to_camel_case)
+        process_response(response, klass)
+      end
+
+      def perform_get_with_object(path, klass)
+        response = http_client.get("#{@config.api_base}#{path}")
+        process_response(response, klass)
+      end
+
+      def perform_delete(path)
+        response = http_client.delete("#{@config.api_base}#{path}")
+        process_response(response)
+      end
+
+      def perform_put_with_object(path, data, klass)
+        response = http_client.put("#{@config.api_base}#{path}", json: data.to_camel_case)
+        process_response(response, klass)
+      end
+
+      def process_response(response, klass=nil)
+        data = parse_response_body(response.to_s)
+
+        if response.status.success?
+          klass&.new(data)
+        else
+          fail Error.from_response(data, response.code)
+        end
+      end
+
+      def parse_response_body(body)
+        return nil if body.strip.empty?
+        JSON.parse(body, symbolize_names: true)&.to_snake_case
+      rescue JSON::ParserError
+      end
+
+    end
+  end
+end

data/lib/paysafe/api/card_payments_api.rb

@@ -0,0 +1,23 @@
+module Paysafe
+  module Api
+    class CardPaymentsApi < BaseApi
+
+      def create_authorization(**data)
+        perform_post_with_object("/cardpayments/v1/accounts/#{account_number}/auths", data, Authorization)
+      end
+
+      def create_verification(**data)
+        perform_post_with_object("/cardpayments/v1/accounts/#{account_number}/verifications", data, Verification)
+      end
+
+      def get_authorization(id:)
+        perform_get_with_object("/cardpayments/v1/accounts/#{account_number}/auths/#{id}", Authorization)
+      end
+
+      def get_verification(id:)
+        perform_get_with_object("/cardpayments/v1/accounts/#{account_number}/verifications/#{id}", Verification)
+      end
+
+    end
+  end
+end

data/lib/paysafe/api/customer_vault_api.rb

@@ -0,0 +1,74 @@
+module Paysafe
+  module Api
+    class CustomerVaultApi < BaseApi
+
+      def create_address(profile_id:, country:, zip:, **args)
+        data = args.merge({ country: country, zip: zip })
+        perform_post_with_object("/customervault/v1/profiles/#{profile_id}/addresses", data, Address)
+      end
+
+      def create_card(profile_id:, **data)
+        perform_post_with_object("/customervault/v1/profiles/#{profile_id}/cards", data, Card)
+      end
+
+      def create_profile(merchant_customer_id:, locale:, **args)
+        data = args.merge({
+          merchant_customer_id: merchant_customer_id,
+          locale: locale
+        })
+
+        perform_post_with_object("/customervault/v1/profiles", data, Profile)
+      end
+
+      def create_single_use_token(**data)
+        perform_post_with_object("/customervault/v1/singleusetokens", data, SingleUseToken)
+      end
+
+      def delete_address(profile_id:, id:)
+        perform_delete("/customervault/v1/profiles/#{profile_id}/addresses/#{id}")
+      end
+
+      def delete_card(profile_id:, id:)
+        perform_delete("/customervault/v1/profiles/#{profile_id}/cards/#{id}")
+      end
+
+      def delete_profile(id:)
+        perform_delete("/customervault/v1/profiles/#{id}")
+      end
+
+      def get_address(profile_id:, id:)
+        perform_get_with_object("/customervault/v1/profiles/#{profile_id}/addresses/#{id}", Address)
+      end
+
+      def get_card(profile_id:, id:)
+        perform_get_with_object("/customervault/v1/profiles/#{profile_id}/cards/#{id}", Card)
+      end
+
+      def get_profile(id:, fields: [])
+        path = "/customervault/v1/profiles/#{id}"
+        path += "?fields=#{fields.join(',')}" if !fields.empty?
+
+        perform_get_with_object(path, Profile)
+      end
+
+      def update_address(profile_id:, id:, country:, zip:, **args)
+        data = args.merge({ country: country, zip: zip })
+        perform_put_with_object("/customervault/v1/profiles/#{profile_id}/addresses/#{id}", data, Address)
+      end
+
+      def update_card(profile_id:, id:, **data)
+        perform_put_with_object("/customervault/v1/profiles/#{profile_id}/cards/#{id}", data, Card)
+      end
+
+      def update_profile(id:, merchant_customer_id:, locale:, **args)
+        data = args.merge({
+          merchant_customer_id: merchant_customer_id,
+          locale: locale
+        })
+
+        perform_put_with_object("/customervault/v1/profiles/#{id}", data, Profile)
+      end
+
+    end
+  end
+end

data/lib/paysafe/api/payments_api.rb

@@ -0,0 +1,19 @@
+module Paysafe
+  module Api
+    class PaymentsApi < BaseApi
+
+      def get_payment_methods(currency_code:)
+        perform_get_with_object("/paymenthub/v1/paymentmethods?currencyCode=#{currency_code}", PaymentMethods)
+      end
+
+      def create_payment(**data)
+        perform_post_with_object("/paymenthub/v1/payments", data, Payment)
+      end
+
+      def get_payment(id:)
+        perform_get_with_object("/paymenthub/v1/payments/#{id}", Payment)
+      end
+
+    end
+  end
+end

data/lib/paysafe/birth_date.rb

@@ -3,5 +3,9 @@ require 'paysafe/result'
 module Paysafe
   class BirthDate < Result
     attributes :year, :month, :day
+
+    def date
+      @date ||= Date.new(year, month, day)
+    end
   end
 end

data/lib/paysafe/configuration.rb

@@ -0,0 +1,20 @@
+module Paysafe
+  class Configuration
+
+    API_TEST = 'https://api.test.paysafe.com'
+    API_LIVE = 'https://api.paysafe.com'
+
+    attr_reader :account_number, :api_base, :api_key, :api_secret, :test_mode, :timeouts
+
+    def initialize(**options)
+      @test_mode = true
+
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      @api_base = test_mode ? API_TEST : API_LIVE
+    end
+
+  end
+end

data/lib/paysafe/customer.rb

@@ -0,0 +1,11 @@
+require 'paysafe/result'
+
+module Paysafe
+  class Customer < Result
+    attributes :id, :status, :merchant_customer_id, :locale,
+      :ip, :first_name, :middle_name, :last_name, :gender,
+      :nationality, :email, :phone, :cell_phone, :payment_token
+
+    object_attribute :BirthDate, :date_of_birth
+  end
+end

data/lib/paysafe/error.rb

@@ -48,7 +48,7 @@ module Paysafe
     # Raised on the HTTP status code 504
     GatewayTimeout = Class.new(ServerError)
 
-    ERRORS = {
+    ERRORS_BY_STATUS = {
       400 => Paysafe::Error::BadRequest,
       401 => Paysafe::Error::Unauthorized,
       402 => Paysafe::Error::RequestDeclined,
@@ -65,24 +65,14 @@ module Paysafe
       504 => Paysafe::Error::GatewayTimeout,
     }
 
-    # The Paysafe API Error Code
-    #
-    # @return [Integer]
-    attr_reader :code
-
-    # The JSON HTTP response in Hash form
-    #
-    # @return [Hash]
-    attr_reader :response
-
     class << self
       # Create a new error from an HTTP response
       #
       # @param body [String]
-      # @param code [Integer]
+      # @param status [Integer]
       # @return [Paysafe::Error]
-      def from_response(body, code)
-        klass = ERRORS[code] || Paysafe::Error
+      def from_response(body, status)
+        klass = ERRORS_BY_STATUS[status] || Paysafe::Error
         message, error_code = parse_error(body)
         klass.new(message: message, code: error_code, response: body)
       end
@@ -98,16 +88,64 @@ module Paysafe
       end
     end
 
+    # The Paysafe API Error Code
+    #
+    # @return [String]
+    attr_reader :code
+
+    # The JSON HTTP response in Hash form
+    #
+    # @return [Hash]
+    attr_reader :response
+
     # Initializes a new Error object
     #
     # @param message [Exception, String]
-    # @param code [Integer]
+    # @param code [String]
     # @param response [Hash]
     # @return [Paysafe::Error]
     def initialize(message: '', code: nil, response: {})
-      super(message)
       @code = code
       @response = response
+      super(message)
     end
+
+    def to_s
+      [ super, code_text, field_error_text, detail_text ].compact.join(' ')
+    end
+
+    def id
+      response.dig(:id) if response.is_a?(Hash)
+    end
+
+    def merchant_ref_num
+      response.dig(:merchant_ref_num) if response.is_a?(Hash)
+    end
+
+    private
+
+    def code_text
+      "(Code #{code})" if code
+    end
+
+    def field_error_text
+      if field_errors
+        msgs = field_errors.map { |f| "The \`#{f[:field]}\` #{f[:error]}." }.join(' ')
+        "Field Errors: #{msgs}".strip
+      end
+    end
+
+    def field_errors
+      response.dig(:error, :field_errors) if response.is_a?(Hash)
+    end
+
+    def detail_text
+      "Details: #{details.join('. ')}".strip if details
+    end
+
+    def details
+      response.dig(:error, :details) if response.is_a?(Hash)
+    end
+
   end
 end

data/lib/paysafe/gateway_response.rb

@@ -0,0 +1,12 @@
+require 'paysafe/result'
+
+module Paysafe
+  class GatewayResponse < Result
+    attributes :processor,
+      :balance,
+      :merchant_transaction_id,
+      :payment_processor_transaction_id,
+      :lcp_transaction_id,
+      :lcp_encoded_transaction_id
+  end
+end

data/lib/paysafe/payment.rb

@@ -0,0 +1,27 @@
+require 'paysafe/result'
+
+module Paysafe
+  class Payment < Result
+    attributes :id,
+      :payment_type,
+      :payment_handle_token,
+      :merchant_ref_num,
+      :currency_code,
+      :settle_with_auth,
+      :txn_time,
+      :status,
+      :gateway_reconciliation_id,
+      :amount,
+      :available_to_settle,
+      :available_to_refund,
+      :consumer_ip,
+      :live_mode,
+      :updated_time,
+      :status_time
+
+    object_attribute :Address, :billing_details
+    object_attribute :Customer, :profile
+    object_attribute :GatewayResponse, :gateway_response
+    object_attribute :PaymentProcessor, :sightline
+  end
+end

data/lib/paysafe/payment_method.rb

@@ -0,0 +1,7 @@
+require 'paysafe/result'
+
+module Paysafe
+  class PaymentMethod < Result
+    attributes :payment_method, :currency_code, :currency, :account_id, :mcc
+  end
+end

data/lib/paysafe/payment_methods.rb

@@ -0,0 +1,7 @@
+require 'paysafe/result'
+
+module Paysafe
+  class PaymentMethods < Result
+    object_attribute :PaymentMethod, :payment_methods
+  end
+end

data/lib/paysafe/payment_processor.rb

@@ -0,0 +1,7 @@
+require 'paysafe/result'
+
+module Paysafe
+  class PaymentProcessor < Result
+    attributes :consumer_id
+  end
+end

data/lib/paysafe/rest/client.rb

@@ -1,40 +1,16 @@
-require 'http'
-require 'json'
-
 module Paysafe
   module REST
     class Client
+      extend Forwardable
 
-      API_TEST = 'https://api.test.paysafe.com'
-      API_LIVE = 'https://api.paysafe.com'
-
-      HEADERS = {
-        'Content-Type'    => 'application/json',
-        'User-Agent'      => "PaysafeRubyGem/#{Paysafe::VERSION}",
-        'X-Ruby-Version'  => RUBY_VERSION,
-        'X-Ruby-Platform' => RUBY_PLATFORM
-      }
-
-      using Refinements::CamelCase
-      using Refinements::SnakeCase
-
-      attr_accessor :account_number, :api_key, :api_secret, :test_mode, :timeouts
-      attr_reader :api_base
+      delegate [:account_number, :api_base, :api_key, :api_secret, :test_mode, :timeouts] => :@config
 
       # Initializes a new Client object
       #
       # @param options [Hash]
       # @return [Paysafe::REST::Client]
-      def initialize(options={})
-        @test_mode = true
-
-        options.each do |key, value|
-          instance_variable_set("@#{key}", value)
-        end
-
-        yield(self) if block_given?
-
-        @api_base = test_mode ? API_TEST : API_LIVE
+      def initialize(**options)
+        @config = Configuration.new(options)
       end
 
       # @return [Hash]
@@ -47,87 +23,76 @@ module Paysafe
         credentials.values.all?
       end
 
+      def customer_vault
+        @customer_vault ||= Api::CustomerVaultApi.new(@config)
+      end
+
+      def card_payments
+        @card_payments ||= Api::CardPaymentsApi.new(@config)
+      end
+
+      def payments
+        @payments ||= Api::PaymentsApi.new(@config)
+      end
+
       def create_single_use_token(data)
-        response = post(path: "/customervault/v1/singleusetokens", data: data.to_camel_case)
-        process_response(response, SingleUseToken)
+        warn "[DEPRECATION] 'create_single_use_token' is deprecated. Please use 'customer_vault.create_single_use_token' instead."
+        customer_vault.create_single_use_token(**data)
       end
 
       def create_profile_from_token(data)
-        response = post(path: "/customervault/v1/profiles", data: data.to_camel_case)
-        process_response(response, Profile)
+        warn "[DEPRECATION] 'create_profile_from_token' is deprecated. Please use 'customer_vault.create_profile' instead."
+        customer_vault.create_profile(**data)
       end
 
       def create_profile(merchant_customer_id:, locale:, **args)
-        data = args.merge({
-          merchant_customer_id: merchant_customer_id,
-          locale: locale
-        }).to_camel_case
-
-        response = post(path: "/customervault/v1/profiles", data: data)
-        process_response(response, Profile)
+        warn "[DEPRECATION] 'create_profile' is deprecated. Please use 'customer_vault.create_profile' instead."
+        customer_vault.create_profile(merchant_customer_id: merchant_customer_id, locale: locale, **args)
       end
 
       def delete_profile(id:)
-        response = delete(path: "/customervault/v1/profiles/#{id}")
-        process_response(response)
+        warn "[DEPRECATION] 'delete_profile' is deprecated. Please use 'customer_vault.delete_profile' instead."
+        customer_vault.delete_profile(id: id)
       end
 
       def get_profile(id:, fields: [])
-        path = "/customervault/v1/profiles/#{id}"
-        path += "?fields=#{fields.join(',')}" if !fields.empty?
-
-        response = get(path: path)
-        process_response(response, Profile)
+        warn "[DEPRECATION] 'get_profile' is deprecated. Please use 'customer_vault.get_profile' instead."
+        customer_vault.get_profile(id: id, fields: fields)
       end
 
       def update_profile(id:, merchant_customer_id:, locale:, **args)
-        data = args.merge({
-          merchant_customer_id: merchant_customer_id,
-          locale: locale
-        }).to_camel_case
-
-        response = put(path: "/customervault/v1/profiles/#{id}", data: data)
-        process_response(response, Profile)
+        warn "[DEPRECATION] 'update_profile' is deprecated. Please use 'customer_vault.update_profile' instead."
+        customer_vault.update_profile(id: id, merchant_customer_id: merchant_customer_id, locale: locale, **args)
       end
 
       def create_address(profile_id:, country:, zip:, **args)
-        data = args.merge({ country: country, zip: zip }).to_camel_case
-        response = post(path: "/customervault/v1/profiles/#{profile_id}/addresses", data: data)
-        process_response(response, Address)
+        warn "[DEPRECATION] 'create_address' is deprecated. Please use 'customer_vault.create_address' instead."
+        customer_vault.create_address(profile_id: profile_id, country: country, zip: zip, **args)
       end
 
       def get_address(profile_id:, id:)
-        response = get(path: "/customervault/v1/profiles/#{profile_id}/addresses/#{id}")
-        process_response(response, Address)
+        warn "[DEPRECATION] 'get_address' is deprecated. Please use 'customer_vault.get_address' instead."
+        customer_vault.get_address(profile_id: profile_id, id: id)
       end
 
       def create_card_from_token(profile_id:, token:)
-        data = { single_use_token: token }.to_camel_case
-        response = post(path: "/customervault/v1/profiles/#{profile_id}/cards", data: data)
-        process_response(response, Card)
+        warn "[DEPRECATION] 'create_card_from_token' is deprecated. Please use 'customer_vault.create_card' instead."
+        customer_vault.create_card(profile_id: profile_id, single_use_token: token)
       end
 
-      def create_card(profile_id:, number:, month:, year:, **args)
-        data = args.merge({
-          card_num: number,
-          card_expiry: {
-            month: month,
-            year: year
-          }
-        }).reject { |key, value| value.nil? }.to_camel_case
-
-        response = post(path: "/customervault/v1/profiles/#{profile_id}/cards", data: data)
-        process_response(response, Card)
+      def create_card(profile_id:, **data)
+        warn "[DEPRECATION] 'create_card' is deprecated. Please use 'customer_vault.create_card' instead."
+        customer_vault.create_card(profile_id: profile_id, **data)
       end
 
       def delete_card(profile_id:, id:)
-        response = delete(path: "/customervault/v1/profiles/#{profile_id}/cards/#{id}")
-        process_response(response)
+        warn "[DEPRECATION] 'delete_card' is deprecated. Please use 'customer_vault.delete_card' instead."
+        customer_vault.delete_card(profile_id: profile_id, id: id)
       end
 
       def get_card(profile_id:, id:)
-        response = get(path: "/customervault/v1/profiles/#{profile_id}/cards/#{id}")
-        process_response(response, Card)
+        warn "[DEPRECATION] 'get_card' is deprecated. Please use 'customer_vault.get_card' instead."
+        customer_vault.get_card(profile_id: profile_id, id: id)
       end
 
       def update_card(profile_id:, id:, month:, year:, **args)
@@ -136,10 +101,9 @@ module Paysafe
             month: month,
             year: year
           }
-        }).reject { |key, value| value.nil? }.to_camel_case
-
-        response = put(path: "/customervault/v1/profiles/#{profile_id}/cards/#{id}", data: data)
-        process_response(response, Card)
+        }).reject { |key, value| value.nil? }
+        warn "[DEPRECATION] 'update_card' is deprecated. Please use 'customer_vault.update_card' instead with new params format: #{data}"
+        customer_vault.update_card(profile_id: profile_id, id: id, **data)
       end
 
       def purchase(amount:, token:, merchant_ref_num:, **args)
@@ -150,81 +114,21 @@ module Paysafe
           card: {
             payment_token: token
           }
-        }).to_camel_case
-
-        response = post(path: "/cardpayments/v1/accounts/#{account_number}/auths", data: data)
-        process_response(response, Authorization)
+        })
+        warn "[DEPRECATION] 'purchase' is deprecated. Please use 'card_payments.create_authorization' instead with new params format: #{data}"
+        card_payments.create_authorization(**data)
       end
 
       def create_verification_from_token(merchant_ref_num:, token:, **args)
+        warn "[DEPRECATION] 'create_verification_from_token' is deprecated. Please use 'card_payments.create_verification' instead with new params format."
         data = args.merge({
           merchant_ref_num: merchant_ref_num,
           card: {
             payment_token: token
           }
-        }).to_camel_case
-
-        response = post(path: "/cardpayments/v1/accounts/#{account_number}/verifications", data: data)
-        process_response(response, Verification)
-      end
-
-      def verify_card(merchant_ref_num:, number:, month:, year:, cvv:, address:, **args)
-        data = args.merge({
-          merchant_ref_num: merchant_ref_num,
-          billing_details: address,
-          card: {
-            card_num: number,
-            cvv: cvv,
-            card_expiry: {
-              month: month,
-              year: year
-            }
-          }
-        }).to_camel_case
-
-        response = post(path: "/cardpayments/v1/accounts/#{account_number}/verifications", data: data)
-        process_response(response, Verification)
-      end
-
-      private
-
-      def http_client
-        HTTP
-          .headers(HEADERS)
-          .timeout(timeouts ? timeouts : :null)
-          .basic_auth(user: api_key, pass: api_secret)
-      end
-
-      def post(path:, data:)
-        http_client.post("#{api_base}#{path}", json: data)
-      end
-
-      def get(path:)
-        http_client.get("#{api_base}#{path}")
-      end
-
-      def delete(path:)
-        http_client.delete("#{api_base}#{path}")
-      end
-
-      def put(path:, data:)
-        http_client.put("#{api_base}#{path}", json: data)
-      end
-
-      def process_response(response, klass=nil)
-        data = parse_response_body(response.to_s)
-
-        if response.status.success?
-          klass&.new(data)
-        else
-          fail Error.from_response(data, response.code)
-        end
-      end
+        })
 
-      def parse_response_body(body)
-        return nil if body.strip.empty?
-        JSON.parse(body, symbolize_names: true)&.to_snake_case
-      rescue JSON::ParserError
+        card_payments.create_verification(**data)
       end
 
     end

data/lib/paysafe/verification.rb

@@ -12,13 +12,13 @@ module Paysafe
 
     [:unknown, :not_processed, :no_match, :match, :match_address_only, :match_zip_only].each do |key|
       define_method("avs_#{key}?") do
-        avs_response == key.to_s.upcase
+        avs_response.to_s.upcase == key.to_s.upcase
       end
     end
 
     [:unknown, :match, :no_match, :not_processed].each do |key|
       define_method("cvv_#{key}?") do
-        cvv_verification == key.to_s.upcase
+        cvv_verification.to_s.upcase == key.to_s.upcase
       end
     end
   end

data/lib/paysafe/version.rb

@@ -1,3 +1,3 @@
 module Paysafe
-  VERSION = "0.9.4"
+  VERSION = "0.10.0"
 end

data/paysafe.gemspec

@@ -19,15 +19,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 2.4'
 
-  spec.add_dependency "http", '>= 2.2.1', '< 5'
+  spec.add_dependency "http", '>= 4', '< 5'
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "minitest-mock_expectations"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paysafe
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.0
 platform: ruby
 authors:
 - Javier Julio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-24 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -100,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -136,11 +150,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.sample"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -148,11 +163,22 @@ files:
 - bin/setup
 - lib/paysafe.rb
 - lib/paysafe/address.rb
+- lib/paysafe/api/base_api.rb
+- lib/paysafe/api/card_payments_api.rb
+- lib/paysafe/api/customer_vault_api.rb
+- lib/paysafe/api/payments_api.rb
 - lib/paysafe/authorization.rb
 - lib/paysafe/birth_date.rb
 - lib/paysafe/card.rb
 - lib/paysafe/card_expiry.rb
+- lib/paysafe/configuration.rb
+- lib/paysafe/customer.rb
 - lib/paysafe/error.rb
+- lib/paysafe/gateway_response.rb
+- lib/paysafe/payment.rb
+- lib/paysafe/payment_method.rb
+- lib/paysafe/payment_methods.rb
+- lib/paysafe/payment_processor.rb
 - lib/paysafe/profile.rb
 - lib/paysafe/refinements/camel_case.rb
 - lib/paysafe/refinements/snake_case.rb
@@ -174,14 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A Ruby interface to the Paysafe REST API.

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.4
-  - 2.4.7
-  - 2.5.6
-  - 2.6.4
-before_install:
-  - gem update --system
-  - gem install bundler
-cache: bundler
-sudo: false
-fast_finish: true
-env:
-  - SKIP_INTEGRATION=true
-notifications:
-  email:
-    on_success: always
-    on_failure: always