btcpay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 765581c5e126ca0ebd973fb76637dac51de61eb28856a2a5f2e6d9517fb1fc2e
+  data.tar.gz: 37787c831f8e977971c70c1d7a9d973e5685e302b1fce04a84fd92f542607cee
+SHA512:
+  metadata.gz: b0ce38e683b4901c69de9565713d7d839f80d1ea5b3c8f6a3f0dc235e52f032d05d8d37ebf8534b7cb3ad4399e4ad236b4b50cfcb8ab93f4b7244ce071997a0e
+  data.tar.gz: 9e5c178330d04034fe1ee4442457a30f72a94c657c20bec428f189db51db2afe7cd9a5ec4fc5a19d50cb07bceb25ff127b7a61fd052a872a2c083e1823814dc3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+coverage
+.DS_Store
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'bin/**/*'
+Documentation:
+  Enabled: false
+LineLength:
+  Max: 120
+Style/RaiseArgs:
+  EnforcedStyle: compact
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 25
+Lint/Debugger:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in btcpay.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    btcpay (0.1.0)
+      activesupport (> 5)
+      multi_json (~> 1.15)
+      rest-client (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
+    multi_json (1.15.0)
+    netrc (0.11.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.7.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
+    vcr (6.0.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  btcpay!
+  bundler (~> 2.0)
+  factory_bot (~> 6.1)
+  pry (> 0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (> 0)
+  simplecov (> 0)
+  vcr (~> 6.0)
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ZippyDev
+
+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,159 @@
+# Btcpay Server
+
+[BTCPay Server Api Client](https://btcpayserver.org/)
+
+[BTCPay Server is a free and open-source cryptocurrency payment processor which allows you to receive payments in Bitcoin and altcoins directly, with no fees, transaction cost or a middleman.](https://docs.btcpayserver.org/API/Greenfield/v1/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'btcpay'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install btcpay
+
+## Usage
+
+#### Required Params
+
+##### Auth Token
+
+At least one of the following auth tokens are required. Auth tokens can be created via the following:
+
+1. `auth_token`
+
+  - Scoped Api Tokens can be created via `/Manage/APIKeys`
+
+  - `BTCPAY_AUTH_TOKEN` environment variable can also be used
+
+1. `basic_auth_token`
+
+  - Legacy Api Key can be created per store via `/stores/{store-id}/Tokens`
+
+  - `BTCPAY_BASIC_AUTH_TOKEN` environment variable can also be used
+
+##### Base Url
+
+A `base_url` is required to interact with the server.
+  - `BTCPAY_BASE_URL` environment variable can also be used
+
+```ruby
+client = BtcPay.new(auth_token: 'foobar', base_url: 'http://localhost:49392')
+```
+
+### Response
+
+A response consists of the following accessible attributes:
+
+1. `#body` - rubified response body
+1. `#code` - response status code
+1. `#headers` - response headers
+1. `#raw` - unaltered response body
+1. `#status` - `:success`/`:failure`
+
+### Request object types
+
+All endpoints are accessed via namespaced Api resource. Example: `client.users.create({ email: 'foo@bar.com', password: 'password', isAdministrator: false })`
+
+#### Api Keys:
+
+1. `GET #current`
+1. `POST #create(payload)`
+1. `DELETE #revoke(key)`
+1. `DELETE #revoke!`
+
+#### Health:
+
+1. `GET #status`
+
+#### Lightning:
+
+1. TODO - Set up local lightning network, testing, etc.
+
+#### Pull Payments:
+
+1. `GET #get(pull_payment_id)`
+1. `GET #payouts`
+1. `POST #create_payout(pull_payment_id, payload)`
+
+#### Server:
+
+1. `GET #info`
+
+#### Store:
+
+- ##### Payment Requests:
+
+1. `GET #all(store_id)`
+1. `POST #create(store_id, payload)`
+1. `GET #get(store_id, request_id)`
+1. `DELETE #delete(store_id, request_id)`
+1. `PUT #update(store_id, request_id, payload)`
+
+- ##### Payouts:
+
+1. `POST #approve(store_id, payout_id, payload)`
+1. `DELETE #delete(store_id, payout_id)`
+
+- ##### Pull Payments:
+
+1. `GET #all(store_id)`
+1. `POST #create(store_id, payload)`
+1. `DELETE #delete(store_id, pull_payment_id)`
+
+#### Users:
+
+1. `GET #me`
+1. `POST #create(payload)`
+
+## Request helpers
+
+#### Api Keys:
+
+- ##### Authorize
+
+1. `GET #html(permissions: [], application_name:, strict: true, selective_stores: false)`
+1. `#link(permissions: [], application_name:, strict: true, selective_stores: false)`
+
+### Environment Variables
+
+`btcpay` can be initialized with either arguments or ENV:
+
+| Variable                  |  Description            | Default  |
+| --------------------------|:------------------------|:--------:|
+| `BTCPAY_AUTH_TOKEN`       | BtcPay Auth Token       |    -     |
+| `BTCPAY_BASIC_AUTH_TOKEN` | BtcPay Basic Auth Token |    -     |
+| `BTCPAY_BASE_URL`         | BtcPay Base Url         |    -     |
+
+### BtcPay Docker Compose
+
+To get up and running locally quickly, a [BTCPayServer]((https://docs.btcpayserver.org/)) docker-compose file has been added to test local API interactions. To get up and running:
+
+1. `$ docker-compose -f docker-compose.btcpay.yml up`
+1. `$ open http://localhost:49392`
+  - Note: [`regtest`](https://bisq.network/blog/how-to-set-up-bitcoin-regtest/) environment default to allow for block/coin creation for test purpose
+  - `testnet` environment should be used for integration/staging testing prior to production promotion.
+  - `mainnet` is the **real** network.
+
+## 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 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/snogrammer/btcpay.
+
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'btcpay'
+
+# 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.
+
+require 'pry'
+Pry.start

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/btcpay.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/btcpay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'btcpay'
+  spec.version       = BtcPay::VERSION
+  spec.authors       = ['snogrammer']
+  spec.email         = ['btcpay-gem@snogram.com']
+
+  spec.summary       = 'BTCPay Server v1 API wrapper. Be your own Bitpay!'
+  spec.homepage      = 'https://docs.btcpayserver.org/API/Greenfield/v1/'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/snogrammer/btpay'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/snogrammer/btpay/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '> 5'
+  spec.add_dependency 'multi_json', '~> 1.15'
+  spec.add_dependency 'rest-client', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'factory_bot', '~> 6.1'
+  spec.add_development_dependency 'pry', '> 0'
+  spec.add_development_dependency 'rubocop', '> 0'
+  spec.add_development_dependency 'simplecov',  '> 0'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.8'
+end

data/docker-compose.btcpay.yml

@@ -0,0 +1,139 @@
+version: "3"
+
+services:
+  # Bitcoin daemon for blockchain transaction data
+  bitcoind:
+    container_name: bitcoind
+    restart: unless-stopped
+    image: btcpayserver/bitcoin:0.19.0.1
+    environment:
+      BITCOIN_NETWORK: regtest
+      BITCOIN_EXTRA_ARGS: |
+        debug=1
+        regtest=1
+        server=1
+        rpcport=43782
+        rpcbind=0.0.0.0:43782
+        port=39388
+        whitelist=0.0.0.0/0
+        rpcuser=rpcuser
+        rpcpassword=rpcpassword
+    expose:
+      - "43782" # rpc port
+      - "39388" # bitcoin node can communicate
+    ports:
+      - "43782:43782"
+      - "39388:39388"
+    volumes:
+      - "bitcoind_data:/data"
+
+  # Blockchain explorer
+  nbxplorer:
+    container_name: nbxplorer
+    restart: unless-stopped
+    image: nicolasdorier/nbxplorer:2.1.34
+    ports:
+      - "32838:32838"
+    environment:
+      NBXPLORER_NETWORK: regtest
+      NBXPLORER_BIND: 0.0.0.0:32838
+      NBXPLORER_SIGNALFILEDIR: /datadir
+      NBXPLORER_NOAUTH: 1
+      NBXPLORER_CHAINS: btc
+      NBXPLORER_BTCRPCURL: http://bitcoind:43782/
+      NBXPLORER_BTCRPCUSER: rpcuser
+      NBXPLORER_BTCRPCPASSWORD: rpcpassword
+      NBXPLORER_BTCNODEENDPOINT: bitcoind:39388
+    volumes:
+      - "bitcoind_data:/root/.bitcoin"
+      - "nbxplorer_data:/datadir"
+    links:
+      - bitcoind
+
+  btcpay:
+    container_name: btcpay
+    restart: unless-stopped
+    image: btcpayserver/btcpayserver:1.0.5.2
+    ports:
+      - "49392:49392"
+    environment:
+      BTCPAY_BIND: 0.0.0.0:49392
+      BTCPAY_POSTGRES: User ID=user;Password=password;Host=btcpay_db;Port=5432;Database=btcpay_regtest
+      BTCPAY_NETWORK: regtest
+      BTCPAY_CHAINS: btc
+      BTCPAY_ROOTPATH: /
+      BTCPAY_BTCEXPLORERURL: http://nbxplorer:32838/
+      BTCPAY_DEBUGLOG: btcpay.log
+      # https://docs.btcpayserver.org/LightningNetwork/#choosing-the-lightning-network-implementation
+      # BTCPAYGEN_LIGHTNING: clightning
+      # BTCPAYGEN_LIGHTNING: lnd
+    volumes:
+     - "btcpay_data:/datadir"
+     - "nbxplorer_data:/root/.nbxplorer"
+    links:
+      - btcpay_db
+      - bitcoind
+      - nbxplorer
+      # - lightningd
+      # - lnd
+
+  # lnd:
+  #   image: lightningnetwork/lnd-alpine
+  #   container_name: lnd
+  #   environment:
+  #     RPCHOST: bitcoind
+  #     RPCUSER: rpcuser
+  #     RPCPASS: rpcpassword
+  #     DEBUG: debug
+  #     NETWORK: regtest
+  #   volumes:
+  #     - bitcoind_data:/rpc
+  #     - lnd_data:/root/.lnd
+  #   links:
+  #     - bitcoind
+
+  # lightningd:
+  #   image: elementsproject/lightningd
+  #   container_name: lightningd
+  #   command:
+  #     - --bitcoin-rpcconnect=bitcoind
+  #     - --bitcoin-rpcuser=rpcuser
+  #     - --bitcoin-rpcpassword=rpcpassword
+  #     - --bitcoin-rpcport=43782
+  #     - --network=regtest
+  #     - --alias=lightningdnode
+  #     - --log-level=debug
+  #   environment:
+  #     EXPOSE_TCP: "true"
+  #   expose:
+  #     - "9735"
+  #   ports:
+  #     - "0.0.0.0:9735:9735"
+  #   volumes:
+  #     - "lightningd_data:/root/.lightning"
+  #     - "bitcoind_data:/etc/bitcoin"
+  #   links:
+  #     - bitcoind
+
+  btcpay_db:
+    container_name: btcpay_db
+    restart: unless-stopped
+    image: postgres:11.5-alpine
+    environment:
+      POSTGRES_USER: user
+      POSTGRES_PASSWORD: password
+      POSTGRES_MULTIPLE_DATABASES: blocklux_development,btcpay_regtest
+    ports:
+      - "54321:5432"
+    volumes:
+      - /usr/local/var/postgres/data:/var/lib/postgresql/data
+      - /usr/local/var/postgres/docker/multi-db-entrypoint:/docker-entrypoint-initdb.d
+
+volumes:
+  bitcoind_data:
+  btcpay_data:
+  # lightningd_data:
+  # lnd_data:
+  nbxplorer_data:
+
+networks: {}