wikidotrb 3.0.7.pre.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b3162c75bac8240593463765275b458cb753e8da4236eb373ba987848923af5
+  data.tar.gz: 2a9123f682563a8f8b7035cbd19cb5f8e6dadc7d50f39c8421fcd083d8a4a52a
+SHA512:
+  metadata.gz: 40833f07667655fe0dcaa8fdeb89856c48e5390eef2c67701bd02371e79e0209c7addcfaf6e130bb37a9b6e7849ba3f86fe7a41715daf42313da170237c98520
+  data.tar.gz: 41e5dc7aa06fbade1a3220f3ccbbb847d27047b2090c4d5fdaf1533eddd529108d9714cd90bffbb0a58b17f2a52751a9460ecdb5aa6dfa2787cd59d2bfdba57c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,77 @@
+# Target Ruby Version
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/MethodLength:
+  Max: 70
+
+Metrics/CyclomaticComplexity:
+  Max: 25
+
+Metrics/ModuleLength:
+  Max: 500
+
+Metrics/PerceivedComplexity:
+  Max: 25
+
+Metrics/AbcSize:
+  Max: 80
+
+Metrics/BlockLength:
+  Max: 200
+
+Metrics/ParameterLists:
+  Max: 25
+
+Layout/LineLength:
+  Max: 200
+
+Metrics/CollectionLiteralLength:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Lint/EmptyFile:
+  Enabled: false
+
+Lint/DuplicateMethods:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [released]
+
+## [3.0.7.pre] - 2024-10-06
+
+### Added
+- Initial release of `wikidotrb`, a Ruby library inspired by `wikidot.py`.
+
+## [3.0.7.pre.1] - 2024-10-08
+
+### Changed
+- Improved `UserParser.parse` method to convert non-`Nokogiri::XML::Element` elements properly before processing.
+
+## [3.0.7.pre.2] - 2024-10-08
+
+### Fixed
+- Corrected the instantiation of `PageRevisionCollection` by ensuring it properly passes `page` and `revisions` as named parameters.
+
+## [3.0.7.pre.3] - 2024-10-08
+
+### Fixed
+- Remove debug `puts` statement from `PageCollection` instantiation.
+
+## [3.0.7.pre.4] - 2024-10-08
+
+### Fixed
+- Fixed an issue where the `acquire_sources` and `acquire_htmls` methods incorrectly parsed the `response` object. Now directly access `response["body"]` without unnecessary parsing.
+
+## [3.0.7.pre.5] - 2024-10-08
+
+### Fixed
+- Remove debug `puts` statement from `PageCollection` instantiation.
+
+## [3.0.7.pre.6] - 2024-10-08
+
+### Changed
+- Refactored `UserParser.parse` to better handle the string `"(user deleted)"` as input. 
+
+### Added
+- Private helper method `deleted_user_string?` to clearly separate the logic for parsing `"(user deleted)"`.
+
+### Improved
+- Made parsing helper methods (`parse_deleted_user`, `parse_anonymous_user`, `parse_guest_user`, `parse_wikidot_user`, `parse_regular_user`) private to encapsulate their functionality.
+
+### Fixed
+- Added `nil` check for `user_anchor` in `parse_regular_user` to prevent errors when user information is missing.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/_config.yml

@@ -0,0 +1,4 @@
+test:
+  username: 'testuser'
+  password: 'password'
+  site: 'test'

data/lib/wikidotrb/common/decorators.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Wikidotrb
+  module Common
+    module Decorators
+      def login_required(*methods)
+        methods.each do |method|
+          if singleton_methods.include?(method)
+            # クラスメソッドにデコレータを適用
+            singleton_class.class_eval do
+              alias_method "#{method}_without_login_check", method
+
+              define_method(method) do |*args, **kwargs|
+                client = nil
+
+                # インスタンス変数として存在するかを最初にチェック
+                client ||= self.client if respond_to?(:client)
+
+                # キーワード引数からclientを探す
+                client = kwargs[:client] if kwargs.key?(:client)
+
+                # 引数からClientインスタンスを探す
+                unless client
+                  args.each do |arg|
+                    if arg.is_a?(Wikidotrb::Module::Client)
+                      client = arg
+                      break
+                    end
+                  end
+                end
+
+                # clientが見つからない場合はエラーを発生させる
+                raise ArgumentError, "Client is not found" if client.nil?
+
+                # clientのログインチェック
+                client.login_check
+
+                # 元のメソッドの呼び出し
+                send("#{method}_without_login_check", *args, **kwargs)
+              end
+            end
+          elsif instance_methods.include?(method)
+            # インスタンスメソッドにデコレータを適用
+            alias_method "#{method}_without_login_check", method
+
+            define_method(method) do |*args, **kwargs|
+              client = nil
+
+              # インスタンス変数として存在するかを最初にチェック
+              client ||= self.client if respond_to?(:client)
+
+              # キーワード引数からclientを探す
+              client = kwargs[:client] if kwargs.key?(:client)
+
+              # 引数からClientインスタンスを探す
+              unless client
+                args.each do |arg|
+                  if arg.is_a?(Wikidotrb::Module::Client)
+                    client = arg
+                    break
+                  end
+                end
+              end
+
+              # clientが見つからない場合はエラーを発生させる
+              raise ArgumentError, "Client is not found" if client.nil?
+
+              # clientのログインチェック
+              client.login_check
+
+              # 元のメソッドの呼び出し
+              send("#{method}_without_login_check", *args, **kwargs)
+            end
+          else
+            raise NameError, "Undefined method `#{method}` for class `#{self}`"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wikidotrb/common/exceptions.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Wikidotrb
+  module Common
+    module Exceptions
+      # ---
+      # 基底クラス
+      # ---
+
+      class WikidotException < StandardError
+        # 独自例外の基底クラス
+      end
+
+      # ---
+      # ワイルドカード
+      # ---
+
+      class UnexpectedException < WikidotException
+        # 予期せぬ例外が発生したときの例外
+      end
+
+      # ---
+      # セッション関連
+      # ---
+
+      class SessionCreateException < WikidotException
+        # セッションの作成に失敗したときの例外
+      end
+
+      class LoginRequiredException < WikidotException
+        # ログインが必要なメソッドのときの例外
+      end
+
+      # ---
+      # AMC関連
+      # ---
+
+      class AjaxModuleConnectorException < WikidotException
+        # ajax-module-connector.phpへのリクエストに失敗したときの例外
+      end
+
+      class AMCHttpStatusCodeException < AjaxModuleConnectorException
+        # AMCから返却されたHTTPステータスが200以外だったときの例外
+        attr_reader :status_code
+
+        def initialize(message, status_code)
+          super(message)
+          @status_code = status_code
+        end
+      end
+
+      class WikidotStatusCodeException < AjaxModuleConnectorException
+        # AMCから返却されたデータ内のステータスがokではなかったときの例外
+        # HTTPステータスが200以外の場合はAMCHttpStatusCodeExceptionを投げる
+        attr_reader :status_code
+
+        def initialize(message, status_code)
+          super(message)
+          @status_code = status_code
+        end
+      end
+
+      class ResponseDataException < AjaxModuleConnectorException
+        # AMCから返却されたデータが不正だったときの例外
+      end
+
+      # ---
+      # ターゲットエラー関連
+      # ---
+
+      class NotFoundException < WikidotException
+        # サイトやページ・ユーザが見つからなかったときの例外
+      end
+
+      class TargetExistsException < WikidotException
+        # 対象が既に存在しているときの例外
+      end
+
+      class TargetErrorException < WikidotException
+        # メソッドの対象としたオブジェクトに操作が適用できないときの例外
+      end
+
+      class ForbiddenException < WikidotException
+        # 権限がないときの例外
+      end
+    end
+  end
+end

data/lib/wikidotrb/common/logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Wikidotrb
+  module Common
+    # Logger設定
+    def self.setup_logger(name = "wikidot", level = Logger::INFO)
+      # ロガーの作成
+      _logger = Logger.new($stdout)
+      _logger.progname = name
+      _logger.level = level
+
+      # ログフォーマット
+      _logger.formatter = proc do |severity, datetime, progname, msg|
+        "#{datetime} [#{progname}/#{severity}] #{msg}\n"
+      end
+
+      _logger
+    end
+
+    # ロガーの初期化
+    Logger = setup_logger
+  end
+end

data/lib/wikidotrb/connector/ajax.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require "httpx"
+require "json"
+require "logger"
+require "concurrent"
+
+require_relative "../common/exceptions"
+require_relative "../common/logger"
+
+module Wikidotrb
+  module Connector
+    class AjaxRequestHeader
+      # AjaxRequestHeaderオブジェクトの初期化
+      # @param content_type [String] Content-Type
+      # @param user_agent [String] User-Agent
+      # @param referer [String] Referer
+      # @param cookie [Hash] Cookie
+      def initialize(content_type: nil, user_agent: nil, referer: nil, cookie: nil)
+        @content_type = content_type || "application/x-www-form-urlencoded; charset=UTF-8"
+        @user_agent = user_agent || "WikidotRb"
+        @referer = referer || "https://www.wikidot.com/"
+        @cookie = { "wikidot_token7" => 123_456 }.merge(cookie || {})
+      end
+
+      # Cookieを設定
+      # @param name [String] Cookie名
+      # @param value [String] Cookie値
+      def set_cookie(name, value)
+        @cookie[name] = value
+      end
+
+      # Cookieを取得
+      # @param name [String] Cookie名
+      # @return [String, nil] Cookie値
+      def get_cookie(name)
+        @cookie[name]
+      end
+
+      # Cookieを削除
+      # @param name [String] Cookie名
+      def delete_cookie(name)
+        @cookie.delete(name)
+      end
+
+      # ヘッダを構築して返す
+      # @return [Hash] ヘッダのハッシュ
+      def get_header
+        {
+          "Content-Type" => @content_type,
+          "User-Agent" => @user_agent,
+          "Referer" => @referer,
+          "Cookie" => @cookie.map { |name, value| "#{name}=#{value};" }.join
+        }
+      end
+    end
+
+    # AjaxModuleConnectorConfigの定義
+    AjaxModuleConnectorConfig = Struct.new(
+      :request_timeout, :attempt_limit, :retry_interval, :semaphore_limit,
+      keyword_init: true
+    ) do
+      def initialize(**args)
+        super
+        self.request_timeout ||= 20
+        self.attempt_limit ||= 3
+        self.retry_interval ||= 5
+        self.semaphore_limit ||= 10
+      end
+    end
+
+    class AjaxModuleConnectorClient
+      attr_reader :header, :config, :site_name
+
+      # AjaxModuleConnectorClientオブジェクトの初期化
+      # @param site_name [String] サイト名
+      # @param config [AjaxModuleConnectorConfig] クライアントの設定
+
+      def initialize(site_name:, config: nil)
+        raise ArgumentError, "site_name cannot be nil" if site_name.nil?
+
+        @site_name = site_name
+        @config = config || AjaxModuleConnectorConfig.new
+        @header = AjaxRequestHeader.new
+        @logger = Wikidotrb::Common::Logger
+      end
+
+      # サイトの存在とSSLの対応をチェック
+      # @return [Boolean] SSL対応しているか
+      # @raise [NotFoundException] サイトが見つからない場合
+      def check_existence_and_ssl(site_name)
+        http_url = "http://#{site_name}.wikidot.com"
+        https_url = "https://#{site_name}.wikidot.com"
+
+        http_response = HTTPX.get(http_url)
+        raise NotFoundException, "Site is not found: #{site_name}.wikidot.com" if http_response.status == 404
+
+        https_response = HTTPX.get(https_url)
+        https_response.status == 200 || (https_response.status == 301 && https_response.headers["location"].start_with?("https"))
+      end
+
+      # ajax-module-connector.phpへのリクエストを行う
+      # @param bodies [Array<Hash>] リクエストボディのリスト
+      # @param return_exceptions [Boolean] 例外を返すかどうか
+      # @param site_name [String] サイト名
+      # @param site_ssl_supported [Boolean] サイトがSSL対応しているかどうか
+      # @return [Array<Hash>] レスポンスボディのリスト
+      # @raise [AMCHttpStatusCodeException, WikidotStatusCodeException, ResponseDataException]
+      def request(bodies:, return_exceptions: false, site_name: nil, site_ssl_supported: nil)
+        semaphore = Concurrent::Semaphore.new(@config.semaphore_limit)
+        site_name ||= @site_name
+        site_ssl_supported ||= check_existence_and_ssl(site_name)
+
+        tasks = bodies.map do |body|
+          Concurrent::Promises.future do
+            retry_count = 0
+
+            loop do
+              semaphore.acquire
+
+              begin
+                protocol = site_ssl_supported ? "https" : "http"
+                url = "#{protocol}://#{site_name}.wikidot.com/ajax-module-connector.php"
+                body["wikidot_token7"] = 123_456
+                @logger.debug("Ajax Request: #{url} -> #{body}")
+                response = HTTPX.post(
+                  url,
+                  headers: @header.get_header,
+                  form: body,
+                  timeout: { operation: @config.request_timeout }
+                )
+
+                if response.status != 200
+                  retry_count += 1
+                  if retry_count >= @config.attempt_limit
+                    @logger.error("AMC is respond HTTP error code: #{response.status} -> #{body}")
+                    raise AMCHttpStatusCodeException.new("AMC is respond HTTP error code: #{response.status}",
+                                                         response.status)
+                  end
+
+                  @logger.info("AMC is respond status: #{response.status} (retry: #{retry_count}) -> #{body}")
+                  sleep @config.retry_interval
+                  next
+                end
+
+                response_body = JSON.parse(response.body.to_s)
+
+                if response_body.nil? || response_body.empty?
+                  @logger.error("AMC is respond empty data -> #{body}")
+                  raise ResponseDataException, "AMC is respond empty data"
+                end
+
+                if response_body["status"]
+                  if response_body["status"] == "try_again"
+                    retry_count += 1
+                    if retry_count >= @config.attempt_limit
+                      @logger.error("AMC is respond status: \"try_again\" -> #{body}")
+                      raise Wikidotrb::Common::Exceptions::WikidotStatusCodeException.new(
+                        'AMC is respond status: "try_again"', "try_again"
+                      )
+                    end
+
+                    @logger.info("AMC is respond status: \"try_again\" (retry: #{retry_count})")
+                    sleep @config.retry_interval
+                    next
+                  elsif response_body["status"] != "ok"
+                    @logger.error("AMC is respond error status: \"#{response_body["status"]}\" -> #{body}")
+                    raise Wikidotrb::Common::Exceptions::WikidotStatusCodeException.new(
+                      "AMC is respond error status: \"#{response_body["status"]}\"", response_body["status"]
+                    )
+                  end
+                end
+
+                break response_body
+              rescue JSON::ParserError
+                @logger.error("AMC is respond non-json data: \"#{response.body}\" -> #{body}")
+                raise Wikidotrb::Common::Exceptions::ResponseDataException,
+                      "AMC is respond non-json data: \"#{response.body}\""
+              ensure
+                semaphore.release
+              end
+            end
+          end
+        end
+
+        results = Concurrent::Promises.zip(*tasks).value!
+
+        return_exceptions ? results : results.each { |r| raise r if r.is_a?(Exception) }
+      end
+    end
+  end
+end