fat_zebra 3.1.0 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa90ecc2f14542b9afd815d07d056cbcc4568bb1
-  data.tar.gz: 087a34525732fdccc0841212eae069af46a37728
+SHA256:
+  metadata.gz: ce036c9eb7ff13fb1c6f60e6b0e4230299ccdb3384e4359959426d75c9a8e42b
+  data.tar.gz: b55070ec65cbbad8c82ed8974c572dc0cc9eae5d38b3d49a0446dd91febc1570
 SHA512:
-  metadata.gz: 28366c271ee752e25f8f126c94874fe2f2fcccbc7cd30fa607c3ac4089cca41e1c0897e2918e6ff6325ed842365943aaeb2c0e862af4db8f8d8f3a1ccc67e4e2
-  data.tar.gz: 59a415cf84ea85aec23991dc7c09235c58957f8e4b047da6c3e8dfa896189559f1531f27d8fc94b0fa94cfcdc94fc6a4773954b931ae9099896a1d23458e09e2
+  metadata.gz: 741c6e12a74bc6f05de8b1b04794476dd3dd1c711db11e093ccba35768e753657c5289d8151458140f8e582f971eb0d0876bd9240151df6ba97ac12b577f8e16
+  data.tar.gz: 9aee0585dd4f0addde3fbf1ce4408a8905ccf2c336994a9a46d4fd7b2dd6a0d11d1bf9b1c6a33af4f6148b790cfe097de5739f645395a269c684e34cc6e18b96

data/.gitignore

@@ -4,3 +4,5 @@ Gemfile.lock
 pkg/*
 .yardoc
 doc/
+.byebug_history
+.ruby-version

data/.travis.yml

@@ -1,10 +1,11 @@
 cache: bundler
 language: ruby
 rvm:
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
+  - 2.7
 script:
   - bundle exec rspec spec
   - bundle exec rubocop

data/README.md

@@ -3,14 +3,14 @@ Ruby API Library for Fat Zebra
 
 [![Build Status](https://travis-ci.org/fatzebra/Ruby-Library.svg?branch=master)](https://travis-ci.org/fatzebra/Ruby-Library)
 
-Release 3.1.0  for API version 1.0
+Release 3.2.3 for API version 1.0
 
-A Ruby client for the [Fat Zebra](https://www.fatzebra.com.au) Online Payment Gateway (for Australian Merchants)
+A Ruby client for the [Fat Zebra](https://www.fatzebra.com) Online Payment Gateway
 
 Dependencies
 ------------
 
- * Ruby (tested on 2.0, 2.1, 2.2, 2.3, 2.4)
+ * Ruby (tested on 2.3, 2.4, 2.5, 2.6)
  * Rest Client
 
 Installing
@@ -54,11 +54,11 @@ end
 Documentation
 -------------
 
-Full API reference can be found at http://docs.fatzebra.com.au
+Full API reference can be found at http://docs.fatzebra.com
 
 Support
 -------
-If you have any issue with the Fat Zebra Ruby Client please contact us at support@fatzebra.com.au and we will be more then happy to help out. Alternatively you may raise an issue in github.
+If you have any issue with the Fat Zebra Ruby Client please contact us at support@fatzebra.com and we will be more then happy to help out. Alternatively you may raise an issue in github.
 
 Pull Requests
 -------------

data/fat_zebra.gemspec

@@ -6,19 +6,17 @@ require 'fat_zebra/version'
 Gem::Specification.new do |s|
   s.name        = 'fat_zebra'
   s.version     = FatZebra::VERSION
-  s.authors     = ['Matthew Savage']
-  s.email       = ['matt@amasses.net']
+  s.authors     = ['Fat Zebra']
+  s.email       = ['support@fatzebra.com']
   s.homepage    = ''
   s.summary     = 'Fat Zebra payments gem - integrate your ruby app with Fat Zebra'
-  s.description = 'Provides integration with the Fat Zebra internet payment gateway (www.fatzebra.com.au), including purchase, refund, auth, capture and recurring billing functionality.'
-
-  s.rubyforge_project = 'fat_zebra'
+  s.description = 'Provides integration with the Fat Zebra internet payment gateway (www.fatzebra.com), including purchase, refund, auth, capture and recurring billing functionality.'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.require_paths = %w[lib]
 
-  s.add_development_dependency 'pry'
+  s.add_development_dependency 'byebug'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.6'
   s.add_development_dependency 'rubocop', '~> 0.58.1'

data/lib/fat_zebra.rb

@@ -28,6 +28,7 @@ require 'fat_zebra/api_operation/void'
 require 'fat_zebra/purchase'
 require 'fat_zebra/information'
 require 'fat_zebra/card'
+require 'fat_zebra/authenticate'
 require 'fat_zebra/refund'
 require 'fat_zebra/payment_plan'
 require 'fat_zebra/customer'
@@ -37,6 +38,13 @@ require 'fat_zebra/bank_account'
 require 'fat_zebra/web_hook'
 require 'fat_zebra/batch'
 
+# Paypal API Resources
+require 'fat_zebra/paypal/billing_agreement'
+require 'fat_zebra/paypal/order'
+require 'fat_zebra/paypal/authorization'
+require 'fat_zebra/paypal/capture'
+require 'fat_zebra/paypal/refund'
+
 ##
 # Implementation of the FatZebra
 module FatZebra

data/lib/fat_zebra/authenticate.rb

@@ -0,0 +1,64 @@
+module FatZebra
+  ##
+  # == FatZebra \Authenticate
+  #
+  # Manage 3DS2/SCA authentication for the API
+  #
+  # * session
+  # * authenticate
+  # * decode_session
+  #
+  class Authenticate < APIResource
+    @resource_name = 'authenticate'
+
+    validates :card_token, required: true, on: :authenticate
+    validates :sca, required: true, on: :authenticate
+    validates :token, required: true, on: :decode_session
+
+    class << self
+
+      ##
+      # Returns a JWT token for the 3DS authentication process
+      #
+      # @param [Hash] params
+      # @param [Hash] options for the request, and configurations (Optional)
+      #
+      # @return [FatZebra::Authenticate]
+      def session(params = {}, options = {})
+        valid!(params, :session) if respond_to?(:valid!)
+
+        response = request(:post, "#{resource_path}/session", params, options)
+        initialize_from(response)
+      end
+
+      ##
+      # Decodes a JWT token for the 3DS authentication process
+      #
+      # @param [Hash] params
+      # @param [Hash] options for the request, and configurations (Optional)
+      #
+      # @return [FatZebra::Authenticate]
+      def decode_session(params = {}, options = {})
+        valid!(params, :decode_session) if respond_to?(:valid!)
+
+        response = request(:get, "#{resource_path}/decode_session", params, options)
+        initialize_from(response)
+      end
+
+      ##
+      # Authenticates a 3ds request
+      #
+      # @param [Hash] params
+      # @param [Hash] options for the request, and configurations (Optional)
+      #
+      # @return [FatZebra::Authenticate]
+      def authenticate(params = {}, options = {})
+        valid!(params, :authenticate) if respond_to?(:valid!)
+
+        response = request(:post, resource_path, params, options)
+        initialize_from(response)
+      end
+    end
+
+  end
+end

data/lib/fat_zebra/card.rb

@@ -9,6 +9,7 @@ module FatZebra
   class Card < APIResource
     @resource_name = 'credit_cards'
 
+    include FatZebra::APIOperation::Find
     include FatZebra::APIOperation::Save
 
     validates :card_holder, required: { unless: %i[wallet] }, on: :create

data/lib/fat_zebra/paypal/authorization.rb

@@ -0,0 +1,49 @@
+module FatZebra
+  ##
+  # == FatZebra \Paypal::Authorization
+  #
+  # Manage PayPal Authorizations
+  #
+  # * search
+  # * find
+  # * capture
+  # * void
+  #
+  module Paypal
+    class Authorization < APIResource
+      include FatZebra::APIOperation::Find
+      include FatZebra::APIOperation::Search
+
+      class << self
+        def base_path
+          super + '/paypal/'
+        end
+
+        ##
+        # Capture a PayPal Authorization
+        #
+        # @param [String] Authorization id
+        # @param [Hash] params (amount, final_capture, note_to_payer)
+        # @param [Hash] options for the request, and configurations (Optional)
+        #
+        # @return [FatZebra::Paypal::Capture]
+        def capture(id, params = {}, options = {})
+          response = request(:post, resource_path("authorizations/#{id}/capture"), params, options)
+          FatZebra::Paypal::Capture.initialize_from(response)
+        end
+
+        ##
+        # Void a PayPal Authorization
+        #
+        # @param [String] Authorization id
+        # @param [Hash] options for the request, and configurations (Optional)
+        #
+        # @return [FatZebra::Authorization]
+        def void(id, options = {})
+          response = request(:post, resource_path("authorizations/#{id}/void"), {}, options)
+          initialize_from(response)
+        end
+      end
+    end
+  end
+end

data/lib/fat_zebra/paypal/billing_agreement.rb

@@ -0,0 +1,56 @@
+module FatZebra
+  ##
+  # == FatZebra \Paypal::BillingAgreement
+  #
+  # Manage PayPal Billing Agreements
+  #
+  # * search
+  # * find
+  # * charge
+  # * cancel
+  #
+  module Paypal
+    class BillingAgreement < APIResource
+      include FatZebra::APIOperation::Find
+      include FatZebra::APIOperation::Search
+
+      validates :purchases, required: true, on: :charge
+      validates :amount, required: true, on: :charge
+      validates :currency, required: true, on: :charge
+      validates :reference, required: true, on: :charge
+
+      class << self
+        def base_path
+          super + '/paypal/'
+        end
+
+        ##
+        # Charge a PayPal Billing Agreement
+        #
+        # @param [String] Billing Agreement id
+        # @param [Hash] params (currency, reference, amount, purchases)
+        # @param [Hash] options for the request, and configurations (Optional)
+        #
+        # @return [FatZebra::Paypal::Order]
+        def charge(id, params, options = {})
+          valid!(params, :charge) if respond_to?(:valid!)
+
+          response = request(:post, resource_path("billing_agreements/#{id}/charge"), params, options)
+          FatZebra::Paypal::Order.initialize_from(response)
+        end
+
+        ##
+        # Cancel a PayPal Billing Agreement
+        #
+        # @param [String] Billing Agreement id
+        # @param [Hash] options for the request, and configurations (Optional)
+        #
+        # @return [FatZebra::BillingAgreement]
+        def cancel(id, options = {})
+          response = request(:post, resource_path("billing_agreements/#{id}/cancel"), {}, options)
+          initialize_from(response)
+        end
+      end
+    end
+  end
+end

data/lib/fat_zebra/paypal/capture.rb

@@ -0,0 +1,36 @@
+module FatZebra
+  ##
+  # == FatZebra \Paypal::Capture
+  #
+  # Manage PayPal Captures
+  #
+  # * search
+  # * find
+  # * refund
+  #
+  module Paypal
+    class Capture < APIResource
+      include FatZebra::APIOperation::Find
+      include FatZebra::APIOperation::Search
+
+      class << self
+        def base_path
+          super + '/paypal/'
+        end
+
+        ##
+        # Refund a PayPal Capture
+        #
+        # @param [String] Capture id
+        # @param [Hash] params (amount, note_to_payer)
+        # @param [Hash] options for the request, and configurations (Optional)
+        #
+        # @return [FatZebra::Paypal::Refund]
+        def refund(id, params = {}, options = {})
+          response = request(:post, resource_path("captures/#{id}/refund"), params, options)
+          FatZebra::Paypal::Refund.initialize_from(response)
+        end
+      end
+    end
+  end
+end

data/lib/fat_zebra/paypal/order.rb

@@ -0,0 +1,22 @@
+module FatZebra
+  ##
+  # == FatZebra \Paypal::Order
+  #
+  # Manage PayPal Orders
+  #
+  # * search
+  # * find
+  #
+  module Paypal
+    class Order < APIResource
+      include FatZebra::APIOperation::Find
+      include FatZebra::APIOperation::Search
+
+      class << self
+        def base_path
+          super + '/paypal/'
+        end
+      end
+    end
+  end
+end

data/lib/fat_zebra/paypal/refund.rb

@@ -0,0 +1,22 @@
+module FatZebra
+  ##
+  # == FatZebra \Paypal::Refund
+  #
+  # Manage PayPal Refunds
+  #
+  # * search
+  # * find
+  #
+  module Paypal
+    class Refund < APIResource
+      include FatZebra::APIOperation::Find
+      include FatZebra::APIOperation::Search
+
+      class << self
+        def base_path
+          super + '/paypal/'
+        end
+      end
+    end
+  end
+end

data/lib/fat_zebra/purchase.rb

@@ -92,5 +92,28 @@ module FatZebra
       update_from(response)
     end
 
+    ##
+    # Extends an authorization expiry (if not already expired)
+    #
+    # @param [Hash] options for the request, and configurations (Optional)
+    #
+    # @return [Response] Purchase response object
+    def extend!(options = {})
+      response = request(:put, resource_path("purchases/#{id}"), { extend: true }, options)
+      update_from(response)
+    end
+
+    ##
+    # Increments an authorization amount
+    #
+    # @param [Int] amount to increment the authorization by
+    # @param [Hash] options for the request, and configurations (Optional)
+    #
+    # @return [Response] Purchase response object
+    def increment!(additional_amount, options = {})
+      raise ArgumentError, 'Amount must be a positive amount' unless additional_amount > 0
+      response = request(:put, resource_path("purchases/#{id}"), { amount: amount + additional_amount }, options)
+      update_from(response)
+    end
   end
 end

data/lib/fat_zebra/util.rb

@@ -6,7 +6,7 @@ module FatZebra
       REGEXP_HTTP = %r{http[s]?\:\/\/}
 
       def cleanup_host(uri)
-        uri.gsub(REGEXP_HTTP, '')
+        uri.to_s.gsub(REGEXP_HTTP, '')
       end
 
       ##

data/lib/fat_zebra/version.rb

@@ -1,3 +1,3 @@
 module FatZebra
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.4'.freeze
 end

data/spec/cassettes/FatZebra_Authenticate/_authenticate/validations/1_3_5_1.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://gateway.sandbox.fatzebra.com.au/v1.0/credit_cards
+    body:
+      encoding: UTF-8
+      string: '{"card_holder":"Matthew Savage","card_number":"5123456789012346","card_expiry":"02/2030","cvv":123,"test":true}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - application/json
+      User-Agent:
+      - Ruby
+      Authorization:
+      - Basic VEVTVDpURVNU
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Request-Version:
+      - 1.21.8
+      X-Request-Id:
+      - f7428654f99c8a3fbf1ed11296c3c3ea
+      X-Runtime:
+      - '0.273223'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"successful":true,"response":{"token":"bybox0zptr3u8xuvtu7n","card_holder":"Matthew
+        Savage","card_number":"512345XXXXXX2346","card_expiry":"2030-02-28","card_type":"MasterCard","card_category":"Credit","card_subcategory":"Standard","card_issuer":"Banco
+        Del Pichincha, C.A.","card_country":"Ecuador","authorized":true,"transaction_count":0,"alias":null},"errors":[],"test":true}'
+    http_version: 
+  recorded_at: Fri, 13 Dec 2019 03:37:01 GMT
+recorded_with: VCR 3.0.3