smulube-notifo 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jonathan Markwell
+
+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,28 @@
+= notifo
+
+A library for using Notifo. Notifo is a way for users to receive mobile notifications for anything, more at http://notifo.com. This gem uses John Nunemaker's awesome HTTParty.
+
+== Installing
+    $ gem install notifo
+
+== Using notifo
+
+    require 'rubygems'
+    require 'notifo'
+    notifo = Notifo.new("YOUR_NOTIFO_SERVICE_USERNAME","YOUR_NOTIFO_SERVICE_APISECRET")
+    notifo.subscribe_user("A_NOTIFO_USERNAME")
+    notifo.send_notification("A_SUBSCRIBED_NOTIFO_USERNAME","A MESSAGE")
+    notifo.send_message("A_SUBSCRIBED_NOTIFO_USERNAME", "A MESSAGE")
+    notifo.verify_webhook_signature(post_params_hash)
+    
+== 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 Jonathan Markwell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "smulube-notifo"
+    gem.summary = "A library for using the Notifo iPhone notifications service."
+    gem.description = "A library for using Notifo. Notifo is a way for users to receive mobile notifications for anything, more at http://notifo.com. This gem uses John Nunemaker's awesome HTTParty."
+    gem.email = "jonathan.markwell@gmail.com"
+    gem.homepage = "http://github.com/jot/notifo"
+    gem.authors = ["Jonathan Markwell"]
+    gem.add_dependency "httparty", "~>0.4.5"
+    gem.add_development_dependency "shoulda"
+    gem.add_development_dependency "fakeweb"
+    # 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: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "notifo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/notifo.rb

@@ -0,0 +1,75 @@
+require 'httparty'
+require 'cgi'
+require 'digest/sha1'
+
+# Simple client class for the Notifo API.
+class Notifo
+  include HTTParty
+  base_uri 'https://api.notifo.com/v1'
+
+  # Create a new client instance. Must be supplied with the username and
+  # api_secret for your service.
+  #
+  # Required Parameters:
+  # username - notifo service username
+  # api_secret - notifo service api secret
+  def initialize(username, api_secret)
+    @auth = { :username => username, :password => api_secret }
+  end
+  
+  # Subscribe a user to your service. This sends them a message confirming they 
+  # want to use the service.
+  #
+  # Required Parameters:
+  # username - notifo username to subscribe to your service
+  def subscribe_user(username)
+    options = { :body => { :username => username }, :basic_auth => @auth }
+    self.class.post("/subscribe_user", options)
+  end
+  
+  # Send a notification to the specified user. You will only be allowed to send
+  # notifications to users who have previously subscribed to your service.
+  #
+  # Required Parameters:
+  # username - notifo username of recipient
+  # message - message being sent; must be url encoded
+  #
+  # Optional Parameters:
+  # title - name of "notification event"
+  # uri - the uri that will be loaded when the notification is opened; if specified, must be urlencoded; if a web address, must start with http:// or https://
+  # label - label describing the "application" (used only if being sent from a User account; the Service label is automatically applied if being sent from a Service account) 
+  def send_notification(username, message, title = nil, uri = nil, label = nil)
+    options = { :body => {:to => username, :msg => message, :label => title, :title => title, :uri => uri}, :basic_auth => @auth }
+    self.class.post('/send_notification', options)
+  end
+
+  def post(username, message, title = nil, uri = nil, label = nil) # :ndoc:
+    warn "DEPRECATION WARNING: the 'post' method is deprecated. Use 'send_notification' instead"
+    send_notification(username, message, title, uri, label)
+  end
+
+  # Required Parameters:
+  # params - the hash of params the webhook passed to you. All keys must be *Strings*, not symbols.
+  def verify_webhook_signature(params)
+    signature = params['notifo_signature']
+    other_notifo_params = params.reject {|key,val| !(key =~ /\Anotifo_/ && key != "notifo_signature")}
+    str = other_notifo_params.keys.sort.map do |key|
+      params[key]
+    end.join
+    str << @auth[:password]
+
+    signature == Digest::SHA1.hexdigest(CGI::escape(str))
+  end
+
+  # Send a message to a specific Notifo user. Messages are slightly different
+  # from notifications in that they are permitted to be sent to users who
+  # haven't subscribed.
+  #
+  # Required Parameters:
+  # username - notifo username of recipient
+  # message - message being sent; must be url encoded
+  def send_message(username, message)
+    options = { :body => { :to => username, :msg => message }, :basic_auth => @auth }
+    self.class.post('/send_message', options)
+  end
+end

data/smulube-notifo.gemspec

