coinbase-custody-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52668c29e8449e04ca1db45140c9789c3f6c6703a8d22cf81311ac449d5944f6
+  data.tar.gz: 440abb3989668b9324a844a67aebcdd794735c3dc9e2a2ea04f50ea43bb3ea38
+SHA512:
+  metadata.gz: 5b90fc6dd8f90d57f708063e585054b77129cbb56579c59008605a4058d8ac122a67d615acd08a5de0a614954cbbfcc857752d94ab47b6246d3d09487f7c1f84
+  data.tar.gz: 9889f3ddec10a5679eff629797811c289daf735371b0ff62b3df4e45b68bbb5d8b43948fa3794bfae2282e4c770e083e8cd37c03f5c78c12286bbfb941d4aa18

data/lib/coinbase_custody/address_book.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module CoinbaseCustody
+  # AddressBook API
+  class AddressBook < Client
+    ADDRESS_BOOK_PATH = '/address_book'
+
+    # Gets a list of address book addresses
+    #
+    # Retrieve a list of addresses in your organization's address book
+    # The response value can be filtered by query parameters.
+    # @params [String] currency optional the currency to filter
+    # @params [String] account_identifier optional the account identifier to
+    # filter by
+    # @params [String] name optional The name to filter by
+    # @params [String] address optional the address to filter
+    # @return [Hash] a hash with status code and organization's address book
+    def list(params = {})
+      format_response(get(ADDRESS_BOOK_PATH, query: params))
+    end
+
+    # Creates a new address book address
+    #
+    # Request a new address be added to your organization's address book
+    # @params [String] currency required The currency of the new allowed address
+    # @params [String] account_identifier required The name of the
+    # new allowed address
+    # @params [String] name required The crypto address of the
+    # new allowed address
+    # @params [String] address optional The account identifier of the new
+    # allowed address
+    # @return [Hash] a hash with status code and address detail
+    def create(address_book_details)
+      format_response(post(ADDRESS_BOOK_PATH, body: address_book_details))
+    end
+  end
+end

data/lib/coinbase_custody/addresses.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CoinbaseCustody
+  # Addresses APIs
+  class Addresses < Client
+    ADDRESSES_PATH = '/addresses'
+    # Get a list of all crypto addresses associated with the account.
+
+    # @params [String] wallet_id
+    # @params [String] currency
+    # @params [String] state e.g cold, restore_in_progress, restored
+    # @return [Hash] list of addresses
+    def list(params = {})
+      format_response(get(ADDRESSES_PATH, query: params))
+    end
+
+    # Gets a single address.
+
+    # @params [String] address
+    # @return [Hash] address details
+    def fetch(address)
+      format_response(get("#{ADDRESSES_PATH}/#{address}"))
+    end
+  end
+end

data/lib/coinbase_custody/client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+module CoinbaseCustody
+  # Client
+  class Client
+    include Util
+
+    def initialize
+      @url = COINBASE_CUSTODY_CONFIG[:url]
+      @access_key = COINBASE_CUSTODY_CONFIG[:api_access_key]
+      @passphrase = COINBASE_CUSTODY_CONFIG[:passphrase]
+      [@url, @access_key, @passphrase].each do |opt|
+        raise 'Missing coinbase custody credentials' if opt.blank?
+      end
+    end
+
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        'Cb-Access-Key' => @access_key,
+        'Cb-Access-Passphrase' => @passphrase
+      }
+    end
+
+    def http_request(request_params: {}, body: nil)
+      request_params.merge!(headers: headers)
+      request_params.merge!(body: body.to_json) if body.present?
+      yield(request_params) if block_given?
+    end
+
+    def get(path, params = {})
+      http_request(request_params: params) do |request_params|
+        HTTParty.get("#{@url}#{path}", request_params)
+      end
+    end
+
+    def post(path, body: nil)
+      http_request(body: body) do |request_params|
+        HTTParty.post("#{@url}#{path}", request_params)
+      end
+    end
+  end
+end

data/lib/coinbase_custody/transactions.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module CoinbaseCustody
+  # Coinbase Transaction APIs
+  class Transactions < Client
+    TRANSACTIONS_PATH = '/transactions'
+
+    # Retrieve a list of the transactions from organization.
+    # The response is filterable by query parameters.
+    #
+    # @param     [Hash]   The hash with the following parameters
+    # currency   [String] The type of currency to filter.
+    # state      [String] The state of transactions to filter.
+    # type       [String] The type of transactions to filter.
+    # wallet_id  [String] The wallet id to filter.
+    # start_time [String] The start time to filter.
+    # end_time   [String] The end time to filter.
+    # human_id   [String] The human id to filter.
+    # before     [String] Request page before (newer) this
+    # pagination id (optional).
+    # after      [String] Request page after (older) this pagination id
+    # (optional).
+    # limit      [Integer] Number of results per request.
+    # @return [Hash] a list of transactions records.
+    def list(params = {})
+      format_response(get(TRANSACTIONS_PATH, query: params))
+    end
+
+    # Gets a single transaction by id
+    #
+    # @param id [String] The transaction id to retrieve
+    # @return [Hash] The information about a single transaction
+    # from organization.
+    def fetch(transaction_id)
+      format_response(get("#{TRANSACTIONS_PATH}/#{transaction_id}"))
+    end
+
+    # Creates a new withdrawal transaction
+    #
+    # @param params      [Hash]   The hash with the following parameters
+    # body               [Object] The create transaction payload
+    # source             [String] The source wallet id for the transaction
+    # currency           [String] A fiat currency symbol such as USD.
+    # If provided Custody will automatically convert the amount value
+    # into crypto units.
+    # whole_amount       [String] The amount of the transaction in
+    # whole units (e.g. "1.01")
+    # destination        [String] The destination address of the transaction
+    # account_identifier [String] The account identifier of the transaction
+    # (for example destination tag or memo value)
+    # @return [Hash] Created transaction record
+    def create(params = {})
+      format_response(post(TRANSACTIONS_PATH, body: params))
+    end
+  end
+end

data/lib/coinbase_custody/util.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module CoinbaseCustody
+  # Utility file for general methods
+  module Util
+    BASE_API_URL = COINBASE_CUSTODY_CONFIG[:url]
+
+    def send_request(path)
+      headers = {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json',
+        'User-Agent' => 'request'
+      }
+      response = HTTParty.get("#{BASE_API_URL}#{path}", headers: headers)
+      format_response(response)
+    end
+
+    def format_response(response)
+      {
+        status: response.code,
+        result: (JSON.parse(response.body) rescue response.body),
+        pagination: pagination_params(response.headers)
+      }
+    end
+
+    def pagination_params(headers = {})
+      if headers['cb-before'].blank? || headers['cb-after'].blank?
+        return {}
+      end
+
+      { before: headers['cb-before'], after: headers['cb-after'] }
+    end
+  end
+end

data/lib/coinbase_custody/wallets.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module CoinbaseCustody
+  # Wallets API's
+  class Wallets < Client
+    WALLETS_PATH = '/wallets'
+
+    # Gets a list of wallets
+    #
+    # Retrieve a list of your organization's wallets.
+    # The response value can be filtered by query parameters.
+    # @params [String] currency optional the currency to filter
+    # @return [Hash] a hash with status code and organization's wallets
+    def list(params = {})
+      format_response(get(WALLETS_PATH, query: params))
+    end
+
+    # Creates a new wallet
+    #
+    # Request a new wallet be created for your organization
+    # The response value can be filtered by query parameters.
+    # @params [String] currency required the currency
+    # @params [String] name required the name for wallet
+    # @return [Hash] a hash with status code and wallet creation detail such as
+    # apporval_url, currency, name, activity_id
+    def create(wallet_details)
+      format_response(post(WALLETS_PATH, body: wallet_details))
+    end
+
+    # fetch a specific wallet by id
+    #
+    # Retrieve information about an individual wallet for your organization.
+    # @params [String] wallet id
+    # @return [Hash] a hash with status code and wallet details
+    def fetch(wallet_id)
+      format_response(get("#{WALLETS_PATH}/#{wallet_id}"))
+    end
+  end
+end

data/lib/coinbase_custody.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'coinbase_custody/util'
+require 'coinbase_custody/client'
+require 'coinbase_custody/addresses'
+require 'coinbase_custody/address_book'
+require 'coinbase_custody/transactions'
+require 'coinbase_custody/wallets'
+
+# Coinbase base module
+module CoinbaseCustody
+end

data/lib/generators/coinbase_custody/initialize_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+module CoinbaseCustody
+  module Generators
+    # YML file generator
+    class InitializeGenerator < Rails::Generators::Base
+      def create_initializer_file
+        yaml_file = {
+          development: {
+            url: '',
+            api_access_key: '',
+            passphrase: ''
+          }
+        }
+
+        create_file 'config/coinbase_custody.yml', yaml_file.to_yaml
+        create_file 'config/initializers/coinbase_custody.rb', "COINBASE_CUSTODY_CONFIG = YAML.load_file(Rails.root.join('config', 'coinbase_custody.yml'))"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: coinbase-custody-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: rubocop-airbnb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+description: Ruby coinbase custody APIs wrapper
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/coinbase_custody.rb
+- lib/coinbase_custody/address_book.rb
+- lib/coinbase_custody/addresses.rb
+- lib/coinbase_custody/client.rb
+- lib/coinbase_custody/transactions.rb
+- lib/coinbase_custody/util.rb
+- lib/coinbase_custody/wallets.rb
+- lib/generators/coinbase_custody/initialize_generator.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Ruby coinbase custody APIs wrapper
+test_files: []