partner_api 0.11.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cacf04c0842fae66017e82f8ac66c80c457516055b9e06f7e44c16303d32327
+  data.tar.gz: e9b46531becb170f52959334ca4c8f968a955efb9c34e7450354001adf77fee1
+SHA512:
+  metadata.gz: e9502db4c374e70a24a707c0b8c1a5301eb435928208b276fea6b3513e91004406655675c68037d35cb9779aa24a5740544fcbbb0ecdb3bfbc1221cf4fcaef85
+  data.tar.gz: 8213446b7663bf6113cb49007d6a293bc5f883bc8181e30060cd73d54ef8e88df92965b06a549b04598fdce0eb794ce4eb670354fd44a4d715dd0a37fd52b845

data/.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Release gem
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build and publish gem
+      uses: jstastny/publish-gem-to-github@master
+      with:
+        token: ${{ secrets.WORKFLOW_TOKEN }}
+        owner: kaligo

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: RSpec
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "2.6"
+          - "2.7"
+
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        id: ruby
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: run rspec
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+.idea

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--warnings

data/CHANGELOG.md

@@ -0,0 +1,105 @@
+# Change Log
+
+## 0.11.2
+
+- Support HTTP persistent for BNZ client
+
+## 0.11.1
+
+- Emit metrics on Endpoint calls.
+
+## 0.11.0
+
+- Allow to configure BnzApi configuration on the fly
+
+## 0.10.0
+
+- Allow to have multiple FabApi configuration instances
+
+## 0.9.3
+
+- Rescue OpenSSL::SSL::SSLError and re-raised as ConnectionError
+
+## 0.9.2
+
+- Allow working with dry-configuration 1.x
+
+## 0.9.1
+
+- Add view transfers endpoint to Gemini API
+
+## 0.9.0
+
+- Update Westpac API to support `issuer` based configuration
+
+## 0.8.2
+
+- Fix response for Gemini get balances endpoint
+
+## 0.8.1
+
+- Add get balances endpoint to Gemini API
+
+## 0.8.0
+
+- Add Gemini API
+
+## 0.7.4
+
+- Expose response's headers
+
+## 0.7.1 Update BNZ API
+
+- Add MTLS for id token endpoint
+- Add JWKS endpoint
+- Remove user info endpoint
+
+## 0.7 Add BNZ API
+
+- Fetch id token endpoint
+- Fetch user info
+
+## 0.6
+
+- Use `default` keyword of new dry-configurable
+- Require dry-configurable 0.13
+
+## 0.5
+
+- Update Content-Type for FAB
+- Require http-rb 5.x
+
+## 0.4.2
+
+- Add log for request_id/transaction_id/correlation_id
+
+## 0.4.1 Add Westpac User Info endpoint
+
+## 0.4.0 Add Westpac JWK endpoint
+
+## 0.3.4 Support multiple connections for VMA
+
+## 0.3.3 Bug fixes:
+
+- Fix request body sent during VMA client credentials call
+- Separate URLs and credential configs for client credential and SSO endpoints
+
+## 0.3.2 Add VMA client credentails call
+
+## 0.3.1 Add VMA token invalidation endpoint
+
+## 0.3.0 Add VMA API client
+
+## 0.2.1 Bug fixes
+
+- Temporary fix to handle FAB invalid MIME type
+
+## 0.2.0 Switch gem name to `partner_api`
+
+## 0.1.1 Bug fixes:
+
+- Fix setting proxy & ssl options
+
+## 0.1.0 Initial functionality
+
+- Most of FAB endpoints

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fab_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "webmock"
+gem 'byebug'
+gem 'timecop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hieu Nguyen
+
+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,85 @@
+# PartnerAPI
+
+An API client to connect to API provided by all Ascenda Partners:
+
+- First Abu Dhabi Bank
+- Virgin Money Australia
+- Westpac
+- Bank of New Zealand
+- Gemini
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'partner_api', ascenda_private: 'kaligo/partner_api', tag: 'v0.9.3'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+- [FabApi Usage](docs/fab_api.md)
+- [VmaApi Usage](docs/vma_api.md)
+- [WestpacApi Usage](docs/westpac_api.md)
+- [BnzApi Usage](docs/bnz_api.md)
+- [Gemini Usage](docs/gemini_api.md)
+- [Anz Usage](docs/anz_api.md)
+
+
+## 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).
+
+### Add new endpoint
+
+- Add endpoint into `FabApi::Client`:
+
+```ruby
+module FabApi
+  class Client
+    endpoint :new_endpoint
+  end
+end
+```
+
+- Create new endpoint class. By convention, the class is put in
+`lib/fab_api/endpoints` folder, and is inside module `FabApi::Endpoints`.
+After creating the class, overwrite necessary methods to make the class work.
+With the above example, the class should be:
+
+```ruby
+module FabApi
+  module Endpoints
+    class NewEndpoint < Endpoint
+      prepend Initializer
+
+      def initialize(...)
+        # initializing thing
+      end
+
+      private
+
+      def method
+        # HTTP method
+      end
+
+      # ...
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaligo/fab_api.
+
+
+## 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,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bnz_api"
+require "fab_api"
+require "vma_api"
+require "westpac_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/docs/anz_api.md

@@ -0,0 +1,67 @@
+# AnzApi Usage
+
+- [AnzApi Usage](#anzapi-usage)
+  - [Configuration](#configuration)
+  - [Handle errors](#handle-errors)
+  - [Endpoints](#endpoints)
+    - [Fetch JWK](#fetch-jwk)
+
+## Configuration
+
+```ruby
+AnzApi.configure do |config|
+  config.logger = Logger.new # default: log to STDOUT, level info
+  config.jwks_url = 'https://unauthib.anz.com/jwks'
+end
+```
+
+---
+
+## Handle errors
+
+The client is consistent in error handling, this works accross all method calls:
+
+- When there are connection errors, it raises `PartnerApi::Errors::ConnectionError`
+
+- When ANZ responds with something other than 2xx status code, the response
+contains an error array with a `PartnerApi::Errors::RequestError`
+
+Below is an example of error handling:
+
+```ruby
+begin
+  response = AnzApi::Client.new.fetch_jwk
+
+  if response.success?
+    # handle success response
+  else
+    # handle general failure
+    raise response.failure.error
+
+    # or handle original response body
+    # puts response.failure.body
+  end
+rescue PartnerApi::Errors::ConnectionError => e
+  # handle correction error
+  log(e)
+  raise e
+end
+```
+
+---
+
+## Endpoints
+
+### Fetch JWK
+
+```ruby
+response = AnzApi::Client.new.fetch_jwk
+
+if response.success?
+  # handle response
+  puts response.value!
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```

data/docs/bnz_api.md

@@ -0,0 +1,103 @@
+# BnzApi Usage
+
+- [BnzApi Usage](#bnzapi-usage)
+  - [Configuration](#configuration)
+  - [Handle errors](#handle-errors)
+  - [Endpoints](#endpoints)
+    - [Fetch Id Token](#fetch-id-token)
+    - [Fetch JWK](#fetch-jwk)
+
+## Configuration
+
+```ruby
+BnzApi.configure do |config|
+  config.logger = Logger.new # default: log to STDOUT, level info
+
+  config.token_url = 'https://ma.secure.bnz.co.nz/pingfederate/as/token.oauth2'
+  config.jwks_url = 'https://secure.bnz.co.nz/pingfederate/pf/JWKS'
+
+  # MTLS
+  config.token_exchange.public_key = 'public_key'
+  config.token_exchange.private_key = private_key'
+end
+```
+We can also configure on-the-fly using `Configuration` class:
+
+```ruby
+config = BnzApi::Configuration.new.configure do |c|
+  c.token_exchange.public_key = 'new_cert'
+  c.token_exchange.private_key = 'new_key'
+end
+
+client = FabApi::Client.new(config: config)
+```
+
+---
+
+## Handle errors
+
+The client is consistent in error handling, this works accross all method calls:
+
+- When there are connection errors, it raises `PartnerApi::Errors::ConnectionError`
+
+- When BNZ responds with something other than 2xx status code, the response
+contains an error array with a `PartnerApi::Errors::RequestError`
+
+Below is an example of error handling:
+
+```ruby
+begin
+  response = BnzApi::Client.new.fetch_id_token(**params)
+
+  if response.success?
+    # handle success response
+  else
+    # handle general failure
+    raise response.failure.error
+
+    # or handle original response body
+    # puts response.failure.body
+  end
+rescue PartnerApi::Errors::ConnectionError => e
+  # handle correction error
+  log(e)
+  raise e
+end
+```
+
+---
+
+## Endpoints
+
+### Fetch Id Token
+
+```ruby
+response = BnzApi::Client.new.fetch_id_token(
+  auth_code: auth_code,
+  redirect_uri: redirect_uri,
+  client_id: client_id,
+  request_id: request_id
+)
+
+if response.success?
+  # handle response
+  puts response.value!
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### Fetch JWK
+
+```ruby
+response = BnzApi::Client.new.fetch_jwk
+
+if response.success?
+  # handle response
+  puts response.value!
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```