eway_rapid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 478acbee46e2da78654b8f5247e3c52e0b27c573
+  data.tar.gz: dd78e049b7ab567023388bf66ba32939a6db06b0
+SHA512:
+  metadata.gz: 8fd579db7ef9c8b9e038323ce2c5870f25df693905e29d9fcff9a47874b0ffae3848a2cde2533447eaab5d435001642f33dd9aa3b7d44624444e0d35bc29ebd9
+  data.tar.gz: 8e7d254edee4fab2b0fc36b9c7bf30160ed97ad7bf7ebe6bf6a336387eb3582428147bb5c8703752bbbe5cb7dbcb838ec5b87249853b743275d753f0e173aef2

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+/.config
+coverage
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+/.yardoc
+/_yardoc/
+/doc/
+/rdoc/
+
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+/Gemfile.lock
+.idea
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
+
+before_install: gem install bundler -v 1.10.6
+
+sudo: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes will be documented in this file
+
+## 1.0.0
+
+ - First release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2015 Web Active Corporation Pty Ltd
+
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+> THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# eWAY Rapid Ruby Library
+
+[![Latest Version on RubyGems][ico-version]][link-rubygems]
+[![Software License][ico-license]](LICENSE.md)
+[![Build Status][ico-travis]][link-travis]
+
+A Ruby Gem to integrate with eWAY's Rapid Payment API.
+
+Sign up with eWAY at:
+ - Australia:    https://www.eway.com.au/
+ - New Zealand:  https://eway.io/nz/
+ - UK:           https://eway.io/uk/
+ - Hong Kong:    https://eway.io/hk/
+ - Malaysia:     https://eway.io/my/
+ - Singapore:    https://eway.io/sg/
+
+For testing, get a free eWAY Partner account: https://www.eway.com.au/developers
+
+## Installation
+
+The eWAY Ruby Gem requires Ruby 1.9.3 or better, it also requires the rest-client and json gems.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eway_rapid'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install eway_rapid
+```
+
+## Usage
+
+See the [eWAY Rapid API Reference](https://eway.io/api-v3/?ruby) for usage details.
+
+A simple Direct payment:
+
+```ruby
+require 'eway_rapid'
+
+api_key = 'Rapid API Key'
+password = 'Rapid API Password'
+endpoint = 'sandbox'
+
+client = RapidSDK::RapidClient.new(api_key, password, endpoint)
+
+transaction = EwayRapid::Models::Transaction.new
+transaction.customer = EwayRapid::Models::Customer.new
+
+card_details = EwayRapid::Models::CardDetails.new
+card_details.name = 'Ruby Dev'
+card_details.number = '4444333322221111'
+card_details.expiry_month = '05'
+card_details.expiry_year = '22'
+card_details.cvn = '123'
+transaction.customer.card_details = card_details
+
+payment_details = EwayRapid::Models::PaymentDetails.new
+payment_details.total_amount = 1000
+transaction.payment_details = payment_details
+transaction.transaction_type = EwayRapid::Enums::TransactionType::PURCHASE
+
+response = client.create_transaction(EwayRapid::Enums::PaymentMethod::DIRECT, basic_direct)
+
+if response.transaction_status.status?
+ puts "Success! ID: #{response.transaction_status.transaction_id.to_s}"
+end
+```
+
+## Testing
+
+All tests can be run by first installing all dependencies with `bundle install` then running `bundle exec rake`  
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+
+[ico-version]: https://img.shields.io/gem/v/eway-rapid.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/eWAYPayment/eway-rapid-ruby/master.svg?style=flat-square
+
+[link-rubygems]: https://rubygems.org/gems/eway-rapid
+[link-travis]: https://travis-ci.org/eWAYPayment/eway-rapid-ruby

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList[File.join('test', '**', '*test.rb')]
+  t.verbose = true
+end
+
+task :gem do
+  exec('gem build eway_rapid.gemspec')
+end

data/eway_rapid.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eway_rapid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eway_rapid'
+  spec.version       = EwayRapid::VERSION
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.author       = ['eWAY']
+  spec.summary       = 'Ruby gem for eWAY\'s Rapid API'
+  spec.description   = 'Easy online payments with eWAY and the eWAY Rapid Ruby gem.'
+  spec.homepage      = 'https://www.eway.com.au'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'json', '~> 1.8.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/eway_rapid.rb

@@ -0,0 +1,78 @@
+# eWAY Rapid API Ruby Module
+require 'json'
+require 'rest-client'
+require 'yaml'
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'version')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'constants')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'exceptions')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'rapid_logger')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'rapid_client')
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'models', 'enums')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'models', 'models')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'models', 'internal_models')
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'output', 'response_output')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'output', 'create_transaction_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'output', 'query_customer_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'output', 'query_transaction_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'output', 'refund_response')
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'cancel_authorisation_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'cancel_authorisation_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'capture_payment_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'capture_payment_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'create_access_code_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'create_access_code_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'create_access_code_shared_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'create_access_code_shared_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'create_customer_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'direct_customer_search_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'direct_customer_search_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'direct_payment_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'direct_payment_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'direct_refund_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'direct_refund_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'entities', 'transaction_search_response')
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'customer_to_internal_customer')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'direct_payment_to_trans_status')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'direct_refund_to_trans_status')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'internal_customer_to_customer')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'internal_trans_to_trans')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'internal_transaction_to_address')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'internal_transaction_to_status')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'payment_to_payment_details')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'shipping_details_to_address')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'transaction_shipping_address')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'transaction_to_arr_line_item')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'transaction_to_arr_option')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'transaction_to_payment')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'verification_to_verification_result')
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'request', 'refund_to_direct_refund_req')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'request', 'transaction_to_capture_payment')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'request', 'transaction_to_create_access_code_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'request', 'transaction_to_create_access_code_shared_request')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'request', 'transaction_to_direct_payment')
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'access_code_shared_to_create_cust')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'access_code_shared_to_create_trans')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'access_code_to_create_cust')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'access_code_to_create_trans')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'cancel_authorisation_to_refund')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'capture_payment_to_create_transaction')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'direct_customer_to_query_customer')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'direct_payment_to_create_cust')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'direct_payment_to_create_trans')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'direct_refund_to_refund_response')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'convert', 'response', 'search_to_query_trans')
+
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'process', 'rest_process')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'process', 'customer_process')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'process', 'refund_process')
+require File.join(File.dirname(__FILE__), 'eway_rapid', 'message', 'process', 'transaction_process')
+
+module EwayRapid
+end

data/lib/eway_rapid/constants.rb

@@ -0,0 +1,126 @@
+module EwayRapid
+  module Constants
+    EMAIL = 'Email'
+    PHONE = 'Phone'
+    VALUE = 'Value'
+    TOTAL_AMOUNT = 'TotalAmount'
+    INVOICE_NUMBER = 'InvoiceNumber'
+    INVOICE_DESCRIPTION = 'InvoiceDescription'
+    INVOICE_REFERENCE = 'InvoiceReference'
+    CURRENCY_CODE = 'CurrencyCode'
+    ORIGINAL_TRANSACTION_ID = 'TransactionID'
+    FIRST_NAME = 'FirstName'
+    LAST_NAME = 'LastName'
+    STREET1 = 'Street1'
+    STREET2 = 'Street2'
+    CITY = 'City'
+    STATE = 'State'
+    COUNTRY = 'Country'
+    POSTAL_CODE = 'PostalCode'
+    FAX = 'Fax'
+    SHIPPING_METHOD = 'ShippingMethod'
+    CVN = 'CVN'
+    MOBILE = 'Mobile'
+    ADDRESS = 'Address'
+    SKU = 'SKU'
+    DESCRIPTION = 'Description'
+    QUANTITY = 'Quantity'
+    UNIT_COST = 'UnitCost'
+    TAX = 'Tax'
+    TOTAL = 'Total'
+    TOKEN_CUSTOMER_ID = 'TokenCustomerID'
+    REFERENCE = 'Reference'
+    TITLE = 'Title'
+    COMPANY_NAME = 'CompanyName'
+    JOB_DESCRIPTION = 'JobDescription'
+    COMMENTS = 'Comments'
+    URL = 'Url'
+    CARD_NUMBER = 'CardNumber'
+    CARD_START_MONTH = 'CardStartMonth'
+    CARD_START_YEAR = 'CardStartYear'
+    CARD_ISSUE_NUMBER = 'CardIssueNumber'
+    CARD_NAME = 'CardName'
+    CARD_EXPIRY_MONTH = 'CardExpiryMonth'
+    CARD_EXPIRY_YEAR = 'CardExpiryYear'
+    IS_ACTIVE = 'IsActive'
+    CARD_DETAILS = 'CardDetails'
+    CUSTOMER_DEVICE_IP = 'CustomerIP'
+    NAME = 'Name'
+    NUMBER = 'Number'
+    EXPIRY_MONTH = 'ExpiryMonth'
+    EXPIRY_YEAR = 'ExpiryYear'
+    START_MONTH = 'StartMonth'
+    START_YEAR = 'StartYear'
+    ISSUE_NUMBER = 'IssueNumber'
+    CUSTOMER_NOTE = 'CustomerNote'
+    AUTHORISATION_CODE = 'AuthorisationCode'
+    RESPONSE_CODE = 'ResponseCode'
+    RESPONSE_MESSAGE = 'ResponseMessage'
+    TRANSACTION_ID = 'TransactionID'
+    TRANSACTION_STATUS = 'TransactionStatus'
+    BEAGLE_SCORE = 'BeagleScore'
+    OPTIONS = 'Options'
+    VERIFICATION = 'Verification'
+    CUSTOMER = 'Customer'
+    SHIPPING_ADDRESS = 'ShippingAddress'
+    BEAGLE_VERIFICATION = 'BeagleVerification'
+    ERRORS = 'errors'
+    CUSTOMERS = 'Customers'
+    PAYMENT = 'Payment'
+    REQUEST_TRANSACTION_ID = 'TransactionId'
+    ITEMS = 'Items'
+    REDIRECT_URL = 'RedirectUrl'
+    METHOD = 'Method'
+    DEVICE_ID = 'DeviceID'
+    CHECKOUT_PAYMENT = 'CheckoutPayment'
+    CHECKOUT_URL = 'CheckoutUrl'
+    TRANSACTION_TYPE = 'TransactionType'
+    PARTNER_ID = 'PartnerID'
+    TRANSACTIONS = 'Transactions'
+    ERRORS_CAPITALIZED = 'Errors'
+    REFUND = 'Refund'
+    LINE_ITEMS = 'LineItems'
+    TRANSACTION_CAPTURED = 'TransactionCaptured'
+    FRAUD_ACTION = 'FraudAction'
+    ACCESS_CODE = 'AccessCode'
+    FORM_ACTION_URL = 'FormActionURL'
+    SHARED_PAYMENT_URL = 'SharedPaymentUrl'
+    COMPLETE_CHECKOUT_URL = 'CompleteCheckoutURL'
+    CANCEL_URL = 'CancelUrl'
+    LOGO_URL = 'LogoUrl'
+    HEADER_TEXT = 'HeaderText'
+    LANGUAGE = 'Language'
+    CUSTOMER_READ_ONLY = 'CustomerReadOnly'
+    CUSTOMER_VIEW = 'CustomView'
+    VERIFY_CUSTOMER_PHONE = 'VerifyCustomerPhone'
+    VERIFY_CUSTOMER_EMAIL = 'VerifyCustomerEmail'
+    JSON_SUFFIX = '.json'
+    LIBRARY_NOT_HAVE_ENDPOINT_ERROR_CODE = 'S9990'
+    API_KEY_INVALID_ERROR_CODE = 'S9991'
+    COMMUNICATION_FAILURE_ERROR_CODE = 'S9992'
+    AUTHENTICATION_FAILURE_ERROR_CODE = 'S9993'
+    INTERNAL_RAPID_API_ERROR_CODE = 'S9995'
+    INTERNAL_RAPID_SERVER_ERROR_CODE = 'S9996'
+    ERROR_CODE_RESOURCE_EN = 'err_code_resource_en.yml'
+    RAPID_API_RESOURCE = 'rapid-api.yml'
+    RAPID_SDK_USER_AGENT_PARAM = 'rapid.sdk.user.agent'
+    GLOBAL_RAPID_PRODUCTION_REST_URL_PARAM = 'global.rapid.rest.production.url'
+    GLOBAL_RAPID_SANDBOX_REST_URL_PARAM = 'global.rapid.rest.sandbox.url'
+    RAPID_ENDPOINT_SANDBOX = 'Sandbox'
+    RAPID_ENDPOINT_PRODUCTION = 'Production'
+    DIRECT_PAYMENT_METHOD_NAME = 'DirectPayment'
+    RESPONSIVE_SHARED_METHOD_NAME = 'CreateAccessCodeShared'
+    TRANSPARENT_REDIRECT_METHOD_NAME = 'CreateAccessCode'
+    DIRECT_REFUND_METHOD_NAME = 'DirectRefund'
+    CANCEL_AUTHORISATION_METHOD_NAME = 'CancelAuthorisation'
+    CREATE_TOKEN_CUSTOMER_METHOD = 'CreateTokenCustomer'
+    UPDATE_TOKEN_CUSTOMER_METHOD = 'UpdateTokenCustomer'
+    CANCEL_AUTHORISATION_METHOD = 'CancelAuthorisation'
+    TRANSACTION_METHOD = 'Transaction'
+    DIRECT_CUSTOMER_SEARCH_METHOD = 'DirectCustomerSearch'
+    TRANSACTION_QUERY_WITH_INVOICE_NUM_METHOD = 'InvoiceNumber'
+    TRANSACTION_QUERY_WITH_INVOICE_REF_METHOD = 'InvoiceRef'
+    REFUND_SUB_PATH_METHOD = 'Refund'
+    CAPTURE_PAYMENT_METHOD = 'CapturePayment'
+  end
+end

data/lib/eway_rapid/entities/cancel_authorisation_request.rb

@@ -0,0 +1,9 @@
+module EwayRapid
+  class CancelAuthorisationRequest
+    attr_accessor :transaction_id
+
+    def to_json(options={})
+      { Constants::REQUEST_TRANSACTION_ID => transaction_id }.to_json
+    end
+  end
+end

data/lib/eway_rapid/entities/cancel_authorisation_response.rb

@@ -0,0 +1,34 @@
+module EwayRapid
+  class CancelAuthorisationResponse
+    attr_accessor :response_code
+    attr_accessor :response_message
+    attr_accessor :transaction_id
+    attr_accessor :transaction_status
+    attr_accessor :errors
+
+    alias_method :transaction_status?, :transaction_status
+
+    def to_json(options={})
+      { Constants::RESPONSE_CODE => response_code,
+       Constants::RESPONSE_MESSAGE => response_message,
+       Constants::TRANSACTION_ID => transaction_id,
+       Constants::TRANSACTION_STATUS => transaction_status,
+       Constants::ERRORS => errors }.to_json
+    end
+
+    def self.from_json(json)
+      hash = JSON.parse(json)
+      from_hash(hash)
+    end
+
+    def self.from_hash(hash)
+      cancel_authorisation_response = CancelAuthorisationResponse.new
+      cancel_authorisation_response.response_code = hash[Constants::RESPONSE_CODE]
+      cancel_authorisation_response.response_message = hash[Constants::RESPONSE_MESSAGE]
+      cancel_authorisation_response.transaction_id = hash[Constants::TRANSACTION_ID]
+      cancel_authorisation_response.transaction_status = hash[Constants::TRANSACTION_STATUS]
+      cancel_authorisation_response.errors = hash[Constants::ERRORS_CAPITALIZED]
+      cancel_authorisation_response
+    end
+  end
+end