rocketchat 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a6c0288c4420a286b0444dc84749e572fa40806874616673a360a509dfa90f8
-  data.tar.gz: e6d74695c8e75fa49c51f4de0e6db86476b965351a9a7231d9f57b5a59d70bd1
+  metadata.gz: c8dcf3e2e38671372e85fa5f8791ef9014ee5e7a506fa8b4ab896e4e6658afea
+  data.tar.gz: ac550d2d5baae28a8dfa2337c67ae4498b05871c9b5089ae57f1dd07cf6aecd7
 SHA512:
-  metadata.gz: bbecd274cd60768eb7fcc19a95cd9652d474405bb80047aa16e51a700b2468b1057cdfe907ab093471e4227a6870924b05c89cb41a2be8742c7a5ddb4e6a6248
-  data.tar.gz: f6e927d6dca42397da5ea9517033e9549f9ebc238e1f994aee63ef5f33644d497330a4dfd74426f3564f71223af257a79678ac346bce5dc4610d5e95423977ba
+  metadata.gz: ab31a6c39910bb896658c1ea78342a25b6dcaf1e931260700871ff3b6e90b343a781175cc1115df260e2ce03b7a30373c28c446dc5e02455dc2e5abb62c720e2
+  data.tar.gz: 6c173e1f07a55d49ffad6d0c8f9db83b6b0d29340ca475bf0fcfc1792e5f3b5d20af7d1d9fb3f0aa32f059fe963924c35007748082132f6949dd9441d2c8d16b

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 ## Unreleased
 - None
 
+## [0.2.4](releases/tag/v0.2.4) - 2023-12-22
+### Added
+- [#47] Add content-type and filename params for file upload ([@MrRTI][])
+
+## [0.2.3](releases/tag/v0.2.3) - 2023-08-22
+### Added
+- [#46] Add file upload support using rooms.upload endpoint ([@MrRTI][])
+
 ## [0.2.2](releases/tag/v0.2.2) - 2023-04-21
 ### Added
 - [#43] Add Ruby 3.2 support ([@MrRTI][])

data/Gemfile

@@ -4,3 +4,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rocketchat.gemspec
 gemspec
+
+gem 'bundler', ['>= 1.11', '< 3.0']
+gem 'rake', '>= 12.3.3'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.28'
+gem 'rubocop-performance', '~> 1.13'
+gem 'rubocop-rake', '~> 0.6'
+gem 'rubocop-rspec', '~> 2.10'
+gem 'simplecov', '~> 0.16', '< 0.18'
+gem 'webmock', '~> 3.12'
+gem 'yard', '~> 0.9.11'

data/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)

data/lib/rocket_chat/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RocketChat
-  VERSION = '0.2.2'
+  VERSION = '0.2.4'
 end

data/lib/rocket_chat/messages/room.rb

@@ -9,6 +9,8 @@ module RocketChat
       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 @@ module RocketChat
 
       # Full API path to call
       def self.api_path(method)
-        "/api/v1/#{collection}.#{method}"
+        "#{API_PREFIX}/#{collection}.#{method}"
       end
 
       #
@@ -304,6 +306,25 @@ module RocketChat
         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_array(file: file, **rest_params)
+        )
+
+        RocketChat::Message.new response['message'] if response['success']
+      end
+
       private
 
       attr_reader :session
@@ -323,6 +344,19 @@ module RocketChat
         raise ArgumentError, "Unsettable attribute: #{attribute || 'nil'}" unless \
           self.class.settable_attributes.include?(attribute)
       end
+
+      def file_upload_array(**params)
+        permited_keys_for_file_upload = %i[file msg description tmid]
+        hash = Util.slice_hash(params, *permited_keys_for_file_upload).compact
+
+        # NOTE: https://docs.ruby-lang.org/en/master/Net/HTTPHeader.html#method-i-set_form
+        file_options = params.slice(:filename, :content_type).compact
+        hash.map do |key, value|
+          next [key.to_s, value, file_options] if key == :file && file_options.keys.any?
+
+          [key.to_s, value]
+        end
+      end
     end
   end
 end

data/lib/rocket_chat/request_helper.rb

@@ -104,11 +104,14 @@ module RocketChat
 
     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 = 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,13 @@ module RocketChat
         request.body = body.to_s
       end
     end
+
+    def add_form_data(request, form_data)
+      request.set_form(form_data, 'multipart/form-data')
+    end
+
+    def reject_nils(data)
+      data&.reject { |_key, value| value.nil? }
+    end
   end
 end

data/rocketchat.gemspec

@@ -27,15 +27,4 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docs)/}) }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', ['>= 1.11', '< 3.0']
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.28'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.13'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
-  spec.add_development_dependency 'simplecov', '~> 0.16', '< 0.18'
-  spec.add_development_dependency 'webmock', '~> 3.12'
-  spec.add_development_dependency 'yard', '~> 0.9.11'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - int512
@@ -9,160 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.11'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.10'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
+date: 2023-12-22 00:00:00.000000000 Z
+dependencies: []
 description: Rocket.Chat REST API v1 for Ruby
 email:
 - github@int512.net
@@ -230,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Rocket.Chat REST API v1 for Ruby