rocketchat 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7daacf63eeac8a39cca2b669985a82f050d986fc
-  data.tar.gz: bfe5f9c723868a932e25a2553e8fa46105d9077f
+  metadata.gz: 21b04d366533b1fbb66982a06d1d62a7e36b6cf3
+  data.tar.gz: 0461e4015cad44bba749c51b75cba313d277b765
 SHA512:
-  metadata.gz: add0b41372ce7ab821f78d9d071f390e13d137ebf64748474ae98a8b9f49313dfea733e158e0677fd668464a0625792ddba9f0591ae05e7c47b6a87a275f3041
-  data.tar.gz: 15d887ac7c5bc4d19f68bdb4299b9c09450d6069b69f1b42353b87d4a44fc83c2b4f576e7e4cea91bbfb08c6329f757a07acaa1d0c93fc66b3350cbf609ceb34
+  metadata.gz: 8e398ff7c92a611a85dcf154a2b62ac3e97d51fdee28bccfd6286f235c689022dbe90973d21133bb6d2a02ef5feca0b8f65ce3c431f61af7c507d1c51b4517ce
+  data.tar.gz: b15f9cf6e41c60c39f4c58f0328766164c41899ae74cb07b204af6c7e565627d1b32801d80036c1edf48894be73954621ce7aa37175776063fbd10e45b494037

data/.rubocop.yml

@@ -10,3 +10,7 @@ Metrics/MethodLength:
   Max: 15
   Exclude:
     - "**/*_spec.rb"
+
+Style/NumericLiterals:
+  Exclude:
+    - "**/*_spec.rb"

data/README.md

