pushable-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ea422298a860eb66c8ccaa5b9816575ae57f482
+  data.tar.gz: 0dfaf728361e67fc1244fafd67035b55d7b9911d
+SHA512:
+  metadata.gz: df8cdac35efad1b74f3bcd82dd0740746a4ed9d749578a1e7d3ee4a6d4b2a089d5ebdcf199714c37380c1ce89c219f2a7d7ae4762d02334e71bcc052efd2e4ab
+  data.tar.gz: 78ce8fd2150ec9ee4769098c660d2bf6d851e22d0c5b730d8d4ea5d4514cae2a2756e482b21471e6abdd30680a5b1b9ecdc523be5350f752a9b1808ae977c5cb

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matteo Depalo
+
+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,52 @@
+# Pushable::Rails
+
+Send model updates to Pusher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pushable-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pushable-rails
+
+## Usage
+
+Include the `Pushable` module in your activerecord models like this:
+
+```ruby
+class DummyModel < ActiveRecord::Base
+  include Pushable
+end
+```
+
+Now every time you create, update or destroy `DummyModel`s your app will send the corresponding notifications to pusher.
+
+Channel: `pusher`
+
+Events:
+
+- Create
+'dummy_model.destroy'
+
+- Update
+'dummy_model.update'
+
+- Destroy
+'dummy_model.destroy'
+
+The payload will be the output of the model instance `to_json`. If defined, a serializer will be used (eg. `DummyModelSerializer`).
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/pushable-rails/fork )
+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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pushable/version.rb

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

data/lib/pushable.rb

@@ -0,0 +1,33 @@
+require 'pushable/version'
+require 'active_support'
+require 'pusher'
+
+module Pushable
+  extend ActiveSupport::Concern
+
+  included do
+    attr_accessor :client_id
+
+    after_commit :pushable_trigger_create, on: :create
+    after_commit :pushable_trigger_update, on: :update
+    after_commit :pushable_trigger_destroy, on: :destroy
+
+    private
+
+    def pushable_class_name
+      self.class.name.underscore
+    end
+
+    def serialized_model
+      "#{self.class.name}Serializer".constantize.new(self).to_json
+    rescue NameError
+      to_json
+    end
+
+    %w(create update destroy).each do |action_name|
+      define_method("pushable_trigger_#{action_name}") do
+        Pusher.trigger('pusher', "#{pushable_class_name}.#{action_name}", serialized_model)
+      end
+    end
+  end
+end

data/pushable-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pushable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pushable-rails'
+  spec.version       = Pushable::VERSION
+  spec.authors       = ['Matteo Depalo']
+  spec.email         = ['matteodepalo@gmail.com']
+  spec.summary       = 'Send model updates to Pusher'
+  spec.description   = 'Send model updates to Pusher'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails'
+  spec.add_dependency 'pusher'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec'
+end

data/spec/pushable_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+class DummyModel < ActiveRecord::Base
+  include Pushable
+
+  def to_json
+    '{}'
+  end
+end
+
+describe Pushable do
+  describe 'after commit on create' do
+    it 'triggers the corresponding Pusher notification' do
+      dummy_model = DummyModel.new
+      Pusher.should_receive(:trigger).with('pusher', 'dummy_model.create', '{}')
+      dummy_model.save
+    end
+  end
+
+  describe 'after commit on update' do
+    it 'triggers the corresponding Pusher notification' do
+      dummy_model = DummyModel.new
+      dummy_model.save
+      Pusher.should_receive(:trigger).with('pusher', 'dummy_model.update', '{}')
+      dummy_model.update({})
+    end
+  end
+
+  describe 'after commit on destroy' do
+    it 'triggers the corresponding Pusher notification' do
+      dummy_model = DummyModel.new
+      dummy_model.save
+      Pusher.should_receive(:trigger).with('pusher', 'dummy_model.destroy', '{}')
+      dummy_model.destroy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'pushable'
+require 'database_cleaner'
+require 'sqlite3'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+  create_table :dummy_models, force: true
+end
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: pushable-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matteo Depalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Send model updates to Pusher
+email:
+- matteodepalo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pushable.rb
+- lib/pushable/.DS_Store
+- lib/pushable/version.rb
+- pushable-rails.gemspec
+- spec/pushable_spec.rb
+- spec/spec_helper.rb
+- test.db
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Send model updates to Pusher
+test_files:
+- spec/pushable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: