bitstamp_client 1.0.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284b6c7a1d6d71cf415e7ecaef262865e0ead1c22395d6bcdb5041b86e096aab
-  data.tar.gz: 0214c9d3d809a5401e48cdec9b9b4e1b8121fb72382dfdcc0ba10cde53a7bedb
+  metadata.gz: f5f891fcf088ca5c7de2ebf3f7b9278cd5dcf2da656111bd85b8e7545a8a178a
+  data.tar.gz: 4e3ba70c70b3fc4d48fd4df4a2e90449882914c0a3fbea495ea56ea7986374f1
 SHA512:
-  metadata.gz: c9c859fd3c2d78225e8698269707bd7b301cd1f42f75e4928f339d1f55e8159dea59158f94a32aef0fc95b4d072bc33d344a6dd95d1b19b32ff1a81414fbbcf1
-  data.tar.gz: f22dd6da2654178191dc569c643fb7ef6bea9665a407ea962db8e6372f4df7e888de7de7d01b2c22d29ad5a20cc59d2a5cc7694e7203f13fd37ec513cd8f1e5c
+  metadata.gz: 828e7216ad247f733817a69dc1f36e95f2ef0185668c009ec93c72dee427544d81ad253abf418365670e0ed21895df7ede2f7fcafdec752e2a9abd63581a4456
+  data.tar.gz: aa34e0f6e78f517db198d4932de36d718d4de7c2fc9cfbdc3dfe657dffcbdadac4de2898afe4adb5ce12c65753314b66c923213591ffdf13bef97212b03cfb64

data/.env.sample

@@ -0,0 +1,3 @@
+KEY=changeme
+SECRET=changeme
+CUSTOMER=1234

data/.github/workflows/tests.yml

@@ -0,0 +1,23 @@
+name: Ruby Tests
+
+on:
+  push:
+    branches: [ $default-branch ]
+  pull_request:
+    branches: [ $default-branch ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec spec
+

data/.gitignore

@@ -11,3 +11,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+.env
+.env.local

data/.ruby-version

@@ -1 +1 @@
-ruby-2.5.3
+2.6.6

data/CHANGELOG.md

@@ -4,6 +4,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.2.2] - 2021-01-05
+### Changed
+- `BalanceResponse` now returns fields, only if `parsed_body` is present
+- Update bundler and ruby versions
+- Moved away from `config.yml` variables to `ENV` variables
+- Added initial Github action for running tests
+
+## [1.2.1] - 2019-02-15
+### Fixed
+- OrderBook: do not blow up with `JSON::ParserError` when response isn't JSON
+
+## [1.2.0] - 2019-01-09
+### Added
+- Add `balance` API call to get balances
+
+## [1.1.0] - 2019-01-07
+### Fixed
+- Factories updated to FactoryBot
+
+### Added
+- `MarketOrder` `#buy` and `#sell`
+
+## [1.0.1] - 2019-01-07
+### Fixed
+- All responses are not successful when Bitstamp's response has a `status` key
+
 ## [1.0.0] - 2019-01-04
 ### Added
 - Place market orders

data/README.md

@@ -1,8 +1,6 @@
 # BitstampClient
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bitstamp_client`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+API wrapper for Bitstamp.
 
 ## Installation
 
@@ -23,6 +21,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+# Orderbook
 client = BitstampClient.new
 response = client.order_book("btcusd")
 response.success? # true
@@ -32,6 +31,16 @@ order_book.bids # Array of Order instances
 order_book.asks # Array of Order instances
 ```
 
+```ruby
+# Balance
+client = BitstampClient.new
+response = client.balance(nonce: ...)
+response.success? # true
+
+response.usd_balance  # BigDecimal
+response.btc_reserved # BigDecimal
+```
+
 For more, see the files in `spec/acceptance`.
 
 ## Development

data/bitstamp_client.gemspec

@@ -34,12 +34,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "api_client_base", "~> 1.0"
   spec.add_dependency "typhoeus", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "dotenv", "~> 2.7"
+  spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "rspec-its", "~> 1.2"
   spec.add_development_dependency "vcr", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 2.3"
   spec.add_development_dependency "virtus-matchers", ">= 0.4.0"
-  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "webmock", "~> 2.3"
 end

data/lib/bitstamp_client.rb

@@ -8,10 +8,12 @@ require "bitstamp_client/models/market_order"
 require "bitstamp_client/models/order"
 require "bitstamp_client/models/order_book"
 require "bitstamp_client/requests/base_request"
+require "bitstamp_client/requests/balance_request"
 require "bitstamp_client/requests/exchange_rate_request"
 require "bitstamp_client/requests/order_book_request"
 require "bitstamp_client/requests/place_market_order_request"
 require "bitstamp_client/responses/base_response"
+require "bitstamp_client/responses/balance_response"
 require "bitstamp_client/responses/exchange_rate_response"
 require "bitstamp_client/responses/order_book_response"
 require "bitstamp_client/responses/place_market_order_response"

data/lib/bitstamp_client/client.rb

@@ -9,6 +9,7 @@ module BitstampClient
     api_action :order_book, args: [:currency_pair]
     api_action :exchange_rate, args: [:currency_pair]
     api_action :place_market_order
+    api_action :balance
 
     private
 

data/lib/bitstamp_client/factories.rb

@@ -1,19 +1,19 @@
-FactoryGirl.define do
+FactoryBot.define do
 
   factory :bitstamp_client_order_book, class: "BitstampClient::OrderBook" do
     timestamp { Time.now.to_i }
 
     bids do
       [
-        FactoryGirl.build(:bitstamp_client_order),
-        FactoryGirl.build(:bitstamp_client_order),
+        FactoryBot.build(:bitstamp_client_order),
+        FactoryBot.build(:bitstamp_client_order),
       ]
     end
 
     asks do
       [
-        FactoryGirl.build(:bitstamp_client_order),
-        FactoryGirl.build(:bitstamp_client_order),
+        FactoryBot.build(:bitstamp_client_order),
+        FactoryBot.build(:bitstamp_client_order),
       ]
     end
   end
@@ -23,4 +23,12 @@ FactoryGirl.define do
     volume { 2 }
   end
 
+  factory :bitstamp_client_market_order, class: "BitstampClient::MarketOrder" do
+    sequence(:id) {|n| n}
+    datetime { DateTime.now }
+    type { "0" }
+    price { 4000.99 }
+    amount { 0.01 }
+  end
+
 end

data/lib/bitstamp_client/models/market_order.rb

@@ -1,11 +1,26 @@
 module BitstampClient
   class MarketOrder < BaseModel
 
+    BUY_CODE = "0".freeze
+    SELL_CODE = "1".freeze
+
     attribute :id, String
     attribute :datetime, DateTime
     attribute :type, String
     attribute :price, BigDecimal
     attribute :amount, BigDecimal
+    attribute :buy, Boolean, default: :default_buy, lazy: true
+    attribute :sell, Boolean, default: :default_sell, lazy: true
+
+    private
+
+    def default_buy
+      type == BUY_CODE
+    end
+
+    def default_sell
+      type == SELL_CODE
+    end
 
   end
 end

data/lib/bitstamp_client/requests/balance_request.rb

@@ -0,0 +1,35 @@
+module BitstampClient
+  class BalanceRequest < BaseRequest
+
+    attribute :nonce, Integer
+    attribute :signature, String, default: :default_signature
+
+    private
+
+    def body
+      {
+        key: key,
+        signature: signature,
+        nonce: nonce,
+      }
+    end
+
+    def path
+      "/api/v2/balance/"
+    end
+
+    def action
+      :post
+    end
+
+    def headers
+      { 'Content-Type' => 'application/x-www-form-urlencoded' }
+    end
+
+    def default_signature
+      GenSignature.
+        (key: key, secret: secret, nonce: nonce, customer_id: customer_id)
+    end
+
+  end
+end

data/lib/bitstamp_client/responses/balance_response.rb

@@ -0,0 +1,52 @@
+module BitstampClient
+  class BalanceResponse < BaseResponse
+
+    KNOWN_FIELDS = %i[
+      usd_balance
+      btc_balance
+      eur_balance
+      xrp_balance
+      usd_reserved
+      btc_reserved
+      eur_reserved
+      xrp_reserved
+      usd_available
+      btc_available
+      eur_available
+      xrp_available
+      btcusd_fee
+      btceur_fee
+      eurusd_fee
+      xrpusd_fee
+      xrpeur_fee
+      xrpbtc_fee
+      fee
+    ].freeze
+
+    KNOWN_FIELDS.each do |field|
+      attribute field, BigDecimal, default: :"default_#{field}"
+
+      define_method :"default_#{field}" do
+        parsed_body[field.to_s] if parsed_body.present?
+      end
+    end
+
+    def method_missing(method_name, *args)
+      super if !parsed_body.has_key?(method_name.to_s)
+
+      self.class.define_method(method_name) do
+        BigDecimal.new(parsed_body[method_name.to_s])
+      end
+
+      self.send(method_name)
+    end
+
+    private
+
+
+    def default_order_book
+      OrderBook.new(JSON.parse(body))
+    end
+
+  end
+end

data/lib/bitstamp_client/responses/base_response.rb

@@ -3,6 +3,7 @@ module BitstampClient
 
     include APIClientBase::Response.module
     attribute :body, String, lazy: true, default: :default_body
+    attribute :parsed_body, Hash, lazy: true, default: :default_parsed_body
 
     private
 
@@ -10,5 +11,14 @@ module BitstampClient
       raw_response.body
     end
 
+    def default_success
+      raw_response.success? && !parsed_body.has_key?("status")
+    end
+
+    def default_parsed_body
+      JSON.parse(body)
+    rescue JSON::ParserError
+    end
+
   end
 end

data/lib/bitstamp_client/responses/order_book_response.rb

@@ -9,7 +9,8 @@ module BitstampClient
     private
 
     def default_order_book
-      OrderBook.new(JSON.parse(body))
+      return nil if parsed_body.nil?
+      OrderBook.new(parsed_body)
     end
 
   end

data/lib/bitstamp_client/responses/place_market_order_response.rb

@@ -7,7 +7,6 @@ module BitstampClient
     })
     attribute :status, String, lazy: true, default: :default_status
     attribute :reason, String, lazy: true, default: :default_reason
-    attribute :parsed_body, Hash, lazy: true, default: :default_parsed_body
 
     private
 
@@ -23,9 +22,5 @@ module BitstampClient
       parsed_body["reason"]
     end
 
-    def default_parsed_body
-      JSON.parse(body)
-    end
-
   end
 end

data/lib/bitstamp_client/version.rb

@@ -1,3 +1,3 @@
 module BitstampClient
-  VERSION = "1.0.0"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitstamp_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Ramon Tayag
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_client_base
@@ -44,14 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: virtus-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -137,30 +151,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '2.3'
+description:
 email:
 - ramon.tayag@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -178,10 +193,12 @@ files:
 - lib/bitstamp_client/models/market_order.rb
 - lib/bitstamp_client/models/order.rb
 - lib/bitstamp_client/models/order_book.rb
+- lib/bitstamp_client/requests/balance_request.rb
 - lib/bitstamp_client/requests/base_request.rb
 - lib/bitstamp_client/requests/exchange_rate_request.rb
 - lib/bitstamp_client/requests/order_book_request.rb
 - lib/bitstamp_client/requests/place_market_order_request.rb
+- lib/bitstamp_client/responses/balance_response.rb
 - lib/bitstamp_client/responses/base_response.rb
 - lib/bitstamp_client/responses/exchange_rate_response.rb
 - lib/bitstamp_client/responses/order_book_response.rb
@@ -193,7 +210,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -208,9 +225,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for Bitstamp's API
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.3
-before_script:
-  - cp spec/config.yml{.sample,}
-before_install: gem install bundler -v 1.14.6