logux-rack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a92195a6e6cda7d85659828eda8c36688f4631496770acc091310b8918ae0022
+  data.tar.gz: b011e2d6c5c567c15f7a85460ec3fb4b94d6d719656de0d67d90f77f768c4d9a
+SHA512:
+  metadata.gz: 75bb7b8d7a1cdcc309b9395dc13043af53e2f3ebda8db0058bca72fe124f863395badc3af1d1e604db33965fd42cc6be084c620f4fd080d7a9bca3390703229d
+  data.tar.gz: b945746e700b958b415b417580a5d23c7f8bccb0f28578d34deab3789c710a1eb9802863ee890d49b46734da3bf23e82d4a22fb2c06cee4b41a04d4e6bb872cd

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/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2019-08-29
+
+- Initial public release.

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-rack.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,130 @@
+<a href="https://amplifr.com/?utm_source=logux-rack">
+  <img width="100" height="140" align="right"
+    alt="Sponsored by Amplifr" src="https://amplifr-direct.s3-eu-west-1.amazonaws.com/social_images/image/37b580d9-3668-4005-8d5a-137de3a3e77c.png" />
+</a>
+
+# Logux::Rack
+
+[![Build Status](https://travis-ci.org/logux/logux-rack.svg?branch=master)](https://travis-ci.org/logux/logux-rack) [![Coverage Status](https://coveralls.io/repos/github/logux/logux-rack/badge.svg?branch=master)](https://coveralls.io/github/logux/logux-rack?branch=master)
+
+Add WebSockets, live-updates and offline-first to any Rack-based application with [Logux](https://github.com/logux/logux/). It adds [Logux Back-end Protocol](https://github.com/logux/logux/blob/master/backend-protocol/spec.md) support to Ruby on Rails or any other Rack applications, so you can use Logux Server as a proxy between WebSocket and your web 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-rack'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Usage
+
+Here is a minimal Rack configuration to start new `Logux::Rack` server:
+
+```ruby
+# config.ru
+require 'logux/rack'
+
+run Logux.application
+```
+
+Note that the HTTP response streaming depends on the web server used to serve the application. Use a server with streaming capability. [Puma](https://puma.io/), for instance:
+
+```bash
+gem install puma
+```
+
+Start the server:
+
+```bash
+puma config.ru
+```
+
+It is possible to mount `Logux::Rack` server within an existing Rails application. First of all, you will need to configure Logux by defining a server address in an initializer. For example, `config/initializers/logux.rb`:
+
+```ruby
+Logux.configuration do |config|
+  config.logux_host = 'http://localhost:31338'
+end
+```
+
+Mount `Logux::Rack` in routes:
+
+```ruby
+Rails.application.routes.draw do
+  mount Logux::Rack::App => '/'
+end
+```
+
+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.
+
+Here is another routing example for [Roda](https://github.com/jeremyevans/roda) application routing:
+
+```ruby
+class MyApp < Roda
+  route do |r|
+    r.is 'logux' { r.run Logux::Rack::App }
+  end
+end
+```
+
+[Hanami](https://hanamirb.org/) configuration example:
+
+```ruby
+# config/environment.rb
+Hanami.configure do
+  mount Logux::Rack::App, at: '/'
+end
+```
+
+`Logux::Rack` can also be embedded into another Rack application using [Rack::Builder](https://www.rubydoc.info/gems/rack/Rack/Builder):
+
+```ruby
+# config.ru
+
+require 'logux/rack'
+
+app = Rack::Builder.new do
+  use Rack::CommonLogger
+  map '/logux' { run Logux::Rack::App }
+  # ...
+end
+
+run app
+```
+
+`Logux::Rack` 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. Use optional path parameter to limit the search scope: `rake logux:actions[lib/logux/actions]`
+
+## Development with Docker
+
+After checking out the repo, run:
+
+```bash
+docker-compose run app bundle install
+```
+
+Run tests with:
+
+```bash
+docker-compose run app bundle exec 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require_relative 'lib/logux/rake_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+Logux::RakeTasks.new
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'logux/rack'
+
+# 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.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'logux/rack'
+
+run Logux.application

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_rack
+      - 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_rack
+
+volumes:
+  bundler_data:

data/lib/logux.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'logux/rack'

data/lib/logux/action.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Logux
+  class Action
+    extend Forwardable
+
+    def_delegators(
+      :parameters,
+      :[],
+      :keys,
+      :key?,
+      :has_key?,
+      :values,
+      :has_value?,
+      :value?,
+      :empty?,
+      :include?,
+      :as_json,
+      :to_s,
+      :each_key
+    )
+
+    def initialize(parameters = {})
+      raise ArgumentError, :parameters unless parameters.is_a?(Hash)
+
+      @parameters = parameters.transform_keys(&:to_s)
+    end
+
+    def action_name
+      type&.split('/')&.dig(0)
+    end
+
+    def action_type
+      type&.split('/')&.last
+    end
+
+    def channel_name
+      channel&.split('/')&.dig(0)
+    end
+
+    def channel_id
+      channel&.split('/')&.last
+    end
+
+    def type
+      fetch('type')
+    end
+
+    def channel
+      fetch('channel')
+    end
+
+    def fetch(key)
+      value = self[key]
+      raise ParameterMissingError, key if value.to_s.empty?
+
+      value
+    end
+
+    def [](key)
+      parameters[key.is_a?(Symbol) ? key.to_s : key]
+    end
+
+    private
+
+    attr_reader :parameters
+  end
+end

data/lib/logux/action_caller.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Logux
+  class ActionCaller
+    extend Forwardable
+
+    attr_reader :action, :meta
+
+    def_delegator :Logux, :logger
+
+    def initialize(action:, meta:)
+      @action = action
+      @meta = meta
+    end
+
+    def call!
+      Logux.watch_action { call_action }
+    rescue Logux::UnknownActionError, Logux::UnknownChannelError => e
+      logger.warn(e)
+      format(nil)
+    end
+
+    protected
+
+    def call_action
+      logger.debug("Searching Logux action: #{action}, meta: #{meta}")
+      format(action_controller.public_send(action.action_type))
+    end
+
+    private
+
+    def format(response)
+      return response if response.is_a?(Logux::Response)
+
+      Logux::Response.new(:processed, action: action, meta: meta)
+    end
+
+    def class_finder
+      @class_finder ||= Logux::ClassFinder.new(action: action, meta: meta)
+    end
+
+    def action_controller
+      class_finder.find_action_class.new(action: action, meta: meta)
+    end
+  end
+end

data/lib/logux/action_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Logux
+  class ActionController < Logux::BaseController
+  end
+end

data/lib/logux/action_watcher.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Logux
+  class ActionWatcher
+    def self.call(options = {}, &block)
+      new(options).call(&block)
+    end
+
+    attr_reader :options
+
+    def initialize(options = {})
+      raise ArgumentError, :options unless options.is_a?(Hash)
+
+      @options = options
+    end
+
+    def call
+      yield
+    end
+  end
+end

data/lib/logux/actions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Logux
+  class Actions < Action
+    class << self
+      extend Gem::Deprecate
+
+      deprecate :new, 'Logux::Action.new', 2020, 9
+
+      def warn(message)
+        Logux.logger.warn(message)
+      end
+    end
+
+    private_class_method :warn
+  end
+end