fireblocks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15b2538f39f6a45074861bb3d3cc4dbcf807f22e5ad7c0ee567fa6aad15602a0
+  data.tar.gz: 37086db0987726cf43791a51c2437511b01c1bf7e3162a872f80fac7875ec141
+SHA512:
+  metadata.gz: ec0d20c9477cc3f3f766f1007f51b9809b5cbdd78746e81ea61a6e5a9f753d958712fb641537686230f5ca5b55b5e0b337cbfe035e7b7c4adaaae3848185ac1b
+  data.tar.gz: bd855581aa015124ebcf58ef4b0c2755c7fa58138e9e98f8c5cc4aa9d3493fad10d0d18b8abdf5fc944a873d49c627e57a09787eafad715203991d5f94761235

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Bryam Noguera
+
+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,55 @@
+# Fireblocks
+
+The Ruby gem wrapper for Fireblocks! This gem is actively being developed. **Be sure to check the branch for the version you're using.**
+
+## Installation
+
+To install, type:
+
+```
+gem install fireblocks
+```
+
+Add to your `Gemfile`:
+
+```ruby
+gem "fireblocks", "~> 0.1.0"
+```
+
+Run `bundle install`
+
+## Configure
+
+API keys *must* be configured in the gem setup. You can do this anywhere in your application before you make API calls using the gem.
+
+```ruby
+Fireblocks.configure do |config|
+  config.api_key = 'api_key'
+  config.private_key = 'private_key'
+  config.base_url = 'url'
+end
+```
+
+`config.base_url` - the default is set to `'https://api.fireblocks.io'`
+
+## Usage
+
+* Full API documentation for this gem go to [API reference](https://api.fireblocks.io/docs/v1/swagger-ui/).
+* Fireblocks official SDKs can be found [here](https://github.com/fireblocks)
+
+Available methods can be found in `Fireblocks::API`
+
+```
+# To create a vault account
+Fireblocks::API.create_vault_account(name: 'test_name')
+
+# To get all vault accounts
+Fireblocks::API.get_vault_accounts
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+* Please be sure to include tests with your PRs.
+* Run `bundle exec rubocop` to ensure style with the rest of the project

data/lib/fireblocks.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'fireblocks/version'
+require 'fireblocks/configuration'
+require 'fireblocks/api/api'
+require 'fireblocks/api/request'
+require 'fireblocks/api/token'
+
+# Parent module for all classes
+module Fireblocks
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/fireblocks/api/api.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Fireblocks
+  # Namespace to access Fireblocks api methods
+  class API
+    class << self
+      def get_vault_accounts
+        Request.get(path: '/v1/vault/accounts')
+      end
+
+      def create_vault_account(name:)
+        Request.post(body: { name: name }, path: '/v1/vault/accounts')
+      end
+
+      def get_vault_account(id)
+        Request.get(path: "/v1/vault/accounts/#{id}")
+      end
+
+      def update_vault_account(vault_account_id, name:)
+        Request.put(
+          body: { name: name },
+          path: "/v1/vault/accounts/#{vault_account_id}"
+        )
+      end
+
+      def get_vault_account_asset(vault_account_id, asset_id)
+        Request.get(path: "/v1/vault/accounts/#{vault_account_id}/#{asset_id}")
+      end
+
+      def create_vault_account_asset(vault_account_id, asset_id)
+        Request.post(path: "/v1/vault/accounts/#{vault_account_id}/#{asset_id}")
+      end
+
+      def create_deposit_address(vault_account_id, asset_id, description:)
+        Request.post(
+          body: { description: description },
+          path: "/v1/vault/accounts/#{vault_account_id}/#{asset_id}/addresses"
+        )
+      end
+
+      def get_deposit_addressess(vault_account_id, asset_id)
+        Request.get(
+          path: "/v1/vault/accounts/#{vault_account_id}/#{asset_id}/addresses"
+        )
+      end
+
+      def get_internal_wallet(wallet_id)
+        Request.get(path: "/v1/internal_wallets/#{wallet_id}")
+      end
+
+      def get_internal_wallets
+        Request.get(path: '/v1/internal_wallets')
+      end
+
+      def create_internal_wallet(name:)
+        Request.post(body: { name: name }, path: '/v1/internal_wallets')
+      end
+
+      def get_supported_assets
+        Request.get(path: '/v1/supported_assets')
+      end
+    end
+  end
+end

data/lib/fireblocks/api/request.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Fireblocks
+  # Interface to GET, POST, PUT
+  class Request
+    Error = Class.new(StandardError)
+    class << self
+      def get(path:, body: '')
+        new(path: path).get(body)
+      end
+
+      def put(path:, body:)
+        new(path: path).put(body)
+      end
+
+      def post(path:, body:)
+        new(path: path).post(body)
+      end
+    end
+
+    attr_accessor :path, :uri
+
+    def initialize(path:)
+      @path = path
+      @uri = URI("#{Fireblocks.configuration.base_url}#{path}")
+    end
+
+    def get(body)
+      req = Net::HTTP::Get.new(uri)
+      request_headers(body).each { |rk, rv| req[rk] = rv }
+
+      valid_response!(send_request(req))
+    end
+
+    def put(body)
+      req = Net::HTTP::Put.new(uri)
+      request_headers(body).each { |rk, rv| req[rk] = rv }
+      req.body = body.to_json
+
+      valid_response!(send_request(req))
+    end
+
+    def post(body)
+      req = Net::HTTP::Post.new(uri)
+      request_headers(body).each { |rk, rv| req[rk] = rv }
+      req.body = body.to_json
+
+      valid_response!(send_request(req))
+    end
+
+    private
+
+    def request_headers(body)
+      {
+        'X-API-Key' => Fireblocks.configuration.api_key,
+        'Authorization' => "Bearer #{token(body)}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def send_request(request)
+      Net::HTTP.start(
+        uri.hostname, uri.port, use_ssl: true
+      ) { |http| http.request(request) }
+    end
+
+    def token(body)
+      Token.call(body, uri)
+    end
+
+    def valid_response!(req_response)
+      resp = JSON.parse(req_response.body)
+      return resp if req_response.message == 'OK'
+
+      raise Error, resp
+    end
+  end
+end

data/lib/fireblocks/api/token.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'jwt'
+require 'openssl'
+
+module Fireblocks
+  # This class will issue a new Fireblocks token
+  class Token
+    class << self
+      def call(body, uri)
+        new(body, uri).call
+      end
+    end
+
+    attr_accessor :body, :uri
+
+    def initialize(body, uri)
+      @body = body
+      @uri = uri
+    end
+
+    def created_at
+      Time.now.to_i
+    end
+
+    def expire_at
+      Time.now.to_i + 60
+    end
+
+    def call
+      JWT.encode jwt_headers, rsa_private, 'RS256', typ: 'JWT'
+    end
+
+    def body_hash
+      Digest::SHA256.hexdigest(body.to_json)
+    end
+
+    def decode_token
+      JWT.decode token, rsa_private.public_key, true, algorithm: 'RS256'
+    end
+
+    def jwt_headers
+      {
+        uri: uri.request_uri,
+        nonce: nonce,
+        iat: created_at,
+        exp: expire_at,
+        sub: Fireblocks.configuration.api_key,
+        bodyHash: body_hash
+      }
+    end
+
+    def nonce
+      Time.now.to_i * 1000
+    end
+
+    def rsa_private
+      OpenSSL::PKey::RSA.new(Fireblocks.configuration.private_key)
+    end
+  end
+end

data/lib/fireblocks/configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Global configuration settings for the gem
+module Fireblocks
+  #
+  # base_url is set to a default but can be configured
+  #
+  class Configuration
+    Error = Class.new(StandardError)
+    attr_writer :api_key, :private_key
+    attr_accessor :base_url
+
+    def initialize
+      @api_key = nil
+      @private_key = nil
+      @base_url = 'https://api.fireblocks.io'
+    end
+
+    def api_key
+      message =
+        'Fireblocks api key not set. See Fireblocks documentation ' \
+        'to get a hold of your api key'
+      raise Error, message unless @api_key
+
+      @api_key
+    end
+
+    def private_key
+      message =
+        'Fireblocks private key not set. See Fireblocks documentation ' \
+        'to get a hold of your private key'
+      raise Error, message unless @private_key
+
+      @private_key
+    end
+  end
+end

data/lib/fireblocks/version.rb

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

data/test/fireblocks/configuration_test.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class FireblocksConfiguration < Minitest::Test
+  describe Fireblocks::Configuration do
+    let(:new_base_url) { 'example.com' }
+
+    describe 'with configuration block' do
+      before do
+        # To get unique jwt headers for fast requests, add a sleep
+        sleep(1)
+
+        Fireblocks.configure do |config|
+          config.api_key = ENV['FIREBLOCKS_API_KEY']
+          config.private_key = ENV['FIREBLOCKS_PRIVATE_KEY']
+        end
+      end
+
+      def test_it_returns_api_key
+        assert_equal Fireblocks.configuration.api_key, ENV['FIREBLOCKS_API_KEY']
+      end
+
+      def test_it_returns_private_key
+        assert_equal(
+          Fireblocks.configuration.private_key, ENV['FIREBLOCKS_PRIVATE_KEY']
+        )
+      end
+
+      def test_it_resassigns_base_url
+        Fireblocks.configure { |config| config.base_url = new_base_url }
+        assert_equal Fireblocks.configuration.base_url, new_base_url
+      end
+    end
+
+    describe 'without configuration keys' do
+      before do
+        Fireblocks.reset
+      end
+
+      def test_it_raises_api_key_error
+        assert_raises(Fireblocks::Configuration::Error) do
+          Fireblocks.configuration.api_key
+        end
+      end
+
+      def test_it_raises_private_key_error
+        assert_raises(Fireblocks::Configuration::Error) do
+          Fireblocks.configuration.private_key
+        end
+      end
+    end
+  end
+end

data/test/fireblocks/fireblocks_test.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class FireblocksAPI < Minitest::Test
+  describe Fireblocks::API do
+    describe 'send GET Fireblocks requests' do
+      let(:vault_name) { 'test_vault' }
+
+      before do
+        # To get unique jwt headers for fast requests, add a sleep
+        sleep(1)
+
+        Fireblocks.reset
+        Fireblocks.configure do |config|
+          config.api_key = ENV['FIREBLOCKS_API_KEY']
+          config.private_key = ENV['FIREBLOCKS_PRIVATE_KEY']
+        end
+      end
+
+      def test_create_vault_account
+        vault_account = Fireblocks::API.create_vault_account(name: vault_name)
+        assert_equal vault_account['name'], vault_name
+      end
+
+      def test_get_vault_accounts
+        Fireblocks::API.create_vault_account(name: vault_name)
+        sleep(1)
+        vault_accounts = Fireblocks::API.get_vault_accounts
+        refute_empty vault_accounts
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'fireblocks'
+require 'pry-byebug'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: fireblocks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryam Noguera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+description: 
+email:
+- bryamnoguera@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/fireblocks.rb
+- lib/fireblocks/api/api.rb
+- lib/fireblocks/api/request.rb
+- lib/fireblocks/api/token.rb
+- lib/fireblocks/configuration.rb
+- lib/fireblocks/version.rb
+- test/fireblocks/configuration_test.rb
+- test/fireblocks/fireblocks_test.rb
+- test/test_helper.rb
+homepage: https://github.com/csebryam/fireblocks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Fireblocks API
+test_files:
+- test/fireblocks/fireblocks_test.rb
+- test/fireblocks/configuration_test.rb
+- test/test_helper.rb