bitflyer 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 02cf9dce44723e91ea75d8f9c705c8bec8040f40
-  data.tar.gz: 0c359f712a2692685e6e7a504f0c05c70edbc468
+SHA256:
+  metadata.gz: e017b1fb5befa1653ab22b3333a94e9d59e2168ea7f0d5dd58acdcb143dd3eea
+  data.tar.gz: d06a630e375806601b5cdc0d1d23f0c5d5574bc847d23e5156092e20f101baab
 SHA512:
-  metadata.gz: 88b4f42f92fc5e8431011030f28a7195c382903da764c22cdf0a0baf15a3f0f04eac6646fc552433dd1d591e39b21c97f774fca0ba16b521747b9c4da6dffb5e
-  data.tar.gz: 59d59e03775bb6a074f22115803c16d40c674262b1ca5e73b77f2b0dbedc4d3c90fcec0bfd671045b0dd5e6488c557d61a618bc340b26ca5a05672c722150716
+  metadata.gz: 58f8ca8dfe138dd4d0d6a22883bca134ef94f6abef0474f6e3a30dc9c4ae1a123cdd88a67a32daa6b940e814872535f8140472683ac6b8ccf9dcb98f2f3d573a
+  data.tar.gz: 675d662fe2f2667c3d733a82a04af407891132d5afd31fadd43a10c95f32d36a65fde231fb45297e5122aba1341c1e4677e2511faf4d44a664aa39e33f7b8369

data/.circleci/config.yml

@@ -21,6 +21,14 @@ jobs:
           key: cache-bundler-{{ checksum "Gemfile.lock" }}
           paths:
             - vendor/bundle
+  rubocop:
+    docker:
+      - image: circleci/ruby
+    steps:
+      - checkout
+      - *restore_bundle_cache
+      - *bundle_install
+      - run: bundle exec rubocop
   rspec:
     docker:
       - image: circleci/ruby
@@ -34,4 +42,5 @@ workflows:
   rspec:
     jobs:
       - build
+      - rubocop
       - rspec

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+Style/Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-07-08 01:59:32 +0900 using RuboCop version 0.72.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 150
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 20
+
+# Offense count: 3
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bitflyer (0.3.0)
+    bitflyer (1.0.0)
       faraday (~> 0.14.0)
       faraday_middleware (~> 0.12.0)
       websocket-client-simple (~> 0.3.0)
@@ -9,6 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
     event_emitter (0.2.6)
@@ -16,11 +17,16 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
+    jaro_winkler (1.5.3)
     method_source (0.9.2)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    rainbow (3.0.0)
     rake (12.3.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -35,6 +41,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
     websocket (1.2.8)
     websocket-client-simple (0.3.0)
       event_emitter
@@ -49,6 +64,7 @@ DEPENDENCIES
   pry
   rake
   rspec
+  rubocop
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -18,6 +18,8 @@ See https://lightning.bitflyer.jp/docs for details.
 
 ### HTTP API
 
+See [public.rb](./lib/bitflyer/http/public.rb) / [private.rb](./lib/bitflyer/http/private.rb) for method definition.
+
 #### Example
 
 ```ruby 
@@ -33,17 +35,7 @@ p private_client.positions # will print your positions
 Accessor format is like `{event_name}_{product_code}`.
 You can set lambda to get realtime events.
 
-#### `event_name`
-- board_snapshot
-- board
-- ticker
-- executions
-
-#### `product_code`
-- btc_jpy
-- fx_btc_jpy
-- eth_btc
-- bch_btc
+`{event_name}` and `{product_code}` is defined at [client.rb](./lib/bitflyer/realtime/client.rb).
 
 #### Example
 

data/bitflyer.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday_middleware', '~> 0.12.0'
   spec.add_dependency 'websocket-client-simple', '~> 0.3.0'
   spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/bitflyer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bitflyer/version'
 require 'bitflyer/http'
 require 'bitflyer/realtime'

data/lib/bitflyer/http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bitflyer'
 require 'bitflyer/http/public'
 require 'bitflyer/http/private'
@@ -13,7 +15,7 @@ module Bitflyer
       def_delegators :@connection, :get, :post
 
       def initialize(key, secret)
-        @connection = Faraday::Connection.new(:url => 'https://api.bitflyer.jp') do |f|
+        @connection = Faraday::Connection.new(url: 'https://api.bitflyer.jp') do |f|
           f.request :json
           f.response :json
           f.use Authentication, key, secret
@@ -36,7 +38,7 @@ module Bitflyer
         method = env[:method].to_s.upcase
         path = env[:url].path + (env[:url].query ? '?' + env[:url].query : '')
         body = env[:body] || ''
-        signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @secret, timestamp +  method + path + body)
+        signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @secret, timestamp + method + path + body)
         env[:request_headers]['ACCESS-KEY'] = @key if @key
         env[:request_headers]['ACCESS-TIMESTAMP'] = timestamp
         env[:request_headers]['ACCESS-SIGN'] = signature
@@ -44,4 +46,4 @@ module Bitflyer
       end
     end
   end
-end
+end

data/lib/bitflyer/http/private.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bitflyer
   module HTTP
     module Private
@@ -40,10 +42,10 @@ module Bitflyer
 
         def withdraw(currency_code: 'JPY', bank_account_id: nil, amount: nil, code: nil)
           body = {
-              currency_code: currency_code,
-              bank_account_id: bank_account_id,
-              amount: amount,
-              code: code
+            currency_code: currency_code,
+            bank_account_id: bank_account_id,
+            amount: amount,
+            code: code
           }.delete_if { |_, v| v.nil? }
           @connection.post('/v1/me/withdraw', body).body
         end
@@ -52,102 +54,124 @@ module Bitflyer
           @connection.get('/v1/me/getwithdrawals').body
         end
 
-        def send_child_order(product_code: 'BTC_JPY', child_order_type: nil, side: nil, price: nil, size: nil, minute_to_expire: nil, time_in_force: 'GTC')
+        def send_child_order(
+          product_code: 'BTC_JPY',
+          child_order_type: nil,
+          side: nil,
+          price: nil,
+          size: nil,
+          minute_to_expire: nil,
+          time_in_force: 'GTC'
+        )
           body = {
-              product_code: product_code,
-              child_order_type: child_order_type,
-              side: side,
-              price: price,
-              size: size,
-              minute_to_expire: minute_to_expire,
-              time_in_force: time_in_force
+            product_code: product_code,
+            child_order_type: child_order_type,
+            side: side,
+            price: price,
+            size: size,
+            minute_to_expire: minute_to_expire,
+            time_in_force: time_in_force
           }.delete_if { |_, v| v.nil? }
           @connection.post('/v1/me/sendchildorder', body).body
         end
 
         def cancel_child_order(product_code: 'BTC_JPY', child_order_id: nil, child_order_acceptance_id: nil)
           body = {
-              product_code: product_code,
-              child_order_id: child_order_id,
-              child_order_acceptance_id: child_order_acceptance_id
+            product_code: product_code,
+            child_order_id: child_order_id,
+            child_order_acceptance_id: child_order_acceptance_id
           }.delete_if { |_, v| v.nil? }
           @connection.post('/v1/me/cancelchildorder', body).body
         end
 
         def send_parent_order(order_method: nil, minute_to_expire: nil, time_in_force: 'GTC', parameters: {})
           body = {
-              order_method: order_method,
-              minute_to_expire: minute_to_expire,
-              time_in_force: time_in_force,
-              parameters: parameters
+            order_method: order_method,
+            minute_to_expire: minute_to_expire,
+            time_in_force: time_in_force,
+            parameters: parameters
           }.delete_if { |_, v| v.nil? }
           @connection.post('/v1/me/sendparentorder', body).body
         end
 
         def cancel_parent_order(product_code: 'BTC_JPY', parent_order_id: nil, parent_order_acceptance_id: nil)
           body = {
-              product_code: product_code,
-              parent_order_id: parent_order_id,
-              parent_order_acceptance_id: parent_order_acceptance_id
+            product_code: product_code,
+            parent_order_id: parent_order_id,
+            parent_order_acceptance_id: parent_order_acceptance_id
           }.delete_if { |_, v| v.nil? }
           @connection.post('/v1/me/cancelparentorder', body).body
         end
 
         def cancel_all_child_orders(product_code: 'BTC_JPY')
-          @connection.post('/v1/me/cancelallchildorders', { product_code: product_code }).body
+          @connection.post('/v1/me/cancelallchildorders', product_code: product_code).body
         end
 
-        def child_orders(product_code: 'BTC_JPY', count: nil, before: nil, after: nil, child_order_state: nil, parent_order_id: nil)
+        def child_orders(
+          product_code: 'BTC_JPY',
+          count: nil,
+          before: nil,
+          after: nil,
+          child_order_state: nil,
+          parent_order_id: nil
+        )
           query = {
-              product_code: product_code,
-              count: count,
-              before: before,
-              after: after,
-              child_order_state: child_order_state,
-              parent_order_id: parent_order_id
+            product_code: product_code,
+            count: count,
+            before: before,
+            after: after,
+            child_order_state: child_order_state,
+            parent_order_id: parent_order_id
           }.delete_if { |_, v| v.nil? }
           @connection.get('/v1/me/getchildorders', query).body
         end
 
         def parent_orders(product_code: 'BTC_JPY', count: nil, before: nil, after: nil, parent_order_state: nil)
           query = {
-              product_code: product_code,
-              count: count,
-              before: before,
-              after: after,
-              parent_order_state: parent_order_state
+            product_code: product_code,
+            count: count,
+            before: before,
+            after: after,
+            parent_order_state: parent_order_state
           }.delete_if { |_, v| v.nil? }
           @connection.get('/v1/me/getparentorders', query).body
         end
 
         def parent_order(parent_order_id: nil, parent_order_acceptance_id: nil)
           query = {
-              parent_order_id: parent_order_id,
-              parent_order_acceptance_id: parent_order_acceptance_id
+            parent_order_id: parent_order_id,
+            parent_order_acceptance_id: parent_order_acceptance_id
           }.delete_if { |_, v| v.nil? }
           @connection.get('/v1/me/getparentorder', query).body
         end
 
-        def executions(product_code: 'BTC_JPY', count: nil, before: nil, after: nil, child_order_id: nil, child_order_acceptance_id: nil)
+        def executions(
+          product_code: 'BTC_JPY',
+          count: nil,
+          before: nil,
+          after: nil,
+          child_order_id: nil,
+          child_order_acceptance_id: nil
+        )
           query = {
-              product_code: product_code,
-              count: count,
-              before: before,
-              after: after,
-              child_order_id: child_order_id,
-              child_order_acceptance_id: child_order_acceptance_id,
+            product_code: product_code,
+            count: count,
+            before: before,
+            after: after,
+            child_order_id: child_order_id,
+            child_order_acceptance_id: child_order_acceptance_id
           }.delete_if { |_, v| v.nil? }
           @connection.get('/v1/me/getexecutions', query).body
         end
 
         def positions(product_code: 'FX_BTC_JPY')
-          @connection.get('/v1/me/getpositions', { product_code: product_code }).body
+          @connection.get('/v1/me/getpositions', product_code: product_code).body
         end
 
         def trading_commission(product_code: 'BTC_JPY')
-          @connection.get('v1/me/gettradingcommission', { product_code: product_code }).body
+          @connection.get('v1/me/gettradingcommission', product_code: product_code).body
         end
       end
     end
   end
-end
+end

data/lib/bitflyer/http/public.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bitflyer
   module HTTP
     module Public
@@ -14,22 +16,22 @@ module Bitflyer
           @connection.get('/v1/markets').body
         end
 
-        def board(product_code = 'BTC_JPY')
-          @connection.get('/v1/board', { product_code: product_code }).body
+        def board(product_code: 'BTC_JPY')
+          @connection.get('/v1/board', product_code: product_code).body
         end
 
-        def ticker(product_code = 'BTC_JPY')
-          @connection.get('/v1/ticker', { product_code: product_code }).body
+        def ticker(product_code: 'BTC_JPY')
+          @connection.get('/v1/ticker', product_code: product_code).body
         end
 
-        def executions(product_code = 'BTC_JPY')
-          @connection.get('/v1/executions', { product_code: product_code }).body
+        def executions(product_code: 'BTC_JPY')
+          @connection.get('/v1/executions', product_code: product_code).body
         end
 
-        def chats(from_date = (Time.now - 5 * 24 * 60 * 60))
-          @connection.get('/v1/getchats', { from_date: from_date }).body
+        def chats(from_date: (Time.now - 5 * 24 * 60 * 60))
+          @connection.get('/v1/getchats', from_date: from_date).body
         end
       end
     end
   end
-end
+end

data/lib/bitflyer/realtime.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'bitflyer'
 require 'bitflyer/realtime/client'
 
 module Bitflyer
   module Realtime
   end
-end
+end

data/lib/bitflyer/realtime/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative './websocket'
 
 module Bitflyer

data/lib/bitflyer/realtime/websocket.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'websocket-client-simple'
 require 'json'
 
@@ -5,7 +7,7 @@ module Bitflyer
   module Realtime
     class WebSocketClient
       attr_accessor :websocket_client, :channel_name, :channel_callbacks, :ping_interval, :ping_timeout,
-        :last_ping_at, :last_pong_at, :error
+                    :last_ping_at, :last_pong_at, :error
 
       def initialize(host:, debug: false)
         @host = host
@@ -30,7 +32,7 @@ module Bitflyer
         Thread.new do
           loop do
             sleep 1
-            if @websocket_client && @websocket_client.open?
+            if @websocket_client&.open?
               send_ping
               wait_pong
             end
@@ -41,6 +43,7 @@ module Bitflyer
           loop do
             sleep 1
             next unless @error
+
             reconnect
           end
         end
@@ -54,7 +57,7 @@ module Bitflyer
         return unless Time.now.to_i - @last_ping_at > @ping_interval / 1000
 
         debug_log 'Sent ping'
-        @websocket_client.send "2"
+        @websocket_client.send '2'
         @last_ping_at = Time.now.to_i
       end
 
@@ -68,6 +71,7 @@ module Bitflyer
 
       def reconnect
         return unless @error
+
         debug_log 'Reconnecting...'
 
         @error = nil
@@ -81,13 +85,15 @@ module Bitflyer
 
       def handle_error(error:)
         debug_log error
-        return unless error.kind_of? Errno::ECONNRESET
+        return unless error.is_a? Errno::ECONNRESET
+
         reconnect
       end
 
       def handle_message(payload:)
         debug_log payload.data
         return unless payload.data =~ /^\d+/
+
         code, body = payload.data.scan(/^(\d+)(.*)$/)[0]
 
         case code.to_i
@@ -96,15 +102,15 @@ module Bitflyer
         when 41 then disconnect
         when 42 then emit_message(json: body)
         end
-      rescue => e
+      rescue StandardError => e
         puts e
         puts e.backtrace.join("\n")
       end
 
       def setup_by_response(json:)
         body = JSON.parse json
-        @ping_interval = body["pingInterval"].to_i || 25000
-        @ping_timeout  = body["pingTimeout"].to_i || 60000
+        @ping_interval = body['pingInterval'].to_i || 25_000
+        @ping_timeout  = body['pingTimeout'].to_i || 60_000
         @last_ping_at = Time.now.to_i
         @last_pong_at = Time.now.to_i
         channel_callbacks.each do |channel_name, _|
@@ -125,11 +131,13 @@ module Bitflyer
       def emit_message(json:)
         channel_name, *messages = JSON.parse json
         return unless channel_name
+
         messages.each { |message| @channel_callbacks[channel_name.to_sym]&.call(message) }
       end
 
       def debug_log(message)
         return unless @debug
+
         p message
       end
     end

data/lib/bitflyer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bitflyer
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitflyer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuji Ueki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-07 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,6 +130,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -151,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Bitflyer API wrapper