chatwork 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbc0b45bd43456ece01cee8ee7cb111ddd153c401b5d2bf2c4f3fe994c6ded53
-  data.tar.gz: da276d6fe8554b88c5627e0183e86070ac09b34dfb991a09beeaf7c58127cf06
+  metadata.gz: 3b0e86371dbc01a5f67b01eb15d6681dc2fb5cded54530727da8b9a07d20946c
+  data.tar.gz: e79d2f3a743ff131ec83bd81a6e61a16cca8b5c484eae0eb635e23a68b078902
 SHA512:
-  metadata.gz: a37b6b08583b45874a91db8f2d5e9a82bb29d4ffbf0aa90606a94f78d0862bd7c3028dfaddcd3bb715f570bcd6a211bc542f2de8361d30eda1fdc91f45df2f46
-  data.tar.gz: a84e438fb953c64d47cbd7c12925e01acdb52b6fc105bda7cbac45d5e7cdd97a275612626bfdb02ccd11064084388fb823677449676739fd5648af7a65066aee
+  metadata.gz: 45468727cbee93fd0192a3912462eda9a0a00a032a4a867a5bf23ab6ed3982496dcd96f2d61f85a4d5cc1f24cd20137e33100a37d41eab451de6873145d34f6b
+  data.tar.gz: 89ec1973fdb802b11daf722250246f6bca7b77f963fcfd73d15b7cc07d61c27e852938d9f9bf45334adb69386a3e3236df6d7a790f726fe2c6ff845ea8b35675

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Change Log
 ## Unreleased
-[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.9.0...master)
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.10.0...master)
+
+## v0.10.0
+[Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.9.0...v0.10.0)
+
+* Add file upload method
+  * https://github.com/asonas/chatwork-ruby/pull/55
 
 ## v0.9.0
 [Full Changelog](https://github.com/asonas/chatwork-ruby/compare/v0.8.0...v0.9.0)

data/bin/console

@@ -3,8 +3,16 @@
 require "bundler/setup"
 require "chatwork"
 require "dotenv"
+require "faraday_curl"
 
 Dotenv.load
 
+logger = Logger.new(STDOUT)
+
+@client = ChatWork::Client.new(api_key: ENV["CHATWORK_API_TOKEN"])
+connection = @client.instance_variable_get(:@conn)
+connection.request :curl, logger, :debug
+connection.response :logger, logger, bodies: true
+
 require "pry"
 Pry.start

data/chatwork.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "faraday_curl"
   spec.add_development_dependency "onkcop", "0.53.0.0"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake"

data/lib/chatwork.rb

@@ -1,5 +1,6 @@
 require "chatwork/version"
 require "hashie"
+require "faraday"
 
 module ChatWork
   autoload :BaseClient,         "chatwork/base_client"
@@ -16,6 +17,7 @@ module ChatWork
   autoload :Me,                 "chatwork/me"
   autoload :Member,             "chatwork/member"
   autoload :Message,            "chatwork/message"
+  autoload :Multipart,          "chatwork/multipart"
   autoload :MyStatus,           "chatwork/my_status"
   autoload :MyTask,             "chatwork/my_task"
   autoload :OAuthClient,        "chatwork/oauth_client"
@@ -31,6 +33,10 @@ module ChatWork
   @client_id = nil
   @client_secret = nil
 
+  Faraday::Request.register_middleware(
+    chatwork_multipart: -> { ChatWork::Multipart },
+  )
+
   class << self
     # @!attribute [r] api_base
     #  @return [String]

data/lib/chatwork/base_client.rb

@@ -16,6 +16,7 @@ module ChatWork
       default_header.merge!(header)
 
       @conn = Faraday.new(api_base, headers: default_header) do |builder|
+        builder.request :chatwork_multipart
         builder.request :url_encoded
         builder.response :mashify
         builder.response :json

data/lib/chatwork/client/file_methods.rb

@@ -64,4 +64,39 @@ module ChatWork::Client::FileMethods
   def find_file(room_id:, file_id:, create_download_url: nil, &block)
     get("/rooms/#{room_id}/files/#{file_id}", create_download_url: boolean_to_integer(create_download_url), &block)
   end
+
+  # Upload a new file to room
+  #
+  # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-files
+  # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+  #
+  # @param room_id [Integer]
+  # @param file    [Faraday::UploadIO]
+  # @param message [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+  #
+  # @return [Hashie::Mash]
+  #
+  # @example how to upload a file
+  #   client = ChatWork::Client.new(api_key: "XXX")
+  #   client.create_file(room_id: 11111111, file: Faraday::UploadIO.new("/path/to/file.txt", "text/plain"), message: "Test")
+  #
+  # @example response format
+  #   {
+  #     "file_id": 1234
+  #   }
+  #
+  def create_file(room_id:, file:, message: nil, &block)
+    params = {
+      file:    file,
+      message: message,
+    }
+
+    post("/rooms/#{room_id}/files", params, &block)
+  end
+
+  alias_method :upload_file, :create_file
 end

data/lib/chatwork/file.rb

@@ -65,5 +65,36 @@ module ChatWork
     def self.find(room_id:, file_id:, create_download_url: nil, &block)
       ChatWork.client.find_file(room_id: room_id, file_id: file_id, create_download_url: create_download_url, &block)
     end
+
+    # Upload a new file to room
+    #
+    # @see http://developer.chatwork.com/ja/endpoint_rooms.html#POST-rooms-room_id-files
+    # @see http://download.chatwork.com/ChatWork_API_Documentation.pdf
+    #
+    # @param room_id [Integer]
+    # @param file    [Faraday::UploadIO]
+    # @param message [String]
+    #
+    # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+    # @yieldparam response_body [Hashie::Mash] response body
+    # @yieldparam response_header [Hash<String, String>] response header (e.g. X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset)
+    #
+    # @return [Hashie::Mash]
+    #
+    # @example how to upload a file
+    #   ChatWork::File.create(room_id: 11111111, file: Faraday::UploadIO.new("/path/to/file.txt", "text/plain"), message: "Test")
+    #
+    # @example response format
+    #   {
+    #     "file_id": 1234
+    #   }
+    #
+    def self.create(room_id:, file:, message: nil, &block)
+      ChatWork.client.create_file(room_id: room_id, file: file, message: message, &block)
+    end
+
+    class << self
+      alias_method :upload, :create
+    end
   end
 end

data/lib/chatwork/multipart.rb

@@ -0,0 +1,27 @@
+module ChatWork
+  class Multipart < ::Faraday::Request::Multipart
+    self.mime_type = "multipart/form-data".freeze
+
+    def create_multipart(env, params)
+      original_body = super(env, params)
+
+      # replace from Faraday::Parts::EpiloguePart to ChatWork::Multipart::EpiloguePart
+      parts = original_body.instance_variable_get(:@parts)
+      parts.pop
+      parts << EpiloguePart.new(env.request.boundary)
+
+      new_body = ::Faraday::CompositeReadIO.new(*parts)
+      env.request_headers[Faraday::Env::ContentLength] = new_body.length.to_s
+      new_body
+    end
+  end
+
+  class EpiloguePart < ::Faraday::Parts::EpiloguePart
+    def initialize(boundary)
+      # NOTE: ChatWork doesn't accepts ending "\r\n\r\n" of payload...
+      # @part = "--#{boundary}--\r\n\r\n"
+      @part = "--#{boundary}--\r\n"
+      @io = StringIO.new(@part)
+    end
+  end
+end

data/lib/chatwork/version.rb

@@ -1,3 +1,3 @@
 module ChatWork
-  VERSION = "0.9.0".freeze
+  VERSION = "0.10.0".freeze
 end

data/spec/data/upload.txt

@@ -0,0 +1 @@
+Hello ChatWork!

data/spec/lib/chatwork/client/file_methods_spec.rb

@@ -34,4 +34,18 @@ describe ChatWork::Client::FileMethods do
       it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/files/{file_id}"
     end
   end
+
+  describe "#create_file", type: :api do
+    subject { client.create_file(room_id: room_id, file: file, message: message, &block) }
+
+    before do
+      stub_chatwork_request(:post, "/rooms/#{room_id}/files", "/rooms/{room_id}/files")
+    end
+
+    let(:room_id) { 123 }
+    let(:file)    { Faraday::UploadIO.new("#{spec_dir}/data/upload.txt", "text/plain") }
+    let(:message) { "I attached comment to chat." }
+
+    it_behaves_like :a_chatwork_api, :post, "/rooms/{room_id}/files"
+  end
 end

data/spec/lib/chatwork/file_spec.rb

@@ -34,4 +34,18 @@ describe ChatWork::File do
       it_behaves_like :a_chatwork_api, :get, "/rooms/{room_id}/files/{file_id}"
     end
   end
+
+  describe ".create", type: :api do
+    subject { ChatWork::File.create(room_id: room_id, file: file, message: message, &block) }
+
+    before do
+      stub_chatwork_request(:post, "/rooms/#{room_id}/files", "/rooms/{room_id}/files")
+    end
+
+    let(:room_id) { 123 }
+    let(:file)    { Faraday::UploadIO.new("#{spec_dir}/data/upload.txt", "text/plain") }
+    let(:message) { "I attached comment to chat." }
+
+    it_behaves_like :a_chatwork_api, :post, "/rooms/{room_id}/files"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatwork
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - asonas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-08 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -109,6 +109,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_curl
+  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
@@ -294,6 +308,7 @@ files:
 - lib/chatwork/me.rb
 - lib/chatwork/member.rb
 - lib/chatwork/message.rb
+- lib/chatwork/multipart.rb
 - lib/chatwork/my_status.rb
 - lib/chatwork/my_task.rb
 - lib/chatwork/oauth_client.rb
@@ -302,6 +317,7 @@ files:
 - lib/chatwork/task.rb
 - lib/chatwork/token.rb
 - lib/chatwork/version.rb
+- spec/data/upload.txt
 - spec/lib/chatwork/chatwork_error_spec.rb
 - spec/lib/chatwork/client/contacts_methods_spec.rb
 - spec/lib/chatwork/client/file_methods_spec.rb
@@ -361,6 +377,7 @@ signing_key:
 specification_version: 4
 summary: Ruby bindings of ChatWork API
 test_files:
+- spec/data/upload.txt
 - spec/lib/chatwork/chatwork_error_spec.rb
 - spec/lib/chatwork/client/contacts_methods_spec.rb
 - spec/lib/chatwork/client/file_methods_spec.rb