kintone_rb 1.0.0

data/lib/kintone/api.rb

@@ -0,0 +1,121 @@
+require 'faraday'
+require 'faraday/multipart'
+require 'base64'
+require 'json'
+require 'kintone/command/accessor'
+require 'kintone/api/guest'
+require 'kintone/query'
+require 'kintone/kintone_error'
+
+class Kintone::Api
+  BASE_PATH = '/k/v1/'.freeze
+  COMMAND = '%s.json'.freeze
+  ACCESSIBLE_COMMAND = [
+    :record, :records, :form, :app_acl, :record_acl,
+    :field_acl, :template_space, :space, :space_body, :space_thread,
+    :space_members, :guests, :app, :apps, :apis,
+    :bulk_request, :bulk, :file, :preview_form
+  ].freeze
+
+  def initialize(domain, user, password = nil)
+    @connection =
+      Faraday.new(url: "https://#{domain}", headers: build_headers(user, password)) do |builder|
+        builder.request :url_encoded
+        builder.request :multipart
+        builder.response :json, content_type: /\bjson$/
+        builder.adapter :net_http
+      end
+
+    yield(@connection) if block_given?
+  end
+
+  def get_url(command)
+    BASE_PATH + (COMMAND % command)
+  end
+
+  def guest(space_id)
+    Kintone::Api::Guest.new(space_id, self)
+  end
+
+  def get(url, params = {})
+    response =
+      @connection.get do |request|
+        request.url url
+        # NOTE: Request URI Too Large 対策
+        request.headers['Content-Type'] = 'application/json'
+        request.body = params.to_h.to_json
+      end
+    raise Kintone::KintoneError.new(response.body, response.status) if response.status != 200
+    response.body
+  end
+
+  def post(url, body)
+    response =
+      @connection.post do |request|
+        request.url url
+        request.headers['Content-Type'] = 'application/json'
+        request.body = body.to_json
+      end
+    raise Kintone::KintoneError.new(response.body, response.status) if response.status != 200
+    response.body
+  end
+
+  def put(url, body)
+    response =
+      @connection.put do |request|
+        request.url url
+        request.headers['Content-Type'] = 'application/json'
+        request.body = body.to_json
+      end
+    raise Kintone::KintoneError.new(response.body, response.status) if response.status != 200
+    response.body
+  end
+
+  def delete(url, body = nil)
+    response =
+      @connection.delete do |request|
+        request.url url
+        request.headers['Content-Type'] = 'application/json'
+        request.body = body.to_json
+      end
+    raise Kintone::KintoneError.new(response.body, response.status) if response.status != 200
+    response.body
+  end
+
+  def post_file(url, path, content_type, original_filename)
+    response =
+      @connection.post do |request|
+        request.url url
+        request.headers['Content-Type'] = 'multipart/form-data'
+        request.body = { file: Faraday::UploadIO.new(path, content_type, original_filename) }
+      end
+    raise Kintone::KintoneError.new(response.body, response.status) if response.status != 200
+    response.body['fileKey']
+  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
+
+  private
+
+  def build_headers(user, password)
+    if password # パスワード認証
+      { 'X-Cybozu-Authorization' => Base64.strict_encode64("#{user}:#{password}") }
+    else # APIトークン認証
+      { 'X-Cybozu-API-Token' => user }
+    end
+  end
+end

data/lib/kintone/command/accessor.rb

@@ -0,0 +1,109 @@
+class Kintone::Command
+  # common
+  autoload :Record, 'kintone/command/record'
+  autoload :Records, 'kintone/command/records'
+  autoload :BulkRequest, 'kintone/command/bulk_request'
+  autoload :Form, 'kintone/command/form'
+  autoload :PreviewForm, 'kintone/command/preview_form'
+  autoload :App, 'kintone/command/app'
+  autoload :Apps, 'kintone/command/apps'
+  autoload :AppAcl, 'kintone/command/app_acl'
+  autoload :RecordAcl, 'kintone/command/record_acl'
+  autoload :FieldAcl, 'kintone/command/field_acl'
+  autoload :Space, 'kintone/command/space'
+  autoload :SpaceBody, 'kintone/command/space_body'
+  autoload :SpaceThread, 'kintone/command/space_thread'
+  autoload :SpaceMembers, 'kintone/command/space_members'
+  autoload :File, 'kintone/command/file'
+
+  # other than guest
+  autoload :TemplateSpace, 'kintone/command/template_space'
+  autoload :Guests, 'kintone/command/guests'
+  autoload :Apis, 'kintone/command/apis'
+
+  # guest only
+  autoload :SpaceGuests, 'kintone/command/space_guests'
+
+  module Accessor
+    # common
+    def record(api)
+      Record.new(api)
+    end
+
+    def records(api)
+      Records.new(api)
+    end
+
+    def bulk_request(api)
+      BulkRequest.new(api)
+    end
+
+    def form(api)
+      Form.new(api)
+    end
+
+    def preview_form(api)
+      PreviewForm.new(api)
+    end
+
+    def app(api)
+      App.new(api)
+    end
+
+    def apps(api)
+      Apps.new(api)
+    end
+
+    def app_acl(api)
+      AppAcl.new(api)
+    end
+
+    def record_acl(api)
+      RecordAcl.new(api)
+    end
+
+    def field_acl(api)
+      FieldAcl.new(api)
+    end
+
+    def space(api)
+      Space.new(api)
+    end
+
+    def space_body(api)
+      SpaceBody.new(api)
+    end
+
+    def space_thread(api)
+      SpaceThread.new(api)
+    end
+
+    def space_members(api)
+      SpaceMembers.new(api)
+    end
+
+    def file(api)
+      File.new(api)
+    end
+
+    # other than guest
+    def template_space(api)
+      TemplateSpace.new(api)
+    end
+
+    def guests(api)
+      Guests.new(api)
+    end
+
+    def apis(api)
+      Apis.new(api)
+    end
+
+    # guest only
+    def space_guests(api)
+      SpaceGuests.new(api)
+    end
+
+    alias bulk bulk_request
+  end
+end

