worldpay_cnp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89bf5fce70ba0dbff1493a07c9c63a9619a17a633b64bf163681b0fd002ec942
+  data.tar.gz: 74fa0c70f00a2df9a223e3f4644caab533cdb2efb95ea7707a1e1cfda457bd20
+SHA512:
+  metadata.gz: ed19a23c8647fed3ce365d80f5494ca66342b88bf4c6ab095ed2b44fe8f7290ba9f1c3b215614dd7bc8acbcd420795f5db5bebaf21a2dd560102c271e231fab9
+  data.tar.gz: c8082c88313c40675b1ca1d6609b00a18e0153defd5cdb8c948db9b955f9a2b458d90f92110d06203a9b67b88f51b200cb7f1e3bdbbf3bd911ea6035d09e8422

data/.env.sample

@@ -0,0 +1,3 @@
+USERNAME="YOUR_API_USERNAME"
+PASSWORD="YOUR_API_PASSWORD"
+MERCHANT_ID="YOUR_MERCHANT_ID"

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: Test Suite
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
+    - name: Install rubygems
+      run: |
+        gem update --system --no-document
+
+    - name: Install bundler
+      run: |
+        gem install bundler --no-document
+
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Run Tests
+      env:
+        USERNAME: test
+        PASSWORD: test
+        MERCHANT_ID: test
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.env
+Notes.rb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## Unreleased
+
+...
+
+## 0.1.0 (2020-10-30)
+
+* Initial release of worldpay_cnp gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jjfutbol@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in worldpay_cnp.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "dotenv"
+gem "vcr"
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    worldpay_cnp (0.1.0)
+      http (>= 4, < 5)
+      nokogiri (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.6)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    vcr (6.0.0)
+    webmock (3.9.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+  worldpay_cnp!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Javier Julio
+
+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,119 @@
+# WorldpayCnp Ruby gem
+
+![Test Suite](https://github.com/jackpocket/worldpay-cnp/workflows/Test%20Suite/badge.svg)
+
+A Ruby library for the Worldpay cnpAPI with a simple interface for creating transactions as a Ruby hash to XML and back. So no real request objects. Since the cnpAPI uses camelCase, this library will handle converting to and from snake_case for you. While Worldpay has an official [CnpOnline Ruby SDK](https://github.com/Vantiv/cnp-sdk-for-ruby), they no longer support it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'worldpay_cnp'
+```
+
+And then run `bundle install` or install directly with `gem install worldpay_cnp`.
+
+## Usage
+
+### Client Configuration
+
+Create and configure a client with your API authentication.
+
+```ruby
+client = WorldpayCnp::Client.new(
+  username: "YOUR_USERNAME",
+  password: "YOUR_PASSWORD",
+  merchant_id: "YOUR_MERCHANT_ID",
+  # These are the other available options with their default values
+  version: "12.8",
+  environment: :sandbox,
+  timeout: nil, # with an integer, it is in seconds
+  proxy: nil,
+  xml_namspace: "http://www.vantivcnp.com/schema",
+  xml_request_root: "cnpOnlineRequest"
+)
+```
+
+#### Using A Proxy
+
+A client can be configured with a proxy.
+
+```ruby
+WorldpayCnp::Client.new(
+  # ...other options
+  proxy: {
+    host: "127.0.0.1",
+    port: 5000,
+    username: "username",
+    password: "password",
+  }
+)
+```
+
+At a minimum, just the `host` and `port` fields are required to use a proxy.
+
+### Making Requests
+
+Make an API request with a payload in the structure and order documented by the cnpAPI but **using snake_case**. The request payload will be **converted to camelCase** internally before submission.
+
+Since generating part of the request body is taken care of (e.g. the XML root and authentication elements) we just specify the child element. For example, when creating a Sale transaction, it would look like:
+
+```ruby
+client.create_transaction(
+  sale: {
+    "@id": "123",
+    "@report_group": "Default Report Group",
+    order_id: "456"
+    amount: "1000",
+    order_source: "ecommerce",
+    card: {
+      type: "VI",
+      number: "4457010000000009",
+      exp_date: "1025",
+      card_validation_num: "349",
+    }
+  }
+)
+```
+
+Any keys prefixed with "@" will be serialized to an XML attribute, while all others become XML elements. Note that this does not apply to responses.
+
+**IMPORTANT**: The cnpAPI enforces the order of XML elements, so the hash keys provided must be declared in the same order as it would if it were XML.
+
+For now, the library only supports cnpAPI online requests. No batch requests.
+
+### Handling Responses
+
+The generic response object is essentially an underlying hash **in snake_case** form. No typed response objects. So considering the earlier Sale request example, we can use `dig` to retrieve specific values from the response.
+
+```ruby
+response.status_code
+# => 200
+response.dig(:sale_response, :response)
+# => "000"
+response.dig(:sale_response, :message)
+# => "Approved"
+```
+
+Note: The response data starts with **the value of** the root XML element (attributes included) so do not specify the root XML key as part of the lookup process.
+
+Since the cnpAPI returns an HTTP 200 response for format errors, an `WorldpayCnp::Error::InvalidFormatError` **will be raised with the included parsed response code and message**. The response code comes from the XML root `response` attribute and can be a value of "1" through "5" (note: as a string value).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment with methods `authenticated_client` and `sandbox_client` already available.
+
+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/jackpocket/worldpay_cnp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jackpocket/worldpay_cnp/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WorldpayCnp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jackpocket/worldpay_cnp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv/load"
+require "worldpay_cnp"
+
+# 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.
+
+def authenticated_client(**options)
+  WorldpayCnp::Client.new(
+    username: ENV["USERNAME"],
+    password: ENV["PASSWORD"],
+    merchant_id: ENV["MERCHANT_ID"],
+    environment: :prelive,
+    **options
+  )
+end
+
+def sandbox_client(**options)
+  WorldpayCnp::Client.new(environment: :sandbox, **options)
+end
+
+# (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,26 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+read -r -p 'Do you have a Worldpay Prelive account? (y/n) ' has_account
+
+if [[ "$has_account" =~ ^(No|no|N|n)$ ]]; then
+  echo "Then you'll need to get credentials first or rely on"
+  echo "the sandbox environment. No account or auth required."
+  exit 0
+fi
+
+echo "Enter your Prelive credentials below."
+read -p 'API Username: ' username
+read -p 'API Password: ' password
+read -p 'Merchant Id: ' merchant_id
+
+cp .env.sample .env
+
+sed -i '' -e "s/YOUR_API_USERNAME/$username/g" .env
+sed -i '' -e "s/YOUR_API_PASSWORD/$password/g" .env
+sed -i '' -e "s/YOUR_MERCHANT_ID/$merchant_id/g" .env
+
+echo "Done."

data/lib/worldpay_cnp.rb

@@ -0,0 +1,12 @@
+require "http"
+require "nokogiri"
+require "worldpay_cnp/version"
+require "worldpay_cnp/refinements/deep_symbolize_keys"
+require "worldpay_cnp/refinements/camel_case"
+require "worldpay_cnp/refinements/snake_case"
+require "worldpay_cnp/error"
+require "worldpay_cnp/response"
+require "worldpay_cnp/xml"
+require "worldpay_cnp/configuration"
+require "worldpay_cnp/api_client"
+require "worldpay_cnp/client"

data/lib/worldpay_cnp/api_client.rb

@@ -0,0 +1,73 @@
+module WorldpayCnp
+  class ApiClient
+    HEADERS = {
+      'Content-Type' => 'text/xml; charset=UTF-8',
+      'User-Agent' => "WorldpayCnpRubyGem/#{WorldpayCnp::VERSION}",
+      'X-Ruby-Version' => RUBY_VERSION,
+      'X-Ruby-Platform' => RUBY_PLATFORM
+    }
+
+    INVALID_RESPONSE_VALUES = %w(1 2 3 4 5)
+
+    using Refinements::CamelCase
+    using Refinements::SnakeCase
+    using Refinements::DeepSymbolizeKeys
+
+    def initialize(config)
+      @config = config
+    end
+
+    def perform_post(url, data)
+      response = http_client.post(url, body: XML.serialize(data.to_camel_case))
+      process_response(response)
+    end
+
+    protected
+
+    def http_client
+      client = with_proxy? ? HTTP.via(*proxy) : HTTP
+      client.headers(HEADERS).timeout(@config.timeout || :null)
+    end
+
+    def with_proxy?
+      !proxy.nil? && !proxy.empty?
+    end
+
+    def proxy
+      @proxy ||= @config.proxy&.values_at(:host, :port, :username, :password)&.compact
+    end
+
+    def process_response(response)
+      data = parse_response_body(response.to_s)
+
+      if response.status.success?
+        handle_invalid_format_error(data, response.to_s)
+        Response.new(data, response.status.code, response.to_s)
+      else
+        raise Error.from_http_response(response.to_s, response.status.code)
+      end
+    end
+
+    def parse_response_body(body)
+      return {} if body.strip.empty?
+      hash_from_xml(body)
+    end
+
+    def hash_from_xml(xml)
+      result = XML.parse(xml)
+      if root_key = result.keys.first
+        result[root_key]&.to_snake_case&.deep_symbolize_keys
+      end
+    end
+
+    def handle_invalid_format_error(hash, body)
+      if INVALID_RESPONSE_VALUES.include?(hash.dig(:response))
+        raise Error::InvalidFormatError.new(
+          hash.dig(:message),
+          response_code: hash.dig(:response),
+          raw_response: body
+        )
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/client.rb

@@ -0,0 +1,39 @@
+module WorldpayCnp
+  class Client
+
+    attr_reader :config
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [WorldpayCnp::Client]
+    def initialize(**options)
+      @config = Configuration.new(**options)
+    end
+
+    def create_transaction(data)
+      api_client.perform_post(@config.api_url, build_request_body(data))
+    end
+
+    private
+
+    def api_client
+      @api_client ||= ApiClient.new(@config)
+    end
+
+    def build_request_body(data)
+      {
+        @config.xml_request_root => {
+          '@xmlns' => @config.xml_namespace,
+          '@version' => @config.version,
+          '@merchantId' => @config.merchant_id,
+          'authentication' => {
+            'user' => @config.username,
+            'password' => @config.password
+          }
+        }.merge(data)
+      }
+    end
+
+  end
+end

data/lib/worldpay_cnp/configuration.rb

@@ -0,0 +1,43 @@
+module WorldpayCnp
+  class Configuration
+    ENVIRONMENTS = {
+      sandbox: "https://www.testvantivcnp.com/sandbox/communicator/online",
+      prelive: "https://payments.vantivprelive.com/vap/communicator/online",
+      production: "https://payments.vantivcnp.com/vap/communicator/online"
+    }.freeze
+
+    attr_reader :environment,
+      :username,
+      :password,
+      :merchant_id,
+      :version,
+      :timeout,
+      :proxy,
+      :xml_namespace,
+      :xml_request_root
+
+    def initialize(**options)
+      set_defaults
+      set_config(options)
+    end
+
+    def api_url
+      @api_url ||= ENVIRONMENTS[@environment.to_sym]
+    end
+
+    private
+
+    def set_defaults
+      @environment = :sandbox
+      @version = "12.8"
+      @xml_namespace = "http://www.vantivcnp.com/schema"
+      @xml_request_root = "cnpOnlineRequest"
+    end
+
+    def set_config(options)
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/error.rb

@@ -0,0 +1,85 @@
+module WorldpayCnp
+  class Error < StandardError
+    InvalidFormatError = Class.new(self)
+    XmlParseError = Class.new(self)
+
+    # Raised on a 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # Raised on the HTTP status code 403
+    Forbidden = Class.new(ClientError)
+
+    # Raised on the HTTP status code 404
+    NotFound = Class.new(ClientError)
+
+    # Raised on the HTTP status code 405
+    MethodNotAllowed = Class.new(ClientError)
+
+    # Raised on the HTTP status code 417
+    ExpectationFailed = Class.new(ClientError)
+
+    # Raised on a 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # Raised on the HTTP status code 500
+    InternalServerError = Class.new(ServerError)
+
+    # Raised on the HTTP status code 502
+    BadGateway = Class.new(ServerError)
+
+    # Raised on the HTTP status code 503
+    ServiceUnavailable = Class.new(ServerError)
+
+    # Raised on the HTTP status code 504
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS_BY_STATUS = {
+      403 => Error::Forbidden,
+      404 => Error::NotFound,
+      405 => Error::MethodNotAllowed,
+      417 => Error::ExpectationFailed,
+      500 => Error::InternalServerError,
+      502 => Error::BadGateway,
+      503 => Error::ServiceUnavailable,
+      504 => Error::GatewayTimeout,
+    }
+
+    class << self
+      # Create a new error from an HTTP response body and status
+      #
+      # @param body [String]
+      # @param status [Integer]
+      # @return [WorldpayCnp::Error]
+      def from_http_response(body, status)
+        klass = ERRORS_BY_STATUS[status] || self
+        klass.new("Service error (Status: #{status})", raw_response: body)
+      end
+    end
+
+    # The raw HTTP response, if applicable
+    #
+    # @return [String]
+    attr_reader :raw_response
+
+    # The response code in the XML root element. The value of the
+    # response attribute in the following example:
+    #
+    # <cnpOnlineResponse version="12.17" xmlns="http://www.vantivcnp.com/schema"
+    #   response="1" message="Error validating xml..." />
+    #
+    # @return [String]
+    attr_reader :response_code
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [String]
+    # @param raw_http_response [String]
+    # @return [WorldpayCnp::Error]
+    def initialize(message, response_code: '', raw_response: '')
+      @response_code = response_code
+      @raw_response = raw_response
+      super(message)
+    end
+  end
+end

data/lib/worldpay_cnp/refinements/camel_case.rb

@@ -0,0 +1,44 @@
+module WorldpayCnp
+  module Refinements
+    module CamelCase
+      refine Hash do
+
+        def to_camel_case
+          _to_camel_case(self)
+        end
+
+        private
+
+        def _to_camel_case(data)
+          case data
+          when Array
+            data.map { |value| _to_camel_case(value) }
+          when Hash
+            data.map { |key, value| [camel_case_key(key), _to_camel_case(value)] }.to_h
+          else
+            data
+          end
+        end
+
+        def camel_case_key(key)
+          case key
+          when Symbol
+            camel_case(key.to_s).to_sym
+          when String
+            camel_case(key).to_sym
+          else
+            key
+          end
+        end
+
+        def camel_case(string)
+          @acronyms ||= { 'au' => 'AU', 'iias' => 'IIAS' }
+          @acronym_regex ||= /#{@acronyms.values.join("|")}/
+          result = string.sub(/^[a-z\d]*/) { |match| @acronyms[match] || match }
+          result.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{@acronyms[$2] || $2.capitalize}" }
+        end
+
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/refinements/deep_symbolize_keys.rb

@@ -0,0 +1,28 @@
+module WorldpayCnp
+  module Refinements
+    module DeepSymbolizeKeys
+      refine Hash do
+
+        def deep_symbolize_keys
+          _deep_transform_keys_in_object(self, &:to_sym)
+        end
+
+        private
+
+        def _deep_transform_keys_in_object(object, &block)
+          case object
+          when Hash
+            object.each_with_object({}) do |(key, value), result|
+              result[yield(key)] = _deep_transform_keys_in_object(value, &block)
+            end
+          when Array
+            object.map { |value| _deep_transform_keys_in_object(value, &block) }
+          else
+            object
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/refinements/snake_case.rb

@@ -0,0 +1,47 @@
+module WorldpayCnp
+  module Refinements
+    module SnakeCase
+      refine Hash do
+
+        def to_snake_case
+          _to_snake_case(self)
+        end
+
+        private
+
+        def _to_snake_case(data)
+          case data
+          when Array
+            data.map { |value| _to_snake_case(value) }
+          when Hash
+            data.map { |key, value| [underscore_key(key), _to_snake_case(value)] }.to_h
+          else
+            data
+          end
+        end
+
+        def underscore_key(key)
+          case key
+          when Symbol
+            underscore(key.to_s).to_sym
+          when String
+            underscore(key).to_sym
+          else
+            key
+          end
+        end
+
+        def underscore(string)
+          @__memoize_underscore ||= {}
+          return @__memoize_underscore[string] if @__memoize_underscore[string]
+          @__memoize_underscore[string] =
+            string.gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+                  .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                  .downcase
+          @__memoize_underscore[string]
+        end
+
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/response.rb

@@ -0,0 +1,15 @@
+module WorldpayCnp
+  class Response
+    extend Forwardable
+
+    attr_reader :status_code, :raw_response
+
+    delegate [:dig, :to_h, :to_hash] => :@data
+
+    def initialize(data, status_code, raw_response)
+      @data = data || {}
+      @status_code = status_code.to_i
+      @raw_response = raw_response
+    end
+  end
+end

data/lib/worldpay_cnp/version.rb

@@ -0,0 +1,3 @@
+module WorldpayCnp
+  VERSION = "0.1.0"
+end

data/lib/worldpay_cnp/xml.rb

@@ -0,0 +1,17 @@
+require "worldpay_cnp/xml/parser"
+require "worldpay_cnp/xml/serializer"
+require "worldpay_cnp/xml/nokogiri"
+
+module WorldpayCnp
+  module XML
+    class << self
+      def parse(xml)
+        Nokogiri::Parser.new.call(xml)
+      end
+
+      def serialize(hash)
+        Nokogiri::Serializer.new.call(hash)
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/xml/nokogiri.rb

@@ -0,0 +1,47 @@
+module WorldpayCnp
+  module XML
+    module Nokogiri
+      class Parser
+        include XML::Parser
+
+        def call(xml)
+          super(xml)
+        rescue ::Nokogiri::XML::SyntaxError => error
+          raise Error::XmlParseError, error.message, error.backtrace
+        end
+
+        private
+
+        def root(xml)
+          ::Nokogiri::XML(xml) { |c| c.options = ::Nokogiri::XML::ParseOptions::NOBLANKS }.root
+        end
+
+        def value_with!(element)
+          return element.text if element.attributes.empty? && element.elements.empty?
+          element.to_h.merge(hash_with(*element.elements))
+        end
+      end
+
+      class Serializer
+        include XML::Serializer
+
+        def call(hash)
+          ::Nokogiri::XML::Document.new.tap { |d| add_xml_elements!(d, hash) }.to_s
+        end
+
+        private
+
+        def attributes_or_elements!(parent, key, value)
+          return parent[attribute_name(key)] = text_with(value) if attribute?(key)
+          element = ::Nokogiri::XML::Element.new(key.to_s, parent)
+          parent.add_child(element)
+          add_xml_elements!(element, value)
+        end
+
+        def insert_text!(element, text)
+          element.add_child(text_with(text))
+        end
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/xml/parser.rb

@@ -0,0 +1,33 @@
+module WorldpayCnp
+  module XML
+    module Parser
+      def call(xml)
+        hash_with(root(xml))
+      end
+
+      private
+
+      def root(xml)
+        raise NotImplementedError
+      end
+
+      def value_with!(element)
+        raise NotImplementedError
+      end
+
+      def hash_with(*nodes)
+        nodes.each_with_object({}) do |node, hash|
+          inject_or_merge!(hash, node.name, value_with!(node))
+        end
+      end
+
+      def inject_or_merge!(hash, key, value)
+        if hash.key?(key)
+          cv = hash[key]
+          value = cv.is_a?(Array) ? cv.push(value) : [cv, value]
+        end
+        hash[key] = value
+      end
+    end
+  end
+end

data/lib/worldpay_cnp/xml/serializer.rb

@@ -0,0 +1,43 @@
+module WorldpayCnp
+  module XML
+    module Serializer
+      def call(hash)
+        raise NotImplementedError
+      end
+
+      private
+
+      def attributes_or_elements!(parent, key, value)
+        raise NotImplementedError
+      end
+
+      def insert_text!(element, text)
+        raise NotImplementedError
+      end
+
+      def add_xml_elements!(parent, obj)
+        case obj
+        when Hash
+          obj.each { |key, value| attributes_or_elements!(parent, key, value) }
+        when Array
+          obj.each { |value| add_xml_elements!(parent, value) }
+        else
+          insert_text!(parent, obj)
+        end
+        parent
+      end
+
+      def text_with(obj)
+        obj.to_s
+      end
+
+      def attribute?(key)
+        key.to_s.start_with?("@")
+      end
+
+      def attribute_name(key)
+        key.to_s.sub(/^@/, "")
+      end
+    end
+  end
+end

data/worldpay-cnp.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/worldpay_cnp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "worldpay_cnp"
+  spec.version       = WorldpayCnp::VERSION
+  spec.authors       = ["Javier Julio"]
+  spec.email         = ["javier@jackpocket.com"]
+
+  spec.summary       = "A modern Ruby interface to the Worldpay cnpAPI."
+  spec.description   = "A modern Ruby interface to the Worldpay cnpAPI."
+  spec.homepage      = "https://github.com/jackpocket/worldpay-cnp"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.add_dependency "http", '>= 4', '< 5'
+  spec.add_dependency "nokogiri", '~> 1.0'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/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"]
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: worldpay_cnp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Javier Julio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A modern Ruby interface to the Worldpay cnpAPI.
+email:
+- javier@jackpocket.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/worldpay_cnp.rb
+- lib/worldpay_cnp/api_client.rb
+- lib/worldpay_cnp/client.rb
+- lib/worldpay_cnp/configuration.rb
+- lib/worldpay_cnp/error.rb
+- lib/worldpay_cnp/refinements/camel_case.rb
+- lib/worldpay_cnp/refinements/deep_symbolize_keys.rb
+- lib/worldpay_cnp/refinements/snake_case.rb
+- lib/worldpay_cnp/response.rb
+- lib/worldpay_cnp/version.rb
+- lib/worldpay_cnp/xml.rb
+- lib/worldpay_cnp/xml/nokogiri.rb
+- lib/worldpay_cnp/xml/parser.rb
+- lib/worldpay_cnp/xml/serializer.rb
+- worldpay-cnp.gemspec
+homepage: https://github.com/jackpocket/worldpay-cnp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jackpocket/worldpay-cnp
+  source_code_uri: https://github.com/jackpocket/worldpay-cnp
+  changelog_uri: https://github.com/jackpocket/worldpay-cnp/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: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A modern Ruby interface to the Worldpay cnpAPI.
+test_files: []