kintone 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8c6531671baef8c02b16c44f8c97eb94fb8661b
-  data.tar.gz: 842dfa2299afbb03b96e711794681763011a9ef3
+  metadata.gz: b117f1c781845b8712805c6ede66ed44d8b44382
+  data.tar.gz: 2f3151d4228579e118fec2564f55f93b1eef955b
 SHA512:
-  metadata.gz: f58df87bf47682c15223ceb026674d8199b58d3bc2230402bc0680562d090cec2acf1a8500d2759948eb0fec1ef0ccc02008e6b3537967be01f893f7b6386114
-  data.tar.gz: dd16a9a45c84bf9e468164dc980fccfcd7044901c9158055e055e601bcdf211153e1c8155f6063fdb636b497c75b69cb540818f3ffc665435b4f4ba0ad4ba642
+  metadata.gz: dd4fb7e33d330c4922c26b16449cd4ea5ef3998c2eda3376f127fafffcefb5193604f9cce5c381f0e86b239b859f1fe23979827c053edcf1f70cdeda8144f232
+  data.tar.gz: 34b39834c77beddbd95b4ebeff58483663210185a781f1c5e72a2a7213ddb9b67fe66e6a43dd047405f4eb2b23563c7f0a145e33bac209b63cf56ad4c54dd865

data/README.md

@@ -20,7 +20,12 @@ or execute `bundle install` command after you insert the following into Gemfile
 
 ```ruby
 require 'kintone'
+
+# Use password authentication
 api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
+
+# Use token authentication
+api = Kintone::Api.new("example.cybozu.com", "authtoken")
 ```
 
 ### Supported API

data/lib/kintone/api.rb

@@ -30,12 +30,9 @@ class Kintone::Api
     :file
   ].freeze
 
-  def initialize(domain, user, password)
-    token = Base64.encode64("#{user}:#{password}")
-    url = "https://#{domain}"
-    headers = { 'X-Cybozu-Authorization' => token }
+  def initialize(domain, user, password = nil)
     @connection =
-      Faraday.new(url: url, headers: headers) do |builder|
+      Faraday.new(url: "https://#{domain}", headers: build_headers(user, password)) do |builder|
         builder.request :url_encoded
         builder.request :multipart
         builder.response :json, content_type: /\bjson$/
@@ -113,4 +110,14 @@ class Kintone::Api
   class CommandAccessor
     extend Kintone::Command::Accessor
   end
+
+  private
+
+  def build_headers(user, password)
+    if password # パスワード認証
+      { 'X-Cybozu-Authorization' => Base64.encode64("#{user}:#{password}") }
+    else # APIトークン認証
+      { 'X-Cybozu-API-Token' => user }
+    end
+  end
 end

data/lib/kintone/version.rb

@@ -1,3 +1,3 @@
 module Kintone
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/kintone/api_spec.rb

@@ -7,287 +7,421 @@ require 'kintone/command/records'
 describe Kintone::Api do
   let(:target) { Kintone::Api.new(domain, user, password) }
   let(:domain) { 'www.example.com' }
-  let(:user) { 'Administrator' }
-  let(:password) { 'cybozu' }
 
-  describe '#get_url' do
-    subject { target.get_url(command) }
+  context 'ユーザー認証の時' do
+    let(:user) { 'Administrator' }
+    let(:password) { 'cybozu' }
 
-    context '' do
-      let(:command) { 'path' }
-      it { is_expected.to eq('/k/v1/path.json') }
+    describe '#get_url' do
+      subject { target.get_url(command) }
+
+      context '' do
+        let(:command) { 'path' }
+        it { is_expected.to eq('/k/v1/path.json') }
+      end
     end
-  end
 
-  describe '#guest' do
-    subject { target.guest(space) }
+    describe '#guest' do
+      subject { target.guest(space) }
 
-    context '引数が数値の1の時' do
-      let(:space) { 1 }
+      context '引数が数値の1の時' do
+        let(:space) { 1 }
 
-      it { is_expected.to be_a_kind_of(Kintone::Api::Guest) }
-      it { expect(subject.instance_variable_get(:@guest_path)).to eq('/k/guest/1/v1/') }
-    end
+        it { is_expected.to be_a_kind_of(Kintone::Api::Guest) }
+        it { expect(subject.instance_variable_get(:@guest_path)).to eq('/k/guest/1/v1/') }
+      end
 
-    context '引数がnilの時' do
-      let(:space) { nil }
-      xit { expect(subject.instance_variable_get(:@guest_path)).to eq('/k/guest//v1/') }
-    end
+      context '引数がnilの時' do
+        let(:space) { nil }
+        xit { expect(subject.instance_variable_get(:@guest_path)).to eq('/k/guest//v1/') }
+      end
 
-    context '引数に数字以外の文字が含まれる時' do
-      let(:space) { '2.1' }
-      xit { expect(subject.instance_variable_get(:@guest_path)).to eq('/k/guest//v1/') }
+      context '引数に数字以外の文字が含まれる時' do
+        let(:space) { '2.1' }
+        xit { expect(subject.instance_variable_get(:@guest_path)).to eq('/k/guest//v1/') }
+      end
     end
-  end
 
-  describe '#get' do
-    before(:each) do
-      stub_request(
-        :get,
-        'https://www.example.com/k/v1/path'
-      )
-        .with(
-          query: query,
-          headers: { 'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=' }
+    describe '#get' do
+      before(:each) do
+        stub_request(
+          :get,
+          'https://www.example.com/k/v1/path'
         )
-        .to_return(body: "{\"abc\":\"def\"}", status: 200,
-                   headers: { 'Content-type' => 'application/json' })
-    end
+          .with(
+            query: query,
+            headers: { 'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=' }
+          )
+          .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                     headers: { 'Content-type' => 'application/json' })
+      end
 
-    subject { target.get(path, params) }
+      subject { target.get(path, params) }
 
-    let(:path) { '/k/v1/path' }
+      let(:path) { '/k/v1/path' }
 
-    context 'with some params' do
-      let(:params) { { 'p1' => 'abc', 'p2' => 'def' } }
-      let(:query) { 'p1=abc&p2=def' }
+      context 'with some params' do
+        let(:params) { { 'p1' => 'abc', 'p2' => 'def' } }
+        let(:query) { 'p1=abc&p2=def' }
 
-      it { is_expected.to eq 'abc' => 'def' }
+        it { is_expected.to eq 'abc' => 'def' }
+      end
+
+      context 'with empty params' do
+        let(:params) { {} }
+        let(:query) { nil }
+
+        it { is_expected.to eq 'abc' => 'def' }
+      end
+
+      context 'with nil' do
+        let(:params) { nil }
+        let(:query) { nil }
+
+        it { expect { subject }.to raise_error NoMethodError }
+      end
+
+      context 'with no params' do
+        subject { target.get(path) }
+
+        let(:query) { nil }
+
+        it { is_expected.to eq 'abc' => 'def' }
+      end
     end
 
-    context 'with empty params' do
-      let(:params) { {} }
-      let(:query) { nil }
+    describe '#post' do
+      before(:each) do
+        stub_request(
+          :post,
+          'https://www.example.com/k/v1/path'
+        )
+          .with(
+            headers: {
+              'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=',
+              'Content-Type' => 'application/json'
+            },
+            body: "{\"p1\":\"abc\",\"p2\":\"def\"}"
+          )
+          .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                     headers: { 'Content-type' => 'application/json' })
+      end
+
+      subject { target.post(path, body) }
+      let(:path) { '/k/v1/path' }
+      let(:body) { { 'p1' => 'abc', 'p2' => 'def' } }
 
       it { is_expected.to eq 'abc' => 'def' }
     end
 
-    context 'with nil' do
-      let(:params) { nil }
-      let(:query) { nil }
+    describe '#put' do
+      before(:each) do
+        stub_request(
+          :put,
+          'https://www.example.com/k/v1/path'
+        )
+          .with(
+            headers: {
+              'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=',
+              'Content-Type' => 'application/json'
+            },
+            body: "{\"p1\":\"abc\",\"p2\":\"def\"}"
+          )
+          .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                     headers: { 'Content-type' => 'application/json' })
+      end
 
-      it { expect { subject }.to raise_error NoMethodError }
+      subject { target.put(path, body) }
+      let(:path) { '/k/v1/path' }
+      let(:body) { { 'p1' => 'abc', 'p2' => 'def' } }
+
+      it { is_expected.to eq 'abc' => 'def' }
     end
 
-    context 'with no params' do
-      subject { target.get(path) }
+    describe '#delete' do
+      before(:each) do
+        stub_request(
+          :delete,
+          'https://www.example.com/k/v1/path'
+        )
+          .with(
+            body: { 'p1' => 'abc', 'p2' => 'def' }.to_json,
+            headers: { 'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=' }
+          )
+          .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                     headers: { 'Content-type' => 'application/json' })
+      end
 
-      let(:query) { nil }
+      subject { target.delete(path, params) }
+      let(:path) { '/k/v1/path' }
+      let(:params) { { 'p1' => 'abc', 'p2' => 'def' } }
 
       it { is_expected.to eq 'abc' => 'def' }
     end
-  end
 
-  describe '#post' do
-    before(:each) do
-      stub_request(
-        :post,
-        'https://www.example.com/k/v1/path'
-      )
-        .with(
-          headers: {
-            'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=',
-            'Content-Type' => 'application/json'
-          },
-          body: "{\"p1\":\"abc\",\"p2\":\"def\"}"
+    describe '#post_file' do
+      before(:each) do
+        stub_request(
+            :post,
+            'https://www.example.com/k/v1/path'
         )
-        .to_return(body: "{\"abc\":\"def\"}", status: 200,
-                   headers: { 'Content-type' => 'application/json' })
+            .with(headers: { 'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=' }) do
+              attachment
+            end
+            .to_return(body: "{\"fileKey\":\"abc\"}", status: 200,
+                       headers: { 'Content-type' => 'application/json' })
+
+        expect(Faraday::UploadIO).to receive(:new)
+                                         .with(path, content_type, original_filename,
+                                               'Content-Disposition' => 'form-data')
+                                         .and_return(attachment)
+      end
+
+      subject { target.post_file(url, path, content_type, original_filename) }
+      let(:attachment) { double('attachment') }
+      let(:url) { '/k/v1/path' }
+      let(:path) { '/path/to/file.txt' }
+      let(:content_type) { 'text/plain' }
+      let(:original_filename) { 'fileName.txt' }
+
+      it { is_expected.to eq 'abc' }
     end
 
-    subject { target.post(path, body) }
-    let(:path) { '/k/v1/path' }
-    let(:body) { { 'p1' => 'abc', 'p2' => 'def' } }
+    describe '#record' do
+      subject { target.record }
 
-    it { is_expected.to eq 'abc' => 'def' }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::Record) }
+    end
 
-  describe '#put' do
-    before(:each) do
-      stub_request(
-        :put,
-        'https://www.example.com/k/v1/path'
-      )
-        .with(
-          headers: {
-            'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=',
-            'Content-Type' => 'application/json'
-          },
-          body: "{\"p1\":\"abc\",\"p2\":\"def\"}"
-        )
-        .to_return(body: "{\"abc\":\"def\"}", status: 200,
-                   headers: { 'Content-type' => 'application/json' })
+    describe '#records' do
+      subject { target.records }
+
+      it { is_expected.to be_a_kind_of(Kintone::Command::Records) }
     end
 
-    subject { target.put(path, body) }
-    let(:path) { '/k/v1/path' }
-    let(:body) { { 'p1' => 'abc', 'p2' => 'def' } }
+    describe '#form' do
+      subject { target.form }
 
-    it { is_expected.to eq 'abc' => 'def' }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::Form) }
+    end
 
-  describe '#delete' do
-    before(:each) do
-      stub_request(
-        :delete,
-        'https://www.example.com/k/v1/path'
-      )
-        .with(
-          body: { 'p1' => 'abc', 'p2' => 'def' }.to_json,
-          headers: { 'X-Cybozu-Authorization' => 'QWRtaW5pc3RyYXRvcjpjeWJvenU=' }
-        )
-        .to_return(body: "{\"abc\":\"def\"}", status: 200,
-                   headers: { 'Content-type' => 'application/json' })
+    describe '#app_acl' do
+      subject { target.app_acl }
+
+      it { is_expected.to be_a_kind_of(Kintone::Command::AppAcl) }
     end
 
-    subject { target.delete(path, params) }
-    let(:path) { '/k/v1/path' }
-    let(:params) { { 'p1' => 'abc', 'p2' => 'def' } }
+    describe '#record_acl' do
+      subject { target.record_acl }
 
-    it { is_expected.to eq 'abc' => 'def' }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::RecordAcl) }
+    end
 
-  describe '#post_file' do
-    before(:each) do
-      stub_request(
-          :post,
-          'https://www.example.com/k/v1/path'
-      )
-          .with { attachment }
-          .to_return(body: "{\"fileKey\":\"abc\"}", status: 200,
-                     headers: { 'Content-type' => 'application/json' })
+    describe '#field_acl' do
+      subject { target.field_acl }
 
-      expect(Faraday::UploadIO).to receive(:new)
-                                       .with(path, content_type, original_filename,
-                                             'Content-Disposition' => 'form-data')
-                                       .and_return(attachment)
+      it { is_expected.to be_a_kind_of(Kintone::Command::FieldAcl) }
     end
 
-    subject { target.post_file(url, path, content_type, original_filename) }
-    let(:attachment) { double('attachment') }
-    let(:url) { '/k/v1/path' }
-    let(:path) { '/path/to/file.txt' }
-    let(:content_type) { 'text/plain' }
-    let(:original_filename) { 'fileName.txt' }
+    describe '#template_space' do
+      subject { target.template_space }
 
-    it { is_expected.to eq 'abc' }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::TemplateSpace) }
+    end
 
-  describe '#record' do
-    subject { target.record }
+    describe '#space' do
+      subject { target.space }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::Record) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::Space) }
+    end
 
-  describe '#records' do
-    subject { target.records }
+    describe '#space_body' do
+      subject { target.space_body }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::Records) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::SpaceBody) }
+    end
 
-  describe '#form' do
-    subject { target.form }
+    describe '#space_thread' do
+      subject { target.space_thread }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::Form) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::SpaceThread) }
+    end
 
-  describe '#app_acl' do
-    subject { target.app_acl }
+    describe '#space_members' do
+      subject { target.space_members }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::AppAcl) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::SpaceMembers) }
+    end
 
-  describe '#record_acl' do
-    subject { target.record_acl }
+    describe '#guests' do
+      subject { target.guests }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::RecordAcl) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::Guests) }
+    end
 
-  describe '#field_acl' do
-    subject { target.field_acl }
+    describe '#app' do
+      subject { target.app }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::FieldAcl) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::App) }
+    end
 
-  describe '#template_space' do
-    subject { target.template_space }
+    describe '#apps' do
+      subject { target.apps }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::TemplateSpace) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::Apps) }
+    end
 
-  describe '#space' do
-    subject { target.space }
+    describe '#apis' do
+      subject { target.apis }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::Space) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::Apis) }
+    end
 
-  describe '#space_body' do
-    subject { target.space_body }
+    describe '#bulk_request' do
+      subject { target.bulk_request }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::SpaceBody) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::BulkRequest) }
+    end
 
-  describe '#space_thread' do
-    subject { target.space_thread }
+    describe '#bulk' do
+      subject { target.bulk }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::SpaceThread) }
-  end
+      it { is_expected.to be_a_kind_of(Kintone::Command::BulkRequest) }
+    end
 
-  describe '#space_members' do
-    subject { target.space_members }
+    describe '#file' do
+      subject { target.file }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::SpaceMembers) }
+      it { is_expected.to be_a_kind_of(Kintone::Command::File) }
+    end
   end
 
-  describe '#guests' do
-    subject { target.guests }
+  context 'APIトークン認証の時' do
+    let(:user) { 'token-api' }
+    let(:password) { nil }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::Guests) }
-  end
+    describe '#get' do
+      before(:each) do
+        stub_request(
+            :get,
+            'https://www.example.com/k/v1/path'
+        )
+            .with(
+                query: query,
+                headers: { 'X-Cybozu-API-Token' => 'token-api' }
+            )
+            .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                       headers: { 'Content-type' => 'application/json' })
+      end
 
