self-notifo 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gaelian Ditchburn
+
+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.rdoc

@@ -0,0 +1,49 @@
+= self-notifo
+
+The self-notifo gem allows you to send Notifo (http://notifo.com) notifications to your own Notifo account from your Rails app.
+
+== Installation
+    $ gem install self-notifo
+
+== Usage
+Sign up for a Notifo account (it's free). Take note of your API Username and API Secret (find on your account settings page on the Notifo site)
+
+cd into your Rails app and run:
+
+    ./script/generate self_notifo NOTIFO_USERNAME NOTIFO_API_SECRET "Label Describing Your Application"
+
+This will generate a file called self-notifo.yml in your config directory (you may wish to add this file to .gitignore or equivalent).
+
+When you want to send a notification from your Rails app:
+
+    SelfNotifo(:msg => "My message.")
+
+Optional parameters can be added:
+
+    SelfNotifo.new(:msg => "My message.", :title => "My Notification Title", :uri => "http://some.com")
+
+You can also override the settings in self-notifo.yml:
+
+    SelfNotifo.new(:msg => "My message.", :title => "My Notification Title", :uri => "http://some.com", :label => 'My Label' :username => 'USERNAME', :api_secret => 'API_SECRET')
+
+See https://api.notifo.com/docs/notifications for more info on the Notifo API.
+
+== Dependencies
+
+John Nunemaker's awesome httparty[http://github.com/jnunemaker/httparty].
+
+Ruby on Rails, version 2.3.6 or newer.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Gaelian Ditchburn. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "self-notifo"
+    gem.summary = %Q{Send yourself real-time notifications from your Rails app using Notifo.}
+    gem.description = %Q{The self-notifo gem sends notifications to your own Notifo account from your Rails application.}
+    gem.email = "gaelian.ditchburn@gmail.com"
+    gem.homepage = "http://github.com/gaelian/self-notifo"
+    gem.authors = ["Gaelian Ditchburn"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency('httparty', '>= 0.6.1')
+    gem.add_dependency('rails', '>= 2.3.6')
+    gem.files = Dir["{lib,generators}/**/*"] + %w{ Rakefile self-notifo.gemspec VERSION }
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "self-notifo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/generators/self_notifo/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Generates a self-notifo.yml config file in the config directory of your Rails app.
+
+	Example:
+	    `./script/generate self_notifo "NOTIFO_USERNAME" "NOTIFO_API_SECRET" "Name of Your Rails App"`

data/generators/self_notifo/self_notifo_generator.rb

@@ -0,0 +1,7 @@
+class SelfNotifoGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.template 'self-notifo.yml', 'config/self-notifo.yml'
+    end
+  end
+end

data/generators/self_notifo/templates/self-notifo.yml

@@ -0,0 +1,4 @@
+label: <%= actions[1] %>
+auth:
+  username: <%= name %>
+  api_secret: <%= actions[0] %>

data/lib/self-notifo.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+require 'yaml'
+
+class SelfNotifo
+  include HTTParty
+  format :json
+
+  # Pass in a hash when creating a new instance:
+  # SelfNotifo.new(:msg => "My message.")
+  # Optional parameters can be added:
+  # SelfNotifo.new(:msg => "My message.", :label => "My Label", :title => "My Title", :uri => "http://some-relevant-address.com")
+  # The message label defaults to the value set in self-notifo.yml
+  def initialize(params)
+    begin
+      config = YAML.load_file("#{Rails.root}/config/self-notifo.yml")
+      username = config['auth']['username']
+      api_secret = config['auth']['api_secret']
+      params[:label] = config['label'] if params[:label].blank?
+    rescue Errno::ENOENT
+      if params[:username].blank? && params[:api_secret].blank?
+        raise 'Config file "self-notifo.yml" not found, have you generated it?'
+      else
+        username = params[:username]
+        api_secret = params[:api_secret]
+      end
+    end
+    self.class.basic_auth username, api_secret
+    send_notification(params)
+  end
+
+  private
+
+    def logger
+      RAILS_DEFAULT_LOGGER
+    end
+
+    def send_notification(params)
+      r = self.class.post('https://api.notifo.com/v1/send_notification', { :body => { :msg => params[:msg], :label => params[:label], :title => params[:title], :uri => params[:uri] } })
+      logger.info "self-notifo: sent notification, response was: " + r.parsed_response.inspect
+    end
+end

data/self-notifo.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{self-notifo}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gaelian Ditchburn"]
+  s.date = %q{2010-09-18}
+  s.description = %q{The self-notifo gem sends notifications to your own Notifo account from your Rails application.}
+  s.email = %q{gaelian.ditchburn@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "Rakefile",
+     "VERSION",
+     "generators/self_notifo/USAGE",
+     "generators/self_notifo/self_notifo_generator.rb",
+     "generators/self_notifo/templates/self-notifo.yml",
+     "lib/self-notifo.rb",
+     "self-notifo.gemspec"
+  ]
+  s.homepage = %q{http://github.com/gaelian/self-notifo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Send yourself real-time notifications from your Rails app using Notifo.}
+  s.test_files = [
+    "spec/self_notifo_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_runtime_dependency(%q<rails>, [">= 2.3.6"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<rails>, [">= 2.3.6"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<rails>, [">= 2.3.6"])
+  end
+end
+

data/spec/self_notifo_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SelfNotifo, "#initialize" do
+  it "should raise exception when required parameters are not found" do
+    expect{ SelfNotifo.new(:msg => "Test message.") }.to raise_error(RuntimeError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'self-notifo'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+module Rails
+  def self.root
+    ''
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: self-notifo
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Gaelian Ditchburn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-18 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 3
+        - 6
+        version: 2.3.6
+  type: :runtime
+  version_requirements: *id003
+description: The self-notifo gem sends notifications to your own Notifo account from your Rails application.
+email: gaelian.ditchburn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- Rakefile
+- VERSION
+- generators/self_notifo/USAGE
+- generators/self_notifo/self_notifo_generator.rb
+- generators/self_notifo/templates/self-notifo.yml
+- lib/self-notifo.rb
+- self-notifo.gemspec
+- LICENSE
+- README.rdoc
+- spec/self_notifo_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/gaelian/self-notifo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Send yourself real-time notifications from your Rails app using Notifo.
+test_files: 
+- spec/self_notifo_spec.rb
+- spec/spec_helper.rb