kintone 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea0ac21ce99dbd0d7a7721f75a6ab200186aeabd
-  data.tar.gz: a52bb9292342a21c5d67821cfb2aa5fc05ecda82
+  metadata.gz: 548e13d447b105ddea94cd11ffc2ca2b882d1a89
+  data.tar.gz: 8c7940cdf780cdc5980e9920326a7307d820976e
 SHA512:
-  metadata.gz: c549d6b8129703ef3b38879675e95e92a6dbbf01f3edbcc55dcdb4d7e89757c5f0295fa7937583a69b279f9d5faf386fc34db49f0136569bd7fc4d99ddfb7d06
-  data.tar.gz: dc38ec2c27cf9b0025e89628044ef7b173675dd2250122efde24b557bacf8314012825961e54eb3709906484dcedd5ec26a84049eaac410d796709ba887707db
+  metadata.gz: 9f28461efc3dbe61367ee5f178e9585eda7d450c6e56fda8b523b7c3802dbd09d2871d2e34985a6c4d305f956fa6866a48e026f2496b817f4f4a6ed04fd74920
+  data.tar.gz: 2fbf9eb1eb0c53e0247567cf72ccb5355a4f17a4b4b0ba8b3d47dd39b883d971ca2d73656685ca09fbcab1f8ef133c90e360c2de6d985354c5c77aff9c0306a9

data/README.md

@@ -1,6 +1,6 @@
-# Kintone
+# kintone
 
