finswitz 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54616ae6e0c27453ac0bec222a63a10352624e4f27e40f061de18e271bb967ab
+  data.tar.gz: 243f2e913bfc0b05850f0d9d6c4d40f173e57d09662618b1c28591a9929557e9
+SHA512:
+  metadata.gz: db5db1fe3248c3f3fd5e643e4bd981cbabcc121214077ab4d526779f8664229d2ab888fff788b24ced65932320a1b3549310f305f4b40e950269ff172d62c225
+  data.tar.gz: a74e0b7c30517790226d03d928a02c83c5030fc573ece590f6996ebfa8f39093f82b2a41dab3a0f5947a36fd22cfacfd3951c3e17347e9956bb1f17b7282ee70

data/README.md

@@ -0,0 +1,35 @@
+# Finswitz
+
+TODO: Delete this and the text below, and describe your gem
+
+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/finswitz`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/finswitz.

data/lib/finswitz/version.rb

@@ -0,0 +1,3 @@
+module Finswitz
+  VERSION = "1.0.0"
+end

data/lib/finswitz.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require_relative "finswitz/version"
+
+require "json"
+require "net/http"
+require "uri"
+
+module Finswitz
+  DEFAULT_BASE_URL = "https://api.finswitz.com"
+
+  class ApiError < StandardError
+    attr_reader :status, :response
+
+    def initialize(message, status: nil, response: nil)
+      super(message)
+      @status = status
+      @response = response
+    end
+  end
+
+  class Client
+    def initialize(api_key: nil, dashboard_token: nil, base_url: DEFAULT_BASE_URL)
+      @api_key = api_key
+      @dashboard_token = dashboard_token
+      @base_url = base_url.sub(%r{/+$}, "")
+    end
+
+    def request(method, path, body: nil, query: nil, idempotency_key: nil, token_type: :api, token: nil)
+      bearer = token || (token_type == :dashboard ? @dashboard_token : @api_key)
+      raise ArgumentError, token_type == :dashboard ? "Missing dashboard_token." : "Missing api_key." if token_type != :none && !bearer
+
+      uri = URI(@base_url + path)
+      uri.query = URI.encode_www_form(query.reject { |_key, value| value.nil? }) if query && !query.empty?
+
+      klass = Net::HTTP.const_get(method.to_s.capitalize)
+      req = klass.new(uri)
+      req["Accept"] = "application/json"
+      req["Authorization"] = "Bearer #{bearer}" unless token_type == :none
+      req["Idempotency-Key"] = idempotency_key if idempotency_key
+      if body
+        req["Content-Type"] = "application/json"
+        req.body = JSON.generate(body)
+      end
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https", read_timeout: 30) do |http|
+        http.request(req)
+      end
+
+      data = res.body && !res.body.empty? ? JSON.parse(res.body) : nil
+      unless res.code.to_i.between?(200, 299)
+        message = data.is_a?(Hash) && data["error"] ? data["error"] : "Finswitz API request failed with #{res.code}"
+        raise ApiError.new(message, status: res.code.to_i, response: data)
+      end
+      data
+    end
+
+    def get(path, **options) = request(:get, path, **options)
+    def post(path, body = {}, **options) = request(:post, path, body: body, **options)
+    def patch(path, body = {}, **options) = request(:patch, path, body: body, **options)
+
+    def transfer(payload, idempotency_key: nil) = post("/payments/transfer", payload, idempotency_key: idempotency_key)
+    def verify_account(payload) = post("/payments/verify-account", payload)
+    def create_payment_link(payload, idempotency_key: nil) = post("/payments/payment-links", payload, idempotency_key: idempotency_key)
+    def mobile_money(payload, idempotency_key: nil) = post("/payments/mobile-money", payload, idempotency_key: idempotency_key)
+    def mock_charge(payload) = post("/payments/mock/charge", payload)
+    def get_transaction(reference) = get("/payments/#{URI.encode_www_form_component(reference)}")
+    def list_transactions(query: nil) = get("/payments", query: query)
+    def refund(reference, payload = {}, idempotency_key: nil) = post("/payments/#{URI.encode_www_form_component(reference)}/refund", payload, idempotency_key: idempotency_key)
+    def list_banks(query: nil) = get("/payments/banks", query: query)
+
+    def card_pricing = get("/cards/pricing")
+    def issue_card(payload, idempotency_key: nil) = post("/cards/issue", payload, idempotency_key: idempotency_key)
+    def list_cards(query: nil) = get("/cards", query: query)
+    def list_card_transactions(card_id, query: nil) = get("/cards/#{URI.encode_www_form_component(card_id)}/transactions", query: query)
+    def get_card_transaction(card_id, transaction_id) = get("/cards/#{URI.encode_www_form_component(card_id)}/transactions/#{URI.encode_www_form_component(transaction_id)}")
+
+    def dashboard_options(options = {}) = options.merge(token_type: :dashboard)
+    def me = get("/developers/me", **dashboard_options)
+    def list_api_keys = get("/developers/keys", **dashboard_options)
+    def create_api_key(payload) = post("/developers/keys", payload, **dashboard_options)
+    def revoke_api_key(id) = post("/developers/keys/#{URI.encode_www_form_component(id)}/revoke", {}, **dashboard_options)
+    def update_webhooks(payload) = request(:put, "/developers/webhooks", body: payload, **dashboard_options)
+    def list_webhook_logs(query: nil) = get("/developers/webhooks/logs", **dashboard_options(query: query))
+    def simulate_webhook(payload) = post("/developers/webhooks/simulate", payload, **dashboard_options)
+    def wallets = get("/developers/wallets", **dashboard_options)
+    def fund_wallet(payload) = post("/developers/wallets/fund", payload, **dashboard_options)
+    def wallet_funding_status(query: nil) = get("/developers/wallets/fund/status", **dashboard_options(query: query))
+    def convert_wallet(payload) = post("/developers/wallets/convert", payload, **dashboard_options)
+    def treasury = get("/developers/treasury", **dashboard_options)
+    def list_split_rules = get("/developers/treasury/split-rules", **dashboard_options)
+    def create_split_rule(payload, idempotency_key: nil) = post("/developers/treasury/split-rules", payload, **dashboard_options(idempotency_key: idempotency_key))
+    def update_split_rule(id, payload) = patch("/developers/treasury/split-rules/#{URI.encode_www_form_component(id)}", payload, **dashboard_options)
+    def list_escrow_holds = get("/developers/treasury/escrow", **dashboard_options)
+    def create_escrow_hold(payload, idempotency_key: nil) = post("/developers/treasury/escrow", payload, **dashboard_options(idempotency_key: idempotency_key))
+    def release_escrow_hold(id, payload = {}, idempotency_key: nil) = post("/developers/treasury/escrow/#{URI.encode_www_form_component(id)}/release", payload, **dashboard_options(idempotency_key: idempotency_key))
+    def list_vendor_settlements = get("/developers/treasury/settlements", **dashboard_options)
+    def execute_vendor_settlement(id, payload = {}, idempotency_key: nil) = post("/developers/treasury/settlements/#{URI.encode_www_form_component(id)}/execute", payload, **dashboard_options(idempotency_key: idempotency_key))
+    def list_collections = get("/developers/collections", **dashboard_options)
+    def create_collection(payload) = post("/developers/collections", payload, **dashboard_options)
+    def update_collection(id, payload) = patch("/developers/collections/#{URI.encode_www_form_component(id)}", payload, **dashboard_options)
+    def list_collection_payments(id) = get("/developers/collections/#{URI.encode_www_form_component(id)}/payments", **dashboard_options)
+    def public_collection(slug) = get("/public/collections/#{URI.encode_www_form_component(slug)}", token_type: :none)
+    def pay_collection(slug, payload) = post("/public/collections/#{URI.encode_www_form_component(slug)}/pay", payload, token_type: :none)
+    def update_settlement(payload) = post("/developers/settlement", payload, **dashboard_options)
+    def verify_settlement_account(payload) = post("/developers/verify-account", payload, **dashboard_options)
+    def kyc = get("/developers/kyc", **dashboard_options)
+    def submit_kyc(payload) = post("/developers/kyc", payload, **dashboard_options)
+    def request_compliance_review(payload = {}) = post("/developers/compliance/request-review", payload, **dashboard_options)
+
+    def self.parse_webhook(raw_body)
+      raw_body.is_a?(String) ? JSON.parse(raw_body) : raw_body
+    end
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: finswitz
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Taiwo Ayomide TBWLJ
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Ruby SDK for interacting with the Finswitz API.
+email:
+- taiwoayomide202@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/finswitz.rb
+- lib/finswitz/version.rb
+homepage: https://finswitz.com
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Official Ruby SDK for the Finswitz API
+test_files: []