rushover 0.0.1 → 0.0.2

data/README.md

@@ -23,7 +23,8 @@ Or install it yourself as:
 require "rushover"
 
 client = Rushover::Client.new(your_app_token)
-client.notify(user_key, "some message", :priority => 1, :title => "a title!")
+resp = client.notify(user_key, "some message", :priority => 1, :title => "a title!")
+resp.ok? # => true
 
 # Also provides a User class for convenience.  Just keeps the user key
 # around if you want to deal with a User object
@@ -33,8 +34,9 @@ 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.
+Calls to `#notify` will return a `Rushover::Response`.  Pushover app uses
+:status => 1 for success, 0 for failures. The response can be checked for
+success with `#ok?`, or mined like a plain old hash.
 
 ## Contributing
 

data/lib/rushover.rb

@@ -15,12 +15,14 @@ module Rushover
     def notify(user_key, message, options = {})
       data = { :token => token, :user => user_key, :message => message }
       data.merge!(options)
-      begin
+      data = 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
+
+      Response.new(data)
     end
   end
 
@@ -36,4 +38,32 @@ module Rushover
       client.notify(key, message, options)
     end
   end
+
+  class Response
+    attr_accessor :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def [](key)
+      @data[key.to_s]
+    end
+
+    def ok?
+      self["status"].to_i == 1
+    end
+
+    def inspect
+      @data.inspect
+    end
+
+    def to_s
+      @data.to_s
+    end
+
+    def to_h
+      @data.dup
+    end
+  end
 end

data/lib/rushover/version.rb

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

data/test/rushover_client_test.rb

@@ -33,7 +33,7 @@ class RushoverClientTest < RushoverTest
 
     test "successful notify" do
       resp = client.notify("test_user", "test message")
-      assert_equal({"status" => 1}, resp)
+      assert_equal 1, resp["status"]
     end
 
     test "failed notify" do
@@ -48,7 +48,8 @@ class RushoverClientTest < RushoverTest
 
   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)
+      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

data/test/rushover_response_test.rb

@@ -0,0 +1,41 @@
+require File.expand_path("../test_helper", __FILE__)
+
+class RushoverResponseTest < RushoverTest
+  def data
+    @data ||= { "status" => 1 }
+  end
+
+  test "initializing with a response data" do
+    response = Rushover::Response.new(data)
+    assert_equal data, response.data
+  end
+
+  test "delegates [] lookups to the response hash" do
+    data = { "status" => 1, "foo" => "bar" }
+    response = Rushover::Response.new(data)
+    assert_equal 1, response["status"]
+    assert_equal "bar", response[:foo]
+  end
+
+  test "checking if ok?" do
+    response = Rushover::Response.new(data)
+    assert response.ok?
+    response.data = { "status" => 0 }
+    refute response.ok?
+  end
+
+  test "inspect delegates to the data" do
+    response = Rushover::Response.new(data)
+    assert_equal data.inspect, response.inspect
+  end
+
+  test "to_s delegates to the data" do
+    response = Rushover::Response.new(data)
+    assert_equal data.to_s, response.to_s
+  end
+
+  test "to_h returns the data" do
+    response = Rushover::Response.new(data)
+    assert_equal data, response.to_h
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rushover
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2164476560 !ruby/object:Gem::Requirement
+  requirement: &2160386140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164476560
+  version_requirements: *2160386140
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2164476140 !ruby/object:Gem::Requirement
+  requirement: &2160385720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164476140
+  version_requirements: *2160385720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2164475720 !ruby/object:Gem::Requirement
+  requirement: &2160385300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164475720
+  version_requirements: *2160385300
 - !ruby/object:Gem::Dependency
   name: contest
-  requirement: &2164475300 !ruby/object:Gem::Requirement
+  requirement: &2160384880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164475300
+  version_requirements: *2160384880
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2164474880 !ruby/object:Gem::Requirement
+  requirement: &2160384460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2164474880
+  version_requirements: *2160384460
 description: A simple ruby Pushover client
 email:
 - xternal1+github@gmail.com
@@ -82,6 +82,7 @@ files:
 - lib/rushover/version.rb
 - rushover.gemspec
 - test/rushover_client_test.rb
+- test/rushover_response_test.rb
 - test/rushover_user_test.rb
 - test/test_helper.rb
 homepage: ''
@@ -98,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2170637214120495203
+      hash: -3386476054685149572
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2170637214120495203
+      hash: -3386476054685149572
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15
@@ -116,5 +117,6 @@ specification_version: 3
 summary: A simple ruby Pushover client
 test_files:
 - test/rushover_client_test.rb
+- test/rushover_response_test.rb
 - test/rushover_user_test.rb
 - test/test_helper.rb