zipMoney 1.0.1

data/lib/zipMoney/api.rb

@@ -0,0 +1,192 @@
+module ZipMoney
+  class Api 
+
+    attr_accessor :options, :config, :payload, :response
+
+    HTTP_METHOD_POST  = :post
+    HTTP_METHOD_GET   = :get
+
+    # Initializes a new api object
+    #
+    # @param [conf] ZipMoney::Configuration
+    # @param [options] api options
+    #
+    # @return ZipMoney::Api instance
+    def initialize(conf,options={})         
+      if conf.new.class == ZipMoney::Configuration
+        @config = conf
+      else
+        raise ArgumentError, "Config is not valid"
+      end
+      @options = options
+    end
+    
+    # Appends api credentials to the request object
+    #
+    # @param [data] Request data
+    #
+    # @return data
+    def append_api_credentials(params)
+      is_param_defined(params) do
+        params = Struct::ApiCredentials.new
+        params.version = Struct::Version.new
+      end 
+      if params.merchant_id  == nil 
+         params.merchant_id  = self.config.merchant_id
+      end
+      if params.merchant_key == nil
+         params.merchant_key = self.config.merchant_key
+      end
+      if params.version.client == nil
+         params.version.client = ZipMoney::Configuration::API_NAME + " Version:" + ZipMoney::Configuration::API_VERSION
+      end
+      if params.version.platform == nil
+         params.version.platform = ZipMoney::Configuration::API_PLATFORM
+      end
+      params  
+    end 
+
+    # Checks if data is a Struct and calls the block passed as parameter if true
+    #
+    # @param [data] Request data
+    #
+    # @return true|false
+    def is_param_defined(params)
+      yield if !params.is_a?(Struct) 
+    end 
+
+    # Makes request to the zipMoney endpoint
+    #
+    # @param [resource] endpoint resource 
+    # @param [method] method  get|post
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def request(resource, method,  params = nil)      
+      resource = Resources.get(resource, method, params)
+      params   = append_api_credentials(params)
+
+      if method == :post
+        payload = prepare_params(params)
+      else
+        payload = {}
+      end
+
+      headers = @options[:headers] || {}
+      if method == :get 
+        resource.send(method, headers) do |response, request, result, &block| 
+            ZipMoney::Response.new(response)
+        end
+      else
+        resource.send(method, payload, headers) do |response, request, result, &block|
+          ZipMoney::Response.new(response)
+        end
+      end
+    end
+    
+    # Converts the parameters(Hash) to json
+    #
+    # @param [params] request parameters
+    #
+    # @return data as json
+    def prepare_params(params)
+      begin
+        params =  Util.struct_to_hash(params).to_json
+      rescue TypeError => e
+        if params.is_a?(Hash)
+          params = params.to_json
+        else  
+          raise ArgumentError, "Invalid params provided" 
+        end
+      rescue JSON::ParserError => e
+        if params.is_a?(Hash)
+           params = params.to_json
+        else  
+          raise ArgumentError, "Invalid params provided" 
+        end
+      end
+      params
+    end 
+
+    # Makes checkout call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def checkout(params)
+      request(Resources::RESOURCE_CHECKOUT, HTTP_METHOD_POST, params)
+    end 
+    
+    # Makes quote call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def quote(params)
+      request(Resources::RESOURCE_QUOTE, HTTP_METHOD_POST, params)
+    end 
+    
+    # Makes capture call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def capture(params)
+      request(Resources::RESOURCE_CAPTURE, HTTP_METHOD_POST, params)
+    end 
+    
+    # Makes refund call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def refund(params)
+      request(Resources::RESOURCE_REFUND, HTTP_METHOD_POST, params)
+    end 
+
+    # Makes cancel call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def cancel(params)
+      request(Resources::RESOURCE_CANCEL, HTTP_METHOD_POST, params)
+    end 
+
+    # Makes query call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def query(params)
+      request(Resources::RESOURCE_QUERY, HTTP_METHOD_POST, params)
+    end 
+
+    # Makes configure call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def configure(params)
+      request(Resources::RESOURCE_CONFIGURE, HTTP_METHOD_POST, params)
+    end 
+
+    # Makes settings call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def settings
+      request(Resources::RESOURCE_SETTINGS, HTTP_METHOD_POST)
+    end 
+
+    # Makes heartbeat call on the zipMoney endpoint
+    #
+    # @param [params] request parameters
+    #
+    # @return ZipMoney::Response object
+    def heartbeat
+      request(Resources::RESOURCE_HEARTBEAT, HTTP_METHOD_POST)
+    end 
+  end
+end

data/lib/zipMoney/api/cancel.rb

