chatwork 0.5.0 → 0.6.0

data/spec/lib/chatwork/token_spec.rb

@@ -1,17 +1,36 @@
-require_relative '../../shared_oauth_stubs.rb'
-
 describe ChatWork::Token do
-  include_context 'shared oauth stubs'
-
-  describe '.refresh_access_token' do
+  describe ".refresh_access_token" do
     subject { ChatWork::Token.refresh_access_token(refresh_token, scope) }
 
-    let(:scope) { [] }
+    before do
+      allow(ChatWork).to receive(:client_id)     { client_id }
+      allow(ChatWork).to receive(:client_secret) { client_secret }
+
+      stub_request(:post, "https://oauth.chatwork.com/token").
+        with(body: { "grant_type" => "refresh_token", "refresh_token" => refresh_token },
+             headers: { "Authorization" => "Basic #{signature}", "Content-Type" => "application/x-www-form-urlencoded" }).
+        to_return(status: 200, body: token.to_json, headers: { "Content-Type" => "application/json" })
+    end
+
+    let(:client_id)     { "client_id" }
+    let(:client_secret) { "client_secret" }
+    let(:refresh_token) { "refresh_token" }
+    let(:signature)     { "Y2xpZW50X2lkOmNsaWVudF9zZWNyZXQ=" }
+    let(:scope)         { [] }
+    let(:token) do
+      {
+        access_token:  "new_access_token",
+        token_type:    "Bearer",
+        expires_in:    "1800",
+        refresh_token: refresh_token,
+        scope:         "users.all:read rooms.all:read_write contacts.all:read_write",
+      }
+    end
 
     its(["access_token"])  { should eq "new_access_token" }
     its(["token_type"])    { should eq "Bearer" }
     its(["expires_in"])    { should eq "1800" }
-    its(["refresh_token"]) { should eq "refresh_token" }
+    its(["refresh_token"]) { should eq refresh_token }
     its(["scope"])         { should eq "users.all:read rooms.all:read_write contacts.all:read_write" }
   end
 end

data/spec/lib/chatwork_spec.rb

@@ -1,5 +1,5 @@
 describe ChatWork do
-  describe '#client' do
+  describe "#client" do
     subject { super().client }
 
     before do
@@ -9,48 +9,55 @@ describe ChatWork do
     it { should be_a(ChatWork::Client) }
   end
 
-  describe '#api_base' do
+  describe "#api_base" do
     subject { super().api_base }
-    it { should eq('https://api.chatwork.com/') }
+
+    it { should eq("https://api.chatwork.com/") }
   end
-  describe '#api_base=' do
-    before { ChatWork.api_base = 'https://test.example.com/' }
+  describe "#api_base=" do
+    before { ChatWork.api_base = "https://test.example.com/" }
 
-    describe '#api_base' do
+    describe "#api_base" do
       subject { super().api_base }
-      it { should eq('https://test.example.com/') }
+
+      it { should eq("https://test.example.com/") }
     end
 
-    describe '#api_base' do
+    describe "#api_base" do
       subject { super().api_base }
-      it { should eq('https://test.example.com/') }
+
+      it { should eq("https://test.example.com/") }
     end
   end
 
-  describe '#api_key' do
-    context 'when does not set env' do
+  describe "#api_key" do
+    context "when does not set env" do
       subject { super().api_key }
+
       it { should be_nil }
     end
 
-    context 'when sets env' do
-      let(:test_token) { 'chatwork_test_token' }
-      before { ENV['CHATWORK_API_TOKEN'] = test_token }
+    context "when sets env" do
       subject { super().api_key }
+
+      let(:test_token) { "chatwork_test_token" }
+      before { ENV["CHATWORK_API_TOKEN"] = test_token }
       it { is_expected.to eq test_token }
     end
   end
 
-  describe '#access_token' do
-    context 'when does not set env' do
+  describe "#access_token" do
+    context "when does not set env" do
       subject { super().access_token }
+
       it { should be_nil }
     end
 
-    context 'when sets env' do
-      let(:test_token) { 'chatwork_test_token' }
-      before { ENV['CHATWORK_ACCESS_TOKEN'] = test_token }
+    context "when sets env" do
       subject { super().access_token }
+
+      let(:test_token) { "chatwork_test_token" }
+      before { ENV["CHATWORK_ACCESS_TOKEN"] = test_token }
       it { is_expected.to eq test_token }
     end
   end

data/spec/lib/support/utils/raml_parser_spec.rb

@@ -0,0 +1,96 @@
+RSpec.describe RamlParser do
+  describe ".find_resource" do
+    subject { RamlParser.find_resource(verb, path) }
+
+    let(:verb)   { :get }
+    let(:path)   { "/rooms/{room_id}/members" }
+
+    its(["description"]) { should eq "チャットのメンバー一覧を取得\n" }
+    its(["is"])          { should eq ["room_member_list_response", "unauthorized_response"] }
+  end
+
+  describe ".find_response_example" do
+    subject { RamlParser.find_response_example(verb, path, status) }
+
+    context "contains in responses" do
+      let(:verb)   { :put }
+      let(:path)   { "/rooms/{room_id}/members" }
+      let(:status) { 200 }
+
+      let(:expected) do
+        {
+          "admin" => [123, 542, 1001],
+          "member" => [10, 103],
+          "readonly" => [6, 11],
+        }
+      end
+
+      it { should eq expected }
+    end
+
+    context "contains in is" do
+      let(:verb)   { :get }
+      let(:path)   { "/rooms/{room_id}/messages" }
+      let(:status) { 200 }
+
+      let(:expected) do
+        [
+          {
+            "message_id" => "5",
+            "account" => {
+              "account_id" => 123,
+              "name" => "Bob",
+              "avatar_image_url" => "https://example.com/ico_avatar.png",
+            },
+            "body" => "Hello Chatwork!",
+            "send_time" => 1_384_242_850,
+            "update_time" => 0,
+          },
+        ]
+      end
+
+      it { should eq expected }
+    end
+  end
+
+  describe ".find_trait" do
+    subject { RamlParser.find_trait(trait_name) }
+
+    let(:trait_name) { "room_icon" }
+
+    it "can get trait" do
+      expect(subject["queryParameters"]).not_to eq nil
+      expect(subject["queryParameters"]["icon_preset"]).not_to eq nil
+      expect(subject["queryParameters"]["icon_preset"]["displayName"]).to eq "アイコン種類"
+    end
+  end
+
+  describe ".find_query_parameter_example" do
+    subject { RamlParser.find_query_parameter_example(verb, path) }
+
+    let(:verb) { :put }
+    let(:path) { "/rooms/{room_id}" }
+
+    its(:count)          { should eq 3 }
+    its(["name"])        { should eq "Website renewal project" }
+    its(["description"]) { should eq "group chat description" }
+    its(["icon_preset"]) { should eq "meeting" }
+  end
+
+  describe ".raml" do
+    subject { RamlParser.raml }
+
+    before do
+      RamlParser.instance_variable_set(:@raml, nil)
+    end
+
+    after do
+      RamlParser.instance_variable_set(:@raml, nil)
+    end
+
+    it "3 digit number can be read as a string" do
+      comma_separated_integer_list = subject["traits"][0]["room_members"]["queryParameters"]["members_admin_ids"]["example"]
+      expect(comma_separated_integer_list).to eq "123,542,1001"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,9 +1,35 @@
-# encoding: utf-8
-#
-$: << File.expand_path(File.join(*%w{.. .. lib}), __FILE__)
+if ENV["CI"]
+  require "coveralls"
+  Coveralls.wear!
+end
 
-require 'chatwork'
+$LOAD_PATH << File.expand_path(File.join("..", "..", "lib"), __FILE__)
 
-require 'rspec/its'
-require_relative './shared_stubs'
+require "chatwork"
 
+require "rspec-parameterized"
+require "rspec/its"
+require "webmock/rspec"
+require "pry"
+require "active_support/all"
+
+begin
+  require "backport_dig"
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
+Dir["#{__dir__}/support/**/*.rb"].each { |f| require f }
+
+def spec_dir
+  Pathname(__dir__)
+end
+
+def schema_file
+  spec_dir.join("../api/RAML/api-ja.raml")
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    raise "Not found '#{schema_file}'. Please run `git submodule update --init` at first" unless schema_file.exist?
+  end
+end

data/spec/support/contexts/api_context.rb

@@ -0,0 +1,43 @@
+RSpec.shared_context :api_context, type: :api do
+  let(:api_key) { "api_key" }
+
+  let(:response_headers) do
+    {
+      "Content-Type"          => "application/json",
+      "X-RateLimit-Limit"     => ratelimit_limit,
+      "X-RateLimit-Remaining" => ratelimit_remaining,
+      "X-RateLimit-Reset"     => ratelimit_reset,
+    }
+  end
+
+  let(:ratelimit_limit)     { 100 }
+  let(:ratelimit_remaining) { 44 }
+  let(:ratelimit_reset)     { 1_390_941_626 }
+
+  before do
+    allow(ChatWork).to receive(:api_key) { api_key }
+  end
+
+  def stub_chatwork_request(expected_verb, expected_path, resource_path = nil, status = 200)
+    resource_path ||= expected_path
+    example = RamlParser.find_response_example(expected_verb, resource_path, status)
+    raise "Not found '#{expected_verb.to_s.upcase} #{resource_path} #{status}' in '#{schema_file}'" unless example
+
+    request_options = { headers: { "X-Chatworktoken" => api_key } }
+
+    query_example = RamlParser.find_query_parameter_example(expected_verb, resource_path)
+    unless query_example.empty?
+      case expected_verb
+      when :get, :delete
+        query_string = "?" + query_example.to_query
+      when :post, :put
+        request_options[:headers]["Content-Type"] = "application/x-www-form-urlencoded"
+        request_options[:body] = query_example
+      end
+    end
+
+    stub_request(expected_verb, "https://api.chatwork.com/v2#{expected_path}#{query_string}").
+      with(request_options).
+      to_return(status: status, body: example.to_json, headers: response_headers)
+  end
+end

data/spec/support/examples/a_chatwork_api.rb

@@ -0,0 +1,12 @@
+RSpec.shared_examples :a_chatwork_api do |verb, resource, status = 200|
+  it { should match_example(verb, resource, status) }
+
+  it "works with block" do
+    subject do |body, headers|
+      aggregate_failures do
+        expect(body).to match_example(verb, resource, status)
+        expect(headers).to eq response_headers
+      end
+    end
+  end
+end

data/spec/support/matchers/match_example.rb

@@ -0,0 +1,16 @@
+RSpec::Matchers.define :match_example do |verb, resource, status = 200|
+  match do |actual|
+    expected_example = RamlParser.find_response_example(verb, resource, status)
+    raise "Not found '#{verb.to_s.upcase} #{resource} #{status}' in '#{schema_file}'" unless expected_example
+
+    # NOTE: when empty response, FaradayMiddleware::ParseJson convert to nil
+    return true if status == 204 && actual.nil? && expected_example.empty?
+
+    actual == expected_example
+  end
+
+  description do
+    expected_example = RamlParser.find_response_example(verb, resource, status)
+    "match '#{expected_example}'"
+  end
+end

data/spec/support/utils/raml_parser.rb

@@ -0,0 +1,86 @@
+module RamlParser
+  def self.find_resource(verb, path)
+    elements = path.split("/").reject(&:empty?).map { |str| "/#{str}" }
+    elements << verb.to_s.upcase
+    find_node(elements)
+  end
+
+  def self.find_response_example(verb, path, status = 200)
+    resource = find_resource(verb, path)
+    return nil unless resource
+
+    response_json = resource.dig("responses", status, "body", "application/json", "example")
+    return parse_response(response_json) if response_json
+
+    return nil unless resource["is"]
+
+    resource["is"].each do |trait_name|
+      trait = find_trait(trait_name)
+      next unless trait
+
+      response_json = trait.dig("responses", status, "body", "application/json", "example")
+      return parse_response(response_json) if response_json
+    end
+
+    nil
+  end
+
+  def self.find_trait(trait_name)
+    traits = find_node("traits")
+    traits.each do |trait|
+      return trait.first.last if trait.first.first == trait_name
+    end
+    nil
+  end
+
+  def self.find_query_parameter_example(verb, path)
+    resource = find_resource(verb, path)
+    return {} unless resource
+
+    parameter_example = {}
+
+    if resource["queryParameters"]
+      resource["queryParameters"].each do |name, value|
+        parameter_example[name] = value["example"]
+      end
+    end
+
+    if resource["is"]
+      resource["is"].each do |trait_name|
+        trait = find_trait(trait_name)
+        next unless trait
+        next unless trait["queryParameters"]
+
+        trait["queryParameters"].each do |name, value|
+          parameter_example[name] = value["example"]
+        end
+      end
+    end
+
+    parameter_example
+  end
+
+  def self.find_node(elements)
+    elements = Array(elements)
+    raml.dig(*elements)
+  end
+  private_class_method :find_node
+
+  def self.raml
+    return @raml if @raml
+
+    yaml_data = schema_file.read
+
+    # e.g. example: 123,542,1001 -> example: '123,542,1001'
+    yaml_data.gsub!(/example: ([0-9,]+)/) { "example: '#{Regexp.last_match(1)}'" }
+
+    @raml = YAML.safe_load(yaml_data)
+  end
+
+  def self.parse_response(response_json)
+    JSON.parse(response_json)
+  rescue JSON::ParserError
+    response_json
+  end
+  private_class_method :parse_response
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: chatwork
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - asonas
+- sue445
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +25,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: hashie
+  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: activesupport
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +81,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: onkcop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.1.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,46 +179,138 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-parameterized
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: ChatWork is cloud-based business chat tool
 email:
 - hzw1258@gmail.com
+- sue445@sue445.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - chatwork.gemspec
 - lib/chatwork.rb
 - lib/chatwork/base_client.rb
 - lib/chatwork/chatwork_error.rb
 - lib/chatwork/client.rb
 - lib/chatwork/contacts.rb
-- lib/chatwork/entity.rb
+- lib/chatwork/entity_methods.rb
+- lib/chatwork/file.rb
+- lib/chatwork/incoming_request.rb
 - lib/chatwork/me.rb
 - lib/chatwork/member.rb
 - lib/chatwork/message.rb
+- lib/chatwork/my_status.rb
 - lib/chatwork/my_task.rb
 - lib/chatwork/oauth_client.rb
-- lib/chatwork/operations.rb
 - lib/chatwork/room.rb
 - lib/chatwork/task.rb
 - lib/chatwork/token.rb
 - lib/chatwork/version.rb
 - spec/lib/chatwork/chatwork_error_spec.rb
 - spec/lib/chatwork/client_spec.rb
+- spec/lib/chatwork/contacts_spec.rb
+- spec/lib/chatwork/entity_methods_spec.rb
+- spec/lib/chatwork/file_spec.rb
+- spec/lib/chatwork/incoming_request_spec.rb
+- spec/lib/chatwork/me_spec.rb
 - spec/lib/chatwork/member_spec.rb
+- spec/lib/chatwork/message_spec.rb
+- spec/lib/chatwork/my_status_spec.rb
+- spec/lib/chatwork/my_task_spec.rb
 - spec/lib/chatwork/oauth_client_spec.rb
+- spec/lib/chatwork/room_spec.rb
+- spec/lib/chatwork/task_spec.rb
 - spec/lib/chatwork/token_spec.rb
 - spec/lib/chatwork_spec.rb
-- spec/shared_oauth_stubs.rb
-- spec/shared_stubs.rb
+- spec/lib/support/utils/raml_parser_spec.rb
 - spec/spec_helper.rb
+- spec/support/contexts/api_context.rb
+- spec/support/examples/a_chatwork_api.rb
+- spec/support/matchers/match_example.rb
+- spec/support/utils/raml_parser.rb
 homepage: https://github.com/asonas/chatwork-ruby
 licenses:
 - MIT
@@ -140,17 +331,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
-summary: Ruby bindings of Chatwork API
+summary: Ruby bindings of ChatWork API
 test_files:
 - spec/lib/chatwork/chatwork_error_spec.rb
 - spec/lib/chatwork/client_spec.rb
+- spec/lib/chatwork/contacts_spec.rb
+- spec/lib/chatwork/entity_methods_spec.rb
+- spec/lib/chatwork/file_spec.rb
+- spec/lib/chatwork/incoming_request_spec.rb
+- spec/lib/chatwork/me_spec.rb
 - spec/lib/chatwork/member_spec.rb
+- spec/lib/chatwork/message_spec.rb
+- spec/lib/chatwork/my_status_spec.rb
+- spec/lib/chatwork/my_task_spec.rb
 - spec/lib/chatwork/oauth_client_spec.rb
+- spec/lib/chatwork/room_spec.rb
+- spec/lib/chatwork/task_spec.rb
 - spec/lib/chatwork/token_spec.rb
 - spec/lib/chatwork_spec.rb
-- spec/shared_oauth_stubs.rb
-- spec/shared_stubs.rb
+- spec/lib/support/utils/raml_parser_spec.rb
 - spec/spec_helper.rb
+- spec/support/contexts/api_context.rb
+- spec/support/examples/a_chatwork_api.rb
+- spec/support/matchers/match_example.rb
+- spec/support/utils/raml_parser.rb