fat_zebra 3.0.0 → 3.0.1

data/lib/fat_zebra/fat_zebra_object.rb

@@ -4,20 +4,11 @@ module FatZebra
   #
   # Define the API objects
   class FatZebraObject
+    include ObjectHelper
     extend Validation
 
-    ##
-    # @return [Hash] JSON parsed response
-    attr_reader :raw
-
-    ##
-    # @return [Hash] JSON parsed response
-    attr_reader :data
-
-    attr_reader :successful
-    alias successful? successful
-
-    attr_reader :errors
+    attr_reader :accepted
+    alias accepted? accepted
 
     class << self
 
@@ -45,17 +36,6 @@ module FatZebra
 
     end
 
-    ##
-    # Initialize and create accessor for values
-    #
-    # @params [Hash] values
-    def initialize(values = {})
-      @data   = []
-      @values = {}
-
-      update_attributes(values)
-    end
-
     ##
     # Update the object based on the response from the API
     # Remove and new acessor
@@ -74,106 +54,15 @@ module FatZebra
       self
     end
 
-    ##
-    # get attribute value
-    def [](key)
-      @values[key.to_sym]
-    end
-
-    ##
-    # set attribute value
-    def []=(key, value)
-      send(:"#{key}=", value)
-    end
-
-    ##
-    # @return [Array] all the keys
-    def keys
-      @values.keys
-    end
-
-    ##
-    # @return [Hash] values to hash
-    def to_hash
-      @values
-    end
-
-    ##
-    # @return [JSON] values to JSON
-    def to_json
-      JSON.generate(@values)
-    end
-
-    ##
-    # Update the attribute and add accessor for new attributes
-    #
-    # @param [Hash] values
-    def update_attributes(attributes)
-      attributes.each do |(key, value)|
-        add_accessor(key, value)
-      end
-    end
-
     ##
     # Load the root components for the API response
     #
     # @param [Hash] values
     def load_response_api(response)
       @raw        = response
-      @successful = response['successful']
+      @accepted   = response['successful']
       @errors     = response['errors']
     end
 
-    ##
-    # Add data for sub-object
-    #
-    # @param [Object] data
-    def add_data(data)
-      @data << data
-    end
-
-    protected
-
-    def inspect
-      id_string = respond_to?(:id) && !id.nil? ? " id=#{id}" : ''
-      "#<#{self.class}:0x#{object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
-    end
-
-    def method_missing(name, *args)
-      super unless name.to_s.end_with?('=')
-
-      attribute = name.to_s[0...-1].to_sym
-      value     = args.first
-
-      add_accessor(attribute, value)
-    end
-
-    private
-
-    def add_accessors(keys, payload = raw)
-      keys.each do |key|
-        add_accessor(key, payload[key])
-      end
-    end
-
-    def add_accessor(name, value)
-      @values[name] = value
-
-      define_singleton_method(name) { @values[name] }
-      define_singleton_method(:"#{name}=") do |v|
-        @values[name] = v
-      end
-
-      define_singleton_method(:"#{name}?") { value } if [FalseClass, TrueClass].include?(value.class)
-    end
-
-    def remove_accessor(name)
-      @values.delete(name)
-
-      singleton_class.class_eval { remove_method name.to_sym } if singleton_methods.include?(name.to_sym)
-      singleton_class.class_eval { remove_method "#{name}=".to_sym } if singleton_methods.include?("#{name}=".to_sym)
-      singleton_class.class_eval { remove_method "#{name}?".to_sym } if singleton_methods.include?("#{name}?".to_sym)
-    end
-
   end
 end

data/lib/fat_zebra/object_helper.rb

@@ -0,0 +1,118 @@
+module FatZebra
+  ##
+  # == Object \Helper
+  #
+  # API objects helper
+  module ObjectHelper
+
+    ##
+    # @return [Hash] JSON parsed response
+    attr_reader :raw
+
+    ##
+    # @return [Hash] JSON parsed response
+    attr_reader :data
+
+    attr_reader :errors
+
+    ##
+    # Initialize and create accessor for values
+    #
+    # @params [Hash] values
+    def initialize(values = {})
+      @data   = []
+      @values = {}
+      @errors = []
+
+      update_attributes(values)
+    end
+
+    ##
+    # get attribute value
+    def [](key)
+      @values[key.to_sym]
+    end
+
+    ##
+    # set attribute value
+    def []=(key, value)
+      send(:"#{key}=", value)
+    end
+
+    ##
+    # @return [Array] all the keys
+    def keys
+      @values.keys
+    end
+
+    ##
+    # @return [Hash] values to hash
+    def to_hash
+      @values
+    end
+
+    ##
+    # @return [JSON] values to JSON
+    def to_json(_object = nil)
+      JSON.generate(@values)
+    end
+
+    ##
+    # Update the attribute and add accessor for new attributes
+    #
+    # @param [Hash] values
+    def update_attributes(attributes)
+      attributes.each do |(key, value)|
+        add_accessor(key, value)
+      end
+    end
+
+    ##
+    # Add data for sub-object
+    #
+    # @param [Object] data
+    def add_data(data)
+      @data << data
+    end
+
+    def inspect
+      id_string = respond_to?(:id) && !id.nil? ? " id=#{id}" : ''
+      "#<#{self.class}:0x#{object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
+    end
+
+    def method_missing(name, *args)
+      super unless name.to_s.end_with?('=')
+
+      attribute = name.to_s[0...-1].to_sym
+      value     = args.first
+
+      add_accessor(attribute, value)
+    end
+
+    def add_accessors(keys, payload = raw)
+      keys.each do |key|
+        add_accessor(key, payload[key])
+      end
+    end
+
+    def add_accessor(name, value)
+      @values[name] = value
+
+      define_singleton_method(name) { @values[name] }
+      define_singleton_method(:"#{name}=") do |v|
+        @values[name] = v
+      end
+
+      define_singleton_method(:"#{name}?") { value } if [FalseClass, TrueClass].include?(value.class)
+    end
+
+    def remove_accessor(name)
+      @values.delete(name)
+
+      singleton_class.class_eval { remove_method name.to_sym } if singleton_methods.include?(name.to_sym)
+      singleton_class.class_eval { remove_method "#{name}=".to_sym } if singleton_methods.include?("#{name}=".to_sym)
+      singleton_class.class_eval { remove_method "#{name}?".to_sym } if singleton_methods.include?("#{name}?".to_sym)
+    end
+
+  end
+end

data/lib/fat_zebra/payment_plan.rb

@@ -12,8 +12,7 @@ module FatZebra
   #
   class PaymentPlan < APIResource
 
-    extend FatZebra::APIOperation::Find
-
+    include FatZebra::APIOperation::Find
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Delete
 

data/lib/fat_zebra/purchase.rb

@@ -14,9 +14,8 @@ module FatZebra
   #
   class Purchase < APIResource
 
-    extend FatZebra::APIOperation::Find
-    extend FatZebra::APIOperation::Search
-
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Search
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Void
 
@@ -54,9 +53,7 @@ module FatZebra
       #
       # @return [FatZebra::Purchase]
       def settlement(params = {}, options = {})
-        valid!(params, :settlement)
-
-        params = Util.format_dates_in_hash(params)
+        valid!(params, :settlement) if respond_to?(:valid!)
 
         response = request(:get, "#{resource_path}/settlement", params, options)
         initialize_from(response)

data/lib/fat_zebra/refund.rb

@@ -11,13 +11,11 @@ module FatZebra
   #
   class Refund < APIResource
 
-    extend FatZebra::APIOperation::Find
-    extend FatZebra::APIOperation::Search
-
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Search
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Void
 
-    validates :transaction_id, required: true, on: :create
     validates :amount, required: true, on: :create
     validates :reference, required: true, on: :create
 

data/lib/fat_zebra/request.rb

@@ -102,18 +102,20 @@ module FatZebra
       response = http.request(request)
 
       case [response.code_type]
-      when [Net::HTTPBadRequest]
-        raise RequestError, 'Bad Data'
+      when [Net::HTTPOK], [Net::HTTPCreated], [Net::HTTPAccepted]
+        response
       when [Net::HTTPUnauthorized]
-        raise RequestError, 'Unauthorized, please check your username and token'
+        raise RequestError.new(response, message: 'Unauthorized, please check your authentication username or token')
       when [Net::HTTPNotFound]
-        raise RequestError, 'Requested Resource not found'
+        raise RequestError.new(response, message: 'Requested Resource not found')
+      when [Net::HTTPRequestTimeOut]
+        raise RequestError.new(response, message: 'Verify the address for the service')
       when [Net::HTTPInternalServerError]
-        raise RequestError, 'Server Error, please check with Gateway'
+        raise RequestError.new(response, message: 'Server Error, please check with service')
       when [Net::HTTPNotImplemented]
-        raise RequestError, 'Problem processing your request - please check your data'
+        raise RequestError.new(response, message: 'Problem processing your request - please check your data')
       else
-        response
+        raise RequestError, response
       end
     end
 
@@ -135,7 +137,9 @@ module FatZebra
 
     def set_header
       params[:headers].each do |(type, value)|
-        request[type.to_s] = value
+        formated_type = type.to_s.split(/_/).map(&:capitalize).join('-')
+
+        request[formated_type] = value
       end
     end
 

data/lib/fat_zebra/util.rb

@@ -3,6 +3,11 @@ module FatZebra
     class << self
 
       DATE_FORMAT = '%Y/%m/%d'.freeze
+      REGEXP_HTTP = %r{http[s]?\:\/\/}
+
+      def cleanup_host(uri)
+        uri.gsub(REGEXP_HTTP, '')
+      end
 
       ##
       # Remove nil value from hash
@@ -12,12 +17,23 @@ module FatZebra
         hash.reject { |_, value| value.nil? }
       end
 
+      ##
+      # Convert string to camelize
+      #
+      # @param [String]
+      #
+      # @example
+      #   camelize('my_model') => 'MyModel'
+      def camelize(string)
+        string.split('_').map(&:capitalize).join
+      end
+
       ##
       # Encodes a hash of parameters in a way that's suitable for use as query
       # parameters in a URI or as form parameters in a request body. This mainly
       # involves escaping special characters from parameter keys and values (e.g.
       # `&`).
-      def encode_parameters(params)
+      def encode_parameters(params = {})
         params.map { |k, v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&')
       end
 

data/lib/fat_zebra/version.rb

@@ -1,3 +1,3 @@
 module FatZebra
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.1'.freeze
 end

data/lib/fat_zebra/web_hook.rb

@@ -10,8 +10,7 @@ module FatZebra
   #
   class WebHook < APIResource
 
-    extend FatZebra::APIOperation::Search
-
+    include FatZebra::APIOperation::Search
     include FatZebra::APIOperation::Save
     include FatZebra::APIOperation::Delete
 

data/lib/fat_zebra.rb

@@ -6,8 +6,10 @@ 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

data/spec/cassettes/FatZebra_BankAccount/_create/1_1_3.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://gateway.sandbox.fatzebra.com.au/v1.0/bank_accounts
+    body:
+      encoding: UTF-8
+      string: '{"bsb":"123-123","account_name":"Test name","account_number":"012345678","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: 201
+      message: Created
+    headers:
+      Date:
+      - Wed, 05 Jul 2017 05:53:07 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      X-Rack-Cache:
+      - invalidate, pass
+      Cache-Control:
+      - no-store
+      X-Request-Version:
+      - 1.19.41
+      X-Runtime:
+      - '0.035026'
+      Pragma:
+      - no-cache
+      X-Request-Id:
+      - bcad35c76e583e129d7d5dfa8f1bc793
+      X-Backend:
+      - sbox-priv-gateway-a
+    body:
+      encoding: UTF-8
+      string: '{"successful":true,"response":{"id":"071-B-YO282XDY","account_name":"Test
+        name","account_number":"012345678","bsb":"123-123","created_at":"2017-07-05T15:53:07+10:00"},"errors":[],"test":true}'
+    http_version: 
+  recorded_at: Wed, 05 Jul 2017 05:53:07 GMT
+recorded_with: VCR 3.0.3

data/spec/cassettes/FatZebra_Batch/_create/with_file/1_1_1_3.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://gateway.sandbox.fatzebra.com.au/v1.0/batches
+    body:
+      encoding: UTF-8
+      string: "------FatZebraMultipartPost\r\nContent-Disposition: form-data; name=\"BATCH-v1-PURCHASE-TEST-20170705-016bcc0661feae5d0219ab95fadb7e6b.csv\";
+        filename=\"BATCH-v1-PURCHASE-TEST-20170705-016bcc0661feae5d0219ab95fadb7e6b.csv\"\r\nContent-Length:
+        \r\nContent-Type: text/csv\r\nContent-Transfer-Encoding: binary\r\n\r\n1000,AUD,Order12345,John
+        Doe 1,4444333322221111,12/2020,,Gizmo ABC 1\n2051,AUD,Order22345,John Doe
+        2,4444333322221111,12/2020,,Gizmo ABC 2\n3000,AUD,Order32345,John Doe 3,4444333322221111,12/2020,,Gizmo
+        ABC 3\n4000,AUD,Order42345,John Doe 4,4444333322221111,12/2020,,Gizmo ABC
+        4\n\r\n------FatZebraMultipartPost\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\nBATCH-v1-PURCHASE-TEST-20170705-016bcc0661feae5d0219ab95fadb7e6b.csv------FatZebraMultipartPost\r\nContent-Disposition:
+        form-data; name=\"test\"\r\n\r\ntrue------FatZebraMultipartPost--\r\n"
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Authorization:
+      - Basic VEVTVDpURVNU
+      Content-Length:
+      - '835'
+      Content-Type:
+      - multipart/form-data; boundary=----FatZebraMultipartPost
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Wed, 05 Jul 2017 05:53:07 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      X-Rack-Cache:
+      - invalidate, pass
+      Cache-Control:
+      - no-store
+      X-Request-Version:
+      - 1.19.41
+      X-Runtime:
+      - '0.064812'
+      Pragma:
+      - no-cache
+      X-Purge-File:
+      - 'false'
+      X-Request-Id:
+      - a9a9e729847e1c03f2447852998a6582
+      X-Backend:
+      - sbox-priv-gateway-a
+    body:
+      encoding: UTF-8
+      string: '{"successful":true,"response":{"id":"071-BF-SU4GOW5I","filename":"BATCH-v1-PURCHASE-TEST-20170705-016bcc0661feae5d0219ab95fadb7e6b.csv","created_at":"2017-07-05T15:53:07+10:00","process_date":"2017-07-05","start_date":null,"completed_date":null,"status":"New","type":"PURCHASE","reference":"016bcc0661feae5d0219ab95fadb7e6b"},"errors":[],"test":false}'
+    http_version: 
+  recorded_at: Wed, 05 Jul 2017 05:53:07 GMT
+recorded_with: VCR 3.0.3

data/spec/cassettes/FatZebra_Batch/_create/with_path/1_1_2_3.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://gateway.sandbox.fatzebra.com.au/v1.0/batches
+    body:
+      encoding: UTF-8
+      string: "------FatZebraMultipartPost\r\nContent-Disposition: form-data; name=\"filename\"\r\n\r\nBATCH-v1-PURCHASE-TEST-20170705-06bde31e33f2417ec7a57eb9f996eaa6.csv------FatZebraMultipartPost\r\nContent-Disposition:
+        form-data; name=\"BATCH-v1-PURCHASE-TEST-20170705-06bde31e33f2417ec7a57eb9f996eaa6.csv\";
+        filename=\"BATCH-v1-PURCHASE-TEST-20170705-06bde31e33f2417ec7a57eb9f996eaa6.csv\"\r\nContent-Length:
+        \r\nContent-Type: text/csv\r\nContent-Transfer-Encoding: binary\r\n\r\n1000,AUD,Order12345,John
+        Doe 1,4444333322221111,12/2020,,Gizmo ABC 1\n2051,AUD,Order22345,John Doe
+        2,4444333322221111,12/2020,,Gizmo ABC 2\n3000,AUD,Order32345,John Doe 3,4444333322221111,12/2020,,Gizmo
+        ABC 3\n4000,AUD,Order42345,John Doe 4,4444333322221111,12/2020,,Gizmo ABC
+        4\n\r\n------FatZebraMultipartPost\r\nContent-Disposition: form-data; name=\"test\"\r\n\r\ntrue------FatZebraMultipartPost--\r\n"
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Authorization:
+      - Basic VEVTVDpURVNU
+      Content-Length:
+      - '835'
+      Content-Type:
+      - multipart/form-data; boundary=----FatZebraMultipartPost
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Wed, 05 Jul 2017 05:53:08 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      Cache-Control:
+      - no-store
+      X-Request-Version:
+      - 1.19.41
+      Pragma:
+      - no-cache
+      X-Request-Id:
+      - 21f2aa35b9f2c324344231a5e81b04f6
+      X-Runtime:
+      - '0.032829'
+      X-Purge-File:
+      - 'false'
+      X-Rack-Cache:
+      - invalidate, pass
+      X-Backend:
+      - sbox-priv-gateway-a
+    body:
+      encoding: UTF-8
+      string: '{"successful":true,"response":{"id":"071-BF-20AR3L72","filename":"BATCH-v1-PURCHASE-TEST-20170705-06bde31e33f2417ec7a57eb9f996eaa6.csv","created_at":"2017-07-05T15:53:08+10:00","process_date":"2017-07-05","start_date":null,"completed_date":null,"status":"New","type":"PURCHASE","reference":"06bde31e33f2417ec7a57eb9f996eaa6"},"errors":[],"test":false}'
+    http_version: 
+  recorded_at: Wed, 05 Jul 2017 05:53:08 GMT
+recorded_with: VCR 3.0.3