kintone 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 802b3540fa57136b666301320c4a78bb5254084f
-  data.tar.gz: 101a717cecfbd0c2f2db6793aeb37444a7b71379
+  metadata.gz: 24a441e5a7cd395f4b7e77d1ef6c8c5fc450ec57
+  data.tar.gz: d2c412b23b6685dde86ae1e68bee11897dc1f1ed
 SHA512:
-  metadata.gz: 85af72a3f02848b43e58286fc938858f488bf750da800a69133839b0ad92f5ee8165321420060df870dd9dd83cde7eaf5810d0f364d6ec4d044fd229e099ed8e
-  data.tar.gz: 7c58ccadb6289b95ba65fdc27d34869e2c7c320eb8c2ecbfe33853e78a55cf1803fb6870598d54743bfe553c7e29ff2dd7d12a0281f7039313194aeff329161a
+  metadata.gz: 1e255c61c186000b3f8071555158bda3289b73e2bc4be110ca50403ac464bbbe1b86af3e6a0b302722f94f7568fe7cba4a8c4cf5734741359d86f38da0c4adf3
+  data.tar.gz: 8ff4d97a4355fc50a22080bee96331a7c0a662567faf5755abd79a1a59b7d4ad85395646aca1885b74eb5072891ecb38c5cf9f5415be0d35481df43fef1242da

data/.rubocop.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-07-24 11:44:58 +0900 using RuboCop version 0.24.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+AllCops:
+  Exclude:
+    - 'Guardfile'
+
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+# Configuration parameters: AllowURI.
+Style/LineLength:
+  Max: 1_00
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rspec, all_after_pass: false, all_on_start: false do
+  watch(%r{spec/.+_spec\.rb$})
+  watch(%r{lib/(.+)\.rb$}) {|m| "spec/#{m[1]}_spec.rb"}
+  watch(%r{lib/(.+)/.+\.rb$}) {|m| "spec/#{m[1]}_spec.rb"}
+end
+
+guard :rubocop, all_on_start: false do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -18,14 +18,15 @@ api = Kintone::Api.new("example.cybozu.com", "Administrator", "cybozu")
 ```
 
 ### Supported API
-- Record retrieval
-- Record register
-- Record update
-- Record delete
-- Format retrieval
-- Permissions
+- [Record retrieval](#record_retrieval)
+- [Record register](#record_register)
+- [Record update](#record_update)
+- [Record delete](#record_delete)
+- [Format retrieval](#format_retrieval)
+- [Permissions](#permissions)
+- [Space management]("space_management")
 
-### Record retrieval
+### <a name="record_retrieval"> Record retrieval
 
 ```ruby
 # Record retrieval(Assign by Record Number)
@@ -38,7 +39,7 @@ query = "updated_time > \"2012-02-03T09:00:00+0900\" and updated_time < \"2012-0
 api.records.get(app, query, fields) # => {"records" => [{...}, ...]}
 ```
 
-### Record register
+### <a name="record_register"> Record register
 
 ```ruby
 # Record register(single record)
