cryptomate_api 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 665269594527cdc382621877f03ce9945b856cd13564bda1602db1025fda8691
-  data.tar.gz: fe1fc8c40784ff932c02416be565846f6045dc8d3f06bd92185765fc2d4561aa
+  metadata.gz: '029b00c3b8c7a2e7659083238fa82c181269d650f9e4bb2615b60afa0b8e3e47'
+  data.tar.gz: 34cca9b36b988938110cd54b8e2637741f64194f69e55cbfd3bcf9c8dbbfac29
 SHA512:
-  metadata.gz: 1b8d78e0075c9cb87a036aba6153cc5d5ef4f93e65e71346d749221a465b25808a400dd0fb874cf96435c54be05eaadba81006b3addef6fb9347674a8e515baf
-  data.tar.gz: dc44a554406da97883282b4bd583d343a9c6cd7732d78dd78dad1e9ac8db942d934f4b1cc91646888cb7f987461a9e6410eba03ee3fe0da01bdfe3d1b7ee060a
+  metadata.gz: 859353f5ada4b053995c8752acb8641bb701267344373f584dcbb14bca8f626bf70d775fc2f894a63e7cb4b60a55df10fc1d5292910694bed6ebf994aa8a2545
+  data.tar.gz: effa9092de8200bbf583292928116729c2a9883966103e3c75de9fe0e105cfb9592194a5a430702ebbb4e0ba2a2b90bbdbb75a59acf617b0d22cfd08cc876673

data/.rubocop.yml

@@ -1,13 +1,19 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  NewCops: enable
+  TargetRubyVersion: 3.1
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Style/Documentation:
+  Enabled: false
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
 
 Layout/LineLength:
   Max: 120
+  AllowedPatterns: ['(\A|\s)#'] # ignore comments
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false

data/CHANGELOG.md

@@ -3,3 +3,10 @@
 ## [0.1.0] - 2023-11-04
 
 - Initial release
