crowi-client 0.1.0

data/lib/crowi-client.rb

@@ -0,0 +1 @@
+require 'crowi/client/client'

data/lib/crowi/client/apireq/api_request_attachments.rb

@@ -0,0 +1,134 @@
+require_relative 'api_request_base'
+
+# 添付ファイル一覧リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/attachment.js
+class CPApiRequestAttachmentsList < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/attachments.list', METHOD_GET, { page_id: param[:page_id] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.get entry_point, params: @param
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    attachments = []
+    ret['attachments'].each do |attachment|
+      attachments.push(CrowiAttachment.new(attachment))
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: attachments)
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:page_id])
+      CPInvalidRequest.new 'Parameter page_id is required.'
+    end
+  end
+
+end
+
+# 添付ファイル追加リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/attachment.js
+class CPApiRequestAttachmentsAdd < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/attachments.add', METHOD_POST,
+          { page_id: param[:page_id], file: param[:file] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [String] リクエスト実行結果（JSON形式）
+  def execute(entry_point)
+    if invalid?
+      return validation_msg
+    end
+    req = RestClient::Request.new(
+      method: :post,
+      url:    entry_point,
+      payload: {
+        access_token: @param[:access_token],
+        page_id:      @param[:page_id],
+        file:         @param[:file]
+      }
+    )
+    ret = JSON.parse req.execute
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['page']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:file] && @param[:page_id])
+      CPInvalidRequest.new 'Parameters file and page_id are required.'
+    end
+  end
+
+end
+
+
+# 添付ファイル削除リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/attachment.js
+class CPApiRequestAttachmentsRemove < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/attachments.remove', METHOD_POST,
+          { attachment_id: param[:attachment_id] })
+  end
+
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.post entry_point, @param.to_json,
+                          { content_type: :json, accept: :json }
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: nil)
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:attachment_id])
+      CPInvalidRequest.new 'Parameter attachment_id is required.'
+    end
+  end
+
+end
+

data/lib/crowi/client/apireq/api_request_base.rb

@@ -0,0 +1,104 @@
+# APIリクエストのバリデーションエラー
+# @note rescue する必要はないので Exception クラスは継承しない
+class CPInvalidRequest
+  attr_reader :msg
+
+  # コンストラクタ
+  # @param [String] msg エラーメッセージ（原因と対策が分かるとよい）
+  def initialize(msg)
+    @msg = msg
+  end
+
+  # Convert string
+  # @return [String] Message
+  def to_s
+    return @msg
+  end
+end
+
+# APIリクエストの応答基本クラス
+class CPApiReturn
+  attr_accessor :ok, :data
+
+  # Constractor
+  # @param [String] ok Result of API
+  def initialize(params = {})
+    if (! params[:ok].is_a?(TrueClass) && ! params[:ok].is_a?(FalseClass))
+      raise ArgumentError.new('Parameter ok is needed true or false.')
+    end
+    @ok = params[:ok]
+    @data = params[:data]
+  end
+
+end
+
+# APIリクエストの基本クラス
+class CPApiRequestBase
+  METHOD_GET = "GET"
+  METHOD_POST = "POST"
+  attr_reader :entry_point, :method, :param
+
+  # コンストラクタ
+  # @param [String] entry_point APIリクエストのエントリポイントとなるURLパス(ex. '/page.list')
+  # @param [Enumerator] method APIリクエストのタイプ
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(entry_point, method, param = {})
+    @entry_point = entry_point
+    @method = method
+    @param = param.reject { |k, v| !v }
+  end
+
+  # パラメータを代入
+  # @param [Hash] param APIリクエストのパラメータ
+  def param=(param = {})
+    @param = param
+  end
+
+  # パラメータのバリデーションチェックを行う
+  # @return [true/false] バリデーションチェック結果
+  def valid?
+    return (!_invalid)
+  end
+
+  # パラメータのバリデーションチェックを行う
+  # @return [true/false] バリデーションチェック結果
+  def invalid?
+    return (_invalid)
+  end
+
+  # バリデーションエラーの説明
+  # @return [String] バリデーションエラーの説明
+  def validation_msg
+    return _invalid&.to_s
+  end
+
+  # リクエストを実行する
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [String] リクエスト実行結果（CPApiReturnオブジェクト）
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+
+    case @method
+    when 'GET'
+      ret_json = RestClient.get entry_point, params: @param
+    when 'POST'
+      ret_json = RestClient.post entry_point, @param.to_json,
+                                 { content_type: :json, accept: :json }
+    end
+    ret = JSON.parse(ret_json)
+    return CPApiReturn.new(ok: ret['ok'], data: ret.reject { |k,v| k == 'ok' })
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    return CPInvalidRequest "Invalid API request.";
+  end
+
+end
+

data/lib/crowi/client/apireq/api_request_pages.rb

@@ -0,0 +1,389 @@
+require_relative 'api_request_base'
+require 'crowi/client/model/crowi_page'
+
+# ページ一覧リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+class CPApiRequestPagesList < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/pages.list', METHOD_GET,
+          { path: param[:path_exp], user: param[:user] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [Array] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+
+    ret = JSON.parse RestClient.get entry_point, params: @param
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    pages = []
+    ret['pages'].each do |page|
+      pages.push(CrowiPage.new(page))
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: pages)
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:path] || @param[:user])
+      return CPInvalidRequest.new 'Parameter path or page_id is required.'
+    end
+  end
+
+end
+
+
+# ページ取得リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+class CPApiRequestPagesGet < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/pages.get', METHOD_GET,
+          { page_id: param[:page_id], 
+            path: param[:path], revision_id: param[:revision_id] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.get entry_point, params: @param
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['page']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:path] || @param[:page_id]) 
+      return CPInvalidRequest.new 'Parameter path or page_id is required.'
+    end
+  end
+
+end
+
+
+# ページ作成リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+class CPApiRequestPagesCreate < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/pages.create', METHOD_POST,
+          { body: param[:body], path: param[:path], grant: param[:grant] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.post entry_point, @param.to_json,
+                          { content_type: :json, accept: :json }
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['page']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:body] && @param[:path]) 
+      return CPInvalidRequest.new 'Parameters body and path are required.'
+    end
+  end
+
+end
+
+# ページ更新リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+class CPApiRequestPagesUpdate < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/pages.update', METHOD_POST,
+          { body: param[:body], page_id: param[:page_id],
+            revision_id: param[:revision_id], grant: param[:grant] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.post entry_point, @param.to_json,
+                          { content_type: :json, accept: :json }
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['page']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:page_id] && @param[:body]) 
+      return CPInvalidRequest.new 'Parameters page_id and body are required.'
+    end
+  end
+
+end
+
+# ページ閲覧済マークを付与リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+# @note 詳細不明
+class CPApiRequestPagesSeen < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/pages.seen', METHOD_POST, { page_id: param[:page_id] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.post entry_point, @param.to_json,
+                          { content_type: :json, accept: :json }
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['seenUser']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:page_id]) 
+      return CPInvalidRequest.new 'Parameter page_id required.'
+    end
+  end
+
+end
+
+# ライクページ指定リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+class CPApiRequestLikesAdd < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/likes.add', METHOD_POST, { page_id: param[:page_id] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.post entry_point, @param.to_json,
+                          { content_type: :json, accept: :json }
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['page']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:page_id]) 
+      return CPInvalidRequest.new 'Parameter page_id required.'
+    end
+  end
+
+end
+
+# ライクページ指定解除リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+class CPApiRequestLikesRemove < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/likes.remove', METHOD_POST, { page_id: param[:page_id] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.post entry_point, @param.to_json,
+                          { content_type: :json, accept: :json }
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['page']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:page_id]) 
+      return CPInvalidRequest.new 'Parameter page_id required.'
+    end
+  end
+
+end
+
+# 更新ページ一覧リクエスト用クラス
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+# @note notification for 3rd party tool (like Slack)
+class CPApiRequestPagesUpdatePost < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    super('/_api/pages.updatePost', METHOD_GET, { path: param[:path] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.get entry_point, params: @param
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    posts = []
+    ret['updatePost'].each do |post|
+      pages.push(CrowiPage.new(post))
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: posts)
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:path]) 
+      return CPInvalidRequest.new 'Parameter path required.'
+    end
+  end
+
+end
+
+# ページ削除リクエスト用クラス（API利用不可）
+# @ref https://github.com/crowi/crowi/blob/master/lib/routes/page.js
+class CPApiRequestPagesRemove < CPApiRequestBase
+
+  # コンストラクタ
+  # @override
+  # @param [Hash] param APIリクエストのパラメータ
+  def initialize(param = {})
+    raise Exception, 'API of pages.remove is forbidden'
+    super('/_api/pages.remove', METHOD_GET,
+          { page_id: param[:page_id], revision_id: param[:revision_id] })
+  end
+
+  # リクエストを実行する
+  # @override
+  # @param  [String] entry_point APIのエントリーポイントとなるURL（ex. http://localhost:3000/_api/pages.list）
+  # @return [CrowiPage] リクエスト実行結果
+  def execute(entry_point)
+
+    if invalid?
+      return validation_msg
+    end
+    ret = JSON.parse RestClient.get entry_point, params: @param
+    if (ret['ok'] == false)
+      return CPInvalidRequest.new "API return false with msg: #{ret['msg']}"
+    end
+    return CPApiReturn.new(ok: ret['ok'], data: CrowiPage.new(ret['page']))
+  end
+
+protected
+
+  # バリデーションエラーを取得する
+  # @override
+  # @return [nil/CPInvalidRequest] バリデーションエラー結果
+  def _invalid
+    if ! (@param[:page_id] || @param[:revision_id]) 
+      return CPInvalidRequest.new 'Parameter page_id or revision_id is required.'
+    end
+  end
+
+end
+