wikidotrb 3.0.7.pre.6

data/lib/wikidotrb/connector/api.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Wikidotrb
+  module Connector
+    # APIキーのオブジェクト
+    class APIKeys
+      # 読み取り専用の属性
+      attr_reader :ro_key, :rw_key
+
+      # 初期化
+      # @param ro_key [String] Read Only Key
+      # @param rw_key [String] Read-Write Key
+      def initialize(ro_key:, rw_key:)
+        @ro_key = ro_key
+        @rw_key = rw_key
+        freeze
+      end
+    end
+  end
+end

data/lib/wikidotrb/module/auth.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "httpx"
+require "uri"
+require "json"
+require_relative "../common/exceptions"
+
+module Wikidotrb
+  module Module
+    class HTTPAuthentication
+      # ユーザー名とパスワードでログインする
+      # @param client [Client] クライアント
+      # @param username [String] ユーザー名
+      # @param password [String] パスワード
+      # @raise [SessionCreateException] セッション作成に失敗した場合
+      def self.login(client, username, password)
+        url = "https://www.wikidot.com/default--flow/login__LoginPopupScreen"
+
+        # ログインリクエストのデータを作成
+        request_data = {
+          "login" => username,
+          "password" => password,
+          "action" => "Login2Action",
+          "event" => "login"
+        }
+
+        response = HTTPX.post(
+          url,
+          headers: client.amc_client.header.get_header,
+          form: request_data,
+          timeout: { operation: 20 }
+        )
+
+        # ステータスコードのチェック
+        unless response.status == 200
+          raise Wikidotrb::Common::Exceptions::SessionCreateException,
+                "Login attempt is failed due to HTTP status code: #{response.status}"
+        end
+
+        # レスポンスボディのチェック
+        if response.body.to_s.include?("The login and password do not match")
+          raise Wikidotrb::Common::Exceptions::SessionCreateException,
+                "Login attempt is failed due to invalid username or password"
+        end
+
+        # クッキーのチェックとパース
+        set_cookie_header = response.headers["set-cookie"]
+
+        # `set-cookie` が存在しない、または `nil` の場合にエラーを発生
+        raise Wikidotrb::Common::Exceptions::SessionCreateException, "Login attempt is failed due to invalid cookies" if set_cookie_header.nil? || set_cookie_header.empty?
+
+        # セッションクッキーを取得
+        session_cookie = set_cookie_header.match(/WIKIDOT_SESSION_ID=([^;]+)/)
+
+        raise Wikidotrb::Common::Exceptions::SessionCreateException, "Login attempt is failed due to invalid cookies" unless session_cookie
+
+        # セッションクッキーの設定
+        client.amc_client.header.set_cookie("WIKIDOT_SESSION_ID", session_cookie[1])
+      end
+
+      # ログアウトする
+      # @param client [Client] クライアント
+      def self.logout(client)
+        begin
+          client.amc_client.request(
+            [{ "action" => "Login2Action", "event" => "logout", "moduleName" => "Empty" }]
+          )
+        rescue StandardError
+          # 例外を無視してログアウト処理を続ける
+        end
+
+        client.amc_client.header.delete_cookie("WIKIDOT_SESSION_ID")
+      end
+    end
+  end
+end

data/lib/wikidotrb/module/client.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require_relative "../common/logger"
+require_relative "../common/exceptions"
+require_relative "../connector/ajax"
+require_relative "auth"
+require_relative "private_message"
+require_relative "site"
+require_relative "user"
+
+module Wikidotrb
+  module Module
+    class ClientUserMethods
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # ユーザー名からユーザーオブジェクトを取得する
+      # @param name [String] ユーザー名
+      # @param raise_when_not_found [Boolean] ユーザーが見つからない場合に例外を送出するか
+      # @return [User] ユーザーオブジェクト
+      def get(name, raise_when_not_found: false)
+        Wikidotrb::Module::User.from_name(@client, name, raise_when_not_found)
+      end
+
+      # ユーザー名からユーザーオブジェクトを取得する
+      # @param names [Array<String>] ユーザー名のリスト
+      # @param raise_when_not_found [Boolean] ユーザーが見つからない場合に例外を送出するか
+      # @return [Array<User>] ユーザーオブジェクトのリスト
+      def get_bulk(names, raise_when_not_found: false)
+        Wikidotrb::Module::UserCollection.from_names(@client, names, raise_when_not_found)
+      end
+    end
+
+    class ClientPrivateMessageMethods
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # メッセージを送信する
+      # @param recipient [User] 受信者
+      # @param subject [String] 件名
+      # @param body [String] 本文
+      def send_message(recipient, subject, body)
+        Wikidotrb::Module::PrivateMessage.send_message(
+          client: @client, recipient: recipient, subject: subject, body: body
+        )
+      end
+
+      # 受信箱を取得する
+      # @return [PrivateMessageInbox] 受信箱
+      def get_inbox
+        Wikidotrb::Module::PrivateMessageInbox.acquire(client: @client)
+      end
+
+      # 送信箱を取得する
+      # @return [PrivateMessageSentBox] 送信箱
+      def get_sentbox
+        Wikidotrb::Module::PrivateMessageSentBox.acquire(client: @client)
+      end
+
+      # メッセージを取得する
+      # @param message_ids [Array<Integer>] メッセージIDのリスト
+      # @return [PrivateMessageCollection] メッセージのリスト
+      def get_messages(message_ids)
+        Wikidotrb::Module::PrivateMessageCollection.from_ids(client: @client, message_ids: message_ids)
+      end
+
+      # メッセージを取得する
+      # @param message_id [Integer] メッセージID
+      # @return [PrivateMessage] メッセージ
+      def get_message(message_id)
+        Wikidotrb::Module::PrivateMessage.from_id(client: @client, message_id: message_id)
+      end
+    end
+
+    class ClientSiteMethods
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # UNIX名からサイトオブジェクトを取得する
+      # @param unix_name [String] サイトのUNIX名
+      # @return [Site] サイトオブジェクト
+      def get(unix_name)
+        Wikidotrb::Module::Site.from_unix_name(client: client, unix_name: unix_name)
+      end
+    end
+
+    class Client
+      attr_accessor :amc_client, :is_logged_in, :username
+      attr_reader :user, :private_message, :site
+
+      # 基幹クライアント
+      def initialize(username: nil, password: nil, amc_config: nil, logging_level: "WARN")
+        # 最初にロギングレベルを決定する
+        Wikidotrb::Common::Logger.level = logging_level
+
+        # AMCClientを初期化
+        @amc_client = Wikidotrb::Connector::AjaxModuleConnectorClient.new(site_name: "www", config: amc_config)
+
+        # セッション関連変数の初期化
+        @is_logged_in = false
+        @username = nil
+
+        # usernameとpasswordが指定されていればログインする
+        if username && password
+          Wikidotrb::Module::HTTPAuthentication.login(self, username, password)
+          @is_logged_in = true
+          @username = username
+        end
+
+        # メソッドの定義
+        @user = ClientUserMethods.new(self)
+        @private_message = ClientPrivateMessageMethods.new(self)
+        @site = ClientSiteMethods.new(self)
+      end
+
+      # デストラクタ
+      def finalize
+        return unless @is_logged_in
+
+        Wikidotrb::Module::HTTPAuthentication.logout(self)
+        @is_logged_in = false
+        @username = nil
+      end
+
+      def to_s
+        "Client(username=#{@username}, is_logged_in=#{@is_logged_in})"
+      end
+
+      # ログインチェック
+      def login_check
+        raise Wikidotrb::Common::Exceptions::LoginRequiredException, "Login is required to execute this function" unless @is_logged_in
+
+        nil
+      end
+    end
+  end
+end