-クラウド型データベースサービスKintone( https://kintone.cybozu.com/ )のREST APIを使用するためのgemです。
+クラウド型データベースサービスkintone( https://kintone.cybozu.com/ )のREST APIを使用するためのgemです。
 
 ## Installation
 
@@ -14,29 +14,79 @@
 
 ## Usage
 
-    require 'kintone'
+```ruby
+require 'kintone'
+api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
+```
 
-### レコード1件の取得/登録/更新
+### 対応API
+- レコード取得
+- レコード登録
+- レコード更新
+- レコード削除
 
-	api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
-	# レコード取得
-	api.record.get(8, 100) # get(アプリID, レコード番号)
-	# レコード登録
-	api.record.create(7, {"number" => {"value" => "123456"}}) # create(アプリID, レコードデータ)
-	# レコード更新
-	api.record.update(4, 1, {"string_multi" => {"value" => "changed!"}}) # update(アプリID, レコード番号, レコードデータ)
+### レコード取得
+
+```ruby
+# レコード取得(レコード番号指定)
+app = 8; id = 100
+api.record.get(app, id) # => {"record" => {"record_id" => {"type" => "RECORD_NUMBER", "value" => "1"}}}
+
+# レコード取得(クエリで取得)
+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" => [{...}, ...]}
+```
+
+### レコード登録
+
+```ruby
+# レコード登録(1件)
+app = 7
+record = {"number" => {"value" => "123456"}}
+api.record.create(app, record) # => {"id" => "100"}
+
+# レコード登録(複数件)
+app = 7
+records = [{"number" => {"value" => "123456"}}, {"number" => {"value" => "7890"}}]
+api.records.create(app, records) # => {"ids" => ["100", "101"]}
+```
+
+### レコード更新
+
+```ruby
+# レコード更新(1件)
+app = 4; id = 1
+record = {"string_multi" => {"value" => "changed!"}}
+api.record.update(app, id, record) # => {}
+
+# レコード更新(複数件)
+app = 4
+records = [{"id" => 1, "string_multi" => {"value" => "abcdef"}}, {"id" => 2, "string_multi" => {"value" => "opqrstu"}}]
+api.records.update(app, records) # => {}
+```
+
+### レコード削除
+
+```ruby
+app = 8; ids = [100, 80]
+api.records.delete(app, ids) # => {}
+```
 
 ### 他APIへのリクエスト
 
-	# フォーム設計情報取得
-	api.get("form.json", {"app" => 4}) # => {"properties" => [{...}, ...]}
-	# 複数レコード登録
-	body = {"app" => 7, "records" => [{...}, ...]}
-	api.post("records.json", body) # => {"ids" => ["100","101"]}
+```ruby
+# フォーム設計情報取得
+api.get("form.json", {"app" => 4}) # => {"properties" => [{...}, ...]}
+# 複数レコード登録
+body = {"app" => 7, "records" => [{...}, ...]}
+api.post("records.json", body) # => {"ids" => ["100","101"]}
+```
 
 ### ゲストスペースへのAPIリクエスト
 
-	api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
-	api.guest(1).record.get(8, 100)
+```ruby
+api.guest(1).record.get(8, 100)
+```
 
 APIの仕様等については、cybozu.com developers( https://developers.cybozu.com/ )を見てください。

data/kintone.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Kintone::VERSION
   spec.authors       = ["Rikiya Kawakami"]
   spec.email         = ["ricky.k.yang@gmail.com"]
-  spec.summary       = %q{Kintone API client.}
-  spec.description   = %q{Kintone API client.}
+  spec.summary       = %q{kintone API client for Ruby.}
+  spec.description   = %q{kintone API client for Ruby.}
   spec.homepage      = "https://github.com/jue58/kintone"
   spec.license       = "MIT"
 

data/lib/kintone/api.rb

@@ -3,6 +3,7 @@ require 'faraday_middleware'
 require 'base64'
 require 'json'
 require 'kintone/command/record'
+require 'kintone/command/records'
 
 class Kintone::Api
   BASE_PATH = "/k%s/v1/"
@@ -73,4 +74,8 @@ class Kintone::Api
   def record
     Kintone::Command::Record.new(self)
   end
+
+  def records
+    Kintone::Command::Records.new(self)
+  end
 end

data/lib/kintone/command.rb

@@ -0,0 +1,3 @@
+module Kintone::Command
+  
+end

data/lib/kintone/command/record.rb

@@ -1,23 +1,22 @@
+require 'kintone/command'
 require 'kintone/api'
 
-module Kintone::Command
-  class Record
-    PATH = "record.json"
+class Kintone::Command::Record
+  PATH = "record.json"
 
-    def initialize(api)
-      @api = api
-    end
+  def initialize(api)
+    @api = api
+  end
 
-    def get(app, id)
-      @api.get(PATH, {:app => app, :id => id})
-    end
+  def get(app, id)
+    @api.get(PATH, {:app => app, :id => id})
+  end
 
-    def create(app, record)
-      @api.post(PATH, {:app => app, :record => record})
-    end
+  def create(app, record)
+    @api.post(PATH, {:app => app, :record => record})
+  end
 
-    def update(app, id, record)
-      @api.put(PATH, {:app => app, :id => id, :record => record})
-    end
+  def update(app, id, record)
+    @api.put(PATH, {:app => app, :id => id, :record => record})
   end
 end

data/lib/kintone/command/records.rb

@@ -0,0 +1,30 @@
+require 'kintone/command'
+require 'kintone/api'
+
+class Kintone::Command::Records
+  PATH = "records.json"
+
+  def initialize(api)
+    @api = api
+  end
+
+  def get(app, query, fields)
+    params = {:app => app, :query => query}
+    fields.each_with_index {|v, i| params["fields[#{i}]"] = v}
+    return @api.get(PATH, params)
+  end
+
+  def create(app, records)
+    return @api.post(PATH, {:app => app, :records => records})
+  end
+
+  def update(app, records)
+    return @api.put(PATH, {:app => app, :records => records})
+  end
+
+  def delete(app, ids)
+    params = {:app => app}
+    ids.each_with_index {|v, i| params["ids[#{i}]"] = v}
+    return @api.delete(PATH, params)
+  end
+end

data/lib/kintone/version.rb

@@ -1,3 +1,3 @@
 module Kintone
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/api_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 require 'kintone/api'
+require 'kintone/command/record'
+require 'kintone/command/records'
 
 describe Kintone::Api do
   let(:target) { Kintone::Api.new(domain, user, password) }
@@ -99,4 +101,16 @@ describe Kintone::Api do
 
     it { expect(subject).to eq({"abc" => "def"}) }
   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
 end

data/spec/command/records_spec.rb

@@ -0,0 +1,162 @@
+require 'spec_helper'
+require 'kintone/command/records'
+require 'kintone/api'
+
+describe Kintone::Command::Records do
+  let(:target) { Kintone::Command::Records.new(api) }
+  let(:api) { Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu") }
+
+  describe "#get" do
+    subject { target.get(app, query, fields) }
+    let(:app) { 8 }
+    let(:query) { "" }
+    let(:fields) { [] }
+
+    context "アプリIDだけ指定した時" do
+      before(:each) do
+        stub_request(
+          :get,
+          "https://example.cybozu.com/k/v1/records.json?app=8&query="
+        ).
+        to_return(:body => "{\"records\":[{\"record_id\": {\"type\":\"RECORD_NUMBER\",\"value\":\"1\"}}]}", :status => 200)
+      end
+    
+      it { expect(subject).to eq({"records" => [{"record_id" => {"type" => "RECORD_NUMBER", "value" => "1"}}]}) }
+    end
+    
+    context "条件に文字列を含むqueryを指定した時" do
+      before(:each) do
+        stub_request(
+          :get,
+          "https://example.cybozu.com/k/v1/records.json?app=8&query=updated_time%20%3e%20%222012%2d02%2d03T09%3a00%3a00%2b0900%22%20and%20updated_time%20%3c%20%222012%2d02%2d03T10%3a00%3a00%2b0900%22"
+        ).
+        to_return(:body => "{\"records\":[{\"record_id\": {\"type\":\"RECORD_NUMBER\",\"value\":\"1\"}}]}", :status => 200)
+      end
+
+      let(:query) { "updated_time > \"2012-02-03T09:00:00+0900\" and updated_time < \"2012-02-03T10:00:00+0900\"" }
+
+      it { expect(subject).to eq({"records" => [{"record_id" => {"type" => "RECORD_NUMBER", "value" => "1"}}]}) }
+    end
+
+    context "項目に全角文字を含むfieldsを指定した時" do
+      before(:each) do
+        stub_request(
+          :get,
+          "https://example.cybozu.com/k/v1/records.json?app=8&query=&fields%5b0%5d=%E3%83%AC%E3%82%B3%E3%83%BC%E3%83%89%E7%95%AA%E5%8F%B7&fields%5b1%5d=created_time&fields%5b2%5d=dropdown"
+        ).
+        to_return(:body => "{\"records\":[{\"record_id\": {\"type\":\"RECORD_NUMBER\",\"value\":\"1\"}}]}", :status => 200)
+      end
+    
+      let(:fields) { ["レコード番号", "created_time", "dropdown"] }
+
+      it { expect(subject).to eq({"records" => [{"record_id" => {"type" => "RECORD_NUMBER", "value" => "1"}}]}) }
+    end
+
+    context "queryにnilを指定した時" do
+      before(:each) do
+        stub_request(
+          :get,
+          "https://example.cybozu.com/k/v1/records.json?app=8&query"
+        ).
+        to_return(:body => "{\"records\":[{\"record_id\": {\"type\":\"RECORD_NUMBER\",\"value\":\"1\"}}]}", :status => 200)
+      end
+    
+      let(:query) { nil }
+
+      it { expect(subject).to eq({"records" => [{"record_id" => {"type" => "RECORD_NUMBER", "value" => "1"}}]}) }
+    end
+
+    context "fieldsにnilを指定した時" do
+      let(:fields) { nil }
+
+      it { expect{ subject }.to raise_error(NoMethodError)}
+    end
+  end
+
+  describe "#create" do
+    subject { target.create(app, records) }
+
+    context "" do
+      def records_data
+        return [
+          {
+            "rich_editor" => {"value" => "testtest"}
+          },
+          {
+            "user_select" => {"value" => [{"code"=> "suzuki"}]}
+          }
+        ]
+      end
+
+      before(:each) do
+        stub_request(
+          :post,
+          "https://example.cybozu.com/k/v1/records.json"
+        ).
+        with(:body => {"app" => 7, "records" => records_data}.to_json).
+        to_return(:body => "{\"ids\":[\"100\", \"101\"]}", :status => 200)
+      end
+
+      let(:app) { 7 }
+      let(:records) { records_data }
+
+      it { expect(subject).to eq({"ids" => ["100", "101"]}) }
+    end
+  end
+
+  describe "#update" do
+    subject { target.update(app, records) }
+
+    context "" do
+      def records_data
+        return [
+          {
+            "id" => 1,
+            "record" => {
+              "string_1" => {"value" => "abcdef"}
+            }
+          },
+          {
+            "id" => 2,
+            "record" => {
+              "string_multi" => {"value" => "opqrstu"}
+            }
+          }
+        ]
+      end
+
+      before(:each) do
+        stub_request(
+          :put,
+          "https://example.cybozu.com/k/v1/records.json"
+        ).
+        with(:body => {"app" => 4, "records" => records_data}.to_json).
+        to_return(:body => "{}", :status => 200)
+      end
+
+      let(:app) { 4 }
+      let(:records) { records_data }
+
+      it { expect(subject).to eq({}) }
+    end
+  end
+
+  describe "#delete" do
+    subject { target.delete(app, ids) }
+
+    context "" do
+      before(:each) do
+        stub_request(
+          :delete,
+          "https://example.cybozu.com/k/v1/records.json?app=1&ids[0]=100&ids[1]=80"
+        ).
+        to_return(:body => "{}", :status => 200)
+      end
+
+      let(:app) { 1 }
+      let(:ids) { [100, 80] }
+
+      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.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rikiya Kawakami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,7 +94,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Kintone API client.
+description: kintone API client for Ruby.
 email:
 - ricky.k.yang@gmail.com
 executables: []
@@ -110,10 +110,13 @@ files:
 - kintone.gemspec
 - lib/kintone.rb
 - lib/kintone/api.rb
+- lib/kintone/command.rb
 - lib/kintone/command/record.rb
+- lib/kintone/command/records.rb
 - lib/kintone/version.rb
 - spec/api_spec.rb
 - spec/command/record_spec.rb
+- spec/command/records_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jue58/kintone
 licenses:
@@ -138,9 +141,10 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Kintone API client.
+summary: kintone API client for Ruby.
 test_files:
 - spec/api_spec.rb
 - spec/command/record_spec.rb
+- spec/command/records_spec.rb
 - spec/spec_helper.rb
 has_rdoc: