kintone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea0ac21ce99dbd0d7a7721f75a6ab200186aeabd
+  data.tar.gz: a52bb9292342a21c5d67821cfb2aa5fc05ecda82
+SHA512:
+  metadata.gz: c549d6b8129703ef3b38879675e95e92a6dbbf01f3edbcc55dcdb4d7e89757c5f0295fa7937583a69b279f9d5faf386fc34db49f0136569bd7fc4d99ddfb7d06
+  data.tar.gz: dc38ec2c27cf9b0025e89628044ef7b173675dd2250122efde24b557bacf8314012825961e54eb3709906484dcedd5ec26a84049eaac410d796709ba887707db

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/

data/.rspec

@@ -0,0 +1 @@
+-c -f doc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kintone.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rikiya Kawakami
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# Kintone
+
+クラウド型データベースサービスKintone( https://kintone.cybozu.com/ )のREST APIを使用するためのgemです。
+
+## Installation
+
+    gem install kintone
+
+又は、Gemfileに
+
+    gem 'kintone'
+
+と書いて、`bundle install` コマンドを実行してください。
+
+## Usage
+
+    require 'kintone'
+
+### レコード1件の取得/登録/更新
+
+	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, レコード番号, レコードデータ)
+
+### 他APIへのリクエスト
+
+	# フォーム設計情報取得
+	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)
+
+APIの仕様等については、cybozu.com developers( https://developers.cybozu.com/ )を見てください。

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kintone.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kintone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kintone"
+  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.homepage      = "https://github.com/jue58/kintone"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'faraday', '~>0.8.9'
+  spec.add_runtime_dependency 'faraday_middleware', '~>0.9.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/lib/kintone.rb

@@ -0,0 +1,6 @@
+require "kintone/version"
+require "kintone/api"
+
+module Kintone
+  # Your code goes here...
+end

data/lib/kintone/api.rb

@@ -0,0 +1,76 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'base64'
+require 'json'
+require 'kintone/command/record'
+
+class Kintone::Api
+  BASE_PATH = "/k%s/v1/"
+  SPACE_PATH = "/guest/%s"
+
+  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
+        builder.request :url_encoded
+        builder.response :json
+        builder.response :logger
+      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
+  end
+
+  def get(path, params=nil)
+    url = @base_path + path
+    response =
+      @connection.get do |request|
+        request.url url
+        request.params = params
+        request.headers = {"X-Cybozu-Authorization" => @token}
+      end
+    return response.body
+  end
+
+  def post(path, body)
+    url = @base_path + path
+    response =
+      @connection.post do |request|
+        request.url url
+        request.headers = {"X-Cybozu-Authorization" => @token, "Content-Type" => "application/json"}
+        request.body = body.to_json
+      end
+    return response.body
+  end
+
+  def put(path, body)
+    url = @base_path + path
+    response =
+      @connection.put do |request|
+        request.url url
+        request.headers = {"X-Cybozu-Authorization" => @token, "Content-Type" => "application/json"}
+        request.body = body.to_json
+      end
+    return response.body
+  end
+
+  def delete(path, params=nil)
+    url = @base_path + path
+    response =
+      @connection.delete do |request|
+        request.url url
+        request.params = params
+        request.headers = {"X-Cybozu-Authorization" => @token}
+      end
+    return response.body
+  end
+
+  def record
+    Kintone::Command::Record.new(self)
+  end
+end

data/lib/kintone/command/record.rb

@@ -0,0 +1,23 @@
+require 'kintone/api'
+
+module Kintone::Command
+  class Record
+    PATH = "record.json"
+
+    def initialize(api)
+      @api = api
+    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 update(app, id, record)
+      @api.put(PATH, {:app => app, :id => id, :record => record})
+    end
+  end
+end

data/lib/kintone/version.rb

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

data/spec/api_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+require 'kintone/api'
+
+describe Kintone::Api do
+  let(:target) { Kintone::Api.new(domain, user, password) }
+  let(:domain) { "www.example.com" }
+  let(:user) { "Administrator" }
+  let(:password) { "cybozu" }
+
+  describe "guest" do
+    before(:each) do
+      subject
+    end
+
+    subject { target.guest(space) }
+
+    context "引数が数値の1の時" do
+      let(:space) { 1 }
+      it { expect(target.instance_variable_get(:@base_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/") }
+    end
+
+    context "引数に数字以外の文字が含まれる時" do
+      let(:space) { "2.1" }
+      it { expect(target.instance_variable_get(:@base_path)).to eq("/k/v1/") }
+    end
+  end
+
+  describe "#get" do
+    before(:each) do
+      stub_request(
+        :get,
+        "https://www.example.com/k/v1/path?p1=abc&p2=def"
+      ).
+      with(:headers => {"X-Cybozu-Authorization" => "QWRtaW5pc3RyYXRvcjpjeWJvenU="}).
+      to_return(:body => "{\"abc\":\"def\"}", :status => 200)
+    end
+
+    subject { target.get(path, params) }
+    let(:path) { "path" }
+    let(:params) { {"p1" => "abc", "p2" => "def"} }
+
+    it { expect(subject).to eq({"abc" => "def"}) }
+  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\"}").
+      to_return(:body => "{\"abc\":\"def\"}", :status => 200)
+    end
+
+    subject { target.post(path, body) }
+    let(:path) { "path" }
+    let(:body) { {"p1" => "abc", "p2" => "def"} }
+
+    it { expect(subject).to eq({"abc" => "def"}) }
+  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)
+    end
+
+    subject { target.put(path, body) }
+    let(:path) { "path" }
+    let(:body) { {"p1" => "abc", "p2" => "def"} }
+
+    it { expect(subject).to eq({"abc" => "def"}) }
+  end
+  
+  describe "#delete" do
+    before(:each) do
+      stub_request(
+        :delete,
+        "https://www.example.com/k/v1/path?p1=abc&p2=def"
+      ).
+      with(:headers => {"X-Cybozu-Authorization" => "QWRtaW5pc3RyYXRvcjpjeWJvenU="}).
+      to_return(:body => "{\"abc\":\"def\"}", :status => 200)
+    end
+
+    subject { target.delete(path, params) }
+    let(:path) { "path" }
+    let(:params) { {"p1" => "abc", "p2" => "def"} }
+
+    it { expect(subject).to eq({"abc" => "def"}) }
+  end
+end

data/spec/command/record_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'kintone/command/record'
+require 'kintone/api'
+
+describe Kintone::Command::Record do
+  let(:target) { Kintone::Command::Record.new(api) }
+  let(:api) { Kintone::Api.new("www.example.com", "Administrator", "cybozu") }
+
+  describe "#get" do
+    subject { target.get(app, id) }
+
+    context "引数が整数型の時" do
+      before(:each) do
+        stub_request(
+          :get,
+          "https://www.example.com/k/v1/record.json?app=8&id=100"
+        ).
+        to_return(:body => "{\"result\":\"ok\"}", :status => 200)
+      end
+
+      let(:app) { 8 }
+      let(:id) { 100 }
+
+      it { expect(subject).to eq({"result" => "ok"}) }
+    end
+
+    context "引数が数字の文字列の時" do
+      before(:each) do
+        stub_request(
+          :get,
+          "https://www.example.com/k/v1/record.json?app=8&id=100"
+        ).
+        to_return(:body => "{\"result\":\"ok\"}", :status => 200)
+      end
+
+      let(:app) { "8" }
+      let(:id) { "100" }
+
+      it { expect(subject).to eq({"result" => "ok"}) }
+    end
+  end
+
+  describe "#create" do
+    def hash_record
+      return {
+        "number" => {"value" => "123456"},
+        "rich_editor" => {"value" => "testtest"},
+        "user_select" => {"value" => [{"code" => "sato"}]}
+      }
+    end
+    before(:each) do
+      stub_request(
+        :post,
+        "https://www.example.com/k/v1/record.json"
+      ).
+      with(:body => {"app" => 7, "record" => hash_record}.to_json).
+      to_return(:body => "{\"id\":\"100\"}", :status => 200)
+    end
+
+    subject { target.create(app, record) }
+
+    let(:app) { 7 }
+    let(:record) { hash_record }
+
+    it { expect(subject).to eq({"id" => "100"}) }
+  end
+
+  describe "#update" do
+    def hash_record
+      return {
+        "string_multi" => {"value" => "character string is changed"}
+      }
+    end
+
+    before(:each) do
+      stub_request(
+        :put,
+        "https://www.example.com/k/v1/record.json"
+      ).
+      with(:body => {"app" => 4, "id" => 1, "record" => hash_record}.to_json).
+      to_return(:body => "{}", :status => 200)
+    end
+
+    subject { target.update(app, id, record) }
+
+    let(:app) { 4 }
+    let(:id) { 1 }
+    let(:record) { hash_record }
+
+    it { expect(subject).to eq({}) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'kintone'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: kintone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rikiya Kawakami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Kintone API client.
+email:
+- ricky.k.yang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kintone.gemspec
+- lib/kintone.rb
+- lib/kintone/api.rb
+- lib/kintone/command/record.rb
+- lib/kintone/version.rb
+- spec/api_spec.rb
+- spec/command/record_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jue58/kintone
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Kintone API client.
+test_files:
+- spec/api_spec.rb
+- spec/command/record_spec.rb
+- spec/spec_helper.rb
+has_rdoc: