blnk 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05e768b805f7c2e8f061d334fd923afcf82fcc3945bf0c5a3ac844815403fd3f
-  data.tar.gz: 2edddcd8e0227f1183f05d488a7aec58b22cdef9d157e4479fb7e8ca9026aad7
+  metadata.gz: 5c5fd560be10539e1da9ac8d3d47685a4070b2723432ef1b2580ae5e57760a82
+  data.tar.gz: d90db62cdd4fbea9c633cdbe579df1e3242188b520b9e4de17e095b201a598fc
 SHA512:
-  metadata.gz: d8084904b5d4210b9c4e0c8b5a7f7bc8d107fca56ff3669e0d01376cbe5360a644e52b490c677b86baa9672ddb04ba417f4fc4c5ab6c7a6170f381d133558b3b
-  data.tar.gz: 54bf131a6080c1af282d581c24395cf99ec28c7a26fab84cc09c77d1337f19e1be5600907454470edff6017ac6dd3d1a7b4234da8def6c3700ecd527feee0370
+  metadata.gz: f8e50a2169fe30914d20bd8bab234202900e23d336215c93e643edb34ced8a0565996aa7fe873b10a90862ed5b17e1915191b92367bc616c6ff42560b63acd81
+  data.tar.gz: 81c7c8d09fcaf7312e3fb256a5d7a991c59e0c1355141ff8487df32544a40716a11f33ea72909c964a1a3fb437d2aaf6510ef7ededf6481b8c4cc75917dafbb6

data/README.md

@@ -1,5 +1,3 @@
-# This gem is under development, don't use in production
-
 # Blnk
 
 Easy way to use the blnkfinance.com API in ruby
@@ -14,23 +12,40 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install blnk
 
-## Usage
+## TODO
 
-TODO:
 - [x] Create Ledger
 - [x] Find Ledger
 - [x] List Ledgers
-- [ ] Search Ledgers
+- [x] Search Ledgers
 - [x] Create Balances
 - [x] Find Balance
-- [ ] Search Balances
-- [ ] Create Transaction
-- [ ] Find Transaction
-- [ ] Search Transactions
+- [x] Search Balances
+- [x] Create Transaction
+- [x] Multiple sources / destinations Transaction
+- [x] Refund Transaction
+- [x] Commit inflight Transaction
+- [x] Void inflight Transaction
+- [x] Find Transaction
+- [x] Search Transactions
+- [ ] Handler notifications
+- [ ] Create Balance Monitor
+- [ ] Find Balance Monitor
+- [ ] Update Balance Monitor
+- [ ] Backup endpoint
+- [ ] Backup to S3 endpoint
+- [ ] Add Search Contract schema for each resource using they own search attributes
+- [ ] Search Result should convert document resul into resource class
+- [x] Use Dry Monads to get success / failure output
+- [x] Use Dry Validation to validate inputs
+- [ ] Use Dry Schema instead OpenStruct to handle with resource attributes
+- [ ] Use Dry Configuration to better config DSL
 
 ## Usage
 
 ```ruby
+transaction = Blnk::Transaction.find 'transaction_id'
+
 require 'blnk'
 
 # client config
@@ -39,28 +54,40 @@ Blnk.address = '192.168.2.7:5001'
 Blnk.secret_token = 'your_strong_secret_key'
 Blnk.search_api_key = Blnk.secret_token
 
-# ledgers integration
+# Ledgers
 
 ledger = Blnk::Ledger.create(name: 'foobar')
 ledger = Blnk::Ledger.find 'ledger_id'
 ledgers = Blnk::Ledger.all
 
-# search not implemented yet
-ledgers = Blnk::Ledger.search(
-  q: 'USD',
-  filter_by: 'balances > 1400', 
-  sort_by: 'created_at:desc', 
-  page: 1, 
-  per_page: 50
-)
-
+ledgers = Blnk::Ledger.search(q: '*')
 
-# Balance integrations
+# Balances
 balance = Blnk::Balance.find 'balance_id'
 balance = Blnk::Balance.create(ledger_id: 'ledger_id', currency: 'USD')
 
+balances = Blnk::Balance.search(q: '*')
+
+# Transactions
+transaction = Blnk::Transaction.find 'transaction_id'
+transaction = Blnk::Transaction.create(
+  amount: 75,
+  reference: 'ref_005',
+  currency: 'BRLX',
+  precision: 100,
+  source: '@world',
+  destination: 'bln_469f93bc-40e9-4e0e-b6ab-d11c3638c15d',
+  description: 'For fees',
+  allow_overdraft: true
+)
+
+transaction = Blnk::Transaction.search q: '*'
 ```
 