data/lib/kintone/command/apis.rb

@@ -0,0 +1,22 @@
+require 'kintone/command'
+
+class Kintone::Command::Apis < Kintone::Command
+  def self.path
+    'apis'
+  end
+
+  def get
+    @api.get(@url)
+  end
+
+  def get_details_of(link)
+    url = Kintone::Api::BASE_PATH + link
+    @api.get(url)
+  end
+
+  def get_details_of_key(key)
+    response = get
+    link = response['apis'][key]['link']
+    get_details_of(link)
+  end
+end

data/lib/kintone/command/app.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::App < Kintone::Command
+  def self.path
+    'app'
+  end
+
+  def get(id)
+    @api.get(@url, id: id)
+  end
+end

data/lib/kintone/command/app_acl.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::AppAcl < Kintone::Command
+  def self.path
+    'app/acl'
+  end
+
+  def update(app, rights)
+    @api.put(@url, app: app, rights: rights)
+  end
+end

data/lib/kintone/command/apps.rb

@@ -0,0 +1,12 @@
+require 'kintone/command'
+
+class Kintone::Command::Apps < Kintone::Command
+  def self.path
+    'apps'
+  end
+
+  def get(params = {})
+    response = @api.get(@url, params)
+    response['apps']
+  end
+end

data/lib/kintone/command/bulk_request.rb

@@ -0,0 +1,12 @@
+require 'kintone/command'
+
+class Kintone::Command::BulkRequest < Kintone::Command
+  def self.path
+    'bulkRequest'
+  end
+
+  def request(requests)
+    response = @api.post(@url, requests: requests)
+    response['results']
+  end
+end

data/lib/kintone/command/field_acl.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::FieldAcl < Kintone::Command
+  def self.path
+    'field/acl'
+  end
+
+  def update(id, rights)
+    @api.put(@url, id: id, rights: rights)
+  end
+end

data/lib/kintone/command/file.rb

@@ -0,0 +1,15 @@
+require 'kintone/command'
+
+class Kintone::Command::File < Kintone::Command
+  def self.path
+    'file'
+  end
+
+  def get(file_key)
+    @api.get(@url, fileKey: file_key)
+  end
+
+  def register(path, content_type, original_filename)
+    @api.post_file(@url, path, content_type, original_filename)
+  end
+end

data/lib/kintone/command/form.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::Form < Kintone::Command
+  def self.path
+    'form'
+  end
+
+  def get(app)
+    @api.get(@url, app: app)
+  end
+end

data/lib/kintone/command/guests.rb

@@ -0,0 +1,17 @@
+require 'kintone/command'
+
+class Kintone::Command::Guests < Kintone::Command
+  def self.path
+    'guests'
+  end
+
+  def register(guests)
+    @api.post(@url, guests: guests)
+  end
+
+  def delete(guests)
+    @api.delete(@url, guests: guests)
+  end
+
+  alias create register
+end

data/lib/kintone/command/preview_form.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::PreviewForm < Kintone::Command
+  def self.path
+    'preview/form'
+  end
+
+  def get(app)
+    @api.get(@url, app: app)
+  end
+end

data/lib/kintone/command/record.rb

@@ -0,0 +1,23 @@
+require 'kintone/command'
+
+class Kintone::Command::Record < Kintone::Command
+  def self.path
+    'record'
+  end
+
+  def get(app, id)
+    @api.get(@url, app: app, id: id)
+  end
+
+  def register(app, record)
+    @api.post(@url, app: app, record: record.to_kintone)
+  end
+
+  def update(app, id, record, revision: nil)
+    body = { app: app, id: id, record: record.to_kintone }
+    body[:revision] = revision if revision
+    @api.put(@url, body)
+  end
+
+  alias create register
+end

