bibox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 890b2879833d6aa42b6dda649ff4416546cff574309ff7fa802b5d649f9bb629
+  data.tar.gz: '082c82088f461bc47a329e546a113a842c2226ac4a6c9e4613e80982a18c8c3b'
+SHA512:
+  metadata.gz: 3f15d9758d9d59cd95b2c40e7268d937777256d5e2ea5fb957218c58df0bf21101eba42e3fcfff96d15a6da76d50e238da326cef97177eff12c8d395dc6eaaaa
+  data.tar.gz: e4da3aea086d11511e130baa678136e924d11df2991943ea1a31473e3e69c22e9ac1053d40b8b989746675758fea35d198b4f5389c363f47a2387bab57670638

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+credentials.yml
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

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 sebastian.johnsson@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bibox.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    bibox (0.1.0)
+      eventmachine (>= 1.2.5)
+      faraday (>= 0.13)
+      faraday_middleware (>= 0.12.2)
+      faye-websocket (>= 0.10.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    eventmachine (1.2.5)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    faye-websocket (0.10.7)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    hashdiff (0.3.7)
+    multipart-post (2.0.0)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rdoc (6.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    vcr (4.0.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bibox!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rdoc (~> 6.0)
+  rspec (~> 3.0)
+  vcr (~> 4.0)
+  webmock (~> 3.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sebastian
+
+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,67 @@
+# Bibox REST + Websocket client in Ruby
+
+This gem provides a REST client and a Websocket client to interact with the crypto currency exchange Bibox. Bibox is an up and coming exchange that's very similar to Binance and KuCoin.
+
+## Getting started
+
+First you'll need to get an account on Bibox, [click here to get one](https://www.bibox.com/login/register?id=11154920&lang=en).
+
+After setting up your account, head to "Account Information", locate the "API" section and click on "Add".
+Enter a name/comment for your key, e.g. "Bibox Ruby", and proceed to click on "Create".
+Copy the API key and the secret that was just created for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bibox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bibox
+
+## Setup
+
+```ruby
+Bibox.configure do |config|
+  config.key = YOUR_API_KEY
+  config.secret = YOUR_API_SECRET
+end
+```
+
+## Usage
+
+REST Client (see specs/source code for available methods/endpoints):
+
+```ruby
+client = Bibox::Rest::Client.new
+client.pairs
+```
+
+Websocket client
+
+See bin/websocket for a reference implementation of websockets.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bibox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Bibox project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bibox/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bibox.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bibox/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bibox"
+  spec.version       = Bibox::VERSION
+  spec.authors       = ["Sebastian Johnsson"]
+  spec.email         = ["sebastian.johnsson@gmail.com"]
+
+  spec.summary       = %q{Ruby client for Bibox's API'}
+  spec.description   = %q{Ruby REST client for crypto currency exchange Bibox}
+  spec.homepage      = "https://github.com/SebastianJ/bibox"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday",                ">= 0.13"
+  spec.add_dependency "faraday_middleware",     ">= 0.12.2"
+  
+  spec.add_dependency "faye-websocket", ">= 0.10.7"
+  spec.add_dependency "eventmachine", ">= 1.2.5"
+  
+  spec.add_development_dependency "bundler",    "~> 1.16"
+  spec.add_development_dependency "rake",       "~> 10.0"
+  spec.add_development_dependency "rspec",      "~> 3.0"
+  spec.add_development_dependency "rdoc",       "~> 6.0"
+  spec.add_development_dependency "vcr",        "~> 4.0"
+  spec.add_development_dependency "webmock",    "~> 3.1"
+end

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bibox"
+require "yaml"
+
+cfg_path              =   File.join(File.dirname(__FILE__), "../credentials.yml")
+
+if ::File.exists?(cfg_path)
+  cfg                 =   YAML.load_file(cfg_path).fetch("full_permissions", {})
+
+  Bibox.configure do |config|
+    config.key        =   cfg["key"]
+    config.secret     =   cfg["secret"]
+  
+    config.faraday    =   {
+      user_agent: "Bibox Ruby",
+      verbose:    true
+    }
+  end
+end
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/websocket

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bibox"
+
+# Example implementation of websockets
+
+class WebsocketWrapper
+  attr_accessor :client
+  
+  def initialize
+    self.client = ::Bibox::Websocket::Client.new
+  end
+  
+  def run!
+    begin
+      self.set_callbacks
+      self.client.start!
+    ensure
+      self.client.stop!
+    end
+  end
+  
+  def set_callbacks
+    # Subscription callback
+    self.client.callbacks[:subscribe]     = -> { subscribe! }
+    
+    # Received messages callbacks
+    self.client.callbacks[:trading_pairs] = -> (data) { trading_pairs(data) }
+    self.client.callbacks[:order_book]    = -> (data) { order_book(data) }
+    self.client.callbacks[:trades]        = -> (data) { trades(data) }
+    self.client.callbacks[:ticker]        = -> (data) { ticker(data) }
+    self.client.callbacks[:klines]        = -> (data) { klines(data) }
+  end
+  
+  def subscribe!(pairs: ["BIX_ETH", "BIX_BTC"])
+    self.client.subscribe_to_trading_pairs!
+    self.client.subscribe_to_order_book!(pairs: pairs)
+    self.client.subscribe_to_trades!(pairs: pairs)
+    self.client.subscribe_to_ticker!(pairs: pairs)
+    self.client.subscribe_to_klines!(pairs: pairs, periods: ["5min"])
+  end
+  
+  def trading_pairs(data)
+    puts "\nReceived trading pairs message!"
+    pp data
+  end
+  
+  def order_book(data)
+    puts "\nReceived order book message!"
+    pp data
+  end
+  
+  def trades(data)
+    puts "\nReceived trades message!"
+    pp data
+  end
+  
+  def ticker(data)
+    puts "\nReceived ticker message!"
+    pp data
+  end
+  
+  def klines(data)
+    puts "\nReceived klines message!"
+    pp data
+  end
+  
+end
+
+WebsocketWrapper.new.run!

data/credentials.yml.example

@@ -0,0 +1,7 @@
+partial_permissions:
+  key: "PARTIAL_PERMISSIONS_KEY"
+  secret: "PARTIAL_PERMISSIONS_SECRET"
+
+full_permissions:
+  key: "FULL_PERMISSIONS_KEY"
+  secret: "FULL_PERMISSIONS_SECRET"