@@ -35,7 +35,14 @@ This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.
 * [/api/v1/logout](#authentication)
 * /api/v1/me
 
+#### Chat
+* /api/v1/chat.delete
+* /api/v1/chat.getMessage
+* /api/v1/chat.postMessage
+* /api/v1/chat.update
+
 #### Channels
+* /api/v1/channels.archive
 * [/api/v1/channels.create](docs/channels.md#channelscreate)
 * [/api/v1/channels.delete](docs/channels.md#channelsdelete)
 * [/api/v1/channels.info](docs/channels.md#channelsinfo)
@@ -50,8 +57,10 @@ This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.
 * [/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)
+* /api/v1/channels.unarchive
 
 #### Groups
+* /api/v1/groups.archive
 * /api/v1/groups.create
 * /api/v1/groups.delete
 * /api/v1/groups.info
@@ -64,6 +73,7 @@ This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.
 * /api/v1/groups.setReadOnly
 * /api/v1/groups.setTopic
 * /api/v1/groups.setType
+* /api/v1/groups.unarchive
 
 #### 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.7'.freeze
+  VERSION = '0.1.8'.freeze
 end

data/lib/rocket_chat/message.rb

@@ -0,0 +1,72 @@
+module RocketChat
+  #
+  # Rocket.Chat Message
+  #
+  class Message
+    # Raw user data
+    attr_reader :data
+
+    #
+    # @param [Hash] data Raw message data
+    #
+    def initialize(data)
+      @data = Util.stringify_hash_keys data
+    end
+
+    # Message ID
+    def id
+      data['_id']
+    end
+
+    # Timestamp
+    def timestamp
+      DateTime.parse data['ts']
+    end
+
+    # Updated at
+    def updated_at
+      DateTime.parse data['_updatedAt']
+    end
+
+    # Room ID
+    def room_id
+      data['rid']
+    end
+
+    # User
+    def user
+      User.new data['u']
+    end
+
+    # Message
+    def message
+      data['msg']
+    end
+
+    # Alias
+    def alias
+      data['alias']
+    end
+
+    # Parse URLs
+    def parse_urls
+      data['parseUrls']
+    end
+
+    # Groupable
+    def groupable
+      data['groupable']
+    end
+
+    def inspect
+      format(
+        '#<%s:0x%p @id="%s" @room="%s" @msg="%s">',
+        self.class.name,
+        object_id,
+        id,
+        room_id,
+        message
+      )
+    end
+  end
+end

data/lib/rocket_chat/messages/chat.rb

@@ -0,0 +1,94 @@
+module RocketChat
+  module Messages
+    #
+    # Rocket.Chat Chat messages
+    #
+    class Chat
+      include RoomSupport
+
+      #
+      # @param [Session] session Session
+      #
+      def initialize(session)
+        @session = session
+      end
+
+      #
+      # chat.delete REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name (coming soon)
+      # @param [String] msg_id The message id to delete
+      # @param [Boolean] as_user Message deleted as user who sent (optional - default: false)
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def delete(room_id: nil, name: nil, msg_id:, as_user: nil)
+        session.request_json(
+          '/api/v1/chat.delete',
+          method: :post,
+          body:
+            room_params(room_id, name).tap do |h|
+              h[:msgId] = msg_id
+              h[:asUser] = as_user unless as_user.nil?
+            end
+        )['success']
+      end
+
+      #
+      # chat.getMessage REST API
+      # @param [String] msg_id The message id to return
+      # @return [RocketChat::Message]
+      # @raise [HTTPError, StatusError]
+      #
+      def get_message(msg_id:)
+        response = session.request_json(
+          '/api/v1/chat.getMessage',
+          body: { msgId: msg_id }
+        )
+        RocketChat::Message.new response['message'] if response['success']
+      end
+
+      #
+      # chat.postMessage REST API
+      # @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)
+      # @return [RocketChat::Message]
+      # @raise [HTTPError, StatusError]
+      #
+      def post_message(room_id: nil, name: nil, channel:, **params)
+        response = session.request_json(
+          '/api/v1/chat.postMessage',
+          method: :post,
+          body: room_params(room_id, name)
+            .merge(channel: channel)
+            .merge(Util.slice_hash(params, :text, :alias, :emoji, :avatar, :attachments))
+        )
+        RocketChat::Message.new response['message'] if response['success']
+      end
+
+      #
+      # chat.update REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Rocket.Chat room name (coming soon)
+      # @param [String] msg_id The message id to update
+      # @param [String] text Updated text for the message
+      # @return [RocketChat::Message]
+      # @raise [HTTPError, StatusError]
+      #
+      def update(room_id: nil, name: nil, msg_id:, text:)
+        response = session.request_json(
+          '/api/v1/chat.update',
+          method: :post,
+          body: room_params(room_id, name).merge(msgId: msg_id, text: text)
+        )
+        RocketChat::Message.new response['message'] if response['success']
+      end
+
+      private
+
+      attr_reader :session
+    end
+  end
+end

data/lib/rocket_chat/messages/room.rb

@@ -4,6 +4,7 @@ module RocketChat
     # Rocket.Chat Room messages template (groups&channels)
     #
     class Room # rubocop:disable Metrics/ClassLength
+      include RoomSupport
       include UserSupport
 
       def self.inherited(subclass)
@@ -213,16 +214,6 @@ module RocketChat
 
       attr_reader :session
 
-      def room_params(id, name)
-        if id
-          { roomId: id }
-        elsif name
-          { roomName: name }
-        else
-          {}
-        end
-      end
-
       def room_option_hash(options)
         args = [options, :members, :read_only, :custom_fields]
 

data/lib/rocket_chat/messages/room_support.rb

@@ -0,0 +1,18 @@
+module RocketChat
+  module Messages
+    #
+    # Room params builder for calls with room parameters
+    #
+    module RoomSupport
+      def room_params(id, name)
+        if id
+          { roomId: id }
+        elsif name
+          { roomName: name }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/rocket_chat/session.rb

@@ -54,6 +54,10 @@ module RocketChat
       @users ||= RocketChat::Messages::User.new(self)
     end
 
+    def chat
+      @chat ||= RocketChat::Messages::Chat.new(self)
+    end
+
     #
     # Settings messages proxy
     # @return [Messages::Settings]

data/lib/rocket_chat/util.rb

@@ -10,7 +10,14 @@ module RocketChat
     #
     def stringify_hash_keys(hash)
       new_hash = {}
-      hash.each { |key, value| new_hash[key.to_s] = value }
+      hash.each do |key, value|
+        new_hash[key.to_s] =
+          if value.is_a? Hash
+            stringify_hash_keys value
+          else
+            value
+          end
+      end
       new_hash
     end
     module_function :stringify_hash_keys

data/lib/rocketchat.rb

@@ -1,6 +1,7 @@
 require 'rocket_chat/gem_version'
 
 require 'json'
+require 'date'
 
 require 'rocket_chat/error'
 require 'rocket_chat/util'
@@ -8,11 +9,13 @@ require 'rocket_chat/request_helper'
 
 require 'rocket_chat/messages/list_support'
 require 'rocket_chat/messages/user_support'
+require 'rocket_chat/messages/room_support'
 require 'rocket_chat/messages/user'
 require 'rocket_chat/messages/settings'
 require 'rocket_chat/messages/room'
 require 'rocket_chat/messages/channel'
 require 'rocket_chat/messages/group'
+require 'rocket_chat/messages/chat'
 
 require 'rocket_chat/server'
 require 'rocket_chat/session'
@@ -21,3 +24,4 @@ require 'rocket_chat/token'
 require 'rocket_chat/presence_status'
 require 'rocket_chat/room'
 require 'rocket_chat/user'
+require 'rocket_chat/message'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - int512
@@ -115,10 +115,13 @@ files:
 - lib/rocket_chat/error.rb
 - lib/rocket_chat/gem_version.rb
 - lib/rocket_chat/info.rb
+- lib/rocket_chat/message.rb
 - lib/rocket_chat/messages/channel.rb
+- lib/rocket_chat/messages/chat.rb
 - lib/rocket_chat/messages/group.rb
 - lib/rocket_chat/messages/list_support.rb
 - lib/rocket_chat/messages/room.rb
+- lib/rocket_chat/messages/room_support.rb
 - lib/rocket_chat/messages/settings.rb
 - lib/rocket_chat/messages/user.rb
 - lib/rocket_chat/messages/user_support.rb