bml_connect 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91517f1cbbf91c13d81d93227136d7a53c5ed19d1668f035675c364c4c67f96f
-  data.tar.gz: 460a93c1c771a53f56fd7fdbbfa6183031e2862b82cf75e08b273f0ccfe52aee
+  metadata.gz: 748683ae421417ab2febc03a08cc8925e6c0a3a7f58834fae3bff1be14dd5c0c
+  data.tar.gz: 4a0df16c2ba85dbd52943790e5af9280a001db5840482caf185a6060aa2faf41
 SHA512:
-  metadata.gz: ef33690f58f716fc30f275ad3e0a3e0ddef3279eb13973a5f2c4fbe2273f6caac4b7fac56136fd320eed7ba497dcbd50349d2f0a64e40780a6ad1f7f23011d8b
-  data.tar.gz: 8e5914d7c89ea92d8ed589d3b0cf8c3225fc2edacd68f152dbc763f42b3653f8f847a3aac4a212c7535b37843b4536e65f7ee00abe653fb05aec42e58a50ba76
+  metadata.gz: 2968f568d24d3c13f3d3ecf125fcd209f076b84a60601ae0d086f57f47977454819cb4c4cd8958e8ec93d812c094bbf57a4381868d52a76a7aac4c11deeb1819
+  data.tar.gz: 7e4db64d6656e92cae2a79fbc26b70c5476122d30fa6101b15a5e3da0405bc78d8437d720d3c4fd4d3a2e9fde21b6b344ae34be0cff0437196e2a854cf2b0d39

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-08-31
+## [0.1.0] - 2021-09-16
 
 - Initial release
+
+## [0.2.0] - 2021-09-17
+
+### Changes
+- Downgraded ruby to >=2.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bml_connect (0.1.0)
+    bml_connect (0.2.0)
       deep_merge (~> 1.2)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)

data/README.md

@@ -24,6 +24,53 @@ Or install it yourself as:
 
 ## Usage
 
+First get your API key and App ID from Merchant Portal for [`production`](https://dashboard.merchants.bankofmaldives.com.mv) or [`sandbox`](https://dashboard.uat.merchants.bankofmaldives.com.mv).
+
+For production client:
+```ruby
+require 'bml_connect`
+
+client = BMLConnect::Client.new(api_key: '<your-api-key>', app_id: '<your-app-id>')
+```
+For sandbox client:
+```ruby
+require 'bml_connect`
+
+client = BMLConnect::Client.new(api_key: '<your-api-key>', app_id: '<your-app-id>', mode: 'sandbox')
+```
+In Ruby on Rails, to configure globally, add an intilializer `bml_connect.rb`:
+```ruby
+module BMLConnect
+  class Client
+    BML_API_KEY = ENV['BML_MPG_KEY']
+    BML_APP_ID = ENV['BML_MPG_APP_ID']
+    BML_MODE = ENV['BML_MPG_MODE']
+  end
+end
+````
+```ruby
+client = BMLConnect::Client.new
+```
+### API Operations
+To create a new transaction
+```ruby
+resp = client.transactions.create({
+  amount: 10000,
+  currency: 'MVR',
+  redirectUrl: '<your-redirect-uri>',
+  localId: 'local-1',
+  customerReference: 'INV-0001'
+})
+```
+To fetch a specified transaction
+```ruby
+resp = client.transactions.get(id)
+```
+To transaction list
+```ruby
+resp = client.transactions.list({ page: 2 })
+```
+API responses are instances of [`Faraday::Response`](https://github.com/lostisland/faraday/blob/main/lib/faraday/response.rb) class, `json` encoded with symbolized names. 
 
 ## Development
 

data/bml_connect.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Using this gem you can interact with your Bank of Maldives Connect API."
   spec.homepage      = "https://github.com/oxiqa/bml-connect-ruby"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.3.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 

data/lib/bml_connect/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BMLConnect
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bml_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - oxiqa
@@ -139,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="