coss_api_ruby_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cbc9f414e57f076fdcd586ac10eb289711195cb02b7002bdebc2204f073d2db
+  data.tar.gz: c567e689523e862345e0edd008b97f666ba5fb153b66d8ac195af6f27291c859
+SHA512:
+  metadata.gz: a974e4c99956b07fe8bcdbf91c86f58ffc5a9424ba317a3f7e02aefaaa42c00c418820faab83f797406ddd37cd0da8bace4b74394eb2b71fed909b100d907d79
+  data.tar.gz: dcbc50669537bad7cfb61750d3ae80ce920eb3331ccd32b6d0458d4297bb3d15cf55935dd46323e442712a149d494a4d99b8e9ed2680645afc600c0e46e8cd3c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require: rubocop-rspec
+AllCops:
+  Exclude:
+    - 'db/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+  TargetRubyVersion: 2.5.1
+Rails:
+    Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/EmptyExampleGroup:
+  Enabled: false
+RSpec/MessageSpies:
+  EnforcedStyle: receive

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ablebeam@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in coss_api_ruby_wrapper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    coss_api_ruby_wrapper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  coss_api_ruby_wrapper!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Viktor Vsk
+
+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,68 @@
+# CossApiRubyWrapper
+
+API wrapper for trading on cryptocurrency exchange [coss.io](https://coss.io/c/reg?r=BDMG5L7K9J)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coss_api_ruby_wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coss_api_ruby_wrapper
+
+## Usage
+
+```ruby
+coss = CossApiRubyWrapper::Exchange.new(public_key: 'YourPublicKey', private_key: 'YourPrivateKey')
+coss.exchange_info # { ... }
+```
+
+### Exchange Instance Methods
+
+|Method                 |Required Parameters | Optional Parameters| Notes   |
+| --------------------- | ------------------ | ------------------ | ------- |
+| place_limit_order     | symbol, price, side, amount)| None |              |
+| place_market_order    | symbol, price, side, amount)| None |              |
+| order_details         | order_id | None |                                 |
+| open_orders           | symbold | limit, page |                           |
+| completed_orders      | symbol | limit, page |                            |
+| all_orders            | symbol, from_order_id | limit |                   |
+| cancel_order          | symbol, order_id | None |                         |
+| market_price          | symbol | None |                                   |
+| pair_depth            | symbol | None |                                   |
+| market_summary        | symbol | None | Not implemented on COSS side      |
+| exchange_info         | None | None |                                     |
+| account_balances      | None | None |                                     |
+| account_details       | None | None |                                     |
+
+### Errors
+
+In case if invalid request parameters were supplied, error of class `CossApiRubyWrapper::ParamsValidations::InvalidParameter` will be thrown with text indicating specific parameters.
+
+In case if request was sent but response status was not 200 OK, next hash will be provided:
+
+```ruby
+{
+    status: 400,
+    error: 'Invalid request'
+}
+```
+
+error may contain any string: Error text, JSON object, or HTML page.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CossApiRubyWrapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ablebeam/coss_api_ruby_wrapper/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'coss_api_ruby_wrapper'
+
+require 'irb'
+IRB.start(__FILE__)

data/coss_api_ruby_wrapper.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coss_api_ruby_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'coss_api_ruby_wrapper'
+  spec.version       = CossApiRubyWrapper::VERSION
+  spec.authors       = ['Viktor Vsk']
+  spec.email         = ['ablebeam@gmail.com']
+
+  spec.summary       = 'Trading API wrapper for cryptocurrency exchange https://coss.io'
+  spec.homepage      = 'https://github.com/ablebeam/coss_api_ruby_wrapper'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/coss_api_ruby_wrapper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'coss_api_ruby_wrapper/version'
+require 'coss_api_ruby_wrapper/params_validations'
+require 'coss_api_ruby_wrapper/exchange'
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'openssl'
+
+module CossApiRubyWrapper
+  HOST_URL = 'https://trade.coss.io/c/api/v1'
+  ANOTHER_HOST_URL = 'https://engine.coss.io/api/v1'
+end

data/lib/coss_api_ruby_wrapper/exchange.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module CossApiRubyWrapper
+  class Exchange
+    attr_accessor :recv_window
+
+    def initialize(public_key:, private_key:, recv_window: 5000)
+      @public_key = public_key
+      @private_key = private_key
+      @recv_window = recv_window
+    end
+
+    def place_limit_order(symbol, price, side, amount)
+      request(:post, '/order/add', order_symbol: symbol.to_s.strip, order_price: price.to_f, order_side: side.to_s.strip, order_size: amount.to_f, type: 'limit')
+    end
+
+    def place_market_order(symbol, price, side, amount)
+      request(:post, '/order/add', order_symbol: symbol.to_s.strip, order_price: price.to_f, order_side: side.to_s.strip, order_size: amount.to_f, type: 'market')
+    end
+
+    def order_details(order_id)
+      request(:post, '/order/details', order_id: order_id.to_s.strip)
+    end
+
+    def open_orders(symbol, limit = 10, page = 0)
+      request(:post, '/order/list/open', limit: limit.to_i, page: page.to_i, symbol: symbol.to_s.strip)
+    end
+
+    def completed_orders(symbol, limit = 10, page = 0)
+      request(:post, '/order/list/completed', limit: limit.to_i, page: page.to_i, symbol: symbol.to_s.strip)
+    end
+
+    def all_orders(symbol, from_order_id, limit = 10)
+      request(:post, '/order/list/all', symbol: symbol.to_s.strip, from_id: from_order_id.to_s.strip, limit: limit.to_i)
+    end
+
+    def cancel_order(symbol, order_id)
+      request(:delete, '/order/cancel', order_id: order_id.to_s.strip, order_symbol: symbol.to_s.strip)
+    end
+
+    # public request
+    def market_price(symbol)
+      request(:get, '/market-price', symbol: symbol.to_s.strip)
+    end
+
+    # public request
+    def pair_depth(symbol)
+      request(:get, '/dp', symbol: symbol.to_s.strip)
+    end
+
+    # public request
+    def market_summary(symbol)
+      request(:get, '/getmarketsummaries', symbol: symbol.to_s.strip)
+    end
+
+    # public request
+    def exchange_info
+      request(:get, '/exchange-info')
+    end
+
+    def account_balances
+      request(:get, '/account/balances')
+    end
+
+    def account_details
+      request(:get, '/account/details')
+    end
+
+    private
+
+    def timestamp
+      Time.now.to_i * 1000
+    end
+
+    def request(method, endpoint, params = {})
+      validate!(endpoint, params)
+
+      uri = URI("#{host_url(endpoint)}#{endpoint}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      params = normalized_params(params, endpoint)
+
+      # GET requests parameters are passed only as URL address params and POST/DELETE requests require JSON parameters
+      payload = method == :get ? URI.encode_www_form(params) : params.to_json
+      request_path = method == :get ? [uri.path, payload].join('?') : uri.path
+
+      req = Net::HTTP.const_get(method.capitalize).new(request_path, 'Content-Type': 'application/json', 'X-Requested-With': 'XMLHttpRequest')
+      if private_request?(endpoint)
+        req['Authorization'] = @public_key
+        req['Signature'] = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @private_key, payload)
+      end
+      req.body = payload unless method == :get # Do not set payload inside request body for GET requests - use URL address parameters
+      response = http.request(req)
+
+      # Return error for both: JSON and HTML formats
+      unless response.code == '200'
+        return { status: response.code, error: (begin
+                                                  JSON.parse(response.body)
+                                                rescue StandardError
+                                                  response.body
+                                                end) }
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def validate!(endpoint, params)
+      # Run request parameters validations
+      validations = ParamsValidations.new(endpoint, params)
+      validations.run!
+      raise CossApiRubyWrapper::ParamsValidations::InvalidParameter, validations.errors.join("\n") unless validations.errors.empty?
+    end
+
+    def normalized_params(params, endpoint)
+      if private_request?(endpoint)
+        params[:recvWindow] = recv_window.to_i
+        params[:timestamp] = timestamp
+      end
+      # Some COSS endpoints require params to be sorted alphabetically
+      Hash[params.sort_by(&:first)]
+    end
+
+    def host_url(endpoint)
+      # At this point COSS has different hosts for some endpoints
+      case endpoint
+      when %r{^\/market_price.*}, %r{^\/dp.*}
+        ANOTHER_HOST_URL
+      else
+        HOST_URL
+      end
+    end
+
+    def private_request?(endpoint)
+      # Public requqests are not required to be signed with public/private keys
+      case endpoint
+      when %r{^\/market-price.*}, %r{^\/dp.*/, /^\/exchange-info.*}, %r{^\/getmarketsummaries.*}
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/coss_api_ruby_wrapper/params_validations.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CossApiRubyWrapper
+  class ParamsValidations
+    class InvalidParameter < StandardError; end
+    attr_reader :errors, :endpoint, :params
+
+    def initialize(endpoint, params)
+      @endpoint = endpoint
+      @params = params
+      @errors = []
+    end
+
+    def run!
+      case endpoint
+      when '/order/add'
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:order_symbol] =~ /\w+_\w+/
+        @errors << '"price" parameter should be convertable to float and be greater than zero' if params[:order_price] <= 0
+        @errors << '"side" parameter should be either BUY or SELL string' unless %w[BUY SELL].include?(params[:order_side])
+        @errors << '"amount" parameter should be convertable to float and be greater than zero' if params[:order_size] <= 0
+      when '/order/cancel'
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:order_symbol] =~ /\w+_\w+/
+        @errors << '"order_id" parameter should be a non-empty string' if params[:order_id].empty?
+      when '/order/details'
+        @errors << '"order_id" parameter should be a non-empty string' if params[:order_id].empty?
+      when '/order/list/open'
+        @errors << '"limit" parameter should be a positive integer' if params[:limit] <= 0
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:symbol] =~ /\w+_\w+/
+      when '/order/list/completed'
+        @errors << '"limit" parameter should be a positive integer' if params[:limit] <= 0
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:symbol] =~ /\w+_\w+/
+      when '/order/list/all'
+        @errors << '"limit" parameter should be a positive integer' if params[:limit] <= 0
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:symbol] =~ /\w+_\w+/
+        @errors << '"from_order_id" parameter should be a non-empty string' if params[:from_order_id].empty?
+      when '/market-price'
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:symbol] =~ /\w+_\w+/
+      when '/dp'
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:symbol] =~ /\w+_\w+/
+      when '/getmarketsummaries'
+        @errors << '"symbol" parameter should be a string representing trading pair, for example: "COSS_ETH"' unless params[:symbol] =~ /\w+_\w+/
+      end
+    end
+  end
+end

data/lib/coss_api_ruby_wrapper/version.rb

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

data/spec/coss_api_ruby_wrapper_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.describe CossApiRubyWrapper do
+  it 'has a version number' do
+    expect(CossApiRubyWrapper::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'coss_api_ruby_wrapper'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: coss_api_ruby_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viktor Vsk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ablebeam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- coss_api_ruby_wrapper.gemspec
+- lib/coss_api_ruby_wrapper.rb
+- lib/coss_api_ruby_wrapper/exchange.rb
+- lib/coss_api_ruby_wrapper/params_validations.rb
+- lib/coss_api_ruby_wrapper/version.rb
+- spec/coss_api_ruby_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ablebeam/coss_api_ruby_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.0
+signing_key: 
+specification_version: 4
+summary: Trading API wrapper for cryptocurrency exchange https://coss.io
+test_files: []