procon_bypass_man 0.1.8 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f5d2c0b9137168508351ca8a1492470cd1f03c31d7eb920010a32f08f92122e
-  data.tar.gz: c7f42dd711cb3d8932a8fd6d99ee0735084618411e6cd723eeee8860ca96cd8c
+  metadata.gz: 42551d494786247ae06f81c416f522360001fb0a78ffdd67311520aafb56587a
+  data.tar.gz: 92da20f533512ec4e1fdebe93f2c064f5ae1513fd6f26d3c4f34f2a0d488dffd
 SHA512:
-  metadata.gz: 71a45ddf739c64355197e1a0610d2441eb6445eb6d77eef8fd9cf711265d0a9fc23dfcf2d75075115bf1e546141fec7eab0e20c6469feff6b7dea238d4916951
-  data.tar.gz: 1bb4bc56c9310d94d682454b33c3d28ebc0a45753ee292c98cdee47bc94b3400c50ddbbb9c1f08b17ade330829760b4dbc1eef85ea22faf1aa8f9271e1b53e0f
+  metadata.gz: b52fde78831c29dc1b56b56217a604e421b6c0cdf5859b997732b36d94b9b7dc9d02f3906835d41df5f7168a2b694c2c457d3f96fd235903fc4827f42e74422b
+  data.tar.gz: 50defecca29919fca30680469deddc5adc5c41d0c4f02f084c0a73f9633aa8e11101a5f07e863ea4e0b6481178d4f11e0d466a4bf2d9954f08cb5407d3cb10dd

data/.circleci/config.yml

@@ -32,15 +32,16 @@ jobs:
       - run: bundle install --jobs 4
       - run: bundle exec rubocop
       - run: bundle exec rspec
+      - run: bundle exec steep check
 
 build_jobs: &build_jobs
   - rspec:
       matrix:
         parameters:
           version:
-            - "2.5"
             - "2.7"
-            - "3.0"
+            - "3.0.1"
+            - "3.0.2"
 workflows:
   version: 2
   build:

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0.1']
 
     steps:
     - uses: actions/checkout@v2
@@ -24,10 +24,11 @@ jobs:
     # 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@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
-      run: bundle exec rubocop
-      run: bundle exec rake
+      run: |-
+        bundle exec rake
+        bundle exec steep check

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/.ruby-version

@@ -1 +1 @@
-3.0.1
+3.0.2

data/CHANGELOG.md

@@ -1,5 +1,22 @@
+## [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
+- 数時間に一度起きる、数秒間入力が通らなくなる問題の改善
+
 ## [0.1.8] - 2021-09-19
--  使える場合、GC.auto_compactを有効にする
+- 使える場合、GC.auto_compactを有効にしました
+- 起動ログにuptimeからの経過時間を表示しました
 
 ## [0.1.7] - 2021-09-11
 - Support pbmenv

data/Gemfile

@@ -10,3 +10,7 @@ gem "rspec"
 gem "pry"
 gem "timecop"
 gem "rubocop", require: false
+gem "steep", require: false
+gem 'rbs', require: false
+gem "sinatra", require: false
+gem "webrick", require: false

data/Gemfile.lock

@@ -1,23 +1,47 @@
 PATH
   remote: .
   specs:
-    procon_bypass_man (0.1.8)
+    procon_bypass_man (0.1.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
+    ffi (1.15.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
+    minitest (5.14.4)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     parallel (1.20.1)
     parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
     rainbow (3.0.0)
     rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (1.6.2)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -45,12 +69,35 @@ GEM
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    steep (0.46.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 1.2.0)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tilt (2.0.10)
     timecop (0.9.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    webrick (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   arm-linux
   arm64-darwin-20
+  arm64-darwin-21
   armv7l-linux
   x86_64-linux
 
@@ -58,9 +105,13 @@ DEPENDENCIES
   procon_bypass_man!
   pry
   rake (~> 13.0)
+  rbs
   rspec
   rubocop
+  sinatra
+  steep
   timecop
+  webrick
 
 BUNDLED WITH
-   2.2.15
+   2.2.30

data/README.md

@@ -1,4 +1,6 @@
 # ProconBypassMan
+[![Ruby](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/splaplapla/procon_bypass_man/actions/workflows/ruby.yml)
+
 * Switchに繋いだプロコンを連射機にしたり、キーのリマップをしたり、マクロを実行できるツールです
     * 設定ファイルはrubyスクリプトで記述します
 * 特定のタイトルに特化した振る舞いにしたい時は各プラグインを使ってください
@@ -57,21 +59,25 @@ 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
-```
+* pbmenvで生成するapp.rbに開発用ブランチを参照してください
 
 ### プロコンとの接続を維持したまま、現在の設定ファイルをPBMに反映する
 ```shell
 sudo kill -USR2 `cat ./pbm_pid`
 ```
 
+### 起動ログをサーバに送信する
+* `ProconBypassMan.api_server = "http://.."` を設定すると、 `POST /api/events` に対して起動ログなどを送信するようになります
+
+### 開発環境でログの送信を確認する方法
+* `bundle exec bin/dev_api_server.rb`
+* `INTERNAL_API_SERVER=http://localhost:4567 bin/console`
+* `API_SERVER=http://localhost:4567 bin/console`
+  * `message = ProconBypassMan::BootMessage.new; ProconBypassMan::ReportBootJob.report(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

data/Steepfile

@@ -0,0 +1,39 @@
+# D = Steep::Diagnostic
+#
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+#
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+# end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end
+
+target :lib do
+  check "lib/procon_bypass_man/timer.rb"
+  check "lib/procon_bypass_man/uptime.rb"
+  check "lib/procon_bypass_man/configuration.rb"
+
+  signature "sig"
+
+  library "time"
+  library "logger"
+  library "monitor"
+end

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/dev_api_server.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "webrick"
+require "pry"
+
+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/docs/setup_raspi.mitamae.rb

@@ -41,6 +41,18 @@ execute "Initialize PBM" do
  SHELL
 end
 
+# rbenv
+execute "Install rbenv" do
+  not_if "which rbenv"
+  command "git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build"
+end
+
+# ruby
+execute "Install ruby" do
+  not_if "rbenv versions | grep 3.0.1"
+  command "rbenv install 3.0.1"
+end
+
 run_command 'sudo systemctl disable triggerhappy.socket'
 run_command 'sudo systemctl disable triggerhappy.service'
 run_command 'sudo systemctl disable bluetooth'

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,70 @@
+module ProconBypassMan
+  module Background
+    class HttpClient
+      class HttpRequest
+        def self.request!(uri: , hostname: , body: , 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(body)
+          @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
+        if body.is_a?(Hash)
+          body = { body: body, event_type: event_type }
+        else
+          body = { body: { value: body, event_type: event_type } }
+        end
+        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,
+          body: body,
+          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,44 @@
+module ProconBypassMan
+  module Background
+    class JobRunner
+      MAX_QUEUE_SIZE = 100
+
+      def self.start!
+        new.start!
+      end
+
+      # for test
+      def self.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
+      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_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,10 @@
+require "procon_bypass_man/background/job_runnable"
+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_error_job"
+require "procon_bypass_man/background/jobs/report_heartbeat_job"
+require "procon_bypass_man/background/jobs/report_pressed_buttons_job"