chatrix 1.0.0.pre → 1.0.0

data/lib/chatrix/message.rb

@@ -0,0 +1,53 @@
+module Chatrix
+  # Describes a message sent in a room.
+  class Message
+    # Supported message types.
+    #
+    # `:html` is a special message type parsed in {#parse_body!}.
+    TYPES = {
+      'm.text' => :text,
+      'm.emote' => :emote,
+      'm.notice' => :notice
+    }.freeze
+
+    # @!attribute [r] raw
+    #   @return [Hash] The raw message data (the `content` field).
+    # @!attribute [r] type
+    #   @return [Symbol,nil] The type of message. Will be nil if the type
+    #     failed to parse.
+    # @!attribute [r] sender
+    #   @return [User] The user who sent this message.
+    # @!attribute [r] body
+    #   @return [String] The text content of the message. If the message is
+    #     of `:html` type, this will contain HTML format. To get the raw
+    #     message text, use the `'body'` field of the {#raw} hash.
+    attr_reader :raw, :type, :sender, :body
+
+    # Initializes a new Message instance.
+    #
+    # @param sender [User] The user who sent the message.
+    # @param content [Hash] The message content.
+    def initialize(sender, content)
+      @raw = content
+
+      @type = TYPES[@raw['msgtype']]
+      @body = @raw['body']
+      @sender = sender
+
+      parse_body!
+    end
+
+    private
+
+    # Parses the message content to see if there's any special formatting
+    # available.
+    def parse_body!
+      return unless @raw.key? 'format'
+      case @raw['format']
+      when 'org.matrix.custom.html'
+        @type = :html
+        @formatted = @raw['formatted_body']
+      end
+    end
+  end
+end

data/lib/chatrix/room.rb

@@ -0,0 +1,93 @@
+require 'chatrix/components/state'
+require 'chatrix/components/timeline'
+require 'chatrix/components/messaging'
+require 'chatrix/components/permissions'
+require 'chatrix/components/admin'
+
+module Chatrix
+  # Provides functionality for interacting with a room.
+  class Room
+    include Wisper::Publisher
+
+    # @!attribute [r] id
+    #   @return [String] The ID of this room.
+    # @!attribute [r] admin
+    #   @return [Admin] Administration object for carrying out administrative
+    #     actions like kicking and banning of users.
+    # @!attribute [r] messaging
+    #   @return [Messaging] Handle various message actions through this object.
+    attr_reader :id, :state, :timeline, :admin, :messaging
+
+    # Initializes a new Room instance.
+    #
+    # @param id [String] The room ID.
+    # @param users [Users] The User manager.
+    # @param matrix [Matrix] The Matrix API instance.
+    def initialize(id, users, matrix)
+      @id = id
+      @users = users
+      @matrix = matrix
+
+      @state = Components::State.new self, @users
+      @timeline = Components::Timeline.new self, @users
+      @messaging = Components::Messaging.new self, @matrix
+      @admin = Components::Admin.new self, @matrix
+    end
+
+    # Convenience method to get the canonical alias from this room's state.
+    # @return [String] The canonical alias for this room.
+    def canonical_alias
+      @state.canonical_alias
+    end
+
+    # Convenience method to get the name from this room's state.
+    # @return [String] The name for this room.
+    def name
+      @state.name
+    end
+
+    # Process join events for this room.
+    # @param data [Hash] Event data containing state and timeline events.
+    def process_join(data)
+      @state.update data['state'] if data.key? 'state'
+      @timeline.update data['timeline'] if data.key? 'timeline'
+    end
+
+    # Process invite events for this room.
+    # @param data [Hash] Event data containing special invite data.
+    def process_invite(data)
+      data['invite_state']['events'].each { |e| process_invite_event e }
+    end
+
+    # Process leave events for this room.
+    # @param data [Hash] Event data containing state and timeline events up
+    #   until the point of leaving the room.
+    def process_leave(data)
+      @state.update data['state'] if data.key? 'state'
+      @timeline.update data['timeline'] if data.key? 'timeline'
+    end
+
+    # Gets a string representation of this room.
+    # @return [String] If the room has a name, that name is returned.
+    #   If it has a canonical alias, the alias is returned.
+    #   If it has neither a name nor alias, the room ID is returned.
+    def to_s
+      name || canonical_alias || @id
+    end
+
+    private
+
+    # Process an invite event for this room.
+    # @param event [Hash] Event data.
+    def process_invite_event(event)
+      return unless event['type'] == 'm.room.member'
+      return unless event['content']['membership'] == 'invite'
+      @users.process_invite self, event
+      sender = @users[event['sender']]
+      invitee = @users[event['state_key']]
+      # Return early if the user is already in the room
+      return if @state.member? invitee
+      broadcast(:invited, sender, invitee)
+    end
+  end
+end

data/lib/chatrix/rooms.rb

@@ -0,0 +1,90 @@
+require 'chatrix/room'
+
+require 'wisper'
+
+module Chatrix
+  # Manages the rooms known to the client.
+  class Rooms
+    include Wisper::Publisher
+
+    # Initializes a new Rooms instance.
+    #
+    # @param users [Users] The User manager.
+    # @param matrix [Matrix] The Matrix API instance.
+    def initialize(users, matrix)
+      @matrix = matrix
+
+      @users = users
+
+      # room_id => room
+      @rooms = {}
+    end
+
+    # Gets a room by its ID, alias, or name.
+    #
+    # @return [Room,nil] Returns the room instance if the room was found,
+    #   otherwise `nil`.
+    def [](id)
+      return @rooms[id] if id.start_with? '!'
+
+      if id.start_with? '#'
+        res = @rooms.find { |_, r| r.alias == id }
+        return res.last if res.respond_to? :last
+      end
+
+      res = @rooms.find { |_, r| r.name == id }
+      res.last if res.respond_to? :last
+    end
+
+    # Processes a list of room events from syncs.
+    #
+    # @param events [Hash] A hash of room events as returned from the server.
+    def process_events(events)
+      process_join events['join'] if events.key? 'join'
+      process_invite events['invite'] if events.key? 'invite'
+      process_leave events['leave'] if events.key? 'leave'
+    end
+
+    private
+
+    # Gets the Room instance associated with a room ID.
+    # If there is no Room instance for the ID, one is created and returned.
+    #
+    # @param id [String] The room ID to get an instance for.
+    # @return [Room] An instance of the Room class for the specified ID.
+    def get_room(id)
+      return @rooms[id] if @rooms.key? id
+      room = Room.new id, @users, @matrix
+      @rooms[id] = room
+      broadcast(:added, room)
+      room
+    end
+
+    # Process `join` room events.
+    #
+    # @param events [Hash{String=>Hash}] Events to process.
+    def process_join(events)
+      events.each do |room, data|
+        get_room(room).process_join data
+      end
+    end
+
+    # Process `invite` room events.
+    #
+    # @param events [Hash{String=>Hash}] Events to process.
+    def process_invite(events)
+      events.each do |room, data|
+        get_room(room).process_invite data
+      end
+    end
+
+    # Process `leave` room events.
+    #
+    # @param events [Hash{String=>Hash}] Events to process.
+    def process_leave(events)
+      events.each do |room, data|
+        get_room(room).process_leave data
+      end
+    end
+  end
+end

data/lib/chatrix/user.rb

@@ -0,0 +1,109 @@
+require 'chatrix/events'
+
+require 'wisper'
+
+module Chatrix
+  # Describes a user.
+  class User
+    include Wisper::Publisher
+
+    # @!attribute [r] id
+    #   @return [String] The user ID of this user.
+    # @!attribute [r] displayname
+    #   @return [String,nil] The display name of this user, if one has
+    #     been set.
+    # @!attribute [r] avatar
+    #   @return [String,nil] This user's avatar URL, if one has been set.
+    attr_reader :id, :displayname, :avatar
+
+    # Initializes a new User instance.
+    # @param id [String] The user ID.
+    def initialize(id)
+      @id = id
+
+      # room_id => membership
+      @memberships = {}
+    end
+
+    # Get this user's power level in a room.
+    #
+    # @param room [Room] The room to check.
+    # @return [Fixnum] The user's power level in the specified room.
+    def power_in(room)
+      return 0 unless @memberships.key? room
+      @memberships[room][:power] || 0
+    end
+
+    # Process a member event.
+    #
+    # @param room [Room] The room that sent the event.
+    # @param event [Hash] Event data.
+    def process_member_event(room, event)
+      membership = (@memberships[room] ||= {})
+      type = event['content']['membership'].to_sym
+
+      # Only update the membership status if we are currently not in the room
+      # or if the new state is that we have left.
+      if membership[:type] != :join || type == :leave
+        membership[:type] = type
+        broadcast(:membership, self, room, membership)
+      end
+
+      update(event['content'])
+
+      Events.processed event
+    end
+
+    # Process a power level update in a room.
+    #
+    # @param room [Room] The room where the level updated.
+    # @param level [Fixnum] The new power level.
+    def process_power_level(room, level)
+      membership = (@memberships[room] ||= {})
+      membership[:power] = level
+      broadcast(:power_level, self, room, level)
+    end
+
+    # Process an invite to a room.
+    # @param room [Room] The room the user was invited to.
+    # @param sender [User] The user who sent the invite.
+    # @param event [Hash] Event data.
+    def process_invite(room, sender, event)
+      # Return early if we're already part of this room
+      membership = (@memberships[room] ||= {})
+      return if membership[:type] == :join
+      process_member_event room, event
+      broadcast(:invited, self, room, sender)
+    end
+
+    # Converts this User object to a string representation of it.
+    # @return [String] Returns the user's display name if one is set,
+    #   otherwise returns the ID.
+    def to_s
+      @id
+    end
+
+    private
+
+    # Updates metadata for this user.
+    # @param data [Hash{String=>String}] User metadata.
+    def update(data)
+      update_avatar(data['avatar_url']) if data.key? 'avatar_url'
+      update_displayname(data['displayname']) if data.key? 'displayname'
+    end
+
+    # Sets a new avatar URL for this user.
+    # @param url [String] The new URL to set.
+    def update_avatar(url)
+      @avatar = url
+      broadcast(:avatar, self, @avatar)
+    end
+
+    # Sets a new display name for this user.
+    # @param name [String] The new name to set.
+    def update_displayname(name)
+      @displayname = name
+      broadcast(:displayname, self, @displayname)
+    end
+  end
+end

data/lib/chatrix/users.rb

@@ -0,0 +1,74 @@
+require 'chatrix/user'
+require 'chatrix/events'
+
+require 'wisper'
+
+module Chatrix
+  # Manages the users known to the client.
+  class Users
+    include Wisper::Publisher
+
+    # Initializes a new Users instance.
+    def initialize
+      # user_id => user
+      @users = {}
+    end
+
+    # Gets a user by ID or display name.
+    #
+    # @param id [String] A user's ID or display name.
+    # @return [User,nil] The User instance for the specified user, or
+    #   `nil` if the user could not be found.
+    def [](id)
+      return @users[id] if id.start_with? '@'
+
+      res = @users.find { |_, u| u.displayname == id }
+      res.last if res.respond_to? :last
+    end
+
+    # Process a member event.
+    #
+    # @param room [Room] Which room the events are related to.
+    # @param event [Hash] Event data.
+    def process_member_event(room, event)
+      return if Events.processed? event
+      get_user(event['sender']).process_member_event room, event
+    end
+
+    # Process power level updates.
+    #
+    # @param room [Room] The room this event came from.
+    # @param data [Hash{String=>Fixnum}] Power level data, a hash of user IDs
+    #   and their associated power level.
+    def process_power_levels(room, data)
+      data.each do |id, level|
+        get_user(id).process_power_level room, level
+      end
+    end
+
+    # Process an invite event for a room.
+    #
+    # @param room [Room] The room from which the event originated.
+    # @param event [Hash] Event data.
+    def process_invite(room, event)
+      sender = get_user(event['sender'])
+      invitee = get_user(event['state_key'])
+      invitee.process_invite room, sender, event
+    end
+
+    private
+
+    # Get the user instance for a specified user ID.
+    # If an instance does not exist for the user, one is created and returned.
+    #
+    # @param id [String] The user ID to get an instance for.
+    # @return [User] An instance of User for the specified ID.
+    def get_user(id)
+      return @users[id] if @users.key? id
+      user = User.new id
+      @users[id] = user
+      broadcast(:added, user)
+      user
+    end
+  end
+end

data/lib/chatrix/version.rb

@@ -1,4 +1,4 @@
 module Chatrix
   # The current version of this gem.
-  VERSION = '1.0.0.pre'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatrix
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Hellberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -25,103 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: wisper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !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: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
+        version: '1.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.12'
 description: 
 email:
 - sharparam@sharparam.com
@@ -142,8 +72,27 @@ files:
 - bin/setup
 - chatrix.gemspec
 - lib/chatrix.rb
+- lib/chatrix/api/api_component.rb
+- lib/chatrix/api/media.rb
+- lib/chatrix/api/push.rb
+- lib/chatrix/api/room_actions.rb
+- lib/chatrix/api/rooms.rb
+- lib/chatrix/api/session.rb
+- lib/chatrix/api/users.rb
+- lib/chatrix/client.rb
+- lib/chatrix/components/admin.rb
+- lib/chatrix/components/messaging.rb
+- lib/chatrix/components/permissions.rb
+- lib/chatrix/components/state.rb
+- lib/chatrix/components/timeline.rb
 - lib/chatrix/errors.rb
+- lib/chatrix/events.rb
 - lib/chatrix/matrix.rb
+- lib/chatrix/message.rb
+- lib/chatrix/room.rb
+- lib/chatrix/rooms.rb
+- lib/chatrix/user.rb
+- lib/chatrix/users.rb
 - lib/chatrix/version.rb
 homepage: https://github.com/Sharparam/chatrix
 licenses:
@@ -160,9 +109,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1