rocketchat 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d1c8a93431402bbb37c5c6ec923e77c05aa3aeccab7a0e0cd598c14cabd495
-  data.tar.gz: b4c605b263d57257cc3285449988ee7bec9272fb24af6ef70c1a759810c65562
+  metadata.gz: a9dd649b2ce883c528aaaa759be25034b0bf112b4c5e21ac3c9202fab78a6baa
+  data.tar.gz: 23e96835f8b14e4601b78bc10506ee222665acc5409b45380572007db067f765
 SHA512:
-  metadata.gz: 2516550605f1ef594a60c13604400f863c36fe7da3f0fd06167c415cd3428f6181d8ff615835c57e3fb41282ac3b8e46b6abcd5a01436bd04068a6bff3566261
-  data.tar.gz: a897b18924cbd3631e2d071badeb0bfb91ea09e9ef7c2e4a6b17b8f322d45200ddea061026edaad6581d0e4343d0c9a961458160551d29f816937b536b6f5d8c
+  metadata.gz: 9977334377d472e5e51b941f4cf359473b588d2572965bde362d79ffe09e3afc8defdfd47904a32e1e12e47f368917447dc8710227c24d76155d74ea6ee301be
+  data.tar.gz: 82fe7597f43165cedeae9328e2cf8145d9bc5cc0b39f924dfed7580262c1e112a010e5e5711ca74396ee494ffb7855e6aae51adb8c7f6790f7117be54b297569

data/.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2']
 
     steps:
       - uses: actions/checkout@v2

data/.rubocop.yml

@@ -41,6 +41,9 @@ Metrics/MethodLength:
 RSpec/ExampleLength:
   Max: 10
 
+RSpec/IndexedLet:
+  Max: 2
+
 RSpec/MultipleExpectations:
   Max: 5
 

data/CHANGELOG.md

@@ -3,6 +3,19 @@
 ## Unreleased
 - None
 
+## [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][])
+- [#44] Add support for thread messages ([@MrRTI][])
+
+### Fixed
+- [#45] Fixed some rubocop lints ([@abrom][])
+
+
 ## [0.2.1](releases/tag/v0.2.1) - 2022-12-19
 ### Fixed
 - [#41] URL-encode param values in GET query strings ([@nmagedman][])
@@ -131,3 +144,4 @@
 [@christianmoretti]: https://github.com/christianmoretti
 [@alinavancea]: https://github.com/alinavancea
 [@nmagedman]: https://github.com/nmagedman
+[@MrRTI]: https://github.com/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.1'
+  VERSION = '0.2.3'
 end

data/lib/rocket_chat/message.rb

@@ -20,6 +20,11 @@ module RocketChat
       data['_id']
     end
 
+    # Message thread id
+    def tmid
+      data['tmid']
+    end
+
     # Timestamp
     def timestamp
       Time.parse data['ts']
@@ -67,7 +72,8 @@ module RocketChat
         object_id: object_id,
         id: id,
         room_id: room_id,
-        message: message
+        message: message,
+        tmid: tmid
       )
     end
   end

data/lib/rocket_chat/messages/chat.rb

@@ -55,7 +55,7 @@ module RocketChat
       # @param [String] room_id Rocket.Chat room id
       # @param [String] name Rocket.Chat room name (coming soon)
       # @param [String] channel Rocket.Chat channel name
-      # @param [Hash] params Optional params (text, alias, emoji, avatar & attachments)
+      # @param [Hash] params Optional params (text, alias, emoji, tmid, avatar & attachments)
       # @return [RocketChat::Message]
       # @raise [HTTPError, StatusError]
       #
@@ -65,7 +65,7 @@ module RocketChat
           method: :post,
           body: room_params(room_id, name)
             .merge(channel: channel)
-            .merge(Util.slice_hash(params, :text, :alias, :emoji, :avatar, :attachments))
+            .merge(Util.slice_hash(params, :text, :alias, :tmid, :emoji, :avatar, :attachments))
         )
         RocketChat::Message.new response['message'] if response['success']
       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_hash(file: file, **rest_params)
+        )
+
+        RocketChat::Message.new response['message'] if response['success']
+      end
+
       private
 
       attr_reader :session
@@ -323,6 +344,11 @@ module RocketChat
         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

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 = 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 @@ module RocketChat
         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

data/lib/rocket_chat/util.rb

@@ -32,7 +32,7 @@ module RocketChat
     # @return Hash filtered by keys
     #
     def slice_hash(hash, *keys)
-      return {} if keys.length.zero?
+      return {} if keys.empty?
 
       new_hash = {}
       hash.each do |key, value|

data/rocketchat.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Rocket.Chat REST API v1 for Ruby'
   spec.homepage      = 'https://github.com/abrom/rocketchat-ruby'
   spec.license       = 'MIT'
-  spec.required_ruby_version = ['>= 2.5.0', '< 3.2.0']
+  spec.required_ruby_version = ['>= 2.5.0', '< 3.3.0']
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
@@ -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.1
+  version: 0.2.3
 platform: ruby
 authors:
 - int512
@@ -9,160 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-19 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-08-22 00:00:00.000000000 Z
+dependencies: []
 description: Rocket.Chat REST API v1 for Ruby
 email:
 - github@int512.net
@@ -223,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="