procon_bypass_man 0.1.9 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e4ad788ed57ca3bac1d4d17b1648285c8bc8d89d23a3c0a4ca4d5aaa58e4dfd
-  data.tar.gz: 512a1f754cf255c6692ab597c7997d6bad3f3004c2f1203a1ce6adaec603e655
+  metadata.gz: 62fab79bffee3adf43af06325d7ef6bce2060f844d8caaa824968ff77219e5de
+  data.tar.gz: c15ab8b50da926169727b9af5ff097585cd35c7e24fdf2ce75d2ca7d4fe5f07e
 SHA512:
-  metadata.gz: 7a059a91051aee0fa59beb62aa7bd952b1c8db15a75d66c47a66fdbda96a60cd9285094524e1d3c619ec215fa47dc5f9ee44e4dd7524f6c2bd60a4d0dfcf25e3
-  data.tar.gz: 9748ad5293f1e3cc902d9b74bbb40997d0c9588e43e78ab4299eb4ddbb9bfd030a7f3bf717d58a3207ac51e348cc090b1a726d7f63780d705807e04db7d9201d
+  metadata.gz: c94bc5e37b89c54a31fe165e53f84ac32c1b4d10fc617cc1397e0347baf1a39206fd50aff3a65626b8546545d00f33ac0e44a90da5ff25c02778d27e60aafe0f
+  data.tar.gz: 7ad56ef9e17bb8a26d840003faf8fa7d065ba878182dcd23d66118b43053c2827221814f37bb4098174cdfbcc449486d895bf6431520f60ce295a4e7382c39e7

data/.gitignore

@@ -8,3 +8,8 @@
 /tmp/
 vendor
 todo.local.md
+*.log
+.setting_yaml_digest
+pbm_pid
+setting.yml
+device_id

data/.rubocop.yml

@@ -22,3 +22,5 @@ Lint/UselessAssignment:
     Enabled: false
 Lint/EmptyBlock:
     Enabled: false
+Lint/ReturnInVoidContext:
+    Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.1.13] - 2021-11-24
+- 起動を早くするために、procon_bypass_man-splatoon2を同梱しました
+
+## [0.1.12] - 2021-11-18
+- 起動ログなどを設定した外部サーバに送信できるようにしました
+
+## [0.1.11] - 2021-11-05
+- PBM-WEB(>= 0.1.3)でボタンの入力を見るためのスレッドが動くようになりました
+
+## [0.1.10] - 2021-10-28
+- ボタンを無効化するdisableを設定できるようになりました
+- pvmenvで生成する初期ファイルにprocon_bypass_man-webを同梱しました
+- PBM自体の設定の構文を変更しました
+
 ## [0.1.9] - 2021-10-20
 - 左スティックを傾けた時に設定した最大値内に丸めることができるようになりました
     - 関連メソッド: set_neutral_position, left_analog_stick_cap

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in procon_bypass_man.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake"
 gem "rspec"
 gem "pry"
 gem "timecop"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.9)
+    procon_bypass_man (0.1.13)
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +17,7 @@ GEM
     concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
     ffi (1.15.4)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     language_server-protocol (3.16.0.3)
     listen (3.7.0)
@@ -27,7 +27,7 @@ GEM
     minitest (5.14.4)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    parallel (1.20.1)
+    parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
@@ -41,7 +41,7 @@ GEM
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (1.6.2)
+    rbs (1.7.1)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -56,17 +56,17 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.20.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -90,20 +90,21 @@ GEM
     timecop (0.9.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     webrick (1.7.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   arm-linux
   arm64-darwin-20
+  arm64-darwin-21
   armv7l-linux
   x86_64-linux
 
 DEPENDENCIES
   procon_bypass_man!
   pry
-  rake (~> 13.0)
+  rake
   rbs
   rspec
   rubocop
@@ -113,4 +114,4 @@ DEPENDENCIES
   webrick
 
 BUNDLED WITH
-   2.2.22
+   2.2.30

data/README.md

@@ -28,8 +28,8 @@ Switch <-- (PBM): ZR連打
 ## Usage
 * USBガジェットモードで起動するRaspberry Pi4を用意する
   * https://github.com/splaplapla/procon_bypass_man/blob/master/docs/setup_raspi.md
-* Raspberry Pi4で https://github.com/jiikko/procon_bypass_man_sample をclone して実行ファイルを動かす
-  * 実行ファイルと設定ファイルについては https://github.com/splaplapla/procon_bypass_man/wiki に詳細を書いていますが、まず動かすためにはcloneしたほうが早いです
+* Raspberry Pi4 で sudo pbmenv install latest && cd /usr/share/pbm/current && sudo ruby app.rb
+  * 動いたのを確認したらserviceとして登録にするなどしてください
 
 ## Plugins
 * https://github.com/splaplapla/procon_bypass_man-splatoon2
@@ -52,6 +52,8 @@ Switch <-- (PBM): ZR連打
     * 連射中には特定のキーの入力を無視したり、複数のキーをトリガーに連射することができます
 * どうしてsudoが必要なの？
     * 操作するdeviceファイルの所有者がrootだから
+* 市販されているサードパーティ製連射機との違いは？
+    * サードパーティ製のコントローラーは、設定方法や形状が特殊で買い換えるたびに学習・設定コストが発生します。本ツールを使えば、設定内容はテキストで管理することができ、使い慣れたプロコンで同等のことができます。
 
 ## TODO
 * レコーディング機能(プロコンの入力をマクロとして登録ができる)
@@ -59,32 +61,28 @@ Switch <-- (PBM): ZR連打
 * 設定ファイル マクロの引数に、ボタンを取れるようにする
 
 ## 開発系
-```ruby
-ProconBypassMan.tap do |pbm|
-  pbm.root = File.expand_path(__dir__)
-  pbm.logger = Logger.new("#{ProconBypassMan.root}/app.log", 5, 1024 * 1024 * 10)
-  pbm.logger.level = :debug
-end
-```
-
 ### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
 ```shell
 sudo kill -USR2 `cat ./pbm_pid`
 ```
 
 ### 起動ログをサーバに送信する
-* `ProconBypassMan.api_server = "http://.."` を設定すると、 `POST /api/reports` に対して起動ログを送信するようになります
+* `ProconBypassMan.api_server = "http://.."` を設定すると、 `POST /api/events` に対して起動ログなどを送信するようになります
 
 ### 開発環境でログの送信を確認する方法
-* `bundle exec bin/report_receive_server.rb`
-* `bin/console`
-  * `ProconBypassMan.api_server = "http://localhost:4567"`
-  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::Reporter.report(body: message.to_hash)"`
+* `bundle exec bin/dev_api_server.rb`
+* `API_SERVER=http://localhost:4567 INTERNAL_API_SERVER=http://localhost:4567 bin/console`
+  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::ReportBootJob.perform(body: message.to_hash)`
 
 ### リリース手順
-* project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
+* project_template/web.rb, project_template/app.rb, lib/procon_bypass_man/version.rb のバージョンをあげる
+* CHANGELOG.md に日付を書く
 * be rake release
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Links
+* https://discord.gg/bEcRNKf4ep

data/bin/console

@@ -3,6 +3,7 @@
 
 require "bundler/setup"
 require "procon_bypass_man"
+require "pry"
 
 # 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.
@@ -12,4 +13,7 @@ require "procon_bypass_man"
 # Pry.start
 
 require "irb"
+
+ProconBypassMan.config.logger = Logger.new($stdout)
+
 IRB.start(__FILE__)

data/bin/{report_receive_server.rb → dev_api_server.rb}

@@ -4,8 +4,15 @@ require "sinatra"
 require "webrick"
 require "pry"
 
-post '/api/reports' do
+post '/api/events' do
   puts JSON.parse(request.body.read)
   status 200
   body ''
 end
+
+post '/api/pressed_buttons' do
+  r = JSON.parse(request.body.read)
+  puts r
+  status 200
+  body ''
+end

data/lib/procon_bypass_man/background/has_server_pool.rb

@@ -0,0 +1,54 @@
+module ProconBypassMan::Background::HasServerPool
+  class ServerPool
+    def initialize(servers: )
+      if servers.nil? || servers.empty?
+        return
+      end
+
+      @servers = servers
+      if @servers.size >= 1
+        @index = 0
+      else
+        @index = nil
+      end
+    end
+
+    def pick
+      if @index.nil?
+        return @servers&.first
+      end
+      @servers[@index] or raise "bug!!!"
+    end
+    def server; pick; end
+
+    def next!
+      inc_index
+      if @servers[@index].nil?
+        reset
+        return
+      end
+    end
+
+    def reset
+      @index = 0
+    end
+
+    def inc_index
+      @index = @index + 1
+    end
+  end
+
+  def reset_server_pool!
+    @pool_server = nil
+  end
+
+  def pool_server
+    @pool_server ||= ServerPool.new(
+      servers: servers
+    )
+  end
+
+  def servers
+    raise NotImplementedError, nil
+  end
+end

data/lib/procon_bypass_man/background/http_client.rb

@@ -0,0 +1,67 @@
+module ProconBypassMan
+  module Background
+    class HttpClient
+      class HttpRequest
+        def self.request!(uri: , hostname: , params: , device_id: , session_id: nil, event_type: )
+          @uri = uri
+          @http = Net::HTTP.new(uri.host, uri.port)
+          @http.use_ssl = uri.scheme === "https"
+          @params = {
+            hostname: hostname,
+            event_type: event_type,
+            session_id: session_id,
+            device_id: device_id,
+          }.merge(params)
+          @http.post(
+            @uri.path,
+            @params.to_json,
+            { "Content-Type" => "application/json" },
+          )
+        end
+      end
+
+      def initialize(path: , pool_server: , retry_on_connection_error: false)
+        @path = path
+        @pool_server = pool_server
+        @hostname = `hostname`.chomp
+        @retry_on_connection_error = retry_on_connection_error
+      end
+
+      def post(body: , event_type: )
+        if @pool_server.server.nil?
+          ProconBypassMan.logger.info('送信先が未設定なのでスキップしました')
+          return
+        end
+
+        params = { body: body.to_json }
+        session_id = ProconBypassMan.session_id
+        device_id = ProconBypassMan.device_id
+
+        response = HttpRequest.request!(
+          uri: URI.parse("#{@pool_server.server}#{@path}"),
+          hostname: @hostname,
+          device_id: device_id,
+          session_id: session_id,
+          params: params,
+          event_type: event_type,
+        )
+        case response.code
+        when /^200/
+          return
+        else
+          @pool_server.next!
+          ProconBypassMan.logger.error("200以外(#{response.code})が帰ってきました. #{response.body}")
+        end
+      rescue SocketError => e
+        ProconBypassMan.logger.error("error in outbound module: #{e}")
+        if @retry_on_connection_error
+          sleep(10)
+          retry
+        end
+      rescue => e
+        puts e
+        ProconBypassMan.logger.error("error in outbound module: #{e}")
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/background/job_performer.rb

@@ -0,0 +1,16 @@
+module ProconBypassMan
+  module Background
+    class JobPerformer
+      def initialize(klass: , args: )
+        @klass = klass
+        @args = args
+      end
+
+      def perform
+        @klass.perform(*@args)
+      rescue => e
+        ProconBypassMan::ReportErrorJob.perform(e)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/background/job_runnable.rb

@@ -0,0 +1,16 @@
+module ProconBypassMan
+  module Background
+    module JobRunnable
+      def perform(*)
+        raise NotImplementedError, nil
+      end
+
+      def perform_async(*args)
+        ProconBypassMan::Background::JobRunner.push(
+          args: args,
+          reporter_class: self,
+        )
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/background/job_runner.rb

@@ -0,0 +1,45 @@
+module ProconBypassMan
+  module Background
+    class JobRunner
+      MAX_QUEUE_SIZE = 100
+
+      def self.start!
+        new.start!
+      end
+
+      # for test
+      def stop!
+        return unless defined?(@thread)
+        @thread.kill
+      end
+
+      def start!
+        return if defined?(@thread)
+        @thread = Thread.new do
+          while(item = self.class.queue.pop)
+            begin
+              JobPerformer.new(klass: item[:reporter_class], args: item[:args]).perform
+              sleep(1)
+            rescue => e
+              ProconBypassMan.logger.error(e)
+            end
+          end
+        end
+        self
+      end
+
+      def self.queue
+        @@queue ||= Queue.new
+      end
+
+      def self.push(hash)
+        if queue.size > MAX_QUEUE_SIZE
+          ProconBypassMan.logger.error('Over queue size cap!!')
+          return
+        end
+
+        queue.push(hash)
+      end
+    end
+  end
+end

data/lib/procon_bypass_man/background/jobs/base_job.rb

@@ -0,0 +1,12 @@
+class ProconBypassMan::BaseJob
+  extend ProconBypassMan::Background::HasServerPool
+  extend ProconBypassMan::Background::JobRunnable
+
+  def self.servers
+    ProconBypassMan.config.api_servers
+  end
+
+  def self.path
+    "/api/events"
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_boot_job.rb

@@ -0,0 +1,10 @@
+class ProconBypassMan::ReportBootJob <  ProconBypassMan::BaseJob
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::Background::HttpClient.new(
+      path: path,
+      pool_server: pool_server,
+      retry_on_connection_error: true,
+    ).post(body: body, event_type: :boot)
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_error_job.rb

@@ -0,0 +1,10 @@
+class ProconBypassMan::ReportErrorJob < ProconBypassMan::BaseJob
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::Background::HttpClient.new(
+      path: path,
+      pool_server: pool_server,
+      retry_on_connection_error: false,
+    ).post(body: body, event_type: :error,)
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_heartbeat_job.rb

@@ -0,0 +1,10 @@
+class ProconBypassMan::ReportHeartbeatJob < ProconBypassMan::BaseJob
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::Background::HttpClient.new(
+      path: path,
+      pool_server: pool_server,
+      retry_on_connection_error: false,
+    ).post(body: body, event_type: :heartbeat)
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_load_config_job.rb

@@ -0,0 +1,10 @@
+class ProconBypassMan::ReportLoadConfigJob <  ProconBypassMan::BaseJob
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::Background::HttpClient.new(
+      path: path,
+      pool_server: pool_server,
+      retry_on_connection_error: false,
+    ).post(body: body, event_type: :load_config)
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_pressed_buttons_job.rb

@@ -0,0 +1,18 @@
+class ProconBypassMan::ReportPressedButtonsJob
+  extend ProconBypassMan::Background::HasServerPool
+  extend ProconBypassMan::Background::JobRunnable
+
+  PATH = "/api/pressed_buttons"
+
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::Background::HttpClient.new(
+      path: PATH,
+      pool_server: pool_server,
+    ).post(body: body, event_type: :internal)
+  end
+
+  def self.servers
+    ProconBypassMan.config.internal_api_servers
+  end
+end

data/lib/procon_bypass_man/background/jobs/report_reload_config_job.rb

@@ -0,0 +1,10 @@
+class ProconBypassMan::ReportReloadConfigJob <  ProconBypassMan::BaseJob
+  # @param [String] body
+  def self.perform(body)
+    ProconBypassMan::Background::HttpClient.new(
+      path: path,
+      pool_server: pool_server,
+      retry_on_connection_error: false,
+    ).post(body: body, event_type: :reload_config)
+  end
+end

data/lib/procon_bypass_man/background.rb

@@ -0,0 +1,12 @@
+require "procon_bypass_man/background/job_runnable"
+require "procon_bypass_man/background/job_runner"
+require "procon_bypass_man/background/job_performer"
+require "procon_bypass_man/background/has_server_pool"
+require "procon_bypass_man/background/http_client"
+require "procon_bypass_man/background/jobs/base_job"
+require "procon_bypass_man/background/jobs/report_boot_job"
+require "procon_bypass_man/background/jobs/report_reload_config_job"
+require "procon_bypass_man/background/jobs/report_load_config_job"
+require "procon_bypass_man/background/jobs/report_error_job"
+require "procon_bypass_man/background/jobs/report_heartbeat_job"
+require "procon_bypass_man/background/jobs/report_pressed_buttons_job"

data/lib/procon_bypass_man/boot_message.rb

@@ -6,15 +6,19 @@ class ProconBypassMan::BootMessage
     @table[:pid] = $$
     @table[:root_path] = ProconBypassMan.root
     @table[:pid_path] = ProconBypassMan.pid_path
-    @table[:setting_path] = ProconBypassMan::Configuration.instance.setting_path
+    @table[:setting_path] = ProconBypassMan::ButtonsSettingConfiguration.instance.setting_path
     @table[:uptime_from_boot] = ProconBypassMan::Uptime.from_boot
+    @table[:use_pbmenv] = !(!!`which pbmenv`.empty?)
 
-    build_version = `git rev-parse --short HEAD`.chomp
-    if build_version.empty?
-      @table[:build_version] = 'release version'
-    else
-      @table[:build_version] = build_version
-    end
+    # 開発中のHEADを取りたかったけど、Gem::Specification経由から取得する必要がありそう
+    # build_version = `git rev-parse --short HEAD`.chomp
+    # if build_version.empty?
+    #   @table[:build_version] = 'release version'
+    # else
+    #   @table[:build_version] = build_version
+    # end
+
+    # build version: #{@table[:build_version]}
   end
 
   # @return [String]
@@ -22,13 +26,13 @@ class ProconBypassMan::BootMessage
     booted_message = <<~EOF
       ----
       RUBY_VERSION: #{@table[:ruby_version]}
-      ProconBypassMan: #{@table[:pbm_version]}
+      ProconBypassMan::VERSION: #{@table[:pbm_version]}
       pid: #{@table[:pid]}
       root: #{@table[:root_path]}
       pid_path: #{@table[:pid_path]}
       setting_path: #{@table[:setting_path]}
       uptime from boot: #{@table[:uptime_from_boot]} sec
-      build version: #{@table[:build_version]}
+      use_pbmenv: #{@table[:use_pbmenv]}
       ----
     EOF
   end