kintone 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 548e13d447b105ddea94cd11ffc2ca2b882d1a89
-  data.tar.gz: 8c7940cdf780cdc5980e9920326a7307d820976e
+  metadata.gz: 5f270a6f3feb46411a8f630efced0f9240f6715a
+  data.tar.gz: 67f676a7708f96f99be690bd60d9d4e9fe211c5f
 SHA512:
-  metadata.gz: 9f28461efc3dbe61367ee5f178e9585eda7d450c6e56fda8b523b7c3802dbd09d2871d2e34985a6c4d305f956fa6866a48e026f2496b817f4f4a6ed04fd74920
-  data.tar.gz: 2fbf9eb1eb0c53e0247567cf72ccb5355a4f17a4b4b0ba8b3d47dd39b883d971ca2d73656685ca09fbcab1f8ef133c90e360c2de6d985354c5c77aff9c0306a9
+  metadata.gz: 1f6193b7f58e9299c55fb5723fb0b519e838cc483f469b6ec7b458ea767a041d1fa8bb0471df30bfdd9a87dd411650d04847616a1f7559bf20e43ab759113d21
+  data.tar.gz: 889ab4189f4ced1bc9c9a873bf52a7731f0dfcfe2dead65b713b6f45d0ba1aced9dad75de38a568e150d3cfd0b0ce4aba21313b9a712232c708d589c0cbadd54

data/README.md

@@ -1,6 +1,6 @@
 # kintone
 
-クラウド型データベースサービスkintone( https://kintone.cybozu.com/ )のREST APIを使用するためのgemです。
+クラウド型データベースサービス[kintone](https://kintone.cybozu.com/)のREST APIを使用するためのgemです。
 
 ## Installation
 
@@ -24,6 +24,7 @@ api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
 - レコード登録
 - レコード更新
 - レコード削除
+- フォーム設計情報取得
 
 ### レコード取得
 
@@ -73,14 +74,24 @@ app = 8; ids = [100, 80]
 api.records.delete(app, ids) # => {}
 ```
 
+### フォーム設計情報取得
+
+```ruby
+app = 4
+api.form.get(app) # => {"properties" => [{...}, ...]}
+```
+
 ### 他APIへのリクエスト
 
 ```ruby
 # フォーム設計情報取得
-api.get("form.json", {"app" => 4}) # => {"properties" => [{...}, ...]}
+url = api.get_url("form")
+api.get(url, {"app" => 4}) # => {"properties" => [{...}, ...]}
+
 # 複数レコード登録
+url = api.get_url("records")
 body = {"app" => 7, "records" => [{...}, ...]}
-api.post("records.json", body) # => {"ids" => ["100","101"]}
+api.post(url, body) # => {"ids" => ["100","101"]}
 ```
 
 ### ゲストスペースへのAPIリクエスト
@@ -89,4 +100,4 @@ api.post("records.json", body) # => {"ids" => ["100","101"]}
 api.guest(1).record.get(8, 100)
 ```
 
-APIの仕様等については、cybozu.com developers( https://developers.cybozu.com/ )を見てください。
+APIの仕様等については、[cybozu.com developers](https://developers.cybozu.com/)を見てください。

data/lib/kintone/api.rb

@@ -4,14 +4,15 @@ require 'base64'
 require 'json'
 require 'kintone/command/record'
 require 'kintone/command/records'
+require 'kintone/command/form'
+require 'kintone/api/guest'
 
 class Kintone::Api
-  BASE_PATH = "/k%s/v1/"
-  SPACE_PATH = "/guest/%s"
+  BASE_PATH = "/k/v1/"
+  COMMAND = "%s.json"
 
   def initialize(domain, user, password)
     @token = Base64.encode64("#{user}:#{password}")
-    @base_path = BASE_PATH % nil
     @connection =
       Faraday.new(:url => "https://#{domain}", :ssl => false) do |builder|
         builder.adapter :net_http
@@ -21,14 +22,15 @@ class Kintone::Api
       end
   end
 
-  def guest(space)
-    space_path = SPACE_PATH % space if space.to_s.match(/^[1-9][0-9]*$/)
-    @base_path = BASE_PATH % space_path
-    return self
+  def get_url(command)
+    return BASE_PATH + (COMMAND % command)
   end
 
-  def get(path, params=nil)
-    url = @base_path + path
+  def guest(space_id)
+    return Kintone::Api::Guest.new(space_id, self)
+  end
+
+  def get(url, params=nil)
     response =
       @connection.get do |request|
         request.url url
@@ -38,8 +40,7 @@ class Kintone::Api
     return response.body
   end
 
-  def post(path, body)
-    url = @base_path + path
+  def post(url, body)
     response =
       @connection.post do |request|
         request.url url
@@ -49,8 +50,7 @@ class Kintone::Api
     return response.body
   end
 
-  def put(path, body)
-    url = @base_path + path
+  def put(url, body)
     response =
       @connection.put do |request|
         request.url url
@@ -60,8 +60,7 @@ class Kintone::Api
     return response.body
   end
 
-  def delete(path, params=nil)
-    url = @base_path + path
+  def delete(url, params=nil)
     response =
       @connection.delete do |request|
         request.url url
@@ -78,4 +77,8 @@ class Kintone::Api
   def records
     Kintone::Command::Records.new(self)
   end
+
+  def form
+    Kintone::Command::Form.new(self)
+  end
 end

data/lib/kintone/api/guest.rb

@@ -0,0 +1,33 @@
+require 'forwardable'
+require 'kintone/api'
+
+class Kintone::Api
+  class Guest
+    extend Forwardable
+
+    GUEST_PATH = "/k/guest/%s/v1/"
+
+    def initialize(space_id, api)
+      @api = api
+      @guest_path = GUEST_PATH % space_id
+    end
+
+    def get_url(command)
+      return @guest_path + (COMMAND % command)
+    end
+
+    def record
+      return Kintone::Command::Record.new(self)
+    end
+
+    def records
+      return Kintone::Command::Records.new(self)
+    end
+
+    def form
+      return Kintone::Command::Form.new(self)
+    end
+
+    def_delegators :@api, :get, :post, :put, :delete
+  end
+end

data/lib/kintone/command/form.rb

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

data/lib/kintone/command/record.rb

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

data/lib/kintone/command/records.rb

@@ -2,29 +2,30 @@ require 'kintone/command'
 require 'kintone/api'
 
 class Kintone::Command::Records
-  PATH = "records.json"
+  PATH = "records"
 
   def initialize(api)
     @api = api
+    @url = @api.get_url(PATH)
   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)
+    return @api.get(@url, params)
   end
 
   def create(app, records)
-    return @api.post(PATH, {:app => app, :records => records})
+    return @api.post(@url, {:app => app, :records => records})
   end
 
   def update(app, records)
-    return @api.put(PATH, {:app => app, :records => records})
+    return @api.put(@url, {: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)
+    return @api.delete(@url, params)
   end
 end

data/lib/kintone/version.rb

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

data/spec/api/guest_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'kintone/api/guest'
+require 'kintone/api'
+
+describe Kintone::Api::Guest do
+  let(:target) { Kintone::Api::Guest.new(space, api) }
+  let(:space) { 1 }
+  let(:api) { Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu") }
+
+  describe "#get_url" do
+    subject { target.get_url(command) }
+    context "" do
+      let(:command) { "path" }
+
+      it { expect(subject).to eq("/k/guest/1/v1/path.json") }
+    end
+  end
+end

data/spec/api_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'kintone/api'
+require 'kintone/api/guest'
 require 'kintone/command/record'
 require 'kintone/command/records'
 
@@ -9,26 +10,33 @@ describe Kintone::Api do
   let(:user) { "Administrator" }
   let(:password) { "cybozu" }
 
-  describe "guest" do
-    before(:each) do
-      subject
+  describe "#get_url" do
+    subject { target.get_url(command) }
+
+    context "" do
+      let(:command) { "path" }
+      it { expect(subject).to eq("/k/v1/path.json") }
     end
+  end
 
+  describe "#guest" do
     subject { target.guest(space) }
 
     context "引数が数値の1の時" do
       let(:space) { 1 }
-      it { expect(target.instance_variable_get(:@base_path)).to eq("/k/guest/1/v1/") }
+
+      it { expect(subject).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 }
-      it { expect(target.instance_variable_get(:@base_path)).to eq("/k/v1/") }
+      xit { expect(subject.instance_variable_get(:@guest_path)).to eq("/k/guest//v1/") }
     end
 
     context "引数に数字以外の文字が含まれる時" do
       let(:space) { "2.1" }
-      it { expect(target.instance_variable_get(:@base_path)).to eq("/k/v1/") }
+      xit { expect(subject.instance_variable_get(:@guest_path)).to eq("/k/guest//v1/") }
     end
   end
 
@@ -43,7 +51,7 @@ describe Kintone::Api do
     end
 
     subject { target.get(path, params) }
-    let(:path) { "path" }
+    let(:path) { "/k/v1/path" }
     let(:params) { {"p1" => "abc", "p2" => "def"} }
 
     it { expect(subject).to eq({"abc" => "def"}) }
@@ -61,7 +69,7 @@ describe Kintone::Api do
     end
 
     subject { target.post(path, body) }
-    let(:path) { "path" }
+    let(:path) { "/k/v1/path" }
     let(:body) { {"p1" => "abc", "p2" => "def"} }
 
     it { expect(subject).to eq({"abc" => "def"}) }
@@ -79,7 +87,7 @@ describe Kintone::Api do
     end
 
     subject { target.put(path, body) }
-    let(:path) { "path" }
+    let(:path) { "/k/v1/path" }
     let(:body) { {"p1" => "abc", "p2" => "def"} }
 
     it { expect(subject).to eq({"abc" => "def"}) }
@@ -96,7 +104,7 @@ describe Kintone::Api do
     end
 
     subject { target.delete(path, params) }
-    let(:path) { "path" }
+    let(:path) { "/k/v1/path" }
     let(:params) { {"p1" => "abc", "p2" => "def"} }
 
     it { expect(subject).to eq({"abc" => "def"}) }
@@ -113,4 +121,10 @@ describe Kintone::Api do
 
     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
 end

data/spec/command/form_spec.rb

@@ -0,0 +1,25 @@
+require 'kintone/command/form'
+require 'kintone/api'
+
+describe Kintone::Command::Form do
+  let(:target) { Kintone::Command::Form.new(api) }
+  let(:api) { Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu") }
+
+  describe "#get" do
+    subject { target.get(app) }
+
+    context "" do
+      before(:each) do
+        stub_request(
+          :get,
+          "https://example.cybozu.com/k/v1/form.json?app=4"
+        ).
+        to_return(:body => "{\"result\":\"ok\"}", :status => 200)
+      end
+
+      let(:app) { 4 }
+
+      it { expect(subject).to eq({"result" => "ok"})}
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kintone
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Rikiya Kawakami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -110,11 +110,15 @@ files:
 - kintone.gemspec
 - lib/kintone.rb
 - lib/kintone/api.rb
+- lib/kintone/api/guest.rb
 - lib/kintone/command.rb
+- lib/kintone/command/form.rb
 - lib/kintone/command/record.rb
 - lib/kintone/command/records.rb
 - lib/kintone/version.rb
+- spec/api/guest_spec.rb
 - spec/api_spec.rb
+- spec/command/form_spec.rb
 - spec/command/record_spec.rb
 - spec/command/records_spec.rb
 - spec/spec_helper.rb
@@ -143,7 +147,9 @@ signing_key:
 specification_version: 4
 summary: kintone API client for Ruby.
 test_files:
+- spec/api/guest_spec.rb
 - spec/api_spec.rb
+- spec/command/form_spec.rb
 - spec/command/record_spec.rb
 - spec/command/records_spec.rb
 - spec/spec_helper.rb