investec_open_api 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf7fce941e61b6f4a9d707b7a3e5d4ef8c9dc3d8dc993a9a369e1beb0407c467
-  data.tar.gz: 1d7edbe5dc1ce2a0c1e2196bbb57e1e4e574be22948f746874c8ce41ac4a5e65
+  metadata.gz: 2dd0d8bf1f96bd2938b03a10a769c4a133756250d2241339d0c852f40e0af16b
+  data.tar.gz: 04fbd85515e99a1cf8f4bd016ad1d9f32eb69e1c5e49bb74a510d3e4db81183a
 SHA512:
-  metadata.gz: c3c84ef25841c7adc025a6651400ecb865e17893b2f082b37b1817a7dc973c864ffe25288839414272e164836f19cc9ffe173923ddc3be461121f5fb5124cae6
-  data.tar.gz: 39f1f281e4ce2a5ef718f131dc7c74b1c209e4c6f39273517fde84adaa8df256717c69451f6616333951ec7a9651b84d4b2a6f1205696d5cdc7d5f4bc50577d9
+  metadata.gz: 00a186874f8951b24da32ad631b354c72a3f8dba0a50b660d1307d258596b3aeb1e116e29a77775f20b5db6f861c6f4dcb55c4cb6dff8727b25ab72ac117f314
+  data.tar.gz: 859a6740f4d34260b0d026cb4d8ee3f647722cdcd714885fb0c60f90ebc6872b03a70dde2233f3e761586d5e811d9d6c2c172e6ce3e94658ee3add71dae522c2

data/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Run Specs
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.1
+
+      - name: Run bundle install
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+
+      - name: Build and test with rspec
+        env:
+          RAILS_ENV: test
+        run: bundle exec rspec spec

data/.ruby-version

@@ -1 +1 @@
-2.5.4
+3.2.0

data/.travis.yml

@@ -2,5 +2,5 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
-before_install: gem install bundler -v 2.1.4
+  - 3.2.0
+before_install: gem install bundler -v 2.4.12

data/Gemfile

@@ -1,12 +1,6 @@
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in investec_open_api.gemspec
-# gemspec
+gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "active_attr"
-gem "money"
-gem "faraday"
-gem "faraday_middleware"
-gem "webmock"
+gem 'pry'

data/Gemfile.lock

@@ -1,67 +1,104 @@
+PATH
+  remote: .
+  specs:
+    investec_open_api (1.1.1)
+      active_attr
+      faraday
+      faraday_middleware
+      money
+
 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)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
       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)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
       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)
+    active_attr (0.15.4)
+      actionpack (>= 3.0.2, < 7.1)
+      activemodel (>= 3.0.2, < 7.1)
+      activesupport (>= 3.0.2, < 7.1)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activesupport (7.0.4.3)
       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)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     builder (3.2.4)
-    concurrent-ruby (1.1.6)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
     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)
+    erubi (1.12.0)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
-    i18n (1.8.4)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.20.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    money (6.13.8)
+    method_source (1.0.0)
+    mini_portile2 (2.8.2)
+    minitest (5.18.0)
+    money (6.16.0)
       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)
+    multipart-post (2.3.0)
+    nokogiri (1.14.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
     rake (12.3.3)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -75,27 +112,23 @@ GEM
       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)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       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)
+  investec_open_api!
+  pry
+  rake
+  rspec
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.4.12

data/README.md

@@ -1,9 +1,8 @@
 # InvestecOpenApi Client
 
 [![Gem Version](https://badge.fury.io/rb/investec_open_api.svg)](https://badge.fury.io/rb/investec_open_api)
-[![Build Status](https://travis-ci.com/Offerzen/investec_open_api.svg?branch=master)](https://travis-ci.com/Offerzen/investec_open_api)
 
-A simple client wrapper for the [Investec Open API](https://developer.investec.com/programmable-banking/#open-api). 
+A simple client wrapper for the [Investec Open API](https://developer.investec.com/za/api-products).
 
 *Features:*
 
@@ -35,13 +34,21 @@ 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>"
+    config.api_key       = ENV['API_KEY']
+    config.client_id     = ENV['CLIENT_ID']
+    config.client_secret = ENV['CLIENT_SECRET']
 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).
+Create a new file in the root of your directory called `.env` and place the following:
+
+```
+API_KEY='YOUR API KEY'
+CLIENT_ID='YOUR CLIENT ID'
+CLIENT_SECRET='YOUR CLIENT SECRET'
+```
+
+You will need to register to get the following credentials. Follow the steps in [Enrolment in the documentation](https://developer.investec.com/programmable-banking/#enrolment).
 
 
 ## Usage

data/bin/console

@@ -7,8 +7,8 @@ require "investec_open_api"
 # 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 "pry"
+Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+# IRB.start(__FILE__)

data/investec_open_api.gemspec

@@ -3,12 +3,12 @@ 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.authors       = ["Community Core Team"]
+  spec.email         = ["community@make.dev"]
 
   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.homepage      = "https://github.com/programmable-banking-community/investec_open_api"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
@@ -26,4 +26,15 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  # add runtime dependencies
+  spec.add_runtime_dependency 'active_attr'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_runtime_dependency 'money'
+
+  # add development dependencies
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
 end

data/lib/investec_open_api/camel_case_refinement.rb

@@ -0,0 +1,12 @@
+module InvestecOpenApi
+  module CamelCaseRefinement
+    refine Hash do
+      def camelize
+        transform_keys do |key|
+          words = key.to_s.split('_')
+          words.drop(1).collect(&:capitalize).unshift(words.first).join
+        end
+      end
+    end
+  end
+end

data/lib/investec_open_api/client.rb

@@ -2,8 +2,12 @@ require "faraday"
 require "faraday_middleware"
 require "investec_open_api/models/account"
 require "investec_open_api/models/transaction"
+require "investec_open_api/camel_case_refinement"
 
 class InvestecOpenApi::Client
+  using InvestecOpenApi::CamelCaseRefinement
+  INVESTEC_API_URL="https://openapi.investec.com/"
+
   def authenticate!
     @token = get_oauth_token["access_token"]
   end
@@ -15,8 +19,15 @@ class InvestecOpenApi::Client
     end
   end
 
-  def transactions(account_id)
-    response = connection.get("za/pb/v1/accounts/#{account_id}/transactions")
+  def transactions(account_id, options = {})
+    endpoint_url = "za/pb/v1/accounts/#{account_id}/transactions"
+
+    unless options.empty?
+      query_string = URI.encode_www_form(options.camelize)
+      endpoint_url += "?#{query_string}"
+    end
+    
+    response = connection.get(endpoint_url)
     response.body["data"]["transactions"].map do |transaction_raw|
       InvestecOpenApi::Models::Transaction.from_api(transaction_raw)
     end
@@ -25,24 +36,22 @@ class InvestecOpenApi::Client
   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
+    auth_token = Base64.strict_encode64("#{InvestecOpenApi.client_id}:#{InvestecOpenApi.client_secret}")
 
-    response = auth_connection.post("identity/v2/oauth2/token", {
-      grant_type: "client_credentials",
-      scope: "accounts"
-    }.to_query)
+    response = Faraday.post(
+      "#{INVESTEC_API_URL}identity/v2/oauth2/token",
+      { grant_type: "client_credentials" },
+      {
+        'x-api-key' => InvestecOpenApi.api_key,
+        'Authorization' => "Basic #{auth_token}"
+      }
+    )
 
-    response.body
+    JSON.parse(response.body)
   end
 
   def connection
-    @_connection ||= Faraday.new(url: InvestecOpenApi.api_url) do |builder|
+    @_connection ||= Faraday.new(url: INVESTEC_API_URL) do |builder|
       if @token
         builder.headers["Authorization"] = "Bearer #{@token}"
       end

data/lib/investec_open_api/models/transaction.rb

@@ -3,6 +3,7 @@ require "money"
 module InvestecOpenApi::Models
   class Transaction < Base
     attribute :account_id
+    attribute :posted_order
     attribute :type
     attribute :status
     attribute :card_number
@@ -27,7 +28,10 @@ module InvestecOpenApi::Models
       if params['amount'].present?
         adjusted_amount = params['amount'] * 100
         adjusted_amount = -adjusted_amount if params['type'] == 'DEBIT'
-        params['amount'] = Money.new(adjusted_amount, "ZAR")
+
+        Money.rounding_mode = BigDecimal::ROUND_HALF_UP
+        Money.locale_backend = :i18n
+        params['amount'] = Money.from_cents(adjusted_amount, "ZAR")
       end
 
       if params['transactionDate']

data/lib/investec_open_api/version.rb

@@ -1,3 +1,3 @@
 module InvestecOpenApi
-  VERSION = "1.0.1"
+  VERSION = "1.1.1"
 end

data/lib/investec_open_api.rb

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

metadata

@@ -1,24 +1,121 @@
 --- !ruby/object:Gem::Specification
 name: investec_open_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
-- Markus Kuhn
-- Jethro Flanagan
+- Community Core Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
-dependencies: []
+date: 2023-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A small wrapper client for accessing Investec's Open API
 email:
-- mkk0856@gmail.com
-- jethroflanagan@gmail.com
+- community@make.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -33,19 +130,20 @@ files:
 - bin/setup
 - investec_open_api.gemspec
 - lib/investec_open_api.rb
+- lib/investec_open_api/camel_case_refinement.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
+homepage: https://github.com/programmable-banking-community/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
+  homepage_uri: https://github.com/programmable-banking-community/investec_open_api
+  source_code_uri: https://github.com/programmable-banking-community/investec_open_api
+  changelog_uri: https://github.com/programmable-banking-community/investec_open_api
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -61,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Investec Open API Wrapper