kintone-oauth-extension 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee744c1f9e1ef957970753bbb6fde98153b504e05e912d32d82172c6f7b59f89
+  data.tar.gz: a437f27dbd27d4aad95e5e6019f3f78ad959d414e6aea5bcbdf9a9ec495d3604
+SHA512:
+  metadata.gz: 603cc2cb7d028e0ad6452b0d57c8b4bd18ff539d190281d1060a5fa76b5782c56c2288fe6eab6376c0e7db9b4c91fe01a7f44e90302dd827c50630b95b90dd0e
+  data.tar.gz: 9529b5198422902acf0f79f9ac5c480a918b0f675fe841fc2c2be49222e78ad4d1d1bd7a0d4bbdd46ce99a73d393e29dca9934316c67cb1562657db583e09288

data/.github/workflows/gem-push.yml

@@ -0,0 +1,37 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Build and test
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rspec
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        continue-on-error: true
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on: pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Build and test
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rspec
+        env:
+          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/
+sample/
+.ruby-version
+.rbenv-gemsets

data/.rspec

@@ -0,0 +1 @@
+-c -f doc

data/.rubocop.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-07-24 11:44:58 +0900 using RuboCop version 0.24.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+AllCops:
+  Exclude:
+    - "Guardfile"
+    - "vendor/**/*"
+
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 1_00
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/WordArray:
+  Exclude:
+    - "spec/**/**"
+
+Style/AsciiComments:
+  Enabled: false
+
+CyclomaticComplexity:
+  Max: 10
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SymbolProc:
+  Exclude:
+    - "lib/kintone/query.rb"
+
+Style/SignalException:
+  EnforcedStyle: only_raise

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# CHANGELOG
+
+## 0.2.1 (2020-09-18)
+
+rename gem to `kintone-oauth-extension`.
+
+## 0.2.0 (2020-09-14)
+
+Initial release of koshilife-kintone
+
+- support OAuth authentication.
+- update gems.
+- required_ruby_version is set to 2.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 koshikawa2009@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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kenji Koshikawa
+
+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,374 @@
+# kintone
+
+[![Test](https://github.com/koshilife/kintone/workflows/Test/badge.svg)](https://github.com/koshilife/kintone/actions?query=workflow%3ATest)
+[![codecov](https://codecov.io/gh/koshilife/kintone/branch/master/graph/badge.svg)](https://codecov.io/gh/koshilife/kintone)
+[![Gem Version](https://badge.fury.io/rb/kintone.svg)](http://badge.fury.io/rb/kintone-oauth-extension)
+[![license](https://img.shields.io/github/license/koshilife/kintone)](https://github.com/koshilife/kintone/blob/master/LICENSE.txt)
+
+A Ruby gem for communicating with the [kintone](https://kintone.cybozu.com/us/) REST API
+
+## Requirements
+
+- ruby 2.4.0 or later
+
+## Installation
+
+    gem install kintone-oauth-extension
+
+or execute `bundle install` command after you insert the following into Gemfile
+
+    gem 'kintone-oauth-extension'
+
+## Usage
+
+```ruby
+require 'kintone'
+
+# Use password authentication
+api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
+
+# Use token authentication
+api = Kintone::Api.new("example.cybozu.com", "authtoken")
+
+# Use OAuth authentication
+api = Kintone::OAuthApi.new("example.cybozu.com", "access_token")
+# if set oauth options below, you can refresh the access_token.
+oauth_options = {
+  client_id: 'client_id',
+  client_secret: 'client_secret',
+  refresh_token: 'refresh_token',
+  expires_at: 1599921045
+}
+api = Kintone::OAuthApi.new("example.cybozu.com", "access_token", oauth_options)
+# get new token.
+api.refresh!
+api.access_token.token
+# => "new_access_token"
+```
+
+### Supported API
+
+- [Record retrieval](#record_retrieval)
+- [Record register](#record_register)
+- [Record update](#record_update)
+- [Record delete](#record_delete)
+- [Bulk request](#bulk_request)
+- [File](#file)
+- [Permissions](#permissions)
+- [Space management](#space_management)
+- [Guests](#guests)
+- [Application information](#application_information)
+- [Form structure](#form_structure)
+- [API information](#api_information)
+
+### <a name="record_retrieval"> Record retrieval
+
+```ruby
+# Record retrieval(Assign by Record Number)
+app = 8; id = 100
+api.record.get(app, id) # => {"record" => {"record_id" => {"type" => "RECORD_NUMBER", "value" => "1"}}}
+
+# Records retrieval(Assign by Conditions by Query Strings)
+app = 8; fields = ["record_id", "created_time", "dropdown"]
+query = "updated_time > \"2012-02-03T09:00:00+0900\" and updated_time < \"2012-02-03T10:00:00+0900\" order by record_id asc limit 10 offset 20"
+api.records.get(app, query, fields) # => {"records" => [{...}, ...]}
+```
+
+Query helper
+
+```ruby
+query =
+  Kintone::Query.new do
+    field(:updated_time) > "2012-02-03T09:00:00+0900"
+    and!
+    field(:updated_time) < "2012-02-03T10:00:00+0900"
+    order_by(:record_id)
+    limit(10)
+    offset(20)
+  end
+# or
+query =
+  Kintone::Query.new do
+    f(:updated_time) > "2012-02-03T09:00:00+0900"
+    and!
+    f(:updated_time) < "2012-02-03T10:00:00+0900"
+    order_by(:record_id)
+    limit(10)
+    offset(20)
+  end
+query.to_s # => "updated_time > \"2012-02-03T09:00:00+0900\" and updated_time < \"2012-02-03T10:00:00+0900\" order by record_id asc limit 10 offset 20"
+api.records.get(app, query, fields)
+
+# Example
+Kintone::Query.new do
+  field(:Created_datetime) >= last_month
+  and!
+  precede do
+    field(:text).like("Hello")
+    and!
+    field(:number) == 200
+  end
+  or!
+  precede do
+    field(:number) > 100
+    and!
+    field(:Created_by).in([login_user])
+  end
+  order_by(:record_id, :desc)
+  limit(10)
+  offset(20)
+end
+# => "Created_datetime >= LAST_MONTH() and (text like \"Hello\" and number = 200) or (number > 100 and Created_by in (LOGINUSER())) order by record_id desc limit 10 offset 20"
+```
+
+| operator symbol | query helper                    |
+| --------------- | ------------------------------- |
+| =               | field(:code) == other           |
+| !=              | field(:code) != other           |
+| &gt;            | field(:code) > other            |
+| <               | field(:code) < other            |
+| &gt;=           | field(:code) >= other           |
+| <=              | field(:code) <= other           |
+| in              | field(:code).in(["A", "B"])     |
+| not in          | field(:code).not_in(["A", "B"]) |
+| like            | field(:code).like("Hello")      |
+| not like        | field(:code).not_like("Hello")  |
+| and             | and!                            |
+| or              | or!                             |
+| ()              | precede do; end                 |
+
+| function               | query helper         |
+| ---------------------- | -------------------- |
+| LOGINUSER()            | login_user           |
+| PRIMARY_ORGANIZATION() | primary_organization |
+| NOW()                  | now                  |
+| TODAY()                | today                |
+| THIS_MONTH()           | this_month           |
+| LAST_MONTH()           | last_month           |
+| THIS_YEAR()            | this_year            |
+
+| option   | query helper                   |
+| -------- | ------------------------------ |
+| order by | order_by(:code, :asc or :desc) |
+| limit    | limit(20)                      |
+| offset   | offset(30)                     |
+
+### <a name="record_register"> Record register
+
+```ruby
+# Record register(single record)
+# Use Hash
+app = 7
+record = {"number" => {"value" => "123456"}}
+api.record.register(app, record) # => {"id" => "100", "revision" => "1"}
+
+# Use Kintone::Type::Record
+app = 7
+record = Kintone::Type::Record.new(number: "123456")
+api.record.register(app, record) # => {"id" => "100", "revision" => "1"}
+
+# Records register(batch)
+# Use Hash
+app = 7
+records = [
+  {"number" => {"value" => "123456"}},
+  {"number" => {"value" => "7890"}}
+]
+api.records.register(app, records) # => {"ids" => ["100", "101"], "revisions" => ["1", "1"]}
+
+# Use Kintone::Type::Record
+app = 7
+records = [
+  Kintone::Type::Record.new(number: "123456"),
+  Kintone::Type::Record.new(number: "7890")
+]
+api.records.register(app, records) # => {"ids" => ["100", "101"], "revisions" => ["1", "1"]}
+```
+
+### <a name="record_update"> Record update
+
+```ruby
+# Record update(single record)
+# Use Hash
+app = 4; id = 1
+record = {"string_multi" => {"value" => "changed!"}}
+api.record.update(app, id, record) # => {"revision" => "2"}
+
+# Use Kintone::Type::Record
+app = 4; id = 1
+record = Kintone::Type::Record.new({string_multi: "changed!"})
+api.record.update(app, id, record) # => {"revision" => "2"}
+
+# With revision
+api.record.update(app, id, record, revision: 1)
+
+# Records update(batch)
+# Use Hash
+app = 4
+records = [
+  {"id" => 1, "record" => {"string_multi" => {"value" => "abcdef"}}},
+  {"id" => 2, "record" => {"string_multi" => {"value" => "opqrstu"}}}
+]
+api.records.update(app, records) # => {"records" => [{"id" => "1", "revision" => "2"}, {"id" => "2", "revision" => "2"}]}
+
+# Use Kintone::Type::Record
+app = 4
+records = [
+  {id: 1, record: Kintone::Type::Record.new(string_multi: "abcdef")},
+  {id: 2, record: Kintone::Type::Record.new(string_multi: "opqrstu")}
+]
+api.records.update(app, records) # => {"records" => [{"id" => "1", "revision" => "2"}, {"id" => "2", "revision" => "2"}]}
+
+# with revision
+records = [
+  {id: 1, revision: 1, record: Kintone::Type::Record.new(string_multi: "abcdef")},
+  {id: 2, revision: 1, record: Kintone::Type::Record.new(string_multi: "opqrstu")}
+]
+api.records.update(app, records)
+```
+
+### <a name="record_delete"> Record delete
+
+```ruby
+app = 8; ids = [100, 80]
+api.records.delete(app, ids) # => {}
+
+# With revision
+revisions = [1, 1]
+api.records.delete(app, ids, revisions: revisions)
+```
+
+### <a name="bulk_request"> Bulk request
+
+```ruby
+requests = [{"method" => "POST", ...}, {"method" => "PUT", ...}]
+api.bulk.request(requests) # => [...]
+```
+
+### <a name="file"> File
+
+```ruby
+# File upload
+file_key = api.file.register("/path/to/file", "text/plain", "file.txt")
+
+# File download
+file = api.file.get(file_key)
+```
+
+### <a name="permissions"> Permissions
+
+```ruby
+# App
+app = 1
+rights = [{"entity" => {"type" => "USER", "code" => "user1"}, "appEditable" => true, ...}, ...]
+api.app_acl.update(app, rights) # => {}
+
+# Records
+id = 1
+rights = [{"filterCond" => "...", "entities" => [{"entity" => {...}, "viewable" => false, ...}, ...]}, ...]
+api.record_acl.update(id, rights) # => {}
+
+#Fields
+id = 1
+rights = [{"code" => "Single_line_text_0", "entities" => [{"entity" => {...}, "accesibility" => "WRITE"}, ...]}, ...]
+api.field_acl.update(id, rights) # => {}
+```
+
+### <a name="space_management"> Space management
+
+```ruby
+# Space information
+id = 1
+api.space.get(id) # => { "id" => "1", "name" => "space", "defaultThread" => "3", "isPrivate" => true, ...}
+
+# Create space
+id = 1; name = "sample space"
+members = [{"entity" => {"type" => "USER", "code" => "user1"}, "isAdmin": true}, ...]
+api.template_space.create(id, name, members, is_guest: true, fixed_member: false) # => {"id" => "1"}
+
+# Space body update
+id = 1; body = "<b>awesome space!</b>"
+api.space_body.update(id, body) # => {}
+
+# Space members
+id = 1
+members = api.space_members.get(id) # => {"members"=>[{"entity"=>{"type"=>"USER", "code"=> "user1"}, ...}, ...]}
+members << {"entity" => {"type" => "GROUP", "code" => "group1"}}
+members = api.space_members.update(id, members) # => {}
+
+# Space thread update
+id = 1; name = "thread name"
+body = "<b>awesome thread!</b>"
+api.space_thread.update(id, name: name, body: body) # => {}
+
+# Space guests
+id = 1
+guests = ["hoge@example.com"]
+api.guest(1).space_guests.update(id, guests) # => {}
+
+# Space delete
+id = 1
+api.space.delete(id) # => {}
+```
+
+### <a name="guests"> Guests
+
+```ruby
+# Add guest
+guests = [{code: "hoge@example.com", password: "p@ssword", timezone: "Asia/Tokyo", name: "Tokyo, Saburo", ...}, ...]
+api.guests.register(guests) # => {}
+
+# delete guest
+guests = ["hoge@example.com", "fuga@example.com"]
+api.guests.delete(guests) # => {}
+```
+
+### <a name="application_information"> Application information
+
+```ruby
+id = 4
+api.app.get(id) # => {"appId" => "4", "code" => "", ...}
+
+name = "test"; codes = ["FOO", "BAR"]
+api.apps.get({ name: name, codes: codes }) # => { "apps" => [{...}, ...] }
+```
+
+### <a name="form_structure"> Form structure
+
+```ruby
+app = 1
+api.form.get(app) # => {"properties" => [{...}, ...]}
+
+api.preview_form.get(app) # => {"properties" => [{...}, ...]}
+```
+
+### <a name="api_information"> API information
+
+```ruby
+api.apis.get # => {"baseUrl" => "https://example.cybozu.com/k/v1/", "apis" => {"records/get" => {"link" => "apis/records/get.json"}}}
+
+api.apis.get_details_of("apis/records/get.json") # => {"id" => "GetRecords", "baseUrl" => "https://example.cybozu.com/k/v1/", ...}
+
+api.apis.get_details_of_key("records/get") # => {"id" => "GetRecords", "baseUrl" => "https://example.cybozu.com/k/v1/", ...}
+```
+
+### Other examples
+
+```ruby
+# Format retrieval
+url = api.get_url("form")
+api.get(url, {"app" => 4}) # => {"properties" => [{...}, ...]}
+
+# Batch record register
+url = api.get_url("records")
+body = {"app" => 7, "records" => [{...}, ...]}
+api.post(url, body) # => {"ids" => ["100","101"]}
+```
+
+### Access to guest spaces
+
+```ruby
+api.guest(1).record.get(8, 100)
+```
+
+see also [kintone developers](http://developers.kintone.com/)