cryptomate_api 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 665269594527cdc382621877f03ce9945b856cd13564bda1602db1025fda8691
-  data.tar.gz: fe1fc8c40784ff932c02416be565846f6045dc8d3f06bd92185765fc2d4561aa
+  metadata.gz: 906be66131260ee217ea113c34d721097024af3ccfd109357b16cb63db2710c0
+  data.tar.gz: 94433f3e67c9d62a522e85c640c54a263f0558f049a42ff737d1cef4137838ce
 SHA512:
-  metadata.gz: 1b8d78e0075c9cb87a036aba6153cc5d5ef4f93e65e71346d749221a465b25808a400dd0fb874cf96435c54be05eaadba81006b3addef6fb9347674a8e515baf
-  data.tar.gz: dc44a554406da97883282b4bd583d343a9c6cd7732d78dd78dad1e9ac8db942d934f4b1cc91646888cb7f987461a9e6410eba03ee3fe0da01bdfe3d1b7ee060a
+  metadata.gz: dd6398f342185320a4e848bf3d9a21561d9b0070cf42b6665b004728fb35fdc84a01a350e0b3d8f38aacbb0c46354d31af2eb4235b0db457cad9ebc95a545ab9
+  data.tar.gz: 784af7e1d756604e05fa01e56f000cdb852383f8b2047cefeb427a6450ebdf21b5d35a08954ab6f209acdf2c893726f4a7fee3016af783731f31152a37a0c8b5

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/README.md

@@ -31,8 +31,6 @@ require 'cryptomate_api'
 
 CryptomateApi.configure do |config|
   config.api_key = 'your_api_key_here'
