btcpay 0.1.0

data/lib/btcpay/client/base.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/object'
+require 'rest_client'
+
+require_relative './result'
+require_relative './api/base'
+require_relative './helpers/base'
+
+module BtcPay
+  module Client
+    class Error < RuntimeError
+      def initialize(message)
+        super(message)
+      end
+    end
+
+    class Base
+      API_PATH = '/api/v1'
+      DEFAULT_TIMEOUT = 10
+
+      attr_reader :logger
+
+      # @param config [BtcPay::Client::Config]
+      # @param logger [Logger]
+      # @param timeout [Integer] Defaults to DEFAULT_TIMEOUT
+      def initialize(config:, logger: Logger.new(STDOUT), timeout: DEFAULT_TIMEOUT, **_kwargs)
+        @config = config
+        @logger = logger
+        @timeout = timeout
+      end
+
+      # GET request
+      #
+      # @param uri [String]
+      # @param options [Hash]
+      # @param headers [Hash]
+      # @return [Result]
+      def get(uri, options: {}, headers: {}, **kwargs)
+        request(uri, method: :get, options: options, headers: headers, **kwargs)
+      end
+
+      # POST request
+      #
+      # @param uri [String]
+      # @param payload [Hash]
+      # @param options [Hash]
+      # @param headers [Hash]
+      # @return [Result]
+      def post(uri, payload: {}, options: {}, headers: {})
+        data = payload.is_a?(Hash) ? payload.to_json : payload
+        request(uri, method: :post, payload: data, options: options, headers: headers)
+      end
+
+      # PUT request
+      #
+      # @param uri [String]
+      # @param payload [Hash]
+      # @param options [Hash]
+      # @param headers [Hash]
+      # @return [Result]
+      def put(uri, payload:, options: {}, headers: {})
+        data = payload.is_a?(Hash) ? payload.to_json : payload
+        request(uri, method: :put, payload: data, options: options, headers: headers)
+      end
+
+      # DELETE request
+      #
+      # @param uri [String]
+      # @param options [Hash]
+      # @param headers [Hash]
+      # @return [Result]
+      def delete(uri, options: {}, headers: {})
+        request(uri, method: :delete, options: options, headers: headers)
+      end
+
+      def api_keys
+        @api_keys ||= Api::ApiKeys.new(client: self)
+      end
+
+      def api_keys_helper
+        @api_keys_helper ||= Helpers::ApiKeys.new(client: self)
+      end
+
+      def health
+        @health ||= Api::Health.new(client: self)
+      end
+
+      def lightning
+        @lightning ||= OpenStruct.new(node: Api::LightningNode.new(client: self))
+      end
+
+      def pull_payments
+        @pull_payments ||= Api::PullPayments.new(client: self)
+      end
+
+      alias payments pull_payments
+
+      def server
+        @server ||= Api::Server.new(client: self)
+      end
+
+      def store
+        @store ||= Api::Store.new(client: self)
+      end
+
+      def users
+        @users ||= Api::Users.new(client: self)
+      end
+
+      private
+
+      attr_reader :config
+
+      # @return [Hash]
+      def default_headers
+        {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+          'User-Agent' => config.user_agent,
+          'Accept-Encoding' => 'deflate, gzip',
+          'Authorization' => config.authorization
+        }
+      end
+
+      # @yield [Result]
+      def request(uri, **kwargs)
+        params = request_builder(uri, **kwargs)
+        return params if kwargs[:skip_request]
+
+        response = RestClient::Request.execute(params)
+        logger.debug(message: 'GET Request', url: params[:url], options: kwargs[:options], status: response.code)
+        result = success?(response.code) ? Result.success(response) : Result.failed(response)
+
+        logger.warn(error: 'Request Error', code: result.code, body: result.raw) if result.failure?
+        result
+      rescue ::RestClient::GatewayTimeout
+        raise Error.new('Gateway timeout')
+      rescue ::RestClient::RequestTimeout
+        raise Error.new('Request timeout')
+      rescue ::RestClient::Exception => e
+        handle_error(e)
+      end
+
+      # @param uri
+      # @option
+      def request_builder(uri, **kwargs)
+        options = kwargs[:options] ||= {}
+        headers = kwargs[:headers] ||= {}
+
+        url = URI(config.base_url)
+        url.path = kwargs[:skip_api_path] ? uri : API_PATH + uri
+        url.query = CGI.unescape(options.to_query).presence
+
+        return url.to_s if kwargs[:skip_request]
+
+        {
+          method: kwargs[:method],
+          url: url.to_s,
+          payload: kwargs[:payload].presence,
+          headers: default_headers.merge(headers),
+          open_timeout: open_timeout,
+          timeout: timeout
+        }.compact
+      end
+
+      # Handle errors
+      # @param error [Error]
+      # @return [Result]
+      def handle_error(error)
+        logger.error(error: 'Request Exception', code: error.response.code, message: error.message)
+
+        Result.failed(error.response)
+      end
+
+      # @return [Integer]
+      def open_timeout
+        @open_timeout || DEFAULT_TIMEOUT
+      end
+
+      # @return [Integer]
+      def timeout
+        @timeout || DEFAULT_TIMEOUT
+      end
+
+      def success?(response_code)
+        response_code.in?(200..299)
+      end
+    end
+  end
+end

data/lib/btcpay/client/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    class Config
+      AUTH_TOKEN_TYPE = 'token'
+      BASIC_TOKEN_TYPE = 'Basic'
+
+      attr_reader :authorization, :auth_token, :basic_auth_token, :base_url, :user_agent
+
+      def initialize(**kwargs)
+        @base_url = load_url(kwargs[:base_url])
+        @user_agent = kwargs[:user_agent] || "btcpay_ruby/#{BtcPay::VERSION}"
+
+        load_auth_token(kwargs)
+        set_authorization
+      end
+
+      def to_h
+        {
+          auth_token: auth_token,
+          basic_auth_token: basic_auth_token,
+          base_url: base_url,
+          user_agent: user_agent
+        }.compact
+      end
+
+      private
+
+      def load_url(url)
+        base_url = url || ENV['BTCPAY_BASE_URL'].to_s
+        uri = URI(base_url)
+        return uri.to_s if uri.scheme && uri.host
+
+        raise ArgumentError.new('invalid base_url')
+      end
+
+      def load_auth_token(kwargs)
+        @auth_token = kwargs[:auth_token] || ENV['BTCPAY_AUTH_TOKEN']
+        @basic_auth_token = kwargs[:basic_auth_token] || ENV['BTCPAY_BASIC_AUTH_TOKEN']
+
+        raise ArgumentError.new('auth_token or basic_auth_token required') unless @auth_token || @basic_auth_token
+      end
+
+      def set_authorization
+        @authorization = if @auth_token
+                           "#{AUTH_TOKEN_TYPE} #{@auth_token}"
+                         elsif @basic_auth_token
+                           "#{BASIC_TOKEN_TYPE} #{@basic_auth_token}"
+                         end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    module Helpers
+      class ApiKeys < Helpers::Base
+        def authorize
+          Authorize.new(client: client)
+        end
+
+        def set_base_path; end
+
+        class Authorize
+          PATH = '/api-keys/authorize'
+
+          def initialize(client:)
+            @client = client
+            @logger = @client.logger
+          end
+
+          def html(**opts)
+            get(**opts)
+          end
+
+          def link(**opts)
+            get(skip_request: true, **opts)
+          end
+
+          private
+
+          attr_reader :client, :logger
+
+          def get(permissions: [], application_name:, strict: true, selective_stores: false, **opts)
+            opts.merge!(
+              {
+                permissions: Array(permissions),
+                applicationName: application_name,
+                strict: strict,
+                selectiveStores: selective_stores
+              }
+            )
+
+            skip_request = opts.delete(:skip_request)
+            client.get(PATH, options: opts, skip_api_path: true, skip_request: skip_request)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../service'
+
+module BtcPay
+  module Client
+    module Helpers
+      class Base < Client::Service
+        require_relative './api_keys'
+      end
+    end
+  end
+end

