pusherable 1.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pusherable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tony Coconate
+
+MIT License
+
+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,46 @@
+# Pusherable
+
+Adds callback hooks for your ActiveRecord models for sending messages to a Pusher channel.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pusherable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pusherable
+
+## Usage
+
+Add in the following lines to any ActiveRecord model class:
+
+    pusherable(YOUR_CHANNEL)
+
+On your subscribed client(s), events will be triggered by Pusher reflecting your ActiveRecord create/update/destroy actions.
+
+### Example
+
+If you have a model called, __Story__, and you create a new record, Pusher will receive an event called, "story.create".
+It will also carry a payload of data containing the __model_id__
+
+Here is a list of the ActiveRecord callbacks that trigger Pusher events...
+
+```
+"model.create" => after_create
+"model.update" => after_update
+"model.destroy" => before_destroy
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+desc 'Default: run specs'
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/pusherable/version.rb

@@ -0,0 +1,3 @@
+module Pusherable
+  VERSION = '1.0.1'
+end

data/lib/pusherable.rb

@@ -0,0 +1,44 @@
+require 'pusherable/version'
+
+module Pusherable
+  def pusherable?
+    false
+  end
+
+  def pusherable(pusherable_channel='test_channel')
+    class_attribute :pusherable_channel
+    self.pusherable_channel = pusherable_channel
+
+    class_eval do
+      after_create :pusherable_trigger_create
+      after_update :pusherable_trigger_update
+      before_destroy :pusherable_trigger_destroy
+
+      def self.pusherable?
+        true
+      end
+
+      private
+
+      def pusherable_class_name
+        self.class.name.underscore
+      end
+
+      def pusherable_trigger_create
+        Pusher.trigger(pusherable_channel, "#{pusherable_class_name}.create", { model_id: self.id })
+      end
+
+      def pusherable_trigger_update
+        Pusher.trigger(pusherable_channel, "#{pusherable_class_name}.update", { model_id: self.id })
+      end
+
+      def pusherable_trigger_destroy
+        Pusher.trigger(pusherable_channel, "#{pusherable_class_name}.destroy", { model_id: self.id })
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend Pusherable
+end

data/pusherable.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pusherable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'pusherable'
+  gem.version       = Pusherable::VERSION
+  gem.authors       = ['Tony Coconate']
+  gem.email         = ['me@tonycoconate.com']
+  gem.description   = %q{Adds callback hooks for your ActiveRecord models for sending messages to a Pusher channel.}
+  gem.summary       = %q{Adds callback hooks for your ActiveRecord models for sending messages to a Pusher channel.}
+  gem.homepage      = 'https://github.com/tonycoco/pusherable'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'activerecord', '~> 3.2.0'
+  gem.add_development_dependency 'pusher', '~> 0.11.0'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'acts_as_fu'
+  gem.add_development_dependency 'database_cleaner'
+end

data/spec/pusherable_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Pusherable do
+  describe 'setup' do
+    it 'should make ActiveRecord models pusherable' do
+      NonPusherableModel.pusherable?.should == false
+      PusherableModel.pusherable?.should == true
+    end
+
+    it 'should set the channel to push to' do
+      DefaultedPusherableModel.pusherable_channel.should == 'test_channel'
+      PusherableModel.pusherable_channel.should == 'our_channel'
+
+      default_model = DefaultedPusherableModel.new
+      setup_model = PusherableModel.new
+
+      default_model.pusherable_channel.should == 'test_channel'
+      setup_model.pusherable_channel.should == 'our_channel'
+    end
+  end
+
+  describe 'callbacks' do
+    before(:each) do
+      @pusherable_model = PusherableModel.new
+      @non_pusherable_model = NonPusherableModel.new
+      Pusher.stub(:trigger).and_return true
+    end
+
+    it 'should trigger after create' do
+      @pusherable_model.should_receive(:pusherable_trigger_create).once
+      @pusherable_model.save
+    end
+
+    it 'should trigger after update' do
+      @pusherable_model.should_receive(:pusherable_trigger_create).once
+      @pusherable_model.save
+      @pusherable_model.should_receive(:pusherable_trigger_update).once
+      @pusherable_model.save!
+    end
+
+    it 'should trigger after update' do
+      @pusherable_model.should_receive(:pusherable_trigger_create).once
+      @pusherable_model.save
+      @pusherable_model.should_receive(:pusherable_trigger_destroy).once
+      @pusherable_model.destroy
+    end
+
+    it 'should not trigger events on a regular ActiveRecord model' do
+      @non_pusherable_model.should_not_receive(:pusherable_trigger_create)
+      @non_pusherable_model.save
+      @non_pusherable_model.should_not_receive(:pusherable_trigger_update)
+      @non_pusherable_model.save
+      @non_pusherable_model.should_not_receive(:pusherable_trigger_destroy)
+      @non_pusherable_model.destroy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'database_cleaner'
+require 'active_record'
+require 'pusher'
+require 'pusherable'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/models.rb'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,10 @@
+class NonPusherableModel < ActiveRecord::Base
+end
+
+class DefaultedPusherableModel < ActiveRecord::Base
+  pusherable
+end
+
+class PusherableModel < ActiveRecord::Base
+  pusherable('our_channel')
+end

data/spec/support/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :non_pusherable_models, :force => true do |t|
+    t.timestamps
+  end
+
+  create_table :defaulted_pusherable_models, :force => true do |t|
+    t.timestamps
+  end
+
+  create_table :pusherable_models, :force => true do |t|
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: pusherable
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 1.0.1
+platform: ruby
+authors:
+- Tony Coconate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pusher
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: acts_as_fu
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds callback hooks for your ActiveRecord models for sending messages
+  to a Pusher channel.
+email:
+- me@tonycoconate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pusherable.rb
+- lib/pusherable/version.rb
+- pusherable.gemspec
+- spec/pusherable_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/tonycoco/pusherable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Adds callback hooks for your ActiveRecord models for sending messages to
+  a Pusher channel.
+test_files:
+- spec/pusherable_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb