wikidotrb 3.0.7.pre.6

data/lib/wikidotrb/module/page_revision.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require "date"
+require_relative "page_source"
+
+module Wikidotrb
+  module Module
+    class PageRevisionCollection < Array
+      attr_accessor :page
+
+      # 初期化メソッド
+      # @param page [Page] ページオブジェクト
+      # @param revisions [Array<PageRevision>] リビジョンのリスト
+      def initialize(page: nil, revisions: [])
+        super(revisions)
+        @page = page || revisions.first.page
+      end
+
+      # ソースを取得して設定する
+      # @param page [Page] ページオブジェクト
+      # @param revisions [Array<PageRevision>] リビジョンのリスト
+      # @return [Array<PageRevision>] 更新されたリビジョンのリスト
+      def self.acquire_sources(page:, revisions:)
+        target_revisions = revisions.reject(&:source_acquired?)
+
+        return revisions if target_revisions.empty?
+
+        responses = page.site.amc_request(
+          bodies: target_revisions.map do |revision|
+            { "moduleName" => "history/PageSourceModule", "revision_id" => revision.id }
+          end
+        )
+
+        responses.each_with_index do |response, index|
+          body = response["body"]
+          body_html = Nokogiri::HTML(body)
+          target_revisions[index].source = PageSource.new(
+            page: page,
+            wiki_text: body_html.at_css("div.page-source").text.strip
+          )
+        end
+
+        revisions
+      end
+
+      # HTMLを取得して設定する
+      # @param page [Page] ページオブジェクト
+      # @param revisions [Array<PageRevision>] リビジョンのリスト
+      # @return [Array<PageRevision>] 更新されたリビジョンのリスト
+      def self.acquire_htmls(page:, revisions:)
+        target_revisions = revisions.reject(&:html_acquired?)
+
+        return revisions if target_revisions.empty?
+
+        responses = page.site.amc_request(
+          bodies: target_revisions.map do |revision|
+            { "moduleName" => "history/PageVersionModule", "revision_id" => revision.id }
+          end
+        )
+
+        responses.each_with_index do |response, index|
+          body = response["body"]
+          # HTMLソースの抽出
+          source = body.split(
+            "onclick=\"document.getElementById('page-version-info').style.display='none'\">",
+            2
+          )[1].split("</a>\n\t</div>\n\n\n\n", 2)[1]
+          target_revisions[index].html = source
+        end
+
+        revisions
+      end
+
+      # ソースをリビジョンに取得する
+      def get_sources
+        PageRevisionCollection.acquire_sources(page: @page, revisions: self)
+      end
+
+      # HTMLをリビジョンに取得する
+      def get_htmls
+        PageRevisionCollection.acquire_htmls(page: @page, revisions: self)
+      end
+    end
+
+    class PageRevision
+      attr_accessor :page, :id, :rev_no, :created_by, :created_at, :comment, :source, :html
+
+      # 初期化メソッド
+      # @param page [Page] ページオブジェクト
+      # @param id [Integer] リビジョンID
+      # @param rev_no [Integer] リビジョン番号
+      # @param created_by [AbstractUser] 作成者
+      # @param created_at [DateTime] 作成日時
+      # @param comment [String] コメント
+      # @param source [PageSource, nil] ページソース
+      # @param html [String, nil] HTMLソース
+      def initialize(page:, id:, rev_no:, created_by:, created_at:, comment:, source: nil, html: nil)
+        @page = page
+        @id = id
+        @rev_no = rev_no
+        @created_by = created_by
+        @created_at = created_at
+        @comment = comment
+        @source = source
+        @html = html
+      end
+
+      # ソースの取得状況を確認する
+      # @return [Boolean] ソースが取得済みかどうか
+      def source_acquired?
+        !@source.nil?
+      end
+
+      # HTMLの取得状況を確認する
+      # @return [Boolean] HTMLが取得済みかどうか
+      def html_acquired?
+        !@html.nil?
+      end
+
+      # ソースのゲッターメソッド
+      # ソースが取得されていなければ取得する
+      # @return [PageSource] ソースオブジェクト
+      def source
+        PageRevisionCollection.new(page: @page, revisions: [self]).get_sources unless source_acquired?
+        @source
+      end
+
+      # ソースのセッターメソッド
+
+      # HTMLのゲッターメソッド
+      # HTMLが取得されていなければ取得する
+      # @return [String] HTMLソース
+      def html
+        PageRevisionCollection.new(page: @page, revisions: [self]).get_htmls unless html_acquired?
+        @html
+      end
+
+      # HTMLのセッターメソッド
+    end
+  end
+end

data/lib/wikidotrb/module/page_source.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Wikidotrb
+  module Module
+    class PageSource
+      attr_accessor :page, :wiki_text
+
+      # 初期化メソッド
+      # @param page [Page] ページオブジェクト
+      # @param wiki_text [String] ページのWikiテキスト
+      def initialize(page:, wiki_text:)
+        @page = page
+        @wiki_text = wiki_text
+      end
+    end
+  end
+end

data/lib/wikidotrb/module/page_votes.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Wikidotrb
+  module Module
+    class PageVoteCollection < Array
+      attr_accessor :page
+
+      # 初期化メソッド
+      # @param page [Page] ページオブジェクト
+      # @param votes [Array<PageVote>] 投票オブジェクトのリスト
+      def initialize(page:, votes: [])
+        super(votes)
+        @page = page
+      end
+    end
+
+    class PageVote
+      attr_accessor :page, :user, :value
+
+      # 初期化メソッド
+      # @param page [Page] ページオブジェクト
+      # @param user [AbstractUser] ユーザーオブジェクト
+      # @param value [Integer] 投票の値
+      def initialize(page:, user:, value:)
+        @page = page
+        @user = user
+        @value = value
+      end
+    end
+  end
+end

data/lib/wikidotrb/module/private_message.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "httpx"
+require "nokogiri"
+require "date"
+require_relative "client"
+require_relative "user"
+require_relative "../common/exceptions"
+require_relative "../common/decorators"
+require_relative "../util/parser/odate"
+require_relative "../util/parser/user"
+
+module Wikidotrb
+  module Module
+    class PrivateMessageCollection < Array
+      extend Wikidotrb::Common::Decorators
+
+      def to_s
+        "#{self.class.name}(#{size} messages)"
+      end
+
+      def self.from_ids(client:, message_ids:)
+        bodies = message_ids.map do |message_id|
+          { item: message_id, moduleName: "dashboard/messages/DMViewMessageModule" }
+        end
+
+        responses = client.amc_client.request(bodies: bodies, return_exceptions: true)
+
+        messages = []
+
+        responses.each_with_index do |response, index|
+          if response.is_a?(Wikidotrb::Common::Exceptions::WikidotStatusCodeException) && response.status_code == ("no_message")
+            raise Wikidotrb::Common::Exceptions::ForbiddenException.new(
+              "Failed to get message: #{message_ids[index]}"
+            ), response
+          end
+
+          raise response if response.is_a?(Exception)
+
+          html = Nokogiri::HTML(response["body"])
+          sender, recipient = html.css("div.pmessage div.header span.printuser")
+          messages << PrivateMessage.new(
+            client: client,
+            id: message_ids[index],
+            sender: Wikidotrb::Util::Parser::UserParser.parse(client, sender),
+            recipient: Wikidotrb::Util::Parser::UserParser.parse(client, recipient),
+            subject: html.css("div.pmessage div.header span.subject").text.strip,
+            body: html.css("div.pmessage div.body").text.strip,
+            created_at: Wikidotrb::Util::Parser::ODateParser.parse(html.css("div.header span.odate"))
+          )
+        end
+
+        new(messages)
+      end
+
+      def self._acquire(client:, module_name:)
+        response = client.amc_client.request(bodies: [{ moduleName: module_name }])[0]
+
+        html = Nokogiri::HTML(response["body"])
+        pager = html.css("div.pager span.target")
+        max_page = pager.length > 2 ? pager[-2].text.to_i : 1
+
+        responses = if max_page > 1
+                      bodies = (1..max_page).map { |page| { page: page, moduleName: module_name } }
+                      client.amc_client.request(bodies: bodies, return_exceptions: false)
+                    else
+                      [response]
+                    end
+
+        message_ids = []
+        responses.each do |res|
+          html = Nokogiri::HTML(res["body"])
+          message_ids += html.css("tr.message").map { |tr| tr["data-href"].split("/").last.to_i }
+        end
+
+        from_ids(client: client, message_ids: message_ids)
+      end
+
+      # メソッドが定義された後にデコレータを適用
+      login_required :from_ids, :_acquire
+    end
+
+    class PrivateMessageInbox < PrivateMessageCollection
+      def self.from_ids(client:, message_ids:)
+        new(super)
+      end
+
+      def self.acquire(client:)
+        new(_acquire(client: client, module_name: "dashboard/messages/DMInboxModule"))
+      end
+    end
+
+    class PrivateMessageSentBox < PrivateMessageCollection
+      def self.from_ids(client:, message_ids:)
+        new(super)
+      end
+
+      def self.acquire(client:)
+        new(_acquire(client: client, module_name: "dashboard/messages/DMSentModule"))
+      end
+    end
+
+    class PrivateMessage
+      attr_reader :client, :id, :sender, :recipient, :subject, :body, :created_at
+
+      def initialize(client:, id:, sender:, recipient:, subject:, body:, created_at:)
+        @client = client
+        @id = id
+        @sender = sender
+        @recipient = recipient
+        @subject = subject
+        @body = body
+        @created_at = created_at
+      end
+
+      def to_s
+        "PrivateMessage(id=#{id}, sender=#{sender}, recipient=#{recipient}, subject=#{subject})"
+      end
+
+      def self.from_id(client:, message_id:)
+        PrivateMessageCollection.from_ids(client: client, message_ids: [message_id]).first
+      end
+
+      def self.send_message(client:, recipient:, subject:, body:)
+        client.amc_client.request(
+          bodies: [{
+            source: body,
+            subject: subject,
+            to_user_id: recipient.id,
+            action: "DashboardMessageAction",
+            event: "send",
+            moduleName: "Empty"
+          }]
+        )
+      end
+
+      # メソッド定義後にデコレータを適用
+      extend Wikidotrb::Common::Decorators
+      login_required :send_message
+    end
+  end
+end

data/lib/wikidotrb/module/site.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require "httpx"
+require_relative "forum"
+require_relative "page"
+require_relative "site_application"
+require_relative "../common/exceptions"
+require_relative "../common/decorators"
+
+module Wikidotrb
+  module Module
+    class SitePagesMethods
+      def initialize(site)
+        @site = site
+      end
+
+      # ページを検索する
+      # @param kwargs [Hash] 検索クエリのパラメータ
+      # @return [PageCollection] ページのコレクション
+      def search(**kwargs)
+        query = SearchPagesQuery.new(**kwargs)
+        PageCollection.search_pages(@site, query)
+      end
+    end
+
+    class SitePageMethods
+      def initialize(site)
+        @site = site
+      end
+
+      # フルネームからページを取得する
+      # @param fullname [String] ページのフルネーム
+      # @param raise_when_not_found [Boolean] ページが見つからない場合に例外を発生させるかどうか
+      # @return [Page, nil] ページオブジェクト、もしくはnil
+      def get(fullname, raise_when_not_found: true)
+        res = PageCollection.search_pages(@site, Wikidotrb::Module::SearchPagesQuery.new(fullname: fullname))
+
+        if res.empty?
+          raise Wikidotrb::Common::Exceptions::NotFoundException, "Page is not found: #{fullname}" if raise_when_not_found
+
+          return nil
+        end
+
+        res.first
+      end
+
+      # ページを作成する
+      # @param fullname [String] ページのフルネーム
+      # @param title [String] ページのタイトル
+      # @param source [String] ページのソース
+      # @param comment [String] コメント
+      # @param force_edit [Boolean] ページが存在する場合に上書きするかどうか
+      # @return [Page] 作成されたページオブジェクト
+      def create(fullname:, title: "", source: "", comment: "", force_edit: false)
+        Page.create_or_edit(
+          site: @site,
+          fullname: fullname,
+          title: title,
+          source: source,
+          comment: comment,
+          force_edit: force_edit,
+          raise_on_exists: true
+        )
+      end
+    end
+
+    class Site
+      attr_reader :client, :id, :title, :unix_name, :domain, :ssl_supported, :pages, :page
+
+      extend Wikidotrb::Common::Decorators
+
+      def initialize(client:, id:, title:, unix_name:, domain:, ssl_supported:)
+        @client = client
+        @id = id
+        @title = title
+        @unix_name = unix_name
+        @domain = domain
+        @ssl_supported = ssl_supported
+
+        @pages = SitePagesMethods.new(self)
+        @page = SitePageMethods.new(self)
+        @forum = Forum.new(site: self)
+      end
+
+      def to_s
+        "Site(id=#{id}, title=#{title}, unix_name=#{unix_name})"
+      end
+
+      # UNIX名からサイトオブジェクトを取得する
+      # @param client [Client] クライアント
+      # @param unix_name [String] サイトのUNIX名
+      # @return [Site] サイトオブジェクト
+      def self.from_unix_name(client:, unix_name:)
+        url = "http://#{unix_name}.wikidot.com"
+        timeout = { connect: client.amc_client.config.request_timeout }
+        response = HTTPX.with(timeout: timeout).get(url)
+
+        # リダイレクトの対応
+        while response.status >= 300 && response.status < 400
+          url = response.headers["location"]
+          response = HTTPX.with(timeout: timeout).get(url)
+        end
+
+        # サイトが存在しない場合
+        raise Wikidotrb::Common::Exceptions::NotFoundException, "Site is not found: #{unix_name}.wikidot.com" if response.status == 404
+
+        # サイトが存在する場合
+        source = response.body.to_s
+
+        # id : WIKIREQUEST.info.siteId = xxxx;
+        id_match = source.match(/WIKIREQUEST\.info\.siteId = (\d+);/)
+        raise Wikidotrb::Common::Exceptions::UnexpectedException, "Cannot find site id: #{unix_name}.wikidot.com" if id_match.nil?
+
+        site_id = id_match[1].to_i
+
+        # title : titleタグ
+        title_match = source.match(%r{<title>(.*?)</title>})
+        raise Wikidotrb::Common::Exceptions::UnexpectedException, "Cannot find site title: #{unix_name}.wikidot.com" if title_match.nil?
+
+        title = title_match[1]
+
+        # unix_name : WIKIREQUEST.info.siteUnixName = "xxxx";
+        unix_name_match = source.match(/WIKIREQUEST\.info\.siteUnixName = "(.*?)";/)
+        if unix_name_match.nil?
+          raise Wikidotrb::Common::Exceptions::UnexpectedException,
+                "Cannot find site unix_name: #{unix_name}.wikidot.com"
+        end
+
+        unix_name = unix_name_match[1]
+
+        # domain : WIKIREQUEST.info.domain = "xxxx";
+        domain_match = source.match(/WIKIREQUEST\.info\.domain = "(.*?)";/)
+        raise Wikidotrb::Common::Exceptions::UnexpectedException, "Cannot find site domain: #{unix_name}.wikidot.com" if domain_match.nil?
+
+        domain = domain_match[1]
+
+        # SSL対応チェック
+        ssl_supported = response.uri.to_s.start_with?("https")
+
+        new(
+          client: client,
+          id: site_id,
+          title: title,
+          unix_name: unix_name,
+          domain: domain,
+          ssl_supported: ssl_supported
+        )
+      end
+
+      # このサイトに対してAMCリクエストを実行する
+      # @param bodies [Array<Hash>] リクエストボディのリスト
+      # @param return_exceptions [Boolean] 例外を返すかどうか
+      def amc_request(bodies:, return_exceptions: false)
+        client.amc_client.request(
+          bodies: bodies,
+          return_exceptions: return_exceptions,
+          site_name: unix_name,
+          site_ssl_supported: ssl_supported
+        )
+      end
+
+      # サイトへの未処理の参加申請を取得する
+      # @return [Array<SiteApplication>] 未処理の申請リスト
+      def get_applications
+        SiteApplication.acquire_all(site: self)
+      end
+
+      # ユーザーをサイトに招待する
+      # @param user [User] 招待するユーザー
+      # @param text [String] 招待文
+      def invite_user(user:, text:)
+        amc_request(
+          bodies: [{
+            action: "ManageSiteMembershipAction",
+            event: "inviteMember",
+            user_id: user.id,
+            text: text,
+            moduleName: "Empty"
+          }]
+        )
+      rescue Wikidotrb::Common::Exceptions::WikidotStatusCodeException => e
+        case e.status_code
+        when "already_invited"
+          raise Wikidotrb::Common::Exceptions::TargetErrorException.new(
+            "User is already invited to #{unix_name}: #{user.name}"
+          ), e
+        when "already_member"
+          raise Wikidotrb::Common::Exceptions::TargetErrorException.new(
+            "User is already a member of #{unix_name}: #{user.name}"
+          ), e
+        else
+          raise e
+        end
+      end
+
+      # サイトのURLを取得する
+      # @return [String] サイトのURL
+      def get_url
+        "http#{ssl_supported ? "s" : ""}://#{domain}"
+      end
+
+      # `invite_user`にデコレータを適用
+      login_required :invite_user
+      login_required :get_applications
+    end
+  end
+end

data/lib/wikidotrb/module/site_application.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require_relative "site"
+require_relative "user"
+require_relative "../common/exceptions"
+require_relative "../util/parser/odate"
+require_relative "../util/parser/user"
+
+module Wikidotrb
+  module Module
+    class SiteApplication
+      attr_reader :site, :user, :text
+
+      def initialize(site:, user:, text:)
+        @site = site
+        @user = user
+        @text = text
+      end
+
+      def to_s
+        "SiteApplication(user=#{user}, site=#{site}, text=#{text})"
+      end
+
+      def self.acquire_all(site:)
+        # サイトへの未処理の申請を取得する
+        # @param site [Site] サイト
+        # @return [Array<SiteApplication>] 申請のリスト
+        response = site.amc_request(
+          bodies: [{ moduleName: "managesite/ManageSiteMembersApplicationsModule" }]
+        ).first
+
+        body = response["body"]
+
+        raise Wikidotrb::Common::Exceptions::ForbiddenException, "You are not allowed to access this page" if body.include?("WIKIDOT.page.listeners.loginClick(event)")
+
+        html = Nokogiri::HTML(response["body"])
+
+        applications = []
+
+        user_elements = html.css("h3 span.printuser")
+        text_wrapper_elements = html.css("table")
+
+        if user_elements.length != text_wrapper_elements.length
+          raise Wikidotrb::Common::Exceptions::UnexpectedException,
+                "Length of user_elements and text_wrapper_elements are different"
+        end
+
+        user_elements.each_with_index do |user_element, i|
+          text_wrapper_element = text_wrapper_elements[i]
+
+          user = Wikidotrb::Util::Parser::UserParser.user(site.client, user_element)
+          text = text_wrapper_element.css("td")[1].text.strip
+
+          applications << SiteApplication.new(site: site, user: user, text: text)
+        end
+
+        applications
+      end
+
+      def _process(action)
+        # 申請を処理する
+        # @param action [String] 処理の種類 ('accept' または 'decline')
+        raise ArgumentError, "Invalid action: #{action}" unless %w[accept decline].include?(action)
+
+        begin
+          site.amc_request(
+            bodies: [{
+              action: "ManageSiteMembershipAction",
+              event: "acceptApplication",
+              user_id: user.id,
+              text: "your application has been #{action}ed",
+              type: action,
+              moduleName: "Empty"
+            }]
+          )
+        rescue Wikidotrb::Common::Exceptions::WikidotStatusCodeException => e
+          raise e unless e.status_code == "no_application"
+
+          raise Wikidotrb::Common::Exceptions::NotFoundException.new(
+            "Application not found: #{user}"
+          ), e
+        end
+      end
+
+      # 申請を承認する
+      def accept
+        _process("accept")
+      end
+
+      # 申請を拒否する
+      def decline
+        _process("decline")
+      end
+    end
+  end
+end