yl_chat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d74d52377a7fe70f0787a51552b7e2ffdb463a4df1d7486ff4fe3af7c8a4fdf9
+  data.tar.gz: 9a470963007311ee2175cd3a11d79a53f7bae8859195f0909fe27f54a26a35d0
+SHA512:
+  metadata.gz: d1b5e86897174ef27068967790fc73a7c53add3bba0558a2cbda91ee5c431de3cd7d4b059434c760b26f533e1862a5776e093c7a2f0f0833813f64a4bfeb7053
+  data.tar.gz: f32e876efaa90bb1c1d440f7471e1e58984ef76c1e27a6bbb5d65b47e3abd84e9568059c28bf85abcb19b32f7fdd9aa51e5ea789e46d5ff066ccb3140f873710

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Bohdan Nikolaienko
+
+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,45 @@
+# YlChat
+This gem provides integration of the "YlChat" messenger service with your main
+RoR application.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yl_chat',
+    git: 'https://git.yalantis.com/bohdan.nikolaienko/yl_chat_gem.git'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install yl_chat
+```
+
+Create an initializer:
+```bash
+$ rails g yl_chat:initializer
+```
+
+Generate a list of performers:
+```bash
+$ rails g yl_chat:performers
+```
+Inside performers implement needed methods following tips in comments.
+Notice, that by default performers method 'authorized?' returns :true and
+'perform' do nothing and returns nil.
+
+Inside the routes.rb file mount needed routes
+```ruby
+mount YlChat::Engine => "api/chat"
+```
+
+## User disconnection
+The next method provides an ability to disconnect a user from all chat channels:
+```ruby
+YlChat::DisconnectUser.perform("user_uid")
+```

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'YlChat'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/yl_chat/application_controller.rb

@@ -0,0 +1,22 @@
+module YlChat
+  class ApplicationController < ActionController::Base
+    before_action :authorize_ip, if: -> { YlChat.trust_ips.present?}
+
+    rescue_from YlChat::Unauthorized do |_|
+      head :unauthorized
+    end
+
+    def room_meta
+      YlChat.room_meta
+    end
+
+    def identity_meta
+      YlChat.identity_meta
+    end
+
+    def authorize_ip
+      ip_authorized = YlChat.trust_ips.include? request.remote_ip
+      raise YlChat::Unauthorized unless ip_authorized
+    end
+  end
+end

data/app/controllers/yl_chat/notifications_controller.rb

@@ -0,0 +1,22 @@
+module YlChat
+  class NotificationsController < YlChat::ApplicationController
+
+    def handle
+      ::Notify.perform(notification_params.to_h)
+      head :ok
+    end
+
+    private
+
+    def notification_params
+      params.require(:notification)
+            .permit(recipient_uids: [],
+                    message: [:type, :sent_at, :room_uid, :id, :client_id,
+                              body: [:text, :uid, :type, :title, :description,
+                              meta: room_meta,
+                              participants: [:uid, meta: identity_meta]],
+                              author: [:uid, meta: identity_meta]]
+      )
+    end
+  end
+end

data/app/controllers/yl_chat/rooms/connection_controller.rb

@@ -0,0 +1,20 @@
+module YlChat
+  module Rooms
+    class ConnectionController < YlChat::ApplicationController
+      def authorize
+        authenticate_with_http_token do |token, options|
+          ::ConnectUserToRoom.perform(token, connection_params.to_h)
+        end
+        head :ok
+      end
+
+      private
+
+      def connection_params
+        params.require(:data)
+              .permit(:uid, :type, :title, :description, meta: room_meta,
+                      participants: [:uid, meta: identity_meta])
+      end
+    end
+  end
+end

data/app/controllers/yl_chat/rooms/creation_controller.rb

@@ -0,0 +1,20 @@
+module YlChat
+  module Rooms
+    class CreationController < YlChat::ApplicationController
+      def authorize
+        room_data = authenticate_with_http_token do |token, options|
+          ::CreateRoom.perform(token, authorization_params.to_h)
+        end
+        YlChat::RoomValidator.new(room_data).validate!
+        render json: { data: room_data }
+      end
+
+      private
+
+      def authorization_params
+        params.permit(:type, :title, :description, participants: [],
+                      meta: room_meta)
+      end
+    end
+  end
+end

data/app/controllers/yl_chat/users/authorization_controller.rb

@@ -0,0 +1,13 @@
+module YlChat
+  module Users
+    class AuthorizationController < YlChat::ApplicationController
+      def authorize
+        user_data = authenticate_with_http_token do |token, options|
+          ::IdentifyUser.perform(token)
+        end
+        YlChat::IdentityValidator.new(user_data).validate!
+        render json: { data: user_data }
+      end
+    end
+  end
+end

data/app/performers/yl_chat/base_connect_user_to_room.rb

@@ -0,0 +1,13 @@
+module YlChat
+  class BaseConnectUserToRoom < YlChat::BasePerformer
+    def initialize(user_token, room_params)
+      @user_token = user_token
+      @uid = room_params[:uid]
+      @type = room_params[:type]
+      @participants = room_params[:participants]
+      @meta = room_params[:meta]
+      @title = room_params[:title]
+      @description = room_params[:description]
+    end
+  end
+end

data/app/performers/yl_chat/base_create_room.rb

@@ -0,0 +1,12 @@
+module YlChat
+  class BaseCreateRoom < YlChat::BasePerformer
+    def initialize(user_token, room_params)
+      @user_token = user_token
+      @type = room_params[:type]
+      @participant_uids = room_params[:participants]
+      @meta = room_params[:meta]
+      @title = room_params[:title]
+      @description = room_params[:description]
+    end
+  end
+end

data/app/performers/yl_chat/base_identify_user.rb

@@ -0,0 +1,7 @@
+module YlChat
+  class BaseIdentifyUser < YlChat::BasePerformer
+    def initialize(user_token)
+      @user_token = user_token
+    end
+  end
+end

data/app/performers/yl_chat/base_notify.rb

@@ -0,0 +1,8 @@
+module YlChat
+  class BaseNotify < YlChat::BasePerformer
+    def initialize(notification_params)
+      @recipient_uids = notification_params[:recipient_uids]
+      @message = notification_params[:message]
+    end
+  end
+end

data/app/performers/yl_chat/base_performer.rb

@@ -0,0 +1,21 @@
+module YlChat
+  class BasePerformer
+    def self.perform(*args)
+      performer = new(*args)
+      performer.authorize!
+      performer.perform
+    end
+
+    def perform
+      # do nothing
+    end
+
+    def authorized?
+      true
+    end
+
+    def authorize!
+      raise YlChat::Unauthorized unless authorized?
+    end
+  end
+end

data/app/performers/yl_chat/disconnect_user.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'uri'
+
+module YlChat
+  class DisconnectUser
+    attr_reader :user_uid
+    DISCONNECTION_ENDPOINT = '/main_server/socket/disconnect'
+    CONTENT_TYPE = { 'Content-Type' => 'application/json' }
+
+    def initialize(user_uid)
+      @user_uid = user_uid
+    end
+
+    def self.perform(user_uid)
+      new(user_uid).perform
+    end
+
+    def perform
+      uri = URI(YlChat.yl_chat_url + DISCONNECTION_ENDPOINT)
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        request = Net::HTTP::Post.new(uri, CONTENT_TYPE)
+        request.body = { uid: user_uid }.to_json
+        http.request request
+      end
+    end
+  end
+end

data/app/validators/yl_chat/base_validator.rb

@@ -0,0 +1,20 @@
+module YlChat
+  class BaseValidator
+    include ActiveModel::Model
+    include ActiveModel::Validations
+
+    def initialize(attributes)
+      begin
+        super
+      rescue ActiveModel::UnknownAttributeError => e
+        raise InvalidData.new("Unknown attribute #{e.attribute}")
+      rescue ArgumentError => e
+        raise InvalidData.new('Data should be a Hash')
+      end
+    end
+
+    def validate!
+      raise InvalidData.new(self.errors.full_messages.join(', ')) unless valid?
+    end
+  end
+end

data/app/validators/yl_chat/identity_validator.rb

@@ -0,0 +1,18 @@
+module YlChat
+  class IdentityValidator < YlChat::BaseValidator
+    attr_accessor :uid, :meta
+
+    validates_presence_of :uid, :meta
+
+    validate :uid_type
+    validate :meta_type
+ 
+    def uid_type
+      errors.add(:uid, "is not a string") unless uid.is_a? String
+    end
+
+    def meta_type
+      errors.add(:meta, "is not a hash") unless meta.is_a? Hash
+    end
+  end
+end

data/app/validators/yl_chat/room_validator.rb

@@ -0,0 +1,11 @@
+module YlChat
+  class RoomValidator < YlChat::BaseValidator
+    attr_accessor :meta
+
+    validate :meta_type, if: 'meta.present?'
+
+    def meta_type
+      errors.add(:meta, "is not a hash") unless meta.is_a? Hash
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,10 @@
+YlChat::Engine.routes.draw do
+  post '/notifications', to: 'notifications#handle'
+  namespace :users do
+    get '/authorization', to: 'authorization#authorize'
+  end
+  namespace :rooms do
+    post '/creation', to: 'creation#authorize'
+    post '/connection', to: 'connection#authorize'
+  end
+end

data/lib/generators/yl_chat/initializer_generator.rb

@@ -0,0 +1,17 @@
+module YlChat
+  class InitializerGenerator < Rails::Generators::Base
+
+    INITIALIZER_PATH = 'config/initializers/yl_chat.rb'
+    TEMPLATE_PATH = '../templates/initializer.rb'
+
+    def create_initializer_file
+      create_file INITIALIZER_PATH, template
+    end
+
+    private
+
+    def template
+      @template ||= File.read(File.expand_path(TEMPLATE_PATH, __FILE__))
+    end
+  end
+end

data/lib/generators/yl_chat/performers_generator.rb

@@ -0,0 +1,27 @@
+module YlChat
+  class PerformersGenerator < Rails::Generators::Base
+
+    PERFORMERS_PATH = 'app/yl_chat/'
+    TEMPLATE_PATH = '../templates/performers/'
+
+    def create_performers
+      create_performer 'connect_user_to_room.rb'
+      create_performer 'create_room.rb'
+      create_performer 'identify_user.rb'
+      create_performer 'notify.rb'
+    end
+
+    private
+
+    def create_performer(file_name)
+      path = PERFORMERS_PATH + file_name
+      template = performer_template(file_name)
+      create_file path, template
+    end
+
+    def performer_template(file_name)
+      path = TEMPLATE_PATH + file_name
+      File.read(File.expand_path(path, __FILE__))
+    end
+  end
+end

data/lib/generators/yl_chat/templates/initializer.rb

@@ -0,0 +1,11 @@
+YlChat.setup do |config|
+  # configure structure of meta here
+  config.identity_meta = [:name, :avatar]
+  config.room_meta = [:key]
+
+  # configure IP of a chat server to restrict access for other
+  config.trust_ips = []
+
+  # configure a URL of yl_chat application
+  config.yl_chat_url = 'http://yl_chat'
+end

data/lib/generators/yl_chat/templates/performers/connect_user_to_room.rb

@@ -0,0 +1,18 @@
+# This performer will be called every time when a user try to connect to a chat
+# room.
+#
+# Implement the "authorized" method to return :true if this connection is
+# allowed or :falce if forbidden.
+
+class ConnectUserToRoom < YlChat::BaseConnectUserToRoom
+  attr_reader :user_token, :uid, :type, :participants, :meta, :title, :description
+=begin
+  def authorized?
+    begin
+      TokenAuth::AuthenticationToken.find(user_token).entity.present?
+    rescue TokenAuth::FindEntityException => e
+      false
+    end
+  end
+=end
+end

data/lib/generators/yl_chat/templates/performers/create_room.rb

@@ -0,0 +1,25 @@
+# This performer will be called every time before a new chat room creation.
+#
+# Implement the "authorized" method to return :true if creation is allowed
+# or :falce if forbidden.
+#
+# Implement the "perform" method to return a hash with the next schema:
+# { meta: Hash }, where 'meta' is a set of data which will be attached to a
+# created room.
+
+class CreateRoom < YlChat::BaseCreateRoom
+  attr_reader :user_token, :type, :participant_uids, :meta, :title, :description
+=begin
+  def authorized?
+    begin
+      TokenAuth::AuthenticationToken.find(user_token).entity.present?
+    rescue TokenAuth::FindEntityException => e
+      false
+    end
+  end
+
+  def perform
+    { meta: { key: 'value' } }
+  end
+=end
+end

data/lib/generators/yl_chat/templates/performers/identify_user.rb

@@ -0,0 +1,26 @@
+# This performer will be called every time when a user try to connect to a chat.
+#
+# Implement the "authorized" method to return :true if this connection
+# is allowed or :falce if forbidden.
+#
+# Implement the "perform" method to return a hash with the next schema:
+# { uid: String, meta: Hash }, where 'uid' is the unique identifier of a
+# current user and 'meta' is a set of user data which will be used in a chat.
+
+class IdentifyUser < YlChat::BaseIdentifyUser
+  attr_reader :user_token
+=begin
+  def authorized?
+    begin
+      @user = TokenAuth::AuthenticationToken.find(user_token).entity
+      @user.present?
+    rescue TokenAuth::FindEntityException => e
+      false
+    end
+  end
+
+  def perform
+    { uid: @user.id.to_s, meta: { name: @user.name } }
+  end
+=end
+end

data/lib/generators/yl_chat/templates/performers/notify.rb

@@ -0,0 +1,16 @@
+# This performer will be called every time when offline recipients receive a
+# new message.
+#
+# Implement the "perform" method to notify recipients about a new message in
+# properly way.
+
+class Notify < YlChat::BaseNotify
+  attr_reader :recipient_uids, :message
+=begin
+  def perform
+    recipient_uids.each do |recipient_uid|
+      UserNotification::NewMessage.new(recipient_uid, message).notify_user
+    end
+  end
+=end
+end

data/lib/tasks/yl_chat_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :yl_chat do
+#   # Task goes here
+# end

data/lib/yl_chat.rb

@@ -0,0 +1,26 @@
+require "yl_chat/engine"
+
+module YlChat
+  class Unauthorized < StandardError; end
+  class InvalidData < StandardError; end
+
+  @identity_meta = []
+  @room_meta = []
+  @trust_ips = []
+  @yl_chat_url = ''
+
+  class << self
+    attr_accessor :identity_meta
+    attr_accessor :room_meta
+    attr_accessor :trust_ips
+    attr_accessor :yl_chat_url
+
+    def setup
+      yield self
+    end
+
+    def routes(application)
+      application.mount YlChat::Engine => "/notifications"
+    end
+  end
+end

data/lib/yl_chat/engine.rb

@@ -0,0 +1,5 @@
+module YlChat
+  class Engine < ::Rails::Engine
+    isolate_namespace YlChat
+  end
+end

data/lib/yl_chat/version.rb

@@ -0,0 +1,3 @@
+module YlChat
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: yl_chat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bohdan Nikolaienko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Description of YlChat.
+email:
+- bohdan.nikolaienko@yalantis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/yl_chat/application_controller.rb
+- app/controllers/yl_chat/notifications_controller.rb
+- app/controllers/yl_chat/rooms/connection_controller.rb
+- app/controllers/yl_chat/rooms/creation_controller.rb
+- app/controllers/yl_chat/users/authorization_controller.rb
+- app/performers/yl_chat/base_connect_user_to_room.rb
+- app/performers/yl_chat/base_create_room.rb
+- app/performers/yl_chat/base_identify_user.rb
+- app/performers/yl_chat/base_notify.rb
+- app/performers/yl_chat/base_performer.rb
+- app/performers/yl_chat/disconnect_user.rb
+- app/validators/yl_chat/base_validator.rb
+- app/validators/yl_chat/identity_validator.rb
+- app/validators/yl_chat/room_validator.rb
+- config/routes.rb
+- lib/generators/yl_chat/initializer_generator.rb
+- lib/generators/yl_chat/performers_generator.rb
+- lib/generators/yl_chat/templates/initializer.rb
+- lib/generators/yl_chat/templates/performers/connect_user_to_room.rb
+- lib/generators/yl_chat/templates/performers/create_room.rb
+- lib/generators/yl_chat/templates/performers/identify_user.rb
+- lib/generators/yl_chat/templates/performers/notify.rb
+- lib/tasks/yl_chat_tasks.rake
+- lib/yl_chat.rb
+- lib/yl_chat/engine.rb
+- lib/yl_chat/version.rb
+homepage: 
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Summary of YlChat.
+test_files: []