fat_zebra 2.0.13 → 3.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWFkOTI1MGY3NWY2YmUxN2E5ZGEzMGFjN2YxM2I0ZjI5MmRhNTA0MA==
-  data.tar.gz: !binary |-
-    OGExZDFlYzVkODNlYWFhZDkwY2ZkZGQ3MzE1NDRmODFjYzNjODE1NQ==
+SHA1:
+  metadata.gz: a2d528ebf041ec5f73b61570237e3547dc3d9d45
+  data.tar.gz: c8b2990d36c46054972c47fe5272f21002e648b6
 SHA512:
-  metadata.gz: !binary |-
-    ODk5MmI4ODFkZjY2NzIwYzkzMGNiOGJiM2Y2Y2I2MzcxNGJmZTA0N2YxMjJm
-    YTAxMGRkOGE2N2FjNjU0M2FjNjMxZjA4MzE5MzI4ZmYyNzlhODNlNDY1ODVj
-    ODJkOTUzOGE2NTVmMmZhY2Y3YjMwNTk1MzIzMjVjNjU2NGJmNGM=
-  data.tar.gz: !binary |-
-    ZjE3NDVhNmIyNWVjNjNkOTNmOTBmZWY0OTVlNDAxOTkzOGYxNTRlOWQwMTkz
-    MjM3ZDk5OWU5ZjllYTcxMWM2Y2I1ZWQ1MzkxNjhiYWYyM2RhNTM3NmM4MmI3
-    NzQ5NmU4MmMyMzJmNmIzNTE5YzNhNDBhYWZiMWZjY2Q3ZGU5NDM=
+  metadata.gz: 92da2daddc57c3250bc439cb7a29553de9fb0db58536ff01e34fe77cc22604ac26f129075eae2b6b40af0fa5a3c53b541c9c89f99b8d558808bcce07b65fa1a4
+  data.tar.gz: 590f8fc2a63c58f2e1004bbddb1ebadccebf81f25c0e1d94336c2ccf62b2522cb5f35f5973e575ac28262fe39c89d25baac574d4817b767de2cc95348b160f96

data/.rubocop.yml

@@ -0,0 +1,42 @@
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 25
+Metrics/LineLength:
+  Max: 200
+Metrics/ClassLength:
+  CountComments: false
+  Max: 200
+Metrics/MethodLength:
+  CountComments: false
+  Max: 25
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200
+
+Documentation:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Include:
+    - Gemfile
+    - Rakefile
+    - Capfile
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - tmp/**/*
+    - spec/**/*

data/.travis.yml

@@ -1,4 +1,11 @@
+cache: bundler
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+script:
+  - bundle exec rspec spec
+  - bundle exec rubocop

data/Gemfile

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

data/{README.markdown → README.md}

@@ -1,18 +1,17 @@
 Ruby API Library for Fat Zebra
 ==============================
 
-Release 2.0.0  for API version 1.0
+[![Build Status](https://travis-ci.org/fatzebra/Ruby-Library.svg?branch=master)](https://travis-ci.org/fatzebra/Ruby-Library)
+
+Release 3.0.0  for API version 1.0
 
 A Ruby client for the [Fat Zebra](https://www.fatzebra.com.au) Online Payment Gateway (for Australian Merchants)
 
 Dependencies
 ------------
 
- * Ruby (tested on 1.9.3, 2.0.0)
+ * Ruby (tested on 2.0, 2.1, 2.2, 2.3, 2.4)
  * Rest Client
- * JSON
-
- [![Build Status](https://secure.travis-ci.org/fatzebra/Ruby-Library.png?branch=master)](http://travis-ci.org/fatzebra/Ruby-Library)
 
 Installing
 ----------
@@ -31,24 +30,24 @@ require 'fat_zebra'
 
 # Configuration only needs to be done once, usually in your rails initializers
 FatZebra.configure do |config|
-  config.username "TEST"
-  config.token    "TEST"
-  config.gateway  "gateway.fatzebra.com.au"
+  config.username = 'TEST'
+  config.token    = 'TEST'
 end
 
-card_data = {
-	number: "5123456789012346",
-	card_holder: "Bill Simpson",
-	expiry: "05/2023",
-	cvv: "123"
-}
-
-response = FatZebra::Models::Purchase.create(10000, card_data, "ORDER-23", "203.99.87.4")
-
-if response.successful? && response.result.successful
-	puts "Transaction ID: #{response.result.id}"
+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: #{response.errors}"
+  abort "Error in transaction: #{purchase.errors}"
 end
 ```
 

data/Rakefile

@@ -1,18 +1,8 @@
-require "bundler/gem_tasks"
+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
-
-begin
-	require 'yard'
-	desc "Run the YARDdoc task"
-	task :yard do
-		exec "yardoc --plugin yard-tomdoc"
-	end
-rescue LoadError
-	puts "Please install the Yard gem to create docs"
-end
+task default: :spec

data/fat_zebra.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+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.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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = %w[lib]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'rubocop'
+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,23 @@
+module FatZebra
+  class APIOperation
+    ##
+    # == Find a resource for the API
+    #
+    module Find
+
+      ##
+      # 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
+  end
+end

data/lib/fat_zebra/api_operation/save.rb

@@ -0,0 +1,62 @@
+module FatZebra
+  class APIOperation
+    ##
+    # == Save (create or update) a resource for the API
+    #
+    module Save
+      module ClassMethods
+
+        ##
+        # Create an API Resource and validate the params for the API.
+        #
+        # @param [Hash] params for the request
+        # @param [Hash] Additional options for the request
+        #
+        # @return [FatZebra::Object] response from the API
+        def create(params = {}, options = {})
+          valid!(params, :create)
+
+          response = request(:post, resource_path, params, options)
+          initialize_from(response)
+        end
+
+        ##
+        # Update an API Resource and validate params for the API
+        #
+        # @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 update(id, params = {}, options = {})
+          valid!(params, :update)
+
+          response = request(:put, "#{resource_path}/#{id}", params, options)
+          initialize_from(response)
+        end
+
+      end
+
+      ##
+      # Create or Update an API Resource
+      #
+      # @param [Hash] params for the request
+      # @param [Hash] Additional options for the request
+      #
+      # @return [FatZebra::Object] response from the API
+      def save(params = {}, options = {})
+        path   = singleton_methods.include?(:id) ? "#{resource_path}/#{id}" : resource_path
+        method = singleton_methods.include?(:id) ? :put : :post
+
+        response = request(method, path, to_hash.merge(params), options)
+        update_from(response)
+      end
+      alias update save
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/fat_zebra/api_operation/search.rb

@@ -0,0 +1,32 @@
+module FatZebra
+  class APIOperation
+    ##
+    # == Search resources for the API
+    #
+    module Search
+
+      ##
+      # Default params for the API
+      DEFAULT_PARAMS = {
+        offets: 0,
+        limit: 10
+      }.freeze
+
+      ##
+      # Search for API Resources
+      #
+      # @param [Hash] params for the request
+      # @param [Hash] Additional options for the request
+      #
+      # @return [FatZebra::Object] response from the API
+      def search(params = {}, options = {})
+        params = DEFAULT_PARAMS.merge(params)
+        params = Util.format_dates_in_hash(params)
+
+        response = request(:get, resource_path, params, options)
+        initialize_from(response)
+      end
+
+    end
+  end
+end

data/lib/fat_zebra/api_operation/void.rb

@@ -0,0 +1,52 @@
+module FatZebra
+  class APIOperation
+    ##
+    # == Void a resource for the API
+    #
+    module Void
+      module ClassMethods
+
+        ##
+        # Void an API Resource and validate params for the API
+        #
+        # @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 void(id, params = {}, options = {})
+          valid!(params, :void)
+
+          params = {
+            id: id
+          }.merge(params)
+
+          response = request(:post, "#{resource_path}/void", params, options)
+          initialize_from(response)
+        end
+
+      end
+
+      ##
+      # Void an API Resource
+      #
+      # @param [Hash] params for the request
+      # @param [Hash] Additional options for the request
+      #
+      # @return [FatZebra::Object] response from the API
+      def void(params = {}, options = {})
+        params = {
+          id: id
+        }.merge(params)
+
+        response = request(:post, "#{resource_path}/void", params, options)
+        update_from(response)
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/fat_zebra/api_resource.rb

@@ -0,0 +1,135 @@
+module FatZebra
+  ##
+  # == FatZebra \API \Resource
+  #
+  # Define the API requests methods
+  class APIResource < FatZebraObject
+
+    ##
+    # @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
+
+    class << self
+
+      ##
+      # @return [String] resource path
+      def resource_path(path = nil)
+        "/#{configurations.api_version}/#{path || @resource_name || CGI.escape(resource_name)}"
+      end
+
+      ##
+      # @return [String] resource name
+      def resource_name
+        Util.underscore("#{class_name}s")
+      end
+
+      ##
+      # @return [String] the class name
+      def class_name
+        name.split('::')[-1]
+      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, path, payload = {}, options = {})
+        payload[:test] = true if configurations.test_mode
+
+        if method == :get
+          url_params = !payload.empty? && Util.encode_parameters(payload)
+          payload    = nil
+        end
+
+        uri = build_endpoint_url(path, url_params)
+
+        request_options = Util.compact(
+          method:  method,
+          url:     uri.to_s,
+          payload: payload,
+          proxy:   configurations.proxy,
+          use_ssl: configurations.http_secure
+        ).merge(authentication).merge(headers).merge(options)
+
+        request = Request.execute(request_options)
+
+        request.body
+      end
+
+      private
+
+      def build_endpoint_url(path, params = nil)
+        host, port = configurations.gateway.split(':')
+
+        url_params = Util.compact(
+          host:  host,
+          path:  path,
+          port:  port,
+          query: params
+        )
+
+        return URI::HTTPS.build(url_params) if configurations.http_secure
+        URI::HTTP.build(url_params)
+      end
+
+      def ssl_options
+        return {} unless configurations.http_secure
+        {
+          ca_file:     File.expand_path(File.dirname(__FILE__) + '/../../vendor/cacert.pem'),
+          verify_mode: OpenSSL::SSL::VERIFY_PEER
+        }
+      end
+
+      def authentication
+        {
+          basic_auth: {
+            user:     configurations.username,
+            password: configurations.token
+          }
+        }
+      end
+
+      def headers
+        {
+          headers: {
+            accept:       'application/json',
+            content_type: 'application/json'
+          }
+        }
+      end
+
+      def configurations
+        FatZebra.configurations
+      end
+
+    end
+  end
+end

data/lib/fat_zebra/bank_account.rb

@@ -0,0 +1,21 @@
+module FatZebra
+  ##
+  # == FatZebra \Bank \Account
+  #
+  # Manage bank account for the API
+  #
+  # * search
+  # * save
+  #
+  class BankAccount < APIResource
+
+    extend FatZebra::APIOperation::Search
+
+    include FatZebra::APIOperation::Save
+
+    validates :account_name, required: true, on: :create
+    validates :account_number, required: true, on: :create
+    validates :bsb, required: true, on: :create
+
+  end
+end

data/lib/fat_zebra/batch.rb

@@ -0,0 +1,56 @@
+module FatZebra
+  ##
+  # == FatZebra \Batch
+  #
+  # Manage Batch for the API
+  #
+  # * create
+  # * search
+  # * find
+  # * result
+  #
+  class Batch < APIResource
+    @resource_name = 'batches'
+
+    extend FatZebra::APIOperation::Search
+    extend FatZebra::APIOperation::Find
+
+    include FatZebra::APIOperation::Save
+    include FatZebra::APIOperation::Delete
+
+    validates :filename, required: true, class_type: String, on: :create
+    validates :file, required: true, class_type: File, on: :create
+    validates :multipart, required: true, class_type: TrueClass, on: :create
+
+    class << self
+
+      ##
+      # Upload a batch file
+      #
+      # @param [Hash] params for the request
+      # @param [Hash] Additional options for the request
+      #
+      # @return [FatZebra::Batch] response from the API
+      def create(params, options = {})
+        params[:multipart] = true
+        params[:content_type] = 'text/csv'
+        params[:file] = File.new(params.delete(:path)) if params.key?(:path)
+
+        super(params, options)
+      end
+
+    end
+
+    ##
+    # Return result from the batch
+    #
+    # @param [Hash] params for capture API (Optional)
+    # @param [Hash] options for the request, and configurations (Optional)
+    #
+    # @return [String] formated as CSV
+    def result(params = {}, options = {})
+      request(:get, "#{resource_path}/#{id}/result.csv", params, options)
+    end
+
+  end
+end

data/lib/fat_zebra/card.rb

@@ -0,0 +1,22 @@
+module FatZebra
+  ##
+  # == FatZebra \Card
+  #
+  # Manage credit card for the API
+  #
+  # * save
+  #
+  class Card < APIResource
+    @resource_name = 'credit_cards'
+
+    include FatZebra::APIOperation::Save
+
+    validates :card_holder, required: true, on: :create
+    validates :card_number, required: true, on: :create
+    validates :card_expiry, required: true, on: :create
+    validates :cvv, required: true, on: :create
+
+    validates :card_expiry, required: true, on: :update
+
+  end
+end