pinkman 0.9.9.9.9 → 0.9.9.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52f046bfc67c43eb0162e23062de3c6a286f1c740ce0e7cb7e3eb0d67a43646a
-  data.tar.gz: b952d2a6962e886eee3186d3a71cebaa5e6a728c5afb0ada3abf4d61b81774b7
+  metadata.gz: 2578f7ed00a7dbdeb84024113b941e578ce5df966cb3835637879aca2adaae1e
+  data.tar.gz: c04a023cf880c0ff3e4618fb778330f2da7f141a06703bb69d3c0ef1a05512a1
 SHA512:
-  metadata.gz: 04e12687c844dea1204df405065ddfb286b1a98527fe1c42e07bdc3294b8934088d588e1e4d421507a309ceacef7065243dc00a15ea6234a3f3eafce6de87f6b
-  data.tar.gz: ce64f0726d92c4d267ac876729a7e44c824d778bb1cc0b1e7a1ba6c8777d32d2ac475e17b581fbf6a03d4918150a7e0a850cb507015e472988d35596d2d5a452
+  metadata.gz: 88f823fd6b206c0bf6027f3cc2ce89deb8da96f7e3d413d5039eb5e20b33c2fc5197d3c00a4b3040414cbbf3ed5a1b9dc99d1dcb7637818d3408eef46e937f63
+  data.tar.gz: 014dcc79ec52d9fd9ee2b1a9b5bdb01389c182c853224409a6160aeffacc53001e93b7475eac6a9b4d3c8b685f7fafcd41c923a32f600c114689a053aea1d2d9

data/app/assets/javascripts/pinkman_base/controller.coffee

@@ -291,7 +291,9 @@ class window.PinkmanController extends window.PinkmanObject
       throw 'Callback not found.'
     params = if (typeof opt == 'object' and opt['params']?) then opt['params'] else new Object
     params.channel = channel
-    params.room = opt.room if $p.isObject(opt) and opt.room?
+    if $p.isObject(opt)
+      params.room = opt.room if opt.room?
+      params.filter_by = (opt.filter_by or opt.filterBy ) if (opt.filterBy? or opt.filter_by?)
     Pinkman.cable.subscriptions.create params, received: callback
     
   scrolling: (callback) -> 

data/app/channels/pinkman_channel.rb

@@ -0,0 +1,48 @@
+require 'pinkman/broadcaster'
+
+class PinkmanChannel < ActionCable::Channel::Base
+  
+  def self.model 
+    @model || self.to_s.gsub('Channel','').constantize
+  end
+  
+  def self.model= model
+    @model = model
+  end
+  
+  def self.rooms
+    @rooms ||= []
+  end
+  
+  def self.broadcast scope
+    broadcasting = Pinkman::Broadcaster.new(scope: scope, model: model)
+    if block_given?
+      yield(broadcasting)
+      if broadcasting.save
+        broadcasting
+      else
+        raise "Pinkman: Error trying to broadcasting to #{broadcasting.room}."
+      end
+    else
+      raise 'PinkmanChannel.broadcast: no block given'
+    end
+  end
+  
+  def model
+    self.class.model
+  end
+  
+  def subscribed
+    stream
+  end
+  
+  def unsubscribed
+    stop_all_streams
+  end
+  
+  def stream
+    Pinkman::Broadcaster.stream(self,current_scope,params)
+  end
+
+
+end

data/lib/generators/pinkman/channel_generator.rb

@@ -16,13 +16,18 @@ module Pinkman
       class_name.camelize
     end
     
+    def room_name
+      model_name.tableize
+    end
+    
     def channel_name
       model_name + 'Channel'
     end
 
     def file_name
       class_name.underscore + "_channel.rb"
-    end 
+    end
+    alias filename file_name 
     
   end
 end

data/lib/generators/pinkman/templates/channel.rb.erb

@@ -1,10 +1,45 @@
 class <%= channel_name %> < PinkmanChannel
   
-  def subscribed
-    stream_from(room) if <%= model_name %>.allow_streaming?(room,scope)
-  end
-
-  def unsubscribed
+  # TO DO: use connection/params to determine the current scope
+  def current_scope
+    :public
   end
   
+  # broadcast :public do |config|
+  #   config.room :<%= room_name %>
+  # end
+  
+  # --- Quick Broadcast Guide
+  
+  # Start a broadcast here to transmit <%= model_name %>.
+  
+  # Who consumes the transmission?
+  # Everyone that subscribes to <%= channel_name %> and have a current_scope that is broadcasting something.
+  
+  # What gets broadcasted?
+  # Every instance of <%= model_name %> that gets created, updated or destroyed 
+  # is broadcasted as json of the passed scope.
+  
+  # Optionally, you can use filter_by to restrict 
+  # the transmission to a particular group of records.
+  
+  # --- Usage
+  
+  # -- js/coffe - client:
+  #  App.controller 'any-controller', ->
+  #    @main = ->
+  #      
+  #      @subscribe '<%= channel_name %>',
+  #        room: '<%= room_name %>'
+  #        filter_by: 123
+  
+  # -- ruby / server: here (<%= filename %>)
+  #  broadcast :public do |config|
+  #    config.room :<%= room_name %>
+  #    
+  #    config.filter_by :attribute
+  #    # Only records that got `attribute == 123` will be broadcasted.
+  #  
+  #  end
+  
 end

data/lib/pinkman/broadcaster.rb

@@ -0,0 +1,119 @@
+require 'digest'
+
+class Pinkman::Broadcaster
+  
+  include ActiveModel::Validations
+  
+  attr_accessor :model, :scope, :record
+  validates :model, :room, :scope, presence: true
+    
+    
+  def initialize options
+    self.scope = options[:scope]
+    self.model = options[:model]
+    true  
+  end
+  
+  def self.broadcasters
+    @broadcasters ||= {}
+  end 
+  
+  def self.broadcast room, scope, action, record
+    ActionCable.server.broadcast(room_name_from_record(room,record), {action: action, data: record.json_hash(scope)})
+  end
+  
+  def self.stream channel, scope, params
+    if params[:room].present?
+      broadcaster = broadcasters[params[:room].to_sym]
+      if broadcaster.present? and broadcaster.scope == scope
+        channel.stream_from(room_name_from_params(broadcaster,params))
+      else
+        raise "Insuficient permissions or room '#{params[:room]}' not found."
+      end
+    else
+      raise 'Room not specified through client.'
+    end
+  end
+  
+  def self.room_name_from_params broadcaster, params
+    if params[:filter_by].is_a? String
+      broadcaster.encrypt(broadcaster.room,params[:filter_by])
+    elsif params[:filter_by].is_a? Array
+      broadcaster.encrypt(broadcaster.room, params[:filter_by].join(' '))
+    else
+      broadcaster.room
+    end
+  end
+  
+  def self.room_name_from_record room_name, record
+    broadcaster = broadcasters[room_name.to_sym]
+    if broadcaster
+      broadcaster.room_name(record)
+    else
+      raise "#{room_name} not found/declared"
+    end
+  end
+  
+  def room room_name=nil
+    if room_name.present?
+      @room = room_name
+    else
+      @room
+    end
+  end
+  
+  def filter_by *args
+    if args.any?
+      @filter_by = args
+    else
+      @filter_by ||= []
+    end
+  end
+  
+  def save
+    valid? and (self.class.broadcasters[room.to_sym] = self) and set_callbacks
+  end
+  
+  def get_record params
+    if filter_by.any? and params[:filter_by].present?
+      where_hash = {}
+      filter_by.each_with_index {|attribute,i| where_hash[attribute] = params[:filter_by][i] }
+      model.where(where_hash).first if model.where(where_hash).any?
+    end
+  end
+  
+  def encrypt_room_name(record)
+    passphrase = filter_by.map { |attribute| record.send(attribute) }.join(' ')
+    encrypt(room,passphrase)
+  end
+  
+  def encrypt room_name, passphrase
+    md5(room_name.to_s + 'pinkroom' + passphrase)
+  end
+  
+  def room_name(record=nil)
+    (record.present? and filter_by.any?) ? encrypt_room_name(record) : room
+  end
+  
+  def md5 val
+    Digest::MD5.hexdigest(val) 
+  end
+  
+  def set_callbacks
+    if valid?
+      ['create','update','destroy'].each do |action|
+        current_room = room
+        current_scope = scope
+        method_name = "broadcast_#{action}_to_#{room}".to_sym
+        unless model.instance_methods.include?(method_name)
+          model.define_method method_name do
+            Pinkman::Broadcaster.broadcast(current_room, current_scope, action, self)
+          end  
+          model.send("after_#{action}".to_sym, method_name)
+        end
+      end
+      true
+    end
+  end
+  
+end

data/lib/pinkman/version.rb

@@ -1,3 +1,3 @@
 module Pinkman
-  VERSION = "0.9.9.9.9"
+  VERSION = "0.9.9.9.10"
 end

data/lib/pinkman.rb

@@ -5,6 +5,7 @@ require 'pinkman/serializer'
 require 'pinkman/views_helpers'
 require 'pinkman/form_helper'
 require 'pinkman/version'
+require 'pinkman/broadcaster'
 
 module Pinkman
 
@@ -39,23 +40,6 @@ module Pinkman
       # Extending ActiveRecord
       ActiveRecord::Base.singleton_class.class_eval do 
         
-        # Real time
-        def broadcast_to room, scope
-          @broadcasting_to ||= {}
-          @broadcasting_to[room] = scope
-          ['create','update','destroy'].each do |action|
-            send("after_#{action}".to_sym, "broadcast_#{action}_#{room}".to_sym)
-            define_method "broadcast_#{action}_#{room}" do
-              ActionCable.server.broadcast room, {action: action, data: json_hash(scope)}
-            end  
-          end
-        end
-        
-        def allow_streaming? room, scope
-          @broadcasting_to.is_a?(Hash) and @broadcasting_to[room] == scope
-        end
-    
-        
         # Serializer
         def serializer= value
           @serializer = value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinkman
 version: !ruby/object:Gem::Version
-  version: 0.9.9.9.9
+  version: 0.9.9.9.10
 platform: ruby
 authors:
 - Agilso Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -222,6 +222,7 @@ files:
 - app/assets/stylesheets/pinkman/sector.scss
 - app/assets/stylesheets/pinkman/tables.scss
 - app/assets/stylesheets/pinkman/typo.scss
+- app/channels/pinkman_channel.rb
 - app/controllers/pinkman/pinkman_controller.rb
 - app/helpers/pinkman/pinkman_helper.rb
 - app/views/pinkman/_error_for.html.slim
@@ -242,7 +243,6 @@ files:
 - lib/generators/pinkman/install_generator.rb
 - lib/generators/pinkman/model_generator.rb
 - lib/generators/pinkman/page_generator.rb
-- lib/generators/pinkman/pinkman_channel_generator.rb
 - lib/generators/pinkman/resource_generator.rb
 - lib/generators/pinkman/route_generator.rb
 - lib/generators/pinkman/route_resource_generator.rb
@@ -267,10 +267,10 @@ files:
 - lib/generators/pinkman/templates/pink_template.html.erb.erb
 - lib/generators/pinkman/templates/pink_template.html.haml.erb
 - lib/generators/pinkman/templates/pink_template.html.slim.erb
-- lib/generators/pinkman/templates/pinkman_channel.rb
 - lib/generators/pinkman/templates/serializer.rb.erb
 - lib/pinkman.rb
 - lib/pinkman/base_helper.rb
+- lib/pinkman/broadcaster.rb
 - lib/pinkman/form_helper.rb
 - lib/pinkman/form_helper/form_helpers.rb
 - lib/pinkman/serializer.rb

data/lib/generators/pinkman/pinkman_channel_generator.rb

@@ -1,12 +0,0 @@
-require 'rails/generators/base'
-
-module Pinkman
-  class PinkmanChannelGenerator < ::Rails::Generators::Base
-    source_root File.expand_path('../templates', __FILE__)
-
-    def copy_pinkman_channel_file
-      template "pinkman_channel.rb", "app/channels/pinkman_channel.rb"
-    end
-
-  end
-end

data/lib/generators/pinkman/templates/pinkman_channel.rb

@@ -1,16 +0,0 @@
-class PinkmanChannel < ApplicationCable::Channel
-  
-  # TO DO
-  def scope
-    :public
-  end
-  
-  def room
-    if params[:room].present?
-      params[:room].to_sym
-    else
-      raise ArgumentError, 'Pinkman: Room not specified.'
-    end
-  end
-  
-end