tsumanne 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cebc96065c92a00109bc21cce1738bbe6d0d9576abeca0b7ee1915cce48da1c4
-  data.tar.gz: ceab470a37553e4a9811047a4c29deaa048deffb621ae592c4976199067fb306
+  metadata.gz: 752ff6fe9658226339a08a115d6cce82cd8923b31a04908f81828a8f29b7cbd2
+  data.tar.gz: 2b5c2b610ff91d998c1dc21f991d8896bdf55d303c006c542a21ef5e0da3f3d2
 SHA512:
-  metadata.gz: 288fc7f85c1999d509dea4c74797aaaa968caf340fbc657de50ab69b6708c9d30a7b3bc2f2a6e86ac5a19b40ac5ea4b9f5d4dc2bdcc93849856a0d5e0c827a32
-  data.tar.gz: aca354d1cef58425efc27c76d0bb839a12441cb8f93b345de0ee5e6c725f6f1a642cf2a16986a6fca18055117d8360ab5112df0538a95088c0745f5091dfbce4
+  metadata.gz: 1fccf450ca71ee827218be4b2d4fd3633bd3e7183eb0847dedc015f293d303f2614a5c27bfa8351868b6105fbe381de7dc22f9bad591ad3ff23d1eaa6b89d0c7
+  data.tar.gz: 9a12be921f3d1d4acfe4b3253035fed4072d9c3ca9983e70e1399bb6b594dccb592590b36920a1dca900f63a7bb7031b720ec9a01d4fbf973359ad6905f9e059

data/README.md

@@ -1,5 +1,17 @@
 # Tsumanne
 
