btcpay 0.1.0

data/lib/btcpay.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'btcpay/version'
+
+require 'btcpay/client/config'
+require 'btcpay/client/base'
+
+module BtcPay
+  class Error < StandardError; end
+
+  module_function
+
+  def new(**args)
+    config = BtcPay::Client::Config.new(**args)
+    BtcPay::Client::Base.new(config: config, **args)
+  end
+end

data/lib/btcpay/client/api/api_keys.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class ApiKeys < Base
+        PATH = '/api-keys'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1current/get
+        def current(**opts)
+          client.get(path('current'), options: opts)
+        end
+
+        alias get current
+        alias info current
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys/post
+        def create(payload, **opts)
+          client.post(path, payload: payload, options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1{apikey}/delete
+        def revoke(key, **opts)
+          client.delete(path(key), options: opts)
+        end
+
+        alias delete revoke
+
+        # https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1current/delete
+        def revoke!(**opts)
+          client.delete(path('current'), options: opts)
+        end
+
+        alias delete! revoke!
+
+        protected
+
+        def set_base_path
+          @base_path = PATH
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../service'
+
+module BtcPay
+  module Client
+    module Api
+      class Base < Client::Service
+        require_relative './api_keys'
+        require_relative './health'
+        require_relative './lightning_node'
+        require_relative './pull_payments'
+        require_relative './server'
+        require_relative './store'
+        require_relative './store_payment_requests'
+        require_relative './store_payouts'
+        require_relative './store_pull_payments'
+        require_relative './users'
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/health.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class Health < Base
+        PATH = '/health'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Health_GetHealth
+        def status(**opts)
+          client.get(path, options: opts)
+        end
+
+        alias get status
+        alias info status
+
+        protected
+
+        def set_base_path
+          @base_path = PATH
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/lightning_node.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class LightningNode < Base
+        PATH = '/server/lightning/'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Lightning-(Internal-Node)
+        def info(crypto_code, **opts)
+          client.get(path(crypto_code, 'info'), options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/InternalLightningNodeApi_ConnectToNode
+        def connect(crypto_code, payload, **opts)
+          client.post(path(crypto_code, 'connect'), payload: payload, options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/InternalLightningNodeApi_GetChannels
+        def channels(crypto_code, **opts)
+          client.get(path(crypto_code, 'channels'), options: opts)
+        end
+
+        alias get_channels channels
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/InternalLightningNodeApi_OpenChannel
+        def open(crypto_code, payload, **opts)
+          client.post(path(crypto_code, 'channels'), payload: payload, options: opts)
+        end
+
+        alias open_channels open
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/InternalLightningNodeApi_GetDepositAddress
+        def deposit_address(crypto_code, payload, **opts)
+          client.post(path(crypto_code, 'address'), payload: payload, options: opts)
+        end
+
+        alias address deposit_address
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/InternalLightningNodeApi_GetInvoice
+        def invoice(crypto_code, invoice_id, **opts)
+          client.get(path(crypto_code, 'invoices', invoice_id), options: opts)
+        end
+
+        alias get_invoice invoice
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/InternalLightningNodeApi_PayInvoice
+        def pay(crypto_code, payload, **opts)
+          client.post(path(crypto_code, 'invoices', 'pay'), payload: payload, options: opts)
+        end
+
+        alias pay_invoice pay
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/InternalLightningNodeApi_CreateInvoice
+        def create_invoice(crypto_code, payload, **opts)
+          client.post(path(crypto_code, 'invoices'), payload: payload, options: opts)
+        end
+
+        protected
+
+        def set_base_path
+          @base_path = PATH
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/pull_payments.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class PullPayments < Base
+        PATH = 'pull-payments'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Public)/paths/~1api~1v1~1pull-payments~1{pullPaymentId}/get
+        def get(pull_payment_id, **opts)
+          client.get(path(pull_payment_id), options: opts)
+        end
+
+        alias find get
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Public)/paths/~1api~1v1~1pull-payments~1{pullPaymentId}~1payouts/get
+        def payouts(pull_payment_id, **opts)
+          client.get(path(pull_payment_id, 'payouts'), options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Public)/paths/~1api~1v1~1pull-payments~1{pullPaymentId}~1payouts/post
+        def create_payout(pull_payment_id, payload, **opts)
+          client.post(path(pull_payment_id, 'payouts'), payload: payload, options: opts)
+        end
+
+        protected
+
+        def set_base_path
+          @base_path = PATH.dup
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/server.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class Server < Base
+        PATH = '/server'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Health_GetHealth
+        def info(**opts)
+          client.get(path('info'), options: opts)
+        end
+
+        protected
+
+        def set_base_path
+          @base_path = PATH
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/store.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class Store < Base
+        PATH = '/stores'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_GetStores
+        def all(**opts)
+          client.get(path, options: opts)
+        end
+
+        alias stores all
+        alias index all
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores/post
+        def create(payload, **opts)
+          client.post(path, payload: payload, options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_GetStore
+        def get(store_id, **opts)
+          client.get(path(store_id), options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_UpdateStore
+        def update(store_id, payload, **opts)
+          client.put(path(store_id), payload: payload, options: opts)
+        end
+
+        alias put update
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores~1{storeId}/delete
+        def delete(store_id, **opts)
+          client.delete(path(store_id), options: opts)
+        end
+
+        ##
+        # services
+        ##
+        def payment_requests
+          @payment_requests ||= Api::StorePaymentRequests.new(client: client)
+        end
+
+        def payouts
+          @payouts ||= Api::StorePayouts.new(client: client)
+        end
+
+        def pull_payments
+          @pull_payments ||= Api::StorePullPayments.new(client: client)
+        end
+
+        protected
+
+        def set_base_path
+          @base_path = PATH
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/store_payment_requests.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class StorePaymentRequests < Base
+        PATH = '/stores/:store_id/payment-requests'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_GetPaymentRequests
+        def all(store_id, **opts)
+          client.get(store_path(store_id), options: opts)
+        end
+
+        alias index all
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_CreatePaymentRequest
+        def create(store_id, payload, **opts)
+          client.post(store_path(store_id), payload: payload, options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_GetPaymentRequests
+        def get(store_id, request_id, **opts)
+          client.get(store_path(store_id, request_id), options: opts)
+        end
+
+        alias find get
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_ArchivePaymentRequest
+        def delete(store_id, request_id, **opts)
+          client.delete(store_path(store_id, request_id), options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_ArchivePaymentRequest
+        def update(store_id, request_id, payload, **opts)
+          client.put(store_path(store_id, request_id), payload: payload, options: opts)
+        end
+
+        protected
+
+        def set_base_path
+          @base_path = PATH.dup
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/store_payouts.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class StorePayouts < Base
+        PATH = '/stores/:store_id/payouts'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#/paths/~1api~1v1~1stores~1{storeId}~1payouts~1{payoutId}/post
+        def approve(store_id, payout_id, payload, **opts)
+          client.post(store_path(store_id, payout_id), payload: payload, options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Management)/paths/~1api~1v1~1stores~1{storeId}~1payouts~1{payoutId}/delete
+        def delete(store_id, payout_id, **opts)
+          client.delete(store_path(store_id, payout_id), options: opts)
+        end
+
+        alias cancel delete
+
+        protected
+
+        def set_base_path
+          @base_path = PATH.dup
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/store_pull_payments.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class StorePullPayments < Base
+        PATH = '/stores/:store_id/pull-payments'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Management)/paths/~1api~1v1~1stores~1{storeId}~1pull-payments/get
+        def all(store_id, **opts)
+          client.get(store_path(store_id), options: opts)
+        end
+
+        alias index all
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/PaymentRequests_CreatePaymentRequest
+        def create(store_id, payload, **opts)
+          client.post(store_path(store_id), payload: payload, options: opts)
+        end
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Pull-payments-(Management)/paths/~1api~1v1~1stores~1{storeId}~1pull-payments~1{pullPaymentId}/delete
+        def delete(store_id, pull_payment_id, **opts)
+          client.delete(store_path(store_id, pull_payment_id), options: opts)
+        end
+
+        protected
+
+        def set_base_path
+          @base_path = PATH.dup
+        end
+      end
+    end
+  end
+end

data/lib/btcpay/client/api/users.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Api
+      class Users < Base
+        PATH = '/users'
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Users_GetCurrentUser
+        def me(**opts)
+          client.get(path('me'), options: opts)
+        end
+
+        alias get me
+
+        # @see https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Users/paths/~1api~1v1~1users/post
+        def create(payload, **opts)
+          client.post(path, payload: payload, options: opts)
+        end
+
+        protected
+
+        def set_base_path
+          @base_path = PATH
+        end
+      end
+    end
+  end
+end