activematrix 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d14da1f32ce2269f47a0e1124b264a0e2e61c3f19f94ad224b60951200ba55b
+  data.tar.gz: b12caea772bf4d1df1cbad903caaa888eff93c40dbcda081c53c89b598f69475
+SHA512:
+  metadata.gz: 9f62a5e1eb8bd28688e2b9b029c156271f827ace85d6898ba75fb1b2d47c3185a7aaaadf8ed2a18ef1829ab4a1563a498715f1cbc188b2106f590eb8474b0fe3
+  data.tar.gz: fc32226c83adadca7cc70b4be9ca50e302e518185e26bd0dade5e91013ec582aaee9f8f40c601bd299384898686373f54da80868ab0a3ee6b805ee9210262947

data/CHANGELOG.md

@@ -0,0 +1,219 @@
+## 2.8.0 - 2022-08-19
+
+- Drops support for EoL Ruby 2.6
+- Adds helpers for accessing room state
+- Fixes Client#sync_token usage
+- Improves caching of state events in rooms
+
+## 2.7.0 - 2022-08-12
+
+- Adds a bot subsystem + DSL 
+  - [An example](examples/bot_api.rb) can be found in the examples folder
+- Adds additional useful helpers for Room and User
+- Fixes Client.new_for_domain
+- Improves the handling of MXIDs as strings
+- Improves handling of caches for rooms
+- Improves Client shutdown when using Client#start_listener_thread
+- Improves account data handling, with caches on both Client and Room level
+
+## 2.6.0 - 2022-07-15
+
+- Adds some multi-thread usage support to the API (create your API/client with `threadsafe: :multithread/true/false`)
+    The API will currently default to running with multi-threaded requests. In case your application is single-threaded - or never performs requests from multiple threads - then you can set `threadsafe: true/false` to support connection reuse.
+- Changes room finding to ignore non-canonical aliases by default
+- Improves room alias handling
+- Improves Ruby 3.0+ support
+- Improves debug output by supporting PP (Ruby pretty print) on all MatrixSdk objects
+
+## 2.5.0 - 2022-01-14
+
+- Adds preliminary support for the Matrix v1.1 `client/v3` API
+- Adds some support for knocking rooms
+- Adds mutex synchronization on API requests to avoid some threading issues
+- Fixes error on attempting to skip cache for certain requests (#19)
+- Fixes inconsistency in MXID typing for the Client abstraction (#18 #20)
+- Fixes missed autoloader entries for errors (#22)
+- Fixes some potential issues arising from broken user-provided state data
+
+## 2.4.0 - 2021-07-19
+
+- Adds support for matrix: URI's according to MSC2312
+- Adds some basic support for detecting Spaces (MSC1772)
+- Fixes sync against Synapse 1.38.0 missing empty fields
+
+## 2.3.0 - 2021-03-26
+
+- Adds support for Ruby 3.0 (#15)
+- Adds support for requests against the Synapse admin API
+- Adds helper methods for checking and changing user power levels
+- Adds a proper caching system for room data
+- Fixes argument error in `#get_room_messages`
+- Removes unfinished and broken AS abstraction
+
+## 2.2.0 - 2020-11-20
+
+- Adds direct message (1:1) room mapping to client abstraction
+- Adds Api#get_room_event_context (#13)
+- Improves support for JRuby
+
+## 2.1.3 - 2020-09-18
+
+- Adds separate state event handler as Client#on_state_event
+- Changes Client sync interval to by-default run at full speed
+- Fixes state events being sent twice if included in both timeline and state of a sync
+- Improves error reporting of broken 200 responses
+- Improves event handlers for rooms, to not depend on a specific room object instance anymore
+
+## 2.1.2 - 2020-09-10
+
+- Adds method for reading complete member lists for rooms, improves the CS spec adherence
+- Adds test for state events
+- Fixes state event handler for rooms not actually passing events
+- Fixes Api#new_for_domain using a faulty URI in certain cases
+
+## 2.1.1 - 2020-08-21
+
+- Fixes crash if state event content is null (#11)
+- Fixes an uninitialized URI constant exception when requiring only the main library file
+- Fixes the Api#get_pushrules method missing an ending slash in the request URI
+- Fixes discovery code for client/server connections based on domain
+
+## 2.1.0 - 2020-05-22
+
+- Adds unique query IDs as well as duration in API debug output, to make it easier to track long requests
+- Finishes up MSC support, get sync over SSE working flawlessly
+- Exposes the #listen_forever method in the client abstraction
+- Fixes room access methods
+
+## 2.0.1 - 2020-03-13
+
+- Adds code for handling non-final MSC's in protocols
+  - Currently implementing clients parts of MSC2018 for Sync over Server Sent Events
+
+## 2.0.0 - 2020-02-14
+
+**NB**, this release includes backwards-incompatible changes;  
+- Changes room state lookup to separate specific state lookups from full state retrieval.
+  This will require changes in client code where `#get_room_state` is called to retrieve
+  all state, as it now requires a state key. For retrieving full room state,
+  `#get_room_state_all` is now the method to use.
+- Changes some advanced parameters to named parameters, ensure your code is updated if it makes use of them
+- Fixes SSL verification to actually verify certs (#9)
+
+- Adds multiple CS API endpoints
+- Adds `:room_id` key to all room events
+- Adds `:self` as a valid option to the client abstraction's `#get_user` method
+- Separates homeserver part stringification for MXIDs
+- Exposes some previously private client abstraction methods (`#ensure_room`, `#next_batch`) for easier bot usage
+- Changes room abstraction member lookups to use `#get_room_joined_members`, reducing transferred data amounts
+- Fixes debug print of methods that return arrays (e.g. CS `/room/{id}/state`)
+
+## 1.5.0 - 2019-10-25
+
+- Adds error event to the client abstraction, for handling errors in the background listener
+- Adds an `open_timeout` setter to the API
+- Fixes an overly aggressive filter for event handlers
+
+## 1.4.0 - 2019-09-30
+
+- Adds the option to change the logger globally or per-object.
+
+## 1.3.0 - 2019-07-16
+
+- Improves response handling to add accessors recursively
+- Removes MatrixSdk extensions from the global scope,
+  if you've been using these in your own code you must now remember to
+  `extend MatrixSdk::Extensions` in order for them to be available.
+
+## 1.2.1 - 2019-07-02
+
+- Fixes mxc download URL generation
+
+## 1.2.0 - 2019-06-28
+
+- Adds getters and setters for more specced room state
+- Fixes handling of the timeout parameter for the sync endpoint (#7)
+    - Additionally also now allows for running sync with a nil timeout
+- Cleans up the CS protocol implementation slightly, removing a mutation that's not supposed to be there
+- Cleans up the gemspec slightly, no longer uses `git ls-files`
+- Add support for explicitly setting proxy config for API
+
+## v1.1.1 - 2019-06-05
+
+- Fixes a faulty include which broke the single implemented S2S endpoint
+- Replaces the room name handling with a cached lazy loading system
+
+## v1.1.0 - 2019-06-04
+
+- The create_room method in the client abstraction now automatically stores the created room
+- Adds more CS API endpoints, exposed as #get_joined_rooms, #get_public_rooms, and #username_available?
+- Adds a method to the client abstraction to reload all joined rooms
+- Adds a method to the client abstraction to get a list of all public rooms
+- Adds avatar tracking to rooms in the client abstraction
+- Adds lazy loading of join rules and guest access for rooms in the client abstraction
+- Adds granular error classes like MatrixSdk::MatrixNotFoundError to make error handling easier
+- Improves the CS API endpoint for room state retrieval
+- Fixes an issue in the client abstraction where it would fail to load aliases if multiple HSes have applied aliases to a room
+
+## v1.0.1 - 2019-05-24
+
+- Fixes an error in the room creation code
+- Fixes a divergence from spec in the room message request
+- Fixes a slight divergence from spec in the kick method
+- Fixes a divergence from spec in the tags handling methods
+
+## v1.0.0 - 2019-05-17
+
+- Improves testing and code coverage of existing code
+- Fixes a series of minor bugs found during the writing of tests
+
+## v0.1.0 - 2019-05-10
+
+- Adds code for handling member lazy load in the client abstraction, and activates it by default
+- Adds methods to read device keys from users
+- Adds basic methods for device handling
+- Restructures the API code to separate protocol implementations
+- Improves the domain discovery code to support all currently specced methods
+- Improves performance in sync calls
+- Started work on an application service prototype, not ready for use yet
+- Testing has been written for large parts of the code
+
+## v0.0.4 - 2019-02-20
+
+- Adds a parameter to the client abstraction to allow retrying syncs on timeouts
+- Adds support for token-based login in the client abstraction
+- Adds rudimentary username and password validation in the client abstraction
+- Adds MXID validation in the client abstraction
+- Adds a method to discover a homeserver address based on a domain.
+    - Supporting both SRV and .well-known lookups
+- Adds methods from the r0.4.0 spec
+- Adds support for version 3 event IDs
+- Extends the connection exceptions with a specific timeout error
+- Sets a series of filters in the simple client example to skip unhandled event
+- Fixes an exception when null values end up in the body cleaner during debugging
+- Fixes an error with CGI not being required correctly
+
+## v0.0.3 - 2018-08-14
+
+- Adds missing accessors for HTTP timeout
+- Adds methods for checking auth status to client API
+- Adds a wrapper class for API responses to ease use
+- Adds option (and defaults) to store login details on registration
+- Allows creating a MatrixSdk::Client off of an existing MatrixSdk::Api
+- Extends event handling
+
+- Fixes batch handling in sync
+- Fixes event handling in the sample
+- Removes unimplemented API methods to avoid confusion
+
+- Plenty of documentation work
+
+## v0.0.2 - 2018-05-11
+
+- Fixes for multiple issues discovered after initial release
+- Adds additional API methods
+- Higher-level client API gets room and user abstractions
+
+## v0.0.1 - 2018-05-06
+
+Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexander "Ace" Olofsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# ActiveMatrix
+
+A Rails gem for integrating Matrix protocol communication into Ruby on Rails applications. This gem is a fork of the [matrix-sdk](https://github.com/ananace/ruby-matrix-sdk) gem, enhanced with Rails-specific features and tight integration with ActiveRecord and the Rails framework.
+
+## About
+
+ActiveMatrix provides a seamless way to add Matrix protocol support to your Rails applications, allowing you to build chat features, real-time messaging, and collaborative tools using the decentralized Matrix network.
+
+## 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).
+