-  describe '#app' do
-    subject { target.app }
+      subject { target.get(path, params) }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::App) }
-  end
+      let(:path) { '/k/v1/path' }
 
-  describe '#apps' do
-    subject { target.apps }
+      context 'with no params' do
+        subject { target.get(path) }
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::Apps) }
-  end
+        let(:query) { nil }
 
-  describe '#apis' do
-    subject { target.apis }
+        it { is_expected.to eq 'abc' => 'def' }
+      end
+    end
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::Apis) }
-  end
+    describe '#post' do
+      before(:each) do
+        stub_request(
+            :post,
+            'https://www.example.com/k/v1/path'
+        )
+            .with(
+                headers: {
+                  'X-Cybozu-API-Token' => 'token-api',
+                  'Content-Type' => 'application/json'
+                },
+                body: "{\"p1\":\"abc\",\"p2\":\"def\"}"
+            )
+            .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                       headers: { 'Content-type' => 'application/json' })
+      end
+
+      subject { target.post(path, body) }
+      let(:path) { '/k/v1/path' }
+      let(:body) { { 'p1' => 'abc', 'p2' => 'def' } }
 
-  describe '#bulk_request' do
-    subject { target.bulk_request }
+      it { is_expected.to eq 'abc' => 'def' }
+    end
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::BulkRequest) }
-  end
+    describe '#put' do
+      before(:each) do
+        stub_request(
+            :put,
+            'https://www.example.com/k/v1/path'
+        )
+            .with(
+                headers: {
+                  'X-Cybozu-API-Token' => 'token-api',
+                  'Content-Type' => 'application/json'
+                },
+                body: "{\"p1\":\"abc\",\"p2\":\"def\"}"
+            )
+            .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                       headers: { 'Content-type' => 'application/json' })
+      end
+
+      subject { target.put(path, body) }
+      let(:path) { '/k/v1/path' }
+      let(:body) { { 'p1' => 'abc', 'p2' => 'def' } }
 
-  describe '#bulk' do
-    subject { target.bulk }
+      it { is_expected.to eq 'abc' => 'def' }
+    end
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::BulkRequest) }
-  end
+    describe '#delete' do
+      before(:each) do
+        stub_request(
+            :delete,
+            'https://www.example.com/k/v1/path'
+        )
+            .with(
+                body: { 'p1' => 'abc', 'p2' => 'def' }.to_json,
+                headers: { 'X-Cybozu-API-Token' => 'token-api' }
+            )
+            .to_return(body: "{\"abc\":\"def\"}", status: 200,
+                       headers: { 'Content-type' => 'application/json' })
+      end
+
+      subject { target.delete(path, params) }
+      let(:path) { '/k/v1/path' }
+      let(:params) { { 'p1' => 'abc', 'p2' => 'def' } }
 
-  describe '#file' do
-    subject { target.file }
+      it { is_expected.to eq 'abc' => 'def' }
+    end
 
-    it { is_expected.to be_a_kind_of(Kintone::Command::File) }
+    describe '#post_file' do
+      before(:each) do
+        stub_request(
+            :post,
+            'https://www.example.com/k/v1/path'
+        )
+            .with(
+              headers: { 'X-Cybozu-API-Token' => 'token-api' }
+            )
+            .to_return(body: "{\"fileKey\":\"abc\"}", status: 200,
+                       headers: { 'Content-type' => 'application/json' })
+
+        expect(Faraday::UploadIO).to receive(:new)
+                                         .with(path, content_type, original_filename,
+                                               'Content-Disposition' => 'form-data')
+                                         .and_return(attachment)
+      end
+
+      subject { target.post_file(url, path, content_type, original_filename) }
+      let(:attachment) { double('attachment') }
+      let(:url) { '/k/v1/path' }
+      let(:path) { '/path/to/file.txt' }
+      let(:content_type) { 'text/plain' }
+      let(:original_filename) { 'fileName.txt' }
+
+      it { is_expected.to eq 'abc' }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kintone
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Rikiya Kawakami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: kintone API client for Ruby.