@@ -0,0 +1,44 @@
+module ZipMoney
+  class Cancel
+    include Request
+
+    attr_accessor :params
+    Struct.new("CancelParams", :txn_id, :merchant_id, :merchant_key, :order, :order_id, :quote_id, :reference, :version, :metadata)
+
+    # Initializes a ZipMoney::Cancel object
+    #
+    # Returns ZipMoney::Cancel object
+    def initialize 
+      @params      = Struct::CancelParams.new
+      @params.order    = Struct::Order.new
+      @params.order.detail =  Array.new
+      @params.metadata = Struct::Metadata.new
+      @params.version  = Struct::Version.new
+    end
+    
+    # Performs the Cancel api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Cancel object 
+    def do  
+      validate
+      ZipMoney.api.cancel(@params)
+    end
+
+    # Performs the parameters validation
+    def validate
+      raise ArgumentError, "Params emtpy" if @params.nil? 
+      @errors = []
+      @errors << 'txn_id must be provided' if @params.txn_id.nil? 
+      @errors << 'order must be provided' if @params.order.nil? 
+      @errors << 'order.id must be provided' if @params.order.id.nil? 
+      @errors << 'order.total must be provided' if@params.order.total.nil? 
+      @errors << 'order.shipping_value must be provided' if @params.order.shipping_value.nil? 
+      @errors << 'order.tax must be provided' if @params.order.tax.nil? 
+      @errors << 'order detail must be provided' if @params.order.detail.nil? 
+      
+      validate_item_details @params.order.detail
+
+      raise ZipMoney::RequestError.new("Following error(s) occurred while making request, please resolve them to make the request: #{@errors}") if @errors.any?
+    end
+  end
+end

data/lib/zipMoney/api/capture.rb

@@ -0,0 +1,44 @@
+module ZipMoney
+  class Capture
+    include Request
+
+    attr_accessor :params
+
+    Struct.new("CaptureParams",  :txn_id, :order_id, :quote_id, :order, :reference, :version, :metadata, :merchant_id, :merchant_key)
+    
+    # Initializes a ZipMoney::Capture object
+    #
+    # Returns ZipMoney::Capture object
+      def initialize 
+      @params      = Struct::CaptureParams.new
+      @params.order    = Struct::Order.new
+      @params.metadata = Struct::Metadata.new
+      @params.version  = Struct::Version.new
+      @params.order.detail = Array.new
+    end
+    
+    # Performs the Capture api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Cancel object 
+    def do  
+      validate
+      ZipMoney.api.capture(@params)
+    end
+
+    # Performs the parameters validation
+    def validate
+      raise ArgumentError, "Params emtpy" if @params.nil? 
+      @errors = []
+      @errors << 'txn_id must be provided' if @params.txn_id.nil? 
+      @errors << 'order.id must be provided' if @params.order.id.nil? 
+      @errors << 'order.total must be provided' if @params.order.total.nil? 
+      @errors << 'order.shipping_value must be provided' if @params.order.shipping_value.nil? 
+      @errors << 'order.tax must be provided' if @params.order.tax.nil? 
+      @errors << 'order detail must be provided' if @params.order.detail.nil? 
+      
+      validate_item_details @params.order.detail
+
+      raise ZipMoney::RequestError.new("Following error(s) occurred while making request, please resolve them to make the request: #{@errors}") if @errors.any?
+    end
+  end
+end

data/lib/zipMoney/api/checkout.rb

@@ -0,0 +1,52 @@
+module ZipMoney
+  class Checkout
+    include Request
+    
+    attr_accessor :params
+
+    Struct.new("CheckoutParams", :charge, :currency_code, :return_url, :cancel_url, :notify_url, :error_url, :in_store, :txn_id, :token, :merchant_id, :merchant_key, 
+                  :order_id, :order, :consumer, :billing_address, :shipping_address, :version, :metadata)
+    
+    # Initializes a ZipMoney::Checkout object
+    #
+    # Returns ZipMoney::Checkout object
+    def initialize 
+      @params         = Struct::CheckoutParams.new
+      @params.order   = Struct::Order.new
+      @params.billing_address  = Struct::Address.new
+      @params.shipping_address = Struct::Address.new
+      @params.consumer = Struct::Consumer.new
+      @params.metadata = Struct::Metadata.new
+      @params.version  = Struct::Version.new
+      @params.order.detail =  Array.new
+    end
+
+    # Performs the Checkout api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Checkout object 
+    def do  
+      validate
+
+      ZipMoney.api.checkout(self.params)
+    end
+    
+    # Performs the parameters validation
+    def validate
+      raise ArgumentError, "Params emtpy" if @params.nil? 
+      @errors = []
+      @errors << 'charge must be provided' if @params.charge.nil? 
+      @errors << 'currency_code must be provided' if @params.currency_code.nil? 
+      @errors << 'order_id must be provided' if @params.order_id.nil? 
+      @errors << 'order must be provided' if @params.order.nil? 
+      @errors << 'order.id must be provided' if @params.order.id.nil? 
+      @errors << 'order.total must be provided' if @params.order.total.nil? 
+      @errors << 'order.shipping_value must be provided' if @params.order.shipping_value.nil? 
+      @errors << 'order.tax must be provided' if @params.order.tax.nil? 
+      @errors << 'order detail must be provided' if @params.order.detail.nil? 
+
+      validate_item_details @params.order.detail
+
+      raise ZipMoney::RequestError.new("Following error(s) occurred while making request, please resolve them to make the request: #{@errors}") if @errors.any?
+    end
+  end
+end

