connect-sdk-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9904df39ea9086dd36f1fda45a260a42546ea32
+  data.tar.gz: 5a9958176cceaba5701b659be2df0b9952fe5ef0
+SHA512:
+  metadata.gz: bc6c5983080c1199c1ff60c5e6bcce7a5f381f80b73c9490121b5277f1ec31f9aa06b6ab0dd0465e369d3b8644611f69b21d531caf8beb448671de197eefb9a9
+  data.tar.gz: 2c4be282e92d5e19a87a14751d37382b0e3d29a215ff2008768dc2bcc90a735545ad2638dc071f3444b75113ad86e4f07db4b108ada3e6c94fe6c3e78b9221c0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Global Collect Services B.V.
+
+ 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,140 @@
+# Ingenico Connect Ruby SDK
+
+## Introduction
+
+The Ruby SDK helps you to communicate with the [Ingenico Connect](http://www.ingenico.com/epayments) Server API. Its primary features are:
+
+* convenient Ruby library for the API calls and responses
+    * marshalls Ruby request objects to HTTP requests
+    * unmarshalls HTTP responses to Ruby response objects or Ruby exceptions
+* handling of all the details concerning authentication
+* handling of required meta data
+
+Its use is demonstrated by an example for each possible call. The examples execute a call using the provided API keys. 
+
+See the [Ingenico Connect Developer Hub](https://developer.globalcollect.com/documentation/sdk/server/ruby/) for more information on how to use the SDK.
+
+## Structure of this repository
+
+This repository consists out of four main components:
+
+1. The source code of the SDK itself: `/lib/ingenico/connect/sdk/`
+2. The source code of the SDK unit tests: `/spec/lib/`
+3. The source code of the SDK integration tests: `/spec/integration/`
+4. Usage examples: `/examples/`
+
+Note that the source code of the unit tests, integration tests and the examples can only be found on GitHub.
+
+## Requirements
+
+Ruby 2.2 and higher versions are required. Ruby 2.1.10 is also supported but is not suggested because official support has ended and security maintenance will end soon.
+In addition, the following package is required:
+
+* [httpclient](https://github.com/nahi/httpclient) 2.8 or higher
+
+## Installation
+
+### Using RubyGems
+
+To install the SDK using `gem`, execute the following command:
+
+    gem install connect-sdk-ruby
+
+### Using a pre-built gem
+
+1. Download the latest version of the Ruby SDK from GitHub. Choose the `connect-sdk-ruby-x.y.z.gem` file from the [releases](https://github.com/Ingenico-ePayments/connect-sdk-ruby/releases) page, where `x.y.z` is the version number.
+2. Navigate into the folder where the gem file is downloaded to, and execute the following command:
+
+    ```
+    gem install connect-sdk-ruby-x.y.z.gem
+    ```
+3. Feel free to delete the gem file at this point, it is no longer required.
+
+### From source
+
+1. Download the latest version of the Ruby SDK from GitHub. Choose the `connect-sdk-ruby-x.y.z.zip` file from the [releases](https://github.com/Ingenico-ePayments/connect-sdk-ruby/releases) page, where `x.y.z` is the version number.
+2. Unzip the file, navigate into the folder where the file is unzipped to, and execute the following commands:
+
+    ```
+    gem build connect-sdk-ruby.gemspec
+    gem install connect-sdk-ruby-x.y.z.gem
+    ```
+3. Feel free to delete the unzipped archive, the zip file and the gem file at this point, they are no longer required.
+
+## Uninstalling
+
+After the Ruby SDK has been installed, it can be uninstalled using the
+following command:
+
+    gem uninstall connect-sdk-ruby
+
+The required packages can be uninstalled in the same way.
+
+## Usage
+
+After the Ruby SDK has been installed, it can be required in Ruby program as follows:
+
+    require 'ingenico/connect/sdk'
+
+## Running tests 
+
+There are two types of tests: unit tests and integration tests. The unit tests will work out-of-the-box; for the integration tests some configuration is required.
+First, some environment variables need to be set:
+
+* `connect.api.apiKeyId` for the API key id to use. This can be retrieved from the Configuration Center.
+* `connect.api.secretApiKey` for the secret API key to use. This can be retrieved from the Configuration Center.
+* `connect.api.merchantId` for your merchant ID.
+
+In addition, to run the proxy integration tests, the proxy URI, username and password should be set in the `spec/fixtures/resources/properties.proxy.yml` file.
+
+In order to run the unit and integration tests, some additional dependencies are required:
+
+* [rake](https://ruby.github.io/rake/) 10.4 or higher
+* [rspec](https://github.com/rspec/rspec) 3.5 or higher
+* [webmock](https://github.com/bblimke/webmock) 2.1 or higher
+* [sinatra](https://github.com/sinatra/sinatra) 1.4 or higher
+
+They can be installed using the following command:
+
+    gem install rake rspec webmock sinatra
+
+*Note: if rake is already installed as part of the Ruby installation, this will cause a conflict error. This can safely be ignored.*
+
+The following commands can now be executed from the root directory of the SDK folder (/) to execute the tests:
+
+* Unit tests:
+
+    ```
+    rake unit
+    ```
+
+* Integration tests:
+
+    ```
+    rake integration
+    ```
+
+* Both unit and integration tests:
+
+    ```
+    rake spec
+    ```
+
+## Generating documentation
+
+Documentation can be generated with YARD. YARD can be installed as a gem. The gems required to generate documentation are:
+
+* [rake](https://ruby.github.io/rake/) 10.4 or higher
+* [yard](https://github.com/lsegal/yard) 0.9.5 or higher
+
+They can be installed using the following command:
+
+    gem install rake yard
+
+*Note: if rake is already installed as part of the Ruby installation, this will cause a conflict error. This can safely be ignored.*
+
+Once YARD and rake are installed, documentation can be generated with the following command (ran from the root folder):
+
+    rake yard
+
+Documentation will be generated in the `/doc` folder. The file `/doc/index.html` is the main documentation file.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|  # supports automated testing using the command *rake* *spec*
+    t.rspec_opts = '--color --format documentation'
+  end
+
+  RSpec::Core::RakeTask.new(:unit) do |t|  # supports automated testing using unit tests using the command *rake* *unit*
+    t.rspec_opts = '--color --format documentation'
+    t.exclude_pattern = 'spec/integration/**'
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|  # supports automated testing of integration using the command *rake* *integration*
+    t.rspec_opts = '--color --format documentation'
+    t.pattern = 'spec/integration/**_spec.rb'
+  end
+
+  task :default => :spec
+rescue LoadError
+  puts '[*] error -- development dependency is not installed'
+end
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new(:yard) do |t|  # supports generating documentation using the command *rake* *yard*
+      # t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
+      t.options = ['--no-private']
+  end
+
+  task :doc => :yard  # alternative alias to generate documentation
+rescue LoadError
+  puts '[*] error -- development dependency is not installed'
+end

data/connect-sdk-ruby.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |spec|
+  spec.name           = 'connect-sdk-ruby'
+  spec.version        = '1.0.0'
+  spec.authors        = ['Ingenico ePayments']
+  spec.email          = ['github@epay.ingenico.com']
+  spec.summary        = %q{SDK to communicate with the GlobalCollect platform using the Ingenico Connect Server API}
+  spec.description    = %q{SDK to communicate with the GlobalCollect platform using the Ingenico Connect Server API}
+  spec.homepage       = %q{https://github.com/Ingenico-ePayments/connect-sdk-ruby}
+  spec.license        = 'MIT'
+
+  # exclude hidden files like .gitignore
+  spec.files          = Dir['lib/**/*'] + Dir['examples/**/*'] + Dir['spec/**/*'] +
+                        ['connect-sdk-ruby.gemspec', 'Gemfile', 'LICENSE.txt', 'Rakefile', 'README.md']
+  spec.executables    = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files     = spec.files.grep(%r{^(test|spec|features)\/})
+  spec.require_paths  = ['lib']
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency 'httpclient', '~> 2.8'
+
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'sinatra', '~> 1.4'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  # spec.metadata['yard.run'] = 'yri'  # compiles yard doc on install
+end

data/examples/merchant/example_configuration.yml

@@ -0,0 +1,6 @@
+--- # YAML settings used in testing the SDK
+  connect.api.endpoint.host: api-sandbox.globalcollect.com
+  connect.api.authorizationType: v1HMAC
+  connect.api.connectTimeout: -1
+  connect.api.socketTimeout: -1
+  connect.api.maxConnections: 100

data/examples/merchant/hostedcheckouts/create_hosted_checkout_example.rb

@@ -0,0 +1,53 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/address'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+require 'ingenico/connect/sdk/domain/hostedcheckout/create_hosted_checkout_request'
+require 'ingenico/connect/sdk/domain/hostedcheckout/hosted_checkout_specific_input'
+require 'ingenico/connect/sdk/domain/payment/customer'
+require 'ingenico/connect/sdk/domain/payment/order'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Hostedcheckout = Ingenico::Connect::SDK::Domain::Hostedcheckout
+Payment = Ingenico::Connect::SDK::Domain::Payment
+
+def example
+  get_client do |client|
+    hosted_checkout_specific_input = Hostedcheckout::HostedCheckoutSpecificInput.new
+    hosted_checkout_specific_input.locale = 'en_GB'
+    hosted_checkout_specific_input.variant = 'testVariant'
+
+    amount_of_money = Definitions::AmountOfMoney.new
+    amount_of_money.amount = 2345
+    amount_of_money.currency_code = 'USD'
+
+    billing_address = Definitions::Address.new
+    billing_address.country_code = 'US'
+
+    customer = Payment::Customer.new
+    customer.billing_address = billing_address
+
+    order = Payment::Order.new
+    order.amount_of_money = amount_of_money
+    order.customer = customer
+
+    body = Hostedcheckout::CreateHostedCheckoutRequest.new
+    body.hosted_checkout_specific_input = hosted_checkout_specific_input
+    body.order = order
+
+    response = client.merchant('merchantId').hostedcheckouts().create(body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/hostedcheckouts/get_hosted_checkout_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').hostedcheckouts().get('hostedCheckoutId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payments/approve_payment_example.rb

@@ -0,0 +1,42 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/payment/approve_payment_request'
+require 'ingenico/connect/sdk/domain/payment/approve_payment_non_sepa_direct_debit_payment_method_specific_input'
+require 'ingenico/connect/sdk/domain/payment/order_approve_payment'
+require 'ingenico/connect/sdk/domain/payment/order_references_approve_payment'
+
+Payment = Ingenico::Connect::SDK::Domain::Payment
+
+def example
+  get_client do |client|
+    direct_debit_payment_method_specific_input = Payment::ApprovePaymentNonSepaDirectDebitPaymentMethodSpecificInput.new
+    direct_debit_payment_method_specific_input.date_collect = '20150201'
+    direct_debit_payment_method_specific_input.token = 'bfa8a7e4-4530-455a-858d-204ba2afb77e'
+
+    references = Payment::OrderReferencesApprovePayment.new
+    references.merchant_reference = 'AcmeOrder0001'
+
+    order = Payment::OrderApprovePayment.new
+    order.references = references
+
+    body = Payment::ApprovePaymentRequest.new
+    body.amount = 2980
+    body.direct_debit_payment_method_specific_input = direct_debit_payment_method_specific_input
+    body.order = order
+
+    response = client.merchant('merchantId').payments().approve('paymentId', body)
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payments/cancel_approval_payment_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').payments().cancelapproval('paymentId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payments/cancel_payment_example.rb

@@ -0,0 +1,22 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/factory'
+
+
+def example
+  get_client do |client|
+    response = client.merchant('merchantId').payments().cancel('paymentId')
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end

data/examples/merchant/payments/create_payment_example.rb

@@ -0,0 +1,177 @@
+#
+# This class was auto-generated from the API references found at
+# https://developer.globalcollect.com/documentation/api/server/
+#
+require 'ingenico/connect/sdk/api_exception'
+require 'ingenico/connect/sdk/declined_payment_exception'
+require 'ingenico/connect/sdk/factory'
+require 'ingenico/connect/sdk/domain/definitions/address'
+require 'ingenico/connect/sdk/domain/definitions/amount_of_money'
+require 'ingenico/connect/sdk/domain/definitions/card'
+require 'ingenico/connect/sdk/domain/definitions/company_information'
+require 'ingenico/connect/sdk/domain/payment/create_payment_request'
+require 'ingenico/connect/sdk/domain/payment/address_personal'
+require 'ingenico/connect/sdk/domain/payment/card_payment_method_specific_input'
+require 'ingenico/connect/sdk/domain/payment/contact_details'
+require 'ingenico/connect/sdk/domain/payment/customer'
+require 'ingenico/connect/sdk/domain/payment/line_item'
+require 'ingenico/connect/sdk/domain/payment/line_item_invoice_data'
+require 'ingenico/connect/sdk/domain/payment/order'
+require 'ingenico/connect/sdk/domain/payment/order_invoice_data'
+require 'ingenico/connect/sdk/domain/payment/order_references'
+require 'ingenico/connect/sdk/domain/payment/personal_information'
+require 'ingenico/connect/sdk/domain/payment/personal_name'
+
+Definitions = Ingenico::Connect::SDK::Domain::Definitions
+Payment = Ingenico::Connect::SDK::Domain::Payment
+
+def example
+  get_client do |client|
+    card = Definitions::Card.new
+    card.card_number = '4567350000427977'
+    card.cardholder_name = 'Wile E. Coyote'
+    card.cvv = '123'
+    card.expiry_date = '1220'
+
+    card_payment_method_specific_input = Payment::CardPaymentMethodSpecificInput.new
+    card_payment_method_specific_input.card = card
+    card_payment_method_specific_input.payment_product_id = 1
+    card_payment_method_specific_input.skip_authentication = false
+
+    amount_of_money = Definitions::AmountOfMoney.new
+    amount_of_money.amount = 2980
+    amount_of_money.currency_code = 'EUR'
+
+    billing_address = Definitions::Address.new
+    billing_address.additional_info = 'b'
+    billing_address.city = 'Monument Valley'
+    billing_address.country_code = 'US'
+    billing_address.house_number = '13'
+    billing_address.state = 'Utah'
+    billing_address.street = 'Desertroad'
+    billing_address.zip = '84536'
+
+    company_information = Definitions::CompanyInformation.new
+    company_information.name = 'Acme Labs'
+
+    contact_details = Payment::ContactDetails.new
+    contact_details.email_address = 'wile.e.coyote@acmelabs.com'
+    contact_details.email_message_type = 'html'
+    contact_details.fax_number = '+1234567891'
+    contact_details.phone_number = '+1234567890'
+
+    name = Payment::PersonalName.new
+    name.first_name = 'Wile'
+    name.surname = 'Coyote'
+    name.surname_prefix = 'E.'
+    name.title = 'Mr.'
+
+    personal_information = Payment::PersonalInformation.new
+    personal_information.date_of_birth = '19490917'
+    personal_information.gender = 'M'
+    personal_information.name = name
+
+    shipping_name = Payment::PersonalName.new
+    shipping_name.first_name = 'Road'
+    shipping_name.surname = 'Runner'
+    shipping_name.title = 'Miss'
+
+    shipping_address = Payment::AddressPersonal.new
+    shipping_address.additional_info = 'Suite II'
+    shipping_address.city = 'Monument Valley'
+    shipping_address.country_code = 'US'
+    shipping_address.house_number = '1'
+    shipping_address.name = shipping_name
+    shipping_address.state = 'Utah'
+    shipping_address.street = 'Desertroad'
+    shipping_address.zip = '84536'
+
+    customer = Payment::Customer.new
+    customer.billing_address = billing_address
+    customer.company_information = company_information
+    customer.contact_details = contact_details
+    customer.locale = 'en_US'
+    customer.merchant_customer_id = '1234'
+    customer.personal_information = personal_information
+    customer.shipping_address = shipping_address
+    customer.vat_number = '1234AB5678CD'
+
+    items = []
+
+    item1_amount_of_money = Definitions::AmountOfMoney.new
+    item1_amount_of_money.amount = 2500
+    item1_amount_of_money.currency_code = 'EUR'
+
+    item1_invoice_data = Payment::LineItemInvoiceData.new
+    item1_invoice_data.description = 'ACME Super Outfit'
+    item1_invoice_data.nr_of_items = '1'
+    item1_invoice_data.price_per_item = 2500
+
+    item1 = Payment::LineItem.new
+    item1.amount_of_money = item1_amount_of_money
+    item1.invoice_data = item1_invoice_data
+
+    items << item1
+
+    item2_amount_of_money = Definitions::AmountOfMoney.new
+    item2_amount_of_money.amount = 480
+    item2_amount_of_money.currency_code = 'EUR'
+
+    item2_invoice_data = Payment::LineItemInvoiceData.new
+    item2_invoice_data.description = 'Asperin'
+    item2_invoice_data.nr_of_items = '12'
+    item2_invoice_data.price_per_item = 40
+
+    item2 = Payment::LineItem.new
+    item2.amount_of_money = item2_amount_of_money
+    item2.invoice_data = item2_invoice_data
+
+    items << item2
+
+    invoice_data = Payment::OrderInvoiceData.new
+    invoice_data.invoice_date = '20140306191500'
+    invoice_data.invoice_number = '000000123'
+
+    references = Payment::OrderReferences.new
+    references.descriptor = 'Fast and Furry-ous'
+    references.invoice_data = invoice_data
+    references.merchant_order_id = 123456
+    references.merchant_reference = 'AcmeOrder0001'
+
+    order = Payment::Order.new
+    order.amount_of_money = amount_of_money
+    order.customer = customer
+    order.items = items
+    order.references = references
+
+    body = Payment::CreatePaymentRequest.new
+    body.card_payment_method_specific_input = card_payment_method_specific_input
+    body.order = order
+
+    begin
+      response = client.merchant('merchantId').payments().create(body)
+    rescue Ingenico::Connect::SDK::DeclinedPaymentException => e
+      handle_declined_payment(e.create_payment_result)
+    rescue Ingenico::Connect::SDK::ApiException => e
+      handle_api_errors(e.errors)
+    end
+  end
+end
+
+def get_client
+  api_key_id = ENV.fetch('connect.api.apiKeyId', 'someKey')
+  secret_api_key = ENV.fetch('connect.api.secretApiKey', 'someSecret')
+  configuration_file_name = File.join(__FILE__, '..', '..', 'example_configuration.yml')
+  yield client = Ingenico::Connect::SDK::Factory.create_client_from_file(configuration_file_name, api_key_id, secret_api_key)
+ensure
+  # Free networking resources when done
+  client.close unless client.nil?
+end
+
+def handle_declined_payment(create_payment_result)
+  # handle the result here
+end
+
+def  handle_api_errors(errors)
+  # handle the errors here
+end