action_cable_notifications 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3208ee7a8df2cd087f3ef9067fca4da783ef9afe
+  data.tar.gz: 15d6a3138c7d6aa2b4b2cebdd1b54673ac51616c
+SHA512:
+  metadata.gz: 2ecb8ca921ea58baddd3452a51aa3243fdfb8c20ecf3760f5a9c003ab9f782bf335240d0c89a464894e0f540f83b89eaeedd91a848065167ede83acbdd0cfdda
+  data.tar.gz: a02c1d61f271a7f1402f21e24bd8ac45893df76ca944d17ef4ca733b22ab0ce944a1ea652e9569691450d9b02d6d370259ee15fd13ee7eb45a89286312c1aaa8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Guillermo Bisheimer
+
+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,47 @@
+# ActionCableNotifications
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_cable_notifications'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install action_cable_notifications
+```
+
+## Usage
+Create a new channel (`rails g cahnnel Test`) or modify existing one including `ActionCableNotifications::Streams` module. 
+
+```ruby
+class TestChannel < ApplicationCable::Channel
+
+  include ActionCableNotifications::Streams
+
+  def subscribed
+    stream_for model, include_initial: true
+  end
+
+  def unsubscribed
+    # Any cleanup needed when channel is unsubscribed
+  end
+end
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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    = 'ActionCableNotifications'
+  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/assets/config/action_cable_notifications_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/action_cable_notifications .js
+//= link_directory ../stylesheets/action_cable_notifications .css

data/app/assets/javascripts/action_cable_notifications/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/action_cable_notifications/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/action_cable_notifications/application_controller.rb

@@ -0,0 +1,5 @@
+module ActionCableNotifications
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/action_cable_notifications/application_helper.rb

@@ -0,0 +1,4 @@
+module ActionCableNotifications
+  module ApplicationHelper
+  end
+end

data/app/jobs/action_cable_notifications/application_job.rb

@@ -0,0 +1,4 @@
+module ActionCableNotifications
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/action_cable_notifications/application_mailer.rb

@@ -0,0 +1,6 @@
+module ActionCableNotifications
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/action_cable_notifications/application_record.rb

@@ -0,0 +1,5 @@
+module ActionCableNotifications
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/action_cable_notifications/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Action cable notifications</title>
+  <%= stylesheet_link_tag    "action_cable_notifications/application", media: "all" %>
+  <%= javascript_include_tag "action_cable_notifications/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActionCableNotifications::Engine.routes.draw do
+end

data/lib/action_cable_notifications.rb

@@ -0,0 +1,5 @@
+require "action_cable_notifications/engine"
+
+module ActionCableNotifications
+  # Your code goes here...
+end

data/lib/action_cable_notifications/callbacks.rb

@@ -0,0 +1,50 @@
+module ActionCableNotifications
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      after_update :notify_update
+      after_create :notify_create
+      after_destroy :notify_destroy
+    end
+
+    module ClassMethods
+      def notify_initial( collection=nil )
+        collection ||= self
+        data = {
+          collection: self.model_name.collection,
+          msg: 'add',
+          data: collection.all
+        }
+      end
+    end
+
+    def notify_create
+      ActionCable.server.broadcast self.model_name.collection,
+        collection: self.model_name.collection,
+        msg: 'create',
+        id: self.id,
+        fields: self
+    end
+
+    def notify_update
+      changes = {}
+      self.changes.each do |k,v|
+        changes[k] = v[1]
+      end
+
+      ActionCable.server.broadcast self.model_name.collection,
+        collection: self.model_name.collection,
+        msg: 'update',
+        id: self.id,
+        fields: changes
+    end
+
+    def notify_destroy
+      ActionCable.server.broadcast self.model_name.collection,
+        collection: self.model_name.collection,
+        msg: 'destroy',
+        id: self.id
+    end
+  end
+end

data/lib/action_cable_notifications/engine.rb

@@ -0,0 +1,8 @@
+require 'action_cable_notifications/callbacks.rb'
+require 'action_cable_notifications/streams.rb'
+
+module ActionCableNotifications
+  class Engine < ::Rails::Engine
+    isolate_namespace ActionCableNotifications
+  end
+end

data/lib/action_cable_notifications/streams.rb

@@ -0,0 +1,34 @@
+module ActionCableNotifications
+  module Streams
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :ActionCableNotificationsOptions
+      self.ActionCableNotificationsOptions = {}
+    end
+
+    private
+
+    def stream_for(model, options = {})
+
+      # Original behaviour
+      if options.is_a? Proc
+        super(model, options)
+      else
+
+        # Checks if model already includes notification callbacks
+        if !model.respond_to? :notify_initial
+          model.send('include', ActionCableNotifications::Callbacks)
+        end
+
+        super(model, options[:callback])
+
+        # Transmit initial state if required
+        if options[:include_initial].present?
+          transmit model.notify_initial
+        end
+      end
+    end
+
+  end
+end

data/lib/action_cable_notifications/version.rb

@@ -0,0 +1,3 @@
+module ActionCableNotifications
+  VERSION = '0.1.2'
+end

data/lib/tasks/action_cable_notifications_tasks.rake

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: action_cable_notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- ByS Sistemas de Control
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-29 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
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !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: Rails engine that provides automatic notification broadcasts for Ruby
+  on Rails models changes using Action Cable and websockets
+email:
+- info@bys-control.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/action_cable_notifications_manifest.js
+- app/assets/javascripts/action_cable_notifications/application.js
+- app/assets/stylesheets/action_cable_notifications/application.css
+- app/controllers/action_cable_notifications/application_controller.rb
+- app/helpers/action_cable_notifications/application_helper.rb
+- app/jobs/action_cable_notifications/application_job.rb
+- app/mailers/action_cable_notifications/application_mailer.rb
+- app/models/action_cable_notifications/application_record.rb
+- app/views/layouts/action_cable_notifications/application.html.erb
+- config/routes.rb
+- lib/action_cable_notifications.rb
+- lib/action_cable_notifications/callbacks.rb
+- lib/action_cable_notifications/engine.rb
+- lib/action_cable_notifications/streams.rb
+- lib/action_cable_notifications/version.rb
+- lib/tasks/action_cable_notifications_tasks.rake
+homepage: https://github.com/bys-control/action_cable_notifications
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Realtime notification broadcast for Ruby on Rails models changes using Action
+  Cable and websockets
+test_files: []