+[![Rake]](https://github.com/eggplants/tsumanne/actions/workflows/rake.yml)
+[![Release Gem]](https://github.com/eggplants/tsumanne/actions/workflows/release.yml)
+[![Gem Version]](https://badge.fury.io/rb/tsumanne)
+[![Maintainability]](https://codeclimate.com/github/eggplants/tsumanne/maintainability)
+[![Test Coverage]](https://codeclimate.com/github/eggplants/tsumanne/test_coverage)
+
+[Rake]: <https://github.com/eggplants/tsumanne/actions/workflows/rake.yml/badge.svg>
+[Release Gem]: <https://github.com/eggplants/tsumanne/actions/workflows/release.yml/badge.svg>
+[Gem Version]: <https://badge.fury.io/rb/tsumanne.svg>
+[Maintainability]: <https://api.codeclimate.com/v1/badges/673df4b2c0e15b80f06c/maintainability>
+[Test Coverage]: <https://api.codeclimate.com/v1/badges/673df4b2c0e15b80f06c/test_coverage>
+
 API Wrapper for tsumanne.net
 
 ## Installation
@@ -24,7 +36,7 @@ rake
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eggplants/tsumanne.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/eggplants/tsumanne>.
 
 ## License
 

data/Rakefile

@@ -1,25 +1,37 @@
+# typed: ignore
+
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
+# require "sorbet-runtime"
 
-RSpec::Core::RakeTask.new(:spec)
+# T.bind(self, T.all(Rake::DSL, Object))
 
-require "rubocop/rake_task"
+RSpec::Core::RakeTask.new(:spec)
 
 RuboCop::RakeTask.new do |task|
   task.requires << 'rubocop-sorbet'
 end
 
+namespace :mdl do
+  desc 'Format markdown files with markdownlint'
+  task :format do
+    system("bundle exec mdl #{Dir.glob("**/*.md") * ?\s}")
+    puts "#{$?.success? ? :no : :some} errors found"
+  end
+end
+
 namespace :sorbet do
   desc 'Type-checking with sorbet'
   task :check do
-    system("bundle exec srb tc -v")
+    system("bundle exec srb tc")
   end
 
   desc 'Type-checking and auto-fix correctable errors with sorbet'
   task :autocorrect do
-    system("bundle exec srb tc --autocorrect -v")
+    system("bundle exec srb tc --autocorrect")
   end
 end
 
@@ -36,10 +48,12 @@ namespace :tapioca do
 end
 
 task :default do
-   %i[spec rubocop:autocorrect_all sorbet:autocorrect tapioca:check_shims].each do
-     puts ".｡*ﾟ+.*.｡　　#{?\s * _1.size}　　ﾟ+..｡*ﾟ+"
-     puts ".｡*ﾟ+.*.｡　　#{_1}　　ﾟ+..｡*ﾟ+"
-     puts ".｡*ﾟ+.*.｡　　#{?\s * _1.size}　　ﾟ+..｡*ﾟ+"
+   %i[mdl:format rubocop:autocorrect_all sorbet:autocorrect tapioca:check_shims spec].each do
+     puts <<~EOS
+       .｡*ﾟ+.*.｡　　#{padding = ?= * _1.size}　　ﾟ+..｡*ﾟ+
+       .｡*ﾟ+.*.｡　　#{_1}　　ﾟ+..｡*ﾟ+
+       .｡*ﾟ+.*.｡　　#{padding}　　ﾟ+..｡*ﾟ+
+     EOS
      Rake::Task[_1].execute
    end
 end

data/exe/tsumanne

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+# typed: strict
+
+require "sorbet-runtime"
+
+require_relative "../lib/tsumanne/cli"
+
+Tsumanne::CLI.start(ARGV)

data/lib/tsumanne/api.rb

@@ -0,0 +1,124 @@
+# typed: strict
+
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+require "zlib"
+
+require "mhtml"
+require "sorbet-runtime"
+
+require_relative "models/get_threads"
+require_relative "models/search_thread_from_uri"
+require_relative "models/search_indexes"
+require_relative "models/register_thread"
+
+# API module for tsumanne.net includes knowledge as const.
+module Tsumanne
+  class API
+    extend T::Sig
+
+    sig{ returns(String) }
+    attr_reader :board_id
+
+    sig { params(board_id: Symbol).void }
+    def initialize(board_id:)
+      @board_id = T.let(T.must(BOARD_IDS[board_id]), String)
+    end
+
+    sig { params(index: String, page: Integer).returns(GetThreadsResponse) }
+    def get_threads(index: "all", page: 1)
+      # https://tsumanne.net/si/all/1
+      # https://tsumanne.net/si/hoge/1
+      GetThreadsResponse.from_hash(fetch_json(paths: [index, page.to_s]))
+    end
+
+    sig { params(thread_id: String).returns(Mhtml::RootDocument) }
+    def get_thread_mht(thread_id)
+      # https://tsumanne.net/si/mht.php?id=129691
+      res = fetch_json(paths: ["mht.php"], query: { id: thread_id }, method: :get_response)
+      mht_gz = fetch(paths: [T.let(res["path"], String)])
+      # https://ksef-3go.hatenadiary.org/entry/20070924/1190563143
+      # https://docs.ruby-lang.org/ja/latest/method/Zlib=3a=3aInflate/s/new.html
+      zstream = Zlib::Inflate.new(Zlib::MAX_WBITS + 32)
+      buf = zstream.inflate(mht_gz)
+      zstream.finish
+      zstream.close
+      Mhtml::RootDocument.new(buf)
+    end
+
+    sig { params(thread_path: String).returns(T.nilable(Mhtml::RootDocument)) }
+    def get_thread_from_path(thread_path)
+      # https://tsumanne.net/si/data/2023/08/30/8883354/
+      match_data = %r{^\d{4}/\d{2}/\d{2}/(?<thread_id>\d+)$}.match(thread_path)
+      return if match_data.nil?
+      get_thread_mht(T.must(match_data[:thread_id]))
+    end
+
+    sig { params(uri: URI).returns(SearchThreadFromUriResponse) }
+    def search_thread_from_uri(uri)
+      # https://tsumanne.net/si/indexes.php?format=json&w=...&sbmt=URL
+      # https://tsumanne.net/si/indexes.php?format=json&w=https%3A%2F%2Fimg.2chan.net%2Fb%2Fres%2F86279902.htm&sbmt=URL
+      SearchThreadFromUriResponse.from_hash(
+        fetch_json(paths: ["indexes.php"], query: { w: uri, sbmt: :URL })
+      )
+    end
+
+    sig { params(keyword: T.nilable(String), order: Symbol, page: Integer).returns(SearchIndexesResponse) }
+    def search_indexes(keyword: nil, order: :newer, page: 1)
+      # https://tsumanne.net/si/indexes.php?format=json&w=&sbmt=%E2%86%93%E6%96%B0
+      SearchIndexesResponse.from_hash(
+        fetch_json(paths: ["indexes.php"], query: { w: keyword, sbmt: INDEXES_ORDERS[order], p: page })
+      )
+    end
+
+    sig { params(uri: URI, indexes: T.nilable(T::Array[String])).returns(RegisterThreadResponse) }
+    def register_thread(uri, indexes: nil)
+      # post, https://tsumanne.net/si/input.php?format=json&url=...&category=...
+      RegisterThreadResponse.from_hash(
+        fetch_json(paths: ["input.php?format=json"], query: { url: uri, category: (indexes || []).join(",") }, method: :post)
+      )
+    end
+
+    private
+
+    sig do
+      params(paths: T.nilable(T::Array[String]),
+             query: T.nilable(T::Hash[Symbol, T.any(Integer, String, Symbol)]),
+             method: Symbol).returns(T.nilable(String))
+    end
+    def fetch(paths: nil, query: nil, method: :get)
+      uri = join_paths(BASE_URL, [@board_id] + (paths || []))
+      query = URI.encode_www_form(query || {})
+
+      case method
+      when :get
+        uri.query = query
+        Net::HTTP.get(uri)
+      when :get_response
+        uri.query = query
+        Net::HTTP.get_response(uri).body
+      when :post
+        Net::HTTP.post(uri, query).body
+      end
+    end
+
+    sig do
+      params(paths: T.nilable(T::Array[String]),
+             query: T.nilable(T::Hash[Symbol, T.any(Integer, String, Symbol)]),
+             method: Symbol).returns(T::Hash[String, T.untyped])
+    end
+    def fetch_json(paths: nil, query: nil, method: :get)
+      query ||= {}
+      json = fetch(paths:, query: query.merge({ format: :json }), method:)
+      JSON.parse(T.must(json))
+    end
+
+    sig { params(base: String, paths: T::Array[String]).returns(URI::Generic) }
+    def join_paths(base, *paths)
+      URI.parse(T.must(([base] + paths).reduce { File.join(_1, _2) }))
+    end
+  end
+end

data/lib/tsumanne/cli.rb

@@ -0,0 +1,13 @@
+# typed: strict
+
+# frozen_string_literal: true
+
+module Tsumanne
+  class CLI
+    extend T::Sig
+    sig { params(args: BasicObject).returns(NilClass) }
+    def self.start(args)
+      p args
+    end
+  end
+end

data/lib/tsumanne/models/get_threads.rb

@@ -0,0 +1,34 @@
+# typed: strict
+
+require "sorbet-runtime"
+
+class GetThreadsResponse < T::Struct
+  extend T::Sig
+
+  class Log < T::Struct
+    extend T::Sig
+
+    const :id, Integer
+    const :url, String # URI
+    const :date, String # Time
+    const :close, T::Boolean
+    const :res, Integer
+    const :files, Integer
+    const :access, Integer
+    const :public, T::Boolean
+    const :text, String
+    const :thumb, String
+    const :del, Integer
+    const :atid, T::Boolean
+    const :last, String # Time
+    const :path, String
+    const :category, T::Array[String]
+  end
+
+  const :success, T::Boolean
+  const :messages, T::Array[String]
+  const :lastpage, Integer
+  const :count, Integer
+  const :cid, Integer
+  const :logs, T::Array[Log]
+end

data/lib/tsumanne/models/register_thread.rb

@@ -0,0 +1,18 @@
+# typed: strict
+
+require "sorbet-runtime"
+
+class RegisterThreadResponse < T::Struct
+  extend T::Sig
+
+  class Tags < T::Struct
+    extend T::Sig
+
+    const :success, T::Boolean
+    const :messages, T::Array[String]
+  end
+
+  const :success, T::Boolean
+  const :messages, T::Array[String]
+  const :tags, Tags
+end

data/lib/tsumanne/models/search_indexes.rb

@@ -0,0 +1,18 @@
+# typed: strict
+
+require "sorbet-runtime"
+
+class SearchIndexesResponse < T::Struct
+  extend T::Sig
+
+  class Tag < T::Struct
+    extend T::Sig
+
+    const :tag, String
+  end
+
+  const :success, T::Boolean
+  const :messages, T::Array[String]
+  const :count, Integer
+  const :tags, T::Array[Tag]
+end

data/lib/tsumanne/models/search_thread_from_uri.rb

@@ -0,0 +1,11 @@
+# typed: strict
+
+require "sorbet-runtime"
+
+class SearchThreadFromUriResponse < T::Struct
+  extend T::Sig
+
+  const :success, T::Boolean
+  const :messages, T::Array[String]
+  const :path, String
+end

data/lib/tsumanne/version.rb

@@ -3,5 +3,5 @@
 # frozen_string_literal: true
 
 module Tsumanne
-  VERSION = "0.0.0"
+  VERSION = "0.0.2"
 end

data/lib/tsumanne.rb

@@ -2,14 +2,9 @@
 
 # frozen_string_literal: true
 
-require "net/http"
-require "uri"
-require "json"
-require "zlib"
-
-require "mhtml"
 require "sorbet-runtime"
 
+require_relative "tsumanne/api"
 require_relative "tsumanne/version"
 
 # API module for tsumanne.net includes knowledge as const.
@@ -25,104 +20,4 @@ module Tsumanne
   INDEXES_ORDERS = T.let({ hira: "↓あ", newer: "↓新" }.freeze, T::Hash[Symbol, String])
 
   class Error < StandardError; end
-
-  # API to get information fron tsumanne.net
-  class API
-    extend T::Sig
-
-    sig{ returns(String) }
-    attr_reader :board_id
-
-    sig { params(board_id: Symbol).void }
-    def initialize(board_id:)
-      @board_id = T.let(T.must(BOARD_IDS[board_id]), String)
-    end
-
-    sig { params(index: String, page: Integer).returns(T::Hash[String, T.untyped]) }
-    def get_threads(index: "all", page: 1)
-      # https://tsumanne.net/si/all/1
-      # https://tsumanne.net/si/hoge/1
-      fetch_json(paths: [index, page.to_s])
-    end
-
-    sig { params(thread_id: String).returns(Mhtml::RootDocument) }
-    def get_thread_mht(thread_id)
-      # https://tsumanne.net/si/mht.php?id=129691
-      res = fetch_json(paths: ["mht.php"], query: { id: thread_id }, method: :get_response)
-      mht_gz = fetch(paths: [T.let(res["path"], String)])
-      # https://ksef-3go.hatenadiary.org/entry/20070924/1190563143
-      # https://docs.ruby-lang.org/ja/latest/method/Zlib=3a=3aInflate/s/new.html
-      zstream = Zlib::Inflate.new(Zlib::MAX_WBITS + 32)
-      buf = zstream.inflate(mht_gz)
-      zstream.finish
-      zstream.close
-      Mhtml::RootDocument.new(buf)
-    end
-
-    sig { params(thread_path: String).returns(T.nilable(Mhtml::RootDocument)) }
-    def get_thread_from_path(thread_path)
-      # https://tsumanne.net/si/data/2023/08/30/8883354/
-      match_data = %r{^\d{4}/\d{2}/\d{2}/(?<thread_id>\d+)$}.match(thread_path)
-      return if match_data.nil?
-      get_thread_mht(T.must(match_data[:thread_id]))
-    end
-
-    sig { params(uri: URI).returns(T::Hash[String, T.untyped]) }
-    def search_thread_from_uri(uri)
-      # https://tsumanne.net/si/indexes.php?format=json&w=&sbmt=URL
-      fetch_json(paths: ["indexes.php"], query: { w: uri, sbmt: :URL })
-    end
-
-    sig { params(keyword: T.nilable(String), order: Symbol, page: Integer).returns(T::Hash[String, T.untyped]) }
-    def search_indexes(keyword: nil, order: :newer, page: 1)
-      # https://tsumanne.net/si/indexes.php?format=json&w=&sbmt=URL
-      # https://tsumanne.net/si/indexes.php?format=json&w=&sbmt=%E2%86%93%E6%96%B0
-      fetch_json(paths: ["indexes.php"], query: { w: keyword, sbmt: INDEXES_ORDERS[order], p: page })
-    end
-
-    sig { params(uri: URI, indexes: T.nilable(T::Array[String])).returns(T::Hash[String, T.untyped]) }
-    def register_thread(uri, indexes: nil)
-      # post, https://tsumanne.net/si/input.php?format=json&url=...&category=...
-      fetch_json(paths: ["input.php?format=json"], query: { url: uri, category: (indexes || []).join(",") }, method: :post)
-    end
-
-    private
-
-    sig do
-      params(paths: T.nilable(T::Array[String]),
-             query: T.nilable(T::Hash[Symbol, T.any(Integer, String, Symbol)]),
-             method: Symbol).returns(T.nilable(String))
-    end
-    def fetch(paths: nil, query: nil, method: :get)
-      uri = join_paths(BASE_URL, [@board_id] + (paths || []))
-      query = URI.encode_www_form(query || {})
-
-      case method
-      when :get
-        uri.query = query
-        Net::HTTP.get(uri)
-      when :get_response
-        uri.query = query
-        Net::HTTP.get_response(uri).body
-      when :post
-        Net::HTTP.post(uri, query).body
-      end
-    end
-
-    sig do
-      params(paths: T.nilable(T::Array[String]),
-             query: T.nilable(T::Hash[Symbol, T.any(Integer, String, Symbol)]),
-             method: Symbol).returns(T::Hash[String, T.untyped])
-    end
-    def fetch_json(paths: nil, query: nil, method: :get)
-      query ||= {}
-      json = fetch(paths:, query: query.merge({ format: :json }), method:)
-      JSON.parse(T.must(json))
-    end
-
-    sig { params(base: String, paths: T::Array[String]).returns(URI::Generic) }
-    def join_paths(base, *paths)
-      URI.parse(T.must(([base] + paths).reduce { File.join(_1, _2) }))
-    end
-  end
 end

data/sorbet/config

@@ -1,4 +1,19 @@
 --dir
 .
+
+bin/console
+bin/tapioca
+exe/tsumanne
+
+Gemfile
+Rakefile
+
 --ignore=tmp/
 --ignore=vendor/
+
+--allowed-extension=.rb
+--allowed-extension=.rbi
+--allowed-extension=.gemspec
+--allowed-extension=.rake
+
+--enable-experimental-requires-ancestor

data/sorbet/rbi/gems/chef-utils@18.2.7.rbi

@@ -0,0 +1,8 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `chef-utils` gem.
+# Please instead update this file by running `bin/tapioca gem chef-utils`.
+
+# THIS IS AN EMPTY RBI FILE.
+# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem

data/sorbet/rbi/gems/concurrent-ruby@1.2.2.rbi

@@ -0,0 +1,8 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `concurrent-ruby` gem.
+# Please instead update this file by running `bin/tapioca gem concurrent-ruby`.
+
+# THIS IS AN EMPTY RBI FILE.
+# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem