tazapay 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b977bb2c645361ecfec78c427b2c225e81cc0a23d0f9075558d57d4549b43ba4
-  data.tar.gz: 8d2eff6f8f83b4e199c77b5ec5dd0c2d4eb13645626782fc65f4d8bd6fb37a87
+  metadata.gz: b450d94fc7d24206476c392110db8e1defd931c6a8b9f31b127ecbe1f4ff6cf0
+  data.tar.gz: 6c082cdd772f23a90fc78ed6aadd8d4d0ab0538ec7254d3c6dbe7f229a6e6537
 SHA512:
-  metadata.gz: 2ee04358c3e84821b6262f38a7a1fd1ceab05885de7a0488f41e78f2a0979cc4be61e465f88d9759fec82b6b20421aa3f3f2fb97e5a08bd420617591ae6eb6c7
-  data.tar.gz: 10c190ff09e1d965c345a4d2f58c807196be14c4baee8a874c96c56c06fe6bfd8508831f717dbcbd3fbe3bb5ab5d4ae5dbad5f77decafc479e33826ee30965e6
+  metadata.gz: 07f5a205b8d63fa6459e9ca0af995e3b215c358761fd444bc8b9100451c2f1d6106ba4f179785ec7f3908022d5f1f2a408dec31366d3c0f61429508f0760698e
+  data.tar.gz: b2c84373e543b873bd1aac04dcb33802db28e02ed0ea391b9b7ef0723dd298ec813dcafd1ca9b5c4bc40f4e10da88ce817eee61048e8cd56796fbeaeed478884

data/CHANGELOG.md

@@ -3,3 +3,19 @@
 ## [0.1.0] - 2023-02-23
 
 - Initial release
+- Add Checkout API
+
+
+## [0.1.1] - 2023-02-24
+
+- Add User API
+
+
+## [0.1.2] - 2023-02-25
+
+- Add Bank API
+
+
+## [0.1.3] - 2023-02-25
+
+- Add Metadata API

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at a.kuznetsov@okft.io. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at m2lxkuz@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tazapay (0.1.1)
+    tazapay (0.1.3)
       faraday (~> 1.0)
 
 GEM

data/README.md

@@ -1,8 +1,7 @@
 # Tazapay
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tazapay`. To experiment with that code, run `bin/console` for an interactive prompt.
+Tazapay API ruby client
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -44,6 +43,99 @@ data = tazapay_checkout.get_status(tx_number)
 
 ```
 
+### User
+
+```ruby
+
+tazapay_user = Tazapay::User.new
+
+data = {
+  email: "sometest+12@mail.io",
+  country: "SG",
+  ind_bus_type: "Business",
+  business_name: "TEST SANDBOX",
+  contact_code: "+65",
+  contact_number: "9999999999",
+  partners_customer_id: "test-123"
+}
+
+# Create user
+user_id = tazapay_user.create(data)["data"]["account_id"]
+
+# Update user
+tazapay_user.update(user_id, new_data)
+
+# Find user by ID
+tazapay_user.find(user_id)
+
+# Find user by Email
+tazapay_user.find(email)
+
+```
+
+See more details in tests
+
+### Bank
+
+```ruby
+
+tazapay_bank = Tazapay::Bank.new
+
+data = {
+  email: "sometest+12@mail.io",
+  country: "SG",
+  ind_bus_type: "Business",
+  business_name: "TEST SANDBOX",
+  contact_code: "+65",
+  contact_number: "9999999999",
+  partners_customer_id: "test-123"
+}
+
+# Add bank account
+bank_id = tazapay_bank.add(
+  account_id: user_id, bank_data: new_data
+)['data']['bank_id']
+
+# List user banks
+tazapay_bank.list(user_id)
+
+# Make bank account primary
+tazapay_bank.make_primary(bank_id: bank_id, account_id: user_id)
+
+```
+
+See more details in tests
+
+
+### Metadata
+
+```ruby
+
+tazapay_metadata = Tazapay::Metadata.new
+
+# See https://docs.tazapay.com/reference/country-configuration-api
+tazapay_metadata.country_config(country)
+
+# See https://docs.tazapay.com/reference/invoice-currency-api
+tazapay_metadata.invoice_currency(buyer_country:, seller_country:)
+
+# See https://docs.tazapay.com/reference/collection-methods-api
+tazapay_metadata.collection_methods(buyer_country:, seller_country:, invoice_currency:, amount:)
+
+# See https://docs.tazapay.com/reference/disburse-methods-api
+tazapay_metadata.disbursement_methods(buyer_country:, seller_country:, invoice_currency:, amount:)
+
+# Doc upload URL
+tazapay_metadata.doc_upload_url
+
+# KYB Doc
+tazapay_metadata.kyb_doc(country)
+
+# See https://docs.tazapay.com/reference/get-milestone-schemes
+tazapay_metadata.milestone_scheme
+
+```
+
 See more details in tests
 
 
@@ -55,7 +147,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tazapay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tazapay/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/lxkuz/tazapay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tazapay/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/tazapay/bank.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "tazapay/config"
+require "tazapay/client"
+
+module Tazapay
+  # Bank API
+  class Bank < Client
+    def add(account_id:, bank_data:)
+      path = "v1/bank"
+      data = bank_data.merge(account_id: account_id)
+      send_request(method: :post, path: path, body: data)
+    end
+
+    def list(account_id)
+      path = "v1/bank/#{account_id}"
+      send_request(method: :get, path: path)
+    end
+
+    def make_primary(account_id:, bank_id:)
+      path = "v1/bank/primary"
+      send_request(method: :put, path: path, body: {
+                     account_id: account_id,
+                     bank_id: bank_id
+                   })
+    end
+  end
+end

data/lib/tazapay/checkout.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# Implementation of the MTN API remittances client
-
 require "tazapay/config"
 require "tazapay/client"
 

data/lib/tazapay/client.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-# Base implementation of the MTN API client
-
-# Includes methods common to collections, disbursements and remittances
-
 require "faraday"
 
 require "tazapay/config"
@@ -13,12 +9,11 @@ module Tazapay
   # Base API client
   class Client
     def send_request(method:, path:, headers: default_headers, body: {})
-      conn = faraday_with_block(url: Tazapay.config.base_url)
-      conn.headers = headers
-      conn.basic_auth(Tazapay.config.access_key, Tazapay.config.secret_key)
+      conn = prepare_connection(headers)
       case method.to_s
       when "get" then response = conn.get(path)
       when "post" then response = conn.post(path, body.to_json)
+      when "put" then response = conn.put(path, body.to_json)
       end
       interpret_response(response)
     end
@@ -39,6 +34,13 @@ module Tazapay
 
     private
 
+    def prepare_connection(headers)
+      conn = faraday_with_block(url: Tazapay.config.base_url)
+      conn.headers = headers
+      conn.basic_auth(Tazapay.config.access_key, Tazapay.config.secret_key)
+      conn
+    end
+
     def faraday_with_block(options)
       Faraday.new(options)
       block = Tazapay.config.faraday_block

data/lib/tazapay/errors.rb

@@ -3,12 +3,13 @@
 # Error handling for unsuccessful responses from the Tazapay API
 
 module Tazapay
-  # Stanadrd API error
+  # Standard API error
   class Error < StandardError
-    attr_reader :code
+    attr_reader :code, :response_body
 
     def initialize(message, code)
       @code = code
+      @response_body = message
       super("Error code #{code} #{message}")
     end
   end

data/lib/tazapay/metadata.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "tazapay/config"
+require "tazapay/client"
+
+module Tazapay
+  # Metadata API
+  class Metadata < Client
+    def country_config(country)
+      path = "v1/metadata/countryconfig?country=#{country}"
+      send_request(method: :get, path: path)
+    end
+
+    def invoice_currency(buyer_country:, seller_country:)
+      path = "v1/metadata/invoicecurrency?buyer_country=#{buyer_country}&seller_country=#{seller_country}"
+      send_request(method: :get, path: path)
+    end
+
+    def collection_methods(buyer_country:, seller_country:, invoice_currency:, amount:)
+      path = "v1/metadata/collect?buyer_country=#{buyer_country}" \
+             "&seller_country=#{seller_country}&invoice_currency=#{invoice_currency}" \
+             "&amount=#{amount}"
+      send_request(method: :get, path: path)
+    end
+
+    def disbursement_methods(buyer_country:, seller_country:, invoice_currency:, amount:)
+      path = "v1/metadata/disburse?buyer_country=#{buyer_country}" \
+             "&seller_country=#{seller_country}&invoice_currency=#{invoice_currency}" \
+             "&amount=#{amount}"
+      send_request(method: :get, path: path)
+    end
+
+    def doc_upload_url
+      path = "/v1/metadata/doc/upload"
+      send_request(method: :get, path: path)
+    end
+
+    def kyb_doc(country)
+      path = "/v1/metadata/kyb/doc?country=#{country}"
+      send_request(method: :get, path: path)
+    end
+
+    def milestone_scheme
+      path = "v1/metadata/milestone/scheme"
+      send_request(method: :get, path: path)
+    end
+  end
+end

data/lib/tazapay/user.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# Implementation of the MTN API remittances client
-
 require "tazapay/config"
 require "tazapay/client"
 

data/lib/tazapay/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tazapay
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/tazapay.rb

@@ -4,6 +4,8 @@ require "tazapay/config"
 require "tazapay/version"
 require "tazapay/checkout"
 require "tazapay/user"
+require "tazapay/bank"
+require "tazapay/metadata"
 
 # Head module
 module Tazapay

data/tazapay.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name = "tazapay"
   spec.version = Tazapay::VERSION
   spec.authors = ["Alexey Kuznetsov"]
-  spec.email = ["a.kuznetsov@okft.io"]
+  spec.email = ["m2lxkuz@gmail.com"]
 
   spec.summary = "Tazapay payments API ruby client"
   spec.description = "Tazapay payments API ruby client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tazapay
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Alexey Kuznetsov
@@ -68,7 +68,7 @@ dependencies:
         version: '3.18'
 description: Tazapay payments API ruby client
 email:
-- a.kuznetsov@okft.io
+- m2lxkuz@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -79,15 +79,16 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/tazapay.rb
+- lib/tazapay/bank.rb
 - lib/tazapay/checkout.rb
 - lib/tazapay/client.rb
 - lib/tazapay/config.rb
 - lib/tazapay/errors.rb
+- lib/tazapay/metadata.rb
 - lib/tazapay/user.rb
 - lib/tazapay/version.rb
 - sig/tazapay.rbs

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Alexey
-
-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.