growi-client 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac56c4422e6572699058511873cfed8cf01f01fc15b688e4aa13bd8a19fb4592
+  data.tar.gz: 0eb97e2e86c0ec4fe870ff56e14fe2cf965d5a6d82314bd53465232412c5b9dc
+SHA512:
+  metadata.gz: ee9245bcda0307298726bda847805cf25b4f02c69e5304f4e7709c2f4142ed52401d118260ebcffeee3a01efb805a51b2da0cbf699e4961f3f607df4f935ee1a
+  data.tar.gz: 74c8108b80b7623f9494d224ada9404bc4671213bee37ad3679fe3689796c18ca50a9ed1a86ca4bc7fd88d4c9d4efc61abb6a004ff150c40883cf55004684835

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# RSpec
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tatsurou313@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in growi-client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 ryu-sato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Ryu Sato <ryu@weseek.co.jp>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,221 @@
+[![wercker status](https://app.wercker.com/status/837aadfe3b9e25cf5aacd36ae2bdc6a4/s/master "wercker status")](https://app.wercker.com/project/byKey/837aadfe3b9e25cf5aacd36ae2bdc6a4)
+
+# growi-client -- client of growi with use API
+
+A client of growi with use API.
+
+## Compatibility
+
+growi-client is passed the test of these Growi versions.
+
+|growi-client|Growi|
+| --- | --- |
+|0.9.0|3.1.12|
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'growi-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install growi-client
+
+## Usage
+
+Export these environments.
+
+```
+export GROWI_ACCESS_TOKEN=0123456789abcdef0123456789abcdef0123456789ab
+export GROWI_URL=http://localhost:3000/
+```
+
+```ruby
+require 'growi-client'
+
+growi_client = GrowiClient.new(growi_url: ENV['GROWI_URL'], access_token: ENV['GROWI_ACCESS_TOKEN'])
+
+p growi_client.page_exist?( path_exp: '/' )
+p growi_client.attachment_exist?( path_exp: '/', attachment_name: 'LICENSE.txt' )
+```
+
+## Examples
+
+```ruby
+# get page's ID
+p growi_client.page_id( path_exp: '/' )
+```
+
+```ruby
+# Check existence of page by page path (you can use regular expression)
+growi_client.page_exist?( path_exp: '/' )
+```
+
+```ruby
+# Check existence of attachment by file name of attachment
+growi_client.attachment_exist?( path_exp: '/', attachment_name: 'LICENSE.txt' )
+```
+
+```ruby
+# get attachment's ID
+p growi_client.attachment_id( path_exp: '/', attachment_name: 'LICENSE.txt' )
+```
+
+```ruby
+# get attachment (return data is object of GrowiAttachment)
+p growi_client.attachment( path_exp: '/', attachment_name: 'LICENSE.txt' )
+```
+
+```ruby
+# pages list
+req = GApiRequestPagesList.new path_exp: '/'
+p growi_client.request(req)
+```
+
+```ruby
+# pages get - path_exp
+req = GApiRequestPagesList.new path_exp: '/'
+p growi_client.request(req)
+```
+
+```ruby
+# pages get - page_id
+req = GApiRequestPagesGet.new page_id: growi_client.page_id(path_exp: '/')
+p growi_client.request(req)
+```
+
+```ruby
+# pages get - revision_id
+reqtmp = GApiRequestPagesList.new path_exp: '/'
+ret = growi_client.request(reqtmp)
+path = ret.data[0].path
+revision_id = ret.data[0].revision._id
+req = GApiRequestPagesGet.new path: path, revision_id: revision_id
+p growi_client.request(req)
+```
+
+```ruby
+# pages create
+test_page_path = '/tmp/growi-client test page'
+body = "# growi-client\n"
+req = GApiRequestPagesCreate.new path: test_page_path,
+        body: body
+p growi_client.request(req)
+```
+
+```ruby
+# pages update
+test_page_path = '/tmp/growi-client test page'
+test_cases = [nil, GrowiPage::GRANT_PUBLIC, GrowiPage::GRANT_RESTRICTED,
+              GrowiPage::GRANT_SPECIFIED, GrowiPage::GRANT_OWNER]
+page_id = growi_client.page_id(path_exp: test_page_path)
+
+body = "# growi-client\n"
+test_cases.each do |grant|
+  body = body + grant.to_s
+  req = GApiRequestPagesUpdate.new page_id: page_id,
+          body: body, grant: grant
+  p growi_client.request(req)
+end
+```
+
+```ruby
+# pages seen
+page_id = growi_client.page_id(path_exp: '/')
+req = GApiRequestPagesSeen.new page_id: page_id
+p growi_client.request(req)
+```
+
+```ruby
+# likes add
+test_page_path = '/tmp/growi-client test page'
+page_id = growi_client.page_id(path_exp: test_page_path)
+req = GApiRequestLikesAdd.new page_id: page_id
+p growi_client.request(req)
+```
+
+```ruby
+# likes remove
+test_page_path = '/tmp/growi-client test page'
+page_id = growi_client.page_id(path_exp: test_page_path)
+req = GApiRequestLikesRemove.new page_id: page_id
+p growi_client.request(req)
+```
+
+```ruby
+# update post
+test_page_path = '/tmp/growi-client test page'
+req = GApiRequestPagesUpdatePost.new path: test_page_path
+p growi_client.request(req)
+```
+
+
+```ruby
+# attachments list
+test_page_path = '/tmp/growi-client test page'
+page_id = growi_client.page_id(path_exp: test_page_path)
+req = GApiRequestAttachmentsList.new page_id: page_id
+p growi_client.request(req)
+```
+
+```ruby
+# attachments add
+test_page_path = '/tmp/growi-client test page'
+page_id = growi_client.page_id(path_exp: test_page_path)
+req = GApiRequestAttachmentsAdd.new page_id: page_id,
+                                     file: File.new('LICENSE.txt')
+p growi_client.request(req)
+```
+
+```ruby
+# attachments remove
+test_page_path = '/tmp/growi-client test page'
+page_id = growi_client.page_id(path_exp: test_page_path)
+reqtmp = GApiRequestAttachmentsList.new page_id: page_id
+ret = growi_client.request(reqtmp)
+attachment_id = ret.data[0]._id
+req = GApiRequestAttachmentsRemove.new attachment_id: attachment_id
+p growi_client.request(req)
+```
+
+### Basic Authentication
+
+```ruby
+require 'growi-client'
+
+# Create growiclient instance with username and password that is used by basic authentication
+growi_client = GrowiClient.new(growi_url: ENV['GROWI_URL'], access_token: ENV['GROWI_ACCESS_TOKEN'],
+                               rest_client_param: { user: 'who', password: 'bar'})
+
+# Check existence of page
+p growi_client.page_exist?( path_exp: '/' ) ? '/ exist' : '/ not exist'
+
+# Create page whose path is '/tmp'
+req = GApiRequestPagesCreate.new path: '/tmp', body: 'tmp'
+p growi_client.request(req)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryu-sato/growi-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Growi::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryu-satgrowiwi-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "growi-client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here