fat_zebra 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2d528ebf041ec5f73b61570237e3547dc3d9d45
-  data.tar.gz: c8b2990d36c46054972c47fe5272f21002e648b6
+  metadata.gz: 0ac27cea9c7baf7c382f97bb6eadeede98ebdd03
+  data.tar.gz: 31a7ebdd9646a45834a478ae3b8d2cbb142232fa
 SHA512:
-  metadata.gz: 92da2daddc57c3250bc439cb7a29553de9fb0db58536ff01e34fe77cc22604ac26f129075eae2b6b40af0fa5a3c53b541c9c89f99b8d558808bcce07b65fa1a4
-  data.tar.gz: 590f8fc2a63c58f2e1004bbddb1ebadccebf81f25c0e1d94336c2ccf62b2522cb5f35f5973e575ac28262fe39c89d25baac574d4817b767de2cc95348b160f96
+  metadata.gz: c8e625b2825444e7cc694e751d3ec572ed17a2560255fe096882089033192c7306ed6e8a46dbf2fc20c57469b0011df4cde81b05c2725e6727326ec74dbf670c
+  data.tar.gz: 7fd6085163d5071a61e61a934b5c2c6a1d5d59146799e3759341549d5eb246075f8eee37ccdc25d2a7aa13e92cc20c19c2003dc7c4ae9495ca7d9578224f5dce

data/.rubocop.yml

@@ -13,7 +13,7 @@ Style/NumericPredicate:
 Metrics/AbcSize:
   # The ABC size is a calculated magnitude, so this number can be a Fixnum or
   # a Float.
-  Max: 25
+  Max: 27
 Metrics/LineLength:
   Max: 200
 Metrics/ClassLength:
@@ -25,6 +25,8 @@ Metrics/MethodLength:
 Metrics/ModuleLength:
   CountComments: false
   Max: 200
+Metrics/CyclomaticComplexity:
+  Max: 7
 
 Documentation:
   Enabled: false

data/fat_zebra.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.require_paths = %w[lib]
 
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '~> 3.6'
   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'
+  s.add_development_dependency 'vcr', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 3.0'
+  s.add_development_dependency 'rubocop', '~> 0.49'
 end

data/lib/fat_zebra/api_helper.rb

@@ -0,0 +1,95 @@
+module FatZebra
+  ##
+  # == FatZebra \Helper
+  #
+  # Help for the api resource
+  module APIHelper
+
+    module ClassMethods
+
+      def base_path
+        ''
+      end
+
+      ##
+      # @return [String] resource path
+      def resource_path(path = nil)
+        "/#{base_path}#{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
+      def request
+        raise 'need to be implemented'
+      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/find.rb

@@ -4,18 +4,25 @@ module FatZebra
     # == 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)
+        ##
+        # 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

data/lib/fat_zebra/api_operation/save.rb

@@ -14,7 +14,7 @@ module FatZebra
         #
         # @return [FatZebra::Object] response from the API
         def create(params = {}, options = {})
-          valid!(params, :create)
+          valid!(params, :create) if respond_to?(:valid!)
 
           response = request(:post, resource_path, params, options)
           initialize_from(response)
@@ -29,7 +29,7 @@ module FatZebra
         #
         # @return [FatZebra::Object] response from the API
         def update(id, params = {}, options = {})
-          valid!(params, :update)
+          valid!(params, :update) if respond_to?(:valid!)
 
           response = request(:put, "#{resource_path}/#{id}", params, options)
           initialize_from(response)

data/lib/fat_zebra/api_operation/search.rb

@@ -12,19 +12,26 @@ module FatZebra
         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)
+      module ClassMethods
+
+        ##
+        # 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)
+
+          response = request(:get, resource_path, params, options)
+          initialize_from(response)
+        end
+
+      end
 
-        response = request(:get, resource_path, params, options)
-        initialize_from(response)
+      def self.included(base)
+        base.extend(ClassMethods)
       end
 
     end

data/lib/fat_zebra/api_operation/void.rb

@@ -15,7 +15,7 @@ module FatZebra
         #
         # @return [FatZebra::Object] response from the API
         def void(id, params = {}, options = {})
-          valid!(params, :void)
+          valid!(params, :void) if respond_to?(:valid!)
 
           params = {
             id: id

data/lib/fat_zebra/api_resource.rb

@@ -4,51 +4,12 @@ module FatZebra
   #
   # 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
+    include APIHelper
 
     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]
+      def base_path
+        "#{configurations.api_version}/"
       end
 
       ##
@@ -63,13 +24,9 @@ module FatZebra
       # @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)
+        payload        = Util.format_dates_in_hash(payload)
+        url_params     = Util.encode_parameters(payload) if method == :get
+        uri            = build_endpoint_url(configurations.gateway, path, url_params, http_secure: configurations.http_secure)
 
         request_options = Util.compact(
           method:  method,
@@ -77,7 +34,7 @@ module FatZebra
           payload: payload,
           proxy:   configurations.proxy,
           use_ssl: configurations.http_secure
-        ).merge(authentication).merge(headers).merge(options)
+        ).merge(authentication).merge(default_headers).merge(configurations.global_options).merge(options)
 
         request = Request.execute(request_options)
 
@@ -86,20 +43,6 @@ module FatZebra
 
       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
         {
@@ -117,15 +60,6 @@ module FatZebra
         }
       end
 
-      def headers
-        {
-          headers: {
-            accept:       'application/json',
-            content_type: 'application/json'
-          }
-        }
-      end
-
       def configurations
         FatZebra.configurations
       end

data/lib/fat_zebra/bank_account.rb

@@ -9,8 +9,7 @@ module FatZebra
   #
   class BankAccount < APIResource
 
-    extend FatZebra::APIOperation::Search
-
+    include FatZebra::APIOperation::Search
     include FatZebra::APIOperation::Save
 
     validates :account_name, required: true, on: :create

data/lib/fat_zebra/batch.rb

@@ -12,9 +12,8 @@ module FatZebra
   class Batch < APIResource
     @resource_name = 'batches'
 
-    extend FatZebra::APIOperation::Search
-    extend FatZebra::APIOperation::Find
-
+    include FatZebra::APIOperation::Search
+    include FatZebra::APIOperation::Find
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Delete
 
@@ -50,6 +49,9 @@ module FatZebra
     # @return [String] formated as CSV
     def result(params = {}, options = {})
       request(:get, "#{resource_path}/#{id}/result.csv", params, options)
+    rescue FatZebra::RequestError => error
+      return error.http_body if error.http_status == 422
+      raise
     end
 
   end

data/lib/fat_zebra/card.rb

@@ -11,10 +11,11 @@ module FatZebra
 
     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_holder, required: { unless: %i[wallet] }, on: :create
+    validates :card_number, required: { unless: %i[wallet] }, on: :create
+    validates :card_expiry, required: { unless: %i[wallet] }, on: :create
+
+    validates :wallet, required: { unless: %i[card_number] }, on: :create
 
     validates :card_expiry, required: true, on: :update
 

data/lib/fat_zebra/config.rb

@@ -5,6 +5,11 @@ module FatZebra
   # Represent the FatZebra configuration for the API
   class Config
 
+    GATEWAY_URLS = {
+      production: 'gateway.fatzebra.com.au',
+      sandbox:    'gateway.sandbox.fatzebra.com.au'
+    }.freeze
+
     ##
     # @return [String] Username
     attr_accessor :username
@@ -17,14 +22,6 @@ module FatZebra
     # @return [String] Test mode
     attr_accessor :test_mode
 
-    ##
-    # @return [String] Sandbox
-    attr_accessor :sandbox
-
-    ##
-    # @return [String] Options
-    attr_accessor :options
-
     ##
     # @return [String] Gateway url
     attr_accessor :gateway
@@ -41,27 +38,36 @@ module FatZebra
     # @return [String] api version
     attr_accessor :api_version
 
+    ##
+    # @return [String] global request options
+    attr_accessor :global_options
+
     ##
     # @param [Hash{Symbol=>Object}]
     # Initialize and validate the configuration
     def initialize(options = {})
-      self.token       = options[:token]
-      self.username    = options[:username]
-      self.gateway     = options[:gateway] || 'gateway.fatzebra.com.au'
-      self.test_mode   = options[:test_mode] || false
-      self.http_secure = options[:http_secure] || true
-      self.api_version = options[:api_version] || 'v1.0'
-      self.sandbox     = options[:sandbox]
-      self.options     = options[:options]
-      self.proxy       = options[:proxy]
+      self.token          = options[:token]
+      self.username       = options[:username]
+      self.gateway        = options[:gateway] || :production
+      self.test_mode      = options[:test_mode] || false
+      self.http_secure    = options[:http_secure] || true
+      self.api_version    = options[:api_version] || 'v1.0'
+      self.proxy          = options[:proxy]
+      self.global_options = options[:global_options] || {}
+
+      valid! unless options.empty?
     end
 
     ##
     # validate the configuration
     # Raise when configuration is not valid
+    # Remove "http://" or "https://" from urls
+    #
     # @return [Boolean] true
     def valid!
-      %i[username token].each do |field|
+      format!
+
+      %i[username token gateway api_version].each do |field|
         validate_presence(field)
       end
 
@@ -70,6 +76,13 @@ module FatZebra
 
     private
 
+    def format!
+      self.gateway = GATEWAY_URLS[gateway] if gateway.is_a?(Symbol)
+
+      self.gateway = Util.cleanup_host(gateway)
+      self.proxy   = Util.cleanup_host(proxy) if proxy
+    end
+
     def validate_presence(field)
       raise FatZebra::ConfigurationError, "#{field} can't be blank" if send(field).nil? || send(field).empty?
     end

data/lib/fat_zebra/customer.rb

@@ -11,9 +11,8 @@ module FatZebra
   #
   class Customer < APIResource
 
-    extend FatZebra::APIOperation::Search
-    extend FatZebra::APIOperation::Find
-
+    include FatZebra::APIOperation::Search
+    include FatZebra::APIOperation::Find
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Delete
 

data/lib/fat_zebra/direct_credit.rb

@@ -11,9 +11,8 @@ module FatZebra
   #
   class DirectCredit < APIResource
 
-    extend FatZebra::APIOperation::Find
-    extend FatZebra::APIOperation::Search
-
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Search
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Delete
 

data/lib/fat_zebra/direct_debit.rb

@@ -11,9 +11,8 @@ module FatZebra
   #
   class DirectDebit < APIResource
 
-    extend FatZebra::APIOperation::Find
-    extend FatZebra::APIOperation::Search
-
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Search
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Delete
 

data/lib/fat_zebra/errors.rb

@@ -4,10 +4,6 @@ module FatZebra
   # Configuration Error
   class ConfigurationError < StandardError; end
 
-  ##
-  # Request to API Error
-  class RequestError < StandardError; end
-
   ##
   # Validations for the request
   class RequestValidationError < StandardError; end
@@ -16,4 +12,26 @@ module FatZebra
   # Method unknown for the request
   class UnknownRequestMethod < StandardError; end
 
+  ##
+  # Request to API Error
+  class RequestError < StandardError
+
+    attr_reader :http_body
+    attr_reader :http_status
+    attr_reader :http_status_type
+    attr_reader :http_message
+
+    def initialize(response, message: nil)
+      @http_status      = response.code.to_i
+      @http_status_type = response.code_type
+      @http_body        = response.body
+      @http_message     = message || response.message
+    end
+
+    def to_s
+      "Status #{http_status}: #{http_message}"
+    end
+
+  end
+
 end