bitstamper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 940546c32d17d9d2786fbe9c88a6b8581c830acb438bcd24cda1c33ac59cb92e
+  data.tar.gz: bd8e5efd83e84a4c96df7623f69d8d69d6044754617dd0e3251065dae3db7a03
+SHA512:
+  metadata.gz: 5c78680b19e52019b7430d022bb1fb44c83b6bd9b0642fca768f9489d94824f6287132b8f019c319fafc9b19fe69cbdf90549d8ea9bf8ea87d91514ab3689ef8
+  data.tar.gz: 3e1bcad548ac3ee86df0fe6d66cf2137bb743a94b873ae527e6ba9e9df92152d5ad9408fbf396c5e7bcc3b21b36896c9e66098e7834d52a7f6d831d54e012af3

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 bitstamper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    bitstamper (0.1.0)
+      faraday (>= 0.13)
+      faraday_middleware (>= 0.12.2)
+      pusher-client (>= 0.6.2)
+      ruby-hmac (>= 0.4.0)
+
+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)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    multipart-post (2.0.0)
+    public_suffix (3.0.1)
+    pusher-client (0.6.2)
+      json
+      websocket (~> 1.0)
+    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.0)
+    ruby-hmac (0.4.0)
+    safe_yaml (1.0.4)
+    vcr (4.0.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    websocket (1.2.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitstamper!
+  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,39 @@
+# Bitstamper Ruby API
+
+Ruby client for interacting with Bitstamp. Originally inspired by the bitstamp gem but rewritten from the ground up and also includes additional API endpoints as well as websocket support.
+
+Feel free to fork, modify & redistribute under the MIT license.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bitstamper'
+
+## Create API Key
+
+More info at: [https://www.bitstamp.net/article/api-key-implementation/](https://www.bitstamp.net/article/api-key-implementation/)
+    
+## Setup
+
+```ruby
+Bitstamper.configure do |config|
+  config.key = YOUR_API_KEY
+  config.secret = YOUR_API_SECRET
+  config.client_id = YOUR_BITSTAMP_USERNAME
+end
+```
+
+If you fail to set your `key` or `secret` or `client_id` a `::Bitstamper::Errors::MissingConfigError`
+will be raised.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b
+my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bitstamper"
+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", {})
+
+  Bitstamper.configure do |config|
+    config.key        =   cfg["key"]
+    config.secret     =   cfg["secret"]
+    config.client_id  =   cfg["client_id"]
+  
+    config.faraday    =   {
+      user_agent: "Bitstamp 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,55 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bitstamper"
+
+# Example implementation of websockets
+# Subscribe to channels with subscribe! (product: :btcusd can also be passed to the method to only subscribe to a specific product/trading pair where applicable)
+# Implement your own callbacks to process the incoming data, set the callbacks on the client with client.callbacks[:callback] = lambda
+
+class WebsocketWrapper
+  def run!
+    client = ::Bitstamper::Websocket::Client.new(enable_logging: true)
+
+    begin
+      client.start!
+  
+      client.subscribe!(:live_trades)
+      client.subscribe!(:order_book)
+      client.subscribe!(:diff_order_book)
+      client.subscribe!(:live_orders)
+  
+      client.callbacks[:live_trades]                 = -> (channel, event, data) { custom_receive(channel, event, data) }
+      client.callbacks[:order_book]                  = -> (channel, event, data) { custom_receive(channel, event, data) }
+      client.callbacks[:diff_order_book]             = -> (channel, event, data) { custom_receive(channel, event, data) }
+  
+      client.callbacks[:live_orders][:order_created] = -> (channel, event, data) { custom_receive(channel, event, data) }
+      client.callbacks[:live_orders][:order_changed] = -> (channel, event, data) { custom_receive(channel, event, data) }
+      client.callbacks[:live_orders][:order_deleted] = -> (channel, event, data) { custom_receive(channel, event, data) }
+  
+      client.loop!
+    ensure
+      client.stop!
+    end
+  end
+  
+  def custom_receive(channel, event, data)
+    puts "\n\nUsing custom callbacks!\n\n"
+  
+    parsed = case channel[:name]
+      when /^live_trades/i
+        ::Bitstamper::Models::LiveTrade.new(data.symbolize_keys.merge(product: channel[:product]))
+      when /^order_book/i
+        ::Bitstamper::Models::OrderBook.new(data)
+      when /^diff_order_book/i
+        ::Bitstamper::Models::OrderBook.new(data)
+      when /^live_orders/i
+        ::Bitstamper::Models::Order.new(data.merge(event: event))
+    end
+  
+    pp parsed
+  end
+  
+end
+
+WebsocketWrapper.new.run!

data/bitstamper.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bitstamper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitstamper"
+  spec.version       = Bitstamper::VERSION
+  spec.authors       = ["SebastianJ"]
+  spec.email         = ["sebastian.johnsson@gmail.com"]
+
+  spec.summary       = %q{Ruby client for Bitstamp's API'}
+  spec.description   = %q{Rest + Websocket client for interacting with Bitstamp's API'}
+  spec.homepage      = "https://github.com/SebastianJ/Bitstamper"
+  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 "ruby-hmac",              ">= 0.4.0"
+  spec.add_dependency "pusher-client",          ">= 0.6.2"
+  
+  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/credentials.yml.example

@@ -0,0 +1,9 @@
+partial_permissions:
+  key: "PARTIAL_PERMISSIONS_KEY"
+  secret: "PARTIAL_PERMISSIONS_SECRET"
+  client_id: "PARTIAL_PERMISSIONS_CLIENT_ID"
+
+full_permissions:
+  key: "FULL_PERMISSIONS_KEY"
+  secret: "FULL_PERMISSIONS_SECRET"
+  client_id: "FULL_PERMISSIONS_CLIENT_ID"

data/lib/bitstamper/configuration.rb

@@ -0,0 +1,41 @@
+module Bitstamper
+  class Configuration
+    attr_accessor :key, :secret, :client_id, :pusher_app_key, :faraday, :products
+    
+    def initialize
+      self.key              =   nil
+      self.secret           =   nil
+      self.client_id        =   nil
+      
+      self.pusher_app_key   =   "de504dc5763aeef9ff52"
+      
+      self.faraday          =   {
+        adapter:    :net_http,
+        user_agent: 'Bitstamp Ruby',
+        verbose:    false
+      }
+      
+      self.products         =   [
+        "btceur",
+        "eurusd",
+        "xrpusd",
+        "xrpeur",
+        "xrpbtc",
+        "ltcusd",
+        "ltceur",
+        "ltcbtc",
+        "ethusd",
+        "etheur",
+        "ethbtc",
+        "bchusd",
+        "bcheur",
+        "bchbtc"
+      ]
+    end
+    
+    def verbose_faraday?
+      self.faraday.fetch(:verbose, false)
+    end
+    
+  end
+end

data/lib/bitstamper/constants.rb

@@ -0,0 +1,34 @@
+module Bitstamper
+  module Constants
+    
+    BUY_ORDER           =   0
+    SELL_ORDER          =   1
+    
+    AVAILABLE_CRYPTOS   =   [
+      "btc",
+      "eth",
+      "xrp",
+      "bch",
+      "ltc"
+    ]
+    
+    TRADEABLE           =   AVAILABLE_CRYPTOS | ["eur", "usd"]
+    
+    TIME_IN_SECONDS     =   {
+      day: 86400,
+      hour: 3600
+    }
+    
+    ERRORS              =   {
+      matches: {
+        invalid_permissions: "No permission found",
+        invalid_order:       "Order not found",
+      },
+      
+      responses: {
+        invalid_permissions: "Not allowed to perform this action - check your API key credentials.",
+      }
+    }
+    
+  end
+end

data/lib/bitstamper/errors.rb

@@ -0,0 +1,11 @@
+module Bitstamper
+  module Errors
+    class Error < StandardError; end;
+    class MissingConfigError < Bitstamper::Errors::Error; end;
+    class InvalidPermissionsError < Bitstamper::Errors::Error; end;
+    class InvalidOrderError < Bitstamper::Errors::Error; end;
+    class InvalidAmountError < Bitstamper::Errors::Error; end;
+    class InvalidAddressError < Bitstamper::Errors::Error; end;
+    class InvalidCurrencyError < Bitstamper::Errors::Error; end;
+  end
+end

data/lib/bitstamper/extensions/hash.rb

@@ -0,0 +1,27 @@
+class Hash
+  
+  def symbolize_keys
+    transform_keys{ |key| key.to_sym rescue key }
+  end
+  
+  def transform_keys
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+  
+  def deep_symbolize_keys
+    deep_transform_keys{ |key| key.to_sym rescue key }
+  end
+  
+  def deep_transform_keys(&block)
+    result = {}
+    each do |key, value|
+      result[yield(key)] = value.is_a?(Hash) ? value.deep_transform_keys(&block) : value
+    end
+    result
+  end
+  
+end

data/lib/bitstamper/models/balance.rb

@@ -0,0 +1,56 @@
+module Bitstamper
+  module Models
+    class Balance
+      attr_accessor :currency, :available, :balance, :reserved, :fees
+      
+      def initialize(hash)
+        hash.each do |key, value|
+          self.send("#{key}=", value) if self.respond_to?(key)
+        end
+      end
+      
+      def self.parse(hash)
+        parsed                  =   []
+        groups                  =   {}
+        
+        hash.each do |key, value|
+          if key !~ /_fee$/i
+            splitted            =   key.split("_")
+
+            if splitted.size == 2
+              currency           =   splitted.first
+              value_key          =   splitted.last
+
+              groups[currency]  ||=   {}
+              groups[currency][value_key] = value&.to_f
+            end
+          end
+        end
+        
+        hash.each do |key, value|
+          if key =~ /_fee$/i
+            pair                =   key.split("_")&.first #btceur_fee -> btceur
+            
+            groups.keys.each do |grouped_key|
+              if pair =~ /^#{grouped_key}/i
+                quote_key       =   pair.gsub(grouped_key, "")
+                groups[grouped_key]["fees"] ||= {}
+                groups[grouped_key]["fees"][quote_key] = value&.to_f
+              end
+            end
+          end
+        end
+        
+        groups                  =   groups.deep_symbolize_keys
+
+        groups.each do |key, values|
+          values[:currency]     =   key.to_s.upcase
+          parsed               <<   ::Bitstamper::Models::Balance.new(values)
+        end
+        
+        return parsed
+      end
+      
+    end
+  end
+end

data/lib/bitstamper/models/base.rb

@@ -0,0 +1,11 @@
+module Bitstamper
+  module Models
+    class Base
+
+      def attributes
+        Hash[instance_variables.map { |name| [name.to_s.gsub(/^@/, "").to_sym, instance_variable_get(name)] }]
+      end
+      
+    end
+  end
+end

data/lib/bitstamper/models/deposit.rb

@@ -0,0 +1,26 @@
+module Bitstamper
+  module Models
+    class Deposit < Base
+      attr_accessor :address, :amount, :confirmations
+      
+      MAPPING             =   {
+        "address"         =>   :string,
+        "amount"          =>   :float,
+        "confirmations"   =>   :integer,
+      }
+      
+      def initialize(hash)
+        hash.each do |key, value|
+          type            =     ::Bitstamper::Models::Deposit::MAPPING.fetch(key, nil)
+          value           =     value && type ? ::Bitstamper::Utilities::convert_value(value, type) : value
+          self.send("#{key}=", value) if self.respond_to?(key)
+        end
+      end
+      
+      def self.parse(data)
+        data&.collect { |item| ::Bitstamper::Models::Deposit.new(item) }
+      end
+      
+    end
+  end
+end

data/lib/bitstamper/models/live_trade.rb

@@ -0,0 +1,41 @@
+module Bitstamper
+  module Models
+    class LiveTrade
+      attr_accessor :id, :buy_order_id, :sell_order_id
+      attr_accessor :amount, :amount_str, :price, :price_str
+      attr_accessor :epoch, :timestamp
+      attr_accessor :type
+      attr_accessor :product
+      
+      TYPES             =   {
+        0 => :buy,
+        1 => :sell
+      }
+      
+      MAPPING           =   {
+        id:                             :string,
+        buy_order_id:                   :string,
+        sell_order_id:                  :string,
+        amount:                         :float,
+        amount_str:                     :string,
+        price:                          :float,
+        price_str:                      :string,
+        epoch:                          :integer,
+        timestamp:                      :time,
+        type:                           :integer,
+        product:                        :string,
+      }
+      
+      def initialize(hash)
+        hash.each do |key, value|
+          type      =     ::Bitstamper::Models::LiveTrade::MAPPING.fetch(key, nil)
+          value     =     value && type ? ::Bitstamper::Utilities::convert_value(value, type) : value
+          self.send("#{key}=", value) if self.respond_to?(key)
+        end
+        
+        self.type   =   TYPES[self.type]
+      end
+      
+    end
+  end
+end