# Ruby Matrix SDK
A Ruby gem for easing the development of software that communicates with servers implementing the Matrix protocol.
There is a Matrix room for the discussion about usage and development at [#ruby-matrix-sdk:kittenface.studio](https://matrix.to/#/#ruby-matrix-sdk:kittenface.studio).
Live YARD documentation can be found at; https://ruby-sdk.ananace.dev
## Example usage
For more fully-featured examples, check the [examples](examples/) folder.
```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 with login
require 'matrix_sdk'
client = MatrixSdk::Client.new 'https://example.com'
client.login 'username', '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"}
```
```ruby
# Client wrapper with token
require 'matrix_sdk'
client = MatrixSdk::Client.new 'https://example.com'
client.api.access_token = 'thisisnotarealtoken'
# Doesn't automatically trigger a sync when setting the token directly
client.rooms.count
# => 0
client.sync
client.rooms.count
# => 5
```
```ruby
#!/bin/env ruby
# Bot DSL
require 'matrix_sdk/bot'
command :plug do
room.send_text <<~PLUG
The Ruby SDK is a fine method for writing applications communicating over the Matrix protocol.
It can easily be integrated with Rails, and it supports most client/bot use-cases.
PLUG
end
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/ruby-matrix-sdk
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
用于Matrix通信协议的RubySDK_Ruby_下载.zip （58个子文件） 
ruby-matrix-sdk-master lib 
matrix_sdk.rb 2KB matrix_sdk response.rb 2KB bot base.rb 26KB main.rb 2KB protocols is.rb 920B ss.rb 358B as.rb 111B msc.rb 5KB cs.rb 84KB errors.rb 2KB client.rb 25KB room.rb 36KB mxid.rb 4KB bot.rb 82B rooms space.rb 2KB api.rb 18KB version.rb 72B util account_data_cache.rb 2KB events.rb 2KB tinycache_adapter.rb 2KB extensions.rb 2KB tinycache.rb 4KB state_event_cache.rb 2KB uri.rb 3KB user.rb 5KB .rubocop.yml 941B Rakefile 315B .travis.yml 215B .github workflows ruby.yml 616B container.yml 864B
LICENSE.txt 1KB examples simple_client.rb 4KB bot_api.rb 4KB simple_bot.rb 5KB CHANGELOG.md 9KB matrix-sdk.gemspec 888B Dockerfile.bot 320B Gemfile 126B .gitlab-ci.yml 876B test bot_test.rb 7KB matrix_sdk_test.rb 612B user_test.rb 2KB api_cs_protocol_verification_test.rb 3KB tinycache_custom_test.rb 950B mxid_test.rb 3KB test_helper.rb 613B fixtures cs_api_methods.yaml 54KB sync_response.json 5KB api_ss_protocol_test.rb 747B tinycache_test.rb 3KB response_test.rb 629B client_test.rb 14KB room_test.rb 12KB api_creation_test.rb 9KB uri_test.rb 4KB api_cs_protocol_test.rb 8KB .gitignore 103B README.md 2KB资源评论