@@ -0,0 +1,61 @@
+# 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{smulube-notifo}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jonathan Markwell"]
+  s.date = %q{2011-02-03}
+  s.description = %q{A library for using Notifo. Notifo is a way for users to receive mobile notifications for anything, more at http://notifo.com. This gem uses John Nunemaker's awesome HTTParty.}
+  s.email = %q{jonathan.markwell@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/notifo.rb",
+     "smulube-notifo.gemspec",
+     "test/assets/webhook_params.yaml",
+     "test/notifo_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jot/notifo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A library for using the Notifo iPhone notifications service.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/notifo_test.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_runtime_dependency(%q<httparty>, ["~> 0.4.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, ["~> 0.4.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, ["~> 0.4.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+  end
+end
+

data/test/assets/webhook_params.yaml

@@ -0,0 +1,10 @@
+--- 
+notifo_service: Message
+notifo_title: ""
+notifo_uri: http://test.com/
+notifo_to_username: testing42
+notifo_signature: 853bbc06ccae3491f3b9e5617f8b2b9dce6f65d5
+notifo_unix_time: "1278988965"
+notifo_message: Test
+notifo_id: "1043960"
+notifo_webhook_url: http://jackowayed-notifo.oncloud.org/

data/test/notifo_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class NotifoTest < Test::Unit::TestCase
+
+  context "setup test environment correctly" do
+    should "have substituted the username and password into the NOTIFO_BASE_URI constant" do
+      assert_equal "https://#{NOTIFO_USERNAME}:#{NOTIFO_API_SECRET}@api.notifo.com/v1", NOTIFO_BASE_URI
+    end
+  end
+
+  context "container context" do
+    setup do
+      @response = '{"status":"success","response_code":2201,"response_message":"OK"}'
+    end
+
+    context "#verify_webhook_sigature" do
+      should "return true if given the right API secret" do
+        assert NOTIFO.verify_webhook_signature(WEBHOOK)
+      end
+  
+      should "return false if given the wrong API secret" do
+        bad_notifo = Notifo.new NOTIFO_USERNAME, 'thisisntthesecret'
+        assert !bad_notifo.verify_webhook_signature(WEBHOOK)
+      end
+    end
+
+    context "#subscribe user successfully" do
+      setup do
+        FakeWeb.register_uri(:post, "#{NOTIFO_BASE_URI}/subscribe_user", :body => @response)
+      end
+
+      should "subscribe the user" do
+        assert_equal @response, NOTIFO.subscribe_user("user") 
+      end
+    end
+  
+    context "#send_message successfully" do
+      setup do
+        FakeWeb.register_uri(:post, "#{NOTIFO_BASE_URI}/send_message", :body => @response)
+      end
+  
+      should "send message to another user via notifo" do
+        assert_equal @response, NOTIFO.send_message("user", "message")
+      end
+    end
+  
+    context "#send_notification successfully" do
+      setup do
+        FakeWeb.register_uri(:post, "#{NOTIFO_BASE_URI}/send_notification", :body => @response)
+      end
+
+      should "send notification using the new send_notification method" do
+        assert_equal @response, NOTIFO.send_notification("user", "message", "title", "http://google.com", "label")
+      end
+
+      should "send notification using the old post method" do
+        assert_equal @response, NOTIFO.post("user", "message", "title", "http://google.com", "label")
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'notifo'
+
+class Test::Unit::TestCase
+end
+
+NOTIFO_USERNAME = 'testing42'
+NOTIFO_API_SECRET = 'x96cb52807a33bafc8fd741eeba5e40ff89f05896'
+
+NOTIFO = Notifo.new NOTIFO_USERNAME, NOTIFO_API_SECRET
+NOTIFO_BASE_URI = Notifo.base_uri.gsub(/(https:\/\/)(.+)/, "\\1#{NOTIFO_USERNAME}:#{NOTIFO_API_SECRET}@\\2")
+
+FakeWeb.allow_net_connect = false
+
+WEBHOOK = YAML::load(File.read('test/assets/webhook_params.yaml'))

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: smulube-notifo
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jonathan Markwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-03 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 4
+        - 5
+        version: 0.4.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A library for using Notifo. Notifo is a way for users to receive mobile notifications for anything, more at http://notifo.com. This gem uses John Nunemaker's awesome HTTParty.
+email: jonathan.markwell@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/notifo.rb
+- smulube-notifo.gemspec
+- test/assets/webhook_params.yaml
+- test/notifo_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jot/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: A library for using the Notifo iPhone notifications service.
+test_files: 
+- test/test_helper.rb
+- test/notifo_test.rb