cryptomate_api 0.1.4 → 0.3.0

data/lib/cryptomate_api/management/credential.rb

@@ -5,91 +5,93 @@ module CryptomateApi
     # Manage the access you give to each key and the permissions you will have for each blockchain,
     # such as only receiving transactions or only accessing one of the blockchains.
     class Credential < CryptomateApi::Base
-      # Get all credentials for an API-Key
-      # https://cryptomate.me/docs/management#get-all-credentials-for-a-api-key
-      # @param [String] api_key (API-Key to see its credentials.)
-      # TODO: check response if it's an array or a hash
-      # Response:
-      # {
-      #   "id": "string",
-      #   "key": {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   },
-      #   "operation": {
-      #     "id": "string",
-      #     "description": "string"
-      #   }
-      # }
-      def get_all_credentials(api_key)
-        self.class.get("/management/credentials/api-key/#{api_key}")
-      end
+      class << self
+        # Get all credentials for an API-Key
+        # https://cryptomate.me/docs/management#get-all-credentials-for-a-api-key
+        # @param [String] api_key (API-Key to see its credentials.)
+        # TODO: check response if it's an array or a hash
+        # Response:
+        # {
+        #   "id": "string",
+        #   "key": {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   },
+        #   "operation": {
+        #     "id": "string",
+        #     "description": "string"
+        #   }
+        # }
+        def get_all_credentials(api_key)
+          get("/management/credentials/api-key/#{api_key}")
+        end
 
-      # Get a credential information by id
-      # https://cryptomate.me/docs/management#get-a-credential-information
-      # @param [String] credential_id (Credential id to see its information.)
-      # Response:
-      # {
-      #   "id": "string",
-      #   "key": {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   },
-      #   "operation": {
-      #     "id": "string",
-      #     "description": "string"
-      #   }
-      # }
-      def get_credential(credential_id)
-        self.class.get("/management/credentials/#{credential_id}")
-      end
+        # Get a credential information by id
+        # https://cryptomate.me/docs/management#get-a-credential-information
+        # @param [String] credential_id (Credential id to see its information.)
+        # Response:
+        # {
+        #   "id": "string",
+        #   "key": {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   },
+        #   "operation": {
+        #     "id": "string",
+        #     "description": "string"
+        #   }
+        # }
+        def get_credential(credential_id)
+          get("/management/credentials/#{credential_id}")
+        end
 
-      # Creates a credential for a API-Key and operation.
-      # https://cryptomate.me/docs/management#create-a-credential
-      # @param [String] api_key (API-Key to create the credential on.)
-      # @param [String] operation_id (Id of the operation to give credential.)
-      # Response:
-      # {
-      #   "id": "string",
-      #   "key": {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   },
-      #   "operation": {
-      #     "id": "string",
-      #     "description": "string"
-      #   }
-      # }
-      def create_credential(api_key, operation_id)
-        self.class.post("/management/credentials", body: { api_key:, operation_id: }.to_json)
-      end
+        # Creates a credential for a API-Key and operation.
+        # https://cryptomate.me/docs/management#create-a-credential
+        # @param [String] api_key (API-Key to create the credential on.)
+        # @param [String] operation_id (Id of the operation to give credential.)
+        # Response:
+        # {
+        #   "id": "string",
+        #   "key": {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   },
+        #   "operation": {
+        #     "id": "string",
+        #     "description": "string"
+        #   }
+        # }
+        def create_credential(api_key, operation_id)
+          post('/management/credentials', body: { api_key:, operation_id: }.to_json)
+        end
 
-      # Modifies a credential by ID.
-      # https://cryptomate.me/docs/management#update-a-credential
-      # @param [String] credential_id (Id of the credential to modify.)
-      # @param [String] api_key (Api-key to modify its credential.)
-      # @param [String] operation_id (Id of the operation.)
-      # Response:
-      # {
-      #   "id": "string",
-      #   "key": {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   },
-      #   "operation": {
-      #     "id": "string",
-      #     "description": "string"
-      #   }
-      # }
-      def update_credential(credential_id, api_key, operation_id)
-        self.class.put("/management/credentials/#{credential_id}", body: { api_key:, operation_id: }.to_json)
-      end
+        # Modifies a credential by ID.
+        # https://cryptomate.me/docs/management#update-a-credential
+        # @param [String] credential_id (Id of the credential to modify.)
+        # @param [String] api_key (Api-key to modify its credential.)
+        # @param [String] operation_id (Id of the operation.)
+        # Response:
+        # {
+        #   "id": "string",
+        #   "key": {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   },
+        #   "operation": {
+        #     "id": "string",
+        #     "description": "string"
+        #   }
+        # }
+        def update_credential(credential_id, api_key, operation_id)
+          put("/management/credentials/#{credential_id}", body: { api_key:, operation_id: }.to_json)
+        end
 
-      # Deletes a credential by ID.
-      # https://cryptomate.me/docs/management#delete-a-credential
-      # @param [String] credential_id (Id of the credential to delete.)
-      def delete_credential(credential_id)
-        self.class.delete("/management/credentials/#{credential_id}")
+        # Deletes a credential by ID.
+        # https://cryptomate.me/docs/management#delete-a-credential
+        # @param [String] credential_id (Id of the credential to delete.)
+        def delete_credential(credential_id)
+          delete("/management/credentials/#{credential_id}")
+        end
       end
     end
   end

data/lib/cryptomate_api/management/key.rb

@@ -6,66 +6,68 @@ module CryptomateApi
     # You can create, modify and delete them.
     # This api-keys are used to authenticate the clients in the platform.
     class Key < CryptomateApi::Base
-      # Get all keys
-      # https://cryptomate.me/docs/management#get-all-keys
-      # Response:
-      # [
-      #   {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   }
-      # ]
-      def get_all_keys
-        self.class.get("/management/keys/list")
-      end
+      class << self
+        # Get all keys
+        # https://cryptomate.me/docs/management#get-all-keys
+        # Response:
+        # [
+        #   {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   }
+        # ]
+        def get_all_keys
+          get('/management/keys/list')
+        end
 
-      # Get a specific key
-      # https://cryptomate.me/docs/management#get-a-key
-      # Response:
-      # [
-      #   {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   }
-      # ]
-      def get_key(key_id)
-        self.class.get("/management/keys/#{key_id}")
-      end
+        # Get a specific key
+        # https://cryptomate.me/docs/management#get-a-key
+        # Response:
+        # [
+        #   {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   }
+        # ]
+        def get_key(key_id)
+          get("/management/keys/#{key_id}")
+        end
 
-      # Create a key
-      # https://cryptomate.me/docs/management#create-a-key
-      # @param [String] name (Alias name of the API-Key to create.)
-      # Response:
-      # [
-      #   {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   }
-      # ]
-      def create_key(name)
-        self.class.post("/management/keys/create", body: { name: }.to_json)
-      end
+        # Create a key
+        # https://cryptomate.me/docs/management#create-a-key
+        # @param [String] name (Alias name of the API-Key to create.)
+        # Response:
+        # [
+        #   {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   }
+        # ]
+        def create_key(name)
+          post('/management/keys/create', body: { name: }.to_json)
+        end
 
-      # Modify a key
-      # https://cryptomate.me/docs/management#modify-a-key
-      # @param [String] key_name (Name of the key to modify.)
-      # @param [String] new_api_key_value (New api-key value.)
-      # Response:
-      # [
-      #   {
-      #     "api_key": "string",
-      #     "name": "string"
-      #   }
-      # ]
-      def modify_key(key_name, new_api_key_value)
-        self.class.put("/management/keys/#{key_name}", body: { api_key: new_api_key_value }.to_json)
-      end
+        # Modify a key
+        # https://cryptomate.me/docs/management#modify-a-key
+        # @param [String] key_name (Name of the key to modify.)
+        # @param [String] new_api_key_value (New api-key value.)
+        # Response:
+        # [
+        #   {
+        #     "api_key": "string",
+        #     "name": "string"
+        #   }
+        # ]
+        def modify_key(key_name, new_api_key_value)
+          put("/management/keys/#{key_name}", body: { api_key: new_api_key_value }.to_json)
+        end
 
-      # Delete a key
-      # https://cryptomate.me/docs/management#delete-a-key
-      # @param [String] api_key (Id of the API-Key. Ex: master-ac8ff424-426f-46a7-94c3-13932c6e8adf)
-      def delete_key(api_key)
-        self.class.delete("/management/keys/#{api_key}")
+        # Delete a key
+        # https://cryptomate.me/docs/management#delete-a-key
+        # @param [String] api_key (Id of the API-Key. Ex: master-ac8ff424-426f-46a7-94c3-13932c6e8adf)
+        def delete_key(api_key)
+          delete("/management/keys/#{api_key}")
+        end
       end
     end
   end

data/lib/cryptomate_api/management/operation.rb

@@ -5,28 +5,30 @@ module CryptomateApi
     # Get all the operations available in the platform.
     # You can use this information to create new credentials for your clients.
     class Operation < CryptomateApi::Base
-      # Get all operations
-      # https://cryptomate.me/docs/management#get-all-operations
-      # Response:
-      # [
-      #   {
-      #     "id": "string",
-      #     "description": "string"
-      #   }
-      # ]
-      def get_all_operations
-        self.class.get("/management/operations/list")
-      end
+      class << self
+        # Get all operations
+        # https://cryptomate.me/docs/management#get-all-operations
+        # Response:
+        # [
+        #   {
+        #     "id": "string",
+        #     "description": "string"
+        #   }
+        # ]
+        def get_all_operations
+          get('/management/operations/list')
+        end
 
-      # Get a specific operation
-      # https://cryptomate.me/docs/management#get-a-operation
-      # Response:
-      # {
-      #   "id": "string",
-      #   "description": "string"
-      # }
-      def get_operation(operation_id)
-        self.class.get("/management/operations/#{operation_id}")
+        # Get a specific operation
+        # https://cryptomate.me/docs/management#get-a-operation
+        # Response:
+        # {
+        #   "id": "string",
+        #   "description": "string"
+        # }
+        def get_operation(operation_id)
+          get("/management/operations/#{operation_id}")
+        end
       end
     end
   end

data/lib/cryptomate_api/mpc/account.rb

@@ -6,65 +6,67 @@ module CryptomateApi
     # This allows you to manage your crypto assets in a more organized manner,
     # and also allows you to create multiple wallets for the same or different blockchain.
     class Account < CryptomateApi::Base
-      # Get all accounts
-      # https://cryptomate.me/docs/mpc#get-all-accounts
-      # TODO: check response if it's an array or a hash
-      # Response:
-      # {
-      #   "id": "string",
-      #   "alias": "string",
-      #   "wallets": [
-      #     {
-      #       "id": "string",
-      #       "alias": "string",
-      #       "wallet_address": "string",
-      #       "blockchain": "string"
-      #     }
-      #   ]
-      # }
-      def get_all_accounts
-        self.class.get("/mpc/accounts/list")
-      end
+      class << self
+        # Get all accounts
+        # https://cryptomate.me/docs/mpc#get-all-accounts
+        # TODO: check response if it's an array or a hash
+        # Response:
+        # {
+        #   "id": "string",
+        #   "alias": "string",
+        #   "wallets": [
+        #     {
+        #       "id": "string",
+        #       "alias": "string",
+        #       "wallet_address": "string",
+        #       "blockchain": "string"
+        #     }
+        #   ]
+        # }
+        def get_all_accounts
+          get('/mpc/accounts/list')
+        end
 
-      # Create an account
-      # https://cryptomate.me/docs/mpc/create-an-account
-      # @param [String] alias_name (Alias name of the account to create.)
-      # Response:
-      # {
-      #   "id": "String",
-      #   "alias": "String",
-      #   "wallets": []
-      # }
-      def create_account(alias_name)
-        self.class.post("/mpc/accounts/create", body: { alias: alias_name }.to_json)
-      end
+        # Create an account
+        # https://cryptomate.me/docs/mpc/create-an-account
+        # @param [String] alias_name (Alias name of the account to create.)
+        # Response:
+        # {
+        #   "id": "String",
+        #   "alias": "String",
+        #   "wallets": []
+        # }
+        def create_account(alias_name)
+          post('/mpc/accounts/create', body: { alias: alias_name }.to_json)
+        end
 
-      # Edit account: Modifies the account information.
-      # https://cryptomate.me/docs/mpc/edit-account
-      # @param [String] account_id (Id of the account to edit.)
-      # @param [String] alias_name (New alias name of the account.)
-      # Response:
-      # {
-      #   "id": "string",
-      #   "alias": "string",
-      #   "wallets": [
-      #     {
-      #       "id": "string",
-      #       "alias": "string",
-      #       "wallet_address": "string",
-      #       "blockchain": "string"
-      #     }
-      #   ]
-      # }
-      def edit_account(account_id, alias_name)
-        self.class.put("/mpc/account/#{account_id}", body: { alias: alias_name }.to_json)
-      end
+        # Edit account: Modifies the account information.
+        # https://cryptomate.me/docs/mpc/edit-account
+        # @param [String] account_id (Id of the account to edit.)
+        # @param [String] alias_name (New alias name of the account.)
+        # Response:
+        # {
+        #   "id": "string",
+        #   "alias": "string",
+        #   "wallets": [
+        #     {
+        #       "id": "string",
+        #       "alias": "string",
+        #       "wallet_address": "string",
+        #       "blockchain": "string"
+        #     }
+        #   ]
+        # }
+        def edit_account(account_id, alias_name)
+          put("/mpc/account/#{account_id}", body: { alias: alias_name }.to_json)
+        end
 
-      # Delete account
-      # https://cryptomate.me/docs/mpc/delete-account
-      # @param [String] account_id (Id of the account to delete.)
-      def delete_account(account_id)
-        self.class.delete("/mpc/account/#{account_id}")
+        # Delete account
+        # https://cryptomate.me/docs/mpc/delete-account
+        # @param [String] account_id (Id of the account to delete.)
+        def delete_account(account_id)
+          delete("/mpc/account/#{account_id}")
+        end
       end
     end
   end