matrix_sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1edf23725115b5d4e4891db5baa88ff1d7850fff891921c0d5f294d74e04d4bc
-  data.tar.gz: 8e836ac2b7f6758ee89f43f964e6495df332db826d523456563c95c9cc3261ac
+  metadata.gz: 6d0b5d000dfb07e1f488a66587a403c087c7056b2cde52cd2ee87e4835972a23
+  data.tar.gz: 1fdd6f7a913b42cf8654eeed0b198d14337f47ab7da71baf43c1b2779d752eb5
 SHA512:
-  metadata.gz: 3c86db36a677016fb8fcdb9b56a0ba307f6d21d7fccc5fe445557258d339e7ed5a9cc29602ea75f10f3d95e2f77f16c5e9cd9ac4ec4e4314739c61d1c8054cf9
-  data.tar.gz: fc66623c861bc0d8bb7941330ef9d21661df4a219c872c10b988a328dac6d7d2b0fdfa5a0b5641b145ecc6badf1bbe30ad4dff4d52650aa15046843381d2c9f6
+  metadata.gz: 466f80ee4d8b06c1827de39e7526a23e62e654db99c2102db5552492992a58fd6f6a4883d1c90d2a577c345d67312de51d5cbdb0a2bfbcab461278141dffcbc4
+  data.tar.gz: 189b5b6243fb574b60ac02036850bfe33f20499b4a88ea9840491892f840fd367167be5233da73e08811d6d8721523bce9027e4907ea6c927a9c70a8c1ed20cc

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - '*.spec'
+    - 'Rakefile'
+
+# Don't enforce documentation
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/LineLength:
+  Max: 190
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false

data/README.md

@@ -3,18 +3,43 @@
 A Ruby gem for easing the development of software that communicates with servers implementing the Matrix protocol.
 
 
-## Usage
+## Example usage
 
 ```ruby
+# Raw API usage
+require 'matrix_sdk'
+
 api = MatrixSdk::Api.new 'https://matrix.org'
 
 api.login user: 'example', password: 'notarealpass'
 api.whoami?
+# => {:user_id=>"@example:matrix.org"}
+
+# It's possible to call arbitrary APIs as well
+api.request :get, :federation_v1, '/version'
+# => {:server=>{:version=>"0.28.1", :name=>"Synapse"}}
+```
+
+```ruby
+# Client wrapper
+require 'matrix_sdk'
+
+client = MatrixSdk::Client.new 'https://matrix.org'
+client.login user: 'example', password: 'notarealpass' # no_sync: true
+
+client.rooms.count
+# => 5
+hq = client.find_room '#matrix:matrix.org'
+# => #<MatrixSdk::Room:00005592a1161528 @id="!cURbafjkfsMDVwdRDQ:matrix.org" @name="Matrix HQ" @topic="The Official Matrix HQ - please come chat here! | To support Matrix.org development: https://patreon.com/matrixdotorg | Try http://riot.im/app for a glossy web client | Looking for homeserver hosting? Check out https://upcloud.com/matrix!" @canonical_alias="#matrix:matrix.org" @aliases=["#matrix:jda.mn"] @join_rule=:public @guest_access=:can_join @event_history_limit=10>
+hq.guest_access?
+# => true
+hq.send_text "This is an example message - don't actually do this ;)"
+# => {:event_id=>"$123457890abcdef:matrix.org"}
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/ruby-matrix-sdk.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/ruby-matrix-sdk
 
 
 ## License

data/examples/simple_client.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+
+require 'io/console'
+require 'matrix_sdk'
+
+class SimpleClient < MatrixSdk::Client
+  def initialize(hs_url)
+    super hs_url, sync_filter_limit: 10
+
+    @pls = {}
+  end
+
+  def add_listener(room)
+    room.on_event { |ev| on_message(room, ev) }
+  end
+
+  def run
+    start_listener_thread
+  end
+
+  private
+
+  def get_user_level(room, mxid)
+    levels = @pls[room.id] ||= api.get_power_levels(room.id)[:users]
+    levels[mxid.to_sym]
+  end
+
+  def on_message(room, event)
+    puts "Event: #{ev}"
+    case ev[:type]
+    when 'm.room.member'
+      puts "#{Time.now.strftime '%H:%M'} #{event[:content][:displayname]} joined." if event['membership'] == 'join'
+    when 'm.room.message'
+      user = get_user event[:sender]
+      admin_level = get_user_level(room, user.id)
+      prefix = (admin_level >= 100 ? '@' : (admin_level >= 50 ? '+' : ' '))
+      if %w[m.text m.notice].include? event[:content][:msgtype]
+        puts "#{Time.now.strftime '%H:%M'} <#{prefix}#{user.display_name}> #{event[:content][:body]}"
+      elsif event[:content][:msgtype] == 'm.emote'
+        puts "#{Time.now.strftime '%H:%M'} *#{prefix}#{user.display_name} #{event[:content][:body]}"
+      else
+        puts "#{Time.now.strftime '%H:%M'} <#{prefix}#{user.display_name}> [#{event[:content][:msgtype]}] #{event[:content][:body]} - #{api.get_download_url event[:content][:url]}"
+      end
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  raise "Usage: #{$PROGRAM_NAME} [-d] homeserver_url room_id_or_alias" unless ARGV.length >= 2
+  begin
+    if ARGV.first == '-d'
+      MatrixSdk.debug!
+      ARGV.shift
+    end
+
+    client = SimpleClient.new ARGV.first
+
+    print 'Username: '
+    user = STDIN.gets.strip
+    puts 'Password: '
+    password = STDIN.noecho(&:gets).strip
+
+    puts 'Logging in...'
+    client.login(user, password, sync_timeout: 5)
+
+    puts 'Finding room...'
+    room = client.find_room(ARGV.last)
+    room ||= begin
+      puts 'Joining room...'
+      client.join_room(ARGV.last)
+    end
+
+    client.add_listener(room)
+
+    puts 'Starting listener'
+    client.run
+
+    puts 'Entering main loop'
+    loop do
+      print '> '
+      msg = STDIN.gets.strip
+      break if msg.start_with? '/quit'
+
+      if msg.start_with? '/me'
+        room.send_emote msg.gsub(/\/me\s*/, '')
+      else
+        room.send_text msg
+      end
+    end
+  ensure
+    client.logout if client
+  end
+end