+## Result
+
+All methods return a Dry::Monad::Result, so you can use ```.failure?``` to check if method was executed and returned a failure (can be validation or a server error). ```.success?``` to check if method was executed with successful and access the data from the failure or successful result using ```.value!```. You can check on the dry-monad gem to see other options on Result.
+
 
 ## Development
 

data/lib/blnk/balance.rb

@@ -3,9 +3,15 @@
 module Blnk
   # Balance representation
   class Balance < Resourceable
-    def self.resource_name = :balances
+    class CreateContract < Dry::Validation::Contract
+      schema do
+        required(:ledger_id).value(:string)
+        required(:currency).value(:string)
+      end
+    end
 
-    def persisted? = !balance_id.nil?
-    def body_data = { ledger_id:, currency: }
+    self.resource_name = :balances
+    self.id_field = :balance_id
+    self.create_contract = CreateContract
   end
 end

data/lib/blnk/ledger.rb

@@ -3,9 +3,15 @@
 module Blnk
   # Ledger representation
   class Ledger < Resourceable
-    def self.resource_name = :ledgers
+    class CreateContract < Dry::Validation::Contract
+      schema do
+        required(:name).value(:string)
+        optional(:meta_data).value(:hash)
+      end
+    end
 
-    def persisted? = !ledger_id.nil?
-    def body_data = { name:, meta_data: }
+    self.resource_name = :ledgers
+    self.id_field = :ledger_id
+    self.create_contract = CreateContract
   end
 end

data/lib/blnk/resourceable.rb

@@ -3,37 +3,127 @@
 module Blnk
   # Resoureable module that bring some tweaks for basic REST api integration
   class Resourceable < OpenStruct
-    include Client
+    extend Client
+    extend Forwardable
 
-    def self.resource_name = raise NotImplementedError
+    def_delegators :'self.class', :put_request, :post_request, :get_request, :with_handler
 
-    def self.find(id)
-      response = new.get_request(path: "/#{resource_name}/#{id}")
-      return response unless response.status.success?
+    class SearchResult < OpenStruct; end
 
-      new response.parse
+    class DefaultSearchContract < Dry::Validation::Contract
+      schema do
+        required(:q).value(:string)
+      end
     end
 
-    def self.all
-      response = new.get_request(path: "/#{resource_name}")
-      return response unless response.status.success?
+    class << self
+      include Dry::Monads[:result]
+
+      attr_accessor :resource_name, :id_field, :create_contract, :search_contract
+
+      def resources_path = "/#{resource_name}"
+      def resource_path(id) = "/#{resource_name}/#{id}"
+      def search_path = "/search/#{resource_name}"
+
+      def find(id) = with_handler resp: find_request(id)
+      def find_request(id) = get_request(path: resource_path(id))
+
+      def all
+        check_vars
+        resp = get_request(path: resources_path)
+        with_handler(resp:, block: method(:all_handler))
+      end
+
+      def create(**args)
+        wrap_call(create_contract_new, args) do |contract|
+          with_handler(resp: post_request(path: resources_path, body: contract.to_h))
+        end
+      end
+
+      def search(**args)
+        wrap_call(search_contract_new, args) do |contract|
+          with_handler(resp: post_request(path: search_path, body: contract.to_h),
+                       block: method(:search_handler))
+        end
+      end
+
+      def check_vars
+        raise NotImplementedError, 'missing self.resource_name' unless resource_name
+        raise NotImplementedError, 'missing self.id_field' unless id_field
+        raise NotImplementedError, 'missing self.create_contract' unless create_contract
+      end
+
+      def wrap_call(contract, args)
+        check_vars
+        ccall = contract.call(args)
+        return Failure(ccall.errors.to_h) if ccall.failure?
+
+        return yield ccall if block_given?
+
+        ccall
+      end
+
+      def create_contract_new
+        return create_contract.new if create_contract
 
-      response.parse.map do |r|
-        new r
+        raise NotImplementedError, 'missing self.create_contract'
+      end
+
+      def search_contract_new = (search_contract || DefaultSearchContract).new
+
+      def search_handler(parsed, status)
+        success = status.success?
+        result = SearchResult.new(parsed) if success
+
+        inj_handler(result:, success:, error: parsed)
+      end
+
+      def all_handler(parsed, status)
+        success = status.success?
+        result = parsed.map { |r| new(r) } if success
+        inj_handler(success:, result:, error: parsed)
+      end
+
+      def handler(parsed, status)
+        inj_handler(
+          result: new(parsed),
+          error: parsed,
+          success: status.success?
+        )
+      end
+
+      def inj_handler(result:, error:, success:)
+        (success ? Success(result) : Failure(error))
+      end
+
+      def with_handler(resp:, kself: nil, block: method(:handler))
+        using_resp(resp:, kself:, &block)
+      end
+
+      def using_resp(resp:, kself: nil, &block)
+        check_vars
+        parsed = resp.parse
+        parsed = parsed.transform_keys(&:to_sym) unless parsed.is_a?(Array)
+
+        kself&.reload
+
+        block.call(parsed, resp.status)
       end
     end
 
-    def self.create(*)
-      response = new.post_request(
-        path: "/#{resource_name}",
-        body: new(*).body_data
-      )
-      return response unless response.status.success?
+    def reload
+      self.class.find_request(_id).tap do |res|
+        next unless res.status.success?
 
-      new(response.parse)
+        res.parse.each_pair do |k, v|
+          self[k] = v
+        end
+      end
+      self
     end
 
-    def persisted? = raise NotImplementedError
-    def body_data = raise NotImplementedError
+    # table[self.class.id_field]
+    def persisted? = !_id.nil?
+    def _id = public_send(self.class.id_field)
   end
 end

data/lib/blnk/transaction.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Blnk
+  # Transaction representation
+  class Transaction < Resourceable
+    class CreateContract < Dry::Validation::Contract
+      schema do
+        required(:amount).value(:integer)
+        required(:precision).value(:integer)
+        required(:currency).value(:string)
+        required(:reference).value(:string)
+        optional(:source).value(:string)
+        optional(:sources).array(:hash) do
+          required(:identifier).value(:string)
+          required(:distribution).value(:string)
+          required(:narration).value(:string)
+        end
+        optional(:destination).value(:string)
+        optional(:destinations).array(:hash) do
+          required(:identifier).value(:string)
+          required(:distribution).value(:string)
+          required(:narration).value(:string)
+        end
+        required(:description).value(:string)
+        required(:allow_overdraft).value(:bool)
+        optional(:inflight).value(:bool)
+        optional(:rate).value(:integer)
+        optional(:scheduled_for).value(:string)
+      end
+
+      rule do
+        base.failure('must only contain one of source, sources') if key?(:source) && key?(:sources)
+
+        if key?(:destination) && key?(:destinations)
+          base.failure('must only contain one of destination, destinations')
+        end
+
+        if values[:source].to_s.empty? && values[:sources].to_s.empty?
+          key(:source).failure('missing source')
+        end
+
+        if values[:destination].to_s.empty? && values[:destinations].to_s.empty?
+          key(:destination).failure('missing destination')
+        end
+      end
+    end
+
+    self.resource_name = :transactions
+    self.id_field = :transaction_id
+    self.create_contract = CreateContract
+
+    def refund = short_hander(resp: req_refund)
+    def void = short_hander(resp: req_inflight(body: { status: 'void' }))
+    def commit = short_hander(resp: req_inflight(body: { status: 'commit' }))
+
+    private
+
+    def short_hander(resp:) = with_handler(resp:, kself: self)
+    def inflight_path = "/transactions/inflight/#{_id}"
+    def refund_path = "/refund-transaction/#{_id}"
+    def req_inflight(body:) = put_request(path: inflight_path, body:)
+    def req_refund = post_request(path: refund_path, body: nil)
+  end
+end

data/lib/blnk/version.rb

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

data/lib/blnk.rb

@@ -2,11 +2,14 @@
 
 require 'http'
 require 'ostruct'
+require 'dry-validation'
+require 'dry/monads'
 require_relative 'blnk/version'
 require_relative 'blnk/client'
 require_relative 'blnk/resourceable'
 require_relative 'blnk/ledger'
 require_relative 'blnk/balance'
+require_relative 'blnk/transaction'
 
 module Blnk
   class Error < StandardError; end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: blnk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Antonio Roberto Silva
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -41,6 +83,7 @@ files:
 - lib/blnk/client.rb
 - lib/blnk/ledger.rb
 - lib/blnk/resourceable.rb
+- lib/blnk/transaction.rb
 - lib/blnk/version.rb
 - sig/blnk.rbs
 homepage: https://blnkledger.com/