investec_open_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d69402eec4e9726ed5bfe503c817b6b179b53b5cd3658ae5d5906971482908da
+  data.tar.gz: f98b0b7abc269d4d915787061ae937ce6674a1d3a80bc94627490973e6a74c63
+SHA512:
+  metadata.gz: 9fa72caba53822a4ed58cceae465e629044ba5a6b5c0699e546695d1f4ff91694253f410ae81b55bb7e8ad4713cd02f4e1052164fc0991f3e0413a564c94a876
+  data.tar.gz: 90cdd9eab5eb502edd1f6995a95d91780aa7def38f47c7957bbe0d4b7c64a62bd6a3259238f10b03341bcb0041d86da01bc03ba2389385c37250e8122a42240c

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/.ruby-version

@@ -0,0 +1 @@
+2.5.4

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

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 mkk0856@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,12 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in investec_open_api.gemspec
+# gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "active_attr"
+gem "money"
+gem "faraday"
+gem "faraday_middleware"
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,101 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_attr (0.15.0)
+      actionpack (>= 3.0.2, < 6.1)
+      activemodel (>= 3.0.2, < 6.1)
+      activesupport (>= 3.0.2, < 6.1)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    i18n (1.8.4)
+      concurrent-ruby (~> 1.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    money (6.13.8)
+      i18n (>= 0.6.4, <= 2)
+    multipart-post (2.1.1)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.5)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    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.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)
+    safe_yaml (1.0.5)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_attr
+  faraday
+  faraday_middleware
+  money
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 OfferZen
+
+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,68 @@
+# InvestecOpenApi Client
+
+A simple client wrapper for the [Investec Open API](https://developer.investec.com/programmable-banking/#open-api). 
+
+*Features:*
+
+- Authorize access via OAuth
+- Retrieve accounts
+- Retrieve transactions per account
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'investec_open_api'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install investec_open_api
+```
+
+Create a new initializer called `investec_open_api.rb` in `config/initializers`:
+
+```ruby
+InvestecOpenApi.configuration do |config|
+    config.api_username = "https://openapi.investec.com/"
+    config.api_password = "<Open API username>"
+    config.api_url = "<Open API password>"
+end
+```
+
+You will need to register for Open API access. Follow the steps in [Enrolment in the documentation](https://developer.investec.com/programmable-banking/#enrolment).
+
+
+## Usage
+
+To use the wrapper, create an instance of `InvestecOpenApi::Client` and then authenticate with your credentials:
+
+```ruby
+client = InvestecOpenApi::Client.new
+client.authenticate!
+```
+
+Once authenticated you can retrieve your accounts:
+
+```ruby
+accounts = client.accounts
+my_account = accounts.first
+```
+
+Use the ID of one of your accounts to retrieve transactions:
+
+```ruby
+client.transactions(my_account.id)
+```
+
+## 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,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 "investec_open_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/investec_open_api.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/investec_open_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "investec_open_api"
+  spec.version       = InvestecOpenApi::VERSION
+  spec.authors       = ["Markus Kuhn", "Jethro Flanagan"]
+  spec.email         = ["mkk0856@gmail.com", "jethroflanagan@gmail.com"]
+
+  spec.summary       = %q{Investec Open API Wrapper}
+  spec.description   = %q{A small wrapper client for accessing Investec's Open API}
+  spec.homepage      = "https://github.com/offerzen/investec_open_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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

data/lib/investec_open_api.rb

@@ -0,0 +1,14 @@
+require "investec_open_api/version"
+require "investec_open_api/models/base"
+
+module InvestecOpenApi
+  class Error < StandardError; end
+
+  class << self
+    mattr_accessor :api_url, :api_username, :api_password, :scope
+  end
+
+  def self.configuration(&block)
+    yield self
+  end
+end

data/lib/investec_open_api/client.rb

@@ -0,0 +1,59 @@
+require "faraday"
+require "faraday_middleware"
+require "investec_open_api/models/account"
+require "investec_open_api/models/transaction"
+
+class InvestecOpenApi::Client
+  def authenticate!
+    @token = get_oauth_token["access_token"]
+  end
+
+  def accounts
+    response = connection.get("za/pb/v1/accounts")
+    response.body["data"]["accounts"].map do |account_raw|
+      InvestecOpenApi::Models::Account.from_api(account_raw)
+    end
+  end
+
+  def transactions(account_id)
+    response = connection.get("za/pb/v1/accounts/#{account_id}/transactions")
+    response.body["data"]["transactions"].map do |transaction_raw|
+      InvestecOpenApi::Models::Transaction.from_api(transaction_raw)
+    end
+  end
+
+  private
+
+  def get_oauth_token
+    auth_connection = Faraday.new(url: InvestecOpenApi.api_url) do |builder|
+      builder.headers["Accept"] = "application/json"
+      builder.basic_auth(InvestecOpenApi.api_username, InvestecOpenApi.api_password)
+      builder.response :raise_error
+      builder.response :json
+      builder.adapter Faraday.default_adapter
+    end
+
+    response = auth_connection.post("identity/v2/oauth2/token", {
+      grant_type: "client_credentials",
+      scope: "accounts"
+    }.to_query)
+
+    response.body
+  end
+
+  def connection
+    @_connection ||= Faraday.new(url: InvestecOpenApi.api_url) do |builder|
+      if @token
+        builder.headers["Authorization"] = "Bearer #{@token}"
+      end
+
+      builder.headers["Accept"] = "application/json"
+      builder.request :json
+
+      builder.response :raise_error
+      builder.response :json
+
+      builder.adapter Faraday.default_adapter
+    end
+  end
+end

data/lib/investec_open_api/models/account.rb

@@ -0,0 +1,25 @@
+module InvestecOpenApi::Models
+  class Account < Base
+    attribute :id
+    attribute :number
+    attribute :name
+    attribute :reference_name
+    attribute :product_name
+
+    def self.from_api(params = {})
+      if params['accountId'].present?
+        params['id'] = params['accountId']
+      end
+
+      if params['accountNumber'].present?
+        params['number'] = params['accountNumber']
+      end
+
+      if params['accountName'].present?
+        params['name'] = params['accountName']
+      end
+
+      super
+    end
+  end
+end

data/lib/investec_open_api/models/base.rb

@@ -0,0 +1,15 @@
+require "active_attr"
+
+module InvestecOpenApi::Models
+  class Base
+    include ActiveAttr::Model
+
+    def self.from_api(params = {})
+      underscored_params = params.deep_transform_keys do |key|
+        key.underscore.to_sym
+      end
+
+      new(underscored_params)
+    end
+  end
+end

data/lib/investec_open_api/models/transaction.rb

@@ -0,0 +1,35 @@
+require "money"
+
+module InvestecOpenApi::Models
+  class Transaction < Base
+    attribute :account_id
+    attribute :type
+    attribute :status
+    attribute :card_number
+    attribute :amount
+    attribute :description
+    attribute :posting_date, type: Date
+    attribute :value_date, type: Date
+    attribute :action_date, type: Date
+
+    # At this point, there is no unique identifier being returned from Investec's API.
+    # This method serves to create a stable unique identifier based on the transaction details.
+    def id
+      [
+        amount.to_i,
+        description,
+        posting_date.to_s
+      ].map(&:to_s).join('-')
+    end
+
+    def self.from_api(params)
+      if params['amount'].present?
+        adjusted_amount = params['amount'] * 100
+        adjusted_amount = -adjusted_amount if params['type'] == 'DEBIT'
+        params['amount'] = Money.new(adjusted_amount, "ZAR")
+      end
+
+      super
+    end
+  end
+end

data/lib/investec_open_api/version.rb

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: investec_open_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Markus Kuhn
+- Jethro Flanagan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-30 00:00:00.000000000 Z
+dependencies: []
+description: A small wrapper client for accessing Investec's Open API
+email:
+- mkk0856@gmail.com
+- jethroflanagan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- investec_open_api.gemspec
+- lib/investec_open_api.rb
+- lib/investec_open_api/client.rb
+- lib/investec_open_api/models/account.rb
+- lib/investec_open_api/models/base.rb
+- lib/investec_open_api/models/transaction.rb
+- lib/investec_open_api/version.rb
+homepage: https://github.com/offerzen/investec_open_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/offerzen/investec_open_api
+  source_code_uri: https://github.com/offerzen/investec_open_api
+  changelog_uri: https://github.com/offerzen/investec_open_api
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Investec Open API Wrapper
+test_files: []