fat_zebra_multi 3.1.0.1

data/lib/fat_zebra/customer.rb

@@ -0,0 +1,26 @@
+module FatZebra
+  ##
+  # == FatZebra \Customer
+  #
+  # Manage customer for the API
+  #
+  # * search
+  # * save
+  # * find
+  # * delete
+  #
+  class Customer < APIResource
+
+    include FatZebra::APIOperation::Search
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Save
+    include FatZebra::APIOperation::Delete
+
+    validates :first_name, required: true, on: :create
+    validates :last_name, required: true, on: :create
+    validates :reference, required: true, on: :create
+    validates :email, required: true, on: :create
+    validates :ip_address, required: true, on: :create
+
+  end
+end

data/lib/fat_zebra/direct_credit.rb

@@ -0,0 +1,26 @@
+module FatZebra
+  ##
+  # == FatZebra \Direct \Credit
+  #
+  # Manage direct credit for the API
+  #
+  # * search
+  # * save
+  # * find
+  # * delete
+  #
+  class DirectCredit < APIResource
+
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Search
+    include FatZebra::APIOperation::Save
+    include FatZebra::APIOperation::Delete
+
+    validates :description, required: true, on: :create
+    validates :amount, required: true, type: :positive_float, on: :create
+    validates :bsb, required: true, on: :create
+    validates :account_name, required: true, on: :create
+    validates :account_number, required: true, on: :create
+
+  end
+end

data/lib/fat_zebra/direct_debit.rb

@@ -0,0 +1,26 @@
+module FatZebra
+  ##
+  # == FatZebra \Direct \Debit
+  #
+  # Manage direct debit for the API
+  #
+  # * search
+  # * save
+  # * find
+  # * delete
+  #
+  class DirectDebit < APIResource
+
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Search
+    include FatZebra::APIOperation::Save
+    include FatZebra::APIOperation::Delete
+
+    validates :description, required: true, on: :create
+    validates :amount, required: true, type: :positive_float, on: :create
+    validates :bsb, required: true, on: :create
+    validates :account_name, required: true, on: :create
+    validates :account_number, required: true, on: :create
+
+  end
+end

data/lib/fat_zebra/errors.rb

@@ -0,0 +1,37 @@
+module FatZebra
+
+  ##
+  # Configuration Error
+  class ConfigurationError < StandardError; end
+
+  ##
+  # Validations for the request
+  class RequestValidationError < StandardError; end
+
+  ##
+  # 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

data/lib/fat_zebra/fat_zebra_object.rb

@@ -0,0 +1,68 @@
+module FatZebra
+  ##
+  # == FatZebra \Object
+  #
+  # Define the API objects
+  class FatZebraObject
+    include ObjectHelper
+    extend Validation
+
+    attr_reader :accepted
+    alias accepted? accepted
+
+    class << self
+
+      ##
+      # Initialize from the API response
+      #
+      # @return [FatZebra::FatZebraObject]
+      def initialize_from(response)
+        object = new
+
+        object.load_response_api(response.is_a?(Hash) ? response : JSON.parse(response))
+
+        if object.raw['response']
+          if object.raw['response'].is_a?(Array)
+            object.raw['response'].each { |response_object| object.add_data(initialize_from(response_object)) }
+          else
+            object.update_attributes(object.raw['response'])
+          end
+        else
+          object.update_attributes(object.raw)
+        end
+
+        object
+      end
+
+    end
+
+    ##
+    # Update the object based on the response from the API
+    # Remove and new acessor
+    #
+    # @param [Hash] response
+    #
+    # @return [FatZebra::FatZebraObject]
+    def update_from(response)
+      load_response_api(response.is_a?(Hash) ? response : JSON.parse(response))
+
+      # attributes to remove
+      (@values.keys - raw['response'].keys).each { |key| remove_accessor(key) }
+
+      update_attributes(raw['response'])
+
+      self
+    end
+
+    ##
+    # Load the root components for the API response
+    #
+    # @param [Hash] values
+    def load_response_api(response)
+      @raw        = response
+      @accepted   = response['successful']
+      @errors     = response['errors']
+    end
+
+  end
+end

data/lib/fat_zebra/information.rb

@@ -0,0 +1,29 @@
+module FatZebra
+  ##
+  # == FatZebra \Information
+  #
+  # Manage information for the API
+  #
+  # * ping
+  #
+  class Information < APIResource
+    class << self
+
+      def base_path(_account)
+        ''
+      end
+
+      ##
+      # Ping the API
+      #
+      # @param [String] echo param
+      #
+      # @return [FatZebra::Information] response
+      def ping(nonce = SecureRandom.hex)
+        response = request(:get, 'ping', echo: nonce)
+        initialize_from(response)
+      end
+
+    end
+  end
+end