@@ -52,7 +53,7 @@ records = [{"number" => {"value" => "123456"}}, {"number" => {"value" => "7890"}
 api.records.create(app, records) # => {"ids" => ["100", "101"]}
 ```
 
-### Record update
+### <a name="record_update"> Record update
 
 ```ruby
 # Record update(single record)
@@ -66,21 +67,21 @@ records = [{"id" => 1, "string_multi" => {"value" => "abcdef"}}, {"id" => 2, "st
 api.records.update(app, records) # => {}
 ```
 
-### Record delete
+### <a name="record_delete"> Record delete
 
 ```ruby
 app = 8; ids = [100, 80]
 api.records.delete(app, ids) # => {}
 ```
 
-### Format retrieval
+### <a name="format_retrieval"> Format retrieval
 
 ```ruby
 app = 4
 api.form.get(app) # => {"properties" => [{...}, ...]}
 ```
 
-### Permissions
+### <a name="permissions"> Permissions
 
 ```ruby
 # App
@@ -99,6 +100,27 @@ rights = [{"code" => "Single_line_text_0", "entities" => [{"entity" => {...}, "a
 api.field_acl.update(id, rights) # => {}
 ```
 
+### <a name="space_management"> Space management
+
+```ruby
+# Space information reference
+id = 1
+api.space.get(id) # => { "id" => "1", "name" => "space", "defaultThread" => "3", "isPrivate" => true, ...}
+
+# Create space
+id = 1; name = "sample space"
+members = [{"entity" => {"type" => "USER", "code" => "user1"}, "isAdmin": true}, ...]
+api.template_space.create(id, name, members, is_guest: true, fixed_member: false) # => {"id" => "1"}
+
+# Space body update
+id = 1; body = "<b>awesome space!</b>"
+api.space_body.update(id, body) # => {}
+
+# Space delete
+id = 1
+api.space.delete(id) # => {}
+```
+
 ### Other examples
 
 ```ruby
@@ -118,4 +140,4 @@ api.post(url, body) # => {"ids" => ["100","101"]}
 api.guest(1).record.get(8, 100)
 ```
 
-see also [kintone developers](https://developers.kintone.com/)
+see also [kintone developers](http://developers.kintone.com/)

data/Rakefile

@@ -1 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task default: :travis
+task travis: [:spec, :rubocop]

data/kintone.gemspec

@@ -1,28 +1,31 @@
 # coding: utf-8
+# rubocop:disable Style/RegexpLiteral
 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.name          = 'kintone'
   spec.version       = Kintone::VERSION
-  spec.authors       = ["Rikiya Kawakami"]
-  spec.email         = ["ricky.k.yang@gmail.com"]
-  spec.summary       = %q{kintone API client for Ruby.}
-  spec.description   = %q{kintone API client for Ruby.}
-  spec.homepage      = "https://github.com/jue58/kintone"
-  spec.license       = "MIT"
+  spec.authors       = ['Rikiya Kawakami']
+  spec.email         = ['ricky.k.yang@gmail.com']
+  spec.summary       = 'kintone API client for Ruby.'
+  spec.description   = 'kintone API client for Ruby.'
+  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.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '~>0.8.9'
-  spec.add_runtime_dependency 'faraday_middleware', '~>0.9.0'
+  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"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
 end

data/lib/kintone.rb

@@ -1,5 +1,5 @@
-require "kintone/version"
-require "kintone/api"
+require 'kintone/version'
+require 'kintone/api'
 
 module Kintone
   # Your code goes here...

data/lib/kintone/api.rb

@@ -8,92 +8,106 @@ require 'kintone/command/form'
 require 'kintone/command/app_acl'
 require 'kintone/command/record_acl'
 require 'kintone/command/field_acl'
+require 'kintone/command/template_space'
+require 'kintone/command/space'
+require 'kintone/command/space_body'
 require 'kintone/api/guest'
 
 class Kintone::Api
-  BASE_PATH = "/k/v1/"
-  COMMAND = "%s.json"
+  BASE_PATH = '/k/v1/'
+  COMMAND = '%s.json'
 
   def initialize(domain, user, password)
     token = Base64.encode64("#{user}:#{password}")
     @connection =
-      Faraday.new(:url => "https://#{domain}",
-                  :headers => {"X-Cybozu-Authorization" => token},
-                  :ssl => false) do |builder|
+      Faraday.new(url: "https://#{domain}",
+                  headers: { 'X-Cybozu-Authorization' => token },
+                  ssl: false) do |builder|
         builder.adapter :net_http
         builder.request :url_encoded
         builder.response :json
-        builder.response :logger
       end
   end
 
   def get_url(command)
-    return BASE_PATH + (COMMAND % command)
+    BASE_PATH + (COMMAND % command)
   end
 
   def guest(space_id)
-    return Kintone::Api::Guest.new(space_id, self)
+    Kintone::Api::Guest.new(space_id, self)
   end
 
-  def get(url, params=nil)
+  def get(url, params = nil)
     response =
       @connection.get do |request|
         request.url url
         request.params = params
       end
-    return response.body
+    response.body
   end
 
   def post(url, body)
     response =
       @connection.post do |request|
         request.url url
-        request.headers["Content-Type"] = "application/json"
+        request.headers['Content-Type'] = 'application/json'
         request.body = body.to_json
       end
-    return response.body
+    response.body
   end
 
   def put(url, body)
     response =
       @connection.put do |request|
         request.url url
-        request.headers["Content-Type"] = "application/json"
+        request.headers['Content-Type'] = 'application/json'
         request.body = body.to_json
       end
-    return response.body
+    response.body
   end
 
-  def delete(url, params=nil)
+  def delete(url, params = nil)
     response =
       @connection.delete do |request|
         request.url url
         request.params = params
       end
-    return response.body
+    response.body
   end
 
   def record
-    return Kintone::Command::Record.new(self)
+    Kintone::Command::Record.new(self)
   end
 
   def records
-    return Kintone::Command::Records.new(self)
+    Kintone::Command::Records.new(self)
   end
 
   def form
-    return Kintone::Command::Form.new(self)
+    Kintone::Command::Form.new(self)
   end
 
   def app_acl
-    return Kintone::Command::AppAcl.new(self)
+    Kintone::Command::AppAcl.new(self)
   end
 
   def record_acl
-    return Kintone::Command::RecordAcl.new(self)
+    Kintone::Command::RecordAcl.new(self)
   end
 
   def field_acl
-    return Kintone::Command::FieldAcl.new(self)
+    Kintone::Command::FieldAcl.new(self)
+  end
+
+  def template_space
+    Kintone::Command::TemplateSpace.new(self)
+  end
+
+  def space
+    Kintone::Command::Space.new(self)
+  end
+
+  def space_body
+    Kintone::Command::SpaceBody.new(self)
   end
 end

data/lib/kintone/api/guest.rb

@@ -5,7 +5,7 @@ class Kintone::Api
   class Guest
     extend Forwardable
 
-    GUEST_PATH = "/k/guest/%s/v1/"
+    GUEST_PATH = '/k/guest/%s/v1/'
 
     def initialize(space_id, api)
       @api = api
@@ -13,31 +13,39 @@ class Kintone::Api
     end
 
     def get_url(command)
-      return @guest_path + (COMMAND % command)
+      @guest_path + (COMMAND % command)
     end
 
     def record
-      return Kintone::Command::Record.new(self)
+      Kintone::Command::Record.new(self)
     end
 
     def records
-      return Kintone::Command::Records.new(self)
+      Kintone::Command::Records.new(self)
     end
 
     def form
-      return Kintone::Command::Form.new(self)
+      Kintone::Command::Form.new(self)
     end
 
     def app_acl
-      return Kintone::Command::AppAcl.new(self)
+      Kintone::Command::AppAcl.new(self)
     end
 
     def record_acl
-      return Kintone::Command::RecordAcl.new(self)
+      Kintone::Command::RecordAcl.new(self)
     end
 
     def field_acl
-      return Kintone::Command::FieldAcl.new(self)
+      Kintone::Command::FieldAcl.new(self)
+    end
+
+    def space
+      Kintone::Command::Space.new(self)
+    end
+
+    def space_body
+      Kintone::Command::SpaceBody.new(self)
     end
 
     def_delegators :@api, :get, :post, :put, :delete

data/lib/kintone/command.rb

@@ -1,3 +1,12 @@
-module Kintone::Command
-  
+require 'kintone/api'
+
+class Kintone::Command
+  def self.path
+    '/'
+  end
+
+  def initialize(api)
+    @api = api
+    @url = @api.get_url(self.class.path)
+  end
 end

data/lib/kintone/command/app_acl.rb

@@ -1,15 +1,11 @@
 require 'kintone/command'
-require 'kintone/api'
 
-class Kintone::Command::AppAcl
-  PATH = "app/acl"
-
-  def initialize(api)
-    @api = api
-    @url = @api.get_url(PATH)
+class Kintone::Command::AppAcl < Kintone::Command
+  def self.path
+    'app/acl'
   end
 
   def update(app, rights)
-    @api.put(@url, {:app => app, :rights => rights})
+    @api.put(@url, app: app, rights: rights)
   end
 end