activeresource-chatwork 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a946e0834391b63e300f5047b21366d3ea7bcd6
+  data.tar.gz: cf72d30e77cfa7df2a5716e505e10735e705edd5
+SHA512:
+  metadata.gz: 7ede91450a5b9688e6780d0595efaede1841001e97a77bc01b5b658a50bda35c889b74e66d7a5d058ea85c35f9c31cfe7b8c9aa43cb24d39068d3b66565b5f2b
+  data.tar.gz: 819d537a5723055e9d72830a29a208e1b55769eca00d93d2be4aee203994b42f8bf61a409af7080514d42b63b507adabcc2c5195ef0e94179c8a07ac3771c06f

data/.editorconfig

@@ -0,0 +1,7 @@
+
+root = true
+
+[*.rb]
+indent_size = 2
+indent_style = space
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,13 @@
+=======
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+vendor
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/AsciiComments:
+  Exclude:
+    - '**/*'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Shingo Inoue
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Shingo Inoue
+
+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,158 @@
+# activeresource-chatwork
+[![CircleCI](https://circleci.com/gh/Leko/activeresource-chatwork/tree/master.svg?style=svg)](https://circleci.com/gh/Leko/activeresource-chatwork/tree/master)
+[![codecov](https://codecov.io/gh/Leko/activeresource-chatwork/branch/master/graph/badge.svg)](https://codecov.io/gh/Leko/activeresource-chatwork)
+
+ActiveResource classes for Chatwork API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activeresource-chatwork'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activeresource-chatwork
+
+## Usage
+
+### Setup
+```ruby
+ENV['CHATWORK_TOKEN'] = 'YOUR_CHATWORK_API_TOKEN'
+```
+
+### Contacts
+```ruby
+# GET /v1/contacts
+contacts = Chatwork::Contact.all
+```
+
+### My
+```ruby
+# GET /v1/my/status
+status = Chatwork::My.status
+
+# GET /v1/my/tasks?status=open
+tasks = Chatwork::My.tasks status: Chatwork::Task::STATUS_OPEN
+```
+
+### Rooms
+```ruby
+# GET /v1/rooms
+rooms = Chatwork::Room.all
+
+# GET /v1/rooms/xxx
+room = Chatwork::Room.find xxx
+
+# POST /v1/rooms
+params = {
+  name: 'xxx',
+  members_admin_ids: [yyy],
+  icon_preset: Chatwork::Room::ICON_GROUP
+  # show all icon constants -> Chatwork::Room.constants.grep(/ICON_/)
+}
+room = Chatwork::Room.create params
+
+# PUT /v1/rooms/xxx
+room.name = 'xxx'
+room.save
+
+# DELETE /v1/rooms/xxx
+# show all action constants -> Chatwork::Room.constants.grep(/ACTION_/)
+Chatwork::Room.delete(room.id, action_type: Chatwork::Room::ACTION_DELETE)
+```
+
+### Messages
+```ruby
+# GET /v1/rooms/xxx/messages
+params = {params: {force: 1, room_id: xxx}}
+messages = Chatwork::Message.all params
+# or
+room = Chatwork::Room.find xxx
+messages = room.messages
+
+# GET /v1/rooms/xxx/messages/yyy
+params = {params: {room_id: xxx}}
+message = Chatwork::Message.find yyy, params
+# or
+room = Chatwork::Room.find xxx
+message = room.message yyy
+
+# POST /v1/rooms/xxx/messages
+message = Chatwork::Message.new body: 'yyy'
+message.prefix_options[:room_id] = xxx
+message.save
+```
+
+### Members
+```ruby
+# GET /v1/rooms/xxx/members
+params = {params: {room_id: xxx}}
+members = Chatwork::Member.all params
+# or
+room = Chatwork::Room.find xxx
+members = room.members
+
+# PUT /v1/rooms/xxx/members
+room = Chatwork::Room.find xxx
+room.update_members members_admin_ids: [yyy, zzz].join(',')
+```
+
+### Tasks
+```ruby
+# GET /v1/rooms/xxx/tasks
+tasks = Chatwork::Contact.all
+# or
+room = Chatwork::Room.find xxx
+tasks = room.tasks
+
+# GET /v1/rooms/xxx/tasks/yyy
+params = { params: { room_id: xxx } }
+tasks = Chatwork::Task.all params
+# or
+room = Chatwork::Room.find xxx
+task = room.task(yyy)
+
+# POST /v1/rooms/xxx/tasks
+task = Chatwork::Task.new(body: 'some task', to_ids: [yyy, zzz])
+task.prefix_options[:room_id] = xxx
+task.save
+```
+
+### Files
+```ruby
+# GET /v1/rooms/xxx/files
+params = { params: { room_id: xxx } }
+files = Chatwork::File.all params
+# or
+room = Chatwork::Room.find xxx
+files = room.files
+
+# GET /v1/rooms/xxx/files/yyy
+file = Chatwork::Contact.all
+# or
+room = Chatwork::Room.find xxx
+file = room.file(yyy)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Leko/activeresource-chatwork.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activeresource-chatwork.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chatwork/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activeresource-chatwork'
+  spec.version       = Chatwork::VERSION
+  spec.authors       = ['Leko']
+  spec.email         = ['leko.noor@gmail.com']
+
+  spec.summary       = 'ActiveResource classes for Chatwork API'
+  spec.homepage      = 'https://github.com/Leko/activeresource-chatwork'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activeresource'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'dotenv'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chatwork'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path=vendor/bundle --jobs=4 --retry=3

data/circle.yml

@@ -0,0 +1,18 @@
+dependencies:
+  override:
+    - ./bin/setup
+
+test:
+  override:
+    - bundle exec rubocop
+    - bundle exec rake spec
+
+deployment:
+  rubygems:
+    branch: master
+    commands:
+      - curl -u Leko:$RUBYGEMS_PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
+      - git config user.name Leko
+      - git config user.email $RUBYGEMS_EMAIL
+      - bundle exec rake build
+      - bundle exec rake release

data/lib/chatwork.rb

@@ -0,0 +1,14 @@
+require 'chatwork/version'
+
+# Define autoloads
+module Chatwork
+  autoload :Base, 'chatwork/base'
+  autoload :Contact, 'chatwork/contact'
+  autoload :My, 'chatwork/my'
+  autoload :Room, 'chatwork/room'
+  autoload :Message, 'chatwork/message'
+  autoload :Member, 'chatwork/member'
+  autoload :Task, 'chatwork/task'
+  autoload :File, 'chatwork/file'
+  autoload :NestOfRoom, 'chatwork/nest_of_room'
+end

data/lib/chatwork/base.rb

@@ -0,0 +1,47 @@
+require 'uri'
+require 'json'
+require 'active_resource'
+require 'active_resource/formats/json_format'
+
+module Chatwork
+  #
+  # Chatwork API用のフォーマッター
+  #
+  # 送信は`x-www-form-urlencoded`に対しデコードは`application/json`という特殊な要件
+  # を吸収するために実装した。Chatwork以外で使用するケースはないと判断しここに置いている
+  class FormToJsonParser
+    include ActiveResource::Formats::JsonFormat
+
+    def mime_type
+      'application/x-www-form-urlencoded'
+    end
+
+    def decode(json)
+      ActiveSupport::JSON.decode(json)
+    end
+  end
+
+  #
+  # ChatworkのAPI通信をする際の基底クラス
+  #
+  # APIキーの設定やフォーマッタの設定など、共通で必要な設定をここで行う
+  # Chatwork APIを扱う際にはこのクラスを継承すること
+  class Base < ActiveResource::Base
+    headers['X-ChatWorkToken'] = ENV['CHATWORK_TOKEN']
+
+    self.site = 'https://api.chatwork.com/v1'
+    self.format = FormToJsonParser.new
+    self.include_format_in_path = false
+
+    def to_json(options = {})
+      json = if include_root_in_json
+               super({ root: self.class.element_name }.merge(options))
+             else
+               super(options)
+             end
+      hash = JSON.parse(json)
+
+      URI.encode_www_form(hash)
+    end
+  end
+end

data/lib/chatwork/contact.rb

@@ -0,0 +1,9 @@
+
+module Chatwork
+  # /contacts
+  # see http://developer.chatwork.com/ja/endpoint_contacts.html
+  class Contact < Base
+    self.collection_name = 'contacts'
+    self.primary_key = 'account_id'
+  end
+end

data/lib/chatwork/file.rb

@@ -0,0 +1,12 @@
+
+module Chatwork
+  # /rooms/xxx/files
+  # see http://developer.chatwork.com/ja/endpoint_rooms.html
+  class File < Base
+    include Chatwork::NestOfRoom
+
+    self.prefix = '/v1/rooms/:room_id/'
+    self.collection_name = 'files'
+    self.primary_key = 'file_id'
+  end
+end

data/lib/chatwork/member.rb

@@ -0,0 +1,12 @@
+
+module Chatwork
+  # /rooms/xxx/members
+  # see http://developer.chatwork.com/ja/endpoint_rooms.html
+  class Member < Base
+    include Chatwork::NestOfRoom
+
+    self.prefix = '/v1/rooms/:room_id/'
+    self.collection_name = 'members'
+    self.primary_key = 'account_id'
+  end
+end

data/lib/chatwork/message.rb

@@ -0,0 +1,12 @@
+
+module Chatwork
+  # /rooms/xxx/messages
+  # see http://developer.chatwork.com/ja/endpoint_rooms.html
+  class Message < Base
+    include Chatwork::NestOfRoom
+
+    self.prefix = '/v1/rooms/:room_id/'
+    self.collection_name = 'messages'
+    self.primary_key = 'message_id'
+  end
+end

data/lib/chatwork/my.rb

@@ -0,0 +1,16 @@
+
+module Chatwork
+  # /my
+  # see http://developer.chatwork.com/ja/endpoint_my.html
+  class My < Base
+    self.collection_name = 'my'
+
+    def self.status
+      get(:status)
+    end
+
+    def self.tasks(params = {})
+      get(:tasks, params).map { |t| Chatwork::Task.new(t, true) }
+    end
+  end
+end

data/lib/chatwork/nest_of_room.rb

@@ -0,0 +1,8 @@
+module Chatwork
+  # Utility for /rooms/xxx/* route classes
+  module NestOfRoom
+    def room
+      Room.find(prefix_options[:room_id])
+    end
+  end
+end

data/lib/chatwork/room.rb

@@ -0,0 +1,67 @@
+module Chatwork
+  # /rooms
+  # see http://developer.chatwork.com/ja/endpoint_rooms.html
+  class Room < Base
+    ACTION_LEAVE = 'leave'.freeze
+    ACTION_DELETE = 'delete'.freeze
+
+    ICON_GROUP = 'group'.freeze
+    ICON_CHECK = 'check'.freeze
+    ICON_DOCUMENT = 'document'.freeze
+    ICON_MEETING = 'meeting'.freeze
+    ICON_EVENT = 'event'.freeze
+    ICON_PROJECT = 'project'.freeze
+    ICON_BUSINESS = 'business'.freeze
+    ICON_STUDY = 'study'.freeze
+    ICON_SECURITY = 'security'.freeze
+    ICON_STAR = 'star'.freeze
+    ICON_IDEA = 'idea'.freeze
+    ICON_HEART = 'heart'.freeze
+    ICON_MAGCUP = 'magcup'.freeze
+    ICON_BEER = 'beer'.freeze
+    ICON_MUSIC = 'music'.freeze
+    ICON_SPORTS = 'sports'.freeze
+    ICON_TRAVEL = 'travel'.freeze
+
+    self.collection_name = 'rooms'
+    self.primary_key = 'room_id'
+
+    def messages(params = {})
+      Message.all(params: subroute_params(params))
+    end
+
+    def message(pk)
+      Message.find(pk, params: subroute_params)
+    end
+
+    def members(params = {})
+      Member.all(params: subroute_params(params))
+    end
+
+    def update_members(params = {})
+      put(:members, params)
+    end
+
+    def files(params = {})
+      File.all(params: subroute_params(params))
+    end
+
+    def file(pk)
+      File.find(pk, params: subroute_params)
+    end
+
+    def tasks(params = {})
+      Task.all(params: subroute_params(params))
+    end
+
+    def task(pk)
+      Task.find(pk, params: subroute_params)
+    end
+
+    private
+
+    def subroute_params(additional = {})
+      { room_id: room_id }.merge(additional)
+    end
+  end
+end

data/lib/chatwork/task.rb

@@ -0,0 +1,15 @@
+
+module Chatwork
+  # /rooms/xxx/tasks
+  # see http://developer.chatwork.com/ja/endpoint_rooms.html
+  class Task < Base
+    include Chatwork::NestOfRoom
+
+    STATUS_OPEN = 'open'.freeze
+    STATUS_DONE = 'done'.freeze
+
+    self.prefix = '/v1/rooms/:room_id/'
+    self.collection_name = 'tasks'
+    self.primary_key = 'task_id'
+  end
+end

data/lib/chatwork/version.rb

@@ -0,0 +1,3 @@
+module Chatwork
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: activeresource-chatwork
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Leko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  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: codecov
+  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: dotenv
+  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: 
+email:
+- leko.noor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- activeresource-chatwork.gemspec
+- bin/console
+- bin/setup
+- circle.yml
+- lib/chatwork.rb
+- lib/chatwork/base.rb
+- lib/chatwork/contact.rb
+- lib/chatwork/file.rb
+- lib/chatwork/member.rb
+- lib/chatwork/message.rb
+- lib/chatwork/my.rb
+- lib/chatwork/nest_of_room.rb
+- lib/chatwork/room.rb
+- lib/chatwork/task.rb
+- lib/chatwork/version.rb
+homepage: https://github.com/Leko/activeresource-chatwork
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveResource classes for Chatwork API
+test_files: []