cable_x 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76917008d7ce08585ee10c4920f94f7fea9e52fcd04f031617cc94689f7034f1
+  data.tar.gz: ea77fe44decf6ce838664e1af8a4c71680274b31fb6119c8af8c2592c1692f59
+SHA512:
+  metadata.gz: 6bcec2f189429bc13d423c35b67cc496f4d40894439a1c81ac5fe437ea1c94909d9665f811ddc6298e4e4fb316985bce15494fe96fe9cc340f5e4208cb7d490e
+  data.tar.gz: 1ed2df1944dc39fadee3ded7de04f489574e54e7d82d8c252a883065aae964dbaa37dec34b7c1a6d7792d7e44ad9c2c9fbd5113f54d7b5059b7d0bc0efaa499c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Nitesh Purohit
+
+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,28 @@
+# CableX
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cable_x'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cable_x
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,24 @@
+# frozen_string_literal: true
+
+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    = 'CableX'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/lib/cable_x.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'action_cable'
+require 'rails'
+require_relative 'cable_x/engine'
+require_relative 'cable_x/server'
+require_relative 'cable_x/version'
+require_relative 'cable_x/channel/cable_x_channel'
+module CableX
+  class Error < StandardError; end
+end

data/lib/cable_x/cable/channel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CableX
+  module Cable
+    # Channel for realtime updates
+    class Channel < ActionCable::Channel::Base
+    end
+  end
+end

data/lib/cable_x/cable/connection.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CableX
+  module Cable
+    ##
+    # Connection class to serve entry point
+    class Connection < ActionCable::Connection::Base
+      attr_accessor :device_id
+      identified_by :device_id
+
+      def connect
+        self.device_id = SecureRandom.hex(20)
+      end
+    end
+  end
+end

data/lib/cable_x/channel/cable_x_channel.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../cable/channel'
+require_relative './process/controller'
+require_relative './process/request'
+require_relative './process/response'
+module CableX
+  module Channel
+    ##
+    # CableXChannel class to serve subscription, and cmd execution
+    class CableXChannel < Cable::Channel
+      include Channel::Process::Controller
+      include Channel::Process::Request
+      include Channel::Process::Response
+
+      attr_reader :data, :request, :response, :controller_action_hash, :ctrl, :request_id, :response_body
+
+      def subscribed
+        reject unless device_id.present?
+        stream_from device_id
+      end
+
+      def unsubscribed; end
+
+      def cmd(data)
+        @data = data
+        invoke_controller
+        prepare_response
+        transmit response_body, via: device_id
+      end
+    end
+  end
+end

data/lib/cable_x/channel/process/controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CableX
+  module Channel
+    module Process
+      ##
+      # Process controller specific tasks
+      module Controller
+        def set_controller
+          set_controller_hash
+        end
+
+        def invoke_controller
+          set_controller
+          set_request
+          set_response
+          controller_klass.dispatch(controller_action_hash[:action], request, response)
+        end
+
+        def set_controller_hash
+          @controller_action_hash = Rails.application.routes.recognize_path data['path'], { method: data['method'] }
+        end
+
+        def controller_klass
+          controller_klass_name = controller_action_hash[:controller].split('/').map(&:camelize).join('::')
+          "#{controller_klass_name}Controller".constantize
+        end
+      end
+    end
+  end
+end

data/lib/cable_x/channel/process/request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CableX
+  module Channel
+    module Process
+      ##
+      # Process request specific tasks
+      module Request
+        def set_request
+          @request_id = data['request_id']
+          @request = ActionDispatch::Request.new({})
+          @request.headers = data['headers'] if data['headers']
+          @request.request_parameters = controller_action_hash.merge(data['params'] || {}).merge(data['data'] || {})
+          @request.request_method = data['method'].upcase
+        end
+      end
+    end
+  end
+end

data/lib/cable_x/channel/process/response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CableX
+  module Channel
+    module Process
+      ##
+      # Process response specific tasks
+      module Response
+        def set_response
+          @response = ActionDispatch::Response.new
+        end
+
+        def prepare_response
+          @response_body = { request_id: request_id, body: response.body, code: response.code, headers: response.headers.to_h }
+        end
+      end
+    end
+  end
+end

data/lib/cable_x/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/rails'
+require_relative 'server'
+require_relative 'cable/connection'
+module CableX
+  ##
+  # CableX Engine
+  class Engine < ::Rails::Engine
+    attr_accessor :allowed_request_origins
+    isolate_namespace CableX
+
+    def self.server
+      config = Rails.application.config_for(:cable_x) rescue nil
+      self.allowed_request_origins = config[:allowed_request_origins] if config
+      server = CableX::Server.server
+      server.config.connection_class = -> { CableX::Cable::Connection }
+      server.config.allowed_request_origins = allowed_request_origins
+      server
+    end
+  end
+end

data/lib/cable_x/server.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CableX
+  ##
+  # CableX ActionCable server module
+  module Server
+    extend ActionCable
+
+    def self.server
+      @server ||= ActionCable::Server::Base.new
+    end
+  end
+end

data/lib/cable_x/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CableX
+  VERSION = '0.1.0'
+end

data/lib/generators/cable_x/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/cable_x/install/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CableX
+  ##
+  # Install generator
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_install_file
+      route('mount CableX::Engine.server => "/cable_x"')
+      template 'cable_x_yml.rb.tt', File.join('config', 'cable_x.yml')
+    end
+  end
+end

data/lib/generators/cable_x/install/templates/cable_x_yml.rb.tt

@@ -0,0 +1,10 @@
+###
+# Set origins appropriately, is follows standard action cable format for allowed_request_origins
+###
+production:
+  ##TODO edit me
+  allowed_request_origins: <%= ENV.fetch("CABLE_X_ALLOWED_REQUEST_ORIGINS") { "http://127.0.0.1:3000/cable_x" } %>
+development:
+  allowed_request_origins: <%= ENV.fetch("CABLE_X_ALLOWED_REQUEST_ORIGINS") { "http://127.0.0.1:3000/cable_x" } %>
+test:
+  allowed_request_origins: <%= ENV.fetch("CABLE_X_ALLOWED_REQUEST_ORIGINS") { "http://127.0.0.1:3000/cable_x" } %>

data/lib/tasks/cable_x_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :cable_x do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: cable_x
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nitesh Purohit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.23
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Standard MVC over cable for realtime applications to enjoy seamless experience
+  over cable. Use specialized clients for Android, IOS, Angular, React, JS
+email:
+- nitesh.purohit.it@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/cable_x.rb
+- lib/cable_x/cable/channel.rb
+- lib/cable_x/cable/connection.rb
+- lib/cable_x/channel/cable_x_channel.rb
+- lib/cable_x/channel/process/controller.rb
+- lib/cable_x/channel/process/request.rb
+- lib/cable_x/channel/process/response.rb
+- lib/cable_x/engine.rb
+- lib/cable_x/server.rb
+- lib/cable_x/version.rb
+- lib/generators/cable_x/install/USAGE
+- lib/generators/cable_x/install/install_generator.rb
+- lib/generators/cable_x/install/templates/cable_x_yml.rb.tt
+- lib/tasks/cable_x_tasks.rake
+homepage: https://github.com/Code-Vedas/rails-cable-x
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Code-Vedas/rails-cable-x
+  source_code_uri: https://github.com/Code-Vedas/rails-cable-x
+  changelog_uri: https://github.com/Code-Vedas/rails-cable-x
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Standard MVC over cable for realtime applications to enjoy seamless experience
+  over cable
+test_files: []