bitflyer-cli 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0bc41cd1651df77286923e598cb0af3bea5b90f19168c6af1b2aa8b9ce2b056
-  data.tar.gz: dcdced9d98ae4a05492cd452f97bd2ec096f8e809116d51cc419e6320f8ed832
+  metadata.gz: ddca3f608079462d31cb86831e22fe67edfb00fa055bc3bef1ff092c4647ba60
+  data.tar.gz: 383c32699f7aa5d8f554b1edcc5a6aa5bd82dd07518edf93cf1069794c9e5d80
 SHA512:
-  metadata.gz: d2f5ca212d01caf38fd10395370083da64b7c14f7a6cc9e098ffdeb285f53b5bce8bf995e25d79647c323df352f71e1997d2eda42066f76d148211e275473ce9
-  data.tar.gz: 7d7b5c860605a9551493063353700a8dbf50c8dda913a9270a10d98163bd01090c0b10badc0c0c4492c51b4b442d42049a7678ff59aef8c8c2e306fc9da95c97
+  metadata.gz: 8d00cc6795858857d1e5165777c0389afb3ed8b355e128349f1b068e6afb31a7da2538697b6132b32a514e804db766560a3cd8159bd9101c96dc621e972b20e2
+  data.tar.gz: faf067d80282c993290ff84ae73a3f0880b89fe6193df8489d32ecadb9cc83eab0458d8ea48416216625316f4400210fd336c61c3772ae9a6db5a00e0c6e61a3

data/.github/workflows/test.yml

@@ -3,13 +3,29 @@ name: test
 on: [push]
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4.4'
+          rubygems: latest
+      - name: Install bundler
+        run: gem install bundler
+      - name: Install dependencies
+        run: bundle install --jobs 4
+      - name: Run lint
+        run: bundle exec rubocop
+
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby: ['3.4.4', '3.3.8', '3.2.8', '3.1.7']
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.rubocop.yml

@@ -0,0 +1,12 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  NewCops: enable
+  Include:
+    - 'lib/**/*.rb'
+  TargetRubyVersion: 3.1
+Style/Documentation:
+  Enabled: false
+Layout/LineLength:
+  Max: 120
+Naming/HeredocDelimiterNaming:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,16 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-06-28 13:43:17 UTC using RuboCop version 1.77.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: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - '**/*.arb'
+    - 'exe/bitflyer'

data/Gemfile.lock

@@ -1,57 +1,97 @@
 PATH
   remote: .
   specs:
-    bitflyer-cli (1.0.0)
+    bitflyer-cli (1.0.1)
       bigdecimal
       bitflyer (>= 2.0)
       colorize (>= 0.8.1, < 1.2.0)
-      thor (>= 0.20, < 1.4)
+      thor (>= 0.20, < 1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (3.2.2)
+    bigdecimal (4.0.1)
     bitflyer (2.0.1)
       faraday (>= 1.0)
       faraday_middleware (>= 1.2)
       websocket-client-simple (>= 0.9)
     colorize (1.1.0)
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.2)
     event_emitter (0.2.6)
-    faraday (1.4.3)
+    faraday (1.10.4)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      multipart-post (>= 1.2, < 3)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
+    faraday-em_synchrony (1.0.1)
     faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.2.0)
+      multipart-post (~> 2.0)
     faraday-net_http (1.0.2)
     faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
     faraday_middleware (1.2.1)
       faraday (~> 1.0)
+    json (2.18.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     multipart-post (2.4.1)
     mutex_m (0.3.0)
-    rake (13.2.1)
-    rspec (3.13.0)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
+    rspec-support (3.13.7)
+    rubocop (1.84.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    thor (1.3.1)
+    thor (1.5.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
     websocket (1.2.11)
     websocket-client-simple (0.9.0)
       base64
@@ -67,6 +107,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   rake
   rspec
+  rubocop
 
 BUNDLED WITH
    2.6.9

data/bitflyer-cli.gemspec

@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bitflyer', '>= 2.0'
   spec.add_dependency 'bigdecimal'
   spec.add_dependency 'colorize', '>= 0.8.1', '< 1.2.0'
-  spec.add_dependency 'thor', '>= 0.20', '< 1.4'
+  spec.add_dependency 'thor', '>= 0.20', '< 1.6'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/bitflyer/cli/authorization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Authorization
   def api_key
     ENV['BITFLYER_API_KEY'] || puts('environment variable BITFLYER_API_KEY is not set')
@@ -6,4 +8,4 @@ module Authorization
   def api_secret
     ENV['BITFLYER_API_SECRET'] || puts('environment variable BITFLYER_API_SECRET is not set')
   end
-end
+end

data/lib/bitflyer/cli/command/cancel_all_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bitflyer/cli/has_http_client'
 
 class CancelAllCommand

data/lib/bitflyer/cli/command/counter_trade_command.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require 'bitflyer/cli/has_http_client'
 
 class CounterTradeCommand
   include HasHTTPClient
 
-  def run
+  def run # rubocop:disable Metrics/MethodLength
     position = Position.new(http_private_client.positions)
     size = position.size.abs.to_f
-    type = position.size > 0 ? 'SELL' : 'BUY'
+    type = position.size.positive? ? 'SELL' : 'BUY'
     response = http_private_client.send_child_order(
-        product_code: 'FX_BTC_JPY',
-        child_order_type: 'MARKET',
-        side: type,
-        size: size
+      product_code: 'FX_BTC_JPY',
+      child_order_type: 'MARKET',
+      side: type,
+      size: size
     )
     if response['child_order_acceptance_id'].nil?
-      puts 'An error has occurred' + response.to_s
+      puts "An error has occurred#{response}"
     else
       puts "Clear position #{type} / #{size}"
     end
   end
-end
+end

data/lib/bitflyer/cli/command/ifdoco_by_range_command.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'bitflyer/cli/has_http_client'
 require 'bitflyer/cli/model/position'
 
 class IFDOCOByRangeCommand
   include HasHTTPClient
 
-  def run(options)
+  def run(options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     side = options.type.upcase
     size = options.amount.abs
     ratio = options.percentage.to_f
@@ -17,7 +19,7 @@ class IFDOCOByRangeCommand
     response = http_private_client.send_parent_order(request)
 
     if response['parent_order_acceptance_id'].nil?
-      puts 'An error has occurred' + response.to_s
+      puts "An error has occurred#{response}"
     else
       puts "Send market order #{side} / #{size.to_f}"
       puts "Set limit order #{side} / #{profit_price} / #{size.to_f}"
@@ -27,7 +29,7 @@ class IFDOCOByRangeCommand
 
   private
 
-  def request(side:, size:, profit_price:, loss_price:)
+  def request(side:, size:, profit_price:, loss_price:) # rubocop:disable Metrics/MethodLength
     {
       order_method: 'IFDOCO',
       time_in_force: 'GTC',
@@ -58,9 +60,9 @@ class IFDOCOByRangeCommand
 
   def profit_line(side:, current_price:, range:, ratio:)
     if side == 'BUY'
-      current_price + range * ratio / 100.0
+      current_price + (range * ratio / 100.0)
     elsif side == 'SELL'
-      current_price - range * ratio / 100.0
+      current_price - (range * ratio / 100.0)
     else
       0
     end
@@ -68,11 +70,11 @@ class IFDOCOByRangeCommand
 
   def loss_line(side:, current_price:, range:, ratio:)
     if side == 'BUY'
-      current_price - range * (100.0 - ratio) / 100.0
+      current_price - (range * (100.0 - ratio) / 100.0)
     elsif side == 'SELL'
-      current_price + range * (100.0 - ratio) / 100.0
+      current_price + (range * (100.0 - ratio) / 100.0)
     else
       0
     end
   end
-end
+end

data/lib/bitflyer/cli/command/order_by_best_command.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'bitflyer/cli/has_http_client'
 
 class OrderByBestCommand
   include HasHTTPClient
 
-  def run(options)
+  def run(options) # rubocop:disable Metrics/MethodLength
     amount = options.amount
     type = options.type
 
@@ -11,17 +13,17 @@ class OrderByBestCommand
     price = type == 'buy' ? ticker['best_bid'] : ticker['best_ask']
 
     response = http_private_client.send_child_order(
-        product_code: 'FX_BTC_JPY',
-        child_order_type: 'LIMIT',
-        side: type.upcase,
-        price: price,
-        size: amount
+      product_code: 'FX_BTC_JPY',
+      child_order_type: 'LIMIT',
+      side: type.upcase,
+      price: price,
+      size: amount
     )
 
     if response['child_order_acceptance_id'].nil?
-      puts 'An error has occurred' + response.to_s
+      puts "An error has occurred#{response}"
     else
       puts "An order is created #{type} / #{price} / #{amount}"
     end
   end
-end
+end

data/lib/bitflyer/cli/command/order_by_twap_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bitflyer/cli/has_http_client'
 
 class OrderByTWAPCommand
@@ -17,18 +19,18 @@ class OrderByTWAPCommand
 
   private
 
-  def order(type, amount)
+  def order(type, amount) # rubocop:disable Metrics/MethodLength
     response = http_private_client.send_child_order(
-        product_code: 'FX_BTC_JPY',
-        child_order_type: 'MARKET',
-        side: type.upcase,
-        size: amount
+      product_code: 'FX_BTC_JPY',
+      child_order_type: 'MARKET',
+      side: type.upcase,
+      size: amount
     )
 
     if response['child_order_acceptance_id'].nil?
-      puts "An error has occurred\n" + response.to_s
+      puts "An error has occurred\n#{response}"
     else
-      puts response.to_s
+      puts response
     end
   end
-end
+end

data/lib/bitflyer/cli/command/stop_by_range_command.rb

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 require 'bitflyer/cli/has_http_client'
 require 'bitflyer/cli/model/position'
 
 class StopByRangeCommand
   include HasHTTPClient
 
-  def run(options)
+  def run(options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     position = Position.new(http_private_client.positions)
-    return puts "You don't have any position now." if position.size == 0
+    return puts "You don't have any position now." if position.empty?
 
-    side = position.average > 0 ? 'SELL' : 'BUY'
-    price = position.average.abs + options.range * (side == 'BUY' ? 1.0 : -1.0)
+    side = position.average.positive? ? 'SELL' : 'BUY'
+    price = position.average.abs + (options.range * (side == 'BUY' ? 1.0 : -1.0))
 
     response = http_private_client.send_parent_order(
-        order_method: 'SIMPLE',
-        parameters: [{
-            product_code: 'FX_BTC_JPY',
-            condition_type: 'STOP',
-            side: side,
-            trigger_price: price,
-            size: position.size.to_f
-        }]
+      order_method: 'SIMPLE',
+      parameters: [{
+        product_code: 'FX_BTC_JPY',
+        condition_type: 'STOP',
+        side: side,
+        trigger_price: price,
+        size: position.size.to_f
+      }]
     )
 
     if response['parent_order_acceptance_id'].nil?
-      puts 'An error has occurred' + response.to_s
+      puts "An error has occurred#{response}"
     else
       puts "Set limit order #{side} / #{price} / #{position.size.to_f}"
     end
   end
-end
+end

data/lib/bitflyer/cli/command/summary_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bitflyer/cli/has_http_client'
 require 'bitflyer/cli/has_realtime_client'
 require 'bitflyer/cli/ext/string'
@@ -7,34 +9,34 @@ class SummaryCommand
   include HasHTTPClient
   include HasRealtimeClient
 
-  BUFFER_SIZE = 30.freeze
+  BUFFER_SIZE = 30
 
   def initialize
     @current_price = 0.0
 
-    realtime_client.executions_fx_btc_jpy = ->(message) {
+    realtime_client.executions_fx_btc_jpy = lambda { |message|
       message.each { |m| @current_price = m['price'].to_f }
     }
 
     update_balance
   end
 
-  def run
+  def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     $stdout.sync = true
 
     Thread.new do
-      while true
+      loop do
         update_balance
         sleep 5
       end
     end
 
-    while true
-      print <<-"EOS"
-\e[4F\e[0JCurrent:  #{@current_price.to_i.to_s.split_by_comma}
-Position: #{@position.average.to_s.split_by_comma} * #{@position.size.to_f}
-Spread:   #{spread.to_s.split_by_comma.color_with_number(spread)}
-Balance:  #{(@balance + profit).to_s.split_by_comma.ljust(15, ' ')} (#{profit.to_s.split_by_comma.color_with_number(profit)})
+    loop do
+      print <<~EOS
+        \e[4F\e[0JCurrent:  #{@current_price.to_i.to_s.split_by_comma}
+        Position: #{@position.average.to_s.split_by_comma} * #{@position.size.to_f}
+        Spread:   #{spread.to_s.split_by_comma.color_with_number(spread)}
+        Balance:  #{(@balance + profit).to_s.split_by_comma.ljust(15, ' ')} (#{profit.to_s.split_by_comma.color_with_number(profit)})
       EOS
       sleep 0.1
     end
@@ -48,13 +50,15 @@ Balance:  #{(@balance + profit).to_s.split_by_comma.ljust(15, ' ')} (#{profit.to
   end
 
   def profit
-    return 0 if @current_price == 0
+    return 0 if @current_price.zero?
+
     @position.profit(@current_price).to_i
   end
 
   def spread
-    return 0 if @current_price == 0
-    return 0 if @position.average.to_i == 0
+    return 0 if @current_price.zero?
+    return 0 if @position.average.to_i.zero?
+
     @current_price.to_i - @position.average.to_i
   end
-end
+end

data/lib/bitflyer/cli/ext/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'colorize'
 
 class String
@@ -7,6 +9,6 @@ class String
   end
 
   def split_by_comma
-    reverse.gsub( /(\d{3})(?=\d)/, '\1,').reverse
+    reverse.gsub(/(\d{3})(?=\d)/, '\1,').reverse
   end
-end
+end

data/lib/bitflyer/cli/has_http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bitflyer'
 require 'bitflyer/cli/authorization'
 
@@ -11,4 +13,4 @@ module HasHTTPClient
   def http_private_client
     @http_private_client ||= Bitflyer.http_private_client(api_key, api_secret)
   end
-end
+end

data/lib/bitflyer/cli/has_realtime_client.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'bitflyer'
 
 module HasRealtimeClient
   def realtime_client
     @realtime_client ||= Bitflyer.realtime_client
   end
-end
+end

data/lib/bitflyer/cli/model/position.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
 require 'bigdecimal/util'
 
@@ -8,20 +10,20 @@ class Position
 
   def profit(current_price)
     @positions.inject('0'.to_d) do |sum, position|
-      sum + (current_price - position['price'].to_s.to_d) * position['size'].to_s.to_d * coefficient(position)
+      sum + ((current_price - position['price'].to_s.to_d) * position['size'].to_s.to_d * coefficient(position))
     end
   end
 
   def average
-    @positions.size > 0 ? (sum / size.abs).to_i : 0
+    @positions.size.positive? ? (sum / size.abs).to_i : 0
   end
 
   def sum
-    @positions.inject('0'.to_d) { |sum, position| sum + position['price'].to_s.to_d * position['size'].to_s.to_d }
+    @positions.inject('0'.to_d) { |sum, position| sum + (position['price'].to_s.to_d * position['size'].to_s.to_d) }
   end
 
   def size
-    @positions.inject('0'.to_d) { |sum, position| sum + position['size'].to_s.to_d * coefficient(position) }
+    @positions.inject('0'.to_d) { |sum, position| sum + (position['size'].to_s.to_d * coefficient(position)) }
   end
 
   private

data/lib/bitflyer/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Bitflyer
   module Cli
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/lib/bitflyer/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'bitflyer/cli/command/cancel_all_command'
 require 'bitflyer/cli/command/counter_trade_command'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitflyer-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Yuji Ueki
@@ -66,7 +66,7 @@ dependencies:
         version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -76,7 +76,7 @@ dependencies:
         version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
 description: CLI tool for Bitflyer
 email:
 - unhappychoice@gmail.com
@@ -131,6 +145,8 @@ files:
 - ".github/workflows/release.yaml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile