kintone 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eff478f183ba34b92fbe55e9cfc9430abc9b3bec
-  data.tar.gz: 2b3d0878d64405acf03a17d3cb9a222e341c0497
+  metadata.gz: cf4c8005133bbbca3d1167a4d6b0465f01154176
+  data.tar.gz: 5ffb28f4d5f8c50e13d5c67beb5d8bdee900b497
 SHA512:
-  metadata.gz: 9d6b91023cb5a2ce0a2a176b95bef60d32572f34e1125f5213469cebfbc5256fa3f7997fc2fe32a163d840548e1162a939620c28e542357e153fd5cbe8a4f783
-  data.tar.gz: 82a7ea80e96892f8975a08be637a4f12bbf084b907abf64b464f6ce8d5b3231b2340ce381a20dabdeb423e709da82ba479ce0bcac3b6c870ecf605362eb48a67
+  metadata.gz: 6a5a62448f89a07c5fb8c6638e77f2dcbbeb813ce2698003ea92f27c55d35714644d5a059be98343ea5c63d21429a0b0163a1b9e0c77b01d069f510521212fa6
+  data.tar.gz: b4fe9f583b016bd39c86a9dac52b40c0c7d56dd449434c17cd74676bb8cb7294b8cb3636a802fe22e31ba345b835f2355794c0366808d98fe57c9acf558598fe

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 vendor/
+sample/

data/.travis.yml

@@ -1,5 +1,13 @@
+sudo: false
 language: ruby
 rvm:
   - 2.1.0
   - 2.1.1
   - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+  - 2.1.6
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2

data/Guardfile

@@ -1,10 +1,10 @@
-guard :rspec, all_after_pass: false, all_on_start: false do
+guard :rspec, all_after_pass: false, all_on_start: false, cmd: 'bundle exec rspec' do
   watch(%r{spec/.+_spec\.rb$})
   watch(%r{lib/(.+)\.rb$}) {|m| "spec/#{m[1]}_spec.rb"}
   watch(%r{lib/(.+)/.+\.rb$}) {|m| "spec/#{m[1]}_spec.rb"}
 end
 
-guard :rubocop, all_on_start: false do
+guard :rubocop, all_on_start: false, cmd: 'bundle exec rubocop' do
   watch(%r{.+\.rb$})
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end

data/README.md

@@ -1,5 +1,7 @@
 # kintone
 
+[![Build Status](https://travis-ci.org/jue58/kintone.svg?branch=master)](https://travis-ci.org/jue58/kintone)
+
 A Ruby gem for communicating with the [kintone](https://kintone.cybozu.com/us/) REST API
 
 ## Requirements
@@ -26,6 +28,7 @@ api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
 - [Record register](#record_register)
 - [Record update](#record_update)
 - [Record delete](#record_delete)
+- [Bulk request](#bulk_request)
 - [Format retrieval](#format_retrieval)
 - [Permissions](#permissions)
 - [Space management](#space_management)
@@ -58,6 +61,16 @@ query =
     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)
 
@@ -121,12 +134,12 @@ offset | offset(30)
 # Use Hash
 app = 7
 record = {"number" => {"value" => "123456"}}
-api.record.register(app, record) # => {"id" => "100"}
+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"}
+api.record.register(app, record) # => {"id" => "100", "revision" => "1"}
 
 # Records register(batch)
 # Use Hash
@@ -135,7 +148,7 @@ records = [
   {"number" => {"value" => "123456"}},
   {"number" => {"value" => "7890"}}
 ]
-api.records.register(app, records) # => {"ids" => ["100", "101"]}
+api.records.register(app, records) # => {"ids" => ["100", "101"], "revisions" => ["1", "1"]}
 
 # Use Kintone::Type::Record
 app = 7
@@ -143,7 +156,7 @@ records = [
   Kintone::Type::Record.new(number: "123456"),
   Kintone::Type::Record.new(number: "7890")
 ]
-api.records.register(app, records) # => {"ids" => ["100", "101"]}
+api.records.register(app, records) # => {"ids" => ["100", "101"], "revisions" => ["1", "1"]}
 
 # Deprecated
 api.record.create(app, record)
@@ -157,12 +170,15 @@ api.records.create(app, records)
 # Use Hash
 app = 4; id = 1
 record = {"string_multi" => {"value" => "changed!"}}
-api.record.update(app, id, record) # => {}
+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) # => {}
+api.record.update(app, id, record) # => {"revision" => "2"}
+
+# With revision
+api.record.update(app, id, record, revision: 1)
 
 # Records update(batch)
 # Use Hash
@@ -171,7 +187,7 @@ records = [
   {"id" => 1, "record" => {"string_multi" => {"value" => "abcdef"}}},
   {"id" => 2, "record" => {"string_multi" => {"value" => "opqrstu"}}}
 ]
-api.records.update(app, records) # => {}
+api.records.update(app, records) # => {"records" => [{"id" => "1", "revision" => "2"}, {"id" => "2", "revision" => "2"}]}
 
 # Use Kintone::Type::Record
 app = 4
@@ -179,7 +195,14 @@ 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) # => {}
+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
@@ -187,6 +210,17 @@ api.records.update(app, records) # => {}
 ```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 = {"requests" => [{"method" => "POST", ...}, {"method" => "PUT", ...}]}
+api.bulk.request(requests) # => {"results" => [...]}
 ```
 
 ### <a name="format_retrieval"> Format retrieval

data/lib/kintone/api.rb

@@ -2,27 +2,32 @@ require 'faraday'
 require 'faraday_middleware'
 require 'base64'
 require 'json'
-require 'kintone/command/record'
-require 'kintone/command/records'
-require 'kintone/command/form'
-require 'kintone/command/app_acl'
-require 'kintone/command/record_acl'
-require 'kintone/command/field_acl'
-require 'kintone/command/template_space'
-require 'kintone/command/space'
-require 'kintone/command/space_body'
-require 'kintone/command/space_thread'
-require 'kintone/command/space_members'
-require 'kintone/command/guests'
-require 'kintone/command/app'
-require 'kintone/command/apps'
-require 'kintone/command/apis'
+require 'kintone/command/accessor'
 require 'kintone/api/guest'
 require 'kintone/query'
 
 class Kintone::Api
   BASE_PATH = '/k/v1/'
   COMMAND = '%s.json'
+  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
+  ].freeze
 
   def initialize(domain, user, password)
     token = Base64.encode64("#{user}:#{password}")
@@ -83,63 +88,15 @@ class Kintone::Api
     response.body
   end
 
-  def record
-    Kintone::Command::Record.new(self)
+  def method_missing(name, *args)
+    if ACCESSIBLE_COMMAND.include?(name)
+      CommandAccessor.send(name, self)
+    else
+      super(name, *args)
+    end
   end
 
-  def records
-    Kintone::Command::Records.new(self)
-  end
-
-  def form
-    Kintone::Command::Form.new(self)
-  end
-
-  def app_acl
-    Kintone::Command::AppAcl.new(self)
-  end
-
-  def record_acl
-    Kintone::Command::RecordAcl.new(self)
-  end
-
-  def field_acl
-    Kintone::Command::FieldAcl.new(self)
-  end
-
-  def template_space
-    Kintone::Command::TemplateSpace.new(self)
-  end
-
-  def space
-    Kintone::Command::Space.new(self)
-  end
-
-  def space_body
-    Kintone::Command::SpaceBody.new(self)
-  end
-
-  def space_thread
-    Kintone::Command::SpaceThread.new(self)
-  end
-
-  def space_members
-    Kintone::Command::SpaceMembers.new(self)
-  end
-
-  def guests
-    Kintone::Command::Guests.new(self)
-  end
-
-  def app
-    Kintone::Command::App.new(self)
-  end
-
-  def apps
-    Kintone::Command::Apps.new(self)
-  end
-
-  def apis
-    Kintone::Command::Apis.new(self)
+  class CommandAccessor
+    extend Kintone::Command::Accessor
   end
 end

data/lib/kintone/api/guest.rb

@@ -1,12 +1,31 @@
 require 'forwardable'
 require 'kintone/api'
-require 'kintone/command/space_guests'
+require 'kintone/command/accessor'
 
 class Kintone::Api
   class Guest
     extend Forwardable
 
     GUEST_PATH = '/k/guest/%s/v1/'
+    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
+    ].freeze
+
+    def_delegators :@api, :get, :post, :put, :delete
 
     def initialize(space_id, api)
       @api = api
@@ -17,58 +36,16 @@ class Kintone::Api
       @guest_path + (COMMAND % command)
     end
 
-    def record
-      Kintone::Command::Record.new(self)
-    end
-
-    def records
-      Kintone::Command::Records.new(self)
-    end
-
-    def form
-      Kintone::Command::Form.new(self)
-    end
-
-    def app_acl
-      Kintone::Command::AppAcl.new(self)
-    end
-
-    def record_acl
-      Kintone::Command::RecordAcl.new(self)
-    end
-
-    def field_acl
-      Kintone::Command::FieldAcl.new(self)
-    end
-
-    def space
-      Kintone::Command::Space.new(self)
-    end
-
-    def space_body
-      Kintone::Command::SpaceBody.new(self)
-    end
-
-    def space_thread
-      Kintone::Command::SpaceThread.new(self)
-    end
-
-    def space_members
-      Kintone::Command::SpaceMembers.new(self)
+    def method_missing(name, *args)
+      if ACCESSIBLE_COMMAND.include?(name)
+        CommandAccessor.send(name, self)
+      else
+        super(name, *args)
+      end
     end
 
-    def space_guests
-      Kintone::Command::SpaceGuests.new(self)
+    class CommandAccessor
+      extend Kintone::Command::Accessor
     end
-
-    def app
-      Kintone::Command::App.new(self)
-    end
-
-    def apps
-      Kintone::Command::Apps.new(self)
-    end
-
-    def_delegators :@api, :get, :post, :put, :delete
   end
 end

data/lib/kintone/command/accessor.rb

@@ -0,0 +1,99 @@
+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 :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'
+
+  # 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 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
+
+    # 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_method :bulk, :bulk_request
+  end
+end