boxcar_publisher 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faa4a93da71f1e0fa2f7f8c6c2e0dd3d8cde0424
-  data.tar.gz: a1d2deff6ade74808d9ef26a1495e82b0b6acb3c
+  metadata.gz: 2b985b49865d8beec8fff112190e0511d650bff3
+  data.tar.gz: f11f1c40339da2e7c88993f6477e9a13b9911896
 SHA512:
-  metadata.gz: 46e97b377eec7f1fe9106d65bad9042ea90165a74bfc83b3cfb2ef81168f7fc72a6055d36cc581a59d28e6c2a1772fe1875a19885685b72a3fa2052d7765bea7
-  data.tar.gz: 0e0b236480b4d50dfd7513402a6f6a68638adf17d8f53970f2c79c58aaeb45cba6d415d9e672189a1f381541dd4e484128d488b20cadf3d574ec4c8748fe4ec6
+  metadata.gz: b0d816dd768bf814133d443cee6af6fc3bb050251526a52dcf64075433dd817e3bd76f2333be8b50839e319815290b750619b38fe47571eb392b23cae2445cdf
+  data.tar.gz: c03a9703f2a56858971d1bc7baef973fa87b2a47ee3373895bc41aabf7922177eea4efcd0d7ad81c1f687869d93141dcd2358def9a0f81b774c2666a6f81bf36

data/README.md

@@ -1,25 +1,38 @@
 boxcar\_publisher
 =================
 
+A simple Ruby interface to the [Boxcar Push API](http://developer.boxcar.io/api/publisher/).
+
 Installation
 -----
 
-```
+```ruby
 gem install boxcar_publisher
 ```
 
 Usage
 -----
 
-```
+```ruby
 BoxcarPublisher.setup do |config|
   config.access_key 'THIS_IS_MY_ACCESS_KEY'
   config.secret_key 'THIS_IS_MY_SECRET_KEY'
 end
 
+# Create a new push notification (POST /api/push)
+# Returns a BoxcarPublisher::Push instance
 push = BoxcarPublisher::Push.new aps: { alert: 'Hello world' }, tags: ['@all'], id: '12345'
+# => #<BoxcarPublisher::Push:0x007f8491892ea8 @id="472317", @url="http://boxcar-api.io/api/push/472317">
 push.id
 # => 12345
+
+# Get the state of an existing push (GET /api/push/{id})
+# Returns a hash with the current state of the push
 push.state
 # => {:state=>"delivered", :created_at=>2015-05-27 22:28:10 -0700, :last_delivered_at=>2015-05-27 22:28:10 -0700, :sent=>1, :errors=>0, :opened=>0}
+
+# Delete a queued push (DELETE /api/push/{id})
+# Returns nil on success; raises an error on failure
+push.delete
+# => nil
 ```

data/boxcar_publisher.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name         = 'boxcar_publisher'
-  spec.version      = '1.0.0'
+  spec.version      = '1.0.1'
   spec.date         = Date.today.to_s
   spec.summary      = "Publisher API for boxcar.io"
   spec.description  = "Send push notifications with Boxcar.io"

data/lib/boxcar_publisher.rb

@@ -51,5 +51,10 @@ class BoxcarPublisher
         end
       end
     end
+
+    def delete
+      result = BoxcarPublisher._conn.delete "push/#{id}"
+      raise "Expected repsonse to have HTTP status 202, received #{result.status}" unless result.status == 202
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxcar_publisher
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tony Novak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- boxcar_publisher-1.0.0.gem
 - boxcar_publisher.gemspec
 - lib/boxcar_publisher.rb
 homepage: http://rubygems.org/gems/boxcar_publisher