guard-pusher 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in guard-pusher.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/(.*)_spec.rb})
+  watch(%r{^lib/(.*)\.rb})                              { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper.rb})                       { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Klaus Hartl
+
+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.rdoc

@@ -0,0 +1,80 @@
+= guard-pusher
+
+Pusher guard allows to automatically send a Pusher message to any number of browserswhen files are modified. That message can for instance be used to reload a page
+during development. Sort of Livereload but for iPad, iPhone etc. without the ability to install the necessary extension.
+
+- Tested on Ruby 1.8.7 & 1.9.2.
+
+== Install
+
+Please be sure to have {Guard}[https://github.com/guard/guard] installed before continue.
+
+Install the gem:
+
+    gem install guard-pusher
+
+Or add it to your Gemfile
+
+    gem 'guard-pusher'
+
+and run
+
+    bundle install
+
+Add guard definition to your Guardfile by running this command:
+
+    guard init pusher
+
+Get a free Pusher developer account: http://pusherapp.com (also available as Heroku add-on).
+
+Create a YAML file containing your API credentials for the development environment and save it in the config directory:
+
+    # config/pusher.yml
+    development:
+      app_id: ...
+      key: ...
+      secret: ...
+
+You can also pass these credentials as option in your guard definition, see Options below.
+
+Include the following JavaScript:
+
+    <script src="http://js.pusherapp.com/1.8/pusher.min.js"></script>
+    <script>
+        new Pusher(<key>).subscribe('guard-pusher').bind('guard', function() {
+            // do something - for instance simply reload the page:
+            location.reload();
+       });
+    </script>
+
+== Usage
+
+Please read {Guard usage doc}[https://github.com/guard/guard#readme]
+
+== Options
+
+Pass Pusher API credentials as option:
+
+    guard 'pusher', :app_id => ..., :key => '...', :secret => '...' do
+      ...
+    end
+
+Set the name of the event you're binding to:
+
+    guard 'pusher', :event => 'ping' do
+      ...
+    end
+
+    new Pusher(...).subscribe('guard-pusher').bind('ping', function() { ... });
+
+== Development
+
+- Source hosted at {GitHub}[https://github.com/guard/guard-pusher]
+- Report issues, questions, feature requests on {GitHub Issues}[https://github.com/guard/guard-pusher/issues]
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.
+
+== Authors
+
+{Klaus Hartl}[https://github.com/carhartl]
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+namespace(:spec) do
+  desc "Run all specs on multiple ruby versions (requires rvm)"
+  task(:portability) do
+    %w[1.8.6 1.8.7 1.9.2].each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+                 rvm #{version};
+                 echo "--------- version #{version} ----------\n";
+                 bundle install;
+                 rake spec'
+      BASH
+    end
+  end
+end

data/guard-pusher.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "guard/pusher/version"
+
+Gem::Specification.new do |s|
+  s.name        = "guard-pusher"
+  s.version     = Guard::PusherVersion::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Klaus Hartl"]
+  s.email       = ["klaus.hartl@gmail.com"]
+  s.homepage    = "http://github.com/carhartl/guard-pusher"
+  s.summary     = "Guard gem for Pusher"
+  s.description = "Pusher guard allows to automatically send a Pusher message to any number of browsers."
+
+  s.rubyforge_project = "guard-pusher"
+
+  s.add_dependency "guard", ">= 0.3"
+  s.add_dependency "pusher", ">= 0.8"
+
+  s.add_development_dependency "bundler", "~> 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.3.0"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rb-fsevent"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/guard/pusher/templates/Guardfile

@@ -0,0 +1,4 @@
+guard 'pusher' do
+  # Rails example
+  watch(%r{public/.+\.(css|js)})
+end

data/lib/guard/pusher/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module PusherVersion
+    VERSION = "0.0.1"
+  end
+end

data/lib/guard/pusher.rb

@@ -0,0 +1,42 @@
+require 'guard'
+require 'guard/guard'
+require 'pusher'
+
+module Guard
+  class Pusher < Guard
+
+    def initialize(watchers = [], options = {})
+      super
+
+      @options = options
+
+      config = if File.file?('config/pusher.yml')
+        YAML.load_file('config/pusher.yml')['development']
+      else
+        options
+      end
+
+      if config_pusher_with(config)
+        UI.info('Pusher is ready.', :reset => true)
+      else
+        UI.info("D'oh! Pusher not properly configured. Make sure to add app_id, key and secret.", :reset => true)
+      end
+    end
+
+    def run_on_change(paths)
+      ::Pusher['guard-pusher'].trigger(@options[:event] || 'guard', {})
+    end
+
+
+    private
+
+    def config_pusher_with(credentials)
+      %w{app_id key secret}.each do |config|
+        return false unless (value = credentials[config] || credentials[config.to_sym])
+        ::Pusher.send("#{config}=", value)
+      end
+      true
+    end
+
+  end
+end

data/spec/guard/pusher_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Guard::Pusher do
+
+  describe "configuration" do
+    context "provided through YAML file" do
+      before(:each) do
+        File.should_receive(:file?).
+          with('config/pusher.yml').
+          and_return(true)
+
+        YAML.should_receive(:load_file).
+          with('config/pusher.yml').
+          and_return({ "development" => { "app_id" => 42, "key" => "fake_key", "secret" => "fake_secret" }})
+      end
+
+      it "requires 'app_id', 'key' and 'secret'" do
+        Pusher.should_receive(:app_id=).with(42)
+        Pusher.should_receive(:key=).with('fake_key')
+        Pusher.should_receive(:secret=).with('fake_secret')
+        Guard::UI.should_receive(:info).with(/.*Pusher is ready.*/, :reset => true)
+        Guard::Pusher.new([])
+      end
+    end
+
+    context "provided through options" do
+      before(:each) do
+        File.should_receive(:file?).
+          with('config/pusher.yml').
+          and_return(false)
+      end
+
+      it "requires 'app_id', 'key' and 'secret'" do
+        Pusher.should_receive(:app_id=).with(42)
+        Pusher.should_receive(:key=).with('fake_key')
+        Pusher.should_receive(:secret=).with('fake_secret')
+        Guard::UI.should_receive(:info).with(/.*Pusher is ready.*/, :reset => true)
+        Guard::Pusher.new([], {
+          :app_id => 42,
+          :key    => 'fake_key',
+          :secret => 'fake_secret'
+        })
+      end
+    end
+
+    context "missing the necessery keys" do
+      before(:each) do
+        File.should_receive(:file?).
+          with('config/pusher.yml').
+          and_return(false)
+      end
+
+      it "does not attempt to configure Pusher and issues a warning" do
+        Pusher.should_not_receive(:app_id=)
+        Guard::UI.should_receive(:info).with(/.*Pusher not properly configured.*/, :reset => true)
+        Guard::Pusher.new([], {
+          :key    => 'fake_key',
+          :secret => 'fake_secret'
+        })
+      end
+    end
+  end
+
+  describe "run_on_change" do
+    it "sends Pusher message" do
+      channel = mock(Pusher::Channel)
+      Pusher.should_receive(:[]).with('guard-pusher').and_return(channel)
+      channel.should_receive(:trigger).with('guard', {})
+      subject.run_on_change(['foo'])
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'guard/pusher'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: guard-pusher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: !!null 
+platform: ruby
+authors:
+- Klaus Hartl
+autorequire: !!null 
+bindir: bin
+cert_chain: []
+date: 2011-03-01 00:00:00.000000000 +01:00
+default_executable: !!null 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2156752380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156752380
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: &2156751880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156751880
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2156751420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156751420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156750960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156750960
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2156750580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156750580
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &2156750120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156750120
+description: Pusher guard allows to automatically send a Pusher message to any number
+  of browsers.
+email:
+- klaus.hartl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- guard-pusher.gemspec
+- lib/guard/pusher.rb
+- lib/guard/pusher/templates/Guardfile
+- lib/guard/pusher/version.rb
+- spec/guard/pusher_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/carhartl/guard-pusher
+licenses: []
+post_install_message: !!null 
+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: guard-pusher
+rubygems_version: 1.5.0
+signing_key: !!null 
+specification_version: 3
+summary: Guard gem for Pusher
+test_files:
+- spec/guard/pusher_spec.rb
+- spec/spec_helper.rb