quoinex 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 467b541c5bdf83957fe28d81eecdcbe34c42bfd8
-  data.tar.gz: fbf694e099f0309e5f6d33f23b5ef53b752609cf
+  metadata.gz: e9dd8c4f97072452b97db4d7995e9a69f1041bcc
+  data.tar.gz: 6162b912992051d660ad6541bbe938cd3a6c935a
 SHA512:
-  metadata.gz: 6c347a21fd320975600e16f219b1d45a8381988f0050a7c28ab106eb23e95e4c3c1eaa7b5336d2bd56c3bb52e98bf7c4999c3958e4534094c528a2870e1598b2
-  data.tar.gz: 0de4cd3764a35ea9b4ad296de84e4055b353d6f46e113782b5370a072ba9c0c9650b1e2e2cccf9c2a428de36305264be8b5aa567255b819b9ec66ad220bfe40e
+  metadata.gz: 7978786f53bbecc879610a304f1ad22a6e882300339e017fc91c93fe61bb02cf222e545f495e5c549efcf30a38710f9cdc7dbc63dbf5197a7fe72308094e92da
+  data.tar.gz: 9689338f41e479ce5170bd7761e61bd431ecfd1d3c35943f0a503c456fa0c1e17c9ccc049123fdf3feb88a2371d5ddeda1d91083ae177f2137541416795417ba

data/.gitignore

@@ -0,0 +1,44 @@
+# Parts of this file were adapted from
+# GitHub’s collection of .gitignore file templates
+# which are Copyright (c) 2016 GitHub, Inc.
+# and released under the MIT License.
+# For more details, visit the project page:
+# https://github.com/github/gitignore
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Guardfile
+    - Rakefile
+
+Style/RegexpLiteral:
+  Exclude:
+    - Guardfile

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+language: ruby
+sudo: required
+dist: trusty
+cache: bundler
+rvm:
+  - 2

data/.yardopts

