nedbank_api 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 232191d832adf52be4ec8b3819395c3624a33d57
+  data.tar.gz: 1963075ba078b1d5327ad81991767daac2a472cd
+SHA512:
+  metadata.gz: 0d1264a544ff92c7d3557428b15084a43f6b5441ebcbaf7452ee1afa66786c615cfa7975ff5ca8aea62e63c78a21b0c83f2b3af2e2bdd214f928c1cb4f0648fa
+  data.tar.gz: 678d7a4f9d708e93cc57300c86b06675e7e3a12f5f723d9c77798467b148c139e8653d9fcead30a6f8ba0d76e05943e78b1d606e43db0360e90bf53a4daeb4e9

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.4.4

data/.travis.yml

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

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 jonobth@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nedbank_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    nedbank_api (0.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    factory_bot (5.0.2)
+      activesupport (>= 4.2.0)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.0)
+    httplog (1.3.2)
+      rack (>= 1.0)
+      rainbow (>= 2.0.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    public_suffix (4.0.1)
+    rack (2.0.7)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-nc (0.3.0)
+      rspec (>= 3)
+      terminal-notifier (>= 1.4)
+    rspec-support (3.8.2)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.5)
+    shellany (0.0.1)
+    slop (3.6.0)
+    terminal-notifier (2.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    webmock (3.7.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  factory_bot (~> 5.0)
+  guard (~> 2.15)
+  guard-rspec (~> 4.7)
+  httplog (~> 1.3)
+  nedbank_api!
+  pry (~> 0.12)
+  pry-nav (~> 0.3)
+  pry-remote (~> 0.1)
+  rake (~> 12.3)
+  rspec (~> 3.8)
+  rspec-nc (~> 0.3)
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jono Booth
+
+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,46 @@
+# NedbankApi
+
+The purpose of this gem is to streamline development of a Ruby application when using the [Nedbank Marketplace API](https://apim.nedbank.co.za/static/docs).
+
+This gem currently only uses the Authoristaions API and Payments API. If you are in need of other parts of the API then please feel free to contribute or submit a feature request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nedbank_api', github: 'jono-booth/nedbank_api'
+```
+
+And then execute:
+
+    $ bundle
+
+## Documentation
+
+**[1. Quickstart Guide](https://github.com/jono-booth/nedbank_api/wiki)**
+
+**[2. Getting Started Properly](https://github.com/jono-booth/nedbank_api/wiki/Getting-Started)**
+
+**[3. Authorisations API](https://github.com/jono-booth/nedbank_api/wiki/Authorisations-API)**
+
+**[4. Payments API](https://github.com/jono-booth/nedbank_api/wiki/Payments-API)**
+
+
+## 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/jono-booth/nedbank_api. 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).
+
+## Code of Conduct
+
+Everyone interacting in the NedbankApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jono-booth/nedbank_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nedbank_api"
+
+# 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/nedbank_api.rb

@@ -0,0 +1,39 @@
+require 'nedbank_api/api_wrapper'
+require 'nedbank_api/authentications_api'
+require 'nedbank_api/exceptions'
+require 'nedbank_api/payments_api'
+require 'nedbank_api/version'
+require 'nedbank_api/models/base_model'
+require 'nedbank_api/models/intent_token'
+require 'nedbank_api/models/payment'
+require 'nedbank_api/models/payment_submission'
+require 'nedbank_api/services/client'
+require 'nedbank_api/services/configuration'
+require 'nedbank_api/services/http'
+
+require 'uri'
+require 'openssl'
+require 'net/http'
+require 'uri'
+require 'securerandom'
+
+module NedbankApi
+  @intent_token = Models::IntentToken.new(Object.new)
+
+  class << self
+    attr_accessor :intent_token,
+      :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/nedbank_api/api_wrapper.rb

@@ -0,0 +1,29 @@
+module NedbankApi
+  class ApiWrapper
+    class << self
+      def idempotency_key
+        rand.to_s[2..24]
+      end
+
+      def auth_headers(overrides={})
+        {
+          "Content-Type" => "application/json",
+          "accept" => 'application/json',
+          "x-fapi-financial-id" => "OB/2017/001",
+          "x-idempotency-key" => idempotency_key,
+          "Authorization" => "Bearer #{NedbankApi.intent_token.access_token}",
+          "x-ibm-client-id" => NedbankApi.configuration.client_id,
+          "x-ibm-client-secret" => NedbankApi.configuration.client_secret
+        }.merge(overrides)
+      end
+
+      def endpoint(path)
+        NedbankApi.configuration.api_endpoint + path
+      end
+
+      def json_to_object(json)
+        JSON.parse(json, object_class: OpenStruct)
+      end
+    end
+  end
+end

data/lib/nedbank_api/authentications_api.rb

@@ -0,0 +1,57 @@
+module NedbankApi
+  class AuthenticationsApi < ApiWrapper
+    class << self
+      def request_token_light
+        http = Http.new(url: endpoint('/nboauth/oauth20/token'))
+
+        response = http.post(
+          body: URI.encode_www_form({
+            client_id: NedbankApi.configuration.client_id,
+            client_secret: NedbankApi.configuration.client_secret,
+            grant_type: 'client_credentials',
+            scope: 'tpp_client_credential'
+          })
+        )
+
+        intent_token = Models::IntentToken.new(JSON.parse(response.body, object_class: OpenStruct))
+
+        NedbankApi.intent_token = intent_token
+
+        return intent_token
+      end
+
+      def request_token_heavy(request_body: {})
+        http = Http.new(url: endpoint('/nboauth/oauth20/token'))
+
+        response = http.post(
+          body: URI.encode_www_form({
+            client_id: NedbankApi.configuration.client_id,
+            client_secret: NedbankApi.configuration.client_secret,
+            redirect_uri: NedbankApi.configuration.oauth_redirect_url,
+            grant_type: 'authorization_code',
+          }.merge(request_body))
+        )
+
+        intent_token = Models::IntentToken.new(JSON.parse(response.body, object_class: OpenStruct))
+
+        NedbankApi.intent_token = intent_token
+
+        return intent_token
+      end
+
+      def authorisation_url(request_body: {})
+        url = endpoint('/nboauth/oauth20/authorize')
+
+        body = URI.encode_www_form({
+            client_id: NedbankApi.configuration.client_id,
+            redirect_uri: NedbankApi.configuration.oauth_redirect_url,
+            response_type: 'code',
+            scope: 'payments',
+            itype: 'payments'
+        }.merge(request_body))
+
+        return "#{url}?#{body}"
+      end
+    end
+  end
+end