crowi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14e413c7b6aa907b809be9b937745095e0c8800e
+  data.tar.gz: 6870d99a37c309fee81df97be25932db0a1f084c
+SHA512:
+  metadata.gz: 35b28fb2b0eaaab3b9a7478f6c56bd44de01f11286eb99edb7ead5a52230213f5acafc1f39af60efc2fba9532ee09365b766cff49ecfe6936d947b88feaaddab
+  data.tar.gz: 43fd831015ff777d6e1cdf95c5ddf0671215a6d8664fc72ecf6e39cff6596964bd6a9bbab5f984a7cc076eca69377b973c9b8e3f6bc9278ab1b3bb39293c48db

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crowi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hiromichi Kishi
+
+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,59 @@
+# ruby-crowi
+
+A ruby client for [Crowi](http://site.crowi.wiki/) API.
+
+ruby-crowi supports up to [v1.6.2](https://github.com/crowi/crowi/releases/tag/v1.6.2).
+
+**Crowi API is experimental.**
+
+## Installation
+
+```ruby
+gem 'crowi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crowi
+
+## Usage
+
+```ruby
+require "crowi"
+
+client = Crowi::Client.new(base_url: "<your_crowi_url>", access_token: "<access_token>")
+
+# Pages API
+client.page(page_id)
+client.pages(path, user, offset)
+client.create_page(path, body)
+client.update_page(page_id, body)
+
+# Comments API
+client.comments(page_id)
+client.add_comment(page_id, comment, revision_id)
+
+# Attachments API
+client.attachments(page_id)
+client.add_attachment(page_id, filepath, content_type)
+```
+
+## 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/h-kishi/ruby-crowi.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "crowi"
+
+# 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

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

data/crowi.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crowi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crowi"
+  spec.version       = Crowi::VERSION
+  spec.authors       = ["Hiromichi Kishi"]
+  spec.email         = ["h.kishi47@gmail.com"]
+
+  spec.summary       = %q{A ruby client for Crowi API}
+  spec.description   = %q{A ruby client for Crowi API}
+  spec.homepage      = "https://github.com/h-kishi/ruby-crowi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday", "~> 0.9"
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+end

data/examples/crowi_example.rb

@@ -0,0 +1,31 @@
+require 'crowi'
+
+crowi = Crowi::Client.new(base_url: "<your crowi url>", access_token: "<your access token>")
+
+# Create page
+page = crowi.create_page('/sandbox/test', 'new page').body['page']
+puts page
+
+page_id = page['_id']
+revision_id = page['revision']['_id']
+
+# Get page
+puts crowi.page('/sandbox/test').body['page']
+
+# Get pages
+puts crowi.pages('/sandbox/').body['pages']
+
+# Update page
+crowi.update_page(page_id, 'updated page')
+
+# Add comment
+crowi.add_comment(page_id, 'new comment', revision_id)
+
+# Get comments
+puts crowi.comments(page_id).body['comments']
+
+# Add attachment
+crowi.add_attachment(page_id, '/Users/kishi/Downloads/unity.png', 'image/png')
+
+# Get attachments
+puts crowi.attachments(page_id).body['attachments']

data/lib/crowi.rb

@@ -0,0 +1,7 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'crowi/version'
+require 'crowi/client'
+require 'crowi/response'
+require 'crowi/api_methods'

data/lib/crowi/api_methods.rb

@@ -0,0 +1,44 @@
+module Crowi
+  module ApiMethods
+    def page(path)
+      get('/_api/pages.get', { path: path })
+    end
+
+    def pages(path = nil, user = nil, offset = 0)
+      raise 'path or user is required' unless path || user
+      get('/_api/pages.list', { path: path, user: user, offset: offset })
+    end
+
+    def create_page(path, body)
+      post('/_api/pages.create', { path: path, body: body })
+    end
+
+    def update_page(page_id, body)
+      post('/_api/pages.update', { page_id: page_id, body: body })
+    end
+
+    def comments(page_id)
+      get('/_api/comments.get', { page_id: page_id })
+    end
+
+    def add_comment(page_id, comment, revision_id)
+      post('/_api/comments.add', { commentForm: {  page_id: page_id, comment: comment, revision_id: revision_id } })
+    end
+
+    def attachments(page_id)
+      get('/_api/attachments.list', { page_id: page_id })
+    end
+
+    def add_attachment(page_id, filename, content_type)
+      # To use multipart/form-data use faraday directly
+      connection = Faraday.new(faraday_options) do |connection|
+        connection.request :multipart
+        connection.request :url_encoded
+        connection.adapter :net_http
+      end
+
+      params = { page_id: page_id, file: Faraday::UploadIO.new(filename, content_type), access_token: @access_token }
+      Crowi::Response.new(connection.send(:post, '/_api/attachments.add', params))
+    end
+  end
+end

data/lib/crowi/client.rb

@@ -0,0 +1,62 @@
+require 'crowi/api_methods'
+require 'crowi/version'
+
+module Crowi
+  class Client
+    include Crowi::ApiMethods
+
+    def initialize(base_url: nil, access_token: nil)
+      @base_url = base_url
+      @access_token = access_token
+    end
+
+    def get(path, params = nil, headers = nil)
+      send_request(:get, path, params, headers)
+    end
+
+    def post(path, params = nil, headers = nil)
+      send_request(:post, path, params, headers)
+    end
+
+    def put(path, params = nil, headers = nil)
+      send_request(:put, path, params, headers)
+    end
+
+    def patch(path, params = nil, headers = nil)
+      send_request(:patch, path, params, headers)
+    end
+
+    def delete(path, params = nil, headers = nil)
+      send_request(:delete, path, params, headers)
+    end
+
+    def send_request(method, path, params = {}, headers = nil)
+      # TODO Crowi does not support Authorization: Bearer
+      params[:access_token] = @access_token
+      Crowi::Response.new(connection.send(method, path, params, headers))
+    end
+
+    private
+      def connection
+        @connection ||= Faraday.new(faraday_options) do |connection|
+           connection.request :json
+           connection.response :json
+           connection.adapter Faraday.default_adapter
+        end
+      end
+
+      def faraday_options
+        {
+           url: @base_url,
+           headers: headers
+        }
+      end
+
+      def headers
+        {
+          'Accept' => 'application/json',
+          'User-Agent' => "Crowi Ruby Gem #{Crowi::VERSION}"
+        }
+      end
+  end
+end

data/lib/crowi/response.rb

@@ -0,0 +1,23 @@
+module Crowi
+  class Response
+    def initialize(faraday_response)
+      @raw_body = faraday_response.body
+      @raw_headers = faraday_response.headers
+      @raw_status = faraday_response.status
+    end
+
+    def body
+      @raw_body
+    end
+
+    def headers
+      @headers ||= @raw_headers.inject({}) do |result, (key, value)|
+        result.merge(key.split("-").map(&:capitalize).join("-") => value)
+      end
+    end
+
+    def status
+      @raw_status
+    end
+  end
+end

data/lib/crowi/version.rb

@@ -0,0 +1,3 @@
+module Crowi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: crowi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiromichi Kishi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby client for Crowi API
+email:
+- h.kishi47@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crowi.gemspec
+- examples/crowi_example.rb
+- lib/crowi.rb
+- lib/crowi/api_methods.rb
+- lib/crowi/client.rb
+- lib/crowi/response.rb
+- lib/crowi/version.rb
+homepage: https://github.com/h-kishi/ruby-crowi
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby client for Crowi API
+test_files: []