cryptomus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f60a4f81086d5b7e88b0fe308a09f62180cd353f373b48942ac13fd0bb474139
+  data.tar.gz: d965a52db2e10cbdce4f4ec5c6b54fd2f9f8e6a2d466847962adbc6bf2cbf013
+SHA512:
+  metadata.gz: 97b863cb937d0c5da1c1592692df174809dcf513b8d1e1d2c24d9dc68242572974552cb067e5f7b36b56cef103f4bf9ca1c21761587e9ab1ca3d826996b33ec8
+  data.tar.gz: e971b602839afee23d5cafc9c5bd8deb32f7999d47f07492f70a4df9c52ea167953a86d3e04158ecd43b9ea8cf3b2fd29e45403a0b0e33174046fa8ba364bf71

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,113 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.2
+  DisplayCopNames: true
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: no_space
+
+Layout/MultilineArrayBraceLayout:
+  EnforcedStyle: new_line
+
+Layout/MultilineHashBraceLayout:
+  EnforcedStyle: new_line
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+  AllowedMethods: [ change, not_change ]
+
+Metrics/BlockLength:
+  Max: 80
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/MethodLength:
+  Max: 40
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/ParameterLists:
+  Max: 3
+  CountKeywordArgs: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 5
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+# All lambda will be like `->() {}`, `->() do end`.
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: true
+  BracesRequiredMethods: [ 'expect', 'change' ]
+
+Style/GuardClause:
+  Enabled: false
+
+# internal concerns must be written in compact style.
+# classes in a namespace should be written in expanded style.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-15
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Denis Talakevich
+
+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,64 @@
+# Cryptomus
+
+Ruby SDK for Cryptomus Crypto Payment Gateway.  
+See the [documentation](https://doc.cryptomus.com)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add cryptomus
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install cryptomus
+
+## Usage
+
+```ruby
+require 'cryptomus'
+
+Cryptomus.configure do |config|
+  config.merchant_id = 'your_merchant_id'
+  config.api_key = 'your_api_key'
+end
+
+crypto_payment = Cryptomus::Client.create_payment(
+  order_id: 'your_unique_order_id_from_your_system',
+  amount: '100',
+  currency: 'USD',
+  lifetime: 24 * 60 * 60, # expires in 24 hours
+  subtract: 100 # client will pay 100% of commission
+)
+
+puts "Pay URL: #{crypto_payment[:result][:url]}"
+```
+
+```ruby
+crypto_payment = Cryptomus::Client.payment(order_id: 'your_unique_order_id_from_your_system')
+if !crypto_payment[:result][:is_final]
+  puts "Waiting for client to pay (status=#{crypto_payment[:result][:status]})"
+elsif %w[paid paid_over].include?(crypto_payment[:result][:status])
+  puts "Payment completed (amount=#{crypto_payment[:result][:payer_amount]}, status=#{crypto_payment[:result][:status]})"
+else
+  puts "Payment failed (status=#{crypto_payment[:result][:status]})"
+end
+```
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/senid231/cryptomus.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cryptomus/client.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Cryptomus
+  module Client
+    module_function
+
+    # https://doc.cryptomus.com/payments/creating-invoice
+    # @param attributes [Hash]
+    # @option attributes [String] :order_id required
+    # @option attributes [String] :currency required
+    # @option attributes [String] :amount required
+    # @return [Hash]
+    # @raise [Cryptomus::Errors::ApiError]
+    # @example
+    #   Cryptomus::Client.create_invoice(
+    #     order_id: '123',
+    #     currency: 'USD',
+    #     amount: '100'
+    #   )
+    def create_payment(attributes)
+      connection.post('/v1/payment', body: attributes)
+    end
+
+    # https://doc.cryptomus.com/payments/payment-history
+    # @param cursor [String,nil] from previous response paginate.nextCursor or paginate.previousCursor
+    # @param date_from [String,nil] format: 'YYYY-MM-DD H:mm:ss'
+    # @param date_to [String,nil] format: 'YYYY-MM-DD H:mm:ss'
+    # @return [Hash]
+    # @raise [Cryptomus::Errors::ApiError]
+    def list_payments(cursor: nil, date_from: nil, date_to: nil)
+      attributes = { date_from:, date_to: }.compact
+      attributes = nil if attributes.empty?
+      query = { cursor: }.compact
+      query = nil if query.empty?
+      connection.post('/v1/payment/list', body: attributes, query:)
+    end
+
+    # https://doc.cryptomus.com/payments/payment-information
+    # @param uuid [String,nil] uuid or order_id must be passed.
+    # @param order_id [String,nil] uuid or order_id must be passed.
+    # @return [Hash]
+    # @raise [Cryptomus::Errors::ApiError]
+    def payment(uuid: nil, order_id: nil)
+      attributes = { uuid:, order_id: }.compact
+      connection.get('/v1/payment/info', body: attributes)
+    end
+
+    # https://doc.cryptomus.com/payments/creating-static
+    # @param attributes [Hash]
+    # @option attributes [String] :order_id required
+    # @option attributes [String] :currency required
+    # @option attributes [String] :network required
+    # @return [Hash]
+    # @raise [Cryptomus::Errors::ApiError]
+    # @example
+    #   Cryptomus::Client.create_wallet(
+    #     order_id: '123',
+    #     currency: 'USDT',
+    #     network: 'tron'
+    #   )
+    def create_wallet(attributes)
+      connection.post('/v1/wallet', body: attributes)
+    end
+
+    # https://doc.cryptomus.com/balance
+    # @return [Hash]
+    # @raise [Cryptomus::Errors::ApiError]
+    # @example
+    #   Cryptomus::Client.balance
+    def balance
+      connection.post('/v1/balance')
+    end
+
+    def connection
+      @connection ||= Connection.new
+    end
+  end
+end

data/lib/cryptomus/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Cryptomus
+  class Configuration
+    attr_accessor :api_key,
+                  :merchant_id,
+                  :user_agent,
+                  :connection_config,
+                  :on_error,
+                  :logger
+
+    def initialize
+      self.user_agent = "Cryptomus Ruby SDK #{Cryptomus::VERSION} (Ruby #{RUBY_VERSION})"
+    end
+  end
+end

data/lib/cryptomus/connection.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Cryptomus
+  class Connection
+    MIME_TYPE = 'application/json'
+
+    # @param path [String]
+    # @param body [Hash, nil]
+    # @raise [Cryptomus::Errors::ApiError]
+    def post(path, body: nil, query: nil)
+      response = connection.post do |req|
+        req.url(path, query)
+        raw_body = body&.to_json
+        req.body = raw_body
+        req[:sign] = Signature.generate(raw_body)
+      end
+      handle_response(response)
+      response.body
+    end
+
+    private
+
+    def connection
+      Faraday.new(connection_options) do |builder|
+        builder.adapter Faraday.default_adapter
+        builder.request :json
+        builder.response :json, parser_options: { symbolize_names: true }
+        builder.response :logger, Cryptomus.config.logger, bodies: true if Cryptomus.config.logger
+        Cryptomus.config.connection_config&.call(builder)
+      end
+    end
+
+    def handle_response(response)
+      return if response.success?
+      return if Cryptomus.config.handle_response&.call(response)
+
+      raise Cryptomus::Errors::ApiError, response
+    end
+
+    def connection_options
+      {
+        url: Cryptomus::CONST::URL,
+        headers: {
+          'Content-Type' => MIME_TYPE,
+          merchant: Cryptomus.config.merchant_id,
+          user_agent: Cryptomus.config.user_agent
+        }
+      }
+    end
+  end
+end

data/lib/cryptomus/const.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cryptomus
+  module CONST
+    URL = 'https://api.cryptomus.com'
+  end
+end

data/lib/cryptomus/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Cryptomus
+  module Errors
+    class Error < StandardError
+    end
+
+    class ApiError < Error
+      # @!method response [Faraday::Response,nil]
+      # @!method status [Integer,nil]
+      # @!method response_body [Hash,nil]
+      attr_reader :response, :status, :response_body
+
+      # @param msg [String]
+      # @param response [Faraday::Response,nil]
+      def initialize(msg, response = nil)
+        @response = response
+        @status = response&.status
+        @response_body = response&.body
+        super(msg)
+      end
+    end
+  end
+end

data/lib/cryptomus/signature.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'digest'
+
+module Cryptomus
+  module Signature
+    module_function
+
+    # https://doc.cryptomus.com/getting-started/request-format
+    # @param raw_body [String]
+    # @return [String]
+    def generate(raw_body)
+      raw_body_encoded = Base64.encode64(raw_body || '')
+      Digest::MD5.hexdigest("#{raw_body_encoded}#{Cryptomus.config.api_key}")
+    end
+  end
+end

data/lib/cryptomus/version.rb

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

data/lib/cryptomus/webhook_validator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cryptomus
+  module WebhookValidator
+    module_function
+
+    # https://doc.cryptomus.com/payments/webhook
+    # @param payload [Hash]
+    # @param sign [String]
+    # @return [Boolean]
+    def validate(payload:, sign:)
+      payload_json = JSON.generate(payload)
+      generated_sign = Cryptomus::Signature.generate(payload_json)
+      generated_sign == sign
+    end
+  end
+end

data/lib/cryptomus.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'cryptomus/version'
+require_relative 'cryptomus/const'
+require_relative 'cryptomus/errors'
+require_relative 'cryptomus/configuration'
+require_relative 'cryptomus/signature'
+require_relative 'cryptomus/webhook_validator'
+require_relative 'cryptomus/connection'
+require_relative 'cryptomus/client'
+
+# Cryptomus Crypto Payment Gateway
+# [https://doc.cryptomus.com]
+module Cryptomus
+  module_function
+
+  def configure
+    yield config
+  end
+
+  def config
+    @config ||= Configuration.new
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: cryptomus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Talakevich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Ruby SDK for Cryptomus Crypto Payment Gateway.
+email:
+- senid231@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/cryptomus.rb
+- lib/cryptomus/client.rb
+- lib/cryptomus/configuration.rb
+- lib/cryptomus/connection.rb
+- lib/cryptomus/const.rb
+- lib/cryptomus/errors.rb
+- lib/cryptomus/signature.rb
+- lib/cryptomus/version.rb
+- lib/cryptomus/webhook_validator.rb
+homepage: https://github.com/senid231/cryptomus-ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/senid231/cryptomus-ruby-sdk
+  source_code_uri: https://github.com/senid231/cryptomus-ruby-sdk
+  changelog_uri: https://github.com/senid231/cryptomus-ruby-sdk/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Cryptomus Crypto Payment Gateway.
+test_files: []