fat_zebra_multi 3.1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee47c7e08352ee5db3f0648ccbb0331af1e0cbf6e2364cddbae5525f747cf5a0
+  data.tar.gz: 57a95b2cd2f58cd814798f990bb5b03267dd42e607febcfd7c568f57a44709ee
+SHA512:
+  metadata.gz: 7914d2d1e23cdce79db77fb6ea0aeab26039344b2cc5a1d3157089ebad6e577d693048f3c901d1a70345a1ff97063b165e89f579c29120e475507bb81134b2eb
+  data.tar.gz: 1fd30cea517d76df7612752972f83089a33a201092d8b3dd6483a5ece8faa01eecb3bb895d534d09c52ce9471bff407b8d030b64fcab3b82692f876164dd0e6b

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+doc/

data/.rubocop.yml

@@ -0,0 +1,44 @@
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+Style/MethodMissingSuper:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 27
+Metrics/LineLength:
+  Max: 200
+Metrics/ClassLength:
+  CountComments: false
+  Max: 200
+Metrics/MethodLength:
+  CountComments: false
+  Max: 25
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Documentation:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - tmp/**/*
+    - spec/**/*

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in FatZebra.gemspec
+gemspec

data/README.md

@@ -0,0 +1,104 @@
+Ruby API Library for Fat Zebra
+==============================
+
+[![Build Status](https://travis-ci.org/supporterhub/fat-zebra-api-client.svg?branch=master)](https://travis-ci.org/supporterhub/fat-zebra-api-client)
+
+A Ruby client for the [Fat Zebra](https://www.fatzebra.com.au) Online Payment Gateway (for Australian Merchants)
+
+This is an unofficial fork of the Fat Zebra API client. This version has been patched to allow multiple accounts to be used simultaneously.
+
+Version 3.1.0.1 of this gem aims to be a drop-in replacement for version 3.1.0 of the official gem.
+
+It aims to maintain parity with the [official Fat Zebra API client](https://github.com/fatzebra/Ruby-Library).
+
+Dependencies
+------------
+
+ * Ruby (tested on 2.3, 2.4, 2.5, 2.6)
+ * Rest Client
+
+Installing
+----------
+
+    gem install fat_zebra_multi
+
+Or in a Rails App (or similar, with Bundler), in your Gemfile:
+
+    gem "fat_zebra_multi"
+
+Usage
+-----
+
+With one account:
+```ruby
+require 'fat_zebra_multi'
+
+# Configuration only needs to be done once, usually in your rails initializers
+FatZebra.configure do |config|
+  config.username = 'TEST'
+  config.token    = 'TEST'
+end
+
+purchase = FatZebra::Purchase.create(
+  amount:      10000,
+  card_holder: 'Bill Simpson',
+  card_number: '5123456789012346',
+  card_expiry: '05/2023',
+  cvv:         '123',
+  reference:   'ORDER-23',
+  customer_ip: '203.99.87.4'
+)
+
+if purchase.successful?
+  puts "Transaction ID: #{purchase.id}"
+else
+  abort "Error in transaction: #{purchase.errors}"
+end
+```
+
+With multiple accounts:
+```ruby
+require 'fat_zebra_multi'
+
+account_1 = FatZebra::Config.new(
+  username:  'USERNAME_1',
+  token:     'API_TOKEN_1',
+)
+
+account_2 = FatZebra::Config.new(
+  username:  'USERNAME_2',
+  token:     'API_TOKEN_2',
+)
+
+purchase = FatZebra::Purchase.create({
+  amount:      10000,
+  card_holder: 'Bill Simpson',
+  card_number: '5123456789012346',
+  card_expiry: '05/2023',
+  cvv:         '123',
+  reference:   'ORDER-23',
+  customer_ip: '203.99.87.4'
+}, {
+  account: account_1
+})
+
+if purchase.successful?
+  puts "Transaction ID: #{purchase.id}"
+else
+  abort "Error in transaction: #{purchase.errors}"
+end
+```
+
+
+Documentation
+-------------
+
+Full API reference can be found at http://docs.fatzebra.com.au
+
+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.
+
+Pull Requests
+-------------
+If you would like to contribute to the plugin please fork the project, make your changes within a feature branch and then submit a pull request. All pull requests will be reviewed as soon as possible and integrated into the main branch if deemed suitable.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task default: :spec
+
+desc 'Run the unit tests (alias of `spec`)'
+task test: :spec

data/fat_zebra_multi.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'fat_zebra/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'fat_zebra_multi'
+  s.version     = FatZebra::VERSION
+  s.authors     = ['Matthew Savage']
+  s.email       = ['matt@amasses.net']
+  s.homepage    = ''
+  s.summary     = 'Unofficial fork of the Fat Zebra API client - 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.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 'rake'
+  s.add_development_dependency 'rspec', '~> 3.6'
+  s.add_development_dependency 'rubocop', '~> 0.58.1'
+  s.add_development_dependency 'vcr', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 3.0'
+
+  s.required_ruby_version = '~> 2.3'
+end

data/lib/fat_zebra.rb

@@ -0,0 +1,65 @@
+# Libraries
+require 'securerandom'
+require 'json'
+require 'ostruct'
+require 'net/http'
+require 'cgi'
+require 'date'
+
+require 'fat_zebra/version'
+require 'fat_zebra/util'
+require 'fat_zebra/config'
+require 'fat_zebra/errors'
+require 'fat_zebra/validation'
+require 'fat_zebra/object_helper'
+require 'fat_zebra/fat_zebra_object'
+require 'fat_zebra/request'
+require 'fat_zebra/api_helper'
+require 'fat_zebra/api_resource'
+
+# API Operations
+require 'fat_zebra/api_operation/find'
+require 'fat_zebra/api_operation/search'
+require 'fat_zebra/api_operation/save'
+require 'fat_zebra/api_operation/delete'
+require 'fat_zebra/api_operation/void'
+
+# API Resources
+require 'fat_zebra/purchase'
+require 'fat_zebra/information'
+require 'fat_zebra/card'
+require 'fat_zebra/refund'
+require 'fat_zebra/payment_plan'
+require 'fat_zebra/customer'
+require 'fat_zebra/direct_debit'
+require 'fat_zebra/direct_credit'
+require 'fat_zebra/bank_account'
+require 'fat_zebra/web_hook'
+require 'fat_zebra/batch'
+
+##
+# Implementation of the FatZebra
+module FatZebra
+  class << self
+
+    ##
+    # @return [FatZebra::Config] configurations
+    attr_reader :configurations
+
+    ##
+    # Configures the FatZebra API
+    #
+    # @example Default configuration
+    #   FatZebra.configure do |config|
+    #     config.username = 'my-username'
+    #     config.token    = 'my-token'
+    #   end
+    def configure
+      yield @configurations = FatZebra::Config.new
+
+      FatZebra.configurations.valid!
+    end
+
+  end
+
+end

data/lib/fat_zebra/api_helper.rb

@@ -0,0 +1,91 @@
+module FatZebra
+  ##
+  # == FatZebra \Helper
+  #
+  # Help for the api resource
+  module APIHelper
+
+    module ClassMethods
+
+      ##
+      # @return [String] resource path
+      def resource_path(path = nil)
+        (path || @resource_name || CGI.escape(resource_name)).to_s
+      end
+
+      ##
+      # @return [String] resource name
+      def resource_name
+        Util.underscore("#{class_name}s")
+      end
+
+      ##
+      # @return [String] the class name
+      def class_name
+        name.split('::').last
+      end
+
+      ##
+      # Send a request to the API
+      def request
+        raise NotImplementedError
+      end
+
+      def build_endpoint_url(base_url, path, params = nil, options = {})
+        host, port = base_url.split(':')
+        port       = port.to_i if port
+
+        url_params = Util.compact(
+          host:  host,
+          path:  path,
+          port:  port,
+          query: params
+        )
+
+        return URI::HTTPS.build(url_params) if options[:http_secure]
+        URI::HTTP.build(url_params)
+      end
+
+      def default_headers
+        {
+          headers: {
+            accept:       'application/json',
+            content_type: 'application/json'
+          }
+        }
+      end
+
+    end
+
+    ##
+    # @return [String] resource name
+    def resource_name
+      self.class.resource_name
+    end
+
+    ##
+    # @return [String] resource path
+    def resource_path(path = nil)
+      self.class.resource_path(path)
+    end
+
+    ##
+    # Send a request to the API
+    #
+    # @param [Symbol] method for the request
+    # @param [String] endpoint for the request
+    # @param [Hash] options
+    # @param [Hash] Payload
+    #
+    # @return [Hash] response
+    # @raise [FatZebra::RequestError] if the request is invalid
+    def request(method, resource_path, payload = {}, options = {})
+      self.class.request(method, resource_path, payload, options)
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+  end
+end

data/lib/fat_zebra/api_operation/delete.rb

@@ -0,0 +1,38 @@
+module FatZebra
+  class APIOperation
+    ##
+    # == Delete a resource for the API
+    #
+    module Delete
+      module ClassMethods
+        ##
+        # Delete an API Resource
+        #
+        # @param [String] id for the request
+        # @param [Hash] Additional options for the request
+        #
+        # @return [FatZebra::Object] response from the API
+        def delete(id, options = {})
+          response = request(:delete, "#{resource_path}/#{id}", options)
+          initialize_from(response)
+        end
+      end
+
+      ##
+      # Delete an API Resources
+      #
+      # @param [Hash] Additional options for the request
+      #
+      # @return [FatZebra::Object] response from the API
+      def destroy(options = {})
+        response = request(:delete, "#{resource_path}/#{id}", {}, options)
+        update_from(response)
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/fat_zebra/api_operation/find.rb

@@ -0,0 +1,30 @@
+module FatZebra
+  class APIOperation
+    ##
+    # == Find a resource for the API
+    #
+    module Find
+      module ClassMethods
+
+        ##
+        # Find an API Resource
+        #
+        # @param [String] id for the request
+        # @param [Hash] params for the request
+        # @param [Hash] Additional options for the request
+        #
+        # @return [FatZebra::Object] response from the API
+        def find(id, params = {}, options = {})
+          response = request(:get, "#{resource_path}/#{id}", params, options)
+          initialize_from(response)
+        end
+
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end