cryptomarket-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56104f24b0cf0227d1b07b004a96a0c7bb12f6c0144683fe5286ecf605e229e9
+  data.tar.gz: 1bdebf110497fc4c99fa768ad5f01c4d5d7811f48b90c739b677e84b90d720fd
+SHA512:
+  metadata.gz: b8db890022384ea30bfaf012af54b37e06eb2951874246aa7b363c603a3672a5d35f5a44b2ad6d02f006247818f04283b1327db62573c7374c3e7f6fdf054af5
+  data.tar.gz: 467cd155cee84cb5e67dd57859eb3c1b5227f9549420d4c7e073e815355ce0842fd5b56d5dfb983f16f4c944b4adcc69aea302f923be3c4dc29126fa43681691

data/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 CryptoMarket Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,177 @@
+# CryptoMarket-Ruby
+[main page](https://www.cryptomkt.com/)
+
+
+[sign up in CryptoMarket](https://www.cryptomkt.com/account/register).
+
+# Installation
+To install Cryptomarket use pip
+```
+gem install cryptomarket
+```
+# Documentation
+
+[The api documentation](https://api.exchange.cryptomkt.com/)
+
+
+# Quick Start
+
+## rest client
+```ruby
+require "cryptomarket"
+
+# instance a client
+api_key='AB32B3201'
+api_secret='21b12401'
+client = Cryptomarket::Client.new apiKey:apiKey, apiSecret:apiSecret
+
+# get currencies
+currencies = client.getCurrencies()
+
+# get order books
+order_book = client.getOrderbook('EOSETH')
+
+# get your account balances
+account_balance = client.getAccountBalance()
+
+# get your trading balances
+trading_balance = client.getTradingBalance()
+
+# move balance from account bank to account trading
+result = client.transferMoneyFromBankToExchange('ETH', '3.2')
+
+# get your active orders
+orders = client.getActiveOrders('EOSETH')
+
+# create a new order
+order = client.createOrder('EOSETH', 'buy', '10', order_type=args.ORDER_TYPE.MARKET)
+```
+
+## websocket client
+
+All websocket calls work with callbacks, subscriptions also use a callback with one argument for the subscription feed. All the other callbacks takes two arguments, err and result: callback(err, result). If the transaction is successful err is None and the result is in result. If the transaction fails, result is None and the error is in err.
+
+callbacks are callables like Procs
+
+There are three websocket clients, the PublicClient, the TradingClient and the AccountClient.
+
+```ruby
+require "cryptomarket-sdk"
+
+# THE PUBLIC CLIENT
+
+wsclient = Cryptomarket::Websocket::PublicClient.new
+
+wsclient.connect() # blocks until connected
+
+my_callback = Proc.new {|err, data|
+    if not err.nil?
+        puts err # deal with error
+        return
+    end
+    puts data
+}
+
+# get currencies
+wsclient.getCurrencies(my_callback)
+
+
+# get an order book feed, 
+# feed_callback is for the subscription feed, with one argument
+# result_callback is for the subscription result (success or failure)
+feed_callback = Proc.new {|feed|
+    puts feed
+}
+
+wsclient.subscribeToOrderbook('EOSETH', feed_callback, my_callback)
+
+# THE TRADING CLIENT
+
+wsclient = Cryptomarket::Websocket::TradingClient.new apiKey:apiKey, apiSecret:apiSecret
+
+wsclient.connect() # blocks until connected and authenticated.
+
+# get your trading balances
+wsclient.getTradingBalance(my_callback)
+
+# get your active orders
+wsclient.getActinveOrders(my_callback)
+
+# create a new order
+wsclient.create_order(
+    clientOrderId:"123123",
+    symbol:'EOSETH', 
+    side:'buy', 
+    quantity:"10",
+    price:"10",
+    callback:my_callback)
+
+# THE ACCONUT CLIENT
+
+wsclient = Cryptomarket::Websocket::AccountClient apiKey:apiKey, apiSecret:apiSecret
+
+wsclient.connect() # blocks until connected
+
+wsclient.getAccountBalance(my_callback)
+```
+
+
+## exception handling
+```ruby
+require "cryptomarket-sdk"
+
+client = Cryptomarket::Client.new apiKey:apiKey, apiSecret:apiSecret
+
+# catch a wrong argument 
+begin
+    order = client.create_order(
+        symbol='EOSETH', 
+        side='selllll', # wrong
+        quantity='3'
+    )
+rescue Cryptomarket::SDKException => e:
+    puts e
+end
+
+# catch a failed transaction
+begin
+    order = client.create_order(
+        symbol='eosehtt',  # non existant symbol
+        side='sell',
+        quantity='10', 
+    )
+rescue Cryptomarket::SDKException => e:
+    puts e
+end
+
+wsclient = Cryptomarket::Websocket::TradingClient.new apiKey:apiKey, apiSecret:apiSecret
+
+# websocket errors are passed as the first argument to the callback
+my_callback = Proc.new {|err, data|
+    if not err.nil?
+        puts err # deal with error
+        return
+    end
+    puts data
+}
+
+wsclient.getTradingBalance(my_callback)
+
+# catch authorization error
+# to catch an authorization error on client connection, a on_error function must be defined on the client
+wsclient = TradingClient(apiKey, apiSecret)
+wsclient.onerror = Proc.new {|error| puts "error", error}
+wsclient.connect
+
+
+```
+# Checkout our other SDKs
+<!-- agregar links -->
+
+python sdk
+
+node sdk
+
+java sdk
+
+go sdk

data/lib/cryptomarket/HttpManager.rb

@@ -0,0 +1,71 @@
+require 'net/http'
+require 'uri'
+require 'json'
+require 'base64'
+require 'rest-client'
+
+module Cryptomarket
+    class HttpManager
+        @@apiUrl = 'https://api.exchange.cryptomkt.com'
+        @@apiVersion = '/api/2/'
+
+        
+        def initialize(apiKey:, apiSecret:)
+            @apiKey = apiKey
+            @apiSecret = apiSecret
+        end
+
+        def getCredential(httpMethod, method, params)
+            timestamp = Time.now.to_i.to_s
+            msg = httpMethod + timestamp + @@apiVersion + method
+            if not params.nil? and params.keys.any?
+                if httpMethod == 'GET'
+                    msg += '?'
+                end
+                msg += URI.encode_www_form params
+            end
+            digest = OpenSSL::Digest.new 'sha256'
+            signature = OpenSSL::HMAC.hexdigest digest, @apiSecret, msg
+            encoded = Base64.encode64(@apiKey + ':' + timestamp + ':' + signature).delete "\n"
+            return 'HS256 ' + encoded
+        end
+        
+        def makeRequest(method:, endpoint:, params:nil, public:false)
+            uri = URI(@@apiUrl + @@apiVersion + endpoint)
+            headers = Hash.new
+            if not public
+                headers['Authorization'] = getCredential(method.upcase, endpoint, params)
+            end
+            if method.upcase == 'GET' and not params.nil?
+                uri.query = URI.encode_www_form params
+                params = nil
+            end
+            begin
+                response = RestClient::Request.execute(
+                    method: method.downcase.to_sym, 
+                    url: uri.to_s,
+                    payload: params, 
+                    headers: headers)
+                return handleResponse(response)
+            rescue RestClient::ExceptionWithResponse => e
+                response = e.response
+                return handleResponse(response)
+            end
+        end
+        
+        def handleResponse(response)
+            result = response.body
+            parsed_result = JSON.parse result
+            if response.code != 200 and not parsed_result['error'].nil?
+                error = parsed_result['error']
+                msg = "(code=#{error['code']}): #{error['message']}"
+                if not error['description'].nil?
+                    msg += ": #{error['description']}"
+                end
+                exception = Cryptomarket::APIException.new error
+                raise exception, msg
+            end
+            return parsed_result
+        end
+    end
+end