data/lib/zipMoney/api/configure.rb

@@ -0,0 +1,34 @@
+module ZipMoney
+  class Configure
+    include Request
+
+    attr_accessor :params
+
+    Struct.new("ConfigureParams", :base_url, :merchant_id, :merchant_key, :version, :metadata)
+    
+    # Initializes a ZipMoney::Configure object
+    #
+    # Returns ZipMoney::Configure object
+    def initialize 
+      @params      = Struct::ConfigureParams.new
+      @params.metadata = Struct::Metadata.new
+      @params.version  = Struct::Version.new
+    end
+    
+    # Performs the Configure api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Configure object  
+    def do  
+      validate
+      ZipMoney.api.configure(self.params)
+    end
+    
+    # Performs the parameters validation
+    def validate
+      raise ArgumentError, "Params emtpy" if params.nil? 
+      @errors = []
+      @errors << 'base_url must be provided' if self.params.txn_id.nil? 
+      raise ZipMoney::RequestError.new("Following error(s) occurred while making request, please resolve them to make the request: #{@errors}") if @errors.any?
+    end
+  end
+end

data/lib/zipMoney/api/query.rb

@@ -0,0 +1,43 @@
+module ZipMoney
+  class Query
+    include Request
+  
+    attr_accessor :params
+
+    Struct.new("QueryParams", :orders, :merchant_id, :merchant_key, :version, :metadata)
+    Struct.new("QueryOrder", :id, :status, :error_message, :txn_id)
+    
+    # Initializes a ZipMoney::Query object
+    #
+    # Returns ZipMoney::Query object
+    def initialize 
+      @params      = Struct::QueryParams.new      
+      @params.orders   = Array.new
+      @params.metadata = Struct::Metadata.new
+      @params.version  = Struct::Version.new
+    end
+    
+    # Performs the Query api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Query object  
+    def do  
+      validate
+      ZipMoney.api.query(@params)
+    end
+
+    # Performs the parameters validation
+    def validate
+      raise ArgumentError, "Params emtpy" if @params.nil? 
+      @errors = []
+      @errors << 'at least one order must be provided' if @params.orders.nil? 
+
+      @params.orders.each_with_index do |item,index|
+        @errors << "order.detail[#{index}].id must be provided" if item.id.nil? 
+      end 
+
+      raise ZipMoney::RequestError.new("Following error(s) occurred while making request, please resolve them to make the request: #{@errors}") if @errors.any?
+    end
+
+
+  end
+end

data/lib/zipMoney/api/quote.rb

@@ -0,0 +1,54 @@
+module ZipMoney
+  class Quote
+    include Request
+
+    attr_accessor :params
+
+    Struct.new("QuoteParams", :currency_code, :cart_url, :success_url, :cancel_url, :refer_url, :error_url, :decline_url, :in_store, :checkout_source, :txn_id, :merchant_id, :merchant_key, 
+                  :quote_id, :order, :consumer, :billing_address, :shipping_address, :version, :metadata, :token)
+    
+    # Initializes a ZipMoney::Quote object
+    #
+    # Returns ZipMoney::Quote object
+    def initialize 
+      @params     = Struct::QuoteParams.new
+      @params.order   = Struct::Order.new
+      @params.billing_address  = Struct::Address.new
+      @params.shipping_address = Struct::Address.new
+      @params.consumer = Struct::Consumer.new
+      @params.metadata = Struct::Metadata.new
+      @params.version  = Struct::Version.new
+      @params.order.detail = Array.new
+    end
+    
+    # Performs the Quote api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Quote object  
+    def do  
+      validate
+      ZipMoney.api.quote(@params)
+    end
+    
+    # Performs the parameters validation
+    def validate
+      raise ArgumentError, "Params emtpy" if @params.nil? 
+      @errors = []
+      @errors << 'quote_id must be provided' if @params.quote_id.nil? 
+      @errors << 'success_url must be provided' if @params.success_url.nil? 
+      @errors << 'cancel_url must be provided' if @params.cancel_url.nil? 
+      @errors << 'error_url must be provided' if @params.error_url.nil? 
+      @errors << 'decline_url must be provided' if @params.decline_url.nil? 
+      @errors << 'quote_id must be provided' if @params.quote_id.nil? 
+      @errors << 'order must be provided' if @params.order.nil? 
+      @errors << 'order.id must be provided' if @params.order.id.nil? 
+      @errors << 'order.total must be provided' if @params.order.total.nil? 
+      @errors << 'order.shipping_value must be provided' if @params.order.shipping_value.nil? 
+      @errors << 'order.tax must be provided' if @params.order.tax.nil? 
+      @errors << 'order detail must be provided' if @params.order.detail.nil? 
+
+      validate_item_details @params.order.detail
+
+      raise ZipMoney::RequestError.new("Following error(s) occurred while making request, please resolve them to make the request: #{@errors}") if @errors.any?
+    end
+  end
+end