@@ -0,0 +1,6 @@
+--markup=markdown
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+This change log follows the conventions of
+[keep a CHANGELOG](http://keepachangelog.com/).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/heelhook/quoinex/compare/v0.0.1...HEAD

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in quoinex.gemspec.
+gemspec

data/Guardfile

@@ -0,0 +1,23 @@
+scope groups: [:doc, :lint, :unit]
+
+group :doc do
+  guard :yard do
+    watch(%r{^lib/(.+)\.rb$})
+  end
+end
+
+group :lint do
+  guard :rubocop do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+group :unit do
+  guard :rspec, cmd: 'bundle exec rspec --color --format Fuubar' do
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^lib/quoinex/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^spec/.+_spec\.rb$})
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Pablo Fernandez
+
+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,164 @@
+# quoinex
+
+[![Gem](https://img.shields.io/gem/v/quoinex.svg)](https://rubygems.org/gems/quoinex)
+[![GitHub license](https://img.shields.io/github/license/heelhook/quoinex.svg)](./LICENSE.txt)
+[![Gemnasium](https://img.shields.io/gemnasium/heelhook/quoinex.svg)](https://gemnasium.com/heelhook/quoinex)
+[![Travis](https://img.shields.io/travis/heelhook/quoinex.svg)](https://travis-ci.org/heelhook/quoinex)
+[![Codecov](https://img.shields.io/codecov/c/github/heelhook/quoinex.svg)](https://codecov.io/github/heelhook/quoinex)
+[![Code Climate](https://img.shields.io/codeclimate/github/heelhook/quoinex.svg)](https://codeclimate.com/github/heelhook/quoinex)
+
+> Built from [makenew/ruby-gem](https://github.com/makenew/ruby-gem).n
+## Description
+
+
+## Installation
+
+Add this line to your application's [Gemfile][Bundler]
+
+```ruby
+gem 'quoinex'
+```
+
+and update your bundle with
+
+```
+$ bundle
+```
+
+Or install it yourself with
+
+```
+$ gem install quoinex
+```
+
+[Bundler]: http://bundler.io/
+
+## Usage
+
+```
+client = Quoinex::API.new(passphrase: ..., key: ..., secret: ...)
+```
+
+### Fetching accounts
+
+```
+client.accounts
+```
+
+### Listing orders
+
+```
+client.orders
+```
+
+### Order detils
+
+```
+client.order(id)
+```
+
+### Placing an order
+
+```
+client.create_order(
+  side: :buy,
+  size: 1.0,
+  price: 10000,
+  product_id: 'BTCEUR',
+  type: 'limit',
+)
+```
+
+### Cancel an order
+
+```
+client.cancel_order(id)
+```
+
+## Documentation
+
+- [YARD documentation][RubyDoc] is hosted by RubyDoc.info.
+- [Interactive documentation][Omniref] is hosted by Omniref.
+
+[RubyDoc]: http://www.rubydoc.info/gems/quoinex
+[Omniref]: https://www.omniref.com/ruby/gems/quoinex
+
+## Development and Testing
+
+### Source Code
+
+The [quoinex source] is hosted on GitHub.
+Clone the project with
+
+```
+$ git clone https://github.com/heelhook/quoinex.git
+```
+
+[quoinex source]: https://github.com/heelhook/quoinex
+
+### Requirements
+
+You will need [Ruby] with [Bundler].
+
+Install the development dependencies with
+
+```
+$ bundle
+```
+
+[Bundler]: http://bundler.io/
+[Ruby]: https://www.ruby-lang.org/
+
+### Rake
+
+Run `$ rake -T` to see all Rake tasks.
+
+```
+rake build                 # Build quoinex-2.0.1.gem into the pkg directory
+rake bump:current[tag]     # Show current gem version
+rake bump:major[tag]       # Bump major part of gem version
+rake bump:minor[tag]       # Bump minor part of gem version
+rake bump:patch[tag]       # Bump patch part of gem version
+rake bump:pre[tag]         # Bump pre part of gem version
+rake bump:set              # Sets the version number using the VERSION environment variable
+rake clean                 # Remove any temporary products
+rake clobber               # Remove any generated files
+rake install               # Build and install quoinex-2.0.1.gem into system gems
+rake install:local         # Build and install quoinex-2.0.1.gem into system gems without network access
+rake release[remote]       # Create tag v2.0.1 and build and push quoinex-2.0.1.gem to Rubygems
+rake rubocop               # Run RuboCop
+rake rubocop:auto_correct  # Auto-correct RuboCop offenses
+rake spec                  # Run RSpec code examples
+rake test                  # Run test suite
+rake yard                  # Generate YARD Documentation
+```
+
+### Guard
+
+Guard tasks have been separated into the following groups:
+`doc`, `lint`, and `unit`.
+By default, `$ guard` will generate documentation, lint, and run unit tests.
+
+## Contributing
+
+Please submit and comment on bug reports and feature requests.
+
+To submit a patch:
+
+1. Fork it (https://github.com/heelhook/quoinex/fork).
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Make changes. Write and run tests.
+4. Commit your changes (`git commit -am 'Add some feature'`).
+5. Push to the branch (`git push origin my-new-feature`).
+6. Create a new Pull Request.
+
+## License
+
+This Ruby gem is licensed under the MIT license.
+
+## Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bump/tasks'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+task default: [:test, :yard]
+
+desc 'Run test suite'
+task test: [:rubocop, :spec]
+
+RSpec::Core::RakeTask.new
+
+RuboCop::RakeTask.new do |t|
+  t.formatters = ['progress']
+end
+
+YARD::Rake::YardocTask.new

data/lib/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: ../.rubocop.yml

data/lib/quoinex.rb

@@ -0,0 +1,3 @@
+require 'quoinex/version'
+require 'quoinex/quoinex'
+require 'quoinex/exceptions'

data/lib/quoinex/exceptions.rb

@@ -0,0 +1,4 @@
+module Quoinex
+  class CreateOrderException < RuntimeError; end
+  class CancelOrderException < RuntimeError; end
+end

data/lib/quoinex/quoinex.rb

@@ -0,0 +1,132 @@
+require 'rest-client'
+require 'json'
+require 'base64'
+require 'byebug'
+require 'jwt'
+
+module Quoinex
+  class API
+    attr_reader :key,
+                :secret,
+                :url
+
+    def initialize(key:, secret:, url: 'https://api.quoine.com/')
+      @key = key
+      @secret = secret
+      @url = url
+    end
+
+    def balances
+      get('/accounts/balance')
+    end
+
+    def order(id)
+      get("/orders/#{id}")
+    end
+
+    def orders
+      get('/orders')
+    end
+
+    def cancel_order(id)
+      status = put("/orders/#{id}/cancel")
+      return status
+
+      if status['responseStatus'] && status['responseStatus']['errorCode']
+        error = status['responseStatus']['message']
+        error ||= status['responseStatus']
+        raise Quoinex::CancelOrderException.new(error)
+      end
+
+      status
+    rescue => e
+      raise Quoinex::CancelOrderException.new(e.message)
+    end
+
+    def create_order(side:, size:, price:, product_id:)
+      opts = {
+        order_type: :limit,
+        product_id: product_id,
+        side: side,
+        quantity: size.to_f.to_s,
+        price: price.to_f.to_s,
+      }
+      order = post('/orders', opts)
+
+      if !order['id']
+        error ||= order
+        raise Quoinex::CreateOrderException.new(error)
+      end
+
+      order
+    rescue => e
+      raise Quoinex::CreateOrderException.new(e.message)
+    end
+
+    # private
+
+    def signature(path)
+      auth_payload = {
+        path: path,
+        nonce: DateTime.now.strftime('%Q'),
+        token_id: @key
+      }
+
+      JWT.encode(auth_payload, @secret, 'HS256')
+    end
+
+    def get(path, opts = {})
+      uri = URI.parse("#{@url}#{path}")
+      uri.query = URI.encode_www_form(opts[:params]) if opts[:params]
+
+      response = RestClient.get(uri.to_s, auth_headers(uri.request_uri))
+
+      if !opts[:skip_json]
+        JSON.parse(response.body)
+      else
+        response.body
+      end
+    end
+
+    def post(path, payload, opts = {})
+      data = JSON.unparse(payload)
+      response = RestClient.post("#{@url}#{path}", data, auth_headers(path))
+
+      if !opts[:skip_json]
+        JSON.parse(response.body)
+      else
+        response.body
+      end
+    end
+
+    def put(path, opts = {})
+      response = RestClient.put("#{@url}#{path}", auth_headers(path))
+
+      if !opts[:skip_json]
+        JSON.parse(response.body)
+      else
+        response.body
+      end
+    end
+
+    def delete(path, opts = {})
+      response = RestClient.delete("#{@url}#{path}", auth_headers(path))
+
+      if !opts[:skip_json]
+        JSON.parse(response.body)
+      else
+        response.body
+      end
+    end
+
+    def auth_headers(path)
+      sign = signature(path)
+
+      {
+        'Content-Type' => 'application/json',
+        'X-Quoine-API-Version' => 2,
+        'X-Quoine-Auth' => sign,
+      }
+    end
+  end
+end

data/lib/quoinex/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# Primary module for this gem.
+module Quoinex
+  # Current Quoinex version.
+  VERSION = '0.1.4'.freeze
+end

data/quoinex.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path(File.join('..', 'lib'), __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'quoinex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'quoinex'
+  spec.version       = Quoinex::VERSION
+  spec.authors       = ['Pablo Fernandez']
+  spec.email         = ['pfer@me.com']
+  spec.description   = ''
+  spec.summary       = ''
+  spec.homepage      = 'https://github.com/heelhook/quoinex'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(features|spec|test)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 11.2'
+  spec.add_development_dependency 'bump', '~> 0.5'
+
+  spec.add_development_dependency 'guard', '~> 2.11'
+  spec.add_development_dependency 'guard-yard', '~> 2.1'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+
+  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'codecov', '~> 0.1'
+  spec.add_development_dependency 'fuubar', '~> 2.0'
+
+  spec.add_development_dependency 'yard', '~> 0.9.5'
+  spec.add_development_dependency 'redcarpet', '~> 3.2'
+  spec.add_development_dependency 'github-markup', '~> 1.3'
+
+  spec.add_development_dependency 'byebug', '~> 9.1'
+
+  spec.add_dependency 'rest-client', '~> 2'
+  spec.add_dependency 'jwt', '~> 2.1'
+end

data/spec/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+Style/StringLiterals:
+  Enabled: false

data/spec/ruby_gem_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Quoinex::API do
+  subject(:ruby_gem) { Quoinex::API.new }
+
+  describe ".new" do
+    it "makes a new instance" do
+      expect(ruby_gem).to be_a Quoinex::API
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+
+SimpleCov.start
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+else
+  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+end
+
+require 'quoinex'
+
+RSpec.configure do |c|
+  c.expect_with(:rspec) { |e| e.syntax = :expect }
+  c.before(:each) do
+    allow(FileUtils).to receive(:remove_entry_secure).with(anything)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quoinex
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Pablo Fernandez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -268,7 +268,27 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.rubocop.yml
+- lib/quoinex.rb
+- lib/quoinex/exceptions.rb
+- lib/quoinex/quoinex.rb
+- lib/quoinex/version.rb
+- quoinex.gemspec
+- spec/.rubocop.yml
+- spec/ruby_gem_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/heelhook/quoinex
 licenses:
 - MIT
@@ -293,4 +313,7 @@ rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: ''
-test_files: []
+test_files:
+- spec/.rubocop.yml
+- spec/ruby_gem_spec.rb
+- spec/spec_helper.rb