data/lib/btcpay/client/result.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'multi_json'
+
+module BtcPay
+  module Client
+    ##
+    # Status object to capture result from an HTTP request
+    #
+    # Gives callers context of the result and allows them to
+    # implement successful strategies to handle success/failure
+    class Result
+      def self.success(response)
+        new(:success, response)
+      end
+
+      def self.failed(response)
+        new(:failed, response)
+      end
+
+      attr_reader :body, :code, :headers, :raw, :status
+
+      def initialize(status, response)
+        @code = response.code
+        @headers = response.headers # e.g. "Content-Type" will become :content_type.
+        @status = status
+
+        @raw = raw_parse(response.body)
+        @body = rubify_body
+      end
+
+      def success?
+        status == :success
+      end
+
+      def failure?
+        !success?
+      end
+
+      def to_h
+        {
+          status: status,
+          headers: headers,
+          code: code,
+          body: body
+        }
+      end
+
+      alias to_hash to_h
+
+      private
+
+      def method_missing(method, *args, &blk)
+        to_h.send(method, *args, &blk) || super
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        to_h.respond_to?(method) || super
+      end
+
+      # @param body [JSON] Raw JSON body
+      def raw_parse(response)
+        return if response.blank?
+
+        body = MultiJson.load(response)
+        return body.with_indifferent_access if body.respond_to?(:with_indifferent_access)
+        raise NotImplemented.new('Unknown response type') unless body.is_a?(Array)
+
+        key = success? ? :data : :errors
+        {
+          key => body.map(&:with_indifferent_access)
+        }
+      rescue MultiJson::ParseError
+        response
+      rescue StandardError => e
+        raise ResponseBodyParseError.new(error: 'JSON parse error', message: e.message, body: response)
+      end
+
+      def rubify_body
+        return if raw.blank?
+        return unless raw.respond_to?(:deep_transform_keys)
+
+        raw.deep_transform_keys { |key| key.to_s.underscore }.with_indifferent_access
+      end
+
+      class ResponseBodyParseError < StandardError; end
+    end
+  end
+end

data/lib/btcpay/client/service.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BtcPay
+  module Client
+    class Service
+      def initialize(client:)
+        @base_path = set_base_path
+        @client = client
+        @logger = @client.logger
+      end
+
+      protected
+
+      def path(*args)
+        request_path = args.prepend(base_path.presence).compact.join('/')
+        request_path[0].eql?('/') ? request_path : '/' + request_path
+      end
+
+      def store_path(store_id, *args)
+        base_path.gsub!(':store_id', store_id)
+        path(*args)
+      end
+
+      def set_base_path
+        raise NotImplementedError.new
+      end
+
+      private
+
+      attr_reader :client, :logger, :base_path
+    end
+  end
+end

data/lib/btcpay/version.rb

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

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: btcpay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- snogrammer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rubocop
+  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: simplecov
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: 
+email:
+- btcpay-gem@snogram.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- btcpay.gemspec
+- docker-compose.btcpay.yml
+- lib/btcpay.rb
+- lib/btcpay/client/api/api_keys.rb
+- lib/btcpay/client/api/base.rb
+- lib/btcpay/client/api/health.rb
+- lib/btcpay/client/api/lightning_node.rb
+- lib/btcpay/client/api/pull_payments.rb
+- lib/btcpay/client/api/server.rb
+- lib/btcpay/client/api/store.rb
+- lib/btcpay/client/api/store_payment_requests.rb
+- lib/btcpay/client/api/store_payouts.rb
+- lib/btcpay/client/api/store_pull_payments.rb
+- lib/btcpay/client/api/users.rb
+- lib/btcpay/client/base.rb
+- lib/btcpay/client/config.rb
+- lib/btcpay/client/helpers/api_keys.rb
+- lib/btcpay/client/helpers/base.rb
+- lib/btcpay/client/result.rb
+- lib/btcpay/client/service.rb
+- lib/btcpay/version.rb
+homepage: https://docs.btcpayserver.org/API/Greenfield/v1/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://docs.btcpayserver.org/API/Greenfield/v1/
+  source_code_uri: https://gitlab.com/snogrammer/btpay
+  changelog_uri: https://gitlab.com/snogrammer/btpay/CHANGELOG.md
+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.1.2
+signing_key: 
+specification_version: 4
+summary: BTCPay Server v1 API wrapper. Be your own Bitpay!
+test_files: []