-
-  # optional:
   config.base_uri = 'your-sandbox-uri'
 end
 ```

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,15 +1,42 @@
+# frozen_string_literal: true
+
 require 'httparty'
 
 module CryptomateApi
+  class << self
+    def configure
+      yield self if block_given?
+    end
+
+    def base_uri=(uri)
+      Base.base_uri uri
+    end
+
+    def api_key=(key)
+      Base.headers 'Content-Type' => 'application/json', 'x-api-key' => key
+    end
+  end
+
   class Base
     include HTTParty
 
-    # Initializes the client with the given API key
-    def initialize
-      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}"
+    class << self
+      [:get, :post, :put, :patch, :delete, :head, :options, :move].each do |http_method|
+        define_method(http_method) do |*args, &block|
+          ensure_configuration!
+          super(*args, &block)
+        end
+      end
+
+      private
+
+      def ensure_configuration!
+        errors = []
+        errors << "Base URI not configured" if base_uri.nil?
+        errors << "API key not configured" if headers['x-api-key'].nil?
+
+        raise CryptomateApi::Error, errors.join(", ") unless errors.empty?
+      end
     end
   end
-end
+end

data/lib/cryptomate_api/management/blockchain.rb

@@ -6,17 +6,19 @@ module CryptomateApi
     # credentials for your clients or using every other endpoints that ask for the blockchain where
     # you want to operate.
     class Blockchain < CryptomateApi::Base
-      # Get all blockchains
-      # https://cryptomate.me/docs/management#get-all-blockchains
-      # Response:
-      # [
-      #   {
-      #     "id": "string",
-      #     "description": "string"
-      #   }
-      # ]
-      def get_all_blockchains
-        self.class.get("/management/blockchains/list")
+      class << self
+        # Get all blockchains
+        # https://cryptomate.me/docs/management#get-all-blockchains
+        # Response:
+        # [
+        #   {
+        #     "id": "string",
+        #     "description": "string"
+        #   }
+        # ]
+        def get_all_blockchains
+          get('/management/blockchains/list')
+        end
       end
     end
   end

data/lib/cryptomate_api/management/client.rb

@@ -5,58 +5,60 @@ module CryptomateApi
     # Manage the company information from here, like changing the webhook url where we will
     # notify that some event happened or just changing the name of the company.
     class Client < CryptomateApi::Base
-      # Get clients information
-      # https://cryptomate.me/docs/management#get-clients-information
-      # Response:
-      # {
-      #   "name": "string",
-      #   "last_name": "string",
-      #   "email": "string",
-      #   "social_reason": "string",
-      #   "webhook_url": "string",
-      # }
-      def get_clients
-        self.class.get("/management/clients")
-      end
+      class << self
+        # Get clients information
+        # https://cryptomate.me/docs/management#get-clients-information
+        # Response:
+        # {
+        #   "name": "string",
+        #   "last_name": "string",
+        #   "email": "string",
+        #   "social_reason": "string",
+        #   "webhook_url": "string",
+        # }
+        def get_clients
+          get('/management/clients')
+        end
 
-      # Update Webhook-Url
-      # https://cryptomate.me/docs/management#update-webhook-url
-      # @param [String] webhook_url (New webhook url to use to inform any changes.)
-      # Response:
-      # {
-      #   "name": "string",
-      #   "email": "string",
-      #   "webhook_url": "string"
-      # }
-      def update_webhook_url(webhook_url)
-        self.class.patch("/management/clients/webhook-url", body: { webhook_url: }.to_json)
-      end
+        # Update Webhook-Url
+        # https://cryptomate.me/docs/management#update-webhook-url
+        # @param [String] webhook_url (New webhook url to use to inform any changes.)
+        # Response:
+        # {
+        #   "name": "string",
+        #   "email": "string",
+        #   "webhook_url": "string"
+        # }
+        def update_webhook_url(webhook_url)
+          patch('/management/clients/webhook-url', body: { webhook_url: }.to_json)
+        end
 
-      # Update Client-Information
-      # https://cryptomate.me/docs/management#update-client-information
-      # @param [String] name (Name of the client to update.)
-      # @param [String] email (Email of the client to update.)
-      # @param [String] webhook_url (New webhook url to use to inform any changes.)
-      # Response:
-      # {
-      #   "name": "string",
-      #   "email": "string",
-      #   "webhook_url": "string"
-      # }
-      def update_client_information(name, email, webhook_url)
-        self.class.put("/management/clients", body: { name:, email:, webhook_url: }.to_json)
-      end
+        # Update Client-Information
+        # https://cryptomate.me/docs/management#update-client-information
+        # @param [String] name (Name of the client to update.)
+        # @param [String] email (Email of the client to update.)
+        # @param [String] webhook_url (New webhook url to use to inform any changes.)
+        # Response:
+        # {
+        #   "name": "string",
+        #   "email": "string",
+        #   "webhook_url": "string"
+        # }
+        def update_client_information(name, email, webhook_url)
+          put('/management/clients', body: { name:, email:, webhook_url: }.to_json)
+        end
 
-      # Update Payment Address
-      # https://cryptomate.me/docs/management#update-payments-address
-      # @param [String] address (Address where you want to receive the payments)
-      # @param [String] blockchain (Blockchain where you want to receive the payments)
-      # Response:
-      # {
-      #   "address": "string",
-      # }
-      def update_payment_address(address, blockchain)
-        self.class.patch("/management/clients/payment-treasury", body: { address:, blockchain: }.to_json)
+        # Update Payment Address
+        # https://cryptomate.me/docs/management#update-payments-address
+        # @param [String] address (Address where you want to receive the payments)
+        # @param [String] blockchain (Blockchain where you want to receive the payments)
+        # Response:
+        # {
+        #   "address": "string",
+        # }
+        def update_payment_address(address, blockchain)
+          patch('/management/clients/payment-treasury', body: { address:, blockchain: }.to_json)
+        end
       end
     end
   end

data/lib/cryptomate_api/management/configuration.rb

@@ -4,36 +4,39 @@ module CryptomateApi
   module Management
     # Manage the company configurations from here, like changing the payment destination address for each blockchain.
     class Configuration < CryptomateApi::Base
-      # Get payment destination
-      # Gets the treasury wallet address for holding the payments received on the selected blockchain.
-      # https://cryptomate.me/docs/management#get-payment-destination
-      # @param [String] blockchain (Id of the blockchain.)
-      # Response:
-      # {
-      #   "address": "string",
-      #   "blockchain": "string"
-      # }
-      def get_payment_destination(blockchain)
-        self.class.get("/management/configurations/payments/#{blockchain}")
-      end
+      class << self
 
-      # Set payment destination
-      # Sets the treasury wallet that all the payments will sent after being completed.
-      # https://cryptomate.me/docs/management#set-payment-destination
-      # @param [String] address (Address of the treasury wallet)
-      # @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)
-      end
+        # Get payment destination
+        # Gets the treasury wallet address for holding the payments received on the selected blockchain.
+        # https://cryptomate.me/docs/management#get-payment-destination
+        # @param [String] blockchain (Id of the blockchain.)
+        # Response:
+        # {
+        #   "address": "string",
+        #   "blockchain": "string"
+        # }
+        def get_payment_destination(blockchain)
+          get("/management/configurations/payments/#{blockchain}")
+        end
+
+        # Set payment destination
+        # Sets the treasury wallet that all the payments will sent after being completed.
+        # https://cryptomate.me/docs/management#set-payment-destination
+        # @param [String] address (Address of the treasury wallet)
+        # @param [String] blockchain (Id of the blockchain.)
+        # Response: None
+        def set_payment_destination(address, blockchain)
+          post('/management/configurations/payments', body: { address:, blockchain: }.to_json)
+        end
 
-      # Delete payment destination
-      # Deletes the treasury wallet that all the payments will sent after being completed.
-      # https://cryptomate.me/docs/management#delete-payment-destination
-      # @param [String] blockchain (Id of the blockchain.)
-      # Response: None
-      def delete_payment_destination(blockchain)
-        self.class.delete("/management/configurations/payments/#{blockchain}")
+        # Delete payment destination
+        # Deletes the treasury wallet that all the payments will sent after being completed.
+        # https://cryptomate.me/docs/management#delete-payment-destination
+        # @param [String] blockchain (Id of the blockchain.)
+        # Response: None
+        def delete_payment_destination(blockchain)
+          delete("/management/configurations/payments/#{blockchain}")
+        end
       end
     end
   end