pousse 0.0.4 → 0.0.5

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p374

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3-p374"
+script: bundle exec rspec spec

data/Gemfile

@@ -10,5 +10,6 @@ end
 
 group :test do
   gem 'rspec'
+  gem 'coveralls', require: false
   gem 'therubyracer', require: 'v8'
 end

data/README.md

@@ -1,6 +1,13 @@
 # Pousse
 
-TODO: Write a gem description
+[![Pousse](http://doc.agorize.com/pousse/poussette.png)](http://github.com/Studyka/pousse)
+
+
+[![Build Status](https://travis-ci.org/Studyka/pousse.png?branch=master)](https://travis-ci.org/Studyka/pousse)
+[![Dependency Status](https://gemnasium.com/Studyka/pousse.png)](https://gemnasium.com/Studyka/pousse)
+[![Code Climate](https://codeclimate.com/github/Studyka/pousse.png)](https://codeclimate.com/github/Studyka/pousse)
+
+Pousse enables you to add realtime to any rails application by sending javascript to users or group of users.
 
 ## Installation
 
@@ -16,25 +23,60 @@ Or install it yourself as:
 
     $ gem install pousse
 
+### Install your Poussette node server on heroku:
+
+```
+git clone git@github.com:Studyka/poussette.git
+cd poussette
+heroku create <your-app>
+heroku config:set POUSSE_SECRET=yoursecret # Used as encryption key
+heroku addons:add redistogo
+git push heroku master
+heroku config | grep REDISTOGO_URL # This url is needed in the pousse initializer below
+```
+
 ## Usage
 
+
 Create an initializer config/initializer/pousse.rb
 
+Set an envirnoment variable `REDISTOGO_URL` corresponding to the url previously greped
+
+### If you are using Heroku with RedisToGo:
+```
+Pousse::configure do |config|
+  config.server = ENV['POUSSETTE_SERVER'] # Warning: You must specify the port in development mode (eg: http://mypousssette.herokuapp.com:80)
+  config.secret = ENV['POUSSE_SECRET']
+  if ENV['REDISTOGO_URL'].present?
+    uri = URI.parse(ENV['REDISTOGO_URL'])
+    config.redis = { host: uri.host, port: uri.port, password: uri.password }
+  end
+end
+```
+### else (without Heroku):
 ```
 Pousse::configure do |config|
+  config.server = ''
+  config.secret = ''
+  config.redis = {
+    host: '',
+    port: '',
+    password: ''
+  } 
 end
 ```
 
-Add this line to your layout :
+Add this line to your layout:
 
 ```
-<script><%= Pousse::js([:everybody], [server], [secret]) %></script>
+# Everybody is your channel
+<%= javascript_tag Pousse::js([:everybody]) %>
 ```
 
 
-Create a new mailer in app/mailer/pousse.rb
+Create a new mailer in `app/mailer/pousse_mailer.rb`
 ```
-class AlertMailer < Pousse::Mailer
+class PousseMailer < Pousse::Mailer
   def send_alert
     mail(
       to: 'everybody',
@@ -44,14 +86,14 @@ class AlertMailer < Pousse::Mailer
 end
 ```
 
-### Your node server on heroku :
+## Testing:
 
+Add the following line in your `config/environments/test.rb`:
 ```
-git clone ...
-heroku ...
+Pousse::Mailer.delivery_method = :test
 ```
 
-### TODO :
+## TODO:
 
 - Should add some logging when redis is not available.
 - Should add some spec for the configuration.

data/lib/pousse/mailer.rb

@@ -1,5 +1,6 @@
 module Pousse
   class Mailer < ActionMailer::Base
-    default delivery_method: Pousse::RedisDelivery
+    self.delivery_method = Pousse::RedisDelivery
+    default from: 'pousse@pousse.pousse'
   end
 end

data/lib/pousse/redis_delivery.rb

@@ -7,6 +7,7 @@ module Pousse
     end
 
     def deliver!(mail)
+      redis = nil
       begin
         redis = Redis.new @redis_config
         mail.to.each do |to|
@@ -15,6 +16,8 @@ module Pousse
       rescue Exception => e
         #TODO: Use a real logguer ??
         puts "NOTIFICATION NOT DELIVERED: #{e.message}"
+      ensure
+        redis.quit unless redis.nil?
       end
     end
   end

data/lib/pousse/version.rb

@@ -1,3 +1,3 @@
 module Pousse
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/pousse/pousse_spec.rb

@@ -14,15 +14,29 @@ describe Pousse do
             body: 'alert("Générale !");'
           )
         end
-      end 
+      end
     end
 
     let :redis_instance do
-      redis_instance = stub()
+      redis_instance = stub(quit: true)
       Redis.stub(new: redis_instance)
       redis_instance
     end
 
+
+    it 'uses default from' do
+      mailer.send_alert.from.should == ['pousse@pousse.pousse']
+    end
+
+    it 'uses delivery method' do
+      mailer.send_alert.delivery_method.should be_an_instance_of Pousse::RedisDelivery
+    end
+
+    it 'delivery method can be overwritten' do
+      mailer.delivery_method = :test
+      mailer.send_alert.delivery_method.should be_an_instance_of Mail::TestMailer
+    end
+
     it 'provide Pousse::Mailer' do
       expect{
         Class.new Pousse::Mailer

data/spec/pousse/redis_delivery_spec.rb

@@ -3,14 +3,14 @@ require 'spec_helper'
 
 describe Pousse::RedisDelivery do
 
-  let :redis do
-   Pousse::RedisDelivery.new {} 
+  subject do
+   Pousse::RedisDelivery.new {}
   end
 
   describe '#deliver!' do
 
     let :redis_instance do
-      redis_instance = stub()
+      redis_instance = stub(quit: true)
       Redis.stub(new: redis_instance)
       redis_instance
     end
@@ -26,14 +26,26 @@ describe Pousse::RedisDelivery do
       redis_instance
         .should_receive(:publish)
         .with('everyone',  'alert("Générale !");')
-      redis.deliver!(mail)
+      subject.deliver!(mail)
     end
 
     it 'does not fail when redis can not connect' do
       redis_instance.should_receive :publish do
         raise Redis::CannotConnectError.new 'Error connecting to Redis on 127.0.0.1:6379 (ECONNREFUSED)'
       end
-      expect{ redis.deliver!(mail) }.to_not raise_error
+      expect{ subject.deliver!(mail) }.to_not raise_error
+    end
+
+    it 'disconnect after sending' do
+      redis_instance.should_receive(:quit)
+      subject.deliver!(mail)
+    end
+
+    it 'does not crash if Redis.new raise an error' do
+      Redis.should_receive(:new) do
+        raise Redis::CannotConnectError.new 'Error connecting to Redis on 127.0.0.1:6379 (ECONNREFUSED)'
+      end
+      subject.deliver!(mail)
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,9 @@ require 'bundler/setup'
 
 require 'pousse'
 
+require 'coveralls'
+Coveralls.wear!
+
 RSpec.configure do |config|
   # some (optional) config here
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pousse
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -116,12 +118,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 125855808649955746
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 125855808649955746
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23