bitsor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2b6612c7e1b52244270a79a75316446b2c6fab4
+  data.tar.gz: ce4b62fa5ff35c25af1e18496b61a225526c12fb
+SHA512:
+  metadata.gz: 0b2ab8209a509c4325bcd2893a07242854b07b38afcbd55d41a057cd553c07b421acffa4d455b341d9d68b89b747c2b2382787b047b8f8a38393e23ae6d94770
+  data.tar.gz: 62e996c139162d26199be6a10aac875a2f6bf9ffa50568118dee30947511d6cd934d8ad0f41983a97aeb115dede45239598911da33cbf935b13dbb84f75ed342

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    parallelism: 1
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.3.3-node-browsers
+       - image: circleci/php:7.1.9-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+
+      # Restore bundle cache
+      - type: cache-restore
+        name: Restore bundle cache
+        key: rails-demo-bundle-{{ checksum "Gemfile.lock" }}
+
+      - run: gem install bundler -v 1.16
+      - run:
+          name: Bundle Install
+          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      # Store bundle cache
+      - type: cache-save
+        name: Store bundle cache
+        key: bitsor-bundle-{{ checksum "Gemfile.lock" }}
+        paths:
+          - vendor/bundle
+
+      # Run rspec in parallel
+      - run: |
+          ./cc-test-reporter before-build
+          bundle exec rspec --profile 10 \
+                            --format RspecJunitFormatter \
+                            --out test_results/rspec.xml \
+                            --format progress \
+                            $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+          ./cc-test-reporter format-coverage -t simplecov $CIRCLE_ARTIFACTS/coverage/.resultset.json
+          ./cc-test-reporter upload-coverage
+
+      # Save test results for timing analysis
+      - store_test_results:
+          path: test_results
+

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+spec/status.txt
+
+.env
+.DS_Store

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Style/Documentation:
+  Enabled: false
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: []
+    '%i': []
+    '%w': []
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+Style/TrailingBlankLines:
+  EnforcedStyle: final_blank_line
+Style/LambdaCall:
+  Enabled: false
+Style/IndentHash:
+  Enabled: false
+Style/AlignHash:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
+  # directives like '# rubocop: enable ...' when calculating a line's length.
+  IgnoreCopDirectives: false
+Metrics/BlockLength:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitsor.gemspec
+gemspec
+
+gem 'rubocop'
+
+group :test do
+  gem 'dotenv'
+  gem 'multi_json'
+  gem 'pry'
+  gem 'rspec'
+  gem 'rspec_junit_formatter'
+  gem 'simplecov', require: false
+  gem 'vcr', '3.0.3'
+  gem 'webmock', '3.1.1'
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Adrian Castillo
+
+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,74 @@
+[![Maintainability](https://api.codeclimate.com/v1/badges/c7c2d4123ee5665ce540/maintainability)](https://codeclimate.com/github/rodacato/bitsor/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c7c2d4123ee5665ce540/test_coverage)](https://codeclimate.com/github/rodacato/bitsor/test_coverage)
+[![CircleCI](https://circleci.com/gh/rodacato/bitsor/tree/master.svg?style=svg)](https://circleci.com/gh/rodacato/bitsor/tree/master)
+
+# Bitsor
+
+Ruby wrapper for bitso.com API, you will need an account to get the credentials to use this wrapper.
+
+If you already have an account, you can get your api credentials from [here](https://bitso.com/api_setup).
+
+If you dont have already an account, consider to signup from my referal link [here](https://bitso.com/?ref=nphw).
+
+## Quick start
+
+Install via Rubygems
+
+    gem install bitsor
+
+... or add to your Gemfile
+
+    gem "bitsor", "~> 0.1"
+
+### Making requests
+
+[API methods](https://bitso.com/api_info#private-rest-api) are available as module methods (consuming module-level
+configuration) or as client instance methods.
+
+```ruby
+# Provide authentication credentials
+Bitsor.configure do |c|
+  c.client_id = 123456
+  c.api_key = 'funky'
+  c.api_secret = '4l1Th3c01Ns!'
+end
+
+# Fetch the user balance
+Bitsor.balance
+```
+or
+
+```ruby
+# Provide authentication credentials
+client = Bitsor::Client.new(client_id: 123456, api_key: 'defunkt', api_secret: '4l1Th3c01Ns!')
+
+# Fetch the user balance
+client.balance
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rodacato/bitsor.
+
+## License
+
+Copyright (c) 2017 Adrian Castillo
+
+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/Rakefile

@@ -0,0 +1,9 @@
+# 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,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bitsor'
+
+# 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/bitsor.gemspec

@@ -0,0 +1,33 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitsor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bitsor'
+  spec.version       = Bitsor::VERSION
+  spec.authors       = ['Adrian Castillo']
+  spec.email         = ['rodacato@gmail.com']
+
+  spec.summary       = 'Unofficial Ruby API wrapper for use with Bitso.'
+  spec.description   = 'Manage your bitso account from their API endpoints'
+  spec.homepage      = 'https://www.bitsotower.com'
+  spec.license       = 'MIT'
+  spec.metadata      = { "source_code_uri" => "https://github.com/rodacato/bitsor" }
+
+  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 'typhoeus', '~> 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end
+

data/lib/bitsor/client/account_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module AccountStatus
+      def account_status
+        normalize_response.with(:account_status) do
+          get('/v3/account_status/')
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/available_books.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module AvailableBooks
+      def available_books
+        normalize_response.with(:book) do
+          get '/v3/available_books'
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/balance.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module Balance
+      def balance
+        normalize_response.with(:account_balances) do
+          get('/v3/balance/')
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/bitcoin_withdrawal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module BitcoinWithdrawal
+      def bitcoin_withdrawal
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/debit_card_withdrawal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module DebitCardWithdrawal
+      def debit_card_withdrawal
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/ether_withdrawal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module EtherWithdrawal
+      def ether_withdrawal
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/fees.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module Fees
+      def fees
+        normalize_response.with(:account_fees) do
+          get('/v3/fees/')
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/funding.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module Funding
+      def fundings(limit: 25)
+        normalize_response.with(:funding) do
+          get('/v3/fundings/', limit: limit)
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/funding_destination.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module FundingDestination
+      def funding_destination(fund_currency:)
+        normalize_response.with(:funding_destination) do
+          get('/v3/funding_destination/', fund_currency: fund_currency)
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/kyc_documents.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module KycDocuments
+      def kyc_documents
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/ledger.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module Ledger
+      def ledger(marker: nil, sort: :desc, limit: 25)
+        normalize_response.with(:ledger) do
+          get('/v3/ledger/', marker: marker, sort: sort, limit: limit)
+        end
+      end
+
+      def ledger_trades(marker: nil, sort: :desc, limit: 25)
+        normalize_response.with(:ledger) do
+          get('/v3/ledger/trades/', marker: marker, sort: sort, limit: limit)
+        end
+      end
+
+      def ledger_fees(marker: nil, sort: :desc, limit: 25)
+        normalize_response.with(:ledger) do
+          get('/v3/ledger/fees/', marker: marker, sort: sort, limit: limit)
+        end
+      end
+
+      def ledger_fundings(marker: nil, sort: :desc, limit: 25)
+        normalize_response.with(:ledger) do
+          get('/v3/ledger/fundings/', marker: marker, sort: sort, limit: limit)
+        end
+      end
+
+      def ledger_withdrawals(marker: nil, sort: :desc, limit: 25)
+        normalize_response.with(:ledger) do
+          get('/v3/ledger/withdrawals/', marker: marker, sort: sort, limit: limit)
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/mx_bank_codes.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module MxBankCodes
+      def mx_bank_codes
+        get('/v3/mx_bank_codes/')
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/open_orders.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module OpenOrders
+      def open_orders(book: :all, marker: nil, sort: :desc, limit: 25)
+        normalize_response.with(:order) do
+          get('/v3/open_orders/', book: book, marker: marker, sort: sort, limit: limit)
+        end
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/order_book.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module OrderBook
+      def order_book(book:, aggregate: false)
+        get('/v3/order_book/', book: book, aggregate: aggregate)
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/order_trades.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module OrderTrades
+      def order_trades(oid:)
+        get("/v3/order_trades/#{oid}/")
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/orders.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module Orders
+      def lookup_order(oid:)
+        normalize_response.with(:order) do
+          get("/v3/orders/#{oid}/")
+        end
+      end
+
+      def place_order(book:, side:, type:, major: nil, minor: nil, price: nil)
+        post('/v3/orders/', book: book, side: side, type: type, major: major, minor: minor, price: price)
+      end
+
+      def cancel_order(oid:)
+        delete("/v3/orders/#{oid}/")
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/phone_number.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module PhoneNumber
+      def phone_number
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/phone_number_withdrawal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module PhoneNumberWithdrawal
+      def phone_number_withdrawal
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/phone_verification.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module PhoneVerification
+      def phone_verification
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/spei_withdrawal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module SpeiWithdrawal
+      def spei_withdrawal
+        raise Bitsor::NotImplemented
+      end
+    end
+  end
+end
+

data/lib/bitsor/client/ticker.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Bitsor
+  class Client
+    module Ticker
+      def ticker(book:)
+        normalize_response.with(:ticker) do
+          get('/v3/ticker/', book: book)
+        end
+      end
+    end
+  end
+end
+