ruby-libnio 0.0.1 → 0.1.0

data/README.rdoc

@@ -2,6 +2,68 @@
 
 Library for writing Notify.io(http://notify.io) applications
 
+== Dependencies
+
+You'll need the HTTParty gem
+
+== Setting up Notifiers
+
+To use ruby-libnio, include the LibNio module in the class you want to
+send notifications from and set your Notify.io API key:
+
+  class Notifier
+    include LibNio
+    notify_api_key '[key]'
+  end
+
+LibNio will include HTTParty in the Notification class and set the
+base_uri to 'http://notify.io'
+
+To set up your notifier you'll want to set defaults for some of the
+parameters that the Notify.io is expecting:
+
+  n = Notifier.new do |n|
+    n.title = "GHNotify Message"
+    n.link = "http://ghnotiy.com"
+    n.sticky = true
+    n.icon = "http://a3.twimg.com/profile_images/517037601/notifyio-icon.png"
+  end
+
+Note that you can override these defaults on a per notification basis if you
+would like later.
+
+== Sending Notifications
+
+To send notifications to users using Notify.io you will need the md5 hash of
+the Gmail address that they signed up with Notify.io with.
+
+Note that the md5 hash of me@example.com and Me@example.com will be different,
+so it is important that you use the correct casing. In the future, the Notify.io
+API may include a method to verify user hashes, but for now you might need to
+explicitly ask for them to ensure notifications are sent.
+
+With that in mind, here is how we might send a message to someone, given we know
+their userhash:
+  userhash_1 = "a9d9e4fd104a3ae26793ca155c6ee872"
+  n1.notify(userhash_1, :text => "some text")
+
+This will POST to the Notify.io API, and send the default parameters you set earlier,
+as well as the +text+ parameter you send in the method call. Notify's API will return
+'OK' if the POST is successful.
+
+As mentioned, you can override the defaults on a per-notification basis if you want:
+  userhash_1 = "a9d9e4fd104a3ae26793ca155c6ee872"
+  n1.notify(userhash_1, :text => "some text", :title => "new title", :sticky => false)
+
+Lastly, it is possible to send the same notification to a number of users:
+  userhash_1 = "a9d9e4fd104a3ae26793ca155c6ee872"
+  userhash_2 = "5add5f77c09f4c639293e7254a1faf77"
+  users = [userhash_1, userhash_2]
+  n2.notify_all(users, :text => "Tell everyone")
+
+This will return an array of the responses codes from the Notify.io API.
+	
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -5,13 +5,12 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "ruby-libnio"
-    gem.summary = %Q{Library to assist in writing Notify.io application}
-    gem.description = %Q{Library to assist in writing Notify.io application}
+    gem.summary = %Q{helps you write applications that can send notifications to Notify.io}
+    gem.description = %Q{helps you write applications that can send notifications to Notify.io}
     gem.email = "hunter.gillane@gmail.com"
     gem.homepage = "http://github.com/pinecon3/ruby-libnio"
     gem.authors = ["Hunter Gillane"]
     gem.add_dependency('httparty', '>= 0.4.5')
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -50,4 +49,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "ruby-libnio #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/examples/simple.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require '../lib/ruby-libnio'
+
+class Notifier
+  include LibNio
+  # you'll receive an api key when you create an account with Notify.io
+  # http://notify.io
+  notify_api_key 'p8m5zlpfwj6fqigrff'
+end
+
+n1 = Notifier.new
+# set the defaults for notifications
+n1.title = "GHNotify Message"
+n1.link = "http://ghnotiy.com"
+n1.sticky = true
+n1.icon = "http://a3.twimg.com/profile_images/517037601/notifyio-icon.png"
+
+# or initialize your notifier with a block
+n2 = Notifier.new do |n|
+  n.title = "GHNotify Message"
+  n.link = "http://ghnotiy.com"
+  n.sticky = true
+  n.icon = "http://a3.twimg.com/profile_images/517037601/notifyio-icon.png"
+end
+
+# you'll need the MD5 hash of the gmail address of the user you want to notify
+userhash_1 = "a9d9e4fd104a3ae26793ca155c6ee872"
+
+# to use the default options
+# :text is required
+puts n1.notify(userhash_1, :text => "some text")
+
+# overwrite some default options
+puts n2.notify(userhash_1, :text => "message text", :title => "New Title", :sticky => false)
+
+
+# you can also notify multiple users with the same message
+userhash_2 = "5add5f77c09f4c639293e7254a1faf77"
+users = [userhash_1, userhash_2]
+
+puts n2.notify_all(users, :text => "Tell everyone").each {|resp| puts resp }

data/lib/ruby-libnio.rb

@@ -1,26 +1,52 @@
 require 'httparty'
 
-class LibNio
-  include HTTParty
-  base_uri "api.notify.io"
+module LibNio
   
-  def initialize(key)
-    @api_key = key
+  attr_accessor :title, :icon, :link, :sticky
+  
+  def self.included(base)
+    base.extend ClassMethods
+    base.send(:include, HTTParty)
+    base.send(:base_uri, 'api.notify.io')
+  end
+
+  module ClassMethods
+    def notify_api_key(key=nil)
+      return @@api_key unless key
+      @@api_key = key
+    end
+    
+    def initialize
+      yield self if block_given?
+    end
   end
   
-  def t_get
-    self.class.get('/')
+  def api_key
+    self.class.notify_api_key
   end
   
-  def notify(userhash, message, title, icon, link, sticky)
-    options = { :body => 
-                {:text => message,
-                 :title => title,
-                 :icon => icon,
-                 :link => link,
-                 :sticky => sticky } 
-              }
-
-    self.class.post("/v1/notify/#{userhash}?api_key=#{@api_key}", options)
+  def default_options
+    {:title => title,
+      :icon => icon,
+      :link => link,
+      :sticky => sticky }
   end
+  
+  def notify(userhash, opts = {})
+    options = default_options.merge(opts)
+    
+    # TODO: handle api key not being set
+    self.class.post("/v1/notify/#{userhash}?api_key=#{api_key}", :body => options)
+  end
+  
+  def notify_all(userhashes, opts = {})
+    options = default_options.merge(opts)
+    responses = []
+    userhashes.each do |user|
+      responses << self.class.post("/v1/notify/#{user}?api_key=#{api_key}", :body => options)
+    end
+    responses
+  end
+  
+  private :api_key
 end

data/ruby-libnio.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-libnio}
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hunter Gillane"]
-  s.date = %q{2010-01-25}
-  s.description = %q{Library to assist in writing Notify.io application}
+  s.date = %q{2010-01-31}
+  s.description = %q{helps you write applications that can send notifications to Notify.io}
   s.email = %q{hunter.gillane@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,8 +23,11 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "examples/simple.rb",
      "lib/ruby-libnio.rb",
      "ruby-libnio.gemspec",
+     "spec/libnio-spec.rb",
+     "spec/spec_helper.rb",
      "test/helper.rb",
      "test/test_ruby-libnio.rb"
   ]
@@ -32,10 +35,13 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Library to assist in writing Notify.io application}
+  s.summary = %q{helps you write applications that can send notifications to Notify.io}
   s.test_files = [
-    "test/helper.rb",
-     "test/test_ruby-libnio.rb"
+    "spec/libnio-spec.rb",
+     "spec/spec_helper.rb",
+     "test/helper.rb",
+     "test/test_ruby-libnio.rb",
+     "examples/simple.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/libnio-spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe LibNio do
+  before(:each) do
+    @klass = Class.new
+    @klass.instance_eval { include LibNio }
+  end 
+  c
+  it "should mix in HTTParty" do
+    @klass.include?(HTTParty).should == true
+  end
+  
+  it "should set the base uri" do
+    @klass.base_uri.should == 'http://api.notify.io'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ruby-libnio')
+gem 'rspec'
+require 'spec/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-libnio
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Hunter Gillane
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 -08:00
+date: 2010-01-31 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.4.5
     version: 
-description: Library to assist in writing Notify.io application
+description: helps you write applications that can send notifications to Notify.io
 email: hunter.gillane@gmail.com
 executables: []
 
@@ -38,8 +38,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/simple.rb
 - lib/ruby-libnio.rb
 - ruby-libnio.gemspec
+- spec/libnio-spec.rb
+- spec/spec_helper.rb
 - test/helper.rb
 - test/test_ruby-libnio.rb
 has_rdoc: true
@@ -69,7 +72,10 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Library to assist in writing Notify.io application
+summary: helps you write applications that can send notifications to Notify.io
 test_files: 
+- spec/libnio-spec.rb
+- spec/spec_helper.rb
 - test/helper.rb
 - test/test_ruby-libnio.rb
+- examples/simple.rb