+- Modules included:
+  - [Management](https://cryptomate.me/docs/management)
+  - [MPC](https://cryptomate.me/docs/mpc)
+
+## [0.2.0] - 2023-11-30
+
+- Added [Payments module](https://cryptomate.me/docs/payments)

data/Gemfile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cryptomate_api.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    cryptomate_api (0.2.2)
+      httparty (~> 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.5)
+    multi_xml (0.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  cryptomate_api!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/cryptomate_api.gemspec

@@ -1,31 +1,34 @@
 # frozen_string_literal: true
 
-require_relative "lib/cryptomate_api/version"
+require_relative 'lib/cryptomate_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "cryptomate_api"
+  spec.name = 'cryptomate_api'
   spec.version = CryptomateApi::VERSION
-  spec.authors = ["Matias Albarello"]
-  spec.email = ["matias.albarello@gmail.com"]
-  spec.licenses = ["MIT"]
+  spec.authors = ['Matias Albarello']
+  spec.email = ['matias.albarello@gmail.com']
+  spec.licenses = ['MIT']
 
-  spec.summary     = "Ruby client for the CryptoMate API."
-  spec.description = "Provides a Ruby interface to the CryptoMate API, allowing easy access to cryptocurrency data and transaction operations. Supports retrieving currency details, creating and fetching transactions, and managing user information."
-  spec.homepage = "https://github.com/matiasalbarello/cryptomate_api"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary     = 'Ruby client for the CryptoMate API.'
+  spec.description = 'Provides a Ruby interface to the CryptoMate API, allowing easy access to cryptocurrency data and \
+  transaction operations. Supports retrieving currency details, creating and fetching transactions, \
+  and managing user information.'
+  spec.homepage = 'https://github.com/matiasalbarello/cryptomate_api'
+  spec.required_ruby_version = '>= 3.1'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty", "~> 0.18"
+  spec.add_dependency 'httparty', '~> 0.18'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/cryptomate_api/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'httparty'
 
 module CryptomateApi
@@ -9,7 +11,7 @@ module CryptomateApi
       CryptomateApi.configuration ||= CryptomateApi::Configuration.new
       @api_key = CryptomateApi.configuration.api_key
       self.class.base_uri CryptomateApi.configuration.base_uri
-      self.class.headers "x-api-key" => "#{@api_key}"
+      self.class.headers 'x-api-key' => @api_key
     end
   end
-end
+end

data/lib/cryptomate_api/management/blockchain.rb

@@ -16,7 +16,7 @@ module CryptomateApi
       #   }
       # ]
       def get_all_blockchains
-        self.class.get("/management/blockchains/list")
+        self.class.get('/management/blockchains/list')
       end
     end
   end

data/lib/cryptomate_api/management/client.rb

@@ -16,7 +16,7 @@ module CryptomateApi
       #   "webhook_url": "string",
       # }
       def get_clients
-        self.class.get("/management/clients")
+        self.class.get('/management/clients')
       end
 
       # Update Webhook-Url
@@ -29,7 +29,7 @@ module CryptomateApi
       #   "webhook_url": "string"
       # }
       def update_webhook_url(webhook_url)
-        self.class.patch("/management/clients/webhook-url", body: { webhook_url: }.to_json)
+        self.class.patch('/management/clients/webhook-url', body: { webhook_url: }.to_json)
       end
 
       # Update Client-Information
@@ -44,7 +44,7 @@ module CryptomateApi
       #   "webhook_url": "string"
       # }
       def update_client_information(name, email, webhook_url)
-        self.class.put("/management/clients", body: { name:, email:, webhook_url: }.to_json)
+        self.class.put('/management/clients', body: { name:, email:, webhook_url: }.to_json)
       end
 
       # Update Payment Address
@@ -56,7 +56,7 @@ module CryptomateApi
       #   "address": "string",
       # }
       def update_payment_address(address, blockchain)
-        self.class.patch("/management/clients/payment-treasury", body: { address:, blockchain: }.to_json)
+        self.class.patch('/management/clients/payment-treasury', body: { address:, blockchain: }.to_json)
       end
     end
   end

data/lib/cryptomate_api/management/configuration.rb

@@ -24,7 +24,7 @@ module CryptomateApi
       # @param [String] blockchain (Id of the blockchain.)
       # Response: None
       def set_payment_destination(address, blockchain)
-        self.class.post("/management/configurations/payments", body: { address:, blockchain: }.to_json)
+        self.class.post('/management/configurations/payments', body: { address:, blockchain: }.to_json)
       end
 
       # Delete payment destination

data/lib/cryptomate_api/management/credential.rb

@@ -61,7 +61,7 @@ module CryptomateApi
       #   }
       # }
       def create_credential(api_key, operation_id)
-        self.class.post("/management/credentials", body: { api_key:, operation_id: }.to_json)
+        self.class.post('/management/credentials', body: { api_key:, operation_id: }.to_json)
       end
 
       # Modifies a credential by ID.

data/lib/cryptomate_api/management/key.rb

@@ -16,7 +16,7 @@ module CryptomateApi
       #   }
       # ]
       def get_all_keys
-        self.class.get("/management/keys/list")
+        self.class.get('/management/keys/list')
       end
 
       # Get a specific key
@@ -43,7 +43,7 @@ module CryptomateApi
       #   }
       # ]
       def create_key(name)
-        self.class.post("/management/keys/create", body: { name: }.to_json)
+        self.class.post('/management/keys/create', body: { name: }.to_json)
       end
 
       # Modify a key

data/lib/cryptomate_api/management/operation.rb

@@ -15,7 +15,7 @@ module CryptomateApi
       #   }
       # ]
       def get_all_operations
-        self.class.get("/management/operations/list")
+        self.class.get('/management/operations/list')
       end
 
       # Get a specific operation

data/lib/cryptomate_api/mpc/account.rb

@@ -23,7 +23,7 @@ module CryptomateApi
       #   ]
       # }
       def get_all_accounts
-        self.class.get("/mpc/accounts/list")
+        self.class.get('/mpc/accounts/list')
       end
 
       # Create an account
@@ -36,7 +36,7 @@ module CryptomateApi
       #   "wallets": []
       # }
       def create_account(alias_name)
-        self.class.post("/mpc/accounts/create", body: { alias: alias_name }.to_json)
+        self.class.post('/mpc/accounts/create', body: { alias: alias_name }.to_json)
       end
 
       # Edit account: Modifies the account information.

data/lib/cryptomate_api/payment.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module CryptomateApi
+  # The Payments tool is designed to create payments in specific assets through a secure escrow wallet system.
+  # To use this module, you will first need to set up your `payment_address` on the Management API. This address is where you want to receive your funds once the payment is complete.
+
+  # Once you have set up your `payment_address`, you can use the Payments API to create payments in the following steps:
+
+  # 1. Create a payment intent: is a representation of a payment that is being processed. To create a payment intent, you will need to specify the following information:
+  #   a. The amount of the payment
+  #   b. The address of the asset in which the payment is to be made (Check listed token API from this section)
+  #   c. The blockchain where your assets exists (Check get blockchain from the Management API)
+  # 2. Send the customer the address returned by this service.
+
+  # Once the customer has completed the payment, you will receive a webhook notification (configurable in Management API).
+  # This notification will contain the status of the payment.
+  #
+  class Payment < Base
+    # Creates a new payment request.
+    # https://cryptomate.me/docs/payments#create-payments-request
+    # @param [String] token_address (Address of the contract from the token to transfer.)
+    # @param [double] amount (Amount of the selected asset to be payed.)
+    # @param [String] blockchain (Blockchain to create the payment.)
+    # Response:
+    # {
+    #   "id": "String",
+    #   "token_address": "String",
+    #   "wallet_address": "String",
+    #   "amount": "Decimal",
+    # }
+    def create_payments_request(token_address, amount, blockchain)
+      self.class.post('/commerce/payments/create', body: { token_address:, amount:, blockchain: }.to_json)
+    end
+
+    # Returns all the pending payments.
+    # https://cryptomate.me/docs/payments#pending-payments
+    # Response:
+    # [
+    #   {
+    #     "id": "String",
+    #     "token_address": "String",
+    #     "wallet_address": "String",
+    #     "amount": "Decimal",
+    #   }
+    # ]
+    def pending_payments
+      self.class.get('/commerce/payments/list')
+    end
+
+    # Retrieves all the listed tokens to create payments. In the response you will see the token name and it's address on the blockchain.
+    # https://cryptomate.me/docs/payments#get-listed-tokens
+    # @param [String] blockchain (Blockchain to get the listed tokens.)
+    # Response:
+    # {
+    #   "Token name 1": "String",
+    #   "Token name 2": "String",
+    # }
+    def get_listed_tokens(blockchain)
+      self.class.get("/commerce/payments/#{blockchain}/tokens")
+    end
+  end
+end

data/lib/cryptomate_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CryptomateApi
-  VERSION = "0.1.4"
+  VERSION = '0.2.0'
 end

data/lib/cryptomate_api.rb

@@ -2,8 +2,9 @@
 
 require_relative 'cryptomate_api/configuration'
 require_relative 'cryptomate_api/base'
+require_relative 'cryptomate_api/payment'
 
-Dir[File.join(__dir__, 'cryptomate_api/{management,mpc,nft}/**/*.rb')].sort.each { |file| require file }
+Dir[File.join(__dir__, 'cryptomate_api/{management,mpc}/**/*.rb')].each { |file| require file }
 
 module CryptomateApi
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cryptomate_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Matias Albarello
@@ -24,9 +24,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-description: Provides a Ruby interface to the CryptoMate API, allowing easy access
-  to cryptocurrency data and transaction operations. Supports retrieving currency
-  details, creating and fetching transactions, and managing user information.
+description: |-
+  Provides a Ruby interface to the CryptoMate API, allowing easy access to cryptocurrency data and \
+    transaction operations. Supports retrieving currency details, creating and fetching transactions, \
+    and managing user information.
 email:
 - matias.albarello@gmail.com
 executables: []
@@ -38,6 +39,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - cryptomate_api.gemspec
@@ -52,6 +54,7 @@ files:
 - lib/cryptomate_api/management/operation.rb
 - lib/cryptomate_api/mpc/account.rb
 - lib/cryptomate_api/mpc/wallet.rb
+- lib/cryptomate_api/payment.rb
 - lib/cryptomate_api/version.rb
 - sig/cryptomate_api.rbs
 homepage: https://github.com/matiasalbarello/cryptomate_api
@@ -61,6 +64,7 @@ metadata:
   homepage_uri: https://github.com/matiasalbarello/cryptomate_api
   source_code_uri: https://github.com/matiasalbarello/cryptomate_api
   changelog_uri: https://github.com/matiasalbarello/cryptomate_api/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -69,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="