kintone 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24a441e5a7cd395f4b7e77d1ef6c8c5fc450ec57
-  data.tar.gz: d2c412b23b6685dde86ae1e68bee11897dc1f1ed
+  metadata.gz: a164c300acd21a0f68fd1c1bd5c44ec1bafe48f7
+  data.tar.gz: 6bea016672ebf7fc90e4f488f47a81f576b1cab4
 SHA512:
-  metadata.gz: 1e255c61c186000b3f8071555158bda3289b73e2bc4be110ca50403ac464bbbe1b86af3e6a0b302722f94f7568fe7cba4a8c4cf5734741359d86f38da0c4adf3
-  data.tar.gz: 8ff4d97a4355fc50a22080bee96331a7c0a662567faf5755abd79a1a59b7d4ad85395646aca1885b74eb5072891ecb38c5cf9f5415be0d35481df43fef1242da
+  metadata.gz: 2d6fbb16fb2f20c48b1b0e726794991ea487f24f98134844fa54f6c24ac1ece0a415494633814b454be19bb50fd2d9705ca9669da4637686e4323c63bb4f15a1
+  data.tar.gz: 0a65774ec1a15d1efa4729cd5178445e7a52bcc2d2d4aeaeeb015a315c8d0237bcf2f17a460064722c17bd65d88daa11d7606390345a00e8105f3ecfed550f0a

data/.rubocop.yml

@@ -24,3 +24,13 @@ Style/LineLength:
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/StringLiterals:
   EnforcedStyle: single_quotes
+
+Style/WordArray:
+  Exclude:
+    - 'spec/**/**'
+
+Style/AsciiComments:
+  Enabled: false
+
+CyclomaticComplexity:
+  Max: 10

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.1.0
+  - 2.1.1
   - 2.1.2

data/README.md

@@ -2,6 +2,10 @@
 
 A Ruby gem for communicating with the [kintone](https://kintone.cybozu.com/us/) REST API
 
+## Requirements
+
+- ruby 2.1.0 or later
+
 ## Installation
 
     gem install kintone
@@ -24,7 +28,10 @@ api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
 - [Record delete](#record_delete)
 - [Format retrieval](#format_retrieval)
 - [Permissions](#permissions)
-- [Space management]("space_management")
+- [Space management](#space_management)
+- [Guests](#guests)
+- [Application information](#application_information)
+- [API information](#api_information)
 
 ### <a name="record_retrieval"> Record retrieval
 
@@ -39,31 +46,139 @@ query = "updated_time > \"2012-02-03T09:00:00+0900\" and updated_time < \"2012-0
 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
+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
+> | field(:code) > other
+< | field(:code) < other
+>= | 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
+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.create(app, record) # => {"id" => "100"}
+api.record.register(app, record) # => {"id" => "100"}
+
+# Use Kintone::Type::Record
+app = 7
+record = Kintone::Type::Record.new(number: "123456")
+api.record.register(app, record) # => {"id" => "100"}
 
 # Records register(batch)
+# Use Hash
 app = 7
-records = [{"number" => {"value" => "123456"}}, {"number" => {"value" => "7890"}}]
-api.records.create(app, records) # => {"ids" => ["100", "101"]}
+records = [
+  {"number" => {"value" => "123456"}},
+  {"number" => {"value" => "7890"}}
+]
+api.records.register(app, records) # => {"ids" => ["100", "101"]}
+
+# 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"]}
+
+# Deprecated
+api.record.create(app, record)
+api.records.create(app, records)
 ```
 
 ### <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) # => {}
 
+# Use Kintone::Type::Record
+app = 4; id = 1
+record = Kintone::Type::Record.new({string_multi: "changed!"})
+api.record.update(app, id, record) # => {}
+
 # Records update(batch)
+# Use Hash
 app = 4
-records = [{"id" => 1, "string_multi" => {"value" => "abcdef"}}, {"id" => 2, "string_multi" => {"value" => "opqrstu"}}]
+records = [
+  {"id" => 1, "record" => {"string_multi" => {"value" => "abcdef"}}},
+  {"id" => 2, "record" => {"string_multi" => {"value" => "opqrstu"}}}
+]
+api.records.update(app, records) # => {}
+
+# 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) # => {}
 ```
 
@@ -103,7 +218,7 @@ api.field_acl.update(id, rights) # => {}
 ### <a name="space_management"> Space management
 
 ```ruby
-# Space information reference
+# Space information
 id = 1
 api.space.get(id) # => { "id" => "1", "name" => "space", "defaultThread" => "3", "isPrivate" => true, ...}
 
@@ -116,11 +231,56 @@ api.template_space.create(id, name, members, is_guest: true, fixed_member: false
 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.create(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" => "", ...}
+```
+
+### <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

data/kintone.gemspec

@@ -24,8 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'rubocop', '~> 0.24.1'
+  spec.add_development_dependency 'webmock', '~> 1.18'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'rspec-parameterized', '~> 0.1.2'
 end

data/lib/kintone.rb

@@ -1,5 +1,6 @@
 require 'kintone/version'
 require 'kintone/api'
+require 'kintone/type'
 
 module Kintone
   # Your code goes here...

data/lib/kintone/api.rb

@@ -11,7 +11,13 @@ 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/apis'
 require 'kintone/api/guest'
+require 'kintone/query'
 
 class Kintone::Api
   BASE_PATH = '/k/v1/'
@@ -37,7 +43,7 @@ class Kintone::Api
     Kintone::Api::Guest.new(space_id, self)
   end
 
-  def get(url, params = nil)
+  def get(url, params = {})
     response =
       @connection.get do |request|
         request.url url
@@ -66,11 +72,12 @@ class Kintone::Api
     response.body
   end
 
-  def delete(url, params = nil)
+  def delete(url, body = nil)
     response =
       @connection.delete do |request|
         request.url url
-        request.params = params
+        request.headers['Content-Type'] = 'application/json'
+        request.body = body.to_json
       end
     response.body
   end
@@ -110,4 +117,24 @@ class Kintone::Api
   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 apis
+    Kintone::Command::Apis.new(self)
+  end
 end

data/lib/kintone/api/guest.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require 'kintone/api'
+require 'kintone/command/space_guests'
 
 class Kintone::Api
   class Guest
@@ -48,6 +49,22 @@ class Kintone::Api
       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 space_guests
+      Kintone::Command::SpaceGuests.new(self)
+    end
+
+    def app
+      Kintone::Command::App.new(self)
+    end
+
     def_delegators :@api, :get, :post, :put, :delete
   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/guests.rb

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

data/lib/kintone/command/record.rb

@@ -9,11 +9,15 @@ class Kintone::Command::Record < Kintone::Command
     @api.get(@url, app: app, id: id)
   end
 
+  def register(app, record)
+    @api.post(@url, app: app, record: record.to_kintone)
+  end
+
   def create(app, record)
-    @api.post(@url, app: app, record: record)
+    register(app, record)
   end
 
   def update(app, id, record)
-    @api.put(@url, app: app, id: id, record: record)
+    @api.put(@url, app: app, id: id, record: record.to_kintone)
   end
 end