agms 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWVjNDJjMTM0YWJjYWFmNjQ2NTNkMWI0YzlkNjVlNjVhNDQ5NDM4MQ==
+  data.tar.gz: !binary |-
+    NjI3NmNlZTU2MzkyMWNiYmQ4YzM5ZDc4MDJiNDcxZDJlMzk4NWIxMA==
+SHA512:
+  metadata.gz: !binary |-
+    ZWY1MTVhZDFkYjZkNmE2MjI2OTRmYTY5Y2ZlMzlmNDQyMmU0MGE3Y2M3NzYx
+    NDFiNGM4MTQ4NGIyYjU2YzRkNjc3M2NiNzZlNGE1ZjNmZjUxMjM2ODNhNzll
+    NzQwYjJiNGZhY2E2YTFjZDg4NzhjZmU5ZjlhMTEyNTRhZWRiMDE=
+  data.tar.gz: !binary |-
+    NjVlMjlhODE2ZDQwOWRiZDhkMDA4N2IyMTIyZmNhYjNhZmMwZTc3NDAzOWIw
+    MmUwZGIyZDc4ZDhiYTg1MzJmYzQ0ZGQxZDViYzRhMWExNGU4YzcyNGEwZmIz
+    YWM4YTdiNDUyYTRiZmU0MWZmMWU3ZDMyNGY3NzYxMGMxMWJlOTY=

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in agms.gemspec
+gemspec

data/README.md

@@ -0,0 +1,51 @@
+# AgmsRuby Library
+
+The AGMS Ruby library provides integration to the Avant-Garde Gateway.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'agms'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install agms
+
+## Usage
+
+Take a look at example code in the example folder
+
+
+## Release Notes
+
+Support for Invoicing and Recurring are not yet completed.
+
+
+## Documentation
+
+* [Official documentation](https://www.onlinepaymentprocessing.com/docs/ruby)
+* [Bug Tracker](http://github.com/agms/agms_ruby/issues)
+
+Examples can be found as part of this package in example /hpp.rb, example/invoicing.rb, example/recurring.rb, example_report.py, example/safe.rb, example/transaction.rb.
+
+
+## License
+
+See the LICENSE file.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/agms_code/agms_ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,40 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'agms/version'
+
+begin
+  require 'bundler'
+  Bundler.setup
+rescue LoadError => e
+  puts "Error loading bundler (#{e.message}): \"gem install bundler\" for bundler support."
+  require 'rubygems'
+end
+
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+task :tag_release do
+  system "git tag 'v#{Agms::VERSION}'"
+  system "git push --tags"
+end
+
+desc "Run the unit test suite"
+task :default => 'test:units'
+task :test => 'test:units'
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems -w'
+    t.libs << 'test'
+    t.verbose = true
+  end
+
+  Rake::TestTask.new(:remote) do |t|
+    t.pattern = 'test/remote/**/*_test.rb'
+    t.ruby_opts << '-rubygems -w'
+    t.libs << 'test'
+    t.verbose = true
+  end
+end
+

data/agms.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "agms"
+  spec.version       = Agms::VERSION
+  spec.authors       = ["Maanas Royy"]
+  spec.email         = ["maanas@agms.com"]
+
+  spec.summary       = %q{AGMS Ruby Client Library}
+  spec.description   = %q{Ruby Library for integrating AGMS Gateway}
+  spec.homepage      = "http://www.onlinepaymentprocessing.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.add_development_dependency 'nokogiri', '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'mocha', '~> 0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "agms_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/hpp.rb

@@ -0,0 +1,18 @@
+require './lib/agms'
+
+Agms::Configuration.init('init.yml')
+
+hpp = Agms::HPP.new
+
+params = {
+    :transaction_type => { :value => 'sale'},
+    :amount => { :value => '20.00'},
+    :first_name => {  :setting => 'required'},
+    :last_name => { :setting => 'required'},
+    :zip => { :setting => 'required'},
+    :email => { :setting => 'required'},
+    :hpp_format => { :value => '1'}
+}
+
+result = hpp.generate(params)
+print result

data/example/invoicing.rb

@@ -0,0 +1,23 @@
+require './lib/agms'
+
+Agms::Configuration.init('init.yml')
+Agms::Configuration.verbose = true
+recur = Agms::Invoicing.new
+
+params = {
+    :invoice_number => {:value => '12'},
+    :invoice_date => { :value => '2014-11-20'},
+    :bill_to_first_name => {:value => '0520'},
+    :cc_cvv => {:value => '123'},
+    :first_name => {:value => 'Test'},
+    :last_name => {:value => 'Recurring'},
+    :start_date => {:value => '2014-11-09'},
+    :end_date => {:value => '2018-11-09'},
+    :frequency => {:value => 'months'},
+    :number_of_retries => {:value => '2'},
+    :email => {:value => 'maanas@agms.com'}
+}
+
+result = recur.add(params)
+
+print result

data/example/recurring.rb

@@ -0,0 +1,23 @@
+require './lib/agms'
+
+Agms::Configuration.init('init.yml')
+Agms::Configuration.verbose = true
+recur = Agms::Recurring.new
+
+params = {
+    :recurring_amount => {:value => '20.00'},
+    :cc_number => { :value => '4111111111111111'},
+    :cc_exp_date => {:value => '0520'},
+    :cc_cvv => {:valuRe => '123'},
+    :first_name => {:value => 'Test'},
+    :last_name => {:value => 'Recurring'},
+    :start_date => {:value => '2014-11-09'},
+    :end_date => {:value => '2018-11-09'},
+    :frequency => {:value => 'months'},
+    :number_of_retries => {:value => '2'},
+    :email => {:value => 'maanas@agms.com'}
+}
+
+result = recur.add(params)
+
+print result

data/example/report.rb

@@ -0,0 +1,16 @@
+require './lib/agms'
+
+Agms::Configuration.init('init.yml')
+
+rep = Agms::Report.new
+
+params = {
+    :start_date => { :value => '2015-01-01'},
+    :end_date => { :value => '2015-03-28'}
+}
+
+result = rep.listTransactions(params)
+print result
+
+result = rep.listSAFEs(params)
+print result

data/example/safe.rb

@@ -0,0 +1,17 @@
+require './lib/agms'
+
+Agms::Configuration.init('init.yml')
+
+safe = Agms::SAFE.new
+
+params = {
+    :payment_type => { :value => 'creditcard'},
+    :first_name => { :value => 'Joe'},
+    :last_name => { :value => 'Smith'},
+    :cc_number => { :value => '4111111111111111'},
+    :cc_exp_date => { :value => '0500'},
+    :cc_cvv => { :value => '123'}
+}
+
+safe_result = safe.add(params)
+print safe_result

data/example/transaction.rb

@@ -0,0 +1,17 @@
+require './lib/agms'
+
+Agms::Configuration.init('init.yml')
+
+trans = Agms::Transaction.new
+
+params = {
+    :transaction_type => { :value => 'sale'},
+    :amount => { :value => '100.00'},
+    :cc_number => { :value => '4111111111111111'},
+    :cc_exp_date => { :value => '0520'},
+    :cc_cvv => { :value => '123'}
+}
+
+result = trans.process(params)
+
+print result

data/init.yml

@@ -0,0 +1,9 @@
+username : agmsdevdemo
+password : nX1m*xa9Id
+account : 1001789
+api_key : b00f57326f8cf34bbb705a74b5fcbaa2b2f3e58076dc81f
+http_client : requests
+max_amount : 10000
+min_amount : 0.00
+verbose : false
+hpp_template : template1

data/lib/agms.rb

@@ -0,0 +1,59 @@
+# Add current directory in library load path
+$:.unshift(File.expand_path(File.dirname(__FILE__))) unless
+    $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'net/http'
+require 'net/https'
+require 'openssl'
+
+require 'nokogiri'
+
+
+require 'agms/version'
+
+require 'agms/configuration'
+require 'agms/agms'
+
+require 'agms/transaction'
+require 'agms/safe'
+require 'agms/report'
+require 'agms/recurring'
+require 'agms/invoicing'
+require 'agms/hpp'
+
+require 'agms/error/agms_error'
+require 'agms/error/authentication_error'
+require 'agms/error/authorization_error'
+require 'agms/error/client_error_error'
+require 'agms/error/configuation_error'
+require 'agms/error/down_for_maintenance_error'
+require 'agms/error/forged_query_String_error'
+require 'agms/error/invalid_parameter_error'
+require 'agms/error/invalid_request_error'
+require 'agms/error/invalid_signature_error'
+require 'agms/error/not_found_error'
+require 'agms/error/request_validation_error'
+require 'agms/error/response_error'
+require 'agms/error/server_error_error'
+require 'agms/error/ssl_certificate_error'
+require 'agms/error/unexpected_error'
+require 'agms/error/upgrade_required_error'
+
+require 'agms/request/request'
+require 'agms/request/transaction_request'
+require 'agms/request/safe_request'
+require 'agms/request/report_request'
+require 'agms/request/recurring_request'
+require 'agms/request/invoicing_request'
+require 'agms/request/hpp_request'
+
+require 'agms/response/response'
+require 'agms/response/transaction_response'
+require 'agms/response/safe_response'
+require 'agms/response/report_response'
+require 'agms/response/recurring_response'
+require 'agms/response/invoicing_response'
+require 'agms/response/hpp_response'
+
+require 'agms/connect'
+

data/lib/agms/agms.rb

@@ -0,0 +1,109 @@
+module Agms
+
+    class Agms
+        # A class representing base AGMS objects.
+
+        # Version data
+        MAJOR = 0
+        MINOR = 2
+        TINY = 1
+
+        API = 3
+
+        def self.getLibraryVersion()
+          return Agms::MAJOR.to_s + '.' + Agms::MINOR.to_s + '.' + Agms::TINY.to_s
+        end
+
+        def self.getAPIVersion()
+          return Agms::API.to_s
+        end
+
+        def self.whatCardType(truncated, card_format='name')
+          card_abb = {
+              '3' => 'AX',
+              '4' => 'VX',
+              '5' => 'MC',
+              '6' => 'DS',
+          }
+
+          card_name = {
+              '3' => 'American Express',
+              '4' => 'Visa',
+              '5' => 'Mastercard',
+              '6' => 'Discover',
+          }
+
+          first_digit = truncated[0]
+
+          if card_format == 'abbreviation'
+            begin
+              return card_abb[first_digit]
+            rescue
+              return 'Unknown'
+            end
+          else
+            begin
+              return card_name[first_digit]
+            rescue
+              return 'Unknown'
+            end
+          end
+
+        end
+
+        def initialize(username=nil, password=nil, account=nil, api_key=nil)
+            if username and password
+                @username = username
+                @password = password
+                @account = account
+                @api_key = api_key
+            else
+                @username = Configuration.gateway_username
+                @password = Configuration.gateway_password
+                @account = Configuration.gateway_account
+                @api_key = Configuration.gateway_api_key
+            end
+            @op = nil
+            @api_url = nil
+            @request = nil
+            @response = nil
+        end
+
+        def doConnect(request_method, response_object)
+            # Get requestObject class name
+            requestClass = Object.const_get('Agms').const_get(@requestObject)
+            if @request.instance_of?(requestClass.class)
+                raise RequestValidationError('No request has been created, please define request parameters.')
+            else
+                connect = Connect.new(Configuration.instantiate())
+                request_body = @request.get(@username, @password, @account, @api_key)
+                request_body = @request.getParams(request_body)
+                response = connect.connect(@api_url, request_body, request_method, response_object)
+                responseClass = Object.const_get('Agms').const_get(@responseObject)
+                @response = responseClass.new(response, @op)
+                return true
+            end
+        end
+                
+        def setParameter(field, opts)
+            if not @request
+                self.resetParameters()
+            end
+            if opts.class == Hash and opts.length > 0
+                opts.each do |param, value|
+                  @request.setField(field, param, value)
+                end
+                return true
+            else
+                raise InvalidParameterError('Provided options are not in valid array format.')
+            end
+        end
+
+        def resetParameters()
+            @request = nil
+            requestClass = Object.const_get('Agms').const_get(@requestObject)
+            @request = requestClass.new(@op)
+        end
+
+    end
+end