zipMoney 1.0.1

data/lib/zipMoney/api/refund.rb

@@ -0,0 +1,46 @@
+module ZipMoney
+  class Refund
+    include Request
+
+    attr_accessor :params
+
+    Struct.new("RefundParams", :reason, :refund_amount, :txn_id, :order_id, :quote_id, :order, :reference, :version, :metadata, :merchant_id, :merchant_key)
+    
+    # Initializes a ZipMoney::Refund object
+    #
+    # Returns ZipMoney::Refund object
+    def initialize 
+      @params      = Struct::RefundParams.new
+      @params.order    = Struct::Order.new
+      @params.metadata = Struct::Metadata.new
+      @params.version  = Struct::Version.new
+      @params.order.detail = Array.new
+    end
+    
+    # Performs the Refund api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Refund object 
+    def do  
+      validate
+      ZipMoney.api.refund(@params)
+    end
+    
+    # Performs the parameters validation
+    def validate
+      raise ArgumentError, "Params emtpy" if @params.nil? 
+      @errors = []
+      @errors << 'reason must be provided' if @params.reason.nil? 
+      @errors << 'refund_amount must be provided' if @params.refund_amount.nil? 
+      @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/settings.rb

@@ -0,0 +1,16 @@
+module ZipMoney
+  class Settings
+    include Request
+
+    attr_accessor :params
+
+    Struct.new("SettingsParams", :merchant_id, :merchant_key, :version, :metadata)
+    
+    # Performs the Checkout api call on zipMoney endpoint
+    #
+    # Returns ZipMoney::Checkout object 
+    def do  
+      ZipMoney.api.settings()
+    end
+  end
+end

data/lib/zipMoney/configuration.rb

@@ -0,0 +1,49 @@
+module ZipMoney
+	class Configuration
+		
+		API_VERSION  = "1.0.1"
+		API_PLATFORM = "ruby"
+		API_NAME	 = "zipMoney Ruby SDK"
+
+    ENV_LIVE_API_URL = "https://api.zipmoney.com.au/v1/"
+    ENV_TEST_API_URL = "https://api.sandbox.zipmoney.com.au/v1/"
+
+    ATTRIBUTES = [
+      :merchant_id,
+      :merchant_key,
+      :environment,
+    ]
+
+  	attr_accessor *ATTRIBUTES
+
+    class << self
+     	attr_accessor *ATTRIBUTES
+
+			# Checks if passed value is valid and assigns it true
+			#
+			# @param [env] Environment sandbox|live
+			#
+			# @return true|false
+    	def environment=(env)
+      	env = env.to_sym
+      	raise ArgumentError, "#{env.inspect} is not a valid environment"   unless [:sandbox, :live].include?(env)
+      	@environment = env
+    	end
+
+    	# Checks if environment is sandbox
+    	#
+			# @return true|false
+    	def is_sandbox
+    		environment.to_s == "sandbox"
+   		end
+
+			# Checks if passed merchant_id and merchant_key match with the one provided during setup
+			#
+			# @param [merchant_id] Merchant Id
+			# @param [merchant_key] Merchant Key
+   		def credentials_valid(merchant_id,merchant_key)
+    		raise ExpressError, "Invalid merchant credentials in the request" unless @merchant_id.to_i.eql?(merchant_id.to_i) && @merchant_key.to_s.eql?(merchant_key.to_s)
+    	end
+    end
+	end
+end

data/lib/zipMoney/errors.rb

@@ -0,0 +1,11 @@
+module ZipMoney
+  class ApiError < StandardError; end 
+  class InvalidArgumentError < StandardError; end 
+  class RequestError < StandardError; end
+  class ResponseError < StandardError; end
+  class WebHookError < StandardError; end
+  class WebHookRequestError < StandardError; end
+  class ExpressError < StandardError; end
+  class ExpressRequestError < StandardError; end
+  class ExpressResponseError < StandardError; end
+end

data/lib/zipMoney/express.rb

@@ -0,0 +1,65 @@
+module ZipMoney
+	module Express
+		attr_accessor :merchant_id, :merchant_key
+		   
+    ACTION_GET_QUOTE_DETAILS        = 'quotedetails';
+    ACTION_GET_SHIPPING_METHODS     = 'shippingmethods';
+    ACTION_CONFIRM_SHIPPING_METHOD  = 'confirmshippingmethod';
+    ACTION_CONFIRM_ORDER            = 'confirmorder';
+    ACTION_FINALISE_ORDER           = 'finaliseorder';
+    ACTION_CANCEL_QUOTE             = 'cancelquote';
+
+    # Process the express checkout action
+    #
+    # @param [action] Action
+    # @param [request] Express checkout request 
+    # @param [block] Actions to be taken for respective actions
+    #
+    # Returns the response to the zipMoney Express Api
+    def self.process(action, request, &block)
+  		raise ExpressRequestError, "Action empty" if action.nil?    		
+  		raise ExpressRequestError, "Request empty" if request.nil?
+  		request = Util.json_parse(request)
+  		Configuration.credentials_valid(request["merchant_id"], request["merchant_key"])
+  		if (block.arity > 0)
+     			response = block.call(action, request)
+     			raise ExpressResponseError, "No response provided" if response.nil?
+     			puts send_response(response)
+  		end	
+  	end
+ 		
+ 		# Appends api credentials to the express checkout response
+    #
+    # @param [response] response
+		def self.append_api_credentials(response)
+			response = Hash.new if !response.is_a?(Hash)
+
+			if response["merchant_id"]  == nil 
+			   response["merchant_id"]  = Configuration.merchant_id
+			end
+
+			if response["merchant_key"] == nil
+			   response["merchant_key"] = Configuration.merchant_key
+			end
+			response	
+		end
+
+		# Prepars the express checkout response
+    #
+    # @param [response] response
+		def self.prepare_response(response)
+			response = Util.json_parse(response)
+			append_api_credentials(response)
+		end	
+
+		# Prints the express checkout response
+    #
+    # @param [response] response
+		def self.send_response(response)
+			prepare_response(response).to_json
+		end	
+	end
+end
+
+
+

data/lib/zipMoney/request.rb

@@ -0,0 +1,22 @@
+module ZipMoney
+  module Request
+    Struct.new("Order", :id, :tax, :shipping_value, :total, :detail)
+    Struct.new("Detail", :quantity, :name, :price, :description, :sku, :id, :category, :image_url)
+    Struct.new("Address",:first_name, :last_name, :line1, :line2, :country, :zip, :city, :state)
+    Struct.new("Consumer",:first_name, :last_name,:city, :phone, :gender, :dob, :email, :title)
+    Struct.new("Metadata",:order_reference, :attributes)
+    Struct.new("Version",:client, :platform)
+    Struct.new("ApiCredentials",:merchant_id, :merchant_key, :version)
+
+    attr_accessor :errors
+
+    def validate_item_details(order_items)
+      order_items.each_with_index do |item,index|
+        @errors << "order.detail[#{index}].id must be provided" if item.id.nil? 
+        @errors << "order.detail[#{index}].name must be provided" if item.name.nil? 
+        @errors << "order.detail[#{index}].quantity must be provided" if item.quantity.nil? 
+        @errors << "order.detail[#{index}].price must be provided" if item.price.nil? 
+      end 
+    end 
+  end
+end

data/lib/zipMoney/resources.rb

@@ -0,0 +1,71 @@
+module ZipMoney
+  class Resources
+    
+    RESOURCE_SETTINGS                 = 'settings'
+    RESOURCE_CONFIGURE                = 'configure'
+    RESOURCE_QUOTE                    = 'quote'
+    RESOURCE_CANCEL                 = 'cancel'
+    RESOURCE_REFUND                 = 'refund'
+    RESOURCE_CHECKOUT                 = 'checkout'
+    RESOURCE_QUERY                    = 'query'
+    RESOURCE_CAPTURE                  = 'capture'
+    RESOURCE_HEART_BEAT               = 'Heartbeat'
+
+    class << self
+      # Checks if passed resource is valid and returns RestClient::Resource object 
+      # configured with the passed resource and url
+      #
+      # @param [resource] endpoint resource 
+      # @param [method] method  get|post
+      # @param [query_string] query_string parameters
+      #
+      # @return RestClient::Resource object
+      def get(resource, method = :post, query_string = nil)
+        return false unless resource_exists(resource)
+        url = get_url(resource, (method == :get ? query_string : nil))
+        ssl_opts = {:verify_ssl => OpenSSL::SSL::VERIFY_PEER}
+        opts = {}
+        RestClient::Resource.new(url, opts.merge(ssl_opts))
+      end 
+
+      # Checks if passed resource exists 
+      #
+      # @param [resource] endpoint resource 
+      #
+      # @return ZipMoney::Response object
+      def resource_exists(resource)
+        if resource.is_a?(String)
+          if self.constants.map{ |k| self.const_get(k).downcase }.include?resource 
+            resource
+          end  
+        else
+          raise ArgumentError, "#{resource} should be a string"
+        end
+      end
+        
+      # Builds the proper endpoint url with the given resource
+      #
+      # @param [resource] endpoint resource 
+      # @param [query_string] query_string parameters
+      #
+      # @return String
+      def get_url(resource, query_string = nil)
+        if Configuration.is_sandbox
+          url = "#{Configuration::ENV_TEST_API_URL}"
+        else
+          url = "#{Configuration::ENV_LIVE_API_URL}"
+        end   
+
+        url =   url + resource
+
+        unless query_string.nil?
+          url = url + "?" + 
+          query_string.map do |key, value|
+            "#{key}=#{value}" 
+          end.join("&")
+        end
+        url
+      end
+    end
+  end
+end

data/lib/zipMoney/response.rb

@@ -0,0 +1,68 @@
+module ZipMoney
+  class Response
+        
+    attr_accessor :_response , :_responseBody, :_responseHeader, :_statusCode
+
+    # Initializes a new api response object
+    #
+    # @param [response] response 
+    #
+    # @return ZipMoney::Response object
+    def initialize(response)
+      raise ArgumentError, "Response doesnot exist" if ((response.nil? || response.empty?) && response.code.nil? && response.code.empty?)
+      @_response       = response
+      @_statusCode     = response.code
+      @_responseBody   = response.body
+    end         
+    
+    # Converts the response body to Hash
+    #
+    # @return Hash
+    def toHash
+      raise ResponseError, "Response body doesnot exist" if @_responseBody.nil? || @_responseBody.empty?
+      JSON.parse(@_responseBody) 
+    end
+    
+    # Converts the response body to Object
+    #
+    # @return OpenStruct
+    def toObject
+      raise ResponseError, "Response body doesnot exist" if @_responseBody.nil? || @_responseBody.empty?
+      responseObject = JSON.parse(@_responseBody, object_class: OpenStruct)
+      responseObject
+    end
+      
+    # Returns the redirect_url from the checkout and quote calls
+    #
+    # @return String 
+    def getRedirectUrl
+      raise ArgumentError, "Response body doesnot exist" if @_responseBody.nil? || @_responseBody.empty?
+      resObj = toObject
+      return false if resObj.redirect_url.nil?  || resObj.redirect_url.empty?
+      resObj.redirect_url
+    end
+      
+    # Returns the http status code
+    #
+    # @return Int 
+    def getStatusCode
+      @_statusCode
+    end 
+
+    # Returns if the api call was a success or failure
+    #
+    # @return true|false 
+    def isSuccess
+      return @_statusCode == 200 || @_statusCode == 201? true : false
+    end
+      
+    # Returns error string
+    #
+    # @return String 
+    def getError
+      raise ArgumentError, "Response body doesnot exist" if @_responseBody.nil? || @_responseBody.empty?
+      resObj = toObject
+      resObj.Message
+    end
+  end
+end

data/lib/zipMoney/util.rb

@@ -0,0 +1,53 @@
+module ZipMoney
+  class Util
+    class << self
+      
+    # Converts Struct objects to Hash
+    #
+    # @param [object] Struct Object 
+    #
+    # @return Hash
+    def struct_to_hash(object)
+      hash = {}
+      object.to_h.each  do |k,v| 
+        if v.is_a?(Struct) 
+          v = struct_to_hash(v)
+          hash[k] = v unless v.empty?
+        elsif v.is_a?(Array)
+          
+          a = Array.new
+          v.each_with_index do  |k1,v1|  
+            v2 = struct_to_hash(k1) 
+            a[v1] = v2  unless v2.empty?
+          end
+
+          hash[k] = a
+        else
+          hash[k] = v unless v.nil?
+        end
+      end
+        hash
+    end 
+
+    # Converts Hash|Struct|OpenStruct objects to Hash
+    #
+    # @param [data] Json String 
+    #
+    # @return data
+    def json_parse(data)
+      begin
+        data =  JSON.parse(data)
+      rescue TypeError => e         
+        if !data.is_a?(Hash) && !data.is_a?(Struct) && !data.is_a?(OpenStruct)
+      raise ArgumentError, "Invalid params provided" 
+        end
+      rescue JSON::ParserError => e
+        if !data.is_a?(Hash) && !data.is_a?(Struct) && !data.is_a?(OpenStruct)
+      raise ArgumentError, "Invalid params provided" 
+        end
+      end
+      data
+    end
+    end
+  end 
+end

data/lib/zipMoney/version.rb

@@ -0,0 +1,3 @@
+module ZipMoney
+  VERSION = "1.0.1"
+end

data/lib/zipMoney/webhook.rb

@@ -0,0 +1,67 @@
+module ZipMoney
+	module WebHook
+		attr_accessor :merchant_id, :merchant_key
+
+		EVENT_AUTH_SUCCESS    = "authorise_succeeded"
+    EVENT_AUTH_FAIL       = "authorise_failed"
+    EVENT_AUTH_REVIEW     = "authorise_under_review"
+    EVENT_AUTH_DECLINED   = "authorise_declined"
+    EVENT_CANCEL_SUCCESS  = "cancel_succeeded"
+    EVENT_CANCEL_FAIL     = "cancel_failed"
+    EVENT_CAPTURE_SUCCESS = "capture_succeeded"
+    EVENT_CAPTURE_FAIL    = "capture_failed"
+    EVENT_REFUND_SUCCESS  = "refund_succeeded"
+    EVENT_REFUND_FAIL     = "refund_failed"
+    EVENT_ORDER_CANCELLED = "order_cancelled"
+    EVENT_CHARGE_SUCCESS  = "charge_succeeded"
+    EVENT_CHARGE_FAIL     = "charge_failed"
+    EVENT_CONFIG_UPDATE   = "configuration_updated"
+
+    TYPE_SUBSCRIPTION_CONFIRMATION = "SubscriptionConfirmation"
+    TYPE_NOTIFICATION 		  	   = "Notification"
+
+    # Process the webhook
+    #
+    # @param [request] WebHook's request 
+    # @param [block] Actions to be taken for respective notifications
+    def self.process(request,&block)
+		raise WebHookRequestError, "Payload emtpy" if request.nil? 
+		request = Util.json_parse(request)
+		if request["Type"] == TYPE_SUBSCRIPTION_CONFIRMATION
+  			subscribe(request["SubscribeURL"])
+  		elsif request["Type"] == TYPE_NOTIFICATION	
+  			process_notifications(request, &block)
+  		end	
+  	end
+        
+    # Process the webhook notifications
+    #
+    # @param [request] WebHook's request 
+    # @param [block] Actions to be taken for respective notifications
+  	def self.process_notifications(request, &block)
+  		raise ArgumentError, "Invalid params provided" if request["Message"].nil?
+  		message = Util.json_parse(request["Message"])
+  		Configuration.credentials_valid(message["response"]["merchant_id"], message["response"]["merchant_key"])
+  		raise ArgumentError, "Response empty" if message["response"].nil?
+  		
+  		if (block.arity > 0)
+     		block.call(message['type'], message["response"])
+  		end	
+  	end
+
+    # Subscribes for the webhook notifications by calling the subscription url
+    #
+    # @param [request] WebHook's request 
+    # @param [block] Actions to be taken for respective notifications
+  	def self.subscribe(url)			
+  		raise WebHookError, "Url emtpy" if url.nil? 
+  		
+  		begin
+  			response = RestClient.get(url)
+  		rescue
+  			raise WebHookError, "Unable to reach the subscription url #{url}" if response.nil?
+  		end	
+        response.code == 200 || response.code == 201
+  	end	
+	end
+end