opayo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5d4cd10581167bbe065fbb03034f70a9dfbba1b424d1463773aee64c0e417e7
+  data.tar.gz: 983c4d16226c97e12082c09688153e40b7919d50499fc4ce1d0af21d488e23bc
+SHA512:
+  metadata.gz: 8dc7811ca0e707590624f4a9bf4b4e8168396f72942309946938d465b8cbfcfff9bf54219d06497f2a6358a9a75cb0ad975000676004fdbf2f72e0181fb42598
+  data.tar.gz: 5e7fd373a67dbe2ad4fe12163c6b4a7f48ec0dedcc16a153ecf0730f616ae2a7eb8815ce7517330a3065f8d22b756f232e5c04a07ca1628e99289e8b0359981d

data/.gem-release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/opayo/version.rb'
+  message: Bump opayo to %{version}
+  tag: true

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: peterberkenbosch

data/.github/workflows/changelog.yml

@@ -0,0 +1,37 @@
+name: Changelog
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 4
+    if: "!contains(github.event.head_commit.message, '[nodoc]')"
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: actions/cache@v1.1.2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gem-
+    - name: Create local changes
+      run: |
+        gem install github_changelog_generator
+        github_changelog_generator -u peterberkenbosch -p opayo --token ${{ secrets.CHANGELOG_GITHUB_TOKEN }} --exclude-labels duplicate,question,invalid,wontfix,nodoc
+    - name: Commit files
+      run: |
+        git config --local user.email "github-actions@example.com"
+        git config --local user.name "GitHub Actions"
+        git commit -m "[nodoc] update changelog" -a
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.CHANGELOG_GITHUB_TOKEN }}

data/.github/workflows/standardrb.yml

@@ -0,0 +1,33 @@
+name: StandardRB
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+
+jobs:
+  standard:
+    name: StandardRB Check Action
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Bundle install
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run StandardRB
+      run: bundle exec standardrb --format progress

data/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - '*'
+  push:
+    branches:
+      - master
+
+jobs:
+  ruby_test:
+    name: Ruby Test Action
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+    - name: Bundle install
+      run: |
+        gem install bundler
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - name: Run ruby tests
+      run: bundle exec rake

data/.gitignore

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

data/.rspec

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

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 info@peterberkenbosch.nl. 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,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in opayo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "webmock", "~> 3.8"
+gem "pry"
+gem "standard"
+gem "simplecov", require: false, group: :test
+
+gem "gem-release"

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    opayo (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    gem-release (2.1.1)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      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)
+    rubocop (0.89.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.19.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    standard (0.5.2)
+      rubocop (~> 0.89.1)
+      rubocop-performance (~> 1.7.1)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gem-release
+  opayo!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov
+  standard
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Peter Berkenbosch
+
+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,44 @@
+# Opayo
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/opayo`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opayo'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install opayo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/peterberkenbosch/opayo. 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/peterberkenbosch/opayo/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 Opayo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/peterberkenbosch/opayo/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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opayo"
+
+# 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/opayo.rb

@@ -0,0 +1,12 @@
+require "json"
+require "net/https"
+
+module Opayo
+end
+
+require "opayo/version"
+require "opayo/configuration"
+require "opayo/struct/base"
+require "opayo/client"
+require "opayo/response"
+require "opayo/error"

data/lib/opayo/client.rb

@@ -0,0 +1,81 @@
+module Opayo
+  class Client
+    def initialize
+      @version_strings = []
+      add_version_string "Opayo/" << VERSION
+      add_version_string "Ruby/" << RUBY_VERSION
+      add_version_string OpenSSL::OPENSSL_VERSION.split(" ").slice(0, 2).join "/"
+    end
+
+    def user_agent_string
+      @version_strings.join(" ")
+    end
+
+    # The MSK (merchant session key)
+    # 
+    # The Merchant Session Key expires after 400 seconds and can only be used to create
+    # one successful Card Identifier (tokenised card details). 
+    # It will also expire and be removed after 3 failed attempts to create a Card Identifier.
+    #
+    # @return <Response> the payload on a succesfull response will <Struct::MerchantSessionKey>
+    def merchant_session_key
+      http_call(:post, "merchant-session-keys", Opayo::Struct::MerchantSessionKey, nil, { "vendorName" => Opayo.config.vendor_name })
+    end
+    
+
+    # Executes a request, validates and returns the response.
+    #
+    # @param  [String] http_method The HTTP method (:get, :post)
+    # @param  [String] api_method The api method to call
+    # @param  [Class] payload_struct_class The payload struct class for successfull request
+    # @param  [String] id the optional id to be pasted in
+    # @param  [Hash] body an optional body to post to the endpoint
+    # @return [Hash]
+    # @raise  [RequestError]
+    # @raise  [NotFoundError]
+    # @raise  [AuthenticationFailed]
+    def http_call(http_method, api_method, payload_struct_class, id = nil, body = {})
+      version = "v1"
+
+      path = "/api/#{version}/#{api_method}/#{id}".chomp("/")
+      api_endpoint = Opayo.config.endpoint
+      uri = URI.parse(api_endpoint)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.set_debug_output($stdout) if ENV["DEBUG"]
+
+      case http_method
+      when :get
+        request = Net::HTTP::Get.new(path)
+      when :post
+        body.delete_if { |_k, v| v.nil? }
+        request = Net::HTTP::Post.new(path)
+        request.body = body.to_json
+      else
+        raise RequestError, "Invalid HTTP Method: #{http_method.to_s.upcase}"
+      end
+
+      request.basic_auth Opayo.config.integration_key, Opayo.config.integration_password
+
+      request["Accept"] = "application/json"
+      request["Content-Type"] = "application/json"
+      request["User-Agent"] = user_agent_string
+
+      begin
+        response = http.request(request)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+        Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        raise RequestError, e.message
+      end
+      
+      Response.new(response, payload_struct_class)
+    end
+
+    private
+
+    def add_version_string(version_string)
+      @version_strings << version_string.gsub(/\s+/, "-")
+    end
+  end
+end

data/lib/opayo/configuration.rb

@@ -0,0 +1,35 @@
+require "base64"
+
+module Opayo
+  class Configuration
+    attr_accessor :integration_key
+    attr_accessor :integration_password
+    attr_accessor :vendor_name
+    attr_accessor :environment
+
+    ENDPOINTS = {
+      test: "pi-test.sagepay.com",
+      live: "pi-live.sagepay.com"
+    }
+
+    def initialize
+      @environment = :test
+    end
+
+    def endpoint
+      "https://#{ENDPOINTS[environment]}"
+    end
+  end
+
+  class << self
+    def config
+      @configuration ||= Configuration.new
+    end
+
+    attr_writer :configuration
+
+    def configure
+      yield config
+    end
+  end
+end

data/lib/opayo/error.rb

@@ -0,0 +1,10 @@
+module Opayo
+  class Error < StandardError
+  end
+
+  class RequestError < Error
+    def initialize(http_response)
+      super(http_response)
+    end
+  end
+end

data/lib/opayo/response.rb

@@ -0,0 +1,28 @@
+module Opayo
+  class Response
+    attr_reader :success, :payload, :error, :http_code
+
+    def initialize(http_response, payload_struct_class)
+      http_code = http_response.code.to_i
+      @http_code = http_code
+      case http_code
+      when 200, 201
+        @success = true
+        @payload = build_payload(JSON.parse(http_response.body), payload_struct_class)
+      else
+        @success = false
+        @error = http_response
+      end
+    end
+
+    def success?
+      @success
+    end
+
+    private
+
+    def build_payload(json_body, payload_struct_class)
+      payload_struct_class.new(json_body)
+    end
+  end
+end

data/lib/opayo/struct/base.rb

@@ -0,0 +1,14 @@
+module Opayo
+  module Struct
+    class Base
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          m = "#{key}=".to_sym
+          send(m, value) if respond_to?(m)
+        end
+      end
+    end
+  end
+end
+
+require_relative "merchant_session_key"

data/lib/opayo/struct/merchant_session_key.rb

@@ -0,0 +1,8 @@
+module Opayo
+  module Struct
+    class MerchantSessionKey < Base
+      attr_accessor :expiry
+      attr_accessor :merchantSessionKey
+    end
+  end
+end

data/lib/opayo/version.rb

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

data/opayo.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/opayo/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "opayo"
+  spec.version = Opayo::VERSION
+  spec.authors = ["Peter Berkenbosch"]
+  spec.email = ["info@peterberkenbosch.nl"]
+
+  spec.summary = "ruby api client for Opayo"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/peterberkenbosch/opayo"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/peterberkenbosch/opayo"
+  spec.metadata["changelog_uri"] = "https://github.com/peterberkenbosch/opayo/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,71 @@
+--- !ruby/object:Gem::Specification
+name: opayo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Berkenbosch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-15 00:00:00.000000000 Z
+dependencies: []
+description: ruby api client for Opayo
+email:
+- info@peterberkenbosch.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gem-release.yml"
+- ".github/FUNDING.yml"
+- ".github/workflows/changelog.yml"
+- ".github/workflows/standardrb.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opayo.rb
+- lib/opayo/client.rb
+- lib/opayo/configuration.rb
+- lib/opayo/error.rb
+- lib/opayo/response.rb
+- lib/opayo/struct/base.rb
+- lib/opayo/struct/merchant_session_key.rb
+- lib/opayo/version.rb
+- opayo.gemspec
+homepage: https://github.com/peterberkenbosch/opayo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/peterberkenbosch/opayo
+  source_code_uri: https://github.com/peterberkenbosch/opayo
+  changelog_uri: https://github.com/peterberkenbosch/opayo/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: ruby api client for Opayo
+test_files: []