kintone-client 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8405538519f116448d017e5c80731bff2914fa5
-  data.tar.gz: faf00bbceed1434aec64b54f004d2a7f589c3621
+  metadata.gz: f45e8aea8f3bbfbd363bf255b787f1ebad043ff7
+  data.tar.gz: 302ba4e89536b92386c2212b7e3f2c614f6045ea
 SHA512:
-  metadata.gz: 9335cace6fe308ed569b8578c430e23fcc2d40bdfa7caf69c51437ccfc28fb258695bbc6ae8eac420d6801570a993e959ef546c38402a1bf9181ef5c2c554067
-  data.tar.gz: b5607d1e1afb62d4b58819fd147642badb3fddf12abebfb4abaaa814532c4f16dbe66c8a1e6033e3abba9ff9c65a6dff93b83553e602176df3a06cf2f94bea5a
+  metadata.gz: 2a45e6ba3a2ad346d196baa3116604ab9aa3a621d341f1b1a301f51871878c537e037477bde705bc78e95052e1a6479ed36dd7f07fbe9b62a297d1a356fdafad
+  data.tar.gz: 231119937b7e73b04c25e062b35d6835349aa993849e3c2dce4af077d2f13160b5a9b814a3ab3bc9a92037652ad82b9ff91cddcc94483a363875e922f125505b

data/README.md

@@ -31,6 +31,20 @@ p client.records.get(app: 211)
 
 # https://cybozudev.zendesk.com/hc/ja/articles/202166220-%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9%E3%81%AE%E3%83%A1%E3%83%B3%E3%83%90%E3%83%BC%E3%81%AE%E5%8F%96%E5%BE%97
 p client.space.members.get(id: 4)
