notify-push 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efa3fc9abcef7e26a0e215820da56a98894b9597
-  data.tar.gz: 3fca230957a77717878171fc62963495da2061b3
+  metadata.gz: e5e52e6142a2573fe33415d6b71362d4988763f4
+  data.tar.gz: 95903bb0ece552d3cd9305d55c5db64a1efbfd8e
 SHA512:
-  metadata.gz: a267ee4692cc2819e84eb8635df12b5b4b562b588bbf291f678ce3124bf5335d426f6502f270f0d0b3273ca570a8c9965963f0ce027848fe402d0d57d9579481
-  data.tar.gz: 71d7f548b8d076ebcf775b736740010486d9d3000b28dd5b7ecb7f40664476a31822c1a11dc05514945601882514c852791d182d9783f5d4566ed4347f1b3bc3
+  metadata.gz: b932e42771827493e8877ce6b7959ca0fcbbe888e426f8247ee795a42d0bfd611e70dddd4fcab9aa9382af2de4d581fb76da062f5f4230b3eeac96bdf3852ac5
+  data.tar.gz: f5b1ea146162bc5bd06d7a6dad2a466caa2ebe504c25f00cadbd929e960e40b1ee11ad66689cd82c57bb1e4ceae81d357501b0bac79ce97ffa25b6dd8449c5a5

data/Gemfile

@@ -1,15 +1,15 @@
+# ================================================
+# GEMFILE ========================================
+# ================================================
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+
 gem "pusher"
 gem "pusher-client"
 gem "activesupport"
 gem "recursive-open-struct"
 gem "pidfile"
+gem "os"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"

data/Gemfile.lock

@@ -51,6 +51,7 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    os (0.9.6)
     pidfile (0.3.0)
     pusher (0.14.5)
       httpclient (~> 2.5)
@@ -89,6 +90,7 @@ DEPENDENCIES
   activesupport
   bundler (~> 1.0)
   jeweler (~> 2.0.1)
+  os
   pidfile
   pusher
   pusher-client

data/README.md

@@ -1,3 +1,59 @@
 # notify-push
 A general purpose popup notifier sender/receiver for using WebSockets (via Pusher).
 
+## Disclaimer
+
+![alt text](http://serve.eriknomitch.com/images/works-on-my-machine.jpg "Works on My Machine")
+
+## Installation
+
+### Create Pusher App
+Create an App on [Pusher](https://pusher.com) named **notify-push**.  The free account should be plenty.
+
+### Install notify-push
+For the Receiver machine and the Sender machine(s):
+
+```Shell
+$ gem install notify-push
+```
+
+### Create & Distribute Configuration File
+Next, create a configuration file with your Pusher App's credentials (found on your Pusher App's page under *App Credentials*) and distribute it to each machine (Receiver and Sender(s)).
+
+**Location**: `~/.notify-pushrc`
+
+#### Example
+
+```YML
+pusher:
+  key: a1a2a3b1b2b3c1c2c3d1
+  secret: a1a2a3b1b2b3c1c3c1d1
+  app_id: 12345
+```
+
+## Receiver
+
+### Usage
+Invoke the Receiver with:
+
+```Shell
+$ notify-push --receiver # or -r
+```
+
+TODO: There's a .plist launchd file in there but it's not ready.
+
+## Sender
+
+### Usage
+
+```Shell
+$ notify-push <message> [title] [subtitle]
+```
+
+Alternatively, you can `curl` or use any Pusher tool to send on messages to your `notify-push` app on channel `"notifications"` with data:
+
+```
+message:  The message to notify you with in the notifier popup (REQUIRED)
+title:    The title of the notifier popup (Optional)
+subtitle: The subtitle of the notifier popup (Optional)
+```

data/Rakefile

@@ -22,6 +22,14 @@ Jeweler::Tasks.new do |gem|
   gem.email = "erik@nomitch.com"
   gem.authors = ["Erik Nomitch"]
   gem.licenses = ["GPL-2"]
+  gem.post_install_message = <<-EOS
+---------------------------------------------------------------
+You may need to create a configuration file at ~/.notify-pushrc
+
+See the example at https://github.com/eriknomitch/notify-push
+---------------------------------------------------------------
+  EOS
+
   #s.files = `git ls-files`.split("\n")
   # dependencies defined in Gemfile
 end

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.1

data/lib/notify-push.rb

@@ -2,9 +2,11 @@ require "json"
 require "shellwords"
 require "yaml"
 require "recursive-open-struct"
-require "active_support/dependencies" # For mattr_accessor
-require 'active_support/core_ext/hash/reverse_merge'
-require 'active_support/core_ext/module'
+require "os"
+
+require "active_support/core_ext/hash/reverse_merge"
+require "active_support/core_ext/module"
+require "active_support/core_ext/object/blank"
 
 # ------------------------------------------------
 # MODULE->NOTIFY-PUSH ----------------------------
@@ -19,7 +21,7 @@ module NotifyPush
   # ----------------------------------------------
   # CONSTANTS ------------------------------------
   # ----------------------------------------------
-  CHANNEL_NAME = "notify-push"
+  CHANNEL_NAME            = "notify-push"
   CONFIGURATION_FILE_PATH = "#{ENV["HOME"]}/.notify-pushrc"
   
   # ----------------------------------------------
@@ -63,18 +65,28 @@ module NotifyPush
     def self.start()
       require "pusher"
 
-      raise "No message supplied." if ARGV.length == 0
+      # The only thing we require is a message.
+      # The others will be nil if not supplied.
+      raise "No message supplied." if ARGV[0].blank?
 
-      Pusher.url = "http://#{configuration.pusher.key}:#{configuration.pusher.secret}@api.pusherapp.com/apps/#{configuration.pusher.app_id}"
+      notification = {
+        message:  ARGV[0],
+        title:    ARGV[1],
+        subtitle: ARGV[2]
+      }
 
-      notification = {message: ARGV[0]}
+      # Strip the nil key/value pairs out so we don't have to 
+      # worry about them on the Receiver end.
+      notification.delete_if {|key, value| value.blank?}
+
+      # Connect to Pusher and trigger the notification
+      Pusher.url = "http://#{configuration.pusher.key}:#{configuration.pusher.secret}@api.pusherapp.com/apps/#{configuration.pusher.app_id}"
 
-      notification[:title] = ARGV[1] if ARGV[1]
-      
       Pusher[CHANNEL_NAME].trigger("notification", notification)
 
       0
     end
+
   end
 
   # ----------------------------------------------
@@ -103,17 +115,20 @@ module NotifyPush
     end
 
     def self.ensure_compatibility
-      `uname`.chomp("\n") == "Darwin" or "The notify-push receiver only supports OS X."
+      OS.mac? or "The notify-push receiver only supports OS X."
     end
 
     # --------------------------------------------
     # NOTIFY -------------------------------------
     # --------------------------------------------
-    def self.notify(title: "notify-push", subtitle: nil, message: " ")
+    def self.notify(title: "notify-push", subtitle: nil, message:)
 
-      args = ["-title", title, "-message", message]
+      args = [
+        "-message", message,
+        "-title",   title
+      ]
 
-      args.concat ["-subtitle", subtitle] if subtitle
+      args.concat ["-subtitle", subtitle] unless subtitle.blank?
 
       system "terminal-notifier", *args
     end
@@ -137,7 +152,7 @@ module NotifyPush
       socket.subscribe(CHANNEL_NAME)
 
       # Bind to the main channel event 
-      socket[CHANNEL_NAME].bind('notification') do |data|
+      socket[CHANNEL_NAME].bind("notification") do |data|
 
         begin
           data = JSON.parse(data, symbolize_names: true)
@@ -166,7 +181,6 @@ module NotifyPush
       0
     end
 
-
   end
 end
 
@@ -174,6 +188,6 @@ end
 # TRAP->SIGINT -----------------------------------
 # ------------------------------------------------
 trap "SIGINT" do
-  puts "Exiting"
+  puts "Exiting."
   exit 130
 end

data/notify-push.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: notify-push 0.1.0 ruby lib
+# stub: notify-push 0.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "notify-push"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Erik Nomitch"]
-  s.date = "2015-06-03"
+  s.date = "2015-06-04"
   s.description = "A general purpose popup notifier sender/receiver using WebSockets (via Pusher)"
   s.email = "erik@nomitch.com"
   s.executables = ["notify-push"]
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/eriknomitch/notify-push"
   s.licenses = ["GPL-2"]
+  s.post_install_message = "---------------------------------------------------------------\nYou may need to create a configuration file at ~/.notify-pushrc\n\nSee the example at https://github.com/eriknomitch/notify-push\n---------------------------------------------------------------\n"
   s.rubygems_version = "2.4.6"
   s.summary = "A general purpose popup notifier sender/receiver using WebSockets (via Pusher)"
 
@@ -49,6 +50,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_runtime_dependency(%q<recursive-open-struct>, [">= 0"])
       s.add_runtime_dependency(%q<pidfile>, [">= 0"])
+      s.add_runtime_dependency(%q<os>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
@@ -61,6 +63,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<recursive-open-struct>, [">= 0"])
       s.add_dependency(%q<pidfile>, [">= 0"])
+      s.add_dependency(%q<os>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
@@ -74,6 +77,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<recursive-open-struct>, [">= 0"])
     s.add_dependency(%q<pidfile>, [">= 0"])
+    s.add_dependency(%q<os>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<yard>, ["~> 0.7"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notify-push
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Erik Nomitch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pusher
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
+  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: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +206,12 @@ homepage: http://github.com/eriknomitch/notify-push
 licenses:
 - GPL-2
 metadata: {}
-post_install_message: 
+post_install_message: |
+  ---------------------------------------------------------------
+  You may need to create a configuration file at ~/.notify-pushrc
+
+  See the example at https://github.com/eriknomitch/notify-push
+  ---------------------------------------------------------------
 rdoc_options: []
 require_paths:
 - lib