chatrix 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d46105489cd9f2748b15ea3a650893af40baad6d
-  data.tar.gz: 03d5bc731429c298f6e1d3367efab623c3d34549
+  metadata.gz: 9c4ccf55e9b611ac9df88a62fbc8e1924815abf3
+  data.tar.gz: cb828784148992194d31f5771a7a653c07b9fa24
 SHA512:
-  metadata.gz: 6bd7b7098a58b632bf67e48cd5d4b7ae4685bcbb53c8876a7a210a3450980221f247b931803f434198c111d943f42cdd9d1b5d5aca7ee2b1ac88048277e9b619
-  data.tar.gz: 5a26a6d99f8d66905a50de48062eddd6880b176c7ca3ac61fbc574964651980d847ac25f9457d4c4775b7e04ff20832d31904bd7ef86d789b9310080db580723
+  metadata.gz: 3ce6a0c0835155c222cebaf4f4621f544f343c067fd60db25b250f1210fa2cf09082f7916a6de15e3fe47ab78987020f5037462f74747c45bd177c4bccad0cd0
+  data.tar.gz: f0d9572000576c1085f211807e3eac8063fa4f4f88e5fadc936230b5b454440a416bd0f8f8b24ae1205506d9e0694baa06cc20fce745654dd19a89c80f3dc0cb

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.0
+
+Style/Encoding:
+  EnforcedStyle: always
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always

data/.travis.yml

@@ -3,6 +3,10 @@ sudo: false
 language: ruby
 
 rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3.0
   - 2.3.1
 
 bundler_args: --without development doc

data/Gemfile

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ratrix.gemspec
@@ -14,7 +17,7 @@ group :test do
 end
 
 group :development, :test do
-  gem 'rubocop', '~> 0.40.0'
+  gem 'rubocop', '~> 0.41.0'
 end
 
 group :doc do

data/Rakefile

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'chatrix'

data/chatrix.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'chatrix/version'
@@ -22,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_runtime_dependency 'httparty', '~> 0.13'
   spec.add_runtime_dependency 'wisper', '~> 1.6'
 

data/lib/chatrix.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/version'
 require 'chatrix/errors'
 require 'chatrix/matrix'

data/lib/chatrix/api/api_component.rb

@@ -1,8 +1,12 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   module Api
     # Wraps a matrix instance for use in calling API endpoints.
     class ApiComponent
       # Initializes a new ApiComponent instance.
+      # @param matrix [Matrix] The matrix API instance.
       def initialize(matrix)
         @matrix = matrix
       end

data/lib/chatrix/api/media.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   module Api
     # Contains methods for accessing the media endpoints of a server.

data/lib/chatrix/api/push.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   module Api
     # Contains methods for accessing the "push" endpoints on the server.

data/lib/chatrix/api/room_actions.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   module Api
     # Contains methods for performing actions on rooms.

data/lib/chatrix/api/rooms.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/api/api_component'
 require 'chatrix/api/room_actions'
 

data/lib/chatrix/api/session.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/api/api_component'
 
 module Chatrix

data/lib/chatrix/api/users.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/api/api_component'
 
 module Chatrix
@@ -49,6 +52,7 @@ module Chatrix
       #
       # @param (see #get_user)
       # @raise (see #get_user)
+      # @return [String] The user's display name.
       def get_displayname(user)
         make_request(:get, "/profile/#{user}/displayname")['displayname']
       rescue NotFoundError => e

data/lib/chatrix/client.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/matrix'
 require 'chatrix/users'
 require 'chatrix/rooms'
@@ -9,8 +12,7 @@ module Chatrix
   class Client
     include Wisper::Publisher
 
-    # @!attribute [r] me
-    #   @return [User] The user associated with the access token.
+    # @return [User] The user associated with the access token.
     attr_reader :me
 
     # Initializes a new Client instance.

data/lib/chatrix/components/admin.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/user'
 
 module Chatrix

data/lib/chatrix/components/messaging.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   module Components
     # Class to handle messaging actions for a room.

data/lib/chatrix/components/permissions.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'wisper'
 
 module Chatrix

data/lib/chatrix/components/state.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/events'
 
 require 'chatrix/components/permissions'
@@ -11,26 +14,31 @@ module Chatrix
     class State
       include Wisper::Publisher
 
-      # @!attribute [r] canonical_alias
-      #   @return [String,nil] The canonical alias, or `nil` if none has
-      #     been set.
-      # @!attribute [r] name
-      #   @return [String,nil] The name, or `nil` if none has been set.
-      # @!attribute [r] topic
-      #   @return [String,nil] The topic, or `nil` if none has been set.
-      # @!attribute [r] creator
-      #   @return [User] The user who created the room.
-      # @!attribute [r] guest_access
-      #   @return [Boolean] `true` if guests are allowed in the room,
-      #     otherwise `false`.
-      # @!attribute [r] history_visibility
-      #   @return [String] The room's history visibility.
-      # @!attribute [r] join_rule
-      #   @return [String] Join rules for the room.
-      # @!attribute [r] permissions
-      #   @return [Permissions] Check room permissions.
-      attr_reader :canonical_alias, :name, :topic, :creator, :guest_access,
-                  :join_rule, :history_visibility, :permissions
+      # @return [String,nil] The canonical alias, or `nil` if none has
+      #   been set.
+      attr_reader :canonical_alias
+
+      # @return [String,nil] The name, or `nil` if none has been set.
+      attr_reader :name
+
+      # @return [String,nil] The topic, or `nil` if none has been set.
+      attr_reader :topic
+
+      # @return [User] The user who created the room.
+      attr_reader :creator
+
+      # @return [Boolean] `true` if guests are allowed in the room,
+      #   otherwise `false`.
+      attr_reader :guest_access
+
+      # @return [String] Join rules for the room.
+      attr_reader :join_rule
+
+      # @return [String] The room's history visibility.
+      attr_reader :history_visibility
+
+      # @return [Permissions] Check room permissions.
+      attr_reader :permissions
 
       # Initializes a new State instance.
       #

data/lib/chatrix/components/timeline.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/message'
 require 'chatrix/events'
 
@@ -41,7 +44,10 @@ module Chatrix
       # Process a message event.
       # @param event [Hash] Event data.
       def handle_message(event)
-        message = Message.new @users[event['sender']], event['content']
+        sender = @users[event['sender']]
+        timestamp = event['origin_server_ts'] || Time.now.to_i
+        content = event['content']
+        message = Message.new sender, timestamp, content
         broadcast(:message, @room, message)
         Events.processed event
       end

data/lib/chatrix/errors.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   # Generic faults from the library.
   class ChatrixError < StandardError
@@ -116,7 +119,7 @@ module Chatrix
       # Set data to be the error response hash WITHOUT the error code and
       # error values. This will leave it with only the data relevant for
       # handling authentication.
-      @data = error.select { |key| !%w{(errcode), (error)}.include? key }
+      @data = error.select { |key| !%w(errcode error).include? key }
     end
   end
 end

data/lib/chatrix/events.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   # Keeps track of what events have already been processed.
   module Events

data/lib/chatrix/matrix.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/errors'
 
 require 'chatrix/api/session'
@@ -230,7 +233,7 @@ module Chatrix
     #   and value.
     def make_body(content)
       key = content.respond_to?(:read) ? :body_stream : :body
-      value = content.is_a? Hash ? content.to_json : content
+      value = content.is_a?(Hash) ? content.to_json : content
       { key => value }
     end
 

data/lib/chatrix/message.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   # Describes a message sent in a room.
   class Message
@@ -10,29 +13,37 @@ module Chatrix
       '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
+    # @return [Hash] The raw message data (the `content` field).
+    attr_reader :raw
+
+    # @return [Symbol,nil] The type of message. Will be nil if the type
+    #   failed to parse.
+    attr_reader :type
+
+    # @return [User] The user who sent this message.
+    attr_reader :sender
+
+    # @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 :body
+
+    # @return [Integer] The timestamp of the message, indicating when
+    #   it was sent, according to the origin server.
+    attr_reader :timestamp
 
     # Initializes a new Message instance.
     #
     # @param sender [User] The user who sent the message.
+    # @param timestamp [Integer] The timestamp of the message.
     # @param content [Hash] The message content.
-    def initialize(sender, content)
+    def initialize(sender, timestamp, content)
       @raw = content
 
       @type = TYPES[@raw['msgtype']]
       @body = @raw['body']
       @sender = sender
+      @timestamp = timestamp
 
       parse_body!
     end

data/lib/chatrix/room.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/components/state'
 require 'chatrix/components/timeline'
 require 'chatrix/components/messaging'
@@ -9,14 +12,21 @@ module Chatrix
   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
+    # @return [String] The ID of this room.
+    attr_reader :id
+
+    # @return [State] The state object for this room.
+    attr_reader :state
+
+    # @return [Timeline] The timeline object for this room.
+    attr_reader :timeline
+
+    # @return [Admin] Administration object for carrying out administrative
+    #   actions like kicking and banning of users.
+    attr_reader :admin
+
+    # @return [Messaging] Handle various message actions through this object.
+    attr_reader :messaging
 
     # Initializes a new Room instance.
     #

data/lib/chatrix/rooms.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/room'
 
 require 'wisper'

data/lib/chatrix/user.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/events'
 
 require 'wisper'
@@ -7,14 +10,15 @@ module Chatrix
   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
+    # @return [String] The user ID of this user.
+    attr_reader :id
+
+    # @return [String,nil] The display name of this user, if one has
+    #   been set.
+    attr_reader :displayname
+
+    # @return [String,nil] This user's avatar URL, if one has been set.
+    attr_reader :avatar
 
     # Initializes a new User instance.
     # @param id [String] The user ID.

data/lib/chatrix/users.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'chatrix/user'
 require 'chatrix/events'
 

data/lib/chatrix/version.rb

@@ -1,4 +1,7 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Chatrix
   # The current version of this gem.
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chatrix
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Hellberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -62,6 +62,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
@@ -106,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="