bitnob 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d76d6992c04df571dbc84bde929721e5565adabcab0a2e06fc069cba1a2812a3
+  data.tar.gz: 5ad51857790fa9e67720a744b23a534c0374c871b64d4b649d53b716b4cd2bb5
+SHA512:
+  metadata.gz: 674820661f193897db89659d2e209fc079a99d16f86f851d9d0c753f8c43c589c7ebe8cb479e4eb5f3c183f9e2d124fc707755f1d8540001ae8ff4990108e0cf
+  data.tar.gz: e6d26d72ddc9e3ce69e35fd7b8b98c55d565329b053075d3adf8ff906a3582da5c6bc9fefda43750c84c13e25ee3e94c7655c8c2b4abf3d06aa402fd32b88dbb

data/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: SDK CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  BITNOB_API_KEY: ${{ secrets.BITNOB_API_KEY}}
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.5.5]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.env
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require:
+ - rubocop-performance
+ - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/**/**/*'
+
+Metrics/MethodLength:
+  Max: 1000
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Changelog
+## 1.0.0 (01-Oct-21)

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitnob.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    bitnob (0.0.3)
+      dotenv (~> 2.7)
+      httparty (~> 0.19.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    httparty (0.19.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    multi_xml (0.6.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bitnob!
+  bundler (~> 2.2.27)
+  rake (~> 13.0.1)
+  rspec (~> 3.0)
+  rubocop (~> 1.20.0)
+  rubocop-performance (~> 1.11.5)
+  rubocop-rspec (~> 2.4.0)
+
+BUNDLED WITH
+   2.2.27

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2021, Bitnob
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,171 @@
+# Bitnob
+---
+This is a Ruby gem for easy integration of Bitnob For Business API for various applications written in Ruby language from Bitnob.
+
+[![SDK CI](https://github.com/bitnob/bitnob_ruby_SDK/actions/workflows/main.yml/badge.svg)](https://github.com/bitnob/bitnob_ruby_SDK/actions/workflows/main.yml)
+
+## Getting started
+
+### Requirements
+This gem requires Ruby 2.6+ and Rails 5.2+
+
+### Installation 
+- Add the following to your gem file:
+```ruby
+        gem 'bitnob', '~> 0.0.2'
+```
+Then run:
+
+```ruby
+        bundle install
+```
+
+### Usage 
+- To use this SDK, you need to create a new Bitnob class with your API secret key gotten from your dashboard settings. We recommend you store such keys in an environment variable name `BITNOB_API_KEY`. Instantiating such object would look like this 
+
+
+By default the package assumes that you are currently working using a sandbox credential in development, however to go live, your `secret key` nust be a production-grade secret key and you need to specify `true` when instantiating your bitnob class like this:
+
+```ruby
+    require 'bitnob'
+
+    wallet = Wallet.new(true) # production
+   get_wallets = wallet.fetch_wallets
+   p get_wallets.body
+
+    # Sandbox environment 
+
+    wallet = Wallet.new 
+    
+    get_transaction = wallet.fetch_all_transactions
+   p get_transaction.body
+```
+
+`NOTE`: It is best practice to always set your API keys to your environment variable for security purpose. Please be warned not use this package without setting your API keys in your environment variables in production.
+
+### Bitnob Functions
+- Before making use of any bitnob functions, it is expected you instantiate a new Function class and pass production as true to whatever function you wish to perform. Below is a demonstration:
+
+- `Customer.new(true)`
+- `Lightning.new(true)`
+- `Onchain.new(true)`
+- `Wallets.new(true)`
+
+
+#### Customers
+
+- To manage customers on your Bitnob for business in your ruby application, simply follow the instruction at the beginning of this sub-heading and instantiate a new `Customer` class.
+    - The following functions are available:
+        - create_customer
+        - get_customer_by_email 
+        - get_customer 
+        - update_customer
+
+### Lightning
+- To create Lightning Transactions, simply follow the instruction at the beginning of this sub-heading and instantiate a new `Lightning` class.
+    - The following functions are available:
+        - create_invoice
+        - pay_invoice 
+        - initiate_payment
+        - decode_payment request 
+        - get_invoice
+
+
+###### Full Transaction Workflow 
+```ruby
+    require 'bitnob'
+
+    ln = Lightning.new(true)
+
+    payload = {
+        customerEmail: "parah@bitnob.com",
+        description: "Dorime for Nonso and Tumise",
+        tokens: 300,
+        expires_at: "24h",
+    }
+
+    # Create a lightning invoice 
+
+   new_ln_invoice = ln.create_invoice(payload)
+    
+```
+### Onchain 
+- To create Onchain Transactions, simply follow the instruction at the beginning of this sub-heading and instantiate a new `Onchain` class.
+    - The following functions are available:
+        - send_bitcoin
+        - generate_address
+        - list_addresses
+
+
+#### Full Transaction Workflow
+
+```ruby
+
+    require 'bitnob'
+
+    on_chain = Onchain.new(true)
+
+    payload = {
+        customerEmail: "parah@bitnob.com",
+        satoshis: 30000,
+        address: "btcjshlidlsidskdslisidsdosilsdmxksjsjldksossjoioidjifkji.zjijsi",
+        description: "Go buy your momma a house!",
+        priorityLevel: "regular"
+    }
+
+    # Send bitcoin using onchain 
+
+    new_onchain = on_chain.send_bitcoin(payload)
+
+```
+
+### Wallets 
+- To get wallets information, simply follow the instruction at the beginning of this sub-heading and instantiate a new `Wallets` class.
+    - The following functions are available:
+        - fetch_wallets
+        - fetch_all_transactions
+        - fetch_transaction
+
+
+
+### Webhook Authentication
+
+- You simply check to see if your webhook requests returns the appropriate body by simply doing this 
+
+```ruby 
+
+        require 'bitnob'
+
+        check_webhook = webhook_authentication(requests) # return true or false
+```
+
+### Important Note
+
+- it is important that response from each function returns both the response headers, body and status code. To work with only the reponse body simply call the `BODY` object after each function call :
+
+```ruby
+     require 'bitnob'
+
+    wallet = Wallet.new(true) # production
+   get_wallets = wallet.fetch_wallets
+   p get_wallets.body # fetches response body
+   p get_wallets.headers # fetches response headers
+
+
+```
+
+## Development 
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run rake spec 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 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 tags, and push the .gem file to rubygems.org.
+
+
+## Contributing 
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/bitnob/bitnob_ruby_SDK](https://github.com/bitnob/bitnob_ruby_SDK). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct. Simply create a new branch and raise a Pull Request, we would review and merge. 
+
+## License
+
+The gem is available as open source under the terms of the [BSD License](https://opensource.org/licenses/BSD-3-Clause)
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bitnob'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bitnob.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitnob/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bitnob'
+  spec.version       = Bitnob::VERSION
+  spec.authors       = ['Bitnob', 'Nonso Amadi']
+  spec.email         = ['nonso@bitnob.com']
+
+  spec.summary       = 'Bitnob gem for Ruby/Rails'
+  spec.description   = 'Client Library Gem for Bitnob API. Allows integration of Bitnob in your Ruby Applications'
+  spec.homepage      = 'https://github.com/bitnob/bitnob_ruby_SDK'
+  spec.license       = '0BSD'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extra_rdoc_files = ['README.md']
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Dev dependencies
+  spec.add_development_dependency 'bundler', '~> 2.2.27'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.20.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.4.0'
+
+  # Dependencies
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.add_dependency 'dotenv', '~> 2.7'
+  spec.add_dependency 'httparty', '~> 0.19.0'
+end

data/lib/bitnob/errors.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class BitnobServerError < StandardError
+  attr_reader :response
+
+  def initialize(response: nil)
+    @response = response
+  end
+end
+
+class BitnobBadKeyError < StandardError
+end
+
+class PermissionError < StandardError
+end
+
+class BadRequestError < StandardError
+end
+
+class TooManyRequests < StandardError
+end
+
+class NotFoundError < StandardError
+end
+
+class IncompleteParameterError < StandardError
+end
+
+class UnAuthorizedError < StandardError
+end

data/lib/bitnob/modules/base_endpoints.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module BaseEndpoints
+  BITNOB_LIVE_URL = 'https://api.bitnob.co/api/v1'
+  BITNOB_SANDBOX_URL = 'https://sandboxapi.bitnob.co/api/v1'
+  CUSTOMER = '/customers'
+  LN = '/wallets/ln'
+  ONCHAIN = '/wallets'
+  ADDRESS = '/address'
+end

data/lib/bitnob/objects/base/base.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require_relative '../../modules/base_endpoints'
+require 'json'
+require_relative '../../errors'
+
+class Base
+  attr_accessor :secret_key, :production, :url
+
+  def initialize(production = false)
+    # - bitnob api key
+    @secret_key = ENV['BITNOB_API_KEY']
+    bitnob_sandbox_url = BaseEndpoints::BITNOB_SANDBOX_URL
+    bitnob_live_url = BaseEndpoints::BITNOB_LIVE_URL
+
+    # set bitnob url to sandbox or live if we are in production or development
+    @url = if production == false
+             bitnob_sandbox_url
+           else
+             bitnob_live_url
+           end
+
+    def base_url
+      @url
+    end
+
+    if @secret_key.nil?
+      raise BitnobBadKeyError,
+            "No secret key supplied and couldn't find any in environment variables. Make sure to set secret key as an environment variable BITNOB_SECRET_KEY"
+    end
+
+    raise BitnobBadKeyError, "Invalid secret key #{@secret_key}" unless @secret_key[0..2] == 'sk.'
+  end
+
+  # make a get request
+  def get_request(endpoint)
+    response = HTTParty.get(endpoint, headers: { 'Authorization' => "Bearer #{@secret_key}" })
+    begin
+      unless response.code == 200 || response.code == 201
+        raise BitnobServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+
+      raise BitnobServerError.new(response), "Server Message: #{response.message}" unless response.code != 0
+
+      response
+    rescue JSON::ParserError => e
+      raise BitnobServerError.new(response),
+            "Invalid result data. Could not parse JSON response body \n #{e.message}"
+    end
+  end
+
+  # method to make a post request
+  def post_request(endpoint, data)
+    response = HTTParty.post(endpoint, {
+                               body: data,
+                               headers: {
+                                 'Content-Type' => 'application/json',
+                                 'Authorization' => "Bearer #{@secret_key}"
+                               }
+                             })
+
+    unless response.code == 200 || response.code == 201
+      raise BitnobServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+    end
+
+    response
+  end
+
+  # method to make a put request
+  def put_request(endpoint, data)
+    response = HTTParty.put(endpoint, {
+                              body: data,
+                              headers: {
+                                'Content-Type' => 'application/json',
+                                'Authorization' => "Bearer #{@secret_key}"
+                              }
+                            })
+
+    unless response.code == 200 || response.code == 201
+      raise BitnobServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+    end
+
+    response
+  end
+
+  # - Verify that passed parameter contains required parameters
+  def check_parameters(required_params, passed_params)
+    # This is used to check if the passed authorization parameters matches the required parameters
+    required_params.each do |k, _v|
+      unless passed_params.key?(k)
+        raise IncompleteParameterError,
+              "Parameters Incomplete, Missing Parameter: #{k}, Please pass in the complete parameter."
+      end
+    end
+  end
+end

data/lib/bitnob/objects/customer.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'base/base'
+require 'json'
+
+class Customer < Base
+  # -<tt>Required Parameters</tt>
+  #
+  #
+  #      data: {
+  #     firstName: string(required),
+  #     lastName: string(optional),
+  #     email: string(required),
+  #     countryCode: number(+234)(optional),
+  #     phone: number(optional)
+  #        }
+  def create_customer(data)
+    required_parameters = %w[firstName lastName email countryCode phone]
+    check_passed_parameters(required_parameters, data)
+    payload = data.to_json
+
+    post_request("#{base_url}#{BaseEndpoints::CUSTOMER}", payload)
+  end
+
+  # <tt>Required Parameter</tt>
+  #
+  #       email: string
+  def get_customer_by_email(email)
+    body = { 'email' => email }
+    payload = body.to_json
+
+    post_request("#{base_url}#{BaseEndpoints::CUSTOMER}/fetch_customer", payload)
+  end
+
+  # <tt>Required Parameter</tt>
+  #
+  #    customer_id: string
+  def get_customer(customer_id)
+    get_request("#{base_url}#{BaseEndpoints::CUSTOMER}/#{customer_id}")
+  end
+
+  # -<tt>Required Parameters</tt>
+  #
+  #
+  #      data: {
+  #     firstName: string(required),
+  #     lastName: string(optional),
+  #     email: string(required),
+  #     countryCode: number(+234)(optional),
+  #     phone: number(optional)
+  #        }
+  def update_customer(customer_id, data)
+    payload = data.to_json
+
+    put_request("#{base_url}#{BaseEndpoints::CUSTOMER}/#{customer_id}", payload)
+  end
+end

data/lib/bitnob/objects/lightning.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative 'base/base'
+require 'json'
+
+# - Making Payments Via Lightning
+class Lightning < Base
+  # Create Lightning invoice
+  #
+  # - Required Function Parameters:
+  #
+  #
+  #       data: {
+  #    description: string,
+  #    customerEmail: string,
+  #    tokens: number,
+  #    expires_at: string
+  #     }
+  def create_invoice(data)
+    required_parameters = %w[description customerEmail tokens expires_at]
+
+    check_passed_parameters(required_parameters, data)
+    payload = data.to_json
+
+    post_request("#{base_url}#{BaseEndpoints::LN}/createinvoice", payload)
+  end
+
+  # Pay Lightning invoice
+  #
+  # - Required Function Parameters:
+  #
+  #
+  #       data: {
+  #    description: string,
+  #    customerEmail: string,
+  #    request: string,
+  #     }
+
+  def pay_invoice(data)
+    required_parameters = %w[request customerEmail description]
+
+    check_passed_parameters(required_parameters, data)
+    payload = data.to_json
+
+    post_request("#{base_url}#{BaseEndpoints::LN}/pay", payload)
+  end
+
+  # Initiate payment is advised to be run before paying an invoice to calculate fees and check if an invoice has expired.
+  #
+  # - Required Function Parameters:
+  #
+  #    request: string
+
+  def initiate_payment(request)
+    body = { request: request }
+    payload = body.to_json
+
+    post_request("#{base_url}#{BaseEndpoints::LN}/initiatepayment", payload)
+  end
+
+  # Decode a BOLT 11 compliant payment request
+  #
+  # - Required Function Parameters:
+  #
+  #    request: string
+
+  def decode_payment_request(request)
+    body = { request: request }
+    payload = body.to_json
+
+    post_request("#{base_url}#{BaseEndpoints::LN}/decodepaymentrequest", payload)
+  end
+
+  # Getting Lightning invoice data
+  #
+  # - Required Function Parameters:
+  #
+  #    invoice_id: string
+
+  def get_invoice(invoice_id)
+    body = { id: invoice_id }
+    payload = body.to_json
+
+    post_request("#{base_url}#{BaseEndpoints::LN}/getinvoice", payload)
+  end
+end

data/lib/bitnob/objects/onchain.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'base/base'
+require 'json'
+
+# Handles all transactions via Onchain
+class Onchain < Base
+  # Onchain sending of bitcoin
+  #
+  # - Required Function Parameters:
+  #
+  #
+  #       data: {
+  #    satoshis: number,
+  #    customerEmail: string,
+  #    address: string,
+  #    priorityLevel: string
+  #     }
+  #
+  #
+  # - Priority level is used to detect how long a transaction would take. Its default is regular
+  def send_bitcoin(data)
+    required_parameters = %w[satoshis customerEmail address]
+
+    checked_passed_parameters(required_parameters, data)
+    payload = data.to_json
+    post_request("#{base_url}#{BaseEndpoints::ONCHAIN}/send_bitcoin", payload)
+  end
+
+  # Generates a temporary address for onchain transaction
+  #
+  # - Required Function Parameters: <tt>customer_email</tt>
+  def generate_address(customer_email)
+    body = { customerEmail: customer_email }
+    payload = body.to_json
+    post_request("#{base_url}#{BaseEndpoints::ADDRESS}/generate", payload)
+  end
+
+  # Returns a JSON data containing list of addresses
+  #
+  # - Required Function Parameters: <tt>page_number</tt> <tt>limit</tt>
+  #
+  #
+  #     default: <tt>page_number => 1, limit => 10</tt>
+  def list_addresses(page_number: 1, limit: 10)
+    get_request("#{base_url}#{BaseEndpoints::ADDRESS}order=ASC&page=#{page_number}&take=#{limit}")
+  end
+end

data/lib/bitnob/objects/utils.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'digest'
+
+# - Authenticates Webhook Requests
+def webhook_authentication(request)
+  webhook_secret = ENV['BITNOB_WEBHOOK_SECRET']
+  signature = request.headers['x-bitnob-signature']
+  digest = OpenSSL::Digest.new('Digest', 'sha512')
+
+  hash = OpenSSL::HMAC.hexdigest(digest, webhook_secret, request.body)
+  signature == hash
+end

data/lib/bitnob/objects/wallets.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'base/base'
+require 'json'
+
+class Wallets < Base
+  def fetch_wallets
+    get_request("#{base_url}#{BaseEndpoints::ONCHAIN}")
+  end
+
+  # page_number: number, limit: number
+  # default_value: page_number: 1, limit: 10
+  def fetch_all_transactions(page_number: 1, limit: 10)
+    get_request("#{base_url}#{BaseEndpoints::ONCHAIN}?order=ASC&page=#{page_number}&take=#{limit}")
+  end
+
+  # transaction_id: string
+  def fetch_transaction(transaction_id)
+    get_request("#{base_url}#{BaseEndpoints::ONCHAIN}/#{transaction_id}")
+  end
+end

data/lib/bitnob/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Bitnob
+  VERSION = '0.0.3'
+end

data/lib/bitnob.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'bitnob/objects/customer'
+require_relative 'bitnob/objects/utils'
+require_relative 'bitnob/objects/lightning'
+require_relative 'bitnob/objects/onchain'
+require_relative 'bitnob/objects/wallets'
+require_relative 'bitnob/version'
+require_relative 'bitnob/modules/base_endpoints'
+require_relative 'bitnob/errors'

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: bitnob
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Bitnob
+- Nonso Amadi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.27
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.27
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+description: Client Library Gem for Bitnob API. Allows integration of Bitnob in your
+  Ruby Applications
+email:
+- nonso@bitnob.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitnob.gemspec
+- lib/bitnob.rb
+- lib/bitnob/errors.rb
+- lib/bitnob/modules/base_endpoints.rb
+- lib/bitnob/objects/base/base.rb
+- lib/bitnob/objects/customer.rb
+- lib/bitnob/objects/lightning.rb
+- lib/bitnob/objects/onchain.rb
+- lib/bitnob/objects/utils.rb
+- lib/bitnob/objects/wallets.rb
+- lib/bitnob/version.rb
+homepage: https://github.com/bitnob/bitnob_ruby_SDK
+licenses:
+- 0BSD
+metadata:
+  homepage_uri: https://github.com/bitnob/bitnob_ruby_SDK
+  source_code_uri: https://github.com/bitnob/bitnob_ruby_SDK
+  changelog_uri: https://github.com/bitnob/bitnob_ruby_SDK
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Bitnob gem for Ruby/Rails
+test_files: []