+
+# `"文字列__1行"=>"テスト"` -> `"文字列__1行"=>{"value"=>"テスト"}`
+client.record.post_json(
+  {"app"=>1972,
+   "record"=>
+    {"文字列__1行"=>"テスト",
+     "文字列__複数行"=>"テスト\nテスト2",
+     "数値"=>20,
+     "日時"=>"2014-02-16T08:57:00Z",
+     "チェックボックス"=>{"value"=>["sample1", "sample2"]},
+     "ユーザー選択"=>{"value"=>[{"code"=>"sato"}]},
+     "ドロップダウン"=>"sample1",
+     "リンク_ウェブ"=>"https://www.cybozu.com",
+     "Table"=>{"value"=>[{"value"=>{"テーブル文字列"=>{"value"=>"テスト"}}}]}}})
 ```
 
 ## kintone API

data/kintone-client.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '>= 0.8'
+  spec.add_dependency 'faraday', ENV['FARADAY_VERSION'] ? "= #{ENV['FARADAY_VERSION']}" : '>= 0.8.9'
   spec.add_dependency 'faraday_middleware'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/kintone/client/middleware/form.rb

@@ -7,13 +7,13 @@ module Kintone::Client::Middleware
     def call(env)
       @app.call(env).on_complete do |env|
         if record = env[:body]['record']
-          env[:body] = {
-            'record' => parse_form(record)
-          }
+          env[:body]['record'] = parse_form(record)
         elsif records = env[:body]['records']
-          env[:body] = {
-            'records' => records.map {|r| parse_form(r) }
-          }
+          env[:body]['records'] = records.map {|r| parse_form(r) }
+        end
+
+        if totalCount = env[:body]['totalCount']
+          env[:body]['totalCount'] = totalCount.to_i
         end
       end
     end

data/lib/kintone/client/version.rb

@@ -1,5 +1,5 @@
 module Kintone
   class Client
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

data/spec/kintone/client/app_spec.rb

@@ -17,8 +17,8 @@ describe Kintone::Client do
     it do
       client = kintone_client do |stub|
         stub.get('/k/v1/app.json') do |env|
-          expect(params_from_url(env)).to eq "id=4"
-          expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+          expect(params_from_url(env)).to eq({"id"=>["4"]})
+          expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
           [200, {'Content-Type' => 'json'}, JSON.dump(response)]
         end
       end

data/spec/kintone/client/apps_spec.rb

@@ -29,8 +29,8 @@ describe Kintone::Client do
       it do
         client = kintone_client do |stub|
           stub.get('/k/v1/apps.json') do |env|
-            expect(params_from_url(env)).to eq "codes[0]=FOO&codes[1]=BAR&name=TEST"
-            expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+            expect(params_from_url(env)).to eq({"codes[0]"=>["FOO"], "codes[1]"=>["BAR"], "name"=>["TEST"]})
+            expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
             [200, {'Content-Type' => 'json'}, JSON.dump(response)]
           end
         end
@@ -45,7 +45,7 @@ describe Kintone::Client do
         client = kintone_client do |stub|
           stub.get('/k/v1/apps.json') do |env|
             expect(params_from_url(env)).to be_nil
-            expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+            expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
             [200, {'Content-Type' => 'json'}, JSON.dump(response)]
           end
         end
@@ -64,7 +64,7 @@ describe Kintone::Client do
         client = kintone_client do |stub|
           stub.get('/k/v1/apps.json') do |env|
             expect(params_from_url(env)).to be_nil
-            expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+            expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
             [200, {'Content-Type' => 'json'}, JSON.dump(response)]
           end
         end

data/spec/kintone/client/bulkRequest_spec.rb

@@ -44,9 +44,9 @@ describe Kintone::Client do
     it do
       client = kintone_client do |stub|
         stub.post('/k/v1/bulkRequest.json') do |env|
-          expect(env.body).to eq JSON.dump(request)
-          expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
-          expect(env.request_headers['Content-Type']).to eq 'application/json'
+          expect(env[:body]).to eq JSON.dump(request)
+          expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+          expect(env[:request_headers]['Content-Type']).to eq 'application/json'
           [200, {'Content-Type' => 'json'}, JSON.dump(response)]
         end
       end
@@ -58,9 +58,9 @@ describe Kintone::Client do
     it do
       client = kintone_client do |stub|
         stub.post('/k/v1/bulkRequest.json') do |env|
-          expect(env.body).to eq JSON.dump(request)
-          expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
-          expect(env.request_headers['Content-Type']).to eq 'application/json'
+          expect(env[:body]).to eq JSON.dump(request)
+          expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+          expect(env[:request_headers]['Content-Type']).to eq 'application/json'
           [200, {'Content-Type' => 'json'}, JSON.dump(response)]
         end
       end

data/spec/kintone/client/record_post_spec.rb

@@ -23,10 +23,10 @@ describe Kintone::Client do
          "数値"=>20,
          "日時"=>"2014-02-16T08:57:00Z",
          "チェックボックス"=>{"value"=>["sample1", "sample2"]},
-         "ユーザー選択"=>{"value"=>[{"code"=>"sato"}]},
+         "ユーザー選択"=>{value: [{"code"=>"sato"}]},
          "ドロップダウン"=>"sample1",
          "リンク_ウェブ"=>"https://www.cybozu.com",
-         "Table"=>{"value"=>[{"value"=>{"テーブル文字列"=>{"value"=>"テスト"}}}]}}}
+         "Table"=>{value: [{"value"=>{"テーブル文字列"=>{value: "テスト"}}}]}}}
     end
 
     let(:response) do
@@ -36,9 +36,9 @@ describe Kintone::Client do
     it do
       client = kintone_client do |stub|
         stub.post('/k/v1/record.json') do |env|
-          expect(env.body).to eq JSON.dump(request)
-          expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
-          expect(env.request_headers['Content-Type']).to eq 'application/json'
+          expect(env[:body]).to eq JSON.dump(request)
+          expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+          expect(env[:request_headers]['Content-Type']).to eq 'application/json'
           [200, {'Content-Type' => 'json'}, JSON.dump(response)]
         end
       end
@@ -50,9 +50,9 @@ describe Kintone::Client do
     it do
       client = kintone_client do |stub|
         stub.post('/k/v1/record.json') do |env|
-          expect(env.body).to eq JSON.dump(request)
-          expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
-          expect(env.request_headers['Content-Type']).to eq 'application/json'
+          expect(env[:body]).to eq JSON.dump(request)
+          expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+          expect(env[:request_headers]['Content-Type']).to eq 'application/json'
           [200, {'Content-Type' => 'json'}, JSON.dump(response)]
         end
       end
@@ -61,6 +61,7 @@ describe Kintone::Client do
       expect(result).to eq response
     end
 
+    # https://cybozudev.zendesk.com/hc/ja/articles/201941754-REST-API%E3%81%AE%E5%85%B1%E9%80%9A%E4%BB%95%E6%A7%98#step10
     context 'when error happens' do
       let(:request) do
         {"app"=>1972}
@@ -73,9 +74,9 @@ describe Kintone::Client do
       it do
         client = kintone_client do |stub|
           stub.post('/k/v1/record.json') do |env|
-            expect(env.body).to eq JSON.dump(request)
-            expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
-            expect(env.request_headers['Content-Type']).to eq 'application/json'
+            expect(env[:body]).to eq JSON.dump(request)
+            expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+            expect(env[:request_headers]['Content-Type']).to eq 'application/json'
             [400, {'Content-Type' => 'json'}, JSON.dump(response)]
           end
         end

data/spec/kintone/client/record_spec.rb

@@ -81,8 +81,8 @@ describe Kintone::Client do
     it do
       client = kintone_client do |stub|
         stub.get('/k/v1/record.json') do |env|
-          expect(params_from_url(env)).to eq "app=8&id=100"
-          expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+          expect(params_from_url(env)).to eq({"app"=>["8"], "id"=>["100"]})
+          expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
           [200, {'Content-Type' => 'json'}, JSON.dump(response)]
         end
       end

data/spec/kintone/client/records_spec.rb

@@ -29,10 +29,15 @@ describe Kintone::Client do
       it do
         client = kintone_client do |stub|
           stub.get('/k/v1/record.json') do |env|
-            expect(params_from_url(env)).to eq <<-EOS.strip
-              app=8&fields[0]=record_id&fields[1]=created_time&fields[2]=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
-            EOS
-            expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+            expect(params_from_url(env)).to eq({
+              "app"=>["8"],
+              "fields[0]"=>["record_id"],
+              "fields[1]"=>["created_time"],
+              "fields[2]"=>["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"]
+            })
+
+            expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
             [200, {'Content-Type' => 'json'}, JSON.dump(response)]
           end
         end
@@ -46,5 +51,39 @@ describe Kintone::Client do
         expect(result).to eq parsed_response
       end
     end
+
+    context 'when with totalCount' do
+      before do
+        response['totalCount'] = '1'
+        parsed_response['totalCount'] = 1
+      end
+
+      it do
+        client = kintone_client do |stub|
+          stub.get('/k/v1/record.json') do |env|
+            expect(params_from_url(env)).to eq({
+              "app"=>["8"],
+              "fields[0]"=>["record_id"],
+              "fields[1]"=>["created_time"],
+              "fields[2]"=>["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"],
+              "totalCount"=>["true"]
+            })
+
+            expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+            [200, {'Content-Type' => 'json'}, JSON.dump(response)]
+          end
+        end
+
+        result = client.record.get(
+          app: 8,
+          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',
+          fields: ["record_id", "created_time", "dropdown"],
+          totalCount: true
+        )
+
+        expect(result).to eq parsed_response
+      end
+    end
   end
 end

data/spec/kintone/client/space_spec.rb

@@ -48,8 +48,8 @@ describe Kintone::Client do
     it do
       client = kintone_client do |stub|
         stub.get('/k/v1/space.json') do |env|
-          expect(params_from_url(env)).to eq "id=1"
-          expect(env.request_headers['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
+          expect(params_from_url(env)).to eq({"id"=>["1"]})
+          expect(env[:request_headers]['X-Cybozu-Authorization']).to eq TEST_AUTH_HEADER
           [200, {'Content-Type' => 'json'}, JSON.dump(response)]
         end
       end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'kintone/client'
+require 'cgi'
 
 TEST_AUTH_HEADER = 'c2NvdHQ6dGlnZXI='
 
@@ -13,6 +14,6 @@ def kintone_client
 end
 
 def params_from_url(env)
-  query = URI.parse(env.url.to_s).query
-  query ? URI.decode(query) : query
+  query = URI.parse(env[:url].to_s).query
+  query ? CGI.parse(query) : query
 end

data/test.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+function run_test {
+  bundle install
+  bundle exec rake
+}
+
+FARADAY_VERSION=0.8.9 run_test
+FARADAY_VERSION=0.9.1 run_test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kintone-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Genki Sugawara
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.9
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,7 @@ files:
 - spec/kintone/client/records_spec.rb
 - spec/kintone/client/space_spec.rb
 - spec/spec_helper.rb
+- test.sh
 homepage: ''
 licenses:
 - MIT