rocketchat 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63395cd09bc2b53e342ce3d90fac28b2891d6021
-  data.tar.gz: 2be643107b5c947a9d775b208ba1fdeca8ac8d7e
+  metadata.gz: ed12cd37565f3e4906733b1023bfac88e5a6f3cb
+  data.tar.gz: cd0d89858645ca5385aca940d2ba7efd7f4357a4
 SHA512:
-  metadata.gz: 49ff8a992f56000de70631349a03b86d2ecc2b5002b2d430d59fb24ef08176406c40afba5ef1d32a0dc27306cc63f114f54f035b7c4083db572f9c66f3f8b98b
-  data.tar.gz: a9d75b6c61ccdd46f65241b37484f90a95f90ac9df1f757360ad59718180d7aa5486944c91c005a353099f1f2b53df012e34b814ad7781973c69d7e7db76c1a1
+  metadata.gz: a2cbd52d970d141b7938dfbd8ffbbf3bad29b0f38788e1da079b63ac67c78dfb2bd5338d8f87fd10ff98d1ebee97b01495ccf452404e6be381dc1f8e0b277bad
+  data.tar.gz: 5879c04d4384ef56ac148c9608a4c7606c1521e4d3b2336021ee43fbe7d76c0a775caead524cb7ca49a66e35f5411faab267bbdbf59c46e35f7a7ecab32d0086

data/README.md

@@ -37,15 +37,33 @@ This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.
 
 #### Channels
 * [/api/v1/channels.create](docs/channels.md#channelscreate)
+* [/api/v1/channels.delete](docs/channels.md#channelsdelete)
 * [/api/v1/channels.info](docs/channels.md#channelsinfo)
+* [/api/v1/channels.invite](docs/channels.md#channelsinvite)
+* [/api/v1/channels.join](docs/channels.md#channelsjoin)
+* [/api/v1/channels.leave](docs/channels.md#channelsleave)
 * [/api/v1/channels.list](docs/channels.md#channelslist)
 * [/api/v1/channels.rename](docs/channels.md#channelsrename)
+* [/api/v1/channels.setDescription](docs/channels.md#channelsset_attr)
+* [/api/v1/channels.setJoinCode](docs/channels.md#channelsset_attr)
+* [/api/v1/channels.setPurpose](docs/channels.md#channelsset_attr)
+* [/api/v1/channels.setReadOnly](docs/channels.md#channelsset_attr)
+* [/api/v1/channels.setTopic](docs/channels.md#channelsset_attr)
+* [/api/v1/channels.setType](docs/channels.md#channelsset_attr)
 
 #### Groups
 * /api/v1/groups.create
+* /api/v1/groups.delete
 * /api/v1/groups.info
+* /api/v1/groups.invite
+* /api/v1/groups.leave
 * [/api/v1/groups.list](docs/groups.md#groupslist)
 * /api/v1/groups.rename
+* /api/v1/groups.setDescription
+* /api/v1/groups.setPurpose
+* /api/v1/groups.setReadOnly
+* /api/v1/groups.setTopic
+* /api/v1/groups.setType
 
 #### Users
 * [/api/v1/users.create](docs/users.md#userscreate)

data/lib/rocket_chat/gem_version.rb

@@ -1,3 +1,3 @@
 module RocketChat
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/lib/rocket_chat/messages/channel.rb

@@ -6,6 +6,22 @@ module RocketChat
     class Channel < Room
       include ListSupport
 
+      #
+      # channels.join REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name (coming soon)
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def join(room_id: nil, name: nil)
+        session.request_json(
+          '/api/v1/channels.join',
+          method: :post,
+          body: room_params(room_id, name)
+        )['success']
+      end
+
+      #
       # channels.list REST API
       # @param [Integer] offset Query offset
       # @param [Integer] count Query count/limit
@@ -23,6 +39,17 @@ module RocketChat
 
         response['channels'].map { |hash| RocketChat::Room.new hash } if response['success']
       end
+
+      # Keys for set_attr:
+      # * [String] description A room's description
+      # * [String] join_code Code to join a channel
+      # * [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 join_code purpose read_only topic type]
+      end
     end
   end
 end

data/lib/rocket_chat/messages/group.rb

@@ -6,6 +6,44 @@ module RocketChat
     class Group < Room
       include ListSupport
 
+      #
+      # *.add_leader REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] leader Rocket.Chat user id
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def add_leader(room_id: nil, user_id: nil)
+        session.request_json(
+          self.class.api_path('addLeader'),
+          method: :post,
+          body: {
+            roomId: room_id,
+            userId: user_id
+          },
+          upstreamed_errors: ['error-room-not-found']
+        )['success']
+      end
+
+      #
+      # *.remove_leader REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] leader Rocket.Chat user id
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def remove_leader(room_id: nil, user_id: nil)
+        session.request_json(
+          self.class.api_path('removeLeader'),
+          method: :post,
+          body: {
+            roomId: room_id,
+            userId: user_id
+          },
+          upstreamed_errors: ['error-room-not-found']
+        )['success']
+      end
+
       # groups.list REST API
       # @param [Integer] offset Query offset
       # @param [Integer] count Query count/limit
@@ -22,6 +60,16 @@ module RocketChat
 
         response['groups'].map { |hash| RocketChat::Room.new hash } if response['success']
       end
+
+      # Keys for set_attr:
+      # * [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]
+      end
     end
   end
 end

data/lib/rocket_chat/messages/room.rb

@@ -3,7 +3,9 @@ module RocketChat
     #
     # Rocket.Chat Room messages template (groups&channels)
     #
-    class Room
+    class Room # rubocop:disable Metrics/ClassLength
+      include UserSupport
+
       def self.inherited(subclass)
         field = subclass.name.split('::')[-1].downcase
         collection = field + 's'
@@ -41,6 +43,60 @@ module RocketChat
         RocketChat::Room.new response[self.class.field]
       end
 
+      #
+      # *.delete REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name (coming soon)
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def delete(room_id: nil, name: nil)
+        session.request_json(
+          self.class.api_path('delete'),
+          method: :post,
+          body: room_params(room_id, name),
+          upstreamed_errors: ['error-room-not-found']
+        )['success']
+      end
+
+      #
+      # *.add_owner REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] user_id Rocket.Chat user id
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def add_owner(room_id: nil, user_id: nil)
+        session.request_json(
+          self.class.api_path('addOwner'),
+          method: :post,
+          body: {
+            roomId: room_id,
+            userId: user_id
+          },
+          upstreamed_errors: ['error-room-not-found']
+        )['success']
+      end
+
+      #
+      # *.remove_owner REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] user_id Rocket.Chat user id
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def remove_owner(room_id: nil, user_id: nil)
+        session.request_json(
+          self.class.api_path('removeOwner'),
+          method: :post,
+          body: {
+            roomId: room_id,
+            userId: user_id
+          },
+          upstreamed_errors: ['error-room-not-found']
+        )['success']
+      end
+
       #
       # *.info REST API
       # @param [String] room_id Rocket.Chat room id
@@ -58,6 +114,39 @@ module RocketChat
         RocketChat::Room.new response[self.class.field] if response['success']
       end
 
+      #
+      # *.invite REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name (coming soon)
+      # @param [String] user_id Rocket.Chat user id
+      # @param [String] username Username
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def invite(room_id: nil, name: nil, user_id: nil, username: nil)
+        session.request_json(
+          self.class.api_path('invite'),
+          method: :post,
+          body: room_params(room_id, name)
+            .merge(user_params(user_id, username))
+        )['success']
+      end
+
+      #
+      # *.leave REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name (coming soon)
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def leave(room_id: nil, name: nil)
+        session.request_json(
+          self.class.api_path('leave'),
+          method: :post,
+          body: room_params(room_id, name)
+        )['success']
+      end
+
       #
       # *.rename REST API
       # @param [String] room_id Rocket.Chat room id
@@ -73,6 +162,25 @@ module RocketChat
         )['success']
       end
 
+      #
+      # *.set* REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] new_name New room name
+      # @param [Hash] setting Single key-value
+      # @return [Boolean]
+      # @raise [ArgumentError, HTTPError, StatusError]
+      #
+      def set_attr(room_id: nil, name: nil, **setting)
+        attribute, value = setting.first
+        validate_attribute(attribute)
+        session.request_json(
+          self.class.api_path(Util.camelize("set_#{attribute}")),
+          method: :post,
+          body: room_params(room_id, name)
+            .merge(Util.camelize(attribute) => value)
+        )['success']
+      end
+
       private
 
       attr_reader :session
@@ -82,6 +190,8 @@ module RocketChat
           { roomId: id }
         elsif name
           { roomName: name }
+        else
+          {}
         end
       end
 
@@ -95,6 +205,11 @@ module RocketChat
         options.each { |key, value| new_hash[Util.camelize(key)] = value }
         new_hash
       end
+
+      def validate_attribute(attribute)
+        raise ArgumentError, "Unsettable attribute: #{attribute || 'nil'}" unless \
+          self.class.settable_attributes.include?(attribute)
+      end
     end
   end
 end

data/lib/rocket_chat/messages/user.rb

@@ -3,8 +3,9 @@ module RocketChat
     #
     # Rocket.Chat User messages
     #
-    class User # rubocop:disable Metrics/ClassLength
+    class User
       include ListSupport
+      include UserSupport
 
       #
       # @param [Session] session Session
@@ -188,14 +189,6 @@ module RocketChat
         options.each { |key, value| new_hash[Util.camelize(key)] = value }
         new_hash
       end
-
-      def user_params(id, username)
-        if id
-          { userId: id }
-        elsif username
-          { username: username }
-        end
-      end
     end
   end
 end

data/lib/rocket_chat/messages/user_support.rb

@@ -0,0 +1,18 @@
+module RocketChat
+  module Messages
+    #
+    # User params builder for calls with user parameters
+    #
+    module UserSupport
+      def user_params(id, username)
+        if id
+          { userId: id }
+        elsif username
+          { username: username }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/rocketchat.rb

@@ -7,6 +7,7 @@ require 'rocket_chat/util'
 require 'rocket_chat/request_helper'
 
 require 'rocket_chat/messages/list_support'
+require 'rocket_chat/messages/user_support'
 require 'rocket_chat/messages/user'
 require 'rocket_chat/messages/settings'
 require 'rocket_chat/messages/room'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - int512
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-09 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - lib/rocket_chat/messages/room.rb
 - lib/rocket_chat/messages/settings.rb
 - lib/rocket_chat/messages/user.rb
+- lib/rocket_chat/messages/user_support.rb
 - lib/rocket_chat/presence_status.rb
 - lib/rocket_chat/request_helper.rb
 - lib/rocket_chat/room.rb