kintone_rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b8182c7791ee8596bf2bd0317ef11308369ed1f88e0958e8efc3bacecf20de3
+  data.tar.gz: 1f9add3df139ff19c6cc5a967994be3592a38d4a088829b1bcd34f8d0f065be4
+SHA512:
+  metadata.gz: 7c07ecaba30e8038b956705bca54a4a6a33ab260ca2c3af720891d238eb4f68a5980fd6e492797c197773871230346ba95b89279fad43ac521d0f716766e9a1d
+  data.tar.gz: 502112ccc0c9e772e8827541939afbf87a30c5c3393be264b1f2492a34345ee64828ac14dfc293d1b35b14702de1325a0ff92c09cb8ab421e44c60aca14a548a

data/.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "daily"

data/.github/workflows/rspec.yml

@@ -0,0 +1,28 @@
+name: Build
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1"]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run rspec
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,20 @@
+*.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/
+.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/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 1.0.0
+
+- Drop support faraday v1
+- Rename gem

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,22 @@
+Copyright (c) 2014 Rikiya Kawakami
+
+MIT License
+
+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,361 @@
+# kintone_rb
+
+A Ruby gem for communicating with the [kintone](https://kintone.cybozu.com/us/) REST API
+
+forked from [jue58/kintone](https://github.com/jue58/kintone)
+
+## Requirements
+
+- ruby 2.7.0 or later
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kintone_rb', github: 'SonicGarden/kintone_rb'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+```ruby
+require 'kintone_rb'
+
+# Use password authentication
+api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
+
+# Use token authentication
+api = Kintone::Api.new("example.cybozu.com", "authtoken")
+```
+
+### 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/)

data/Rakefile

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

data/kintone.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kintone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kintone_rb'
+  spec.version       = Kintone::VERSION
+  spec.authors       = ['aki77']
+  spec.email         = ['akira@sonicgarden.jp']
+  spec.summary       = 'kintone API client for Ruby.'
+  spec.description   = 'kintone API client for Ruby.'
+  spec.homepage      = 'https://github.com/SonicGarden/kintone_rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '>=2.0.0'
+  spec.add_runtime_dependency 'faraday-multipart'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop', '~> 0.44.1'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'rspec-parameterized', '~> 0.1.2'
+end

data/lib/kintone/api/guest.rb

@@ -0,0 +1,44 @@
+require 'forwardable'
+require 'kintone/api'
+require 'kintone/command/accessor'
+
+class Kintone::Api
+  class Guest
+    extend Forwardable
+
+    GUEST_PATH = '/k/guest/%s/v1/'.freeze
+    ACCESSIBLE_COMMAND = [
+      :record, :records, :form, :app_acl, :record_acl,
+      :field_acl, :space, :space_body, :space_thread, :space_members,
+      :space_guests, :app, :apps, :bulk_request, :bulk,
+      :file, :preview_form
+    ].freeze
+
+    def_delegators :@api, :get, :post, :put, :delete, :post_file
+
+    def initialize(space_id, api)
+      @api = api
+      @guest_path = GUEST_PATH % space_id.to_i
+    end
+
+    def get_url(command)
+      @guest_path + (COMMAND % command)
+    end
+
+    def method_missing(name, *args)
+      if ACCESSIBLE_COMMAND.include?(name)
+        CommandAccessor.send(name, self)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, *args)
+      ACCESSIBLE_COMMAND.include?(name) || super
+    end
+
+    class CommandAccessor
+      extend Kintone::Command::Accessor
+    end
+  end
+end