blnk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05e768b805f7c2e8f061d334fd923afcf82fcc3945bf0c5a3ac844815403fd3f
+  data.tar.gz: 2edddcd8e0227f1183f05d488a7aec58b22cdef9d157e4479fb7e8ca9026aad7
+SHA512:
+  metadata.gz: d8084904b5d4210b9c4e0c8b5a7f7bc8d107fca56ff3669e0d01376cbe5360a644e52b490c677b86baa9672ddb04ba417f4fc4c5ab6c7a6170f381d133558b3b
+  data.tar.gz: 54bf131a6080c1af282d581c24395cf99ec28c7a26fab84cc09c77d1337f19e1be5600907454470edff6017ac6dd3d1a7b4234da8def6c3700ecd527feee0370

data/.rubocop.yml

@@ -0,0 +1,262 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+# require:
+#   - rubocop-rails
+#   # - rubocop/cop/internal_affairs
+#   # - rubocop-performance
+#   - rubocop-rspec
+#   - rubocop-rspec_rails
+#   # - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+  TargetRubyVersion: 3.3.1
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - 'config/routes.rb'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Lint/MissingSuper:
+  Exclude:
+    - 'app/services/**/*'
+
+Style/Encoding:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 99
+
+Style/OpenStructUse:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+
+# This is the configuration used to check the rubocop source code.
+
+# inherit_from: .rubocop_todo.yml
+# require:
+#   - rubocop-rails
+#   - rubocop/cop/internal_affairs
+#   - rubocop-performance
+#   - rubocop-rspec
+#   - rubocop-rake
+
+# AllCops:
+#   NewCops: enable
+#   Exclude:
+#     - 'vendor/**/*'
+#     - 'spec/fixtures/**/*'
+#     - 'tmp/**/*'
+#     - '.git/**/*'
+#     - 'bin/*'
+#   TargetRubyVersion: 2.7
+#   SuggestExtensions: false
+
+# Naming/PredicateName:
+#   # Method define macros for dynamically generated method.
+#   MethodDefinitionMacros:
+#     - define_method
+#     - define_singleton_method
+#     - def_node_matcher
+#     - def_node_search
+
+# Style/AccessorGrouping:
+#   Exclude:
+#     - lib/rubocop/formatter/base_formatter.rb
+#     - lib/rubocop/cop/offense.rb
+
+# Style/FormatStringToken:
+#   # Because we parse a lot of source codes from strings. Percent arrays
+#   # look like unannotated format string tokens to this cop.
+#   Exclude:
+#     - spec/**/*
+
+# Style/IpAddresses:
+#   # The test for this cop includes strings that would cause offenses
+#   Exclude:
+#     - spec/rubocop/cop/style/ip_addresses_spec.rb
+
+# Layout/EndOfLine:
+#   EnforcedStyle: lf
+
+# Layout/ClassStructure:
+#   Enabled: true
+
+# Layout/RedundantLineBreak:
+#   Enabled: true
+
+# Layout/TrailingWhitespace:
+#   AllowInHeredoc: false
+
+# Lint/AmbiguousBlockAssociation:
+#   Exclude:
+#     - 'spec/**/*.rb'
+
+# Layout/HashAlignment:
+#   EnforcedHashRocketStyle:
+#     - key
+#     - table
+#   EnforcedColonStyle:
+#     - key
+#     - table
+
+# Layout/LineLength:
+#   Max: 100
+#   AllowedPatterns:
+#     - !ruby/regexp /\A +(it|describe|context|shared_examples|include_examples|it_behaves_like) ["']/
+
+# Lint/InterpolationCheck:
+#   Exclude:
+#     - 'spec/**/*.rb'
+
+# Lint/UselessAccessModifier:
+#   MethodCreatingMethods:
+#     - 'def_matcher'
+#     - 'def_node_matcher'
+
+# Lint/EmptyFile:
+#   Exclude:
+#     # This file is intentionally empty to catch rubocop cops failing on empty files.
+#     - spec/rubocop/intentionally_empty_file.rb
+
+# Metrics/BlockLength:
+#   Exclude:
+#     - 'Rakefile'
+#     - '**/*.rake'
+#     - 'spec/**/*.rb'
+
+# Metrics/ClassLength:
+#   Exclude:
+#     - lib/rubocop/config_obsoletion.rb
+#     - lib/rubocop/options.rb
+
+# Metrics/ModuleLength:
+#   Exclude:
+#     - 'spec/**/*.rb'
+
+# Naming/InclusiveLanguage:
+#   Enabled: true
+#   CheckStrings: true
+#   FlaggedTerms:
+#     ' a offense':
+#       Suggestions:
+#         - an offense
+#     auto-correct:
+#       Suggestions:
+#         - autocorrect
+#     auto_correct:
+#       Suggestions:
+#         - autocorrect
+#     behaviour:
+#       Suggestions:
+#         - behavior
+#     offence:
+#       Suggestions:
+#         - offense
+#     'does not registers':
+#       Suggestions:
+#         - does not register
+#     'register no offense':
+#       Suggestions:
+#         - registers no offense
+#   Exclude:
+#     - lib/rubocop/cop/naming/inclusive_language.rb
+#     - lib/rubocop/cop/mixin/auto_corrector.rb
+#     - spec/rubocop/cop/naming/inclusive_language_spec.rb
+
+# RSpec:
+#   Language:
+#     Expectations:
+#       - expect_autocorrect_options_for_autocorrect
+#       - expect_autocorrect_options_for_autocorrect_all
+#       - expect_autocorrect_options_for_fix_layout
+#       - expect_correction
+#       - expect_feature_loader
+#       - expect_no_offenses
+#       - expect_offense
+
+# RSpec/PredicateMatcher:
+#   EnforcedStyle: explicit
+
+# RSpec/FilePath:
+#   Enabled: false
+
+# RSpec/SpecFilePathFormat:
+#   CustomTransform:
+#     GitHubActionsFormatter: github_actions_formatter
+#     JUnitFormatter: junit_formatter
+#     RedundantLetRuboCopConfigNew: redundant_let_rubocop_config_new
+#   Exclude:
+#     - spec/rubocop/cop/mixin/enforce_superclass_spec.rb
+
+# RSpec/MessageSpies:
+#   EnforcedStyle: receive
+
+# RSpec/NestedGroups:
+#   Max: 7
+
+# RSpec/MultipleMemoizedHelpers:
+#   Enabled: false
+
+# Performance/CollectionLiteralInLoop:
+#   Exclude:
+#     - 'Rakefile'
+#     - 'spec/**/*.rb'
+
+# Performance/EndWith:
+#   SafeMultiline: false
+
+# Performance/StartWith:
+#   SafeMultiline: false
+
+# RSpec/StubbedMock:
+#   Enabled: false
+
+# InternalAffairs/ExampleDescription:
+#   Include:
+#     - 'spec/rubocop/cop/**/*.rb'
+
+# InternalAffairs/ExampleHeredocDelimiter:
+#   Include:
+#     - 'spec/rubocop/cop/**/*.rb'
+
+# InternalAffairs/UndefinedConfig:
+#   Include:
+#     - 'lib/rubocop/cop/**/*.rb'
+#   Exclude:
+#     - 'lib/rubocop/cop/correctors/**/*.rb'
+#     - 'lib/rubocop/cop/mixin/**/*.rb'
+
+# InternalAffairs/StyleDetectedApiUse:
+#   Exclude:
+#     - 'lib/rubocop/cop/mixin/percent_array.rb'
+
+# InternalAffairs/NumblockHandler:
+#   Exclude:
+#     - 'lib/rubocop/cop/internal_affairs/*.rb'
+
+# Gemspec/DependencyVersion:
+#   Enabled: true
+
+# Style/RequireOrder:
+#   Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-24
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Antonio Roberto Silva
+
+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.

data/README.md

@@ -0,0 +1,77 @@
+# This gem is under development, don't use in production
+
+# Blnk
+
+Easy way to use the blnkfinance.com API in ruby
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add blnk
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install blnk
+
+## Usage
+
+TODO:
+- [x] Create Ledger
+- [x] Find Ledger
+- [x] List Ledgers
+- [ ] Search Ledgers
+- [x] Create Balances
+- [x] Find Balance
+- [ ] Search Balances
+- [ ] Create Transaction
+- [ ] Find Transaction
+- [ ] Search Transactions
+
+## Usage
+
+```ruby
+require 'blnk'
+
+# client config
+
+Blnk.address = '192.168.2.7:5001'
+Blnk.secret_token = 'your_strong_secret_key'
+Blnk.search_api_key = Blnk.secret_token
+
+# ledgers integration
+
+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
+)
+
+
+# Balance integrations
+balance = Blnk::Balance.find 'balance_id'
+balance = Blnk::Balance.create(ledger_id: 'ledger_id', currency: 'USD')
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/devton/blnk-ruby
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.warning = false
+  t.test_globs = ['./test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/blnk/balance.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Blnk
+  # Balance representation
+  class Balance < Resourceable
+    def self.resource_name = :balances
+
+    def persisted? = !balance_id.nil?
+    def body_data = { ledger_id:, currency: }
+  end
+end

data/lib/blnk/client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Blnk
+  # HTTP Client to do the requests to blnk server
+  module Client
+    def client
+      ::HTTP.headers(
+        'X-Blnk-Key': Blnk.secret_token,
+        'Content-Type': 'application/json',
+        accept: 'application/json'
+      )
+    end
+
+    def get_request(path:, params: nil)
+      client.get(base_uri(path:), params:)
+    end
+
+    def put_request(path:, body:)
+      client.put(base_uri(path:), json: body)
+    end
+
+    def post_request(path:, body:)
+      client.post(base_uri(path:), json: body)
+    end
+
+    def base_uri(path:, uri: Blnk.address)
+      uri = URI(uri)
+      uri.path = path if path
+      uri
+    end
+  end
+end

data/lib/blnk/ledger.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Blnk
+  # Ledger representation
+  class Ledger < Resourceable
+    def self.resource_name = :ledgers
+
+    def persisted? = !ledger_id.nil?
+    def body_data = { name:, meta_data: }
+  end
+end

data/lib/blnk/resourceable.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Blnk
+  # Resoureable module that bring some tweaks for basic REST api integration
+  class Resourceable < OpenStruct
+    include Client
+
+    def self.resource_name = raise NotImplementedError
+
+    def self.find(id)
+      response = new.get_request(path: "/#{resource_name}/#{id}")
+      return response unless response.status.success?
+
+      new response.parse
+    end
+
+    def self.all
+      response = new.get_request(path: "/#{resource_name}")
+      return response unless response.status.success?
+
+      response.parse.map do |r|
+        new r
+      end
+    end
+
+    def self.create(*)
+      response = new.post_request(
+        path: "/#{resource_name}",
+        body: new(*).body_data
+      )
+      return response unless response.status.success?
+
+      new(response.parse)
+    end
+
+    def persisted? = raise NotImplementedError
+    def body_data = raise NotImplementedError
+  end
+end

data/lib/blnk/version.rb

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

data/lib/blnk.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'ostruct'
+require_relative 'blnk/version'
+require_relative 'blnk/client'
+require_relative 'blnk/resourceable'
+require_relative 'blnk/ledger'
+require_relative 'blnk/balance'
+
+module Blnk
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :address, :secret_token, :search_api_key
+  end
+
+  self.address = ENV.fetch('BLNK_ADDRESS', nil)
+  self.secret_token = ENV.fetch('BLNK_SECRET_TOKEN', nil)
+  self.search_api_key = ENV.fetch('BLNK_SEARCH_API_KEY', nil)
+end

data/sig/blnk.rbs

@@ -0,0 +1,4 @@
+module Blnk
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: blnk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Antonio Roberto Silva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: Ruby SDK to connect and interact with BLNK Ledger
+email:
+- forevertonny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/blnk.rb
+- lib/blnk/balance.rb
+- lib/blnk/client.rb
+- lib/blnk/ledger.rb
+- lib/blnk/resourceable.rb
+- lib/blnk/version.rb
+- sig/blnk.rbs
+homepage: https://blnkledger.com/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://blnkledger.com/
+  source_code_uri: https://github.com/devton/blnk-ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Ruby SDK to connect and interact with BLNK Ledger
+test_files: []