agms 0.1.0

data/lib/agms/response/invoicing_response.rb

@@ -0,0 +1,10 @@
+module Agms
+	class InvoicingResponse < Response
+    # A class representing AGMS Invoicing Response objects.
+
+    def initialize
+      @response = nil
+      @mapping = Array.new
+    end
+	end
+end

data/lib/agms/response/recurring_response.rb

@@ -0,0 +1,28 @@
+module Agms
+  class RecurringResponse < Response
+    # A class representing AGMS Recurring Response objects.
+
+    def initialize(response, op)
+      @response = nil
+      @op = op
+
+      response = response['soap:Envelope']['soap:Body'][op + 'Response'][op + 'Result']
+
+      if @op == 'RecurringAdd' or @op == 'RecurringDelete' or @op == 'RecurringUpdate'
+        @mapping = {
+            :RESULT => 'result',
+            :MSG => 'message',
+            :RecurringID => 'recurring_id',
+        }
+      elsif @op == 'RetrieveRecurringID'
+        @mapping = {
+            :RecurringID => 'recurring_id'
+        }
+      else
+        raise InvalidRequestError, 'Invalid op in Response.'
+      end
+      @response = response
+    end
+
+  end
+end

data/lib/agms/response/report_response.rb

@@ -0,0 +1,141 @@
+module Agms
+  class ReportResponse < Response
+    # A class representing AGMS Report Response objects.
+
+    def initialize(response, op)
+      super(response, op)
+      @response = nil
+      @op = op
+      arr = _parseReportResponse(response)
+
+      if @op == 'TransactionAPI'
+        @mapping = {
+            :id => 'id',
+            :transactionid => 'transaction_id',
+            :transactiontype => 'transaction_type',
+            :paymenttype => 'payment_type',
+            :amount => 'amount',
+            :orderdescription => 'order_description',
+            :orderid => 'order_id',
+            :ponumber => 'po_number',
+            :tax => 'tax_amount',
+            :shipping => 'shipping_amount',
+            :tipamount => 'tip_amount',
+            :ccnumber => 'cc_number',
+            :ccexpdate => 'cc_exp_date',
+            :checkname => 'ach_name',
+            :checkaba => 'ach_routing_number',
+            :checkaccount => 'ach_account_number',
+            :accountholdertype => 'ach_business_or_personal',
+            :accounttype => 'ach_checking_or_savings',
+            :seccode => 'ach_sec_code',
+            :safeaction => 'safe_action',
+            :responsesafeid => 'safe_id',
+            :clerkid => 'clerk_id',
+            :firstname => 'first_name',
+            :lastname => 'last_name',
+            :company => 'company_name',
+            :address1 => 'address',
+            :address2 => 'address_2',
+            :city => 'city',
+            :state => 'state',
+            :zip => 'zip',
+            :country => 'country',
+            :phone => 'phone',
+            :fax => 'fax',
+            :email => 'email',
+            :website => 'website',
+            :shippingfirstname => 'shipping_first_name',
+            :shippinglastname => 'shipping_last_name',
+            :shippingcompany => 'shipping_company_name',
+            :shippingaddress1 => 'shipping_address',
+            :shippingaddress2 => 'shipping_address_2',
+            :shippingcity => 'shipping_city',
+            :shippingstate => 'shipping_state',
+            :shippingzip => 'shipping_zip',
+            :shippingcountry => 'shipping_country',
+            :shippingemail => 'shipping_email',
+            :shippingphone => 'shipping_phone',
+            :shippingfax => 'shipping_fax',
+            :shippingcarrier => 'shipping_carrier',
+            :trackingnumber => 'shipping_tracking',
+            :ipaddress => 'ip_address',
+            :customfield1 => 'custom_field_1',
+            :customfield2 => 'custom_field_2',
+            :customfield3 => 'custom_field_3',
+            :customfield4 => 'custom_field_4',
+            :customfield5 => 'custom_field_5',
+            :customfield6 => 'custom_field_6',
+            :customfield7 => 'custom_field_7',
+            :customfield8 => 'custom_field_8',
+            :customfield9 => 'custom_field_9',
+            :customfield10 => 'custom_field_10',
+            :customfield11 => 'custom_field_11',
+            :customfield12 => 'custom_field_12',
+            :customfield13 => 'custom_field_13',
+            :customfield14 => 'custom_field_14',
+            :customfield15 => 'custom_field_15',
+            :customfield16 => 'custom_field_16',
+            :customfield17 => 'custom_field_17',
+            :customfield18 => 'custom_field_18',
+            :customfield19 => 'custom_field_19',
+            :customfield20 => 'custom_field_20',
+            :receipttype => 'receipt_type',
+            :responsestatuscode => 'response_code',
+            :responsestatusmsg => 'response_message',
+            :responsetransid => 'response_transaction_id',
+            :responseauthcode => 'authorization_code',
+            :transactiondate => 'transaction_date',
+            :createdate => 'date_created',
+            :moddate => 'date_last_modified',
+            :createuser => 'created_by',
+            :moduser => 'modified_by',
+            :useragent => 'user_agent'
+        }
+        if arr
+          @response = arr
+        else
+          @response = Array.new
+        end
+      elsif @op == 'QuerySAFE'
+        if arr
+          @response = arr
+        else
+          @response = Array.new
+        end
+      else
+        raise InvalidRequestError, 'Invalid op in Response.'
+      end
+    end
+
+    def toArray
+      # Override toArray method to handle array response
+      response = Array.new
+      if @response
+        @response.each do |result|
+          response << mapResponse(result)
+        end
+      end
+      return response
+    end
+
+    def getSafeId
+      response_array = toArray()
+      return response_array['safe_id']
+    end
+
+    # Parse transaction report response received from gateway
+    def _parseReportResponse(xml)
+      # Parse the response body
+      doc = Nokogiri::XML(xml)
+      # Remove the namespaces
+      doc.remove_namespaces!
+      response = {}
+      # Extract the response data from the ProcessTransactionResult node
+      doc.xpath("//transactions//transaction//*").each do |node|
+        response[node.name] = node.children.text
+      end
+      return response
+    end
+  end
+end

data/lib/agms/response/response.rb

@@ -0,0 +1,48 @@
+module Agms
+	class Response
+    # A class representing AGMS Response objects.
+
+    def initialize(response, op)
+      @response = response
+      @op = op
+      @mapping = nil
+    end
+
+    def toArray
+      return mapResponse(@response)
+    end
+
+    def mapResponse(arr)
+      if @mapping
+        response = doMap(arr)
+        return response
+      else
+        raise UnexpectedError, 'Response mapping not defined for this API.'
+      end
+    end
+
+    def doMap(arr)
+      response = Hash.new
+      mapping = @mapping
+      if mapping
+        # We only map the end of the array containing data
+        # If this element is an array, then we map its individual sub-arrays
+        # Otherwise, we map
+        arr.each do |key, value|
+
+          if value.class == Hash
+            response << doMap(value)
+          else
+
+            if not mapping.has_key?(key)
+              raise UnexpectedError, "Unmapped field #{key} in response."
+            else
+              response[mapping[key]] = value
+            end
+          end
+        end
+      end
+      return response
+    end
+	end
+end

data/lib/agms/response/safe_response.rb

@@ -0,0 +1,51 @@
+module Agms
+  class SAFEResponse < Response
+    # A class representing AGMS SAFE Response objects.
+
+    def initialize(response, op)
+      super(response, op)
+      @mapping = {
+          'STATUS_CODE' => 'response_code',
+          'STATUS_MSG' => 'response_message',
+          'TRANS_ID' => 'transaction_id',
+          'AUTH_CODE' => 'authorization_code',
+          'AVS_CODE' => 'avs_result',
+          'AVS_MSG' => 'avs_message',
+          'CVV2_CODE' => 'cvv_result',
+          'CVV2_MSG' => 'cvv_message',
+          'ORDERID' => 'order_id',
+          'SAFE_ID' => 'safe_id',
+          'FULLRESPONSE' => 'full_response',
+          'POSTSTRING' => 'post_string',
+          'BALANCE' => 'gift_balance',
+          'GIFTRESPONSE' => 'gift_response',
+          'MERCHANT_ID' => 'merchant_id',
+          'CUSTOMER_MESSAGE' => 'customer_message',
+          'RRN' => 'rrn'
+      }
+
+      @response = response
+      @op = op
+
+      if not isSuccessful()
+        response_array = toArray()
+        raise ResponseError.new("Transaction failed with error code #{response_array['response_code']}  and message #{response_array['response_message']}", response_array)
+      end
+    end
+
+    def isSuccessful
+      response_array = toArray()
+      code = response_array['response_code']
+      if code != '1' and code != '2'
+        return false
+      else
+        return true
+      end
+    end
+
+    def getSafeId
+      response_array = toArray()
+      return response_array['safe_id']
+    end
+  end
+end

data/lib/agms/response/transaction_response.rb

@@ -0,0 +1,50 @@
+module Agms
+	class TransactionResponse < Response
+    # A class representing AGMS Transaction Response objects.
+
+    def initialize(response, op)
+      super(response, op)
+      @mapping = {
+        'STATUS_CODE' => 'response_code',
+        'STATUS_MSG' => 'response_message',
+        'TRANS_ID' => 'transaction_id',
+        'AUTH_CODE' => 'authorization_code',
+        'AVS_CODE' => 'avs_result',
+        'AVS_MSG' => 'avs_message',
+        'CVV2_CODE' => 'cvv_result',
+        'CVV2_MSG' => 'cvv_message',
+        'ORDERID' => 'order_id',
+        'SAFE_ID' => 'safe_id',
+        'FULLRESPONSE' => 'full_response',
+        'POSTSTRING' => 'post_string',
+        'BALANCE' => 'gift_balance',
+        'GIFTRESPONSE' => 'gift_response',
+        'MERCHANT_ID' => 'merchant_id',
+        'CUSTOMER_MESSAGE' => 'customer_message',
+        'RRN' => 'rrn'
+      }
+
+      @response = response
+      @op = op
+
+      if not isSuccessful()
+        response_array = toArray()
+        raise ResponseError.new("Transaction failed with error code #{response_array['response_code']}  and message #{response_array['response_message']}", response_array)
+      end
+    end
+
+    def isSuccessful
+      response_array = toArray()
+      if response_array['response_code'] != '1' and response_array['response_code'] != '2'
+        return false
+      else
+        return true
+      end
+    end
+
+    def getAuthorization
+      response_array = toArray()
+      return response_array['transaction_id']
+    end
+	end
+end

data/lib/agms/safe.rb

@@ -0,0 +1,66 @@
+module Agms
+  class SAFE < Agms
+    # A class representing AGMS SAFE objects.
+
+    alias AgmsResetParameters resetParameters
+    alias AgmsSetParameter setParameter
+    alias AgmsDoConnect doConnect
+
+    def initialize
+      super()
+      @api_url = 'https://gateway.agms.com/roxapi/AGMS_SAFE_API.asmx'
+      @requestObject = 'SAFERequest'
+      @responseObject = 'SAFEResponse'
+    end
+
+    # @return [Object]
+    def add(params)
+      @op = 'AddToSAFE'
+      AgmsResetParameters()
+      AgmsSetParameter(:SAFE_Action, {:value => 'add_safe'})
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    # @return [Object]
+    def update(params)
+      @op = 'UpdateSAFE'
+      AgmsResetParameters()
+      AgmsSetParameter(:SAFE_Action, {:value => 'update_safe'})
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    # @return [Object]
+    def delete(params)
+      @op = 'DeleteFromSAFE'
+      AgmsResetParameters()
+      AgmsSetParameter(:SAFE_Action, {:value => 'delete_safe'})
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    protected
+    def execute
+      if @op == 'AddToSAFE'
+        AgmsDoConnect('AddToSAFE', @responseObject)
+      elsif @op == 'UpdateSAFE'
+          AgmsDoConnect('UpdateSAFE', @responseObject)
+      elsif @op == 'DeleteFromSAFE'
+        AgmsDoConnect('DeleteFromSAFE', @responseObject)
+      else
+        raise InvalidRequestError, "Invalid request to Transaction API #{@op}"
+      end
+    end
+
+  end
+end

data/lib/agms/transaction.rb

@@ -0,0 +1,37 @@
+module Agms
+	class Transaction < Agms
+		# A class representing AGMS Transaction objects.
+		
+		alias AgmsResetParameters resetParameters
+		alias AgmsSetParameter setParameter
+		alias AgmsDoConnect doConnect
+
+		def initialize
+			super()
+      @api_url = 'https://gateway.agms.com/roxapi/agms.asmx'
+      @requestObject = 'TransactionRequest'
+      @responseObject = 'TransactionResponse'
+		end
+
+    # @return [Object]
+    def process(params)
+      @op = 'ProcessTransaction'
+      AgmsResetParameters()
+      params.each do |param, config|
+				AgmsSetParameter(param, config)
+			end
+			self.execute()
+			return @response.toArray()
+		end
+
+		protected
+			def execute
+				if @op == 'ProcessTransaction'
+					AgmsDoConnect('ProcessTransaction', @responseObject)
+				else
+					raise InvalidRequestError, "Invalid request to Transaction API #{@op}"
+				end
+			end
+
+	end
+end

data/lib/agms/version.rb

@@ -0,0 +1,3 @@
+module Agms
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: agms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maanas Royy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Library for integrating AGMS Gateway
+email:
+- maanas@agms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- agms.gemspec
+- bin/console
+- bin/setup
+- example/hpp.rb
+- example/invoicing.rb
+- example/recurring.rb
+- example/report.rb
+- example/safe.rb
+- example/transaction.rb
+- init.yml
+- lib/agms.rb
+- lib/agms/agms.rb
+- lib/agms/configuration.rb
+- lib/agms/connect.rb
+- lib/agms/error/agms_error.rb
+- lib/agms/error/authentication_error.rb
+- lib/agms/error/authorization_error.rb
+- lib/agms/error/client_error_error.rb
+- lib/agms/error/configuation_error.rb
+- lib/agms/error/down_for_maintenance_error.rb
+- lib/agms/error/forged_query_String_error.rb
+- lib/agms/error/invalid_parameter_error.rb
+- lib/agms/error/invalid_request_error.rb
+- lib/agms/error/invalid_signature_error.rb
+- lib/agms/error/not_found_error.rb
+- lib/agms/error/request_validation_error.rb
+- lib/agms/error/response_error.rb
+- lib/agms/error/server_error_error.rb
+- lib/agms/error/ssl_certificate_error.rb
+- lib/agms/error/unexpected_error.rb
+- lib/agms/error/upgrade_required_error.rb
+- lib/agms/hpp.rb
+- lib/agms/invoicing.rb
+- lib/agms/recurring.rb
+- lib/agms/report.rb
+- lib/agms/request/hpp_request.rb
+- lib/agms/request/invoicing_request.rb
+- lib/agms/request/recurring_request.rb
+- lib/agms/request/report_request.rb
+- lib/agms/request/request.rb
+- lib/agms/request/safe_request.rb
+- lib/agms/request/transaction_request.rb
+- lib/agms/response/hpp_response.rb
+- lib/agms/response/invoicing_response.rb
+- lib/agms/response/recurring_response.rb
+- lib/agms/response/report_response.rb
+- lib/agms/response/response.rb
+- lib/agms/response/safe_response.rb
+- lib/agms/response/transaction_response.rb
+- lib/agms/safe.rb
+- lib/agms/transaction.rb
+- lib/agms/version.rb
+homepage: http://www.onlinepaymentprocessing.com
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: AGMS Ruby Client Library
+test_files: []