kintone-oauth-extension 0.2.1

data/bin/console

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'kintone'
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/kintone.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kintone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kintone-oauth-extension'
+  spec.version       = Kintone::VERSION
+  spec.authors       = ['Kenji Koshikawa']
+  spec.email         = ['koshikawa2009@gmail.com']
+  spec.summary       = 'kintone API client for Ruby.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/koshilife/kintone'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/koshilife/kintone'
+  spec.metadata['changelog_uri'] = "#{spec.metadata['source_code_uri']}/blob/master/CHANGELOG.md"
+  spec.metadata['documentation_uri'] = "https://www.rubydoc.info/gems/kintone-oauth-extension/#{spec.version}"
+
+  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', '>=1.0.1'
+  spec.add_runtime_dependency 'faraday_middleware', '>=1.0.0'
+  spec.add_runtime_dependency 'oauth2', '>=1.4.4'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-parameterized'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end

data/lib/kintone.rb

@@ -0,0 +1,8 @@
+require 'kintone/version'
+require 'kintone/api'
+require 'kintone/oauth_api'
+require 'kintone/type'
+
+module Kintone
+  # Your code goes here...
+end

data/lib/kintone/api.rb

@@ -0,0 +1,121 @@
+require 'faraday'
+require 'faraday_middleware'
+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/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

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/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