sora 24.02.25 → 24.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595fdec94ad7aa62fa2490265ffd6633b039773570518115afd13446cf75f5aa
-  data.tar.gz: bab57e34ef9eb436ea590c8e5a3988cdd780e4ae657a254c5ecaadff82ef7239
+  metadata.gz: 7b5ced9f96a91bad46179bfd6c2cb86390ef87c80a43e986c02981a13327de16
+  data.tar.gz: 0b58886bafd8d8030b0262846a74da0747688bcd7719b48a88070e0c46173174
 SHA512:
-  metadata.gz: 221d63074168d433bbff41cb5507e381fa683b9e6ba8c5a46234b3c6e0764d38e0097582eda7981eb156098783058ef968a8612509813767bf8535d3fd2ff4af
-  data.tar.gz: 6c70324213cbf7a197939305b3c8892d3a4a7656ad6b689773fdc836354545f460ca06a257e899e034c374b22bf338c317426c0f2414e0115d2bb419df6c728c
+  metadata.gz: 25bd597229224b8d3971ca8492d17cec5c24e27e18dede006bde0e5627f17c07a85f222f9d9488e5da46a94811fccbfa05a56eeb2d66507bd0dd4d1359c8a736
+  data.tar.gz: 3e935a72f597d2ca57907625f94059886f2e5390f1c97733ee4041592801886227a8ade6ee1ea3d326cce0321233f8394c6052ccfcf17ea284895139c9f3078a

data/.rubocop.yml

@@ -1,19 +1,22 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-Layout/EndOfLine:
-  Enabled: False
-
-Metrics/MethodLength:
-  Enabled: False
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Layout/EndOfLine:
+  Enabled: False
+
+Metrics/MethodLength:
+  Enabled: False
+
+Metrics/AbcSize:
+  Enabled: False

data/CHANGELOG.md

@@ -1,5 +1,5 @@
-## [Unreleased]
-
-## [0.1.0] - 2024-02-24
-
-- Initial release
+## [Unreleased]
+
+## [0.1.0] - 2024-02-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,84 +1,84 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 TODO: Write your name
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.ja.md

@@ -0,0 +1,69 @@
+# sora
+[![Ruby](https://github.com/Himeyama/sora/actions/workflows/main.yml/badge.svg)](https://github.com/Himeyama/sora/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/sora.svg)](https://badge.fury.io/rb/sora)
+
+> ![sora](docs/screenshot.png)
+
+sora は文字列やファイルを送受信できる Ruby 製 http サーバです。
+
+sora (Server Of Ruby for Access) は、ファイルの送受信や、文字列を送信して情報を伝達することができます。
+
+- https://rubygems.org/gems/sora
+
+## インストール
+この gem は Windows と Linux で動作確認をしています。
+
+### インストール方法
+```ps1
+gem install sora
+```
+
+または
+
+```ps1
+rake install # リポジトリからインストールする
+```
+
+## sora とは
+sora はインストールされたマシンでサーバーを立ち上げる。
+そのマシンにLAN 内にあるスマホや他のマシンからアクセスすることで文字列やファイルを共有できます。
+
+次のコマンドは、sora サーバーを 8001 ポートで立ち上げるコマンドです。
+
+```ps1
+sora -p 8080 # または: sora
+```
+
+次にブラウザで、sora にアクセスしてみましょう。
+
+sora をインストールしたマシンでは、以下の url から sora にアクセスできます。
+
+[http://127.0.0.1:8080/](http://127.0.0.1:8080/)
+
+他の端末からはインストールしたマシンの IP アドレスを取得してアクセスします。
+IP アドレスは Windows の「設定」から確認可能で、「IPv4 アドレス」が対象の IP アドレスです。
+コンソールで `ipconfig` を実行して確認してもよいです。
+
+![get ipv4](docs/get-ipaddr.png)
+
+## 開発
+以下、開発者向けの説明です。
+
+- Windows
+- Ruby 3.2.3
+
+### 依存パッケージのインストール
+```ps1
+bundle install
+```
+
+### アプリの実行 
+```ps1
+bundle exec sora
+```
+
+### Webpack でスクリプトをコンパイル
+```ps1
+rake build:webpack
+```
+

data/README.md

@@ -1,4 +1,48 @@
-# Sora
-sora is an http server in Ruby that can send and receive strings and files.
-
-sora (Server Of Ruby for Access) can send and receive files, and transmit text strings to communicate information.
+# sora
+[![Ruby](https://github.com/Himeyama/sora/actions/workflows/main.yml/badge.svg)](https://github.com/Himeyama/sora/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/sora.svg)](https://badge.fury.io/rb/sora)
+
+> ![sora](docs/screenshot.png)
+
+[日本語の README](/README.ja.md)
+
+sora is an http server in Ruby that can send and receive strings and files.
+
+sora (Server Of Ruby for Access) can send and receive files, and transmit text strings to communicate information.
+
+- https://rubygems.org/gems/sora
+
+## Installation
+This gem is supported on Windows and Linux.
+
+### How to Install
+```ps1
+gem install sora
+```
+
+or
+
+```ps1
+rake install # Install from repository
+```
+
+## About sora
+Sola sets up a server on the installed machine. Strings and files can be shared by accessing that machine from smartphones or other machines in the LAN.
+
+The following command will bring up the sora server on port 8080.
+
+```ps1
+sora -p 8080 # or: sora
+```
+
+Next, let's access sora with a browser.
+
+On a machine with sora installed, you can access sora from the following url.
+
+[http://127.0.0.1:8080/](http://127.0.0.1:8080/)
+
+From other terminals, the IP address of the installed machine is obtained and accessed.
+The IP address can be checked from the Windows `Settings`, where `IPv4 address` is the target IP address.
+You can also check it by running `ipconfig` in the console.
+
+![get ipv4](docs/get-ipaddr.png)

data/Rakefile

@@ -1,8 +1,12 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: :rubocop
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop
+
+task "build:webpack" do
+  sh "yarn --cwd src run webpack --mode production -o www -w"
+end

data/cgi-bin/get.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "json"
+require "securerandom"
+
+def get_content_type(filename)
+  content_types = {
+    ".txt" => "text/plain",
+    ".json" => "application/json",
+    ".js" => "text/javascript",
+    ".css" => "text/css",
+    ".csv" => "text/csv",
+    ".pdf" => "application/pdf",
+    ".xls" => "application/vnd.ms-excel",
+    ".xlsx" => "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    ".doc" => "application/msword",
+    ".docx" => "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+    ".ppt" => "application/vnd.ms-powerpoint",
+    ".pptx" => "application/vnd.openxmlformats-officedocument.presentationml.presentation",
+    ".gif" => "image/gif",
+    ".bmp" => "image/bmp",
+    ".svg" => "image/svg+xml",
+    ".zip" => "application/zip",
+    ".lzh" => "application/x-lzh",
+    ".tar" => "application/x-tar",
+    ".mp3" => "audio/mpeg",
+    ".mp4" => "video/mp4",
+    ".mpeg" => "video/mpeg",
+    ".jpg" => "image/jpeg",
+    ".jpeg" => "image/jpeg",
+    ".png" => "image/png",
+    ".html" => "text/html"
+  }
+
+  ext = File.extname(filename)
+  content_types[ext] || "text/html"
+end
+
+#
+# ファイルを取得
+#
+# GET: /get?filename=image.png
+#
+def file
+  cgi = CGI.new
+  params = cgi.params
+  unless params.key?("filename")
+    print cgi.header("application/json")
+    print(JSON.pretty_generate({ status: "NG" }))
+    return
+  end
+
+  if params["filename"].empty?
+    print cgi.header("application/json")
+    print(JSON.pretty_generate({ status: "NG" }))
+    return
+  end
+
+  file_path = File.join(File.expand_path("../data"), params["filename"][0])
+  File.open(file_path, "rb") do |f|
+    cgi.out(
+      {
+        "type" => get_content_type(file_path),
+        "content-disposition" => "inline; filename=#{File.basename(file_path)}"
+      }
+    ) do
+      f.read
+    end
+  end
+end
+
+file

data/cgi-bin/main.rb

@@ -7,8 +7,20 @@ require "securerandom"
 cgi = CGI.new
 print cgi.header("application/json")
 params = cgi.params
+
 @json_file_path = "../data/data.json"
 
+def log(text)
+  open("tmp", "a") do |f|
+    f.puts(text)
+  end
+end
+
+#
+# JSON ファイルを読み込んで配列として返す関数
+#
+#   text = read_json("data.tmp")
+#
 def read_json(filename)
   unless File.exist? filename
     File.open(filename, "w") do |f|
@@ -22,24 +34,41 @@ def read_json(filename)
   json
 end
 
+#
+# データを取得
+#
+# - データがある場合: データを追加して保存し内容を JSON 形式で表示
+# - データがない場合: 内容を JSON 形式で表示
+#
+# GET: /cgi-bin?data=
+# GET: /cgi-bin?data=12345
+#
 def get_json(params)
   return unless params.key?("data")
 
-  data = params["data"][0]
+  data = params["data"]
   json = read_json(@json_file_path)
 
-  if data != "" && !data.nil?
-    json.append({
-                  content: data,
-                  uuid: SecureRandom.uuid
-                })
-    File.open(@json_file_path, "w") do |f|
-      f.write JSON.pretty_generate(json)
+  unless data.nil?
+    content = data[0]
+    if content != ""
+      json.append({
+                    content: content,
+                    uuid: SecureRandom.uuid
+                  })
+      File.open(@json_file_path, "w") do |f|
+        f.write JSON.pretty_generate(json)
+      end
     end
   end
   print(JSON.pretty_generate(json))
 end
 
+#
+# コンテンツを削除する
+#
+# GET: /cgi-bin?delete=9cba8adc-2f1f-4feb-86dd-e6daf0d26d41
+#
 def delete(params)
   return unless params.key?("delete")
 
@@ -57,5 +86,68 @@ def delete(params)
   print JSON.pretty_generate(response)
 end
 
+def save_file(params)
+  return unless params.key?("file")
+
+  file = params["file"][0]
+  response = {
+    filename: file.original_filename
+  }
+
+  return if [".gitignore", "data.json"].include?(response[:filename])
+
+  file_path = File.join(File.expand_path("../data"), response[:filename])
+
+  File.open(file_path, "wb") do |f|
+    f.write file.read
+  end
+
+  print JSON.pretty_generate(response)
+end
+
+def remove_file(params)
+  return unless params.key?("removefile")
+
+  removefiles = params["removefile"]
+  if removefiles.empty?
+    print JSON.pretty_generate({ status: "NG" })
+    return
+  end
+
+  removefile = removefiles[0]
+  response = {
+    filename: removefile,
+    status: "NG"
+  }
+
+  if [".gitignore", "data.json", ""].include?(removefile)
+    print JSON.pretty_generate({ status: "NG" })
+    return
+  end
+
+  file_path = File.join(File.expand_path("../data"), removefile)
+
+  response[:status] = "OK" if File.exist?(file_path) && File.delete(file_path)
+
+  print JSON.pretty_generate(response)
+end
+
+#
+# ファイル一覧を取得
+#
+# GET: /cgi-bin?files
+#
+def get_files(params)
+  return unless params.key?("files")
+
+  response = Dir.glob(File.join(File.expand_path("../data"), "*"))
+  response.map! { |e| File.basename(e) }
+  response.filter! { |e| !["data.json", ".gitignore"].include?(e) }
+  print JSON.pretty_generate(response)
+end
+
 get_json(params)
 delete(params)
+save_file(params)
+get_files(params)
+remove_file(params)

data/data/.gitignore

@@ -1 +1,2 @@
-data.json
+!.gitignore
+*

data/exe/sora

@@ -6,9 +6,9 @@ require "optparse"
 
 opt = OptionParser.new
 
-params = { port: 8080, document_root: File.expand_path("../../www", __FILE__) }
+params = { port: 8080, document_root: File.expand_path("../www", __dir__) }
 
-opt.on("-p [PORT]", "--port [PORT]") { |v| params[:port] = v.to_i }
+opt.on("-p [PORT]", "--port [PORT]", "Port number, default: 8080") { |v| params[:port] = v.to_i }
 
 opt.parse!(ARGV)