vagrant-pushbullet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d1cbbcd221dd4debab453d90c7f2aa8adbdb74c
+  data.tar.gz: 3f677bd7f4c7bf3c14c6e6018c67483dbadc9acd
+SHA512:
+  metadata.gz: 71ecc0b308d9903cc7e65b87e2151fcd97e0b30a97f1a4cbef98654d5965f665f06976739bebe1567d5610d7d7ba6aa2ed9eef3f9887e7d2542b2565700e3b89
+  data.tar.gz: d848a161c272ab3200e2180da2e7f7e711a962d19ea6f00e5dae2746ba60647c926756daac1301b26401db71eeefcf04eac9fa4c540d5fbd484c2378c891924f

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-Pushbullet.gemspec
+gemspec
+
+group :development do
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end
+
+# group :plugins do
+#   gem "vagrant-pushbullet", path: "."
+# end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brett Swift
+
+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,57 @@
+# Vagrant Pushbullet
+
+This gem is a [Vagrant](http://www.vagrantup.com/) plugin that adds Pushbullet notifications to configured devices. 
+
+## Setup Pushbullet
+
+* First get a Pushbullet Account, and add devices to it. 
+    - [Pushbullet.com](https://www.pushbullet.com/)
+* Download the *iOS* app,  *Chrome* plugin, *Android* app, and more.  Add those to your Pushbullet account. 
+* Get your HTTP API Token:  http://pushbullet.com/account
+
+## Install Plugin
+
+```bash
+$ vagrant plugin install vagrant-pushbullet
+```
+
+## Plugin Usage
+
+This plugin is configured purely by a configuration file in your home directory. 
+The plugin will create this file for you, but you will have to edit it manually (for now). 
+
+`~/.vagrant.d/pushbullet.rb`
+```ruby
+module PushbulletConfig
+  TOKEN = "replace this text with token from pushbullet.com/account" #required
+  DEVICES = ['asdfasdfasdf','asdfasdfasdf'] #optional
+end
+```
+
+Run `vagrant pushbullet-config` to retrieve your Device ID's.  Add those to the DEVICES array in the config file to limit which devices are notified. 
+ 
+
+## Notifications
+
+A notification is sent after these commands complete: 
+
+* note there is currently a bug where if an exception occurs in the provisioning, the notification is not sent. 
+
+- `vagrant up`
+- `vagrant reload --provision`
+- `vagrant provision`
+
+## Contributing
+
+* use feature branches please.  Prefer  feature/your_feature_name
+* submit pull requests to the `develop` branch
+
+
+## Author
+
+Brett Swift
+
+## Kudos 
+
+[tcnksm](https://twitter.com/deeeet)
+    - for his vagrant-pushover plugin. This plugin is modeled after his. 

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
+
+version = VagrantPlugins::Pushbullet::VERSION
+
+desc "Install your plugin to your system vagrant."
+task :install_plugin do
+  Rake::Task[:build].execute
+  system("/usr/bin/vagrant plugin install pkg/vagrant-pushbullet-#{version}.gem")
+end
+
+task :uninstall_plugin do
+  system("/usr/bin/vagrant plugin uninstall vagrant-pushbullet")
+end
+
+Bundler::GemHelper.install_tasks
+
+# alias
+task :i => :install_plugin
+task :u => :uninstall_plugin
+

data/Vagrantfile

@@ -0,0 +1,5 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise64"
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+  config.vm.provision :shell, inline: "echo 'Testing Notifications to Pushbullet'"  
+end

data/lib/vagrant-pushbullet/action.rb

@@ -0,0 +1,58 @@
+require "net/https"
+require "washbullet"
+
+module VagrantPlugins
+  module Pushbullet
+    class Action
+
+      def initialize(app,env)
+        @app     = app
+        @ui      = env[:ui]
+        @machine = env[:machine].name.to_s
+        @machinfo = env[:machine]
+      end
+
+      def call(env)
+        # Before machine action
+        state  = env[:machine].state.id
+
+        # Execute machine action
+        @app.call(env)
+
+        # After execute machine action
+        config    = env[:machine].config.Pushbullet
+        action    = env[:machine_action]
+        provision = env[:provision_enabled]
+
+        config_file = ::VagrantPlugins::Pushbullet.config_file
+
+        unless config_file.exist?  &&  config.is_config_valid
+          puts "some validation failed"
+          env[:ui].error("Pushbullet plugin configuration has not yet been set up. \nPlease replace required values in config file: #{config_file} ")
+        end
+
+        @machinfo = env[:machine]
+        case action
+        when :up
+          notification(config, config_file) if state != :running && provision && config.is_config_valid
+        when :reload
+          notification(config, config_file) if provision && config.is_config_valid
+        when :provision
+          notification(config, config_file) if config.is_config_valid
+        end
+      end
+
+      def notification(config, config_file)
+        #TODO: append provisioning result, success or fail.
+        require config_file
+        devices = PushbulletConfig::DEVICES
+        token = PushbulletConfig::TOKEN
+        client = Washbullet::Client.new(token)
+        devices.each {|iden|
+          client.push_note(iden, "Vagrant Finished:  #{@machine}", '')
+        }
+      end
+    end
+  end
+end
+

data/lib/vagrant-pushbullet/command.rb

@@ -0,0 +1,55 @@
+require "washbullet"
+
+module VagrantPlugins
+  module Pushbullet
+    class Command < Vagrant.plugin("2", :command)
+
+      def self.synopsis
+        "generates Pushbullet configration file   weeeeeeeeeeee"
+      end
+      
+      def execute
+        config_file = ::VagrantPlugins::Pushbullet.config_file
+
+        if config_file.exist?
+
+          @env.ui.warn("Welcome to the Pushbullet Setup Guide")
+
+          guide = <<-INFO
+This command helps you configure Pushbullet via it's config file: #{config_file}
+
+To limit notifications to specific devices:
+  - If your token is correct you will see your devices below. 
+  - Add/remove device id's from the list shown below to: '#{config_file}'. 
+To notify all devices:
+  - Leave the DEVICES variable empty in your config file.
+INFO
+          @env.ui.info(guide)
+
+          client = Washbullet::Client.new('v1zUVfPeLEveoY8suYABuu9WmuZUDhItndujC7jkt9OgK')
+          require config_file
+          enabled_devices = PushbulletConfig::DEVICES
+
+          devices = client.devices.body["devices"]
+          msg = []
+          devices.each { |device| 
+            if device["active"] 
+              devices = PushbulletConfig::DEVICES
+              enabled = "\e[32m Enabled"
+              disabled = "\e[31m Disabled"
+              enabled_theme = enabled_devices.include?(device['iden'])? enabled : disabled
+              enabled_theme = enabled if enabled_devices.size == 0
+              msg << "   #{enabled_theme}: '#{device['nickname']}' id:    #{device['iden']} \e[0m"
+            end
+          }
+          msg = msg.join("\n")
+          @env.ui.info(msg)
+        else
+          ::VagrantPlugins::Pushbullet.write_default_key
+          @env.ui.error("Please put your pushbullet token from http://pushbullet.com/account into this file: #{config_file}. 
+            \n  ---- Then run this command again to limit pushes to specific devices-----")
+        end
+      end  
+    end          
+  end
+end        

data/lib/vagrant-pushbullet/config.rb

@@ -0,0 +1,60 @@
+require "net/https"
+
+module VagrantPlugins
+  module Pushbullet
+    class Config < Vagrant.plugin("2", :config)
+      
+      # API parameters
+      attr_accessor :token    
+      attr_accessor :message  
+
+      def initialize
+        super
+
+        @token     = UNSET_VALUE
+
+        @config_file = UNSET_VALUE
+      end
+
+      def set
+        yield self if block_given?
+      end
+ 
+
+      def validate(machine)
+        errors = []
+        @config_file = ::VagrantPlugins::Pushbullet.config_file
+
+        unless @config_file && @config_file.exist?
+        
+          errors << "Pushbullet configuration file created at:  #{@config_file}"
+          errors << "run `pushbullet-config` for assistance on entering required values in that file."
+          errors << "\n       --- you will not see this error again ----"
+          ::VagrantPlugins::Pushbullet.write_default_key
+        end
+
+        require @config_file
+        @token = PushbulletConfig::TOKEN
+
+        {Pushbullet: errors}
+      end
+
+      def attributes
+        [  @token  ]
+      end
+
+      def is_config_valid
+          attributes.each do |attribute|
+            return true if attribute != UNSET_VALUE
+          end
+          false
+      end
+
+      def finalize!
+        @token     = nil                     if @token     == UNSET_VALUE   
+      end
+    end
+    
+  end
+end
+        

data/lib/vagrant-pushbullet/plugin.rb

@@ -0,0 +1,44 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant Pushbullet plugin must be run within Vagrant."
+end
+
+module VagrantPlugins
+  module Pushbullet
+
+    class Plugin < Vagrant.plugin("2")
+      name "Pushbullet"
+      description <<-DESC
+      This plugin add a Pushbullet notification to your vagrant command.
+      This notificates `up` or `provision` is over.
+      DESC
+
+      #TODO replace this with 'set token' that takes a param. 
+      command "pushbullet-config" do
+        require_relative "command"
+        Command
+      end
+
+      action_hook("Pushbullet_hook", :machine_action_up) do |hook|
+        require_relative "action"
+        hook.prepend(Action)
+      end
+
+      action_hook("Pushbullet_hook", :machine_action_provision) do |hook|
+        require_relative "action"
+        hook.prepend(Action)
+      end
+
+      action_hook("Pushbullet_hook", :machine_action_reload) do |hook|
+        require_relative "action"
+        hook.prepend(Action)
+      end
+
+      config(:Pushbullet) do
+        require_relative "config"
+        Config
+      end
+    end
+  end
+end

data/lib/vagrant-pushbullet/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Pushbullet
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-pushbullet.rb

@@ -0,0 +1,27 @@
+require "pathname"
+require "vagrant-Pushbullet/version"
+require "vagrant-Pushbullet/plugin"
+
+module VagrantPlugins
+  module Pushbullet
+
+    def self.config_file
+      vag_home = Pathname.new(File.expand_path("~", __FILE__))
+      Pathname.new("#{vag_home}/.vagrant.d/pushbullet.rb")
+    end
+
+    def self.write_default_key
+      content = <<-EOF
+module PushbulletConfig
+  TOKEN = "<pushbullet_token>" #required
+  DEVICES = [] #optional. MUST use quotes. NO empty strings.
+end
+EOF
+      #TODO: write default config file again. 
+      File.open(config_file,'w') do |f|
+        f.puts content
+      end
+    end
+
+  end
+end

data/vagrant-pushbullet.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-pushbullet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-pushbullet"
+  spec.version       = VagrantPlugins::Pushbullet::VERSION
+  spec.authors       = ["brettswift"]
+  spec.email         = ["brettswift@gmail.com"]
+  spec.summary       = %q{Vagrant plugin that adds Pushbullet notifications }
+  spec.description   = %q{Vagrant plugin that adds Pushbullet notifications }
+  spec.homepage      = "https://github.com/brettswift/vagrant-pushbullet"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'washbullet', '~> 0.3.1'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-pushbullet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- brettswift
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-30 00:00:00.000000000 Z
+dependencies:
+- !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: washbullet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+description: 'Vagrant plugin that adds Pushbullet notifications '
+email:
+- brettswift@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- lib/vagrant-pushbullet.rb
+- lib/vagrant-pushbullet/action.rb
+- lib/vagrant-pushbullet/command.rb
+- lib/vagrant-pushbullet/config.rb
+- lib/vagrant-pushbullet/plugin.rb
+- lib/vagrant-pushbullet/version.rb
+- vagrant-pushbullet.gemspec
+homepage: https://github.com/brettswift/vagrant-pushbullet
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Vagrant plugin that adds Pushbullet notifications
+test_files: []