kintone 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f270a6f3feb46411a8f630efced0f9240f6715a
-  data.tar.gz: 67f676a7708f96f99be690bd60d9d4e9fe211c5f
+  metadata.gz: 802b3540fa57136b666301320c4a78bb5254084f
+  data.tar.gz: 101a717cecfbd0c2f2db6793aeb37444a7b71379
 SHA512:
-  metadata.gz: 1f6193b7f58e9299c55fb5723fb0b519e838cc483f469b6ec7b458ea767a041d1fa8bb0471df30bfdd9a87dd411650d04847616a1f7559bf20e43ab759113d21
-  data.tar.gz: 889ab4189f4ced1bc9c9a873bf52a7731f0dfcfe2dead65b713b6f45d0ba1aced9dad75de38a568e150d3cfd0b0ce4aba21313b9a712232c708d589c0cbadd54
+  metadata.gz: 85af72a3f02848b43e58286fc938858f488bf750da800a69133839b0ad92f5ee8165321420060df870dd9dd83cde7eaf5810d0f364d6ec4d044fd229e099ed8e
+  data.tar.gz: 7c58ccadb6289b95ba65fdc27d34869e2c7c320eb8c2ecbfe33853e78a55cf1803fb6870598d54743bfe553c7e29ff2dd7d12a0281f7039313194aeff329161a

data/README.md

@@ -1,17 +1,15 @@
 # kintone
 
-クラウド型データベースサービス[kintone](https://kintone.cybozu.com/)のREST APIを使用するためのgemです。
+A Ruby gem for communicating with the [kintone](https://kintone.cybozu.com/us/) REST API
 
 ## Installation
 
     gem install kintone
 
-又は、Gemfileに
+or execute `bundle install` command after you insert the following into Gemfile
 
     gem 'kintone'
 
-と書いて、`bundle install` コマンドを実行してください。
-
 ## Usage
 
 ```ruby
@@ -19,85 +17,105 @@ require 'kintone'
 api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
 ```
 
-### 対応API
-- レコード取得
-- レコード登録
-- レコード更新
-- レコード削除
-- フォーム設計情報取得
+### Supported API
+- Record retrieval
+- Record register
+- Record update
+- Record delete
+- Format retrieval
+- Permissions
 
-### レコード取得
+### 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" => [{...}, ...]}
 ```
 
-### レコード登録
+### Record register
 
 ```ruby
-# レコード登録(1件)
+# Record register(single record)
 app = 7
 record = {"number" => {"value" => "123456"}}
 api.record.create(app, record) # => {"id" => "100"}
 
-# レコード登録(複数件)
+# Records register(batch)
 app = 7
 records = [{"number" => {"value" => "123456"}}, {"number" => {"value" => "7890"}}]
 api.records.create(app, records) # => {"ids" => ["100", "101"]}
 ```
 
-### レコード更新
+### Record update
 
 ```ruby
-# レコード更新(1件)
+# Record update(single record)
 app = 4; id = 1
 record = {"string_multi" => {"value" => "changed!"}}
 api.record.update(app, id, record) # => {}
 
-# レコード更新(複数件)
+# Records update(batch)
 app = 4
 records = [{"id" => 1, "string_multi" => {"value" => "abcdef"}}, {"id" => 2, "string_multi" => {"value" => "opqrstu"}}]
 api.records.update(app, records) # => {}
 ```
 
-### レコード削除
+### Record delete
 
 ```ruby
 app = 8; ids = [100, 80]
 api.records.delete(app, ids) # => {}
 ```
 
-### フォーム設計情報取得
+### Format retrieval
 
 ```ruby
 app = 4
 api.form.get(app) # => {"properties" => [{...}, ...]}
 ```
 
-### 他APIへのリクエスト
+### 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) # => {}
+```
+
+### 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"]}
 ```
 
-### ゲストスペースへのAPIリクエスト
+### Access to guest spaces
 
 ```ruby
 api.guest(1).record.get(8, 100)
 ```
 
-APIの仕様等については、[cybozu.com developers](https://developers.cybozu.com/)を見てください。
+see also [kintone developers](https://developers.kintone.com/)

data/lib/kintone/api.rb

@@ -5,6 +5,9 @@ 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/api/guest'
 
 class Kintone::Api
@@ -12,9 +15,11 @@ class Kintone::Api
   COMMAND = "%s.json"
 
   def initialize(domain, user, password)
-    @token = Base64.encode64("#{user}:#{password}")
+    token = Base64.encode64("#{user}:#{password}")
     @connection =
-      Faraday.new(:url => "https://#{domain}", :ssl => false) do |builder|
+      Faraday.new(:url => "https://#{domain}",
+                  :headers => {"X-Cybozu-Authorization" => token},
+                  :ssl => false) do |builder|
         builder.adapter :net_http
         builder.request :url_encoded
         builder.response :json
@@ -35,7 +40,6 @@ class Kintone::Api
       @connection.get do |request|
         request.url url
         request.params = params
-        request.headers = {"X-Cybozu-Authorization" => @token}
       end
     return response.body
   end
@@ -44,7 +48,7 @@ class Kintone::Api
     response =
       @connection.post do |request|
         request.url url
-        request.headers = {"X-Cybozu-Authorization" => @token, "Content-Type" => "application/json"}
+        request.headers["Content-Type"] = "application/json"
         request.body = body.to_json
       end
     return response.body
@@ -54,7 +58,7 @@ class Kintone::Api
     response =
       @connection.put do |request|
         request.url url
-        request.headers = {"X-Cybozu-Authorization" => @token, "Content-Type" => "application/json"}
+        request.headers["Content-Type"] = "application/json"
         request.body = body.to_json
       end
     return response.body
@@ -65,20 +69,31 @@ class Kintone::Api
       @connection.delete do |request|
         request.url url
         request.params = params
-        request.headers = {"X-Cybozu-Authorization" => @token}
       end
     return response.body
   end
 
   def record
-    Kintone::Command::Record.new(self)
+    return Kintone::Command::Record.new(self)
   end
 
   def records
-    Kintone::Command::Records.new(self)
+    return Kintone::Command::Records.new(self)
   end
 
   def form
-    Kintone::Command::Form.new(self)
+    return Kintone::Command::Form.new(self)
+  end
+
+  def app_acl
+    return Kintone::Command::AppAcl.new(self)
+  end
+
+  def record_acl
+    return Kintone::Command::RecordAcl.new(self)
+  end
+
+  def field_acl
+    return Kintone::Command::FieldAcl.new(self)
   end
 end

data/lib/kintone/api/guest.rb

@@ -28,6 +28,18 @@ class Kintone::Api
       return Kintone::Command::Form.new(self)
     end
 
+    def app_acl
+      return Kintone::Command::AppAcl.new(self)
+    end
+
+    def record_acl
+      return Kintone::Command::RecordAcl.new(self)
+    end
+
+    def field_acl
+      return Kintone::Command::FieldAcl.new(self)
+    end
+
     def_delegators :@api, :get, :post, :put, :delete
   end
 end

data/lib/kintone/command/app_acl.rb

@@ -0,0 +1,15 @@
+require 'kintone/command'
+require 'kintone/api'
+
+class Kintone::Command::AppAcl
+  PATH = "app/acl"
+
+  def initialize(api)
+    @api = api
+    @url = @api.get_url(PATH)
+  end
+
+  def update(app, rights)
+    @api.put(@url, {:app => app, :rights => rights})
+  end
+end

data/lib/kintone/command/field_acl.rb

@@ -0,0 +1,15 @@
+require 'kintone/command'
+require 'kintone/api'
+
+class Kintone::Command::FieldAcl
+  PATH = "field/acl"
+
+  def initialize(api)
+    @api = api
+    @url = @api.get_url(PATH)
+  end
+
+  def update(id, rights)
+    @api.put(@url, {:id => id, :rights => rights})
+  end
+end

data/lib/kintone/command/record_acl.rb

@@ -0,0 +1,15 @@
+require 'kintone/command'
+require 'kintone/api'
+
+class Kintone::Command::RecordAcl
+  PATH = "record/acl"
+
+  def initialize(api)
+    @api = api
+    @url = @api.get_url(PATH)
+  end
+
+  def update(id, rights)
+    @api.put(@url, {:id => id, :rights => rights})
+  end
+end

data/lib/kintone/version.rb

@@ -1,3 +1,3 @@
 module Kintone
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/api/guest_spec.rb

@@ -15,4 +15,40 @@ describe Kintone::Api::Guest do
       it { expect(subject).to eq("/k/guest/1/v1/path.json") }
     end
   end
+
+  describe "#record" do
+    subject { target.record }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::Record) }
+  end
+
+  describe "#records" do
+    subject { target.records }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::Records) }
+  end
+
+  describe "#form" do
+    subject { target.form }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::Form) }
+  end
+
+  describe "#app_acl" do
+    subject { target.app_acl }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::AppAcl) }
+  end
+
+  describe "#record_acl" do
+    subject { target.record_acl }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::RecordAcl) }
+  end
+
+  describe "#field_acl" do
+    subject { target.field_acl }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::FieldAcl) }
+  end
 end

data/spec/api_spec.rb

@@ -127,4 +127,22 @@ describe Kintone::Api do
 
     it { expect(subject).to be_a_kind_of(Kintone::Command::Form) }
   end
+
+  describe "#app_acl" do
+    subject { target.app_acl }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::AppAcl) }
+  end
+
+  describe "#record_acl" do
+    subject { target.record_acl }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::RecordAcl) }
+  end
+
+  describe "#field_acl" do
+    subject { target.field_acl }
+
+    it { expect(subject).to be_a_kind_of(Kintone::Command::FieldAcl) }
+  end
 end

data/spec/command/app_acl_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'kintone/command/app_acl'
+require 'kintone/api'
+
+describe Kintone::Command::AppAcl do
+  let(:target) { Kintone::Command::AppAcl.new(api) }
+  let(:api) { Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu") }
+
+  describe "#update" do
+    subject { target.update(app, rights) }
+
+    context "" do
+      before(:each) do
+        stub_request(
+          :put,
+          "https://example.cybozu.com/k/v1/app/acl.json"
+        ).
+        with(:body => {"app" => 1, "rights" => {"p1" => "abc", "p2" => "def"}}.to_json).
+        to_return(:body => "{}", :status => 200)
+      end
+
+      let(:app) { 1 }
+      let(:rights) { {"p1" => "abc", "p2" => "def"} }
+
+      it { expect(subject).to eq({}) }
+    end
+  end
+end

data/spec/command/field_acl_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'kintone/command/field_acl'
+require 'kintone/api'
+
+describe Kintone::Command::FieldAcl do
+  let(:target) { Kintone::Command::FieldAcl.new(api) }
+  let(:api) { Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu") }
+
+  describe "#update" do
+    subject { target.update(id, rights) }
+
+    context "" do
+      before(:each) do
+        stub_request(
+          :put,
+          "https://example.cybozu.com/k/v1/field/acl.json"
+        ).
+        with(:body => {"id" => 1, "rights" => {"p1" => "abc", "p2" => "def"}}.to_json).
+        to_return(:body => "{}", :status => 200)
+      end
+
+      let(:id) { 1 }
+      let(:rights) { {"p1" => "abc", "p2" => "def"} }
+
+      it { expect(subject).to eq({}) }
+    end
+  end
+end

data/spec/command/record_acl_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'kintone/command/record_acl'
+require 'kintone/api'
+
+describe Kintone::Command::RecordAcl do
+  let(:target) { Kintone::Command::RecordAcl.new(api) }
+  let(:api) { Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu") }
+
+  describe "#update" do
+    subject { target.update(id, rights) }
+
+    context "" do
+      before(:each) do
+        stub_request(
+          :put,
+          "https://example.cybozu.com/k/v1/record/acl.json"
+        ).
+        with(:body => {"id" => 1, "rights" => {"p1" => "abc", "p2" => "def"}}.to_json).
+        to_return(:body => "{}", :status => 200)
+      end
+
+      let(:id) { 1 }
+      let(:rights) { {"p1" => "abc", "p2" => "def"} }
+
+      it { expect(subject).to eq({}) }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kintone
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Rikiya Kawakami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -112,13 +112,19 @@ files:
 - lib/kintone/api.rb
 - lib/kintone/api/guest.rb
 - lib/kintone/command.rb
+- lib/kintone/command/app_acl.rb
+- lib/kintone/command/field_acl.rb
 - lib/kintone/command/form.rb
 - lib/kintone/command/record.rb
+- lib/kintone/command/record_acl.rb
 - lib/kintone/command/records.rb
 - lib/kintone/version.rb
 - spec/api/guest_spec.rb
 - spec/api_spec.rb
+- spec/command/app_acl_spec.rb
+- spec/command/field_acl_spec.rb
 - spec/command/form_spec.rb
+- spec/command/record_acl_spec.rb
 - spec/command/record_spec.rb
 - spec/command/records_spec.rb
 - spec/spec_helper.rb
@@ -149,7 +155,10 @@ summary: kintone API client for Ruby.
 test_files:
 - spec/api/guest_spec.rb
 - spec/api_spec.rb
+- spec/command/app_acl_spec.rb
+- spec/command/field_acl_spec.rb
 - spec/command/form_spec.rb
+- spec/command/record_acl_spec.rb
 - spec/command/record_spec.rb
 - spec/command/records_spec.rb
 - spec/spec_helper.rb