citadel-ruby-client 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ad7287c5b5e735b97040f7b8f6bc0cda099dbec
+  data.tar.gz: 01f3a8bcfeca4b2fc1aacd75ad65a68dbf9a04aa
+SHA512:
+  metadata.gz: 19cb0f9d33f06a25663e0a1dc58cbd5dd4faca6a5660c65e17654210dc4990da836231a8f25e77211ea2eacb1614f202b8f5768dadc29c7aa1f634ec0ea4cd84
+  data.tar.gz: 459dbb0a94e877a2ecab91cf0d1cff63c1f0b97ef02166e0acff20d85721c809a26e0fb5833c0898e6d32a5c5af760c1d095cfbc9314d701fef41f5337634d47

data/lib/citadel.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'json'
+require 'citadel/authenticator'
+require 'citadel/matrix_paths'
+require 'citadel/matrix_interceptor'
+
+module Citadel
+
+  DEFAULT_PUBLIC_ROOMS_LIMIT = 100
+
+  class << self
+    attr_accessor :tenant_url, :public_rooms_limit
+  end
+
+  class Client
+    def initialize(tenant_url, public_rooms_limit = DEFAULT_PUBLIC_ROOMS_LIMIT)
+      if tenant_url[-1,1] == '/'
+        Citadel.tenant_url = tenant_url[0,tenant_url.length-1]
+      else
+        Citadel.tenant_url = tenant_url
+      end
+      Citadel.public_rooms_limit = public_rooms_limit
+    end
+
+    #########
+    # AUTH #
+    #########
+
+    def auth_token
+      return @auth_token if defined? @auth_token
+      puts 'Citadel: You need to sign in'
+      return nil
+    end
+
+    def sign_in(login, password)
+      authenticator = Authenticator.new
+      @auth_token = 'Bearer ' + authenticator.get_token(login, password)
+    end
+
+    ##############
+    # LIST ROOMS #
+    ##############
+
+    def list_all_public_rooms
+      response = all_public_rooms_response
+      room_count = JSON.parse(response.body)['total_room_count_estimate'] - 2
+      result = []
+      (0..room_count).each do
+        result << JSON.parse(response.body)['chunk'][i]['room_id']
+      end
+      result
+    end
+
+    def list_all_joined_rooms
+      response = all_joined_rooms_response
+      rooms = JSON.parse(response.body)['joined_rooms']
+      rooms
+    end
+
+    def all_public_rooms_response
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.list_public_rooms_path
+      HTTP.auth(auth_token).get(url)
+    end
+
+    def all_joined_rooms_response
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.list_joined_rooms_path
+      HTTP.auth(auth_token).get(url)
+    end
+
+    #################
+    # ROOM CREATION #
+    #################
+
+    def create_room(room_name, topic)
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.create_room_path
+      room_name_alias = room_name.gsub!(' ','_')
+      data_hash = { creation_content: { 'm.federate': false },
+                    name: room_name,
+                    preset: 'public_chat',
+                    visibility: 'public',
+                    room_alias_name: room_name_alias,
+                    topic: topic}
+      data = JSON.generate data_hash
+
+      response = HTTP.auth(auth_token).post(url, body: data)
+
+      matrix_interceptor = MatrixInterceptor.new
+      if matrix_interceptor.need_to_wait_and_retry(response)
+        response = HTTP.auth(auth_token).post(url, body: data)
+      end
+
+      JSON.parse(response.body)['room_id']
+    end
+
+    ########
+    # SEND #
+    ########
+
+    def send_message(room_id, message)
+
+      matrix_paths = MatrixPaths.new
+      randomizer = Random.new
+      txn = randomizer.rand(100)
+      url = matrix_paths.base_uri + matrix_paths.send_message_path(room_id) + txn.to_s
+
+      data_hash = { msgtype: 'm.text', body: message }
+      data = JSON.generate data_hash
+
+      response = HTTP.auth(auth_token).put(url, body: data)
+
+      matrix_interceptor = MatrixInterceptor.new
+      if matrix_interceptor.need_to_wait_and_retry(response)
+        response = HTTP.auth(auth_token).put(url, body: data)
+      end
+    end
+
+    ##########
+    # INVITE #
+    ##########
+
+    def invite_users_in_room(room_id, users)
+      users.each do |user|
+        invite_in_room(room_id, user)
+      end
+    end
+
+    def invite_in_room(room_id, user_id)
+
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.invite_in_room_path(room_id)
+      data_hash = { user_id: user_id }
+      data = JSON.generate data_hash
+
+      response = HTTP.auth(auth_token).post(url, body: data)
+
+      matrix_interceptor = MatrixInterceptor.new
+      if matrix_interceptor.need_to_wait_and_retry(response)
+        response = HTTP.auth(auth_token).post(url, body: data)
+      end
+    end
+
+    ###################
+    # ROOM MEMBERSHIP #
+    ###################
+
+    def join_room(room_id)
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.join_room_path(room_id)
+
+      response = HTTP.auth(auth_token).post(url)
+
+      matrix_interceptor = MatrixInterceptor.new
+      if matrix_interceptor.need_to_wait_and_retry(response)
+        response = HTTP.auth(auth_token).post(url)
+      end
+    end
+
+    def leave_room(room_id)
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.leave_room_path(room_id)
+
+      response = HTTP.auth(auth_token).post(url)
+
+      matrix_interceptor = MatrixInterceptor.new
+      if matrix_interceptor.need_to_wait_and_retry(response)
+        response = HTTP.auth(auth_token).post(url)
+      end
+    end
+
+    ###################
+    # ROOM MANAGEMENT #
+    ###################
+
+    def change_room_visibility(room_id, visibility)
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.change_room_visibility_path(room_id)
+
+      data_hash = { join_rule: visibility }
+      data = JSON.generate data_hash
+
+      response = HTTP.auth(auth_token).put(url, body: data)
+
+      matrix_interceptor = MatrixInterceptor.new
+      if matrix_interceptor.need_to_wait_and_retry(response)
+        response = HTTP.auth(auth_token).put(url)
+      end
+    end
+  end
+end

data/lib/citadel/authenticator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'matrix_paths'
+
+module Citadel
+  class Authenticator
+    def get_token(login, password)
+      matrix_paths = MatrixPaths.new
+      url = matrix_paths.base_uri + matrix_paths.login_path
+      data_hash = { type: 'm.login.password', user: login, password: password }
+      data = JSON.generate data_hash
+      response = HTTP.post(url, body: data)
+      JSON.parse(response.body)['access_token']
+    end
+  end
+end

data/lib/citadel/matrix_interceptor.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Citadel
+  class MatrixInterceptor
+    def need_to_wait_and_retry(response)
+      wait_time = JSON.parse(response.body)['retry_after_ms']
+      if wait_time
+        sleep((wait_time / 1000).ceil + 1)
+        return true
+      else
+        return false
+      end
+    end
+  end
+end

data/lib/citadel/matrix_paths.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Citadel
+  class MatrixPaths
+
+    def base_uri
+      Citadel.tenant_url + '/_matrix/client/r0'
+    end
+
+    def login_path
+      '/login'
+    end
+
+    def create_room_path
+      '/createRoom'
+    end
+
+    def send_message_path(room_id)
+      '/rooms/' + room_id + '/send/m.room.message/'
+    end
+
+    def invite_in_room_path(room_id)
+      '/rooms/' + room_id + '/invite'
+    end
+
+    def list_public_rooms_path
+      '/publicRooms' + '?limit=' + Citadel.public_rooms_limit
+    end
+
+    def list_joined_rooms_path
+      '/joined_rooms'
+    end
+
+    def join_room_path(room_id)
+      '/rooms/' + room_id + '/join'
+    end
+
+    def leave_room_path(room_id)
+      '/rooms/' + room_id + '/leave'
+    end
+
+    def change_room_visibility_path(room_id)
+      '/rooms/' + room_id + '/state/m.room.join_rules'
+    end
+  end
+end

data/lib/citadel/version.rb

@@ -0,0 +1,3 @@
+module Citadel
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: citadel-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Claire Dufetrelle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: A simple way to publish messages on Citadel
+email:
+- claire.dufetrelle@fabernovel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/citadel.rb
+- lib/citadel/authenticator.rb
+- lib/citadel/matrix_interceptor.rb
+- lib/citadel/matrix_paths.rb
+- lib/citadel/version.rb
+homepage: http://rubygems.org/gems/citadel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Citadel Ruby client
+test_files: []