data/lib/wikidotrb/module/forum.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative "forum_category"
+require_relative "forum_group"
+require_relative "forum_thread"
+
+module Wikidotrb
+  module Module
+    class ForumCategoryMethods
+      # 初期化メソッド
+      # @param forum [Forum] フォーラムオブジェクト
+      def initialize(forum)
+        @forum = forum
+      end
+
+      # カテゴリをIDから取得
+      # @param id [Integer] カテゴリID
+      # @return [ForumCategory] 更新されたカテゴリ
+      def get(id)
+        category = ForumCategory.new(
+          site: @forum.site,
+          id: id,
+          forum: @forum
+        )
+        category.update
+      end
+    end
+
+    class ForumThreadMethods
+      # 初期化メソッド
+      # @param forum [Forum] フォーラムオブジェクト
+      def initialize(forum)
+        @forum = forum
+      end
+
+      # スレッドをIDから取得
+      # @param id [Integer] スレッドID
+      # @return [ForumThread] 更新されたスレッド
+      def get(id)
+        thread = ForumThread.new(
+          site: @forum.site,
+          id: id,
+          forum: @forum
+        )
+        thread.update
+      end
+    end
+
+    class Forum
+      attr_accessor :site, :_groups, :_categories
+
+      # 初期化メソッド
+      # @param site [Site] サイトオブジェクト
+      def initialize(site:)
+        @site = site
+        @name = "Forum"
+        @_groups = nil
+        @_categories = nil
+        @category = ForumCategoryMethods.new(self)
+        @thread = ForumThreadMethods.new(self)
+      end
+
+      # カテゴリメソッドオブジェクトを取得
+      # @return [ForumCategoryMethods] カテゴリメソッド
+      attr_reader :category
+
+      # スレッドメソッドオブジェクトを取得
+      # @return [ForumThreadMethods] スレッドメソッド
+      attr_reader :thread
+
+      # フォーラムのURLを取得
+      # @return [String] フォーラムのURL
+      def get_url
+        "#{@site.get_url}/forum/start"
+      end
+
+      # グループのプロパティ
+      # @return [ForumGroupCollection] グループコレクション
+      def groups
+        ForumGroupCollection.get_groups(site: @site, forum: self) if @_groups.nil?
+        @_groups
+      end
+
+      # カテゴリのプロパティ
+      # @return [ForumCategoryCollection] カテゴリコレクション
+      def categories
+        ForumCategoryCollection.get_categories(site: @site, forum: self) if @_categories.nil?
+        @_categories
+      end
+    end
+  end
+end

data/lib/wikidotrb/module/forum_category.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require "date"
+require_relative "forum_thread"
+
+module Wikidotrb
+  module Module
+    class ForumCategoryCollection < Array
+      attr_accessor :forum
+
+      # 初期化メソッド
+      # @param forum [Forum] フォーラムオブジェクト
+      # @param categories [Array<ForumCategory>] カテゴリーのリスト
+      def initialize(forum:, categories: [])
+        super(categories)
+        @forum = forum
+      end
+
+      # サイトとフォーラムからカテゴリを取得
+      # @param site [Site] サイトオブジェクト
+      # @param forum [Forum] フォーラムオブジェクト
+      def self.get_categories(site:, forum:)
+        categories = []
+
+        forum.groups.each do |group|
+          categories.concat(group.categories)
+        end
+
+        forum._categories = ForumCategoryCollection.new(forum: forum, categories: categories)
+      end
+
+      # IDまたはタイトルからカテゴリを検索
+      # @param id [Integer] カテゴリID
+      # @param title [String] カテゴリのタイトル
+      # @return [ForumCategory, nil] 一致するカテゴリ
+      def find(id: nil, title: nil)
+        find do |category|
+          (id.nil? || category.id == id) && (title.nil? || category.title == title)
+        end
+      end
+
+      # カテゴリ情報を取得して更新する
+      # @param forum [Forum] フォーラムオブジェクト
+      # @param categories [Array<ForumCategory>] カテゴリーのリスト
+      # @return [Array<ForumCategory>] 更新されたカテゴリのリスト
+      def self.acquire_update(forum:, categories:)
+        return categories if categories.empty?
+
+        responses = forum.site.amc_request(
+          bodies: categories.map { |category| { "c" => category.id, "moduleName" => "forum/ForumViewCategoryModule" } }
+        )
+
+        responses.each_with_index do |response, index|
+          category = categories[index]
+          html = Nokogiri::HTML(response.body.to_s)
+          statistics = html.at_css("div.statistics").text
+          description = html.at_css("div.description-block").text.strip
+          info = html.at_css("div.forum-breadcrumbs").text.match(%r{([ \S]*) / ([ \S]*)})
+          counts = statistics.scan(/\d+/).map(&:to_i)
+
+          category.last = nil if category.posts_counts != counts[1]
+          category.description = description.match(/[ \S]*$/)[0]
+          category.threads_counts, category.posts_counts = counts
+          category.group = category.forum.groups.find(info[1])
+          category.title = info[2]
+          pager_no = html.at_css("span.pager-no")
+          category.pagerno = pager_no.nil? ? 1 : pager_no.text.match(/of (\d+)/)[1].to_i
+        end
+
+        categories
+      end
+
+      # カテゴリ情報を更新
+      def update
+        ForumCategoryCollection.acquire_update(forum: @forum, categories: self)
+      end
+    end
+
+    class ForumCategory
+      attr_accessor :site, :id, :forum, :title, :description, :group, :threads_counts, :posts_counts, :pagerno
+      attr_reader :last
+
+      def initialize(site:, id:, forum:, title: nil, description: nil, group: nil, threads_counts: nil,
+                     posts_counts: nil, pagerno: nil, last_thread_id: nil, last_post_id: nil)
+        @site = site
+        @id = id
+        @forum = forum
+        @title = title
+        @description = description
+        @group = group
+        @threads_counts = threads_counts
+        @posts_counts = posts_counts
+        @pagerno = pagerno
+        @_last_thread_id = last_thread_id
+        @_last_post_id = last_post_id
+        @_last = nil
+      end
+
+      # カテゴリのURLを取得
+      def get_url
+        "#{@site.get_url}/forum/c-#{@id}"
+      end
+
+      # カテゴリを更新
+      def update
+        ForumCategoryCollection.new(forum: @forum, categories: [self]).update.first
+      end
+
+      # 最後の投稿を取得
+      def last
+        @_last = @forum.thread.get(@_last_thread_id).get(@_last_post_id) if @_last_thread_id && @_last_post_id && @_last.nil?
+        @_last
+      end
+
+      # 最後の投稿を設定
+      def last=(value)
+        @_last = value
+      end
+
+      # スレッドのコレクションを取得する
+      # @return [ForumThreadCollection] スレッドオブジェクトのコレクション
+      def threads
+        client = @site.client
+        update
+        responses = @site.amc_request(
+          bodies: (1..@pagerno).map { |no| { "p" => no, "c" => @id, "moduleName" => "forum/ForumViewCategoryModule" } }
+        )
+
+        threads = []
+
+        responses.each do |response|
+          html = Nokogiri::HTML(response.body.to_s)
+          html.css("table.table tr.head~tr").each do |info|
+            title = info.at_css("div.title a")
+            thread_id = title["href"].match(/t-(\d+)/)[1].to_i
+            description = info.at_css("div.description").text.strip
+            user = info.at_css("span.printuser")
+            odate = info.at_css("span.odate")
+            posts_count = info.at_css("td.posts").text.to_i
+            last_id = info.at_css("td.last>a")
+            post_id = last_id.nil? ? nil : last_id["href"].match(/post-(\d+)/)[1].to_i
+
+            thread = ForumThread.new(
+              site: @site,
+              id: thread_id,
+              forum: @forum,
+              title: title.text.strip,
+              description: description,
+              created_by: user_parser(client, user),
+              created_at: odate_parser(odate),
+              posts_counts: posts_count,
+              _last_post_id: post_id
+            )
+
+            threads << thread
+          end
+        end
+
+        ForumThreadCollection.new(forum: @forum, threads: threads)
+      end
+
+      # 新しいスレッドを作成
+      def new_thread(title:, source:, description: "")
+        client = @site.client
+        client.login_check
+
+        response = @site.amc_request(
+          bodies: [
+            {
+              "category_id" => @id,
+              "title" => title,
+              "description" => description,
+              "source" => source,
+              "action" => "ForumAction",
+              "event" => "newThread"
+            }
+          ]
+        ).first
+
+        body = JSON.parse(response.body.to_s)
+
+        ForumThread.new(
+          site: @site,
+          id: body["threadId"].to_i,
+          forum: @forum,
+          category: self,
+          title: title,
+          description: description,
+          created_by: client.user.get(client.username),
+          created_at: DateTime.parse(body["CURRENT_TIMESTAMP"]),
+          posts_counts: 1
+        )
+      end
+    end
+  end
+end

data/lib/wikidotrb/module/forum_group.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require "json"
+require_relative "forum_category"
+
+module Wikidotrb
+  module Module
+    class ForumGroupCollection < Array
+      attr_accessor :forum
+
+      # 初期化メソッド
+      # @param forum [Forum] フォーラムオブジェクト
+      # @param groups [Array<ForumGroup>] グループのリスト
+      def initialize(forum:, groups: [])
+        super(groups)
+        @forum = forum
+      end
+
+      # サイトとフォーラムからグループを取得
+      # @param site [Site] サイトオブジェクト
+      # @param forum [Forum] フォーラムオブジェクト
+      def self.get_groups(site:, forum:)
+        groups = []
+
+        response = site.amc_request(bodies: [{ "moduleName" => "forum/ForumStartModule", "hidden" => "true" }]).first
+        body = JSON.parse(response.body)["body"]
+        html = Nokogiri::HTML(body)
+
+        html.css("div.forum-group").each do |group_info|
+          group = ForumGroup.new(
+            site: site,
+            forum: forum,
+            title: group_info.at_css("div.title").text.strip,
+            description: group_info.at_css("div.description").text.strip
+          )
+
+          categories = []
+
+          group_info.css("table tr.head~tr").each do |info|
+            name = info.at_css("td.name")
+            thread_count = info.at_css("td.threads").text.strip.to_i
+            post_count = info.at_css("td.posts").text.strip.to_i
+            last_id = info.at_css("td.last>a")
+            if last_id.nil?
+              thread_id = nil
+              post_id = nil
+            else
+              thread_id, post_id = last_id["href"].match(/t-(\d+).+post-(\d+)/).captures.map(&:to_i)
+            end
+
+            category = ForumCategory.new(
+              site: site,
+              id: name.at_css("a")["href"].match(/c-(\d+)/)[1].to_i,
+              description: name.at_css("div.description").text.strip,
+              forum: forum,
+              title: name.at_css("a").text.strip,
+              group: group,
+              threads_counts: thread_count,
+              posts_counts: post_count,
+              last_thread_id: thread_id,
+              last_post_id: post_id
+            )
+
+            categories << category
+          end
+
+          group.categories = ForumCategoryCollection.new(forum: forum, categories: categories)
+
+          groups << group
+        end
+
+        forum._groups = ForumGroupCollection.new(forum: forum, groups: groups)
+      end
+
+      # グループをタイトルと説明から検索
+      # @param title [String] グループのタイトル
+      # @param description [String] グループの説明
+      # @return [ForumGroup, nil] 見つかったグループ
+      def find(title: nil, description: nil)
+        find do |group|
+          (title.nil? || group.title == title) && (description.nil? || group.description == description)
+        end
+      end
+
+      # 条件に一致するすべてのグループを検索
+      # @param title [String] グループのタイトル
+      # @param description [String] グループの説明
+      # @return [Array<ForumGroup>] 見つかったグループのリスト
+      def findall(title: nil, description: nil)
+        select do |group|
+          (title.nil? || group.title == title) && (description.nil? || group.description == description)
+        end
+      end
+    end
+
+    class ForumGroup
+      attr_accessor :site, :forum, :title, :description, :categories
+
+      def initialize(site:, forum:, title:, description:, categories: nil)
+        @site = site
+        @forum = forum
+        @title = title
+        @description = description
+        @categories = categories || ForumCategoryCollection.new(forum: forum)
+      end
+    end
+  end
+end