data/lib/fat_zebra/object_helper.rb

@@ -0,0 +1,119 @@
+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

@@ -0,0 +1,61 @@
+module FatZebra
+  ##
+  # == FatZebra \Payment \Plan
+  #
+  # Manage payment plan for the API
+  #
+  # * save
+  # * find
+  # * delete
+  # * suspend!
+  # * active!
+  #
+  class PaymentPlan < APIResource
+
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Save
+    include FatZebra::APIOperation::Delete
+
+    validates :payment_method, required: true, on: :create
+    validates :customer, required: true, on: :create
+    validates :reference, required: true, on: :create
+    validates :setup_fee, required: true, on: :create
+    validates :amount, required: true, on: :create
+    validates :start_date, required: true, on: :create
+    validates :frequency, required: true, on: :create
+    validates :anniversary, required: true, on: :create
+    validates :total_count, required: true, on: :create
+    validates :total_amount, required: true, on: :create
+
+    ##
+    # Suspend a payment plan
+    #
+    # @param [Hash] params
+    # @param [Hash] options for the request, and configurations (Optional)
+    #
+    # @return [FatZebra::PaymentPlan]
+    def suspend!(params = {}, options = {})
+      params = {
+        new_status: 'Suspended'
+      }.merge(params)
+
+      save(params, options)
+    end
+
+    ##
+    # Activate a payment plan
+    #
+    # @param [Hash] params
+    # @param [Hash] options for the request, and configurations (Optional)
+    #
+    # @return [FatZebra::PaymentPlan]
+    def active!(params = {}, options = {})
+      params = {
+        new_status: 'Active'
+      }.merge(params)
+
+      save(params, options)
+    end
+
+  end
+end

data/lib/fat_zebra/purchase.rb

@@ -0,0 +1,96 @@
+module FatZebra
+  ##
+  # == FatZebra \Purchase
+  #
+  # Manage purchase for the API
+  #
+  # * search
+  # * save
+  # * find
+  # * void
+  # * settlement
+  # * refund
+  # * capture
+  #
+  class Purchase < APIResource
+
+    include FatZebra::APIOperation::Find
+    include FatZebra::APIOperation::Search
+    include FatZebra::APIOperation::Save
+    include FatZebra::APIOperation::Void
+
+    validates :card_number, required: { unless: %i[card_token wallet] }, on: :create
+    validates :card_token, required: { unless: %i[card_number wallet] }, on: :create
+    validates :card_expiry, required: { unless: %i[card_token wallet] }, on: :create
+    validates :amount, required: true, type: :positive_integer, on: :create
+    validates :reference, required: true, on: :create
+    validates :customer_ip, required: true, on: :create
+
+    validates :from, required: true, on: :settlement
+    validates :to, required: true, on: :settlement
+
+    class << self
+
+      ##
+      # Create a payment plan
+      # Default currency to AUD
+      #
+      # @param [Hash] params
+      # @param [Hash] options for the request, and configurations (Optional)
+      #
+      # @return [FatZebra::PaymentPlan]
+      def create(params, options = {})
+        params[:currency] ||= 'AUD'
+
+        super(params, options)
+      end
+
+      ##
+      # Return all the settlements
+      #
+      # @param [Hash] params (from and to are date required)
+      # @param [Hash] options for the request, and configurations (Optional)
+      #
+      # @return [FatZebra::Purchase]
+      def settlement(params = {}, options = {})
+        valid!(params, :settlement) if respond_to?(:valid!)
+
+        response = request(:get, "#{resource_path}/settlement", params, options)
+        initialize_from(response)
+      end
+
+    end
+
+    ##
+    # Refunds the current purchase
+    #
+    # @param [Hash] params for refund API (Optional)
+    # @param [Hash] options for the request, and configurations (Optional)
+    #
+    # @return [FatZebra::Refund] object
+    def refund(params = {}, options = {})
+      Refund.create({
+        transaction_id: id,
+        amount:         amount,
+        reference:      reference
+      }.merge(params), options)
+    end
+
+    ##
+    # Captures an authorization
+    #
+    # @param [Hash] params for capture API (Optional)
+    # @param [Hash] options for the request, and configurations (Optional)
+    #
+    # @return [Response] Purchase response object
+    def capture(params = {}, options = {})
+      params = {
+        amount: amount
+      }.merge(params)
+
+      response = request(:post, resource_path("purchases/#{id}/capture"), params, options)
+      update_from(response)
+    end
+
+  end
+end