logux_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2ddee267525e7f6503a6a64b42b4b18322dd7a597c1f535f5c3341921bad354
+  data.tar.gz: b7f32ba3524a11d9a81872064231cc939773cc68a22029a3cf52e48253fafeb6
+SHA512:
+  metadata.gz: 5a82d8cf1df3c2c228b4e6a371cf027d146cb59bc67f338cbef4103745132047f56224024fa9b24347d5b3734ead07afe4d0ca744b0b7d8eef07fe3a246d8e38
+  data.tar.gz: 7d9efeb074215bb2ac5c3d601ded5425f2c927efe5f6ed7c4f749c6f49b9f1fb33b4b40abdd0b9145912f1ecc17c08b3bca99580cd9f8a49fecbe2997a1869c3

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store
+
+**/*.log
+.*.swp
+coverage
+Gemfile.lock
+spec/dummy/db/*.sqlite3
+/gemfiles/*

data/.pryrc

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'spec/dummy/db/**/*.rb'
+    - 'vendor/**/*'
+    - 'gemfiles/*'
+  TargetRubyVersion: 2.4
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - 'logux_rails.gemspec'
+    - 'lib/logux/test/helpers.rb'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/logux/tasks/*.rb'
+    - 'spec/requests/*.rb'
+
+FactoryBot/StaticAttributeDefinedDynamically:
+  Enabled: false
+
+RSpec/ExpectChange:
+  EnforcedStyle: block
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/DateTime:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-07-26 13:29:22 +0300 using RuboCop version 0.57.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 17
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/MixinUsage:
+  Exclude:
+    - 'spec/dummy/bin/setup'
+    - 'spec/dummy/bin/update'

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: require
+services:
+  - docker
+
+before_script:
+  - unset BUNDLE_GEMFILE
+  - docker-compose run app bundle install
+  - docker-compose run app bundle exec appraisal install
+script:
+  - docker-compose run app bundle exec appraisal rspec
+  - docker-compose run app bundle exec rubocop

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise '5.0' do
+  gem 'activerecord', '~> 5.0'
+end
+
+appraise '5.1' do
+  gem 'activerecord', '~> 5.1'
+end
+
+appraise '5.2' do
+  gem 'activerecord', '~> 5.2'
+end

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in logux_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 WildDima
+
+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,68 @@
+# Logux Rails
+
+[![Build Status](https://travis-ci.org/logux/logux_rails.svg?branch=master)](https://travis-ci.org/logux/logux_rails) [![Coverage Status](https://coveralls.io/repos/github/logux/logux_rails/badge.svg?branch=master)](https://coveralls.io/github/logux/logux_rails?branch=master)
+
+Add WebSockets, live-updates and offline-first to Ruby on Rails with [Logux](https://github.com/logux/logux/). This gem will add [Logux Back-end Protocol](https://github.com/logux/logux/blob/master/backend-protocol/spec.md) to Ruby on Rails and then you can use Logux Server as a proxy between WebSocket and your Rails application.
+
+Read [Creating Logux Proxy](https://github.com/logux/logux/blob/master/2-starting/2-creating-proxy.md) guide.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logux_rails'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Usage
+
+First of all, you have to configure Logux, by defining server address in, for example, `config/initializers/logux.rb`:
+
+```ruby
+Logux.configuration do |config|
+  config.logux_host = 'http://localhost:31338'
+end
+```
+
+Mount logux in routes:
+
+```ruby
+  mount Logux::Engine => '/'
+```
+
+After this, POST requests to `/logux` will be processed by `LoguxController`. You can redefine it or inherit from, if it necessary, for example, for implementing custom authorization flow.
+
+Logux Rails will try to find Action for the specific message from Logux Server. For example, for `project/rename` action, you should define `Action::Project` class, inherited from `Logux::Action` base class, and implement `rename` method.
+
+You can execute `rake logux:actions` to get the list of available action types, or `rake logux:channels` to get the list of available channels.
+
+## Development with Docker
+
+After checking out the repo, run:
+
+```bash
+docker-compose run app bundle install
+docker-compose run app bundle exec appraisal install
+```
+
+Run tests with:
+
+```bash
+docker-compose run app bundle exec appraisal rspec
+```
+
+Run RuboCop with:
+
+```bash
+docker-compose run app bundle exec rubocop
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/app/controllers/logux_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+class LoguxController < ActionController::Base
+  include ActionController::Live
+
+  def create
+    logux_stream.write('[')
+    Logux.verify_request_meta_data(meta_params)
+    Logux.process_batch(stream: logux_stream, batch: command_params)
+  rescue => ex
+    handle_processing_errors(ex)
+  ensure
+    logux_stream.write(']')
+    logux_stream.close
+  end
+
+  private
+
+  def unsafe_params
+    params.to_unsafe_h
+  end
+
+  def command_params
+    unsafe_params.dig('commands')
+  end
+
+  def meta_params
+    unsafe_params&.slice(:version, :password)
+  end
+
+  def logux_stream
+    @logux_stream ||= Logux::Stream.new(response.stream)
+  end
+
+  def handle_processing_errors(exception)
+    Logux.configuration.on_error.call(exception)
+    Logux.logger.error("#{exception}\n#{exception.backtrace.join("\n")}")
+  ensure
+    logux_stream.write(Logux::ErrorRenderer.new(exception).message)
+  end
+end

data/app/helpers/logux_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module LoguxHelper
+end

data/app/logux/actions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+module Actions; end

data/app/logux/policies.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+module Policies; end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'logux_rails'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Logux::Engine.routes.draw do
+  resource :logux, only: %i[create], controller: :logux
+end

data/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3.4'
+
+services:
+  app:
+    image: ruby:2.5.1
+    environment:
+      - BUNDLE_PATH=/bundle
+      - BUNDLE_CONFIG=/app/.bundle/config
+
+      - DB_HOST=db
+      - DB_NAME=logux_rails
+      - DB_USERNAME=postgres
+    command: bash
+    working_dir: /app
+    volumes:
+      - .:/app:cached
+      - bundler_data:/bundle
+    tmpfs:
+      - /tmp
+    depends_on:
+      - db
+
+  db:
+    image: postgres:10
+    environment:
+      - POSTGRES_DB=logux_rails
+
+volumes:
+  bundler_data:

data/lib/generators/logux/model/USAGE

@@ -0,0 +1,11 @@
+Description:
+  Generates the necessary migration to enable field tracking for logux updates
+
+Examples:
+  rails generate logux:model User
+
+    This will generate the migration to add a column with update time data.
+
+  rails generate logux:model User --nullable
+
+    This will generate the migration to add a column with update time data and add `null: false` constraint. Be careful, adding the constraint to the table with a big number of rows can cause lots of locks.

data/lib/generators/logux/model/model_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record/migration/migration_generator'
+
+module Logux
+  module Generators
+    class ModelGenerator < ::ActiveRecord::Generators::Base # :nodoc:
+      source_root File.expand_path('templates', __dir__)
+
+      class_option :nullable,
+                   type: :boolean,
+                   optional: true,
+                   desc: 'Define whether field should have not-null constraint'
+
+      def generate_migration
+        migration_template(
+          'migration.rb.erb',
+          "db/migrate/add_logux_fields_updated_at_to_#{plural_table_name}.rb"
+        )
+      end
+
+      def nullable?
+        options.fetch(:nullable, false)
+      end
+    end
+  end
+end

data/lib/generators/logux/model/templates/migration.rb.erb

@@ -0,0 +1,14 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VERSION::MAJOR < 5 ? '' : '[5.0]' %>
+  def up
+    <% if nullable? %>
+    add_column :<%= plural_table_name %>, :logux_fields_updated_at, :jsonb, null: false, default: {}
+    <% else %>
+    add_column :<%= plural_table_name %>, :logux_fields_updated_at, :jsonb, null: true
+    change_column_default :<%= plural_table_name %>, :logux_fields_updated_at, {}
+    <% end %>
+  end
+
+  def down
+    remove_column :<%= plural_table_name %>, :logux_fields_updated_at
+  end
+end

data/lib/logux.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'configurations'
+require 'rest-client'
+require 'rails/engine'
+require 'active_support'
+require 'action_controller'
+require 'logux/engine'
+require 'nanoid'
+require 'colorize'
+
+module Logux
+  extend ActiveSupport::Autoload
+  include Configurations
+
+  PROTOCOL_VERSION = 1
+
+  class WithMetaError < StandardError
+    attr_reader :meta
+
+    def initialize(msg, meta: nil)
+      @meta = meta
+      super(msg)
+    end
+  end
+
+  UnknownActionError = Class.new(WithMetaError)
+  UnknownChannelError = Class.new(WithMetaError)
+  UnauthorizedError = Class.new(StandardError)
+
+  autoload :Client, 'logux/client'
+  autoload :Meta, 'logux/meta'
+  autoload :Actions, 'logux/actions'
+  autoload :Auth, 'logux/auth'
+  autoload :BaseController, 'logux/base_controller'
+  autoload :ActionController, 'logux/action_controller'
+  autoload :ChannelController, 'logux/channel_controller'
+  autoload :ClassFinder, 'logux/class_finder'
+  autoload :ActionCaller, 'logux/action_caller'
+  autoload :PolicyCaller, 'logux/policy_caller'
+  autoload :Policy, 'logux/policy'
+  autoload :Add, 'logux/add'
+  autoload :Node, 'logux/node'
+  autoload :Response, 'logux/response'
+  autoload :Stream, 'logux/stream'
+  autoload :Process, 'logux/process'
+  autoload :Logger, 'logux/logger'
+  autoload :Version, 'logux/version'
+  autoload :Test, 'logux/test'
+  autoload :ErrorRenderer, 'logux/error_renderer'
+  autoload :Model, 'logux/model'
+
+  configurable :logux_host, :verify_authorized,
+               :password, :logger,
+               :on_error, :auth_rule,
+               :render_backtrace_on_error
+
+  configuration_defaults do |config|
+    config.logux_host = 'localhost:1338'
+    config.verify_authorized = true
+    config.logger = ActiveSupport::Logger.new(STDOUT)
+    if defined?(Rails) && Rails.respond_to?(:logger)
+      config.logger = Rails.logger
+    end
+    config.on_error = proc {}
+    config.auth_rule = proc { false }
+    config.render_backtrace_on_error = true
+  end
+
+  def self.add(action, meta = Meta.new)
+    Logux::Add.new.call([[action, meta]])
+  end
+
+  def self.add_batch(commands)
+    Logux::Add.new.call(commands)
+  end
+
+  def self.undo(meta, reason: nil, data: {})
+    add(
+      data.merge(type: 'logux/undo', id: meta.id, reason: reason),
+      Logux::Meta.new(clients: [meta.client_id])
+    )
+  end
+
+  def self.verify_request_meta_data(meta_params)
+    if Logux.configuration.password.nil?
+      logger.warn(%(Please, add password for logux server:
+                          Logux.configure do |c|
+                            c.password = 'your-password'
+                          end))
+    end
+    auth = Logux.configuration.password == meta_params&.dig(:password)
+    raise Logux::UnauthorizedError, 'Incorrect password' unless auth
+  end
+
+  def self.process_batch(stream:, batch:)
+    Logux::Process::Batch.new(stream: stream, batch: batch).call
+  end
+
+  def self.generate_action_id
+    Logux::Node.instance.generate_action_id
+  end
+
+  def self.logger
+    configuration.logger
+  end
+end