chatwork 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c77e7a8ed9f1542d07d0a5358aee0f0a47df235629691a33824d48b743fb1c2
-  data.tar.gz: d1ab0c06c73e6fc2adb820bedfbe81b7fdda3935d601d2084067dcaee3562aa8
+  metadata.gz: 59e4ff9379d4a6103a888096f95051bde6b365ad9e7a165f379563f95a14042d
+  data.tar.gz: 90709b0cd1ea756266fb6072cd656455bc929ed34870dcf3d889781cb29f740a
 SHA512:
-  metadata.gz: c1e4a88d1c57069063ed23917bb9df6336f7ee8493c166083ebeb9feceb2e35c59af9e01d19c3b887506d869d4fa0a4c69b0d61f4be6e5b4b96dbedb0e51d2c0
-  data.tar.gz: d12ffa27c12910c660d14f6c72b275d3a1a8fa656eac0c2c6a388ceb5d708424269a75ecee9d190c0009896f843e01c01e195e0e593a5d77e49ea1c47231f193
+  metadata.gz: ee3317f8e4afbf7d4c8a6384562202e8d8ce68226e7ccab6e6fc806446b0548df0a1192b5b712ed879a16de4d7bc2aca5dda15f87a596f4f479c62655787a945
+  data.tar.gz: 438dc9cec86531f6be5abb10f824d3a91c9bb0a22078027fb999e2ad19745fe6f67e4b039d14fa43680f4aa39ada8f9aacc71ebb701b980713fe9da51f3a066d

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 ## Unreleased
-[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.6.0...master)
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.6.1...master)
+
+## v0.6.1
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.6.0...v0.6.1)
+
+* Fixed: ArgumentError when ChatWork::Token.refresh_access_token
+  * https://github.com/asonas/chatwork-ruby/pull/39
 
 ## v0.6.0
 [Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.5.0...v0.6.0)

data/README.md

@@ -92,6 +92,9 @@ 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
 ```
 
+## Reference
+http://www.rubydoc.info/gems/chatwork
+
 ## Development
 ```bash
 cp .env.example .env

data/lib/chatwork.rb

@@ -1,4 +1,5 @@
 require "chatwork/version"
+require "hashie"
 
 module ChatWork
   autoload :BaseClient,         "chatwork/base_client"

data/lib/chatwork/base_client.rb

@@ -1,6 +1,5 @@
 require "faraday"
 require "faraday_middleware"
-require "hashie"
 
 module ChatWork
   class BaseClient

data/lib/chatwork/chatwork_error.rb

@@ -1,15 +1,22 @@
 module ChatWork
   class ChatWorkError < StandardError
     def self.from_response(status, body, headers)
-      unless body["errors"]
-        return APIConnectionError.new("Invalid response #{body}")
+      if headers.has_key?("WWW-Authenticate")
+        return AuthenticateError.from_www_authenticate(
+          www_authenticate: headers["WWW-Authenticate"],
+          status:           status,
+          error_response:   body["errors"],
+        )
       end
 
-      if headers.has_key?("WWW-Authenticate")
-        return AuthenticateError.new(headers["WWW-Authenticate"], status, body["errors"])
+      return APIError.new(status, body["errors"]) if body["errors"]
+
+      if body["error"]
+        message = [body["error"], body["error_description"]].compact.join(" ")
+        return AuthenticateError.new(message, status, body, body["error"], body["error_description"])
       end
 
-      APIError.new(status, body["errors"])
+      APIConnectionError.new("Invalid response #{body.to_hash} (status: #{status})")
     end
 
     attr_reader :status
@@ -29,7 +36,7 @@ module ChatWork
 
     attr_reader :original_error
 
-    def initialize(message, original_error)
+    def initialize(message, original_error = nil)
       @original_error = original_error
       super(message)
     end
@@ -47,14 +54,27 @@ module ChatWork
   class AuthenticateError < ChatWorkError
     attr_reader :error, :error_description
 
-    def initialize(message, status, error_response)
-      message =~ /error="([^\"]+)"/
-      @error = Regexp.last_match(1)
-
-      message =~ /error_description="([^\"]+)"/
-      @error_description = Regexp.last_match(1)
+    def initialize(message, status, error_response, error, error_description)
+      @error = error
+      @error_description = error_description
 
       super(message, status, error_response)
     end
+
+    def self.from_www_authenticate(www_authenticate:, status:, error_response:)
+      www_authenticate =~ /error="([^\"]+)"/
+      error = Regexp.last_match(1)
+
+      www_authenticate =~ /error_description="([^\"]+)"/
+      error_description = Regexp.last_match(1)
+
+      AuthenticateError.new(
+        www_authenticate,
+        status,
+        error_response,
+        error,
+        error_description,
+      )
+    end
   end
 end

data/lib/chatwork/file.rb

@@ -41,7 +41,7 @@ module ChatWork
     # @param create_download_url [Boolean] whether or not to create a download link.
     #                                      If set to true, download like will be created for 30 seconds
     #
-    # @return [Array<Hashie::Mash>]
+    # @return [Hashie::Mash]
     #
     # @example response format
     #   {

data/lib/chatwork/room.rb

@@ -108,6 +108,13 @@ module ChatWork
     # @param icon_preset [String] Type of the group chat icon (group, check, document, meeting, event, project, business,
     #                             study, security, star, idea, heart, magcup, beer, music, sports, travel)
     # @param name [String] Title of the group chat.
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example response format
+    #   {
+    #     "room_id": 1234
+    #   }
     def self.update(room_id:, description: nil, icon_preset: nil, name: nil)
       _put("/rooms/#{room_id}", description: description, icon_preset: icon_preset, name: name)
     end

data/lib/chatwork/token.rb

@@ -14,7 +14,6 @@ module ChatWork
     #     "refresh_token" => "refresh_token",
     #     "scope" => "users.all:read rooms.all:read_write contacts.all:read_write",
     #   }
-    #   ["access_token", "token_type", "expires_in", "refresh_token", "scope"]
     def self.refresh_access_token(refresh_token, scope = [])
       params = {
         grant_type:    "refresh_token",
@@ -22,9 +21,7 @@ module ChatWork
       }
       params[:scope] = scope.join(" ") unless scope.empty?
 
-      response = ChatWork.oauth_client.post("/token", params)
-      raise response if response.is_a?(Exception)
-      response
+      ChatWork.oauth_client.post("/token", params)
     end
   end
 end

data/lib/chatwork/version.rb

@@ -1,3 +1,3 @@
 module ChatWork
-  VERSION = "0.6.0".freeze
+  VERSION = "0.6.1".freeze
 end

data/spec/lib/chatwork/chatwork_error_spec.rb

@@ -1,16 +1,14 @@
 describe ChatWork::ChatWorkError do
   describe ".from_response" do
-    subject { ChatWork::ChatWorkError.from_response(status, body, headers) }
+    subject { ChatWork::ChatWorkError.from_response(status, Hashie::Mash.new(body), headers) }
 
     context "with WWW-Authenticate header" do
       let(:status) { 401 }
 
       let(:body) do
-        json =
-          <<-JSON
-            {"errors":["Invalid API Token"]}
-          JSON
-        Hashie::Mash.new(JSON.parse(json))
+        {
+          errors: ["Invalid API Token"],
+        }
       end
 
       let(:headers) do
@@ -24,5 +22,46 @@ describe ChatWork::ChatWorkError do
       its(:error_description) { should eq "The access token expired" }
       its(:error_response) { should eq ["Invalid API Token"] }
     end
+
+    context "with error" do
+      let(:status) { 401 }
+
+      let(:body) do
+        {
+          error:             "invalid_client",
+          error_description: "The client ID `client_id` is unknown.",
+          error_uri:         nil,
+        }.stringify_keys
+      end
+
+      let(:headers) { {} }
+
+      it { should be_an_instance_of ChatWork::AuthenticateError }
+      its(:message)           { should eq "invalid_client The client ID `client_id` is unknown." }
+      its(:error)             { should eq "invalid_client" }
+      its(:error_description) { should eq "The client ID `client_id` is unknown." }
+      its(:error_response)    { should eq body }
+    end
+  end
+
+  describe ChatWork::AuthenticateError do
+    describe ".from_www_authenticate" do
+      subject do
+        ChatWork::AuthenticateError.from_www_authenticate(
+          www_authenticate: www_authenticate,
+          status:           status,
+          error_response:   error_response,
+        )
+      end
+
+      let(:www_authenticate) { 'Bearer error="invalid_token", error_description="The access token expired"' }
+      let(:status)           { 401 }
+      let(:error_response)   { ["Invalid API Token"] }
+
+      it { should be_an_instance_of ChatWork::AuthenticateError }
+      its(:error)             { should eq "invalid_token" }
+      its(:error_description) { should eq "The access token expired" }
+      its(:error_response)    { should eq ["Invalid API Token"] }
+    end
   end
 end

data/spec/lib/chatwork/token_spec.rb

@@ -5,11 +5,6 @@ describe ChatWork::Token do
     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" }
@@ -17,20 +12,49 @@ describe ChatWork::Token do
     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",
-      }
+
+    context "when successful" do
+      before do
+        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(: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(["scope"])         { should eq "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(["scope"])         { should eq "users.all:read rooms.all:read_write contacts.all:read_write" }
+    context "when failure" do
+      before do
+        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: 401, body: body.to_json, headers: { "Content-Type" => "application/json" })
+      end
+
+      let(:body) do
+        {
+          error:             "invalid_client",
+          error_description: "The client ID `client_id` is unknown.",
+          error_uri:         nil,
+        }
+      end
+
+      it { expect { subject }.to raise_error ChatWork::AuthenticateError }
+    end
   end
 end

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

@@ -76,21 +76,4 @@ RSpec.describe RamlParser do
     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/support/contexts/api_context.rb

@@ -32,7 +32,7 @@ RSpec.shared_context :api_context, type: :api do
         query_string = "?" + query_example.to_query
       when :post, :put
         request_options[:headers]["Content-Type"] = "application/x-www-form-urlencoded"
-        request_options[:body] = query_example
+        request_options[:body] = query_example.transform_values(&:to_s)
       end
     end
 

data/spec/support/utils/raml_parser.rb

@@ -67,15 +67,9 @@ module RamlParser
   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)
+    @raml ||= YAML.load_file(schema_file)
   end
+  private_class_method :raml
 
   def self.parse_response(response_json)
     JSON.parse(response_json)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatwork
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - asonas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -331,7 +331,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings of ChatWork API