pushable 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,73 @@
+# Pushable
+
+[Ah, push it, pu-pu-push it real good!](http://www.youtube.com/watch?v=vCadcBR95oU)
+
+![Salt-n-Pepper](http://1.bp.blogspot.com/_1e1s_bYTxyE/TEZUEini5hI/AAAAAAAABIc/QzKyLsLJCOs/s1600/Salt-n-Pepa_l.jpg)
+
+Push changes in your ActiveModels to Backbone.js clients' models and collections.
+
+Overview
+--------
+
+At this point there are three ActiveModel events that can be pushed out to the Faye server, creation, updat-uhh-ion, and deletion. They can pushed to two channels, collection channels and instance channels. For example if you had a family model and it has_many member models you might have a Backbone family collection, when a new member was born, you're family Backbone collection would be notified via the collection channel, but other families don't need to be notified of the new member. So you can scope a model's collection channel by defining a collection_channel method in both the ActiveModel and the Backbone collection. Similarly you could customize the instance channel used with instance_channel methods. As usual the code speaks for itself:
+
+  class Family < ActiveRecord::Base
+    attr_accessible :name
+    has_many :members
+  end
+
+  class Member < ActiveRecord::Base
+    attr_accessible :name, :family_id
+    belongs_to :family
+
+    push :create  => :collections,
+         :update  => [ :collections, :instances ],
+         :destroy => [ :collections, :instances ]
+
+    def collection_channel
+      "family_#{family_id}_members"
+    end
+  end
+
+  class Family extends Backbone.PushableCollection
+    channel: -> "family_#{@id}_members"
+
+    url: ->
+      if @id
+        '/families/' + @id + '/members.json'
+
+    model: Member
+
+    initialize: (members, options) -> # members is actually options if not initialized with members
+      try
+        @id = (members || options).id
+      catch TypeError
+        throw "MissingFamilyID"
+      super()
+
+  class Member extends Backbone.PushableModel
+    url: ->
+      if @isNew()
+        "/families/#{@family_id}/members.json"
+      else
+        "/members/#{@id}.json"
+
+    channel: -> "member_#{@id}"
+
+Starting the Faye Server
+------------------------
+Start a Faye server instance with...
+
+  rake faye:start
+
+This rake task supports the following options:
+ * `verbose=true`
+ * `port=9292` 9292 is the default
+ * `key=server.key` For an SSL key
+ * `cert=server.crt` For an SSL certificate
+
+Todo
+----
+
+ * Write some specs
+ * Flesh the docs out more, an example app even

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pushable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+task :default => :test

data/lib/pushable.rb

@@ -0,0 +1,66 @@
+require 'net/http'
+
+module Pushable
+  require 'pushable/railtie' if defined?(Rails)
+
+  extend ActiveSupport::Concern
+
+  included do
+    after_create  :push_create
+    after_update  :push_update
+    after_destroy :push_destroy
+  end
+
+  [:create, :update, :destroy].each do |event|
+    define_method "push_#{event.to_s}" do
+      Array.wrap(self.class.pushes[event]).each do |channel|
+        ActionPusher.new.push event, evaluate(channel), self
+      end
+    end
+  end
+
+  def collection_channel
+    self.class.name.underscore.pluralize
+  end
+
+  def instance_channel
+    "#{self.class.name.underscore}_#{id}"
+  end
+
+  def evaluate(channel)
+    case channel
+    when :collections
+      collection_channel
+    when :instances
+      instance_channel
+    when Symbol #references association
+      associate = send(channel)
+      "#{associate.class.name.underscore}_#{associate.id}_#{self.class.name.underscore.pluralize}"
+    when String
+      eval '"' + channel + '"'
+    when Proc
+      evaluate channel.call(self)
+    end
+  end
+
+  module ClassMethods
+    attr_accessor :pushes
+
+    def pushable
+      @pushes = { create: :collections,
+                  update: [ :collections, :instances ],
+                 destroy: [ :collections, :instances ] } #default events and channels
+    end
+
+    def push(options={})
+      @pushes = options
+    end
+  end
+
+  module Rails
+    module Faye
+      mattr_accessor :address
+      self.address = 'http://localhost:9292'
+    end
+  end
+end

data/lib/pushable/action_pusher.rb

@@ -0,0 +1,47 @@
+class ActionPusher < AbstractController::Base
+  include AbstractController::Rendering
+  include AbstractController::Helpers
+  include AbstractController::Translation
+  include AbstractController::AssetPaths
+  include Rails.application.routes.url_helpers
+  helper ApplicationHelper
+  include ApplicationHelper
+  self.view_paths = "app/views"
+
+  NET_HTTP_EXCEPTIONS = [Timeout::Error, Errno::ETIMEDOUT, Errno::EINVAL,
+                         Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError,
+                         Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+                         Net::ProtocolError]
+
+
+  def push(event, channel, object)
+    url = URI.parse("#{Pushable::Rails::Faye.address}/faye")
+    req = Net::HTTP::Post.new(url.path)
+
+    req.form_data = { message: { channel: "/sync/#{channel}",
+                                    data: { object: render_for_push(object),
+                                             event: event } }.to_json }
+    req.basic_auth url.user, url.password if url.user
+
+    http = Net::HTTP.new(url.host, url.port)
+    if url.scheme == "https"
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    http.start do |https|
+      https.request(req)
+    end
+  rescue *NET_HTTP_EXCEPTIONS => exception
+    ::Rails.logger.error("")
+    ::Rails.logger.error("ActionPusher encountered an exception:")
+    ::Rails.logger.error(exception.class.name)
+    ::Rails.logger.error(exception.message)
+    ::Rails.logger.error(exception.backtrace.join("\n"))
+    ::Rails.logger.error("")
+  end
+
+  def render_for_push(object)
+    render_to_hash(partial: "#{object.class.name.underscore.pluralize}/#{object.class.name.underscore}", object: object)
+  end
+end

data/lib/pushable/acts_as_pushable.rb

@@ -0,0 +1,70 @@
+require 'net/http'
+
+module Pushable
+  module ActsAsPushable
+    extend ActiveSupport::Concern
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    included do
+      after_create  :push_create
+      after_update  :push_update
+      after_destroy :push_destroy
+    end
+
+    [:create, :update, :destroy].each do |event|
+      define_method "push_#{event.to_s}" do
+        Array.wrap(self.class.pushes[event]).each do |channel|
+          ActionPusher.new.push event, evaluate(channel), self
+        end
+      end
+    end
+
+    def collection_channel
+      self.class.name.underscore.pluralize
+    end
+
+    def instance_channel
+      "#{self.class.name.underscore}_#{id}"
+    end
+
+    def evaluate(channel)
+      case channel
+      when :collections
+        collection_channel
+      when :instances
+        instance_channel
+      when Symbol #references association
+        associate = send(channel)
+        "#{associate.class.name.underscore}_#{associate.id}_#{self.class.name.underscore.pluralize}"
+      when String
+        eval '"' + channel + '"'
+      when Proc
+        evaluate channel.call(self)
+      end
+    end
+
+    module ClassMethods
+      def push(options={})
+        @pushes = options
+      end
+
+      def pushes
+        @pushes ||= { create: :collections,
+                      update: [ :collections, :instances ],
+                     destroy: :collections } #default events and channels
+      end
+    end
+
+    module Rails
+      module Faye
+        mattr_accessor :address
+        self.address = 'https://localhost:9292'
+      end
+    end
+  end
+end
+
+ActiveModel::Base.send :include, Pushable::ActsAsPushable

data/lib/pushable/railtie.rb

@@ -0,0 +1,12 @@
+require 'pushable'
+require 'rails'
+
+module Pushable
+  class Railtie < Rails::Railtie
+    railtie_name :pushable
+
+    rake_tasks do
+      load "tasks/faye.rake"
+    end
+  end
+end

data/lib/pushable/version.rb

@@ -0,0 +1,3 @@
+module Pushable
+  VERSION = "0.0.1"
+end

data/lib/tasks/faye.rake

@@ -0,0 +1,20 @@
+namespace "faye" do
+  desc "Start the Faye server"
+  task :start do
+    require 'faye'
+
+    if ENV['verbose']
+      Faye::Logging.log_level = :info
+      Faye.logger = lambda { |m| puts m }
+    end
+
+    bayeux = Faye::RackAdapter.new :mount => '/faye', :timeout => 25
+
+    port = ENV['port'] || 9292
+    if ENV['key'] and ENV['cert']
+      bayeux.listen port, :key => ENV['key'], :cert => ENV['cert']
+    else
+      bayeux.listen port
+    end
+  end
+end

data/lib/tasks/pushable_tasks.rake

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

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: pushable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bill Transue
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 2
+        - 12
+        version: 3.2.12
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faye
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thin
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: debugger
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+description: Push ActiveModel changes to Backbone Collections and Models though a Faye Pub/Sub server.
+email: 
+- transue@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/pushable/action_pusher.rb
+- lib/pushable/acts_as_pushable.rb
+- lib/pushable/railtie.rb
+- lib/pushable/version.rb
+- lib/pushable.rb
+- lib/tasks/faye.rake
+- lib/tasks/pushable_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: https://github.com/billy-ran-away/pushable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ah, push it pu-pu-push it real good. Your ActiveModels' changes to Backbone.js clients that is.
+test_files: []
+