stickynotifications 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aeb62d61d9df1ebc0d647e1ae510f552a3b7ab6
-  data.tar.gz: 1de94278d7c9266a6249e4b553d1a6d64e61322d
+  metadata.gz: 3a1d060a62120a5a5feb5da9eafe1c7cfefc7458
+  data.tar.gz: 640421395afa8565082062129e00b7dd1a53456c
 SHA512:
-  metadata.gz: 33035d1ed873e4399b72ddf65cb438ed9986f8ad89662105e5e85540a7dd96c4800abc0beb536ca95fd8d8cf6df6171b8c3ec1be677927b108087258390c70fa
-  data.tar.gz: 06e0bf14986cb7104aee9ba819f71f4639044a5190a0194132c10adb4782b769284d6401841f7d3a1102f6103150d62100539296c7855934af5f9a2750a45b3b
+  metadata.gz: a7aa4dfd9f4d3cb643925c3134c91bc8d652d3b78c8cf4af3e7520737cb7d1113a21df208af59368c03422316221e45387f1e3cd876c38e7bee7c8c556546cbf
+  data.tar.gz: 94a3ed8c93db51175e4b655cc1b3b233b8ae301ee5c15ff79f2fe976911811ad646554c13e377f27e569bb30c0a6506f7dc7f64c85e53dd756af4ddcf1056334

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+## 0.0.6 --- 2014-12-16
+
+### Added
+
+- `--title` option for new Sticky Notifications

data/README.md

@@ -1,6 +1,6 @@
 # Stickynotifications
 
-TODO: Write a gem description
+A gem for interacting with Sticky Notifications.app on OS X.
 
 ## Installation
 
@@ -20,11 +20,11 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    `stickynotifications new "Message to create" --title "Title for my Sticky Notification"`
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/stickynotifications/fork )
+1. Fork it ( https://github.com/brandonpittman/stickynotifications/fork )
 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`)

data/lib/stickynotifications/cli.rb

@@ -1,15 +1,26 @@
 require 'thor'
 require 'stickynotifications/note'
 
+# @author "Brandon Pittman"
 module StickyNotifications
+  # @author "Brandon Pittman"
+  # Inherits from Thor in order to create CLI
   class Cli < Thor
-
-    desc "new TEXT", "create new Sticky Notification with TEXT"
+    desc 'new TEXT [-t TITLE]',
+         'create new Sticky Notification with TEXT [and TITLE]'
     # Creates a new Sticky Notification
-    # @param text [String] the text of the Sticky Notification
+    # @param text [String] the message of the Sticky Notification
+    # @option title [String] optional title for Sticky Notification
+    # @example stickynotifications new
+    #   stickynotifications new "This is the text of my sticky notification!"
+    option :title,
+           aliases: :t,
+           type: :string,
+           default: 'Reminder',
+           banner: 'Optional title for new Sticky Notification.'
     def new(text)
       note = StickyNotifications::Note.new
-      note.create(text)
+      note.create(text, options[:title])
     end
   end
 end

data/lib/stickynotifications/note.rb

@@ -1,18 +1,23 @@
 require 'uri'
 
 module StickyNotifications
+  # Responsible for initiating note creation.
   class Note
     # @param text [String] text to be used as reminder
     # @return [Nil]
-    def create(text)
-      %x{open "sticky-notifications://note?message=#{escape_string(text)}"}
+    # Calls Sticky Notifications URL scheme in order to
+    #   initiate creation of sticky notification.
+    def create(message_text, title_text)
+      message = escape(message_text)
+      title = escape(title_text)
+      `open "sticky-notifications://note?title=#{title}&message=#{message}"`
     end
 
     # Escapes the Sticky Notification text for URLs. URI produces %20 for
     # spaces instead of CGI's +.
     # @param string_to_escape [String] the text to be escaped
     # @return [String] parsed URL
-    def escape_string(string_to_escape)
+    def escape(string_to_escape)
       URI.escape(string_to_escape)
     end
   end

data/lib/stickynotifications/version.rb

@@ -1,5 +1,5 @@
-# Sets version for RubyGems
+# Namespace for stickynotifications
 module Stickynotifications
   # Sets version for RubyGems
-  VERSION = "0.0.5"
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stickynotifications
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - brandonpittman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A gem for creating Sticky Notifications.