crowi-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6388fff5bc284cbf0d49c2f31883309847e8fdf0d40c073fe168bffe52662adb
-  data.tar.gz: 3e6dd95a3611fc8b5e887f53cb209733806186be5fdebf0be1064f393ddb47b2
+  metadata.gz: 310285c37c1db2f5953063e99c161c6a1236f66f1ce2f47c31f317d04c04409d
+  data.tar.gz: eee12e023f1311472a314ed17dc6488cb1c41978f8fe0e2a6693a56bdfb79626
 SHA512:
-  metadata.gz: 721ed10e71c335768ee331c1c49f1fd8393cbae2028bad25abafee11dacbee20a75c869b5b163de287234bba09d9bb6014b84b288f3b4435b9535b5db09691ab
-  data.tar.gz: 27e91594ff1e3af6c60991b596465600332a3f29120284f5717f77f32e247225b1c23679f2ea5d4172b7b2122e22983a351653d57ed7c9e1fa4c7f657b9c1dfe
+  metadata.gz: b5340275410bd45e55f42bdf61da53d1dc54fa81f2cd807a80b94e7112e5ca3141463967db635894e19745a719008c86cbfdf4b07ebf982feffb440bc14b6fea
+  data.tar.gz: e9dd54e46956a2ef52d9887666cf98f5ef37e00965c7259f279e4536aaea50f72e3e9e6164850156f3596ba1be08054b898d5a7156578d151fce92799e92ee72

data/README.md

@@ -20,76 +20,75 @@ Or install it yourself as:
 
 ## Usage
 
-At first, you need to create setting file ```config/settings.yml``` in your application directory.
-And set token key of crowi API, and URL of crowi (ex. http://localhost:3000) in ```settings.yml```.
+Export these environments.
 
-```YAML
-# Example of config/settings.yml. YOU NEED TO REPLACE token!!!
-token: xEKAueUZDrQlr30iFZr96ti3GUd8sqP/pTkS3DGrwcc=
-url: http://localhost:3000/
 ```
-
-Then, you can use crowi client with ```require 'crowi-client'```.
+export CROWI_ACCESS_TOKEN=0123456789abcdef0123456789abcdef0123456789ab
+export CROWI_URL=http://localhost:3000/
+```
 
 ```ruby
 require 'crowi-client'
-puts CrowiClient.instance.page_exist?( path_exp: '/' )
-puts CrowiClient.instance.attachment_exist?( path_exp: '/', attachment_name: 'LICENSE.txt' )
+
+crowi_client = CrowiClient.new(crowi_url: ENV['CROWI_URL'], access_token: ENV['CROWI_ACCESS_TOKEN'])
+
+puts crowi_client.page_exist?( path_exp: '/' )
+puts crowi_client.attachment_exist?( path_exp: '/', attachment_name: 'LICENSE.txt' )
 ```
 
 ## Examples
 
 ```ruby
 # get page's ID
-puts CrowiClient.instance.page_id( path_exp: '/' )
+puts crowi_client.page_id( path_exp: '/' )
 ```
 
 ```ruby
 # Check existence of page by page path (you can use regular expression)
-CrowiClient.instance.page_exist?( path_exp: '/' )
+crowi_client.page_exist?( path_exp: '/' )
 ```
 
 ```ruby
 # Check existence of attachment by file name of attachment
-CrowiClient.instance.attachment_exist?( path_exp: '/', attachment_name: 'LICENSE.txt' )
+crowi_client.attachment_exist?( path_exp: '/', attachment_name: 'LICENSE.txt' )
 ```
 
 ```ruby
 # get attachment's ID
-puts CrowiClient.instance.attachment_id( path_exp: '/', attachment_name: 'LICENSE.txt' )
+puts crowi_client.attachment_id( path_exp: '/', attachment_name: 'LICENSE.txt' )
 ```
 
 ```ruby
 # get attachment (return data is object of CrowiAttachment)
-puts CrowiClient.instance.attachment( path_exp: '/', attachment_name: 'LICENSE.txt' )
+puts crowi_client.attachment( path_exp: '/', attachment_name: 'LICENSE.txt' )
 ```
 
 ```ruby
 # pages list
 req = CPApiRequestPagesList.new path_exp: '/'
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # pages get - path_exp
 req = CPApiRequestPagesList.new path_exp: '/'
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # pages get - page_id
-req = CPApiRequestPagesGet.new page_id: CrowiClient.instance.page_id(path: '/')
-puts CrowiClient.instance.request(req)
+req = CPApiRequestPagesGet.new page_id: crowi_client.page_id(path_exp: '/')
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # pages get - revision_id
 reqtmp = CPApiRequestPagesList.new path_exp: '/'
-ret = CrowiClient.instance.request(reqtmp)
+ret = crowi_client.request(reqtmp)
 path = ret.data[0].path
 revision_id = ret.data[0].revision._id
 req = CPApiRequestPagesGet.new path: path, revision_id: revision_id
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
@@ -98,7 +97,7 @@ test_page_path = '/tmp/crowi-client test page'
 body = "# crowi-client\n"
 req = CPApiRequestPagesCreate.new path: test_page_path,
         body: body
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
@@ -106,74 +105,74 @@ puts CrowiClient.instance.request(req)
 test_page_path = '/tmp/crowi-client test page'
 test_cases = [nil, CrowiPage::GRANT_PUBLIC, CrowiPage::GRANT_RESTRICTED,
               CrowiPage::GRANT_SPECIFIED, CrowiPage::GRANT_OWNER]
-page_id = CrowiClient.instance.page_id(path: test_page_path)
+page_id = crowi_client.page_id(path_exp: test_page_path)
 
 body = "# crowi-client\n"
 test_cases.each do |grant|
   body = body + grant.to_s
   req = CPApiRequestPagesUpdate.new page_id: page_id,
           body: body, grant: grant
-  puts CrowiClient.instance.request(req)
+  puts crowi_client.request(req)
 end
 ```
 
 ```ruby
 # pages seen
-page_id = CrowiClient.instance.page_id(path: '/')
+page_id = crowi_client.page_id(path_exp: '/')
 req = CPApiRequestPagesSeen.new page_id: page_id
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # likes add
 test_page_path = '/tmp/crowi-client test page'
-page_id = CrowiClient.instance.page_id(path: test_page_path)
+page_id = crowi_client.page_id(path_exp: test_page_path)
 req = CPApiRequestLikesAdd.new page_id: page_id
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # likes remove
 test_page_path = '/tmp/crowi-client test page'
-page_id = CrowiClient.instance.page_id(path: test_page_path)
+page_id = crowi_client.page_id(path_exp: test_page_path)
 req = CPApiRequestLikesRemove.new page_id: page_id
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # update post
 test_page_path = '/tmp/crowi-client test page'
 req = CPApiRequestPagesUpdatePost.new path: test_page_path
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 
 ```ruby
 # attachments list
 test_page_path = '/tmp/crowi-client test page'
-page_id = CrowiClient.instance.page_id(path: test_page_path)
+page_id = crowi_client.page_id(path_exp: test_page_path)
 req = CPApiRequestAttachmentsList.new page_id: page_id
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # attachments add
 test_page_path = '/tmp/crowi-client test page'
-page_id = CrowiClient.instance.page_id(path: test_page_path)
+page_id = crowi_client.page_id(path_exp: test_page_path)
 req = CPApiRequestAttachmentsAdd.new page_id: page_id,
                                      file: File.new('LICENSE.txt')
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ```ruby
 # attachments remove
 test_page_path = '/tmp/crowi-client test page'
-page_id = CrowiClient.instance.page_id(path: test_page_path)
+page_id = crowi_client.page_id(path_exp: test_page_path)
 reqtmp = CPApiRequestAttachmentsList.new page_id: page_id
-ret = CrowiClient.instance.request(reqtmp)
+ret = crowi_client.request(reqtmp)
 attachment_id = ret.data[0]._id
 req = CPApiRequestAttachmentsRemove.new attachment_id: attachment_id
-puts CrowiClient.instance.request(req)
+puts crowi_client.request(req)
 ```
 
 ## Development

data/crowi-client.gemspec

@@ -37,5 +37,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rest-client", "~> 2.0"
   spec.add_dependency "json", "~> 2.1"
-  spec.add_dependency "easy_settings", "~> 0.1"
 end

data/lib/crowi/client/client.rb

@@ -1,28 +1,29 @@
-require 'singleton'
 require 'rest-client'
 require 'json'
 require 'yaml'
-require "easy_settings"
+require 'uri'
 
 require 'crowi/client/apireq/api_request_pages'
 require 'crowi/client/apireq/api_request_attachments'
 
 # Crowi のクライアントクラス
 class CrowiClient
-  include Singleton
 
-  # コンストラクタ（シングルトン）
-  def initialize
-    raise ArgumentError, 'Config url is required.'   unless EasySettings['url']
-    raise ArgumentError, 'Config token is required.' unless EasySettings['token']
-    @cp_entry_point = URI.join(EasySettings['url'], '/_api/').to_s
+  # コンストラクタ
+  def initialize(crowi_url: '', access_token: '')
+    raise ArgumentError, 'Config `crowi_url` is required.'    if crowi_url.empty?
+    raise ArgumentError, 'Config `access_token` is required.' if access_token.empty?
+
+    @crowi_url = crowi_url
+    @access_toke = access_token
+    @cp_entry_point = URI.join(crowi_url, '/_api/').to_s
   end
 
   # APIリクエストを送信する
   # @param [ApiRequestBase] req APIリクエスト
   # @return [String] APIリクエストの応答（JSON形式）
   def request(req)
-    req.param[:access_token] = EasySettings['token'] 
+    req.param[:access_token] = @access_toke
     return req.execute URI.join(@cp_entry_point, req.entry_point).to_s
   end
 
@@ -31,7 +32,8 @@ class CrowiClient
   # @return [String] ページID
   def page_id(path_exp: nil)
     ret = request(CPApiRequestPagesList.new path_exp: path_exp)
-    return ret&.data&.find { |p| p.path.match(path_exp) != nil }&.id
+    return nil if (ret.kind_of? CPInvalidRequest || ret.data.nil?)
+    return ret.data.find { |page| URI.unescape(page.path) == path_exp }&.id
   end
 
   # ページが存在するか調べる

data/lib/crowi/client/version.rb

@@ -1,5 +1,5 @@
 module Crowi
   module Client
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowi-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryu Sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: easy_settings
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 description: crowi-client is client of crowi with use API.
 email:
 - ryu@weseek.co.jp
@@ -126,7 +112,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- config/settings.yml
 - crowi-client.gemspec
 - lib/crowi-client.rb
 - lib/crowi/client/apireq/api_request_attachments.rb

data/config/settings.yml

@@ -1,2 +0,0 @@
-url:   http://localhost:3000/
-token: 9MFP98pB81xFI/4EuBzoYgIGZvno5QT3kcgSB3oEuHE=