data/lib/kintone/command/record_acl.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::RecordAcl < Kintone::Command
+  def self.path
+    'record/acl'
+  end
+
+  def update(id, rights)
+    @api.put(@url, id: id, rights: rights)
+  end
+end

data/lib/kintone/command/records.rb

@@ -0,0 +1,29 @@
+require 'kintone/command'
+
+class Kintone::Command::Records < Kintone::Command
+  def self.path
+    'records'
+  end
+
+  def get(app, query, fields, total_count: false)
+    params = { app: app, query: query.to_s, totalCount: total_count }
+    params[:fields] = fields unless fields.nil?
+    @api.get(@url, params)
+  end
+
+  def register(app, records)
+    @api.post(@url, app: app, records: records.to_kintone)
+  end
+
+  def update(app, records)
+    @api.put(@url, app: app, records: records.to_kintone)
+  end
+
+  def delete(app, ids, revisions: nil)
+    params = { app: app, ids: ids }
+    params[:revisions] = revisions if revisions
+    @api.delete(@url, params)
+  end
+
+  alias create register
+end

data/lib/kintone/command/space.rb

@@ -0,0 +1,15 @@
+require 'kintone/command'
+
+class Kintone::Command::Space < Kintone::Command
+  def self.path
+    'space'
+  end
+
+  def get(id)
+    @api.get(@url, id: id)
+  end
+
+  def delete(id)
+    @api.delete(@url, id: id)
+  end
+end

data/lib/kintone/command/space_body.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::SpaceBody < Kintone::Command
+  def self.path
+    'space/body'
+  end
+
+  def update(id, body)
+    @api.put(@url, id: id, body: body)
+  end
+end

data/lib/kintone/command/space_guests.rb

@@ -0,0 +1,11 @@
+require 'kintone/command'
+
+class Kintone::Command::SpaceGuests < Kintone::Command
+  def self.path
+    'space/guests'
+  end
+
+  def update(id, guests)
+    @api.put(@url, id: id, guests: guests)
+  end
+end

data/lib/kintone/command/space_members.rb

@@ -0,0 +1,16 @@
+require 'kintone/command'
+
+class Kintone::Command::SpaceMembers < Kintone::Command
+  def self.path
+    'space/members'
+  end
+
+  def get(id)
+    response = @api.get(@url, id: id)
+    response['members']
+  end
+
+  def update(id, members)
+    @api.put(@url, id: id, members: members)
+  end
+end

data/lib/kintone/command/space_thread.rb

@@ -0,0 +1,14 @@
+require 'kintone/command'
+
+class Kintone::Command::SpaceThread < Kintone::Command
+  def self.path
+    'space/thread'
+  end
+
+  def update(id, name: nil, body: nil)
+    request_body = { id: id }
+    request_body[:name] = name if name
+    request_body[:body] = body if body
+    @api.put(@url, request_body)
+  end
+end

data/lib/kintone/command/template_space.rb

@@ -0,0 +1,12 @@
+require 'kintone/command'
+
+class Kintone::Command::TemplateSpace < Kintone::Command
+  def self.path
+    'template/space'
+  end
+
+  def create(id, name, members, is_guest: false, fixed_member: false)
+    body = { id: id, name: name, members: members, isGuest: is_guest, fixedMember: fixed_member }
+    @api.post(@url, body)
+  end
+end

data/lib/kintone/command.rb

@@ -0,0 +1,12 @@
+require 'kintone/api'
+
+class Kintone::Command
+  def self.path
+    '/'
+  end
+
+  def initialize(api)
+    @api = api
+    @url = @api.get_url(self.class.path)
+  end
+end

data/lib/kintone/kintone_error.rb

@@ -0,0 +1,12 @@
+class Kintone::KintoneError < StandardError
+  attr_reader :message_text, :id, :code, :http_status, :errors
+
+  def initialize(messages, http_status)
+    @message_text = messages['message']
+    @id = messages['id']
+    @code = messages['code']
+    @errors = messages['errors']
+    @http_status = http_status
+    super(format('%s [%s] %s(%s)', @http_status, @code, @message_text, @id))
+  end
+end

data/lib/kintone/query/extension.rb

@@ -0,0 +1,23 @@
+class Kintone::Query
+  module Extention
+    refine Object do
+      def query_format
+        self
+      end
+    end
+
+    refine Symbol do
+      def query_format
+        "\"#{self}\""
+      end
+    end
+
+    refine String do
+      def query_format
+        if self =~ /\A".+"\z/ then self
+        else "\"#{self}\""
+        end
+      end
+    end
+  end
+end