guard-pushover 0.1.0

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - 2.0.0
+branches:
+  only:
+    - master
+script: rspec spec

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guard-pushover.gemspec
+gemspec
+gem 'rb-inotify', '~> 0.9', :require => false

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/guard/(.+)\.rb$}) { |m| "spec/guard/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jonnev
+
+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,40 @@
+[![Build Status](https://travis-ci.org/joenas/preek.png)](https://travis-ci.org/joenas/guard-pushover)
+[![Coverage Status](https://coveralls.io/repos/joenas/guard-pushover/badge.png?branch=master)](https://coveralls.io/r/joenas/guard-pushover)
+
+
+# Guard::Pushover
+
+Send [Pushover](https://pushover.net/) notifications with Guard!
+
+## Installation
+
+Install it yourself as:
+
+    $ git clone git@github.com:joenas/preek.git
+
+    $ cd preek
+
+    $ rake install
+    
+Gem will be available soon.
+
+## Usage
+
+To generate template: `guard init pushover` 
+
+### Example
+
+    guard :pushover, :api_key => '', :user_key => '' do
+        watch(/lib\/(.*).rb/)
+    end
+
+Guard::Pushover will send a message like "[filename] was changed/removed/added".
+Support will be added for custom messages.
+
+## 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 @@
+require "bundler/gem_tasks"

data/guard-pushover.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/pushover/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-pushover"
+  spec.version       = Guard::PushoverVersion::VERSION
+  spec.authors       = ["Jon Neverland"]
+  spec.email         = ["jonwestin@gmail.com"]
+  spec.description   = %q{Let Guard send Pushover notifications}
+  spec.summary       = %q{}
+  spec.homepage      = "https://github.com/joenas/guard-pushover/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rushover", ">= 0.3.0"
+  spec.add_dependency "guard", '>= 1.6'
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'coveralls'
+end

data/lib/guard/pushover/templates/Guardfile

@@ -0,0 +1,7 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :pushover, :api_key => '', :user_key => '' do
+	watch(/lib\/(.*).rb/)
+end
+

data/lib/guard/pushover/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module PushoverVersion
+    VERSION = "0.1.0"
+  end
+end

data/lib/guard/pushover.rb

@@ -0,0 +1,63 @@
+require 'guard'
+require 'guard/guard'
+require 'guard/watcher'
+require 'rushover'
+
+module Guard
+  # Send notifications to Pushover
+  class Pushover < Guard
+
+    DEFAULTS = {
+      :title => 'Guard',
+      :priority => 0
+    }
+
+    def initialize(watchers = [], options = {})
+      options = DEFAULTS.merge(options)
+      @user_key = options.delete(:user_key)
+      @api_key = options.delete(:api_key)
+      super
+    end
+
+    def run_on_changes(paths)
+      send_notification "#{paths.first} was changed."
+    end
+
+    def run_on_removals(paths)
+      send_notification "#{paths.first} was removed."
+    end
+
+    def run_on_additions(paths)
+      send_notification "#{paths.first} was added."
+    end
+
+  private
+
+    def client
+      @client = options.delete(:client) || Rushover::Client.new(@api_key)
+    end
+
+    def send_notification(msg)
+      return unless api_keys_valid?
+      @resp = client.notify(@user_key, msg, options)
+      if @resp.ok?
+        UI.info "Pushover: message sent"
+      else
+        handle_error
+      end
+    end
+
+    def api_keys_valid?
+      return UI.error "No API key given." unless @api_key
+      return UI.error "No User key given." unless @user_key
+      true
+    end
+
+    def handle_error
+      if @resp[:user] == 'invalid' || @resp[:token] == 'invalid'
+        append = ', check API and User key'
+      end
+      UI.error "#{@resp[:errors].join()}#{append}"
+    end
+  end
+end

data/spec/guard/pushover_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe Guard::Pushover do
+
+  subject{Guard::Pushover.new([], options)}
+  let(:options){ {:user_key => user_key, :api_key => api_key} }
+  let(:paths){ ['file.rb'] }
+  let(:user_key){ 'user' }
+  let(:api_key){ 'api' }
+  let(:client){double('client', :notify => response)}
+  let(:response){double('response', :ok? => true)}
+  let(:options) { {:user_key => user_key, :api_key => api_key, :client => client} }
+  let(:expected_options){ { :title => 'Guard', :priority => 0 } }
+
+  context "with valid options and credentials" do
+    it "#run_on_removals sends a notification to client with correct parameters" do
+      message = "#{paths.first} was removed."
+      client.should_receive(:notify).with(user_key, message, expected_options)
+      Guard::UI.should_receive(:info).with(/Pushover: message sent/)
+      subject.run_on_removals(paths)
+    end
+
+    it "#run_on_additions_sends a notification to client with correct parameters" do
+      message = "#{paths.first} was added."
+      client.should_receive(:notify).with(user_key, message, expected_options)
+      Guard::UI.should_receive(:info).with(/Pushover: message sent/)
+      subject.run_on_additions(paths)
+    end
+  end
+
+  describe "#run_on_changes" do
+    let(:run_on_changes){subject.run_on_changes(paths)}
+
+    context "without api_key" do
+      let(:api_key){nil}
+      it "shows error message 'No API key given'" do
+        Guard::UI.should_receive(:error).with(/No API key given/)
+        run_on_changes
+      end
+    end
+
+    context "without user_key" do
+      let(:user_key) { nil }
+      it "shows error message 'No User key given'" do
+        Guard::UI.should_receive(:error).with(/No User key given/)
+        run_on_changes
+      end
+    end
+
+    context "with correct options" do
+      let(:message) { "#{paths.first} was changed." }
+
+      context "and valid credentials" do
+        it "shows an info message 'Pushover: message sent'" do
+          Guard::UI.should_receive(:info).with(/Pushover: message sent/)
+          run_on_changes
+        end
+
+        context "with default options" do
+          it "sends a notification to client with correct parameters" do
+            client.should_receive(:notify).with(user_key, message, expected_options)
+            Guard::UI.should_receive(:info).with(/Pushover: message sent/)
+            run_on_changes
+          end
+        end
+
+        context "with option :title => 'TITLE'" do
+          let(:expected_options){ { :title => 'TITLE', :priority => 0 } }
+          it "sends a notification to client with correct parameters" do
+            options[:title] = 'TITLE'
+            client.should_receive(:notify).with(user_key, message, expected_options)
+            Guard::UI.should_receive(:info).with(/Pushover: message sent/)
+            run_on_changes
+          end
+        end
+
+        context "with option :priority => 1" do
+          let(:expected_options){ { :title => 'Guard', :priority => 1 } }
+          it "sends a notification to client with correct parameters" do
+            options[:priority] = 1
+            client.should_receive(:notify).with(user_key, message, expected_options)
+            Guard::UI.should_receive(:info).with(/Pushover: message sent/)
+            run_on_changes
+          end
+        end
+      end
+
+      context "and invalid credentials" do
+        let(:response){double('response', :ok? => false)}
+
+        context "for 'user' key" do
+          it "shows error message 'user identifier is invalid'" do
+            response.stub(:[]).with(:user).and_return('invalid')
+            response.stub(:[]).with(:errors).and_return(['user identifier is invalid'])
+            Guard::UI.should_receive(:error).with(/user identifier is invalid/)
+            run_on_changes
+          end
+        end
+
+        context "for 'token' key" do
+          it "shows error message 'user identifier is invalid'" do
+            response.stub(:[]).with(:user).and_return(true)
+            response.stub(:[]).with(:token).and_return('invalid')
+            response.stub(:[]).with(:errors).and_return(['application token is invalid'])
+            Guard::UI.should_receive(:error).with(/application token is invalid/)
+            run_on_changes
+          end
+        end
+
+        context "for custom error" do
+          it "shows the error message from client " do
+            response.stub(:[]).with(:user).and_return(true)
+            response.stub(:[]).with(:token).and_return(true)
+            response.stub(:[]).with(:errors).and_return(['some random error'])
+            Guard::UI.should_receive(:error).with(/some random error/)
+            run_on_changes
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'coveralls'
+Coveralls.wear!
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'guard/pushover'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: guard-pushover
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jon Neverland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rushover
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Let Guard send Pushover notifications
+email:
+- jonwestin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-pushover.gemspec
+- lib/guard/pushover.rb
+- lib/guard/pushover/templates/Guardfile
+- lib/guard/pushover/version.rb
+- spec/guard/pushover_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/joenas/guard-pushover/
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/guard/pushover_spec.rb
+- spec/spec_helper.rb
+has_rdoc: