partner_api 0.11.2

data/docs/fab_api.md

@@ -0,0 +1,206 @@
+# FabApi Usage
+
+* [Configuration](#configuration)
+* [Handle errors](#handle-errors)
+* Endpoints
+  * [Deliver Email](#deliver-email)
+  * [Deliver SMS](#deliver-sms)
+  * [Exchange access token for OAuth token](#exchange-access-token-for-oauth-token)
+  * [Fetch new OAuth token using refresh token](#fetch-new-oauth-token-using-refresh-token)
+
+
+## Configuration
+
+```ruby
+FabApi.configure do |config|
+  config.logger = Logger.new # default: log to STDOUT, level info
+
+  config.base_url = 'http://fab.com'
+
+  # if both proxy config is empty, it does not use proxy
+  config.proxy_address = '123.12.11.10'
+  config.proxy_port = 8280
+
+  config.public_key = 'somecert' # SSL cert for mutual SSL
+  config.private_key = 'somekey' # SSL private key for mutual SSL
+
+  # by default, it sets
+  # transactionDateTime: Time.now.strftime('%F %H:%M:%S%z')
+  # senderId: "ASC"
+  # countryOfOrigin: "AE"
+  config.default_parameters = -> {
+    {
+      "applicationArea": {
+        "transactionDateTime": Time.current.iso_8601
+      }
+    }
+  }
+
+  # by default, it sets content-type as json
+  config.default_headers = -> {
+    {
+      'Request-ID' => Current.request_id
+    }
+  }
+end
+```
+
+We can also configure on-the-fly using `Configuration` class:
+
+```ruby
+config = FabApi::Configuration.new.configure do |c|
+  c.public_key = 'new_cert'
+  c.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 FAB response with something other than 2xx status code, the response
+contains an error array with a `PartnerApi::Errors::RequestError`
+
+- When FAB response with 2xx status code and result is failure, the response
+contains an error array with all errors mapped to `PartnerApi::Errors::RequestError`
+
+Below is an example of error handling:
+
+```ruby
+begin
+  response = FabApi::Client.new.deliver_email(
+    partner_user_id: '8000000',
+    notification_id: SecureRandom.uuid,
+    subject: 'some subject',
+    message: 'this is an email'
+  )
+
+  if response.success?
+    # handle success response
+  else
+    if response.failure.status.success?
+
+      # handle errors based on error code
+      response.failure.errors.map do |error|
+        puts error.code
+        puts error.message
+      end
+    else
+
+      # handle general failure
+      raise response.failure.error
+      # or
+      # puts response.failure.errors.first.body
+      #
+      # or handle original response body
+      # puts response.failure.body
+    end
+  end
+rescue PartnerApi::Errors::ConnectionError => e
+  # handle correction error
+  log(e)
+  raise e
+end
+```
+
+---
+
+## Endpoints
+
+### Deliver Email
+
+```ruby
+response = FabApi::Client.new.deliver_email(
+  partner_user_id: '8000000',
+  notification_id: SecureRandom.uuid,
+  subject: 'some subject',
+  message: 'this is an email'
+)
+
+if response.success?
+  # do something
+else
+  # handle error
+end
+```
+
+### Deliver SMS
+
+```ruby
+response = FabApi::Client.new.deliver_sms(
+  partner_user_id: '8000000',
+  notification_id: SecureRandom.uuid,
+  message: 'this is an sms'
+)
+
+if response.success?
+  # do something
+else
+  # handle error
+end
+```
+
+### Exchange access token for OAuth token
+
+```ruby
+response = FabApi::Client.new.exchange_token(
+  access_token: 'ABC12345',
+  transaction_id: SecureRandom.uuid,
+  system: 'RIB'
+)
+
+if response.success?
+  puts response.value! # token
+else
+  # handle error
+end
+```
+
+### Fetch new OAuth token using refresh token
+
+- About `new_token_flag`:
+  - If the value is `true`, FAB creates a new OAuth token with full expiration
+  time
+  - If the value is `false`, FAB fetches a cache token (if there are any) so the
+  token can have lower expiration time
+
+```ruby
+response = FabApi::Client.new.refresh_token(
+  access_token: 'ABC12345',
+  refresh_token: 'XYZ98765',
+  transaction_id: SecureRandom.uuid,
+  system: 'RIB',
+  new_token_flag: true
+)
+
+if response.success?
+  puts response.value! # token
+else
+  # handle error
+end
+```
+
+
+
+### Invalidate access token and related OAuth token
+
+```ruby
+response = FabApi::Client.new.invalidate_token(
+  partner_user_id: '8000000',
+  access_token: 'ABC12345',
+  transaction_id: SecureRandom.uuid,
+  system: 'RIB',
+)
+
+if response.success?
+  # handle success
+else
+  # handle error
+end
+```

data/docs/gemini_api.md

@@ -0,0 +1,184 @@
+# GeminiApi Usage
+
+- [GeminiApi Usage](#geminiapi-usage)
+  - [Configuration](#configuration)
+  - [Handle errors](#handle-errors)
+  - [Endpoints](#endpoints)
+    - [Create Address Request](#create-address-request)
+    - [View Approved Addresses](#view-approved-addresses)
+    - [Withdraw Crypto Fund](#withdraw-crypto-fund)
+    - [Get available balances](#get-available-balances)
+    - [View Transfers](#view-transfers)
+
+## Configuration
+
+```ruby
+GeminiApi.configure do |config|
+  config.logger = Logger.new # default: log to STDOUT, level info
+
+  config.base_url = 'https://api.gemini.com'
+  config.api_key = 'some_api_key'
+  config.api_secret = 'some_api_secret'
+
+  config.default_headers = -> lambda do
+    { 'x-request-id' => Oculus::Core.context[:request_id] }
+  end
+  config.default_parameters = -> { {} }
+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 Gemini 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 = GeminiApi::Client.new.view_approved_addresses(**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
+
+### Create Address Request
+
+Gemini docs:  https://docs.gemini.com/rest-api/#create-an-address-request
+
+```ruby
+response = GeminiApi::Client.new.create_address_request(
+  network: 'gusd',
+  address: '0xDe68f2E91f3AbCca99c35c2330b8A0a32de81150',
+  label: 'test_account',
+  account: 'primary' # optional
+)
+
+if response.success?
+  # handle successful case
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### View approved addresses
+
+Gemini docs: https://docs.gemini.com/rest-api/#view-approved-addresses
+
+```ruby
+response = GeminiApi::Client.new.view_approved_addresses(
+  network: 'gusd',
+  account: 'primary'
+)
+
+if response.success?
+  addresses = response.value!
+
+  addresses.each do |address|
+    puts address.network # => 'etherium'
+    puts address.status  # => 'pending-time'
+    puts address.address # => '0x.....12345'
+  end
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### Withdraw crypto fund
+
+Gemini docs:
+- Withdraw GUSD: https://docs.gemini.com/rest-api/#withdraw-usd-as-gusd
+- Withdraw other currency: https://docs.gemini.com/rest-api/#withdraw-crypto-funds
+
+```ruby
+response = GeminiApi::Client.new.withdraw_crypto_fund(
+  network: 'gusd',
+  amount: 0.1,
+  account: 'primary',
+  address: '0x....1234'
+)
+
+if response.success?
+  transaction = response.value!
+
+  puts transaction.id      # => '62903dc2-ba64-48e9-9121-c648fa59353b'
+  puts transaction.amount  # => 0.1
+  puts transaction.address # => '0x....1234'
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### Get available balances
+
+Gemini docs: https://docs.gemini.com/rest-api/#get-available-balances
+
+```ruby
+response = GeminiApi::Client.new.get_available_balances(account: 'primary')
+
+if response.success?
+  balances = response.value!
+
+  balances.each do |balance|
+    puts balance.currency # => 'USD'
+    puts balance.amount  # => 10000.0
+    puts balance.available_for_withdrawal # => 8000.0
+  end
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### View transfers
+
+Gemini docs: https://docs.gemini.com/rest-api/#transfers
+
+```ruby
+response = GeminiApi::Client.new.view_transfers(
+  currency: 'gusd',
+  timestamp: 1669626639000,
+  limit_transfers: 50,
+  account: 'primary',
+  show_completed_deposit_advances: false
+)
+
+if response.success?
+  transfers = response.value!
+
+  transfers.each do |transfer|
+    puts balance.type # => 'Withdrawal'
+    puts balance.status  # => 'Completed'
+    puts balance.amount # => '10.0'
+    # ... and more
+  end
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```

data/docs/vma_api.md

@@ -0,0 +1,167 @@
+# VmaApi Usage
+
+* [Configuration](#configuration)
+* [Handle errors](#handle-errors)
+* Endpoints
+  * [Exchange short token with access token](#exchange-short-token-with-access-token)
+  * [Refresh access token with refresh-token](#refresh-access-token-with-refresh-token)
+  * [Get client credentials auth token](#get-client-credentials-auth-token)
+
+## Configuration
+
+```ruby
+VmaApi.configure do |config|
+  config.logger = Logger.new # default: log to STDOUT, level info
+
+  # Use this for accessing CIAM access token endpoints, etc.
+  config.auth_base_url = 'http://auth.vma.au'
+  config.auth_client_id = 'vma-issued-auth-client-id'
+  config.auth_client_secret = 'vma-issued-auth-client-secret'
+
+  config.base_url = 'http://www.vma.au'
+  # Configure credentials for making calls to VMA API
+  config.client_id = 'vma-issued-client-id'
+  config.client_secret = 'vma-issued-client-secret'
+
+  # Needed for headers construction during token exchange and token refresh
+  config.subscription_key = 'subscription-key'
+  config.system_id = 'Guardhouse'
+
+  # by default, it sets all request params to include client_id and client_secret
+  config.default_parameters = -> {
+    {
+      "client_id": config.client_id,
+      "client_secret": config.client_secret
+    }
+  }
+
+  # by default, it sets content-type as json
+  config.default_headers = -> {
+    { 'Content-Type' => 'application/json' }
+  }
+end
+```
+
+We can also configure on-the-fly using `Configuration` class:
+
+```ruby
+config = VmaApi::Configuration.new.configure do |c|
+  c.client_id = 'vma-issued-client-id'
+  c.client_secret = 'vma-issued-client-secret'
+end
+
+client = VmaApi::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 VMA 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 = VmaApi::Client.new.access_token(short_token: 'token')
+
+  if response.success?
+    # handle success response
+  else
+    if response.failure.status.success?
+
+      # handle errors based on error code
+      response.failure.errors.map do |error|
+        puts error.code
+        puts error.message
+      end
+    else
+
+      # handle general failure
+      raise response.failure.error
+      # or
+      # puts response.failure.errors.first.body
+      #
+      # or handle original response body
+      # puts response.failure.body
+    end
+  end
+rescue PartnerApi::Errors::ConnectionError => e
+  # handle correction error
+  log(e)
+  raise e
+end
+```
+
+---
+
+## Endpoints
+
+### Exchange short token with access token
+
+Make sure you set the settings `auth_base_url`, `auth_client_id` and `auth_client_secret`.
+
+```ruby
+response = VmaApi::Client.new.access_token(short_token: 'your-short-token')
+
+if response.success?
+  # decrypt the token using the JWE secret
+  decrypt(response.value!)
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### Refresh access token with refresh token
+
+Make sure you set the settings `auth_base_url`, `auth_client_id` and `auth_client_secret`.
+
+```ruby
+response = VmaApi::Client.new.refresh_token(refresh_token: 'your-refresh-token')
+
+if response.success?
+  # decrypt the token using the JWE secret
+  decrypt(response.value!)
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### Get client credentials auth token
+
+Make sure you set the settings `base_url`, `client_id` and `client_secret`.
+
+```ruby
+response = VmaApi::Client.new.client_credentials(
+  tenant_id: '8888-8888-8888-88',
+  resource: 'CIAM://resource-id'
+)
+
+if response.success?
+  puts response.value! # token
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### Invalidate access token and related OAuth token
+
+Make sure you set the settings `auth_base_url`, `auth_client_id` and `auth_client_secret`.
+
+```ruby
+response = VmaApi::Client.new.revoke_token(token: 'token')
+
+if response.success?
+  # handle success
+else
+  # handle error
+end
+```

data/docs/westpac_api.md

@@ -0,0 +1,106 @@
+# WestpacApi Usage
+
+* [Configuration](#configuration)
+* [Handle errors](#handle-errors)
+* Endpoints
+  * [Fetch JWKS](#fetch-jwks)
+  * [Fetch User Info](#fetch-user-info)
+
+## Configuration
+
+```ruby
+WestpacApi.configure do |config|
+  config.logger = Logger.new # default: log to STDOUT, level info
+
+  # URL for fetching JWK
+  config.jwk_url = 'http://www.westpac.au/jwks'
+
+  # URL for fetching user info
+  config.context_api.url = 'https://gw-partner.sit1.api.westpac.com.au/ptr/partner/vendor/westpac/ctxthndvrascenda/v1/ascendaContext'
+
+  # Those values are in 1Password Westpac context API basic auth
+  config.context_api.username = 'username'
+  config.context_api.password = 'password'
+
+  # Proxy is optional. Only needed if when setting up local environment.
+  config.context_api.proxy_address = 'proxy.int.kaligo.com'
+  config.context_api.proxy_port = '3128'
+
+  config.context_api.public_key = 'somecert'
+  config.context_api.private_key = 'somekey'
+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 VMA 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 = WestpacApi::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 JWKS
+
+Make sure you set the settings `jwk_url`
+
+```ruby
+response = WestpacApi::Client.new.fetch_jwk
+
+if response.success?
+  # handle response
+  puts response.value!
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```
+
+### Fetch User Info
+
+Westpac context endpoint requires basic authentication, with proxy and ssl certificates enable.
+
+Make sure you set the settings `context_url`, `username`, `password`, `proxy_address`, `proxy_port`, `public_key`, `private_key`
+
+```ruby
+response = WestpacApi::Client.new.fetch_user(
+  user_id: sub,
+  context_reference_id: ctxrefid
+)
+
+if response.success?
+  # handle response
+  puts response.value!
+else
+  # get the error from the failure object
+  puts response.failure
+end
+```

data/lib/anz_api/client.rb

@@ -0,0 +1,24 @@
+require 'anz_api/endpoints/fetch_jwk'
+
+module AnzApi
+  class Client
+    def self.endpoint(name)
+      define_method(name) do |**args|
+        klass_name = Hanami::Utils::String.classify(name)
+        endpoint_klass = Hanami::Utils::Class.load!("AnzApi::Endpoints::#{klass_name}")
+
+        endpoint_klass.(config, **args)
+      end
+    end
+
+    endpoint :fetch_jwk
+
+    def initialize(config: AnzApi.config)
+      @config = config
+    end
+
+    private
+
+    attr_reader :config
+  end
+end

data/lib/anz_api/endpoint.rb

@@ -0,0 +1,29 @@
+require 'partner_api/endpoints/base'
+require 'anz_api/failure_response'
+
+module AnzApi
+  class Endpoint < PartnerApi::Endpoints::Base
+
+    private
+
+    def connection_options
+      {}
+    end
+
+    def decode(response)
+      response.parse
+    end
+
+    def successful?(response)
+      response.status.success?
+    end
+
+    def decode_error(response)
+      FailureResponse.new(response)
+    end
+
+    def logging_params
+      { request_id: request_id }
+    end
+  end
+end