rocketchat 0.1.21 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0414d925c282330700662c6a617328a2c91610c5969285da247c653a1b512133
-  data.tar.gz: db1fab6b741dd083488e1a1b60f36fff5130e5cff10ee88ed2847ef4853cee14
+  metadata.gz: e905853c710d76e1eef50b102b93632c5523713d142bd3cfe940995b39ae427c
+  data.tar.gz: '08ab172483429ae969d957ab0a30a2a0336d701c116719fd061911978b9f1fb7'
 SHA512:
-  metadata.gz: 002475521b99ee9dcc766622ed1630c08daf488ba68c0f10dd620b568882b022aace8e79a6f2419b8fa6d8780290ea2df442b1537118d97415ca759cb53254bc
-  data.tar.gz: 6f896d0c30470e16702567320ed083c63d6cce9325734295bfd553d710f8669bfd11148d79c590a89465ba06f0e7be870c02679ddab01d60858be9af6ab7b9bb
+  metadata.gz: ac016a85545fea96d9d7d9acf798a22ead3eaa31215e2a61a31d696aa43606bee50999f4c9e1d3174b6bdcf03d0c45d3006eff105203bf6d078bd1a221aa51e0
+  data.tar.gz: 471b76b3a12f47304e26f356218c8d90bc981755ecfc8499724c94d099b40a8f7f34968f3faa912f396dcc108dda20f618cb782a2107f9aef1c305000be0e643

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: Test RocketChat Ruby gem
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Lint code - Rubocop
+        run: bundle exec rubocop
+
+      - name: Run tests
+        run: bundle exec rspec
+
+      - name: Test & publish code coverage
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: abf0a371ff8851f13b563671914b195bb46f0997f0f93142e666d9acad08e22f

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 ## Unreleased
 - None
 
+## [0.1.23](releases/tag/v0.1.23) - 2022-11-11
+### Added
+- [#40] Add set_attr options for announcement, custom_fields and default for channels/groups ([@reist][],[@nmagedman][])
+
+## [0.1.22](releases/tag/v0.1.22) - 2022-07-21
+### Fixed
+- [#38] Fix room (channel/group) online API queries (use `query` instead of `roomId`) ([@abrom][])
+
 ## [0.1.21](releases/tag/v0.1.21) - 2021-08-30
 ### Added
 - [#36] Improve support for various REST APIs ([@abrom][])
@@ -118,4 +126,4 @@
 [@chrisstime]: https://github.com/chrisstime
 [@christianmoretti]: https://github.com/christianmoretti
 [@alinavancea]: https://github.com/alinavancea
-              
+[@nmagedman]: https://github.com/nmagedman

data/lib/rocket_chat/gem_version.rb

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

data/lib/rocket_chat/messages/channel.rb

@@ -46,19 +46,24 @@ module RocketChat
       #
       # channels.online REST API
       # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name
       # @return [Users[]]
+      # @note Must provide either `room_id` or `name` parameter. `room_id` will take precedence if providing both
       # @raise [HTTPError, StatusError]
       #
       def online(room_id: nil, name: nil)
         response = session.request_json(
           '/api/v1/channels.online',
-          body: room_params(room_id, name)
+          body: { query: room_query_params(room_id, name) }
         )
 
         response['online'].map { |hash| RocketChat::User.new hash } if response['success']
       end
 
       # Keys for set_attr:
+      # * [String] announcement Announcement for the channel
+      # * [Hash] custom_fields Custom fields for the channel
+      # * [Boolean] default Sets whether the channel is a default channel or not
       # * [String] description A room's description
       # * [String] join_code Code to join a channel
       # * [String] purpose Alias for description
@@ -66,7 +71,7 @@ module RocketChat
       # * [String] topic A room's topic
       # * [Strong] type c (channel) or p (private group)
       def self.settable_attributes
-        %i[description join_code purpose read_only topic type]
+        %i[announcement custom_fields default description join_code purpose read_only topic type]
       end
     end
   end

data/lib/rocket_chat/messages/group.rb

@@ -77,26 +77,30 @@ module RocketChat
       #
       # groups.online REST API
       # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name
       # @return [Users[]]
+      # @note Must provide either `room_id` or `name` parameter. `room_id` will take precedence if providing both
       # @raise [HTTPError, StatusError]
       #
       def online(room_id: nil, name: nil)
         response = session.request_json(
           '/api/v1/groups.online',
-          body: room_params(room_id, name)
+          body: { query: room_query_params(room_id, name) }
         )
 
         response['online'].map { |hash| RocketChat::User.new hash } if response['success']
       end
 
       # Keys for set_attr:
+      # * [String] announcement Announcement for the channel
+      # * [Hash] custom_fields Custom fields for the channel
       # * [String] description A room's description
       # * [String] purpose Alias for description
       # * [Boolean] read_only Read-only status
       # * [String] topic A room's topic
       # * [Strong] type c (channel) or p (private group)
       def self.settable_attributes
-        %i[description purpose read_only topic type]
+        %i[announcement custom_fields description purpose read_only topic type]
       end
     end
   end

data/lib/rocket_chat/messages/room.rb

@@ -309,7 +309,7 @@ module RocketChat
       attr_reader :session
 
       def room_option_hash(options)
-        args = [options, :members, :read_only, :custom_fields]
+        args = [options, :members, :read_only, :custom_fields, :extra_data]
 
         options = Util.slice_hash(*args)
         return {} if options.empty?

data/lib/rocket_chat/messages/room_support.rb

@@ -15,6 +15,16 @@ module RocketChat
           {}
         end
       end
+
+      def room_query_params(id, name)
+        if id
+          { _id: id }
+        elsif name
+          { name: name }
+        else
+          {}
+        end.to_json
+      end
     end
   end
 end

data/rocketchat.gemspec

@@ -15,7 +15,14 @@ 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.1.0']
+  spec.required_ruby_version = ['>= 2.5.0', '< 3.2.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.
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   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) }
@@ -24,11 +31,11 @@ Gem::Specification.new do |spec|
   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.12'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.10'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.2'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
+  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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.23
 platform: ruby
 authors:
 - int512
 - abrom
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,56 +65,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -129,6 +132,9 @@ dependencies:
     - - "~>"
       - !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
@@ -166,9 +172,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -203,8 +209,10 @@ files:
 homepage: https://github.com/abrom/rocketchat-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,15 +223,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Rocket.Chat REST API v1 for Ruby
 test_files: []

data/.travis.yml

@@ -1,30 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=abf0a371ff8851f13b563671914b195bb46f0997f0f93142e666d9acad08e22f
-
-language: ruby
-
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-
-before_install:
-  - gem update bundler
-
-install:
-  - bundle install --jobs=3 --retry=3
-  - gem install rubocop
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-
-script:
-  - bundle exec rubocop
-  - bundle exec rake
-
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT