chatwork 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be16993941272b82492aa6671c2cce25e9ea8a4d
-  data.tar.gz: 63c1282e35926da56a30e5a1cca103633414fd02
+SHA256:
+  metadata.gz: 5c77e7a8ed9f1542d07d0a5358aee0f0a47df235629691a33824d48b743fb1c2
+  data.tar.gz: d1ab0c06c73e6fc2adb820bedfbe81b7fdda3935d601d2084067dcaee3562aa8
 SHA512:
-  metadata.gz: 33cdf63bf2505a9a02da3958f86ed11851e01838a75da820cb6b67ba3db401686aeb746a05d68f25b1be7a33b8274d4b6b555677b2f66772cbbf84e2b5e96c37
-  data.tar.gz: dce5ad9a60dcb6f843761055fd122a8414472d97f343198466e3b63c0238514a5455126e4bdb6d75af95fa02d12c3629c7aacec41fb94fa999193800985a81af
+  metadata.gz: c1e4a88d1c57069063ed23917bb9df6336f7ee8493c166083ebeb9feceb2e35c59af9e01d19c3b887506d869d4fa0a4c69b0d61f4be6e5b4b96dbedb0e51d2c0
+  data.tar.gz: d12ffa27c12910c660d14f6c72b275d3a1a8fa656eac0c2c6a388ceb5d708424269a75ecee9d190c0009896f843e01c01e195e0e593a5d77e49ea1c47231f193

data/.env.example

@@ -0,0 +1,4 @@
+CHATWORK_API_TOKEN=
+CHATWORK_ACCESS_TOKEN=
+CHATWORK_CLIENT_ID=
+CHATWORK_CLIENT_SECRET=

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 .ruby-gemset
 .ruby-version
+.env

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "api"]
+	path = api
+	url = https://github.com/chatwork/api.git

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  onkcop:
+    - "config/rubocop.yml"
+    - "config/rspec.yml"
+
+require: rubocop-rspec
+
+# module name is `ChatWork`, but I want to use `chatwork` as filename
+RSpec/FilePath:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,26 @@
+sudo: false
+language: ruby
+rvm:
+- 2.1
+- 2.2
+- 2.3
+- 2.4.1
+- 2.5.0
+- ruby-head
+bundler_args: "--jobs=2"
+cache: bundler
+before_install:
+- gem update --system --no-document
+- gem install bundler -v 1.16.1 --no-document
+script:
+- bundle exec rake spec
+- bundle exec rubocop
+branches:
+  only:
+  - master
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+env:
+  global:
+    secure: Ntdheemdu1GavPR/3kPfQg1tR13FTP0jE9KxsSKcG32VbIzM69l22OXXwYttFexMhA1dMNytv5bKGIszeiO+YjwzDXkcDHF7ZULc24epsGCOVfNax4g47Q+Lgt2kpAsx8V/8/SIpK7VeBhc2nPvhAKPjTZ8ddN2gLHk4wifLRFA=

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--no-private

data/CHANGELOG.md

@@ -1,4 +1,36 @@
 # Change Log
+## Unreleased
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.6.0...master)
+
+## v0.6.0
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.5.0...v0.6.0)
+
+* Support all ChatWork APIs
+  * https://github.com/asonas/chatwork-ruby/pull/34
+* raise error when status 4xx and 5xx
+  * https://github.com/asonas/chatwork-ruby/pull/35
+* Returns `Hashie::Mash` instead of `Hash`
+  * https://github.com/asonas/chatwork-ruby/pull/36
+* and many refactorings!
+  * https://github.com/asonas/chatwork-ruby/pull/22
+  * https://github.com/asonas/chatwork-ruby/pull/23
+  * https://github.com/asonas/chatwork-ruby/pull/24
+  * https://github.com/asonas/chatwork-ruby/pull/25
+  * https://github.com/asonas/chatwork-ruby/pull/26
+  * https://github.com/asonas/chatwork-ruby/pull/27
+  * https://github.com/asonas/chatwork-ruby/pull/28
+  * https://github.com/asonas/chatwork-ruby/pull/29
+  * https://github.com/asonas/chatwork-ruby/pull/30
+
+## [v0.5.0](https://github.com/asonas/chatwork-ruby/tree/v0.5.0) (2017-11-29)
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.4.1...v0.5.0)
+
+**Merged pull requests:**
+
+- Support ChatWork OAuth [\#21](https://github.com/asonas/chatwork-ruby/pull/21) ([sue445](https://github.com/sue445))
+- Refactor: remove `require` in each spec file [\#20](https://github.com/asonas/chatwork-ruby/pull/20) ([sue445](https://github.com/sue445))
+- Relax rspec version [\#19](https://github.com/asonas/chatwork-ruby/pull/19) ([sue445](https://github.com/sue445))
+- Add block expression [\#16](https://github.com/asonas/chatwork-ruby/pull/16) ([yuyaan](https://github.com/yuyaan))
 
 ## [v0.4.1](https://github.com/asonas/chatwork-ruby/tree/v0.4.1) (2017-02-17)
 [Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.4.0...v0.4.1)
@@ -95,4 +127,4 @@
 ## [v0.0.1](https://github.com/asonas/chatwork-ruby/tree/v0.0.1) (2013-11-28)
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -1,4 +1,16 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in chatwork.gemspec
 gemspec
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.3.0")
+  group :test do
+    gem "backport_dig", group: :development
+  end
+end
+
+if Gem::Version.create(RUBY_VERSION) < Gem::Version.create("2.2.2")
+  group :test do
+    gem "activesupport", "< 5.0.0", group: :development
+  end
+end

data/README.md

@@ -1,6 +1,11 @@
-# Chatwork
+# ChatWork
 
-TODO: Write a gem description
+Ruby bindings of ChatWork API
+
+[![Gem Version](https://badge.fury.io/rb/chatwork.svg)](https://badge.fury.io/rb/chatwork)
+[![Build Status](https://travis-ci.org/asonas/chatwork-ruby.svg?branch=master)](https://travis-ci.org/asonas/chatwork-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/asonas/chatwork-ruby/badge.svg?branch=master)](https://coveralls.io/github/asonas/chatwork-ruby)
+[![Dependency Status](https://gemnasium.com/badges/github.com/asonas/chatwork-ruby.svg)](https://gemnasium.com/github.com/asonas/chatwork-ruby)
 
 ## Installation
 
@@ -87,6 +92,14 @@ ChatWork::Message.create(room_id: 1234, body: "Hello, ChatWork!")
 $ CHATWORK_CLIENT_ID=xxx CHATWORK_CLIENT_SECRET=xxx REFRESH_TOKEN=xxx ruby refresh_access_token.rb
 ```
 
+## Development
+```bash
+cp .env.example .env
+vi .env
+
+./bin/console
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_tasks"
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new
   task :default => :spec
 rescue
-  $stderr.puts('Install rspec')
+  warn("Install rspec")
 end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chatwork"
+require "dotenv"
+
+Dotenv.load
+
+require "pry"
+Pry.start

data/chatwork.gemspec

@@ -1,27 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'chatwork/version'
+require "chatwork/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "chatwork"
   spec.version       = ChatWork::VERSION
-  spec.authors       = ["asonas"]
-  spec.email         = ["hzw1258@gmail.com"]
-  spec.description   = %q{ChatWork is cloud-based business chat tool}
-  spec.summary       = %q{Ruby bindings of Chatwork API}
+  spec.authors       = ["asonas", "sue445"]
+  spec.email         = ["hzw1258@gmail.com", "sue445@sue445.net"]
+  spec.description   = "ChatWork is cloud-based business chat tool"
+  spec.summary       = "Ruby bindings of ChatWork API"
   spec.homepage      = "https://github.com/asonas/chatwork-ruby"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "hashie"
 
+  spec.add_development_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "onkcop", "0.52.1.0"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-parameterized"
+  spec.add_development_dependency "rubocop", "0.52.1"
+  spec.add_development_dependency "rubocop-rspec", "1.21.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
 end

data/lib/chatwork.rb

@@ -1,32 +1,40 @@
 require "chatwork/version"
 
 module ChatWork
-  autoload(:BaseClient, 'chatwork/base_client')
-  autoload(:Client, 'chatwork/client')
-  autoload(:OAuthClient, 'chatwork/oauth_client')
-  autoload(:Token, 'chatwork/token')
-  autoload(:Operations, 'chatwork/operations')
-  autoload(:ChatWorkError, 'chatwork/chatwork_error')
-  autoload(:APIConnectionError, 'chatwork/chatwork_error')
-  autoload(:APIError, 'chatwork/chatwork_error')
-  autoload(:Room, 'chatwork/room')
-  autoload(:Entity, 'chatwork/entity')
-  autoload(:Message, 'chatwork/message')
-  autoload(:Me, 'chatwork/me')
-  autoload(:MyTask, 'chatwork/my_task')
-  autoload(:Task, 'chatwork/task')
-  autoload(:Member, 'chatwork/member')
-  autoload(:Contacts, 'chatwork/contacts')
-
-  @api_base = 'https://api.chatwork.com/'
-  @oauth_api_base = 'https://oauth.chatwork.com/'
-  @api_version = '/v2'
+  autoload :BaseClient,         "chatwork/base_client"
+  autoload :APIConnectionError, "chatwork/chatwork_error"
+  autoload :APIError,           "chatwork/chatwork_error"
+  autoload :ChatWorkError,      "chatwork/chatwork_error"
+  autoload :Client,             "chatwork/client"
+  autoload :Contacts,           "chatwork/contacts"
+  autoload :EntityMethods,      "chatwork/entity_methods"
+  autoload :File,               "chatwork/file"
+  autoload :IncomingRequest,    "chatwork/incoming_request"
+  autoload :Me,                 "chatwork/me"
+  autoload :Member,             "chatwork/member"
+  autoload :Message,            "chatwork/message"
+  autoload :MyStatus,           "chatwork/my_status"
+  autoload :MyTask,             "chatwork/my_task"
+  autoload :OAuthClient,        "chatwork/oauth_client"
+  autoload :Room,               "chatwork/room"
+  autoload :Task,               "chatwork/task"
+  autoload :Token,              "chatwork/token"
+
+  @api_base = "https://api.chatwork.com/"
+  @oauth_api_base = "https://oauth.chatwork.com/"
+  @api_version = "/v2"
   @api_key = nil
   @access_token = nil
   @client_id = nil
   @client_secret = nil
 
   class << self
+    attr_reader :api_base
+
+    attr_reader :oauth_api_base
+
+    attr_reader :api_version
+
     def client
       @client ||= Client.new(api_key, access_token, api_base, api_version)
     end
@@ -67,32 +75,20 @@ module ChatWork
       @oauth_client = nil
     end
 
-    def api_base
-      @api_base
-    end
-
-    def oauth_api_base
-      @oauth_api_base
-    end
-
     def api_key
-      @api_key || ENV['CHATWORK_API_TOKEN']
+      @api_key || ENV["CHATWORK_API_TOKEN"]
     end
 
     def access_token
-      @access_token || ENV['CHATWORK_ACCESS_TOKEN']
+      @access_token || ENV["CHATWORK_ACCESS_TOKEN"]
     end
 
     def client_id
-      @client_id || ENV['CHATWORK_CLIENT_ID']
+      @client_id || ENV["CHATWORK_CLIENT_ID"]
     end
 
     def client_secret
-      @client_secret || ENV['CHATWORK_CLIENT_SECRET']
-    end
-
-    def api_version
-      @api_version
+      @client_secret || ENV["CHATWORK_CLIENT_SECRET"]
     end
   end
 end

data/lib/chatwork/base_client.rb

@@ -1,17 +1,20 @@
-require 'faraday'
-require 'json'
+require "faraday"
+require "faraday_middleware"
+require "hashie"
 
 module ChatWork
   class BaseClient
     def initialize(api_base, api_version, header)
       default_header = {
-        'User-Agent' => "ChatWork#{api_version} RubyBinding/#{ChatWork::VERSION}"
+        "User-Agent" => "ChatWork#{api_version} RubyBinding/#{ChatWork::VERSION}",
       }
 
       default_header.merge!(header)
 
       @conn = Faraday.new("#{api_base}#{api_version}", headers: default_header) do |builder|
         builder.request :url_encoded
+        builder.response :mashify
+        builder.response :json
         builder.adapter Faraday.default_adapter
       end
       @api_version = api_version
@@ -19,16 +22,10 @@ module ChatWork
 
     def handle_response(response)
       case response.status
-      when 204
-        ChatWork::ChatWorkError.from_response(response.status, response.body, response.headers)
       when 200..299
-        begin
-          JSON.parse(response.body)
-        rescue JSON::ParserError => e
-          raise ChatWork::APIConnectionError.new("Response JSON is broken. #{e.message}: #{response.body}", e)
-        end
+        response.body
       else
-        ChatWork::ChatWorkError.from_response(response.status, response.body, response.headers)
+        raise ChatWork::ChatWorkError.from_response(response.status, response.body, response.headers)
       end
     end
 

data/lib/chatwork/chatwork_error.rb

@@ -1,33 +1,23 @@
-require 'json'
 module ChatWork
   class ChatWorkError < StandardError
-
     def self.from_response(status, body, headers)
-      # HTTP status 204 don't have body.
-      return APIError.new(status, "") if status == 204
-
-      hash =
-        begin
-          JSON.load(body)
-        rescue JSON::ParserError => e
-          return ChatWork::APIConnectionError.new("Response JSON is broken. #{e.message}: #{body}", e)
-        end
-      unless hash['errors']
+      unless body["errors"]
         return APIConnectionError.new("Invalid response #{body}")
       end
 
-      if headers.has_key?('WWW-Authenticate')
-        return AuthenticateError.new(headers['WWW-Authenticate'], status, hash['errors'])
+      if headers.has_key?("WWW-Authenticate")
+        return AuthenticateError.new(headers["WWW-Authenticate"], status, body["errors"])
       end
 
-      APIError.new(status, hash['errors'])
+      APIError.new(status, body["errors"])
     end
 
     attr_reader :status
     attr_reader :error_response
 
     def initialize(message, status = nil, error_response = nil)
-      @status, @error_response = status, error_response
+      @status = status
+      @error_response = error_response
       super(message)
     end
   end

data/lib/chatwork/client.rb

@@ -2,9 +2,9 @@ module ChatWork
   class Client < BaseClient
     def initialize(api_key, access_token, api_base, api_version)
       if api_key
-        super(api_base, api_version, {'X-ChatWorkToken' => api_key})
+        super(api_base, api_version, { "X-ChatWorkToken" => api_key })
       elsif access_token
-        super(api_base, api_version, {'Authorization' => "Bearer #{access_token}"})
+        super(api_base, api_version, { "Authorization" => "Bearer #{access_token}" })
       else
         raise "Either api_key or access_token is required"
       end

data/lib/chatwork/contacts.rb

@@ -1,13 +1,29 @@
 module ChatWork
-  class Contacts < Entity
-    install_class_operations :get
+  module Contacts
+    extend EntityMethods
 
-    def self.path
-      "/contacts"
-    end
-
-    def path
-      "/contacts"
+    # Get the list of your contacts
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_contacts.html#GET-contacts
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @return [Array<Hashie::Mash>]
+    #
+    # @example response format
+    #   [
+    #     {
+    #       "account_id": 123,
+    #       "room_id": 322,
+    #       "name": "John Smith",
+    #       "chatwork_id": "tarochatworkid",
+    #       "organization_id": 101,
+    #       "organization_name": "Hello Company",
+    #       "department": "Marketing",
+    #       "avatar_image_url": "https://example.com/abc.png"
+    #     }
+    #   ]
+    def self.get
+      _get("/contacts")
     end
   end
 end