kintone-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06e0fafa79ca0b5769cd0179135d5dd6d655dde3
-  data.tar.gz: 16c00fb2ef6d8e7f7d907ffc08ad5fd690939a55
+  metadata.gz: 951cf372212f60ae0f4d23e5082ef2d3f4d45d04
+  data.tar.gz: f8e03d313b23c9056e5176d0b250ee091a82ff3a
 SHA512:
-  metadata.gz: d54c24e2d01c6dda8b976c03c2772d1ca64c1bf5c0cf2352dd0b050a9bb0c4ebd67dacb6010afef8a3b93437fe4f25c3bd18463ba1ec2e0d4cf150d5dcdb10a7
-  data.tar.gz: 92a196e4c3dbb3c0afaef293ef980bf1c10f16f1804dedafdac3632915664d12b116bc3d356a6626b4e1a872169b17b5b556a8139019cae017390ab44472b538
+  metadata.gz: a5ec1cbee49c0444bf05e002d5316ace64c18edba60cf6f6e0c7d5f2eee5757fbe570415dca7643eb6304b7ad00f2ca8c07733bb1d2a3ef944f55d32807ceee2
+  data.tar.gz: db3afefc783cc053c54c7539f5970daf07845432a304bb09d77809b7ca037d77507bf3450e6614d20e77566d574bdd0395a45fc52bfb4c96d65b3dd1396fe749

data/lib/kintone/client.rb

@@ -1,4 +1,6 @@
 require 'base64'
+require 'json'
+
 require 'faraday'
 require 'faraday_middleware'
 
@@ -6,4 +8,5 @@ module Kintone; end
 require 'kintone/client/client'
 require 'kintone/client/error'
 require 'kintone/client/middleware/form'
+require 'kintone/client/middleware/record'
 require 'kintone/client/version'

data/lib/kintone/client/client.rb

@@ -20,8 +20,9 @@ class Kintone::Client
 
     @conn = Faraday.new(options) do |faraday|
       faraday.request  :url_encoded
-      faraday.response :form, :content_type => /\bjson$/ # must set before :json
-      faraday.response :json, :content_type => /\bjson$/
+      faraday.request  :record, :content_type => /\bjson$/
+      faraday.response :form,   :content_type => /\bjson$/ # must set before :json
+      faraday.response :json,   :content_type => /\bjson$/
 
       yield(faraday) if block_given?
 
@@ -54,11 +55,19 @@ class Kintone::Client
 
     private
 
-    def request(method_name, params)
+    def request(method_name, params, options = {})
       response = @conn.send(method_name) do |req|
         req.url BASE_PATH + '/' + @path + '.json'
-        req.params = expand_params_array(params || {})
+
+        if options[:json]
+          req.body = JSON.dump(params)
+          req.headers['Content-Type'] = 'application/json'
+        else
+          req.params = expand_params_array(params || {})
+        end
+
         authorize(req)
+
         yield(req) if block_given?
       end
 
@@ -117,7 +126,9 @@ class Kintone::Client
     end
 
     def method_missing(method_name, *args, &block)
-      if [:get, :post, :put, :delete].include?(method_name)
+      method_name = method_name.to_s
+
+      if %w(get post put delete post_json put_json delete_json).include?(method_name)
         case args.length
         when 0
           args = nil
@@ -125,7 +136,14 @@ class Kintone::Client
           args = args.first
         end
 
-        request(method_name, args, &block)
+        options = {}
+
+        if method_name =~ /_json\z/
+          method_name.sub!(/_json\z/, '')
+          options[:json] = true
+        end
+
+        request(method_name, args, options, &block)
       else
         unless args.length.zero?
           raise ArgumentError, "wrong number of arguments (#{args.length} for 0)"

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

@@ -0,0 +1,76 @@
+module Kintone::Client::Middleware
+  class Record < Faraday::Middleware
+    def initialize(app, options = {})
+      super(app)
+      @options = options
+    end
+
+    def call(env)
+      match_content_type(env) do
+        env[:body] = expand_body(env[:body])
+      end
+
+      @app.call env
+    end
+
+    private
+
+    def match_content_type(env)
+      content_type = env[:request_headers]['Content-Type']
+
+      return unless content_type
+
+      content_type = content_type.split(';').first.strip
+      opt_content_type = @options[:content_type] || /.*/
+
+      if env[:body] and opt_content_type =~ content_type
+        yield
+      end
+    end
+
+    def expand_body(body)
+      body = JSON.parse(body)
+
+      if body['record']
+        body['record'] = expand_record(body['record'])
+      elsif body['requests']
+        if_has_record(body['requests']) do |request|
+          record = request['payload']['record']
+          next unless record
+          request['payload']['record'] = expand_record(record)
+        end
+      end
+
+      JSON.dump(body)
+    end
+
+    def expand_record(record)
+      expanded = {}
+
+      record.each do |key, value|
+        case value
+        when Array, Hash
+          expanded[key] = value
+        else
+          expanded[key] = {
+            'value' => value.to_s
+          }
+        end
+      end
+
+      expanded
+    end
+
+    def if_has_record(requests)
+      if requests[0]['payload']['record']
+        requests.each do |request|
+          yield(request)
+        end
+      end
+    rescue
+      # nothing to do
+    end
+  end
+end
+
+Faraday::Request.register_middleware :record => Kintone::Client::Middleware::Record

data/lib/kintone/client/version.rb

@@ -1,5 +1,5 @@
 module Kintone
   class Client
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/spec/kintone/client/bulkRequest_spec.rb

@@ -0,0 +1,72 @@
+# https://cybozudev.zendesk.com/hc/ja/articles/201941814-%E8%A4%87%E6%95%B0%E3%82%A2%E3%83%97%E3%83%AA%E3%81%B8%E3%81%AE%E3%83%AC%E3%82%B3%E3%83%BC%E3%83%89%E4%B8%80%E6%8B%AC%E5%87%A6%E7%90%86
+describe Kintone::Client do
+  describe '複数アプリへのレコード一括処理' do
+    let(:request) do
+      {"requests"=>
+        [{"method"=>"POST",
+          "api"=>"/k/v1/record.json",
+          "payload"=>
+           {"app"=>1972, "record"=>{"文字列__1行"=>{"value"=>"文字列__1行を追加します。"}}}},
+         {"method"=>"PUT",
+          "api"=>"/k/v1/record.json",
+          "payload"=>
+           {"app"=>1973,
+            "id"=>33,
+            "revision"=>2,
+            "record"=>{"文字列__1行"=>{"value"=>"文字列__1行を更新します。"}}}},
+         {"method"=>"DELETE",
+          "api"=>"/k/v1/records.json",
+          "payload"=>{"app"=>1974, "ids"=>[10, 11], "revisions"=>[1, 1]}}]}
+    end
+
+    let(:unexpanded_request) do
+      {"requests"=>
+        [{"method"=>"POST",
+          "api"=>"/k/v1/record.json",
+          "payload"=>
+           {"app"=>1972, "record"=>{"文字列__1行"=>"文字列__1行を追加します。"}}},
+         {"method"=>"PUT",
+          "api"=>"/k/v1/record.json",
+          "payload"=>
+           {"app"=>1973,
+            "id"=>33,
+            "revision"=>2,
+            "record"=>{"文字列__1行"=>"文字列__1行を更新します。"}}},
+         {"method"=>"DELETE",
+          "api"=>"/k/v1/records.json",
+          "payload"=>{"app"=>1974, "ids"=>[10, 11], "revisions"=>[1, 1]}}]}
+    end
+
+    let(:response) do
+      {"results"=>[{"id"=>"39", "revision"=>"1"}, {"revision"=>"34"}, {}]}
+    end
+
+    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'
+          [200, {'Content-Type' => 'json'}, JSON.dump(response)]
+        end
+      end
+
+      result = client.bulkRequest.post_json(request)
+      expect(result).to eq response
+    end
+
+    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'
+          [200, {'Content-Type' => 'json'}, JSON.dump(response)]
+        end
+      end
+
+      result = client.bulkRequest.post_json(unexpanded_request)
+      expect(result).to eq response
+    end
+  end
+end

data/spec/kintone/client/record_post_spec.rb

@@ -0,0 +1,64 @@
+# https://cybozudev.zendesk.com/hc/ja/articles/202166160-%E3%83%AC%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E7%99%BB%E9%8C%B2-POST-
+describe Kintone::Client do
+  describe 'レコードの登録（1件）' do
+    let(:request) do
+      {"app"=>1972,
+       "record"=>
+        {"文字列__1行"=>{"value"=>"テスト"},
+         "文字列__複数行"=>{"value"=>"テスト\nテスト2"},
+         "数値"=>{"value"=>"20"},
+         "日時"=>{"value"=>"2014-02-16T08:57:00Z"},
+         "チェックボックス"=>{"value"=>["sample1", "sample2"]},
+         "ユーザー選択"=>{"value"=>[{"code"=>"sato"}]},
+         "ドロップダウン"=>{"value"=>"sample1"},
+         "リンク_ウェブ"=>{"value"=>"https://www.cybozu.com"},
+         "Table"=>{"value"=>[{"value"=>{"テーブル文字列"=>{"value"=>"テスト"}}}]}}}
+    end
+
+    let(:unexpanded_request) do
+      {"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"=>"テスト"}}}]}}}
+    end
+
+    let(:response) do
+      {"ids"=>["100", "101"], "revisions"=>["1", "1"]}
+    end
+
+    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'
+          [200, {'Content-Type' => 'json'}, JSON.dump(response)]
+        end
+      end
+
+      result = client.record.post_json(request)
+      expect(result).to eq response
+    end
+
+    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'
+          [200, {'Content-Type' => 'json'}, JSON.dump(response)]
+        end
+      end
+
+      result = client.record.post_json(unexpanded_request)
+      expect(result).to eq response
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kintone-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Genki Sugawara
@@ -112,9 +112,12 @@ files:
 - lib/kintone/client/client.rb
 - lib/kintone/client/error.rb
 - lib/kintone/client/middleware/form.rb
+- lib/kintone/client/middleware/record.rb
 - lib/kintone/client/version.rb
 - spec/kintone/client/app_spec.rb
 - spec/kintone/client/apps_spec.rb
+- spec/kintone/client/bulkRequest_spec.rb
+- spec/kintone/client/record_post_spec.rb
 - spec/kintone/client/record_spec.rb
 - spec/kintone/client/records_spec.rb
 - spec/kintone/client/space_spec.rb
@@ -146,6 +149,8 @@ summary: It is a simple client of cybozu kintone.
 test_files:
 - spec/kintone/client/app_spec.rb
 - spec/kintone/client/apps_spec.rb
+- spec/kintone/client/bulkRequest_spec.rb
+- spec/kintone/client/record_post_spec.rb
 - spec/kintone/client/record_spec.rb
 - spec/kintone/client/records_spec.rb
 - spec/kintone/client/space_spec.rb