litecable 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edbe33668bf263f5af67a29240b2d2fc105c2ccf9e98735f4327ae14d965d2d9
-  data.tar.gz: b6f84ccc2bdbee995028ad821176a41925c2fedaf83142ccf6dd41dafaf21b65
+  metadata.gz: 47a04414eade53832c4b900305ca3a034999724c0cabd6aceacb908192a6124f
+  data.tar.gz: 24c67d2cacbb5f64b5b7d63293c7fdbe143797d0102b732983fc78028469dfc9
 SHA512:
-  metadata.gz: 31be4a35bd51711f7cf3677c0a96b749d60133fe7a91cd54aff2ca82f59ee095bd8362a65483d5b2902160fbad1975b060948aae74b292ce10c314e81976c168
-  data.tar.gz: 9cf99b623c1df22104374dbc947e08d694d279e7aae612a3274886433306868f5a75f8fdd096c5cd398319d85d9966b7cf682a424178e0168988a1c81fea014d
+  metadata.gz: eb63ada090f884f750828b7c116d1066a020c87ab043d929e4ad46b035299c95972acf1d458813a34da797273e0656fc7613977cfef24c6e0765a7a8dece9a6a
+  data.tar.gz: 75314e320e2ed5f18e34c4038d467aef14e73f9b0e4fe01f61955369a52ee28e246e62662a94c3e1d1b9f7ea9999049f8d58e5f7af80479fc88a97b91055720e

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change log
 
+## 0.7.0 (2020-01-07)
+
+- Refactor AnyCable integration ([@palkan][])
+
+Now you only need to set AnyCable broadcast adapter:
+
+```ruby
+LiteCable.broadcast_adapter = :any_cable
+```
+
+```sh
+# or via env/config
+LITECABLE_BROADCAST_ADAPTER=any_cable ruby my_app.rb
+```
+
+- Adapterize broadcast adapters ([@palkan][])
+
+- Drop Ruby 2.4 support ([palkan][])
+
 ## 0.6.0 (2019-04-12) 🚀
 
 - Drop Ruby 2.3 support ([@palkan][])
@@ -10,7 +29,7 @@
 
 ## 0.4.1 (2017-02-04)
 
-- Use `websocket-ruby` with subprotocols support ([@palkan][])
+- Use `websocket-ruby` with sub-protocols support ([@palkan][])
 
 ## 0.4.0 (2017-01-29)
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 palkan
+Copyright (c) 2017-2020 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/litecable.svg)](https://rubygems.org/gems/litecable) [![Build Status](https://travis-ci.org/palkan/litecable.svg?branch=master)](https://travis-ci.org/palkan/litecable)
+[![Gem Version](https://badge.fury.io/rb/litecable.svg)](https://rubygems.org/gems/litecable)
+[![Build](https://github.com/palkan/litecable/workflows/Build/badge.svg)](https://github.com/palkan/litecable/actions)
 
 # Lite Cable
 
@@ -25,17 +26,11 @@ Add this line to your application's Gemfile:
 gem "litecable"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install litecable
+And run `bundle install`.
 
 ## Usage
 
-Please, checkout [Action Cable guides](http://guides.rubyonrails.org/action_cable_overview.html) for general information. Lite Cable aims to be compatible with Action Cable as much as possible without the loss of simplicity and _ligthness_.
+Please, checkout [Action Cable guides](http://guides.rubyonrails.org/action_cable_overview.html) for general information. Lite Cable aims to be compatible with Action Cable as much as possible without the loss of simplicity and _lightness_.
 
 You can use Action Cable javascript client without any change (precompiled version can be found [here](https://github.com/palkan/litecable/tree/master/examples/sinatra/assets/cable.js)).
 
@@ -83,24 +78,32 @@ end
 
 ### Using with AnyCable
 
-Lite Cable is AnyCable-compatible out-of-the-box. You should write a simple server script:
+Lite Cable is AnyCable-compatible out-of-the-box:
+
+- Set broadcast adapter to AnyCable:
 
 ```ruby
-#!/usr/bin/env ruby
+LiteCable.broadcast_adapter = :any_cable
+```
 
-require "my_app"
-require "rack"
-require "anycable"
+You can also do this via configuration, e.g., env var (`LITECABLE_BROADCAST_ADAPTER=any_cable`) or `broadcast_adapter: any_cable` in a YAML config.
 
-# Turn AnyCable compatibility mode
-LiteCable.anycable!
+- Configure connection factory:
 
-Anycable.connection_factory = MyApp::Connection
+```ruby
+AnyCable.connection_factory = MyApp::Connection
+```
+
+Then run AnyCable along with the app:
 
-Anycable::Server.start
+```sh
+bundle exec anycable
+
+# add -r option to load the app if it's not ./config/anycable.rb or ./config/environment.rb
+bundle exec anycable -r ./my_app.rb
 ```
 
-And then run this script along with your application. See [Sinatra example](https://github.com/palkan/litecable/tree/master/examples/sinatra) for more.
+See [Sinatra example](https://github.com/palkan/litecable/tree/master/examples/sinatra) for more.
 
 ### Configuration
 
@@ -120,9 +123,8 @@ See [config](https://github.com/palkan/litecable/blob/master/lib/lite_cable/conf
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/litecable.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/litecable](https://github.com/palkan/litecable).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](./LICENSE.txt).

data/lib/lite_cable.rb

@@ -15,6 +15,7 @@ module LiteCable
   require "lite_cable/channel"
   require "lite_cable/coders"
   require "lite_cable/config"
+  require "lite_cable/broadcast_adapters"
   require "lite_cable/anycable"
 
   class << self
@@ -23,8 +24,27 @@ module LiteCable
     end
 
     # Broadcast encoded message to the stream
-    def broadcast(*args)
-      LiteCable::Server.broadcast(*args)
+    def broadcast(stream, message, coder: LiteCable.config.coder)
+      broadcast_adapter.broadcast(stream, message, coder: coder)
+    end
+
+    def broadcast_adapter
+      return @broadcast_adapter if defined?(@broadcast_adapter)
+      self.broadcast_adapter = LiteCable.config.broadcast_adapter.to_sym
+      @broadcast_adapter
+    end
+
+    def broadcast_adapter=(adapter)
+      if adapter.is_a?(Symbol) || adapter.is_a?(Array)
+        adapter = BroadcastAdapters.lookup_adapter(adapter)
+      end
+
+      unless adapter.respond_to?(:broadcast)
+        raise ArgumentError, "BroadcastAdapter must implement #broadcast method. " \
+                              "#{adapter.class} doesn't implement it."
+      end
+
+      @broadcast_adapter = adapter
     end
   end
 end

data/lib/lite_cable/anycable.rb

@@ -3,14 +3,6 @@
 module LiteCable # :nodoc:
   # AnyCable extensions
   module AnyCable
-    module Broadcasting # :nodoc:
-      def broadcast(stream, message, coder: nil)
-        coder ||= LiteCable.config.coder
-        # FIXME: after anycable 0.6.0 release
-        Anycable.broadcast stream, coder.encode(message)
-      end
-    end
-
     module Connection # :nodoc:
       def self.extended(base)
         base.prepend InstanceMethods
@@ -20,9 +12,6 @@ module LiteCable # :nodoc:
         new(socket, options)
       end
 
-      # Backward compatibility with AnyCable <= 0.4
-      alias create call
-
       module InstanceMethods # :nodoc:
         def initialize(socket, subscriptions: nil, **hargs)
           super(socket, **hargs)
@@ -64,6 +53,19 @@ module LiteCable # :nodoc:
   # Patch Lite Cable with AnyCable functionality
   def self.anycable!
     LiteCable::Connection::Base.extend LiteCable::AnyCable::Connection
-    LiteCable.singleton_class.prepend LiteCable::AnyCable::Broadcasting
+  end
+end
+
+if defined?(AnyCable)
+  AnyCable.configure_server do
+    # Make sure broadcast adapter is valid
+    require "lite_cable/broadcast_adapters/any_cable"
+    unless LiteCable::BroadcastAdapters::AnyCable === LiteCable.broadcast_adapter
+      raise "You should use :any_cable broadcast adapter (current: #{LiteCable.broadcast_adapter.class}). " \
+            "Set it via LITECABLE_BROADCAST_ADAPTER=any_cable or in the code/YML."
+    end
+
+    # Turn AnyCable compatibility mode for anycable RPC server automatically
+    LiteCable.anycable!
   end
 end

data/lib/lite_cable/broadcast_adapters.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "lite_cable/broadcast_adapters/base"
+
+module LiteCable
+  module BroadcastAdapters # :nodoc:
+    module_function
+
+    # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
+    def lookup_adapter(args)
+      adapter, options = Array(args)
+      path_to_adapter = "lite_cable/broadcast_adapters/#{adapter}"
+      adapter_class_name = adapter.to_s.split("_").map(&:capitalize).join
+
+      unless BroadcastAdapters.const_defined?(adapter_class_name, false)
+        begin
+          require path_to_adapter
+        rescue LoadError => e
+          # We couldn't require the adapter itself.
+          if e.path == path_to_adapter
+            raise e.class, "Couldn't load the '#{adapter}' broadcast adapter for LiteCable",
+              e.backtrace
+          # Bubbled up from the adapter require.
+          else
+            raise e.class, "Error loading the '#{adapter}' broadcast adapter for LiteCable",
+              e.backtrace
+          end
+        end
+      end
+
+      BroadcastAdapters.const_get(adapter_class_name, false).new(**(options || {}))
+    end
+    # rubocop: enable Metrics/AbcSize, Metrics/MethodLength
+  end
+end

data/lib/lite_cable/broadcast_adapters/any_cable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LiteCable
+  module BroadcastAdapters
+    class AnyCable < Base
+      def broadcast(stream, message, coder:)
+        ::AnyCable.broadcast stream, coder.encode(message)
+      end
+    end
+  end
+end

data/lib/lite_cable/broadcast_adapters/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# frozen_string_literal: true
+
+module LiteCable
+  module BroadcastAdapters
+    class Base
+      def initialize(**options)
+        @options = options
+      end
+
+      private
+
+      attr_reader :options
+    end
+  end
+end

data/lib/lite_cable/broadcast_adapters/memory.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module LiteCable
+  module BroadcastAdapters
+    class Memory < Base
+      def broadcast(stream, message, coder:)
+        Server.subscribers_map.broadcast stream, message, coder
+      end
+    end
+  end
+end

data/lib/lite_cable/config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "anyway"
+require "anyway_config"
 require "logger"
 
 module LiteCable
@@ -12,8 +12,9 @@ module LiteCable
     config_name :litecable
 
     attr_config :logger,
-                coder: Coders::JSON,
-                identifier_coder: Coders::Raw,
-                log_level: Logger::INFO
+      coder: Coders::JSON,
+      broadcast_adapter: :memory,
+      identifier_coder: Coders::Raw,
+      log_level: Logger::INFO
   end
 end

data/lib/lite_cable/connection/subscriptions.rb

@@ -53,9 +53,9 @@ module LiteCable
       def execute_command(data)
         command = data.delete("command")
         case command
-        when "subscribe"   then add(data["identifier"])
+        when "subscribe" then add(data["identifier"])
         when "unsubscribe" then remove(data["identifier"])
-        when "message"     then perform_action(data["identifier"], data["data"])
+        when "message" then perform_action(data["identifier"], data["data"])
         else
           raise UnknownCommandError, "Command not found #{command}"
         end

data/lib/lite_cable/server.rb

@@ -15,12 +15,6 @@ module LiteCable
 
     class << self
       attr_accessor :subscribers_map
-
-      # Broadcast encoded message to the stream
-      def broadcast(stream, message, coder: nil)
-        coder ||= LiteCable.config.coder
-        subscribers_map.broadcast stream, message, coder
-      end
     end
 
     self.subscribers_map = SubscribersMap.new

data/lib/lite_cable/server/client_socket/base.rb

@@ -17,10 +17,10 @@ module LiteCable
           @version = version
           @active = true
 
-          @open_handlers    = []
+          @open_handlers = []
           @message_handlers = []
-          @close_handlers   = []
-          @error_handlers   = []
+          @close_handlers = []
+          @error_handlers = []
 
           @close_on_error = true
         end
@@ -70,13 +70,11 @@ module LiteCable
               @open_handlers.each(&:call)
               each_frame do |data|
                 @message_handlers.each do |h|
-                  begin
-                    h.call(data)
-                  rescue => e # rubocop: disable Style/RescueStandardError
-                    log(:error, "Socket receive failed: #{e}")
-                    @error_handlers.each { |eh| eh.call(e, data) }
-                    close if close_on_error
-                  end
+                  h.call(data)
+                rescue => e # rubocop: disable Style/RescueStandardError
+                  log(:error, "Socket receive failed: #{e}")
+                  @error_handlers.each { |eh| eh.call(e, data) }
+                  close if close_on_error
                 end
               end
             ensure
@@ -137,11 +135,7 @@ module LiteCable
           framebuffer = WebSocket::Frame::Incoming::Server.new(version: version)
 
           while IO.select([socket])
-            if socket.respond_to?(:recvfrom)
-              data, _addrinfo = socket.recvfrom(2000)
-            else
-              data, _addrinfo = socket.readpartial(2000), socket.peeraddr
-            end
+            data = socket.respond_to?(:recv) ? socket.recv(2000) : socket.readpartial(2000)
             break if data.empty?
 
             framebuffer << data

data/lib/lite_cable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiteCable
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litecable
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -72,26 +72,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
@@ -150,48 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.8
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.65.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.65.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-md
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.36
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.36
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -214,35 +172,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gem_release.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- examples/sinatra/Gemfile
-- examples/sinatra/Procfile
-- examples/sinatra/README.md
-- examples/sinatra/app.rb
-- examples/sinatra/assets/app.css
-- examples/sinatra/assets/cable.js
-- examples/sinatra/assets/reset.css
-- examples/sinatra/chat.rb
-- examples/sinatra/config.ru
-- examples/sinatra/config/environment.rb
-- examples/sinatra/views/index.slim
-- examples/sinatra/views/layout.slim
-- examples/sinatra/views/login.slim
-- examples/sinatra/views/resetcss.slim
-- examples/sinatra/views/room.slim
 - lib/lite_cable.rb
 - lib/lite_cable/anycable.rb
+- lib/lite_cable/broadcast_adapters.rb
+- lib/lite_cable/broadcast_adapters/any_cable.rb
+- lib/lite_cable/broadcast_adapters/base.rb
+- lib/lite_cable/broadcast_adapters/memory.rb
 - lib/lite_cable/channel.rb
 - lib/lite_cable/channel/base.rb
 - lib/lite_cable/channel/registry.rb
@@ -268,11 +206,15 @@ files:
 - lib/lite_cable/server/subscribers_map.rb
 - lib/lite_cable/version.rb
 - lib/litecable.rb
-- litecable.gemspec
 homepage: https://github.com/palkan/litecable
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: http://github.com/palkan/litecable/issues
+  changelog_uri: https://github.com/palkan/litecable/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/palkan/litecable
+  homepage_uri: http://github.com/palkan/litecable
+  source_code_uri: http://github.com/palkan/litecable
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -281,14 +223,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Fat-free ActionCable implementation