growi-client 0.9.0

data/lib/growi/client/client.rb

@@ -0,0 +1,73 @@
+require 'rest-client'
+require 'json'
+require 'yaml'
+require 'uri'
+
+require 'growi/client/apireq/api_request_pages'
+require 'growi/client/apireq/api_request_attachments'
+
+# Growi のクライアントクラス
+class GrowiClient
+
+  # コンストラクタ
+  def initialize(growi_url: '', access_token: '', rest_client_param: {})
+    raise ArgumentError, 'Config `growi_url` is required.'    if growi_url.empty?
+    raise ArgumentError, 'Config `access_token` is required.' if access_token.empty?
+
+    @growi_url = growi_url
+    @access_token = access_token
+    @rest_client_param = rest_client_param
+    @cp_entry_point = URI.join(growi_url, '/_api/').to_s
+  end
+
+  # APIリクエストを送信する
+  # @param [ApiRequestBase] req APIリクエスト
+  # @return [String] APIリクエストの応答（JSON形式）
+  def request(req)
+    req.param[:access_token] = @access_token
+    return req.execute URI.join(@cp_entry_point, req.entry_point).to_s,
+                       rest_client_param: @rest_client_param
+  end
+
+  # ページIDを取得する
+  # @param [String] path_exp ページパス
+  # @return [String] ページID
+  def page_id(path_exp: nil)
+    ret = request(GApiRequestPagesList.new path_exp: path_exp)
+    return nil if (ret.kind_of? CPInvalidRequest || ret.data.nil?)
+    return ret.data.find { |page| URI.unescape(page.path) == path_exp }&.id
+  end
+
+  # ページが存在するか調べる
+  # @param [String] path ページパス
+  # @return [true/false] ページの存在
+  def page_exist?(path_exp: nil)
+    return !page_id(path_exp: path_exp).nil?
+  end
+
+  # ページに添付ファイルが存在するか調べる
+  # @param [String] path_exp ページパス（正規表現）
+  # @param [String] attachment_name 添付ファイル名
+  # @return [true/false] 添付ファイルの存在
+  def attachment_exist?(path_exp: nil, attachment_name: nil)
+    ret = request(GApiRequestAttachmentsList.new page_id: page_id(path_exp: path_exp))
+    return ret&.ok && ret&.data&.find { |a| a.originalName == attachment_name } != nil
+  end
+
+  # 指定した添付ファイルのIDを取得する
+  # @param  [String] path_exp ページパス（正規表現）
+  # @return [String] attachment's file name
+  def attachment_id(path_exp: nil, attachment_name: nil)
+    ret = request(GApiRequestAttachmentsList.new page_id: page_id(path_exp: path_exp))
+    return ret&.data&.find { |a| a.originalName == attachment_name }&._id
+  end
+
+  # 指定した添付ファイル情報を取得する
+  # @param  [String] path_exp ページパス（正規表現）
+  # @return [String] attachment's file name
+  def attachment(path_exp: nil, attachment_name: nil)
+    ret = request(GApiRequestAttachmentsList.new page_id: page_id(path_exp: path_exp))
+    return ret&.data&.find { |a| a.originalName == attachment_name }
+  end
+
+end

data/lib/growi/client/model/growi_attachment.rb

@@ -0,0 +1,36 @@
+require 'growi/client/model/growi_model'
+
+# Growi Attachment model class
+class GrowiAttachment < GrowiModelBase
+  attr_reader :_id, :fileFormat, :fileName, :originalName, :filePath,
+              :creator, :page, :__v, :createdAt, :fileSize, :url
+
+  # Constractor
+  # @param [Hash] Attachment model shown as hash
+  # @todo Except running register method always called parse method.
+  def initialize(params = {})
+    init_params = {
+      _id: nil, fileFormat: '', fileName: '', originalName: '', filePath: nil,
+      creator: nil, page: '', __v: 0, createdAt: '', fileSize: 0, url: ''
+    }
+
+    params = init_params.merge(params.map { |k,v| [k.to_sym, v] }.to_h)
+    if (params[:_id] == nil)
+      raise ArgumentError.new('Parameters id is required.')
+    end
+
+    GrowiModelFactory.instance.register({
+      attachment_creator:   Proc.new { |param| param != nil && param.is_a?(String) ? param : GrowiUser.new(param) },
+      attachment_createdAt: Proc.new { |date_str|
+                              date_str != nil && DateTime.parse(date_str) },
+    })
+    maked_params = {}
+    params.each do |k,v|
+      maker = GrowiModelFactory.instance.maker('attachment_' + k.to_s)
+      maked_params[k] = maker.call(v)
+    end
+    super(maked_params)
+  end
+
+end
+

data/lib/growi/client/model/growi_model.rb

@@ -0,0 +1,52 @@
+require 'singleton'
+
+require 'growi/client/model/growi_model_base'
+require 'growi/client/model/growi_page'
+require 'growi/client/model/growi_page_revision'
+require 'growi/client/model/growi_user'
+require 'growi/client/model/growi_attachment'
+
+# Growi model factory class
+# @abstract include singleton class
+# @attr_reader makers Model maker list
+class GrowiModelFactory
+  include Singleton
+  attr_reader :makers
+
+  # Constractor
+  def initialize
+    @makers = {}
+    @makers.default = Proc.new { |param|
+      next nil if param == nil
+      case param
+      when Array, String, Integer then
+        ret = param
+      when FalseClass then
+        ret = false
+      when TrueClass then
+        ret = true
+      end
+      next ret
+    }
+  end
+
+  # Register model maker
+  # @param [Hash] Model factory list
+  def register(makers = {})
+    makers.each do |model_name, model_make_proc|
+      unless model_make_proc.is_a?(Proc)
+        raise ArgumentError.new('Maker is required sub class of Class.')
+      end
+    end
+    @makers.merge!(makers)
+  end
+
+  # Get model maker
+  # @param [String] model_name Model name
+  # @return [Proc] Model maker
+  def maker(model_name)
+    return @makers[model_name&.to_sym]
+  end
+
+end
+

data/lib/growi/client/model/growi_model_base.rb

@@ -0,0 +1,12 @@
+# Growi model base class
+class GrowiModelBase
+
+  # Constractor
+  def initialize(params = {})
+    params.each do |k,v|
+      instance_variable_set(:"@#{k}", v)
+    end
+  end
+
+end
+

data/lib/growi/client/model/growi_page.rb

@@ -0,0 +1,53 @@
+require 'growi/client/model/growi_model'
+
+# Growi Page model class
+class GrowiPage < GrowiModelBase
+  GRANT_PUBLIC     = 1.freeze
+  GRANT_RESTRICTED = 2.freeze
+  GRANT_SPECIFIED  = 3.freeze
+  GRANT_OWNER      = 4.freeze
+
+  STATUS_WIP        = 'wip'.freeze
+  STATUS_PUBLISHED  = 'published'.freeze
+  STATUS_DELETED    = 'deleted'.freeze
+  STATUS_DEPRECATED = 'deprecated'.freeze
+
+  attr_reader :_id, :redirectTo, :updatedAt, :lastUpdateUser,
+              :creator, :path, :__v, :revision, :createdAt,
+              :commentCount, :seenUsers, :liker, :grantedUsers,
+              :grant, :status, :id
+
+  # Constract
+  # @param [Hash] params Prameters data show as Hash
+  # @todo Except running register method always called parse method.
+  def initialize(params = {})
+    init_params = {
+      _id: '', redirectTo: nil, updatedAt: '', lastUpdateUser: '',
+      creator: nil, path: nil, __v: 0, revision: nil, createdAt: '',
+      commentCount: 0, seenUsers: [], liker: [], grantedUsers: [],
+      grant: 0, status: '', id: ''
+    }
+
+    params = init_params.merge(params.map { |k,v| [k.to_sym, v] }.to_h)
+    if (params[:_id] == nil || params[:path] == nil || params[:id] == nil)
+      raise ArgumentError.new('Parameters _id, path and id are required.')
+    end
+
+    # @note Parameters lastUpdateUser and creator have two patterns ID only or Object.
+    GrowiModelFactory.instance.register({
+      page_updatedAt:      Proc.new { |str| str != nil && DateTime.parse(str) },
+      page_lastUpdateUser: Proc.new { |param| param != nil && param.is_a?(String) ? param : GrowiUser.new(param) },
+      page_creator:        Proc.new { |param| param != nil && param.is_a?(String) ? param : GrowiUser.new(param) },
+      page_createdAt:      Proc.new { |str| str != nil && DateTime.parse(str) },
+      page_revision:       Proc.new { |param| param != nil && GrowiPageRevision.new(param) },
+    })
+    maked_params = {}
+    params.each do |k,v|
+      maker = GrowiModelFactory.instance.maker('page_' + k.to_s)
+      maked_params[k] = maker.call(v)
+    end
+    super(maked_params)
+  end
+
+end
+

data/lib/growi/client/model/growi_page_revision.rb

@@ -0,0 +1,34 @@
+require 'growi/client/model/growi_model'
+
+# Growi Page revision model class
+class GrowiPageRevision < GrowiModelBase
+  attr_reader :_id, :author, :body, :path, :__v, :createdAt, :format
+
+  # Constractor
+  # @param [Hash] User model shown as hash
+  # @todo Except running register method always called parse method.
+  def initialize(params = {})
+    init_params = {
+      _id: '', author: nil, body: nil, path: nil, __v: 0, createdAt: nil,
+      format: ''
+    }
+
+    params = init_params.merge(params.map { |k,v| [k.to_sym, v] }.to_h)
+    if (params[:_id] == nil ||  params[:path] == nil)
+      raise ArgumentError.new('Parameters _id and path are required.')
+    end
+
+    GrowiModelFactory.instance.register({
+      page_revision_createdAt: Proc.new { |date_str|
+                                          date_str != nil && DateTime.parse(date_str) },
+    })
+    maked_params = {}
+    params.each do |k,v|
+      maker = GrowiModelFactory.instance.maker('page_revision_' + k.to_s)
+      maked_params[k] = maker.call(v)
+    end
+    super(maked_params)
+  end
+
+end
+

data/lib/growi/client/model/growi_user.rb

@@ -0,0 +1,35 @@
+require 'growi/client/model/growi_model'
+
+# Growi User model class
+class GrowiUser < GrowiModelBase
+  attr_reader :_id, :email, :username, :name,
+              :admin, :createdAt, :status, :lang, :isGravatarEnabled
+
+  # Constractor
+  # @param [Hash] User model shown as hash
+  # @todo Except running register method always called parse method.
+  def initialize(params = {})
+    init_params = {
+      _id: nil, email: nil, username: nil, name: '',
+      admin: false, createdAt: '', status: 0, lang: '', isGravatarEnabled: false
+    }
+
+    params = init_params.merge(params.map { |k,v| [k.to_sym, v] }.to_h)
+    if (params[:_id] == nil || params[:email] == nil || params[:username] == nil)
+      raise ArgumentError.new('Parameters id and email and name are required.')
+    end
+
+    GrowiModelFactory.instance.register({
+      user_createdAt: Proc.new { |date_str|
+                        date_str != nil && DateTime.parse(date_str) },
+    })
+    maked_params = {}
+    params.each do |k,v|
+      maker = GrowiModelFactory.instance.maker('user_' + k.to_s)
+      maked_params[k] = maker.call(v)
+    end
+    super(maked_params)
+  end
+
+end
+

data/lib/growi/client/version.rb

@@ -0,0 +1,5 @@
+module Growi
+  module Client
+    VERSION = "0.9.0"
+  end
+end

data/wercker.yml

