rushover 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rushover.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brendon Murphy
+
+MIT License
+
+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.md

@@ -0,0 +1,45 @@
+# Rushover
+
+A simple ruby [Pushover](https://pushover.net/) client.  Pushover allows
+sending simple push notifications to clients on iOS and Android devices.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rushover'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rushover
+
+## Usage
+
+```ruby
+require "rushover"
+
+client = Rushover::Client.new(your_app_token)
+client.notify(user_key, "some message", :priority => 1, :title => "a title!")
+
+# Also provides a User class for convenience.  Just keeps the user key
+# around if you want to deal with a User object
+user = Rushover::User.new(user_key, rushover_client)
+user.notify("some user message", :title => "another title")
+```
+
+Optional params to the Pushover like `priority` or `title` are passed through.
+
+Calls to `#notify` will return the parsed JSON response body.  Pushover app uses
+:status => 1 for success, 0 for failures.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList["test/*_test.rb"]
+  t.ruby_opts << '-Itest -Ilib'
+end
+task :default => :test

data/lib/rushover.rb

@@ -0,0 +1,39 @@
+require "rushover/version"
+require "rest-client"
+require "json"
+
+module Rushover
+  class Client
+    MESSAGES_ENDPOINT = "https://api.pushover.net/1/messages.json".freeze
+
+    attr_accessor :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def notify(user_key, message, options = {})
+      data = { :token => token, :user => user_key, :message => message }
+      data.merge!(options)
+      begin
+        resp = RestClient.post MESSAGES_ENDPOINT, data.to_json, :content_type => "application/json"
+        JSON.parse(resp)
+      rescue RestClient::Exception => e
+        JSON.parse(e.response)
+      end
+    end
+  end
+
+  class User
+    attr_accessor :key, :client
+
+    def initialize(key, client)
+      @key = key
+      @client = client
+    end
+
+    def notify(message, options = {})
+      client.notify(key, message, options)
+    end
+  end
+end

data/lib/rushover/version.rb

@@ -0,0 +1,3 @@
+module Rushover
+  VERSION = "0.0.1"
+end

data/rushover.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rushover/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brendon Murphy"]
+  gem.email         = ["xternal1+github@gmail.com"]
+  gem.summary       = %q{A simple ruby Pushover client}
+  gem.description   = gem.summary
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rushover"
+  gem.require_paths = ["lib"]
+  gem.version       = Rushover::VERSION
+
+  gem.add_dependency "json"
+  gem.add_dependency "rest-client"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "contest"
+  gem.add_development_dependency "fakeweb"
+end
+

data/test/rushover_client_test.rb

@@ -0,0 +1,58 @@
+require File.expand_path("../test_helper", __FILE__)
+
+class RushoverClientTest < RushoverTest
+  def client
+    Rushover::Client.new("test_api_token")
+  end
+
+  test "it initializes with a token" do
+    subject = Rushover::Client.new("foobar")
+    assert_equal "foobar", subject.token
+  end
+
+  context "with mandatory params" do
+    setup do
+      client.notify("test_user", "test message")
+    end
+
+    test "sending a message hits the messages.json endpoint" do
+      assert_equal "/1/messages.json", FakeWeb.last_request.path
+    end
+
+    test "sending a message uses the token" do
+      assert_equal "test_api_token", last_request_json["token"]
+    end
+
+    test "sending a message to the intended user" do
+      assert_equal "test_user", last_request_json["user"]
+    end
+
+    test "sending a notification includes the message" do
+      assert_equal "test message", last_request_json["message"]
+    end
+
+    test "successful notify" do
+      resp = client.notify("test_user", "test message")
+      assert_equal({"status" => 1}, resp)
+    end
+
+    test "failed notify" do
+      FakeWeb.register_uri(:post, "https://api.pushover.net/1/messages.json",
+                           :body => { "message" => "cannot be blank", "status" => 0 }.to_json,
+                           :content_type => "application/json", :status => ["400", "Bad request"])
+      resp = client.notify("test_user", nil)
+      assert_equal 0, resp["status"]
+      assert_equal "cannot be blank", resp["message"]
+    end
+  end
+
+  context "with optional params" do
+    test "basic optional params" do
+      client.notify("test_user", "test message", :device => "test device", :title => "test title", :priority => 1, :timestamp => 123123)
+      assert_equal "test device", last_request_json["device"]
+      assert_equal "test title", last_request_json["title"]
+      assert_equal "1", last_request_json["priority"].to_s
+      assert_equal "123123", last_request_json["timestamp"].to_s
+    end
+  end
+end

data/test/rushover_user_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path("../test_helper", __FILE__)
+
+class RushoverUserTest < RushoverTest
+  def client
+    Rushover::Client.new("test_api_token")
+  end
+
+  setup do
+    @user = Rushover::User.new("user_key", client)
+  end
+
+  test "it initializes with a user key and client" do
+    assert_equal "user_key", @user.key
+    assert @user.client
+  end
+
+  test "notifying the user via the client" do
+    @user.notify("test user message", :priority => 1)
+    assert_equal "test user message", last_request_json["message"]
+    assert_equal "1", last_request_json["priority"].to_s
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require "test/unit"
+require "contest"
+require "fakeweb"
+require "rushover"
+
+FakeWeb.allow_net_connect = false
+
+class RushoverTest < Test::Unit::TestCase
+  setup do
+    FakeWeb.register_uri(:post, "https://api.pushover.net/1/messages.json", :body => { :status => 1 }.to_json, :content_type => "application/json")
+  end
+
+  teardown do
+    FakeWeb.clean_registry
+  end
+
+  def last_request_json
+    JSON.parse(FakeWeb.last_request.body)
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rushover
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2164476560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164476560
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2164476140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164476140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2164475720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164475720
+- !ruby/object:Gem::Dependency
+  name: contest
+  requirement: &2164475300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164475300
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2164474880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164474880
+description: A simple ruby Pushover client
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rushover.rb
+- lib/rushover/version.rb
+- rushover.gemspec
+- test/rushover_client_test.rb
+- test/rushover_user_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2170637214120495203
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2170637214120495203
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A simple ruby Pushover client
+test_files:
+- test/rushover_client_test.rb
+- test/rushover_user_test.rb
+- test/test_helper.rb