Add files upload to rooms (#46)

* Add form data to request helper
* Add upload_file method to rooms
* Add file upload to docs

README.md

@@ -70,6 +70,7 @@ This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.
 * [/api/v1/channels.online](docs/channels.md#channelsonline)
 * [/api/v1/channels.members](docs/channels.md#channelsmembers)
 * /api/v1/channels.unarchive
+* [/api/v1/rooms.upload](docs/channels.md#channelsupload_file)
 
 #### Groups
 * /api/v1/groups.archive
@@ -92,6 +93,7 @@ This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.
 * /api/v1/groups.setType
 * [/api/v1/groups.members](docs/groups.md#groupsmembers)
 * /api/v1/groups.unarchive
+* [/api/v1/rooms.upload](docs/groups.md#groupsupload_file)
 
 #### Users
 * [/api/v1/users.create](docs/users.md#userscreate)

docs/channels.md

@@ -182,3 +182,17 @@ session = rocket_server.login('username', 'password')
 session.channels.members(name: 'some_channel_name')
 
 ```
+
+
+### channels.upload_file
+
+Upload file to the room
+
+```ruby
+require 'rocketchat'
+
+rocket_server = RocketChat::Server.new('http://your.server.address/')
+session = rocket_server.login('username', 'password')
+session.channels.upload_file(room_id: 'GENERAL', file: File, msg: "Optional Message", description: "Optional Description", tmid: "Optional thread message id")
+
+```

docs/groups.md

@@ -69,4 +69,18 @@ rocket_server = RocketChat::Server.new('http://your.server.address/')
 session = rocket_server.login('username', 'password')
 session.groups.members(name: 'some_channel_name')
 
-```
+```
+
+
+### channels.upload_file
+
+Upload file to the room
+
+```ruby
+require 'rocketchat'
+
+rocket_server = RocketChat::Server.new('http://your.server.address/')
+session = rocket_server.login('username', 'password')
+session.groups.upload_file(room_id: 'GENERAL', file: File, msg: "Optional Message", description: "Optional Description", tmid: "Optional thread message id")
+
+```

lib/rocket_chat/messages/room.rb

@@ -9,6 +9,8 @@ class Room # rubocop:disable Metrics/ClassLength
       include RoomSupport
       include UserSupport
 
+      API_PREFIX = '/api/v1'
+
       def self.inherited(subclass)
         field = subclass.name.split('::')[-1].downcase
         collection = "#{field}s"
@@ -27,7 +29,7 @@ def initialize(session)
 
       # Full API path to call
       def self.api_path(method)
-        "/api/v1/#{collection}.#{method}"
+        "#{API_PREFIX}/#{collection}.#{method}"
       end
 
       #
@@ -304,6 +306,25 @@ def members(room_id: nil, name: nil, offset: nil, count: nil, sort: nil)
         response['members'].map { |hash| RocketChat::User.new hash } if response['success']
       end
 
+      #
+      # *.upload* REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [File] file that should be uploaded to Rocket.Chat room
+      # @param [Hash] rest_params Optional params (msg, description, tmid)
+      # @return [RocketChat::Message]
+      # @raise [HTTPError, StatusError]
+      #
+      # https://developer.rocket.chat/reference/api/rest-api/endpoints/rooms-endpoints/upload-file-to-a-room
+      def upload_file(room_id:, file:, **rest_params)
+        response = session.request_json(
+          "#{API_PREFIX}/rooms.upload/#{room_id}",
+          method: :post,
+          form_data: file_upload_hash(file: file, **rest_params)
+        )
+
+        RocketChat::Message.new response['message'] if response['success']
+      end
+
       private
 
       attr_reader :session
@@ -323,6 +344,11 @@ def validate_attribute(attribute)
         raise ArgumentError, "Unsettable attribute: #{attribute || 'nil'}" unless \
           self.class.settable_attributes.include?(attribute)
       end
+
+      def file_upload_hash(**params)
+        permited_keys_for_file_upload = %i[file msg description tmid]
+        Util.slice_hash(params, *permited_keys_for_file_upload)
+      end
     end
   end
 end

lib/rocket_chat/request_helper.rb

@@ -104,11 +104,14 @@ def create_http(options)
 
     def create_request(path, options)
       headers = get_headers(options)
-      body = options[:body]&.reject { |_key, value| value.nil? }
+      body = reject_nils(options[:body])
 
       if options[:method] == :post
         req = Net::HTTP::Post.new(path, headers)
         add_body(req, body) if body
+
+        form_data = reject_nils(options[:form_data])
+        add_form_data(req, form_data) if form_data
       else
         uri = path
         uri += "?#{URI.encode_www_form(body)}" if body
@@ -126,5 +129,14 @@ def add_body(request, body)
         request.body = body.to_s
       end
     end
+
+    def add_form_data(request, form_data)
+      form_data = form_data.transform_keys(&:to_s) if form_data.is_a? Hash
+      request.set_form(form_data, 'multipart/form-data')
+    end
+
+    def reject_nils(data)
+      data&.reject { |_key, value| value.nil? }
+    end
   end
 end

spec/fixtures/files/iterm-theme.itermcolors

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+</dict>
+</plist>

spec/fixtures/messages/room/upload/file_upload_success.json

@@ -0,0 +1,62 @@
+{
+    "message": {
+        "_id": "%{message_id}",
+        "rid": "%{room_id}",
+        "ts": "2023-07-06T12:05:07.127Z",
+        "file": {
+            "_id": "%{file_id}",
+            "name": "%{file_name}",
+            "type": "application/octet-stream"
+        },
+        "files": [
+            {
+                "_id": "%{file_id}",
+                "name": "%{file_name}",
+                "type": "application/octet-stream"
+            }
+        ],
+        "attachments": [
+            {
+                "ts": "1970-01-01T00:00:00.000Z",
+                "title": "%{file_name}",
+                "title_link": "/file-upload/%{file_id}/%{file_name}",
+                "title_link_download": true,
+                "type": "file",
+                "description": "%{description}",
+                "format": "%{format}",
+                "size": 8347,
+                "descriptionMd": [
+                    {
+                        "type": "PARAGRAPH",
+                        "value": [
+                            {
+                                "type": "PLAIN_TEXT",
+                                "value": "%{description}"
+                            }
+                        ]
+                    }
+                ]
+            }
+        ],
+        "msg": "%{msg}",
+        "u": {
+            "_id": "%{user_id}",
+            "username": "admin",
+            "name": "Admin"
+        },
+        "_updatedAt": "2023-07-06T12:05:07.264Z",
+        "urls": [],
+        "md": [
+            {
+                "type": "PARAGRAPH",
+                "value": [
+                    {
+                        "type": "PLAIN_TEXT",
+                        "value": "%{msg}"
+                    }
+                ]
+            }
+        ]
+    },
+    "success": true
+}

spec/fixtures/messages/room/upload/file_upload_without_message_success.json

@@ -0,0 +1,40 @@
+
+{
+    "message": {
+        "_id": "%{message_id}",
+        "rid": "%{room_id}",
+        "ts": "2023-07-07T10:03:44.048Z",
+        "file": {
+            "_id": "%{file_id}",
+            "name": "%{file_name}",
+            "type": "application/octet-stream"
+        },
+        "files": [
+            {
+                "_id": "%{file_id}",
+                "name": "%{file_name}",
+                "type": "application/octet-stream"
+            }
+        ],
+        "attachments": [
+            {
+                "ts": "1970-01-01T00:00:00.000Z",
+                "title": "%{file_name}",
+                "title_link": "/file-upload/%{file_id}/%{file_name}",
+                "title_link_download": true,
+                "type": "file",
+                "format": "%{format}",
+                "size": 8347
+            }
+        ],
+        "msg": "",
+        "u": {
+            "_id": "%{user_id}",
+            "username": "rocket_admin",
+            "name": "Admin"
+        },
+        "_updatedAt": "2023-07-07T10:03:44.097Z",
+        "urls": []
+    },
+    "success": true
+}

spec/fixtures/messages/room/upload/no_accepted_error.json

@@ -0,0 +1,5 @@
+{
+    "success": false,
+    "error": "File type is not accepted. [error-invalid-file-type]",
+    "errorType": "error-invalid-file-type"
+}

spec/fixtures/messages/room/upload/no_file_error.json

@@ -0,0 +1,5 @@
+{
+    "success": false,
+    "error": "[No file uploaded]",
+    "errorType": "No file uploaded"
+}

spec/fixtures/messages/room/upload/png_upload_success.json

@@ -0,0 +1,73 @@
+{
+    "message": {
+        "_id": "%{message_id}",
+        "rid": "%{room_id}",
+        "ts": "2023-07-07T08:05:32.625Z",
+        "file": {
+            "_id": "%{file_id}",
+            "name": "%{file_name}",
+            "type": "image/png"
+        },
+        "files": [
+            {
+                "_id": "%{file_id}",
+                "name": "%{file_name}",
+                "type": "image/png"
+            },
+            {
+                "_id": "%{preview_file_id}",
+                "name": "%{file_name}",
+                "type": "image/png"
+            }
+        ],
+        "attachments": [
+            {
+                "ts": "1970-01-01T00:00:00.000Z",
+                "title": "%{file_name}",
+                "title_link": "/file-upload/%{file_id}/%{file_name}",
+                "title_link_download": true,
+                "image_dimensions": {
+                    "width": 480,
+                    "height": 300
+                },
+                "image_preview": "/9j/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAAUACADASIAAhEBAxEB/8QAGQAAAwADAAAAAAAAAAAAAAAAAAIDAQQH/8QAHxABAAICAgIDAAAAAAAAAAAAAQACAxESIRMxBEFS/8QAFgEBAQEAAAAAAAAAAAAAAAAAAAUC/8QAFREBAQAAAAAAAAAAAAAAAAAAAAH/2gAMAwEAAhEDEQA/AOFx8PEuche4FtG+PUal26V0SgiFza8jr1JsrZCzyO4rY/MALutfUxRS4kIQK4jy5kv2Tcr8XE1XXo3CEzSP/9k=",
+                "image_url": "/file-upload/%{preview_file_id}/%{file_name}",
+                "image_type": "image/png",
+                "image_size": 103724,
+                "type": "file",
+                "description": "%{description}",
+                "descriptionMd": [
+                    {
+                        "type": "PARAGRAPH",
+                        "value": [
+                            {
+                                "type": "PLAIN_TEXT",
+                                "value": "%{description}"
+                            }
+                        ]
+                    }
+                ]
+            }
+        ],
+        "msg": "%{msg}",
+        "u": {
+            "_id": "%{user_id}",
+            "username": "admin",
+            "name": "Admin"
+        },
+        "_updatedAt": "2023-07-07T08:05:32.669Z",
+        "urls": [],
+        "md": [
+            {
+                "type": "PARAGRAPH",
+                "value": [
+                    {
+                        "type": "PLAIN_TEXT",
+                        "value": "%{msg}"
+                    }
+                ]
+            }
+        ]
+    },
+    "success": true
+}