@@ -0,0 +1,89 @@
+box: ruby:2.5.1
+
+# Run weseek/growi, mongo, elasticsearch
+services:
+  - name: mongo
+    id: mongo:3.4
+
+build:
+    # Steps make up the actions in your pipeline
+    # Read more about steps on our dev center:
+    # http://devcenter.wercker.com/docs/steps/index.html
+    steps:
+        - bundle-install
+
+        - script:
+            name: "Install utility tools"
+            code: |
+              apt-get update
+              apt-get install -y netcat
+
+        - script: 
+            name: "Wait for MongoDB connection" 
+            code: | 
+              echo Wait for connect to $MONGO_PORT_27017_TCP_ADDR:$MONGO_PORT_27017_TCP_PORT
+              while ! nc -q 1 $MONGO_PORT_27017_TCP_ADDR $MONGO_PORT_27017_TCP_PORT </dev/null; do
+                echo "...waiting 3s"; sleep 3;
+              done
+
+        - internal/docker-run:
+            image: weseek/growi:3.1.12
+            name: growi
+            env: >
+              MONGO_URI=mongodb://$MONGO_PORT_27017_TCP_ADDR:$MONGO_PORT_27017_TCP_PORT/growi
+              PASSWORD_SEED=empty
+              FILE_UPLOAD=local
+
+        - script: 
+            name: "Wait for GROWI connection" 
+            code: | 
+              echo Wait for connect to growi:3000
+              while ! nc -q 1 growi 3000 < /dev/null; do
+                echo "...waiting 3s"; sleep 3;
+              done
+              export GROWI_URL=http://growi:3000
+
+        - script:
+            name: "Create admin user"
+            code: |
+              export ADMIN_USER_NAME=admin1
+              export ADMIN_USER_PASS=admin1pass
+              LOGIN_COOKIE=login.cookie
+              OUTPUT_PAGE_NAME=installer.html
+              curl $GROWI_URL/installer -c ${LOGIN_COOKIE} -o ${OUTPUT_PAGE_NAME}
+              CSRF=`grep data-csrftoken ${OUTPUT_PAGE_NAME} | awk -F'=' '{ print $2 }' | sed -e s/\"//g`
+              curl $GROWI_URL/installer/createAdmin -b ${LOGIN_COOKIE} -X POST \
+                -d "registerForm[name]=${ADMIN_USER_NAME}&registerForm[username]=${ADMIN_USER_NAME}&registerForm[email]=${ADMIN_USER_NAME}@localhost&registerForm[password]=${ADMIN_USER_PASS}&_csrf=${CSRF}"
+
+        - script:
+            name: "Login as admin1"
+            code: |
+              OUTPUT_PAGE_NAME=login.html
+              curl $GROWI_URL/login -c ${LOGIN_COOKIE} -o ${OUTPUT_PAGE_NAME}
+              CSRF=`grep data-csrftoken ${OUTPUT_PAGE_NAME} | awk -F'=' '{ print $2 }' | sed -e s/\"//g`
+              curl $GROWI_URL/login -b ${LOGIN_COOKIE} -X POST -d "loginForm[username]=${ADMIN_USER_NAME}&loginForm[password]=${ADMIN_USER_PASS}&_csrf=${CSRF}"
+
+        - script:
+            name: "Generate API token"
+            code: |
+              OUTPUT_PAGE_NAME=apiToken.html
+              curl $GROWI_URL/me/apiToken -b ${LOGIN_COOKIE} -o ${OUTPUT_PAGE_NAME}
+              CSRF=`grep data-csrftoken ${OUTPUT_PAGE_NAME} | awk -F'=' '{ print $2 }' | sed -e s/\"//g`
+              curl $GROWI_URL/me/apiToken -b ${LOGIN_COOKIE} -X POST -d "apiTokenForm[confirm]=1&_csrf=${CSRF}"
+              curl $GROWI_URL/me/apiToken -b ${LOGIN_COOKIE} -o ${OUTPUT_PAGE_NAME}
+              export APITOKEN=`grep -A 10 'Current API Token' ${OUTPUT_PAGE_NAME} | grep '<input' | awk -F'value=' '{ print $2 }' | awk -F'"' '{ print $2 }'`
+
+        - script:
+            name: "Export environment variables"
+            code: |
+              export GROWI_URL=$GROWI_URL
+              export GROWI_ACCESS_TOKEN=$APITOKEN
+
+        - script:
+            name: "View environment variables"
+            code: |
+              env
+
+        - script:
+            name: rspec
+            code: bundle exec rspec

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: growi-client
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Ryu Sato
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: growi-client is client of growi with use API.
+email:
+- ryu@weseek.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- growi-client.gemspec
+- lib/growi-client.rb
+- lib/growi/client/apireq/api_request_attachments.rb
+- lib/growi/client/apireq/api_request_base.rb
+- lib/growi/client/apireq/api_request_pages.rb
+- lib/growi/client/client.rb
+- lib/growi/client/model/growi_attachment.rb
+- lib/growi/client/model/growi_model.rb
+- lib/growi/client/model/growi_model_base.rb
+- lib/growi/client/model/growi_page.rb
+- lib/growi/client/model/growi_page_revision.rb
+- lib/growi/client/model/growi_user.rb
+- lib/growi/client/version.rb
+- wercker.yml
+homepage: https://github.com/ryu-sato/growi-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Client of growi
+test_files: []