CnpChargeback 2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef3e5294caa57da878cb89bdc8d084baea1c52bc
+  data.tar.gz: c313304e8a93d8689130a458f39c77916731261f
+SHA512:
+  metadata.gz: cb509240444d3df40ac8923e6a9cb455a98e0269b1198cc5c75a9c8ca0035421fab748966a75ecf5513256397fe7460c28a0e01ee14b2cc7a38200f09c4e3fb9
+  data.tar.gz: 190c8ebfac05c214b86429b59ea62f33bfbe755dd806f8afbdb58f030e7a1c9b78f9e3c1b29048ee6ce41e3729ecd0bf7433833bb25603ed5d4d9099598715a5

data/CHANGELOG

@@ -0,0 +1,2 @@
+==Version 2.1 (June 19, 2018)
+Initial Release

data/DESCRIPTION

@@ -0,0 +1,5 @@
+Vantiv eCommerce Online Ruby Chargeback SDK.
+
+This gem contains an application interface in the Ruby programming language created by Vantiv eCommerce.
+
+

data/LICENSE

@@ -0,0 +1,44 @@
+Copyright (c) 2017 Vantiv eCommerce.
+
+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.
+=======
+MIT License
+
+Copyright (c) 2018 vantiv
+
+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,70 @@
+# cnp-chargeback-sdk-ruby
+Ruby SDK implementing Vantiv eCommerce Chargeback API
+
+About Vantiv eCommerce
+------------
+[Vantiv eCommerce](https://developer.vantiv.com/community/ecommerce) powers the payment processing engines for leading companies that sell directly to consumers through  internet retail, direct response marketing (TV, radio and telephone), and online services. Vantiv eCommerce is the leading authority in card-not-present (CNP) commerce, transaction processing and merchant services.
+
+About this SDK
+--------------
+The Vantiv eCommerce Ruby Chargeback SDK is a Ruby implementation of the [Vantiv eCommerce](https://developer.vantiv.com/community/ecommerce) Chargeback API. This SDK was created to make it as easy as possible to manage your chargebacks using Vantiv eCommerce API. This SDK utilizes the HTTPS protocol to securely connect to Vantiv eCommerce. Using the SDK requires coordination with the Vantiv eCommerce team in order to be provided with credentials for accessing our systems.
+
+Each Ruby Chargeback SDK release supports all of the functionality present in the associated Vantiv eCommerce Chargeback API version (e.g., SDK v2.1.0 supports Vantiv eCommerce Chargeback API v2.1). Please see the Chargeback API reference guide to get more details on what the Vantiv eCommerce chargeback engine supports.
+
+See LICENSE file for details on using this software.
+
+Source Code available from : [https://github.com/Vantiv/cnp-sdk-for-ruby](https://github.com/Vantiv/cnp-chargeback-sdk-ruby)
+
+Please contact [Vantiv eCommerce](https://developer.vantiv.com/community/ecommerce) to receive valid merchant credentials in order to run tests successfully or if you require assistance in any way.  We are reachable at sdksupport@Vantiv.com
+
+
+Setup
+-----
+
+1) Install the CnpChargeback Ruby gem from rubygems.org, this will install the latest SDK gem in your Ruby environment.
+Our gem is available publicly from rubygems.org.  Use the command below to install.
+
+>sudo gem install CnpChargeback
+
+Note: If you get errors, you might have to configure your proxy.
+
+2) Once the gem is installed run our setup program to generate a configuration file.  The configuration file resides in your home directory
+$HOME/.cnp_chargeback_config.yml
+
+For more details on setup see our instructions [here](https://github.com/Vantiv/cnp-sdk-for-ruby/blob/12.X/SETUP.md)
+
+3) Example usage: 
+
+```ruby
+require 'CnpChargeback'
+include CnpChargeback
+
+# Retrieving information about a chargeback by caseId:
+response = ChargebackRetrieval.new.get_chargeback_by_case_id(case_id: "123")
+#access response elements 
+transactionId = response.transactionId
+cycle = response.cycle
+
+# Retrieving a list of chargebacks by activity date
+response = ChargebackRetrieval.new.get_chargebacks_by_date(activity_date: "2018-01-01")
+# access response elements 
+transactionId = response[5].transactionId
+cycle = response[3].cycle
+ 
+# Update chargeback case
+ChargebackUpdate.new.represent_case(case_id: 10000, note: "Test note", representment_amount: 12000)
+response = ChargebackUpdate.new.assign_case_to_user(case_id: 10000, user_id: "jdeo@company.com", note: "Test note")
+ 
+# Upload document
+response = ChargebackDocument.new.upload_document(case_id: "10000", document_path: "invoice.pdf")
+response_code = response.responseCode
+
+# Retrieve a list of documents by case id
+response = ChargebackDocument.new.list_documents(case_id: "10000")
+document_list = response.documentId
+```
+
+
+Please contact Vantiv eCommerce with any further questions. You can reach us at sdksupport@vantiv.com.
+
+

data/Rakefile

@@ -0,0 +1,90 @@
+# Copyright (c) 2018 Vantiv eCommerce.
+#
+# 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
+# NON-INFRINGEMENT. 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.
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rake/testtask'
+require 'rake/clean'
+
+spec = Gem::Specification.new do |s|
+  FileUtils.rm_rf('pkg')
+  s.name = 'CnpChargeback'
+  s.summary = 'Ruby Chargeback SDK produced by Vantiv eCommerce for chargeback processing using Vantiv eCommerce XML format v12.3'
+  s.description = File.read(File.join(File.dirname(__FILE__), 'DESCRIPTION'))
+  s.requirements =
+    ['Contact sdksupport@vantiv.com for more information']
+  s.version = '2.1'
+  s.author = 'Vantiv - eCommerce'
+  s.email = 'sdksupport@vantiv.com'
+  s.homepage = 'https://developer.vantiv.com/community/ecommerce/pages/sdks#jive_content_id_Ruby_SDK'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>=2.2.0'
+  s.files = Dir['**/**']
+  s.test_files = Dir['test/unit/ts_unit.rb']
+  s.has_rdoc = true
+  s.add_dependency('xml-object')
+  s.add_dependency('xml-mapping')
+  s.add_dependency('mimemagic')
+  s.add_dependency('net-sftp')
+  s.add_dependency('libxml-ruby')
+  s.add_dependency('crack')
+  s.add_dependency('iostreams')
+  s.add_development_dependency('mocha')
+end
+
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+namespace :test do
+  Rake::TestTask.new do |t|
+    t.libs << '.'
+    t.name = 'unit'
+    t.test_files = FileList['test/unit/ts_unit.rb']
+    t.verbose = true
+  end
+
+  Rake::TestTask.new do |t|
+    t.libs << '.'
+    t.name = 'functional'
+    t.test_files = FileList['test/functional/ts_all.rb']
+    t.verbose = true
+  end
+
+  Rake::TestTask.new do |t|
+    t.libs << '.'
+    t.name = 'certification'
+    t.test_files = FileList['test/certification/certTest*.rb']
+    t.verbose = true
+  end
+
+  Rake::TestTask.new do |t|
+    t.libs << '.'
+    t.name = 'all'
+    t.test_files = FileList['test/**/*.rb']
+    t.verbose = true
+  end
+end
+
+task default: 'gem'

data/SETUP.md

@@ -0,0 +1,44 @@
+Setting up and Configuring the Vantiv eCommerce Chargeback SDK
+=========================================
+
+Running the built in configuration file generator
+-------------------------------------------------
+The Ruby Chargeback SDK ships with a built in program which can be used to generate your specific configuration.
+
+This program runs as follows:
+   
+```
+>Setup.rb 
+Welcome to Vantiv eCommerce Ruby_Chargeback_SDK
+please input your user name:
+test_user
+please input your password:
+test_password
+Please choose Vantiv eCommerce url from the following list (example: 'prelive') or directly input another URL:
+sandbox => https://www.testvantivcnp.com/services/chargebacks
+prelive => https://payments.vantivprelive.com/services/chargebacks
+sandbox
+Please input the proxy address, if no proxy hit enter key: 
+
+Please input the proxy port, if no proxy hit enter key: 
+
+The Vantiv eCommerce configuration file has been generated, the file is located at: /<your-home-directory>/.cnp_chargeback_config.yml 
+```
+
+Modifying your configuration
+----------------------------
+You may change the configuration values at anytime by running Setup.rb again, or simpy opening the configuration file directly in the editor of your choice and changing the appropriate fields. 
+
+Changing the location of the Cnp configuration file:
+------------------------------------------------------
+NOTICE you can set the environment variable $CNP_CB_CONFIG_DIR to locate your configuration file in a location other than the $HOME Directory, the the file will reside in $CNP_CB_CONFIG_DIR/.cnp_chargeback_config.yml  
+
+Sample configuration file contents
+----------------------------------
+```
+user: test_user
+password: test_password
+url: https://www.testvantivcnp.com/services/chargebacks
+proxy_addr: yourproxyserver
+proxy_port: 8080
+```

data/bin/Setup.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+
+=begin
+Copyright (c) 2017 Vantiv eCommerce
+
+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
+NON-INFRINGEMENT. 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.
+=end
+
+# make setup file executable
+require 'iostreams'
+
+#
+# Configuration generation for URL and credentials
+#
+class Setup
+  attr_reader :handle, :path
+  def initialize(filename)
+    @handle = File.new(filename, File::CREAT|File::TRUNC|File::RDWR, 0600)
+    File.open(filename, 'w') do |f|
+      puts 'Welcome to Vantiv eCommerce Ruby_SDK'
+      puts 'Please input your user name:'
+      f.puts  'user: '+ gets
+      puts 'Please input your password:'
+      f.puts 'password: ' + gets
+      puts 'Please input your merchantId:'
+      f.puts 'merchantID: ' + gets
+      puts "Please choose Vantiv eCommerce url from the following list (example: 'prelive') or directly input another URL:
+sandbox => https://www.testvantivcnp.com/services/chargebacks
+prelive => https://payments.vantivprelive.com/services/chargebacks"
+      f.puts 'url: ' + Setup.choice(gets)
+      puts 'Please input the proxy address, if no proxy hit enter key: '
+      f.puts 'proxy_addr: ' + gets
+      puts 'Please input the proxy port, if no proxy hit enter key: '
+      f.puts 'proxy_port: ' + gets
+      f.puts 'printxml: false'
+      # default http timeout set to 500 ms
+      f.puts 'timeout: 500'
+    end
+  end
+
+  def finished
+    @handle.close
+  end
+
+  def Setup.choice(cnp_env)
+    if cnp_env == "sandbox\n"
+      return 'https://www.testvantivcnp.com/spring/services/chargebacks'
+    elsif cnp_env == "prelive\n"
+      return 'https://payments.vantivprelive.com/services/chargebacks'
+    else
+      return 'https://www.testvantivcnp.com/spring/chargebacks'
+    end
+  end
+end
+
+#
+#
+# Optionally enable the configuration to reside in a custom location
+# if the $CNP_CB_CONFIG_DIR directory is set
+#
+
+# make the config.yml file in the CNP_CB_CONFIG_DIR directory or HOME directory
+if !(ENV['CNP_CB_CONFIG_DIR'].nil?)
+  path = ENV['CNP_CB_CONFIG_DIR']
+else
+  path = ENV['HOME']
+end
+
+# make the config.yml file hidden
+# create a config file contain all the configuration data
+config_file = path + '/.cnp_chargeback_config.yml'
+f = Setup.new(config_file)
+
+# return the path of the config file and the path file
+@path = File.expand_path(config_file)
+puts 'The Vantiv eCommerce configuration file has been generated, the file is located at: ' + @path
+f.finished
+

data/lib/ChargebackDocument.rb

@@ -0,0 +1,67 @@
+=begin
+Copyright (c) 2017 Vantiv eCommerce
+
+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.
+=end
+require_relative 'Configuration'
+
+#
+# This class handles sending the Cnp online request
+#
+module CnpOnline
+
+  class ChargebackDocument
+    def initialize
+      @config_hash = Configuration.new.config
+    end
+
+    def retrieve_document(case_id:, document_id:, document_path:, config: @config_hash)
+      request_url =  config['url'] + "/retrieve/" + case_id.to_s + "/" + document_id.to_s
+      Communications.http_get_document_request(request_url, document_path, config)
+    end
+
+    def upload_document(case_id:, document_path:, config: @config_hash)
+      document_id = document_path.split("/")[-1]
+      request_url = config['url'] + "/upload/" + case_id + "/" + document_id
+      response_xml = Communications.http_post_document_request(request_url, document_path, config)
+      return XMLObject.new(response_xml)
+    end
+
+    def replace_document(case_id:, document_id:, document_path:, config: @config_hash)
+      request_url = config['url'] + "/replace/" + case_id + "/" + document_id
+      response_xml = Communications.http_put_document_request(request_url, document_path, config)
+      return XMLObject.new(response_xml)
+    end
+
+    def delete_document(case_id:, document_id:, config: @config_hash)
+      request_url = config['url'] + "/delete/" + case_id + "/" + document_id
+      response_xml = Communications.http_delete_document_request(request_url, config)
+      return XMLObject.new(response_xml)
+    end
+
+    def list_documents(case_id:, config: @config_hash)
+      request_url = config['url'] + "/list/" + case_id
+      response_xml = Communications.http_get_document_list_request(request_url, config)
+      return XMLObject.new(response_xml)
+    end
+  end
+end

data/lib/ChargebackRetrieval.rb

@@ -0,0 +1,85 @@
+=begin
+Copyright (c) 2017 Vantiv eCommerce
+
+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.
+=end
+require_relative 'Configuration'
+
+#
+# This class handles sending the Cnp online request
+#
+module CnpOnline
+
+  class ChargebackRetrieval
+    def initialize
+      @config_hash = Configuration.new.config
+    end
+
+    def get_chargebacks_by_date(activity_date:, config: @config_hash)
+      return _get_retrieval_response({date: activity_date}, config)
+    end
+
+    def get_chargebacks_by_financial_impact(activity_date:, financial_impact:, config: @config_hash)
+      return _get_retrieval_response({date: activity_date, financialOnly: financial_impact}, config)
+    end
+
+    def get_actionable_chargebacks(actionable:, config: @config_hash)
+      return _get_retrieval_response({actionable: actionable}, config)
+    end
+
+    def get_chargeback_by_case_id(case_id:, config: @config_hash)
+      return _get_retrieval_response({}, config, case_id)
+    end
+
+    def get_chargebacks_by_token(token:, config: @config_hash)
+      return _get_retrieval_response({token: token}, config)
+    end
+
+    def get_chargebacks_by_card_number(card_number:, expiration_date:, config: @config_hash)
+      return _get_retrieval_response({cardNumber: card_number, expirationDate: expiration_date}, config)
+    end
+
+    def get_chargebacks_by_arn(arn:, config: @config_hash)
+      return _get_retrieval_response({arn: arn}, config)
+    end
+
+    private
+
+    def _get_retrieval_response(parameters, config, endpoint=nil)
+      request_url = config['url']
+      prefix = "?"
+
+      if endpoint
+        request_url += "/" + endpoint
+      end
+
+      parameters.each_key do |name|
+        request_url += prefix + name.to_s + "=" + parameters[name]
+        prefix = "&"
+      end
+
+      response_xml = Communications.http_get_retrieval_request(request_url, config)
+      return XMLObject.new(response_xml)
+    end
+
+  end
+end