notifaction 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b53a7a52c1365daddea0965161d52cfe29e25cd2
+  data.tar.gz: e85bb77a9f9b89680fb605ae79e0e18907529174
+SHA512:
+  metadata.gz: 4e6f659236d07d4ba6c1d41c3ddc0f8931aa0f816ff71843112f827ebca2fa11be766db93ce227cbbcc2e2154a45eae708b1a4496b114311a3c6f4f8aed64776
+  data.tar.gz: cbcd4588e31de407dfa9878b9441690569af4c53600d05717e4a901dbb5848872b4b8811ff16f0307d193a6767061d94475a06f7c06bbcfc993f3f9921583f24

data/lib/notifaction.rb

@@ -0,0 +1,3 @@
+require 'utils.rb'
+require 'style.rb'
+require 'notify.rb'

data/lib/notify.rb

@@ -0,0 +1,141 @@
+$:.unshift File.dirname(__FILE__)
+
+class Notify
+  # Display a notification bubble
+  def self.bubble(message, title)
+    begin
+      if Utils.os == :macosx
+        if !osx_notification(message, title)
+          raise "No handler found, cannot show bubble notification"
+        end
+      else
+        if !notifysend(message, title)
+          raise "No handler found, cannot show bubble notification"
+        #elsif zenity(message, title)
+        #  raise "No handler found, cannot show bubble notification"
+        end
+      end
+    rescue Exception => e
+      warning("[self.bubble] #{e.message}")
+    end
+  end
+
+  def self.modal(message, title)
+    begin
+      if Utils.os == :macosx
+        if !osx_modal(message, title)
+          raise "No handler found, cannot show system popup"
+        end
+      end
+    rescue Exception => e
+      warning("[self.bubble] #{e.message}")
+    end
+  end
+
+  # Prints a pre-formatted error message to the console
+  def self.error(message)
+    message = message.split("\n").join("\n\u2716 ")
+    inline("\u2716 #{message} - #{Utils.formatted_time}", :red)
+    inline("\u2716 Exiting...", :red)
+
+    exit
+  end
+
+  # Prints a pre-formatted warning message to the console
+  def self.warning(message)
+    message = message.split("\n").join("\n\u2011 ")
+    inline("\u2011 #{message} - #{Utils.formatted_time}", :yellow)
+  end
+
+  # Prints a pre-formatted informational message to the console
+  def self.info(message)
+    inline("#{message} - #{Utils.formatted_time}", :blue)
+  end
+
+  # Prints a pre-formatted secondary informational message to the console
+  def self.sinfo(message)
+    message = message.split("\n").join("\n\u2011 ")
+    inline("\u2011 #{message} - #{Utils.formatted_time}", :cyan)
+  end
+
+  # Prints a pre-formatted success message to the console
+  def self.success(message)
+    message = message.split("\n").join("\n\u2713 ")
+    inline("\u2713 #{message} - #{Utils.formatted_time}", :green)
+  end
+
+  # Prints a pre-formatted unstyled message to the console
+  def self.spit(message)
+    inline(message, :null)
+  end
+
+  # Send status updates to WorkingOn
+  def self.wo(message, print_info_message = false)
+    begin
+      require_relative "plugins/workingon.rb"
+
+      plugin = Plugin::WorkingOn.new
+      plugin.send(message)
+
+      if print_info_message
+        info(message)
+      end
+    rescue Exception => e
+      error("Error notifying WO - #{e.message}", self)
+    end
+  end
+
+  # pretty-print a spacer
+  def self.spacer
+    inline("\u2011 =============", :magenta)
+  end
+
+  private
+    # Collate colour and style, build message string in format of 
+    # "\e[#{style};#{colour}m#{text}\e[0m"
+    def self.inline(message, colour = nil, style = nil)
+      puts Style.format(message, colour, style)
+    end
+
+    def osx_notification(message, title)
+      begin
+        @response = `osascript -e 'display notification "#{message}" with title "#{title}"'`
+
+        $?.exitstatus == 0
+      rescue SystemExit, Interrupt
+        error("Interrupt caught, exiting", self)
+      end
+    end
+
+    # OSX system modal popup
+    def osx_modal(message, title, icon = :caution)
+      begin
+        @response = `osascript -e 'tell app "System Events" to display dialog "#{message}" buttons {"OK"} default button 1 with title "#{title}" with icon #{icon}'`
+
+        $?.exitstatus == 0
+      rescue SystemExit, Interrupt
+        error("Interrupt caught, exiting", self)
+      end
+    end
+
+    # Linux system notification
+    def notifysend(message, title)
+      begin
+        @response = `notify-send "#{title}" "#{message}"`
+
+        $?.exitstatus == 0
+      rescue SystemExit, Interrupt
+        error("Interrupt caught, exiting", self)
+      end
+    end
+
+    def zenity(message, title)
+      begin
+        @response = `echo "message:#{message}" | zenity --notification --listen`
+
+        $?.exitstatus == 0
+      rescue SystemExit, Interrupt
+        error("Interrupt caught, exiting", self)
+      end
+    end
+end

data/lib/plugins/workingon.rb

@@ -0,0 +1,11 @@
+module Plugin
+  class WorkingOn
+    def send(message)
+      Net::HTTP.post_form(URI(sprintf(api_endpoint, $config.get[:wo_key])), :task => CGI.escapeHTML(message))
+    end
+
+    def api_endpoint
+      "https://api.workingon.co/hooks/incoming?token=%s"
+    end
+  end
+end

data/lib/style.rb

@@ -0,0 +1,32 @@
+module Style
+  @map = {
+    :colour => {
+      :red => 31,
+      :green => 32,
+      :yellow => 33,
+      :blue => 34,
+      :magenta => 35,
+      :cyan => 36,
+      :white => 37,
+      :null => 0
+    },
+    :style => {
+      :reset => 0,
+      :bold => 1,
+      :underline => 4,
+      :normal => ""
+    }
+  }
+
+  def self.format(message, colour = nil, style = nil)
+    c = @map[:colour][colour.to_sym] if !colour.nil?
+
+    if style.nil?
+      t = 0
+    else
+      t = @map[:style][style.to_sym]
+    end
+    
+    "\e[#{t};#{c}m#{message}\e[0m"
+  end
+end

data/lib/utils.rb

@@ -0,0 +1,30 @@
+require "time"
+require "rbconfig"
+
+class Utils
+  def self.formatted_time(time = nil)
+    if time.nil?
+      time = Time.now
+    end
+    
+    time.strftime("%e/%-m/%Y @ %I:%M:%S%P")
+  end
+
+  def self.os
+    @os ||= (
+      host_os = RbConfig::CONFIG['host_os']
+      case host_os
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        :windows
+      when /darwin|mac os/
+        :macosx
+      when /linux/
+        :linux
+      when /solaris|bsd/
+        :unix
+      else
+        puts "unknown os: #{host_os.inspect}"
+      end
+    )
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: notifaction
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Priebe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies: []
+description: Include terminal and OS notifications in your project
+email: hello@ryanpriebe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/notifaction.rb
+- lib/utils.rb
+- lib/notify.rb
+- lib/style.rb
+- lib/plugins/workingon.rb
+homepage: http://rubygems.org/gems/notifaction
+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: Notification Satisfaction
+test_files: []