rocketchat 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63e5c3e6c2532784d89443021ab60e3cdcd7f6a9
-  data.tar.gz: bd1d984b6706dad200ca49dde43c56de337bb4b2
+  metadata.gz: c1ece9d7db49aaf491be028d4b226e4735ac74a6
+  data.tar.gz: 0fb9b1d7cafbe4c2bde83f23fc4f21f4f75c48ef
 SHA512:
-  metadata.gz: c7d31791d785e2198e312c003a9260a75e2677b6485d7587915ee9cf7b526a54dd43ea8887a0a8e41816db597bf4bfc67cb4b293cad0de52d23085149c6a086b
-  data.tar.gz: 1c0168a638feef734657f0d6ee7190c8e10e42f19370902493618f9e314fca21bce52f593cde9c70fb68b97cd1b0ecefbd6aba0ba53b9c0559c9763e66a3db90
+  metadata.gz: 6c9db4af0f670500137e109f276c911d67517d7b8677c5999405fe7f7f0f3c5cf77e3659fdf30087085e5db7d9f36f66bfb8d398c18fa7be36ac1a57c0ad4e2f
+  data.tar.gz: 9e391cff6561058ebbbe366dcd9e9b8c06dd1e3221cee2673a21568f94a91da45c330950ca36966846163a3ee7360fe5c727d7e52a90022de92f9566d1e33a9b

data/.rubocop.yml

@@ -1,6 +1,7 @@
 Metrics/BlockLength:
   Exclude:
     - "**/*_spec.rb"
+    - "spec/shared/*.rb"
 
 Metrics/LineLength:
   Max: 120

data/README.md

@@ -35,6 +35,18 @@ This gem supports the following Rocket.Chat APIs (Tested against Rocket.Chat v0.
 * [/api/v1/logout](#authentication)
 * /api/v1/me
 
+#### Channels
+* [/api/v1/channels.create](docs/channels.md#channelscreate)
+* [/api/v1/channels.info](docs/channels.md#channelsinfo)
+* [/api/v1/channels.list](docs/channels.md#channelslist)
+* [/api/v1/channels.rename](docs/channels.md#channelsrename)
+
+#### Groups
+* /api/v1/groups.create
+* /api/v1/groups.info
+* [/api/v1/groups.list](docs/groups.md#groupslist)
+* /api/v1/groups.rename
+
 #### Users
 * [/api/v1/users.create](docs/users.md#userscreate)
 * [/api/v1/users.delete](docs/users.md#usersdelete)

data/lib/rocket_chat/gem_version.rb

@@ -1,3 +1,3 @@
 module RocketChat
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/rocket_chat/messages/channel.rb

@@ -0,0 +1,28 @@
+module RocketChat
+  module Messages
+    #
+    # Rocket.Chat Channel messages
+    #
+    class Channel < Room
+      include ListSupport
+
+      # channels.list REST API
+      # @param [Integer] offset Query offset
+      # @param [Integer] count Query count/limit
+      # @param [Hash] sort Query field sort hash. eg `{ msgs: 1, name: -1 }`
+      # @param [Hash] fields Query fields to return. eg `{ name: 1, ro: 0 }`
+      # @param [Hash] query The query. `{ active: true, type: { '$in': ['name', 'general'] } }`
+      # @return [Room[]]
+      # @raise [HTTPError, StatusError]
+      #
+      def list(offset: nil, count: nil, sort: nil, fields: nil, query: nil)
+        response = session.request_json(
+          '/api/v1/channels.list',
+          body: build_list_body(offset, count, sort, fields, query)
+        )
+
+        response['channels'].map { |hash| RocketChat::Room.new hash } if response['success']
+      end
+    end
+  end
+end

data/lib/rocket_chat/messages/group.rb

@@ -0,0 +1,27 @@
+module RocketChat
+  module Messages
+    #
+    # Rocket.Chat Group messages
+    #
+    class Group < Room
+      include ListSupport
+
+      # groups.list REST API
+      # @param [Integer] offset Query offset
+      # @param [Integer] count Query count/limit
+      # @param [Hash] sort Query field sort hash. eg `{ msgs: 1, name: -1 }`
+      # @param [Hash] fields Query fields to return. eg `{ name: 1, ro: 0 }`
+      # @return [Room[]]
+      # @raise [HTTPError, StatusError]
+      #
+      def list(offset: nil, count: nil, sort: nil, fields: nil)
+        response = session.request_json(
+          '/api/v1/groups.list',
+          body: build_list_body(offset, count, sort, fields)
+        )
+
+        response['groups'].map { |hash| RocketChat::Room.new hash } if response['success']
+      end
+    end
+  end
+end

data/lib/rocket_chat/messages/list_support.rb

@@ -0,0 +1,27 @@
+module RocketChat
+  module Messages
+    #
+    # Support methods for *.list calls
+    #
+    module ListSupport
+      private
+
+      def build_list_body(offset, count, sort, fields, query = nil)
+        body = {}
+
+        body[:offset] = offset.to_i if offset.is_a? Integer
+        body[:count] = count.to_i if count.is_a? Integer
+        [[:sort, sort], [:fields, fields], [:query, query]].each do |field, val|
+          case val
+          when Hash
+            body[field] = val.to_json
+          when String
+            body[field] = val
+          end
+        end
+
+        body
+      end
+    end
+  end
+end

data/lib/rocket_chat/messages/room.rb

@@ -0,0 +1,100 @@
+module RocketChat
+  module Messages
+    #
+    # Rocket.Chat Room messages template (groups&channels)
+    #
+    class Room
+      def self.inherited(subclass)
+        field = subclass.name.split('::')[-1].downcase
+        collection = field + 's'
+        subclass.send(:define_singleton_method, :field) { field }
+        subclass.send(:define_singleton_method, :collection) { collection }
+      end
+
+      #
+      # @param [Session] session Session
+      #
+      def initialize(session)
+        @session = session
+      end
+
+      # Full API path to call
+      def self.api_path(method)
+        "/api/v1/#{collection}.#{method}"
+      end
+
+      #
+      # *.create REST API
+      # @param [String] name Room name
+      # @param [Hash] options Additional options
+      # @return [Room]
+      # @raise [HTTPError, StatusError]
+      #
+      def create(name, options = {})
+        response = session.request_json(
+          self.class.api_path('create'),
+          method: :post,
+          body: {
+            name: name
+          }.merge(room_option_hash(options))
+        )
+        RocketChat::Room.new response[self.class.field]
+      end
+
+      #
+      # *.info REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] name Room name (channels since 0.56)
+      # @return [Room]
+      # @raise [HTTPError, StatusError]
+      #
+      def info(room_id: nil, name: nil)
+        response = session.request_json(
+          self.class.api_path('info'),
+          body: room_params(room_id, name),
+          upstreamed_errors: ['error-room-not-found']
+        )
+
+        RocketChat::Room.new response[self.class.field] if response['success']
+      end
+
+      #
+      # *.rename REST API
+      # @param [String] room_id Rocket.Chat room id
+      # @param [String] new_name New room name
+      # @return [Boolean]
+      # @raise [HTTPError, StatusError]
+      #
+      def rename(room_id, new_name)
+        session.request_json(
+          self.class.api_path('rename'),
+          method: :post,
+          body: { roomId: room_id, name: new_name }
+        )['success']
+      end
+
+      private
+
+      attr_reader :session
+
+      def room_params(id, name)
+        if id
+          { roomId: id }
+        elsif name
+          { roomName: name }
+        end
+      end
+
+      def room_option_hash(options)
+        args = [options, :members, :read_only, :custom_fields]
+
+        options = Util.slice_hash(*args)
+        return {} if options.empty?
+
+        new_hash = {}
+        options.each { |key, value| new_hash[Util.camelize(key)] = value }
+        new_hash
+      end
+    end
+  end
+end

data/lib/rocket_chat/messages/user.rb

@@ -4,6 +4,8 @@ module RocketChat
     # Rocket.Chat User messages
     #
     class User
+      include ListSupport
+
       #
       # @param [Session] session Session
       #
@@ -76,7 +78,7 @@ module RocketChat
       # @param [Integer] count Query count/limit
       # @param [Hash] sort Query field sort hash. eg `{ active: 1, email: -1 }`
       # @param [Hash] fields Query fields to return. eg `{ name: 1, email: 0 }`
-      # @param [Hash] query The query. `{ active: true, type: { $in: ['user', 'bot'] } }`
+      # @param [Hash] query The query. `{ active: true, type: { '$in': ['user', 'bot'] } }`
       # @return [User[]]
       # @raise [HTTPError, StatusError]
       #
@@ -156,18 +158,6 @@ module RocketChat
         new_hash
       end
 
-      def build_list_body(offset, count, sort, fields, query)
-        body = {}
-
-        body[:offset] = offset.to_i if offset.is_a? Integer
-        body[:count] = count.to_i if count.is_a? Integer
-        body[:sort] = sort.to_json if sort.is_a? Hash
-        body[:fields] = fields.to_json if fields.is_a? Hash
-        body[:query] = query.to_json if query.is_a? Hash
-
-        body
-      end
-
       def user_params(id, username)
         if id
           { userId: id }

data/lib/rocket_chat/room.rb

@@ -0,0 +1,94 @@
+module RocketChat
+  #
+  # Rocket.Chat Room
+  #
+  class Room
+    # Raw user data
+    attr_reader :data
+
+    TYPES = {
+      'c' => 'public',
+      'p' => 'private',
+      'd' => 'IM'
+    }.freeze
+
+    #
+    # @param [Hash] data Raw user data
+    #
+    def initialize(data)
+      @data = Util.stringify_hash_keys data
+    end
+
+    # Channel ID
+    def id
+      data['_id']
+    end
+
+    # Channel name
+    def name
+      data['name']
+    end
+
+    # Channel owner
+    def owner
+      data['u']
+    end
+
+    def created_at
+      data['ts']
+    end
+
+    def last_update
+      data['_updatedAt']
+    end
+
+    def topic
+      data['topic']
+    end
+
+    def description
+      data['description']
+    end
+
+    # Channel members
+    def members
+      data['usernames'] || []
+    end
+
+    # Read-only status
+    def read_only
+      data['ro']
+    end
+
+    # Message count
+    def message_count
+      data['msgs']
+    end
+
+    # Last message timestamp
+    def last_message
+      data['lm']
+    end
+
+    # Channel type
+    def type
+      TYPES[data['t']] || data['t']
+    end
+
+    # System messages (user left, got invited, room renamed, etc)
+    def system_messages
+      data['sysMes']
+    end
+
+    def inspect
+      format(
+        '#<%s:0x%p @id="%s" @name="%s" @type="%s">',
+        self.class.name,
+        object_id,
+        id,
+        name,
+        type
+      )
+    end
+  end
+end

data/lib/rocket_chat/session.rb

@@ -40,10 +40,16 @@ module RocketChat
       User.new request_json('/api/v1/me', method: :get)
     end
 
-    #
-    # User messages proxy
-    # @return [Messages::User]
-    #
+    ### Message proxies
+
+    def channels
+      @channels ||= RocketChat::Messages::Channel.new(self)
+    end
+
+    def groups
+      @groups ||= RocketChat::Messages::Group.new(self)
+    end
+
     def users
       @users ||= RocketChat::Messages::User.new(self)
     end

data/lib/rocketchat.rb

@@ -6,12 +6,17 @@ require 'rocket_chat/error'
 require 'rocket_chat/util'
 require 'rocket_chat/request_helper'
 
+require 'rocket_chat/messages/list_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/server'
 require 'rocket_chat/session'
 require 'rocket_chat/info'
 require 'rocket_chat/token'
 require 'rocket_chat/presence_status'
+require 'rocket_chat/room'
 require 'rocket_chat/user'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - int512
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-30 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,10 +115,15 @@ files:
 - lib/rocket_chat/error.rb
 - lib/rocket_chat/gem_version.rb
 - lib/rocket_chat/info.rb
+- lib/rocket_chat/messages/channel.rb
+- lib/rocket_chat/messages/group.rb
+- lib/rocket_chat/messages/list_support.rb
+- lib/rocket_chat/messages/room.rb
 - lib/rocket_chat/messages/settings.rb
 - lib/rocket_chat/messages/user.rb
 - lib/rocket_chat/presence_status.rb
 - lib/rocket_chat/request_helper.rb
+- lib/rocket_chat/room.rb
 - lib/rocket_chat/server.rb
 - lib/rocket_chat/session.rb
 - lib/rocket_chat/token.rb