pci_proxy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d2e838d63aadc950a829e6d3b50e7c6fddcfffdb216ae9f7646d4dc06fbb930
+  data.tar.gz: 42b52b3106e60c53a75de4424f445edca6ddc9251c899f12f07dfeadee30b722
+SHA512:
+  metadata.gz: e9c4197a8b75b8070f5174d0a64ffd3fdb374ce4e279bc45b0f2386be6ccfdda3172baac6b00c8ac795526ac45e92bd4e19f41a23f959c5df803643d0b46562a
+  data.tar.gz: 11735efca4a2ce834ea0c6a05906b38649796b999eda37e9f6b697d39bce4b494cc1e92ba376d41a67e5ba270376a91388da925173541c2a46a8b09ec76f3b0f

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/.idea/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# PciProxy
+
+A simple client library for [PCI Proxy](https://pci-proxy.com)'s API
+
+#CHANGE LOG
+
+v1.0.0 - 14th January 2020 - Initial release - covers the [Token API](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes/token-api)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    pci_proxy (1.0.0)
+      faraday (~> 0.17.3)
+      multi_json (~> 1.14.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.13.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    rake (10.5.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  pci_proxy!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Rory Sinclair
+
+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,67 @@
+# PciProxy
+
+A simple client library for [PCI Proxy](https://pci-proxy.com)'s API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pci_proxy', '~> 1.0.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pci_proxy
+
+## Usage
+
+Initially, this gem only covers the [Token API](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes/token-api), which converts a transactionId from the [secure fields](https://docs.pci-proxy.com/collect-and-store-cards/capture-iframes) mechanism into tokenised card PAN and CVV.
+
+Pull requests are most welcome for coverage of other PCI Proxy APIs :)
+### Token API - Usage
+
+Create an instance of ```PciProxy::Token``` and call ```execute``` as follows:
+```ruby
+client = PciProxy::Token.new(api_username: 'username', api_password: 'password')
+```
+
+And execute a token exchange like so:
+```ruby
+client.execute(transaction_id: '1234567890')
+```
+
+In the event of a 200 OK response, the JSON response body is returned as a hash, for example:
+
+```ruby
+{"aliasCC"=>"411111GGCMUJ1111", "aliasCVV"=>"vCslSwP0SQ9JXJy-nDzLKHaS"}
+```
+
+In the event of an error, a subclass of ```PciProxyAPIError``` will be raised.
+
+The most likely error is that the transactionId temporary token has expired, resulting in:
+
+```ruby
+PciProxy::BadRequestError (HTTP status: 400, Response: Tokenization not found)
+```
+
+## Changes
+See [Changelog](CHANGELOG.md)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asmallworldsite/pci_proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pci_proxy"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/pci_proxy.rb

@@ -0,0 +1,22 @@
+require 'bundler'
+require "pci_proxy/version"
+
+require 'pci_proxy/base'
+require 'pci_proxy/token'
+
+module PciProxy
+  PciProxyAPIError = Class.new(StandardError)
+  BadRequestError = Class.new(PciProxyAPIError)
+  UnauthorizedError = Class.new(PciProxyAPIError)
+  ForbiddenError = Class.new(PciProxyAPIError)
+  NotFoundError = Class.new(PciProxyAPIError)
+  UnprocessableEntityError = Class.new(PciProxyAPIError)
+
+  HTTP_OK_CODE = 200
+
+  HTTP_BAD_REQUEST_CODE = 400
+  HTTP_UNAUTHORIZED_CODE = 401
+  HTTP_FORBIDDEN_CODE = 403
+  HTTP_NOT_FOUND_CODE = 404
+  HTTP_UNPROCESSABLE_ENTITY_CODE = 429
+end

data/lib/pci_proxy/base.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'multi_json'
+
+module PciProxy
+  class Base
+
+    attr_reader :api_endpoint, :api_username, :api_password
+
+    ##
+    # Create and memoise a Faraday client for this API client
+    def client
+      @client ||= Faraday.new(@api_endpoint) do |client|
+        client.request :url_encoded
+        client.adapter Faraday.default_adapter
+        client.basic_auth(@api_username, @api_password)
+      end
+    end
+
+    ##
+    # Perform the API request
+    #
+    # @param +endpoint+ [String] (Optional) - the API endpoint to hit - defaults to the value of the api_endpoint reader
+    # @param +http_method+ [Symbol] (Optional) - the HTTP method to use - defaults to GET
+    # @param +params+ [Hash] (Optional) - any parameters to supply to the API call
+    #
+    # @raise [PciProxyAPIError] in cases where the API responds with a non-200 response code
+    # @return [Hash] parsed JSON response
+    #
+    def request(endpoint: @api_endpoint, http_method: :get, params: {})
+      response = client.public_send(http_method, endpoint, params)
+
+      if response.status == HTTP_OK_CODE
+        return MultiJson.load(response.body)
+      end
+
+      raise error_class(response), "HTTP status: #{response.status}, Response: #{response.body}"
+    end
+
+    ##
+    # Fetch the error klass appropriate for the given Faraday +response+
+    #
+    # @param +response+ (Response) - the Faraday response object
+    # @return [StandardError] - the StandardError subclass appropriate to the +response+
+    def error_class(response)
+      case response.status
+      when HTTP_BAD_REQUEST_CODE
+        BadRequestError
+      when HTTP_UNAUTHORIZED_CODE
+        UnauthorizedError
+      when HTTP_FORBIDDEN_CODE
+        ForbiddenError
+      when HTTP_NOT_FOUND_CODE
+        NotFoundError
+      when HTTP_UNPROCESSABLE_ENTITY_CODE
+        UnprocessableEntityError
+      else
+        PciProxyAPIError
+      end
+    end
+
+  end
+end

data/lib/pci_proxy/token.rb

@@ -0,0 +1,25 @@
+module PciProxy
+  class Token < Base
+
+    ##
+    # Initialise with the specified +api_username+ and +api_password+ from PCI Proxy.
+    def initialize(api_username:, api_password:)
+      @api_endpoint = 'https://api.sandbox.datatrans.com/upp/services/v1/inline/token'.freeze
+      @api_username = api_username
+      @api_password = api_password
+    end
+
+    ##
+    # Perform a token request to turn the specified +transaction_id+ into card and CVV tokens
+    #
+    # @param +return_payment_method+ (true/false) - whether or not to return the identified payment method (default: true)
+    # @param +cvv_mandatory+ (true/false) - whether or not to consider the CVV alias should be mandatory (default: false)
+    #
+    # @raise [PciProxyAPIError] in cases where the API responds with a non-200 response code
+    # @return [Hash] result from PCI Proxy, decoded from JSON
+    def execute(transaction_id:, return_payment_method: true, cvv_mandatory: false)
+      request(params: { transactionId: transaction_id, returnPaymentMethod: return_payment_method, mandatoryAliasCVV: cvv_mandatory })
+    end
+
+  end
+end

data/lib/pci_proxy/version.rb

@@ -0,0 +1,3 @@
+module PciProxy
+  VERSION = "1.0.0"
+end

data/pci_proxy.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pci_proxy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pci_proxy"
+  spec.version       = PciProxy::VERSION
+  spec.authors       = ["Rory Sinclair"]
+  spec.email         = ["rory@mungler.com"]
+
+  spec.summary       = 'A client library for the PCI-Proxy service'
+  spec.description   = 'A ruby library covering the server-server aspects of the PCI-Proxy API'
+  spec.homepage      = "https://github.com/asmallworldsite/pci_proxy"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/asmallworldsite/pci_proxy/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "faraday", "~> 0.17.3"
+  spec.add_dependency "multi_json", "~> 1.14.1"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: pci_proxy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rory Sinclair
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+description: A ruby library covering the server-server aspects of the PCI-Proxy API
+email:
+- rory@mungler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pci_proxy.rb
+- lib/pci_proxy/base.rb
+- lib/pci_proxy/token.rb
+- lib/pci_proxy/version.rb
+- pci_proxy.gemspec
+homepage: https://github.com/asmallworldsite/pci_proxy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/asmallworldsite/pci_proxy
+  source_code_uri: https://github.com/asmallworldsite/pci_proxy
+  changelog_uri: https://github.com/asmallworldsite/pci_proxy/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A client library for the PCI-Proxy service
+test_files: []