zero_push 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eccff0e44935d797e6160a61ef05064ede94bcb
-  data.tar.gz: 0efedf88080e645e9d6cfd2d078402a25ff395e9
+  metadata.gz: 53395004125fe3080de63c22f54cf1c0a5bb03d3
+  data.tar.gz: 75b2fa3bb0bebfe3ced3da55a7574e3c837fba6e
 SHA512:
-  metadata.gz: 51d67f43b23eb7b775b719949a2e3315c43d317904171e7e898090639ff2c05122ea015751f192a8db76caa42d34939b3df1e33b1485793182f09696799b79c1
-  data.tar.gz: e44908c18525b36e72c94e428415bf97004ee734b52f057a8d52c9afe79d10165602eb8a46cfc7e44cb38ca317aff77c78338487305c3e02ed00b03d946b27f7
+  metadata.gz: 2d7aa1ff0fc3e1ef9929b980a8e09bfb974f833ab9195d989901e33dab01646709199e1a4c1eef38cf069205ac84e74f8f275a8cf53ef0eebbd8b8ed391e2b39
+  data.tar.gz: 57999b89d6297aea450bd392603c13e51e7f806966dc95c2f8e5142f940f2255e1db6ff0f2a7d42da91ea3cd4cb4354849e5139dc82e6fbdd83fe65c5616774b

data/.travis.yml

@@ -3,6 +3,8 @@ language: ruby
 rvm:
 - 1.9.3
 - 2.0.0
+- 2.1.1
+- 2.2.0
 - jruby-19mode
 notifications:
   email:

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 2.5.0 (2015-01-28)
+
+Features:
+
+* add endpoints `/devices`, `/device/{token}`, `/channels`, and `/channels/{channel_name}`
+* add ability to configure with multiple device tokens.
+* update http client to use JSON parameter encoding.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zero_push (2.4.0)
+    zero_push (2.5.0)
       faraday (~> 0.9.0)
       faraday_middleware (~> 0.9.0)
 
@@ -23,8 +23,11 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
+    addressable (2.3.6)
     builder (3.2.2)
     coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     erubis (2.7.0)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
@@ -53,11 +56,15 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.3.2)
+    safe_yaml (1.0.4)
     slop (3.4.7)
     thor (0.19.1)
     thread_safe (0.3.4)
     tzinfo (1.2.1)
       thread_safe (~> 0.1)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
@@ -69,4 +76,5 @@ DEPENDENCIES
   pry
   railties (~> 4.1.4)
   rake (~> 10.3.2)
+  webmock (~> 1.20.4)
   zero_push!

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,6 @@
-Copyright (c) 2014 Symmetric Infinity LLC
+## License
+
+Copyright (c) 2015 Symmetric Infinity LLC
 
 MIT License
 
@@ -20,3 +22,4 @@ 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

@@ -1,6 +1,6 @@
 [![ZeroPush](https://raw.github.com/ZeroPush/zero_push/master/zeropush-header.png)](https://zeropush.com)
 
-Build Status: [![Build Status](https://travis-ci.org/ZeroPush/zero_push.png?branch=master)](https://travis-ci.org/ZeroPush/zero_push)
+[![Build Status](http://img.shields.io/travis/ZeroPush/zero_push.svg)](https://travis-ci.org/ZeroPush/zero_push) [![Code Climate](https://codeclimate.com/github/ZeroPush/zero_push/badges/gpa.svg)](https://codeclimate.com/github/ZeroPush/zero_push) [![Gem Version](http://img.shields.io/gem/v/zero_push.svg)](http://rubygems.org/gems/zero_push)
 
 ## Installation
 
@@ -25,21 +25,50 @@ Generate the ZeroPush initializer if you are using Ruby on Rails.
 
 ### API Client
 
-The easiest way to use the API client is to set the auth token at the module level and call methods on the ZeroPush module.
+The easiest way to use the API client is to set the server `auth_token` at the module level and call methods on the ZeroPush module. You can find the token on settings page for your app.
 
-    ZeroPush.auth_token = 'your-auth-token'
-    ZeroPush.verify_credentials
-    => true
+```ruby
+  ZeroPush.auth_token = 'iosprod_your-server-token'
+  ZeroPush.verify_credentials
+  => true
+  ZeroPush.notify(device_tokens: ['abcdef'], alert: 'hello, world', badge: '+1')
+```
 
-If your application requires multiple API client instances, that can be achieved as well.
+If your web application supports must support multiple mobile apps, you may configure it like this:
 
-    client_1 = ZeroPush.client('auth-token-1')
-    client_1.verify_credentials
-    => true
+```ruby
+  if Rails.env == 'development'  #or ENV['RACK_ENV']
+    ZeroPush.auth_tokens = {
+      apns: 'iosdev_XYZ',
+      gcm: 'gcmdev_ABC',
+    }
+  else
+    ZeroPush.auth_tokens = {
+      apns: 'iosprod_XYZ',
+      gcm: 'gcmprod_ABC',
+    }
+  end
+```
 
-    client_2 = ZeroPush.client('auth-token-2')
-    client_2.verify_credentials
-    => true
+You may then instantiate clients by calling the method that matches the auth token key:
+
+```ruby
+  ZeroPush.apns.broadcast( ... )
+  ZeroPush.gcm.broadcast( ... )
+```
+
+
+Lastly, if you have many apps you may instantiate clients API Clients
+
+```ruby
+  client_1 = ZeroPush.client('iosprod_app-server-token-1')
+  client_1.broadcast(alert: 'hello, app1')
+
+  client_2 = ZeroPush.client('iosprod_app-server-token-2')
+  client_1.broadcast(alert: 'hello, app2')
+```
+
+Methods supported by this gem and their parameters can be found in the [API Reference](https://zeropush.com/documentation/api_reference)
 
 For more documentation, check our [Getting Started Guide with ZeroPush](https://zeropush.com/documentation)
 
@@ -51,29 +80,3 @@ For more documentation, check our [Getting Started Guide with ZeroPush](https://
 1. Commit your changes (`git commit -am 'Add some feature'`)
 1. Push to the branch (`git push origin my-new-feature`)
 1. Create new Pull Request
-
-## License
-
-Copyright (c) 2014 Symmetric Infinity LLC
-
-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/lib/zero_push.rb

@@ -4,46 +4,40 @@ require 'faraday'
 
 module ZeroPush
   class << self
-    attr_accessor :auth_token
+    extend Forwardable
+    attr_accessor :auth_token, :auth_tokens, :config
+
+    def_delegators :client,
+      :verify_credentials,
+      :notify,
+      :broadcast,
+      :subscribe,
+      :unsubscribe,
+      :register,
+      :unregister,
+      :set_badge,
+      :inactive_tokens,
+      :devices,
+      :set_device,
+      :update_device,
+      :channels,
+      :channel,
+      :delete_channel
 
-    def verify_credentials
-      client.verify_credentials
-    end
-
-    def notify(params)
-      client.notify(params)
-    end
-
-    def broadcast(params)
-      client.broadcast(params)
-    end
-
-    def subscribe(device_token, channel)
-      client.subscribe(device_token, channel)
-    end
-
-    def unsubscribe(device_token, channel)
-      client.unsubscribe(device_token, channel)
-    end
-
-    def register(device_token, channel=nil)
-      client.register(device_token, channel)
-    end
-
-    def unregister(device_token)
-      client.unregister(device_token)
-    end
-
-    def set_badge(device_token, badge)
-      client.set_badge(device_token, badge)
+    def client(auth_token = self.auth_token)
+      ZeroPush::Client.new(auth_token)
     end
 
-    def inactive_tokens
-      client.inactive_tokens
+    def config
+      @config ||= {:http_adapter => Faraday.default_adapter, request_encoding: :json}
     end
 
-    def client(auth_token = self.auth_token)
-      ZeroPush::Client.new(auth_token)
+    def method_missing(method, *params, &block)
+      if auth_tokens.is_a?(Hash) && auth_tokens.keys.include?(method)
+        self.client(auth_tokens[method])
+      else
+        super
+      end
     end
   end
 end

data/lib/zero_push/client.rb

@@ -1,3 +1,4 @@
+require 'zero_push/compatibility'
 require 'faraday_middleware'
 
 module ZeroPush
@@ -8,13 +9,14 @@ module ZeroPush
 
     def initialize(auth_token)
       self.auth_token = auth_token
+      self.extend(Compatibility)
     end
 
     # verifies credentials
     #
     # @return [Boolean]
     def verify_credentials
-      response = client.get('/verify_credentials')
+      response = http.get('/verify_credentials')
       response.status == 200
     end
 
@@ -22,20 +24,20 @@ module ZeroPush
     #
     # @param params [Hash]
     #
-    # Ex.
+    # Example response
     # {"sent_count":10,"inactive_tokens":[],"unregistered_tokens":["abc"]}
     def notify(params)
-      client.post('/notify', params)
+      http.post('/notify', params)
     end
 
     # Sends a notification to all of the devices registered with the ZeroPush backend
     #
     # @param params [Hash]
     #
-    # Ex.
+    # Example response
     # {"sent_count":10}
     def broadcast(params)
-      client.post('/broadcast', params)
+      http.post('/broadcast', params)
     end
 
     # Subscribes a device to a particular notification channel
@@ -43,10 +45,10 @@ module ZeroPush
     # @param device_token [String]
     # @param channel      [String]
     #
-    # Ex.
+    # Example response
     # {"device_token":"abc", "channels":["foo"]}
     def subscribe(device_token, channel)
-      client.post("/subscribe/#{channel}", device_token:device_token)
+      http.post("/subscribe/#{channel}", device_token:device_token)
     end
 
     # Unsubscribes a device from a particular notification channel
@@ -54,22 +56,22 @@ module ZeroPush
     # @param device_token [String]
     # @param channel      [String]
     #
-    # Ex.
+    # Example response
     # {"device_token":"abc", "channels":[]}
     def unsubscribe(device_token, channel)
-      client.delete("/subscribe/#{channel}", device_token:device_token)
+      http.delete("/subscribe/#{channel}", device_token:device_token)
     end
 
     # Registers a device token with the ZeroPush backend
     #
     # @param device_token
     #
-    # Ex.
+    # Example response
     # {"message":"ok"}
     def register(device_token, channel=nil)
       params = {device_token: device_token}
       params.merge!(channel: channel) unless channel.nil?
-      client.post('/register', params)
+      http.post('/register', params)
     end
 
     # Unregisters a device token that has previously been registered with
@@ -77,10 +79,10 @@ module ZeroPush
     #
     # @param device_token
     #
-    # Ex.
+    # Example response
     # {"message":"ok"}
     def unregister(device_token)
-      client.delete('/unregister', device_token: device_token)
+      http.delete('/unregister', device_token: device_token)
     end
 
     # Sets the badge for a particular device
@@ -88,15 +90,15 @@ module ZeroPush
     # @param device_token
     # @param badge
     #
-    # Ex.
+    # Example response
     # {"message":"ok"}
     def set_badge(device_token, badge)
-      client.post('/set_badge', device_token: device_token, badge: badge)
+      http.post('/set_badge', device_token: device_token, badge: badge)
     end
 
     # Returns a list of tokens that have been marked inactive
     #
-    # Ex.
+    # Example response
     # [
     #   {
     #     "device_token":"238b8cb09011850cb4bd544dfe0c8f5eeab73d7eeaae9bdca59076db4ae49947",
@@ -107,19 +109,160 @@ module ZeroPush
     #     "marked_inactive_at":"2013-07-17T01:27:50-04:00"
     #   }
     # ]
-    def inactive_tokens
-      client.get('/inactive_tokens')
+    def inactive_tokens(params = {page:1})
+      http.get('/inactive_tokens', params)
     end
 
-    # the HTTP client configured for API requests
+    # Returns a paginated list of devices
+    # https://zeropush.com/documentation/api_reference#devices_index
     #
-    def client
+    # Example response
+    # [
+    #   {
+    #     "token": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf",
+    #     "active": true,
+    #     "marked_inactive_at": null,
+    #     "badge": 1
+    #   },
+    #   {
+    #     "token": "234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf0",
+    #     "active": true,
+    #     "marked_inactive_at": null,
+    #     "badge": 2
+    #   }
+    # ]
+    def devices(params = {page:1})
+      http.get('/devices', params)
+    end
+
+    # Return detailed information about a device
+    # https://zeropush.com/documentation/api_reference#devices_show
+    #
+    # Example response
+    # {
+    #   "token": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf",
+    #   "active": true,
+    #   "marked_inactive_at": null,
+    #   "badge": 1,
+    #   "channels": [
+    #     "testflight",
+    #     "user@example.com"
+    #   ]
+    # }
+    def device(token)
+      http.get("/devices/#{token}")
+    end
+
+    # Replace the channel subscriptions with a new set of channels. This will
+    # remove all previous subscriptions of the device. If you want to append a
+    # list of channels, use #update_device.
+    # https://zeropush.com/documentation/api_reference#devices_update_put
+    #
+    # @param token        String  token identifying the device
+    # @param channel_list String  Comma separated list of channels
+    #
+    # Example Request
+    #
+    # ZeroPush.set_device(token, channel_list: 'player-1, game-256')
+    #
+    # Example Response
+    # {
+    #   "token": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf",
+    #   "active": true,
+    #   "marked_inactive_at": null,
+    #   "badge": 1,
+    #   "channels": [
+    #     "player-1",
+    #     "game-256"
+    #   ]
+    # }
+    def set_device(token, params)
+      http.put("/devices/#{token}", params)
+    end
+
+    # Append the channel subscriptions with a set of new channels. If you want
+    # to replace the list of channels, use #set_device.
+    # https://zeropush.com/documentation/api_reference#devices_update_patch
+    #
+    # @param token        String  token identifying the device
+    # @param channel_list String  Comma separated list of channels
+    #
+    # Example Request
+    #
+    # ZeroPush.update_device(token, channel_list: 'player-1, game-256')
+    #
+    # Example Response
+    # {
+    #   "token": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf",
+    #   "active": true,
+    #   "marked_inactive_at": null,
+    #   "badge": 1,
+    #   "channels": [
+    #     "player-1",
+    #     "game-256"
+    #   ]
+    # }
+    def update_device(token, params)
+      http.patch("/devices/#{token}", params)
+    end
+
+    # Returns paginated list of channels
+    # https://zeropush.com/documentation/api_reference#channels_index
+    #
+    # Example Response:
+    # [
+    #   "player-1",
+    #   "player-2",
+    #   "player-9",
+    #   "game-256",
+    #   "admins",
+    #   "lobby"
+    # ]
+    def channels(params = {page:1})
+      http.get('/channels', params)
+    end
+
+    # Returns the list of device tokens for the given channel
+    # https://zeropush.com/documentation/api_reference#channels_show
+    #
+    # Example Response:
+    # {
+    #   "channel": "player-1",
+    #   "device_tokens": [
+    #     "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf"
+    #   ]
+    # }
+    def channel(channel_name)
+      http.get("/channels/#{channel_name}")
+    end
+
+    # Deletes a channels and unsubscribes all of the devices from it.
+    # https://zeropush.com/documentation/api_reference#channels_destroy
+    #
+    # {
+    #   "channel": "player-1",
+    #   "device_tokens": [
+    #     "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf"
+    #   ]
+    # }
+    def delete_channel(channel_name)
+      http.delete("/channels/#{channel_name}")
+    end
+
+    # Instantiate a new http client configured for making requests to the API
+    def http
       Faraday.new(url: URL) do |c|
         c.token_auth self.auth_token
-        c.request    :url_encoded            # form-encode POST params
+        c.request    http_config[:request_encoding]
         c.response   :json, :content_type => /\bjson$/ # parse responses to JSON
-        c.adapter    Faraday.default_adapter
+        c.adapter    http_config[:http_adapter]
       end
     end
+    alias client http
+
+    protected
+      def http_config
+        @http_config ||= ZeroPush.config.dup
+      end
   end
 end

data/lib/zero_push/compatibility.rb

@@ -0,0 +1,21 @@
+module ZeroPush
+  module Compatibility
+    def warn_on_deprecated_parameters(params)
+      value = (params[:info] || params['info'] || params[:data] || params['data'])
+      if value.is_a?(String)
+        warn "[DEPRECATION] `info` or `data` encoded as a string will not be supported in version 3.0.0; Use a hash instead."
+        http_config[:request_encoding] = :url_encoded
+      end
+    end
+
+    def notify(params)
+      warn_on_deprecated_parameters(params)
+      super
+    end
+
+    def broadcast(params)
+      warn_on_deprecated_parameters(params)
+      super
+    end
+  end
+end

data/lib/zero_push/version.rb

@@ -1,3 +1,3 @@
 module ZeroPush
-  VERSION = '2.4.1'
+  VERSION = '2.5.0'
 end

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
 require 'minitest/autorun'
 require 'minitest/spec'
+require 'webmock/minitest'
 require 'zero_push'
 require 'pry'
 
 ENV['AUTH_TOKEN'] ||= 'test-token'
 
-require 'fixtures/responses' if ENV['AUTH_TOKEN'] == 'test-token'
+WebMock.enable!

data/spec/zero_push_client_spec.rb

@@ -1,18 +1,57 @@
 require 'spec_helper'
+require 'json'
 
 describe ZeroPush::Client do
 
   let(:auth_token){ ENV['AUTH_TOKEN'] }
   let(:client){ ZeroPush.client(auth_token) }
   let(:device_token) { 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' }
+  before do
+    stub_request(:post, "https://api.zeropush.com/register").
+      with(body: '{"device_token":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}', headers: {'Authorization'=>'Token token="test-token"', 'Content-Type'=>'application/json'}).
+      to_return(status: 200, body: '{"message":"ok"}', headers: {'Content-Type' => 'application/json'})
+
+    stub_request(:delete, "https://api.zeropush.com/unregister?device_token=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").
+      with(headers: {'Authorization'=>"Token token=\"#{auth_token}\""}).
+      to_return(status: 200, body: '{"message":"ok"}', headers: {'Content-Type' => 'application/json'})
+  end
 
-  describe '#verify_credentials' do
+  describe 'compatibility' do
+    it 'should use url_encoding if `info` or `data` params are strings' do
+      request = stub_request(:post, "https://api.zeropush.com/notify").
+        with(body: {"info" => "{\"a\":1}"}, headers: {'Content-Type'=>'application/x-www-form-urlencoded'}).to_return(status: 200)
+      client.notify(info: JSON.dump({a: 1}))
+      assert_request_requested request
+    end
+    it 'should use JSON encoding if `info` or `data` params are hashes' do
+      request = stub_request(:post, "https://api.zeropush.com/notify").
+        with(body: '{"info":{"a":1}}', headers: {'Content-Type' => 'application/json'}).to_return(status: 200)
+      client.notify(info: {a: 1})
+      assert_request_requested request
+    end
+  end
 
+  describe '#http' do
+    it 'should instantiate a default http client' do
+      client.http.must_be_instance_of Faraday::Connection
+      client.http.headers['Authorization'].must_equal 'Token token="test-token"'
+    end
+  end
+
+  describe '#verify_credentials' do
     it 'should verify credentials successfully' do
+      stub_request(:get, "https://api.zeropush.com/verify_credentials").
+        with(headers: {'Authorization'=>'Token token="test-token"'}).
+        to_return(status: 200, body: '{"message": "authenticated"}', headers: {'Content-Type' => 'application/json'})
+
       client.verify_credentials.must_equal true
     end
 
     it 'should fail to verify credentials' do
+      stub_request(:get, "https://api.zeropush.com/verify_credentials").
+        with(headers: {'Authorization'=>'Token token="not a valid token"'}).
+        to_return(status: 401, body: '{"error": "unauthorized"}', headers: {'Content-Type' => 'application/json'})
+
       client = ZeroPush.client('not a valid token')
       client.verify_credentials.must_equal false
     end
@@ -20,6 +59,9 @@ describe ZeroPush::Client do
 
   describe '#notify' do
     before do
+      stub_request(:post, "https://api.zeropush.com/notify").
+        with(body: '{"device_tokens":["aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"],"alert":"hi"}').
+        to_return(status: 200, body: '{"sent_count":1, "inactive_tokens":[], "unregistered_tokens":[]}', headers: {'Content-Type' => 'application/json'})
       client.register(device_token)
     end
 
@@ -40,7 +82,6 @@ describe ZeroPush::Client do
   end
 
   describe '#register' do
-
     describe 'without a channel parameter' do
       it 'should return a hash' do
         client.register(device_token).body.class.must_equal Hash
@@ -52,6 +93,12 @@ describe ZeroPush::Client do
     end
 
     describe 'with a channel parameter' do
+      before do
+        stub_request(:post, "https://api.zeropush.com/register").
+          with(body: '{"device_token":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channel":"foo"}',
+               headers: {'Authorization'=>'Token token="test-token"', 'Content-Type'=>'application/json'}).
+          to_return(status: 200, body: '{"message":"ok"}', headers: {'Content-Type'=>'application/json'})
+      end
       it 'should return a hash' do
         client.register(device_token, 'foo').body.class.must_equal Hash
       end
@@ -68,6 +115,11 @@ describe ZeroPush::Client do
     end
 
     describe 'when the device has been registered' do
+      before do
+        stub_request(:delete, "https://api.zeropush.com/unregister?device_token=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").
+          to_return(status: 200, body: '{"message":"ok"}', headers: {'Content-Type' => 'application/json'})
+      end
+
       it 'should return a hash' do
         client.unregister(device_token).body.class.must_equal Hash
       end
@@ -76,16 +128,13 @@ describe ZeroPush::Client do
         client.unregister(device_token).body['message'].must_equal 'ok'
       end
     end
-
   end
 
   describe '#subscribe' do
     before do
-      client.register(device_token)
-    end
-
-    after do
-      client.unregister(device_token)
+      stub_request(:post, "https://api.zeropush.com/subscribe/foo_channel").
+        with(body: '{"device_token":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}').
+        to_return(status: 200, body: '{"device_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channels":["foo_channel"]}', headers: {'Content-Type' => 'application/json'})
     end
 
     let(:response){client.subscribe(device_token, 'foo_channel')}
@@ -102,12 +151,8 @@ describe ZeroPush::Client do
 
   describe '#unsubscribe' do
     before do
-      client.register(device_token)
-      client.subscribe(device_token, 'foo_channel')
-    end
-
-    after do
-      client.unregister(device_token)
+      stub_request(:delete, "https://api.zeropush.com/subscribe/foo_channel?device_token=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").
+        to_return(status: 200, body: '{"device_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channels":[]}', headers: {'Content-Type' => 'application/json'})
     end
 
     let(:response){client.unsubscribe(device_token, 'foo_channel')}
@@ -123,6 +168,11 @@ describe ZeroPush::Client do
   end
 
   describe '#broadcast' do
+    before do
+      stub_request(:post, "https://api.zeropush.com/broadcast").
+        with(body: '{"alert":"hi"}').
+        to_return(status: 200, body: '{"sent_count":10}', headers: {'Content-Type' => 'application/json'})
+    end
     let(:response){client.broadcast(alert:'hi')}
 
     it 'should return a hash' do
@@ -132,15 +182,20 @@ describe ZeroPush::Client do
     it 'should broadcast a notification to all the devices' do
       response.body['sent_count'].must_equal 10
     end
+
+    it 'should use json encoding for custom data' do
+      request = stub_request(:post, "https://api.zeropush.com/broadcast").
+        with(body: '{"data":{"alert":"hi","user_id":5}}', headers: {'Content-Type'=>'application/json'}).to_return(status: 200)
+      client.broadcast(data: {alert: "hi", user_id: 5})
+      assert_request_requested request
+    end
   end
 
   describe '#set_badge' do
     before do
-      client.register(device_token)
-    end
-
-    after do
-      client.unregister(device_token)
+      stub_request(:post, "https://api.zeropush.com/set_badge").
+        with(body: '{"device_token":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","badge":10}').
+        to_return(status: 200, body: '{"message":"ok"}', headers: {'Content-Type'=>'application/json'})
     end
 
     let(:response){client.set_badge(device_token, 10)}
@@ -157,6 +212,10 @@ describe ZeroPush::Client do
   describe '#inactive_tokens' do
 
     let(:response){client.inactive_tokens}
+    before do
+      stub_request(:get, "https://api.zeropush.com/inactive_tokens?page=1").
+        to_return(status: 200, body: '[{"device_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","marked_inactive_at": "2013-03-11T16:25:14-04:00"}]', headers: {'Content-Type'=>'application/json'})
+    end
 
     it 'should return an array' do
       response.body.class.must_equal Array
@@ -166,4 +225,92 @@ describe ZeroPush::Client do
       response.body.count.must_equal 1
     end
   end
+
+  describe '#devices' do
+    let(:response){client.devices}
+    before do
+      stub_request(:get, "https://api.zeropush.com/devices?page=1").
+        to_return(status: 200, body: '[]', headers: {'Content-Type' => 'application/json', 'Link' => '<https://api.zeropush.com/devices?page=10&per_page=25>; rel="last",<https://api.zeropush.com/devices?page=2&per_page=25>; rel="next"'})
+    end
+    it 'should return an array' do
+      response.body.class.must_equal Array
+    end
+    it 'should have paginated results' do
+      response.headers["link"].must_equal '<https://api.zeropush.com/devices?page=10&per_page=25>; rel="last",<https://api.zeropush.com/devices?page=2&per_page=25>; rel="next"'
+    end
+  end
+
+  describe '#device' do
+    before do
+      stub_request(:get, "https://api.zeropush.com/devices/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").
+        to_return(status: 200, body: '{
+  "token": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf",
+  "active": true,
+  "marked_inactive_at": null,
+  "badge": 1,
+  "channels": [
+    "testflight",
+    "user@example.com"
+  ]
+}', headers: {'Content-Type'=>'application/json'})
+    end
+    let(:response){client.device('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa')}
+
+    it 'should return a device hash' do
+      response.body.class.must_equal Hash
+      response.body.keys.must_equal %w[token active marked_inactive_at badge channels]
+    end
+  end
+
+  describe '#channels' do
+    before do
+      stub_request(:get, "https://api.zeropush.com/channels?page=1").
+        to_return(status: 200, body: '["player-1","foobar"]', headers: {'Content-Type'=>'application/json', 'Link' => '<https://api.zeropush.com/channels?page=10&per_page=25>; rel="last",<https://api.zeropush.com/channels?page=2&per_page=25>; rel="next"'})
+    end
+    let(:response){client.channels}
+    it 'should return an array' do
+      response.body.class.must_equal Array
+    end
+    it 'should have paginated results' do
+      response.headers["link"].must_equal '<https://api.zeropush.com/channels?page=10&per_page=25>; rel="last",<https://api.zeropush.com/channels?page=2&per_page=25>; rel="next"'
+    end
+  end
+
+  describe '#channel' do
+    before do
+      stub_request(:get, 'https://api.zeropush.com/channels/player-1').
+        to_return(status: 200, body:'{
+  "channel": "player-1",
+  "device_tokens": [
+    "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf"
+  ]
+}', headers: {'Content-Type' => 'application/json'})
+    end
+
+    let(:response) { client.channel('player-1') }
+
+    it 'should return a channel hash' do
+      response.body.class.must_equal Hash
+      response.body.keys.must_equal %w[channel device_tokens]
+    end
+  end
+
+  describe '#delete_channel' do
+    before do
+      stub_request(:delete, 'https://api.zeropush.com/channels/player-1').
+        to_return(status: 200, body:'{
+  "channel": "player-1",
+  "device_tokens": [
+    "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcedf"
+  ]
+}', headers: {'Content-Type' => 'application/json'})
+    end
+
+    let(:response) { client.delete_channel('player-1') }
+
+    it 'should return a channel hash' do
+      response.body.class.must_equal Hash
+      response.body.keys.must_equal %w[channel device_tokens]
+    end
+  end
 end

data/spec/zero_push_spec.rb

@@ -5,6 +5,17 @@ describe ZeroPush do
     ZeroPush.auth_token = ENV['AUTH_TOKEN'] || 'test_token'
   end
 
+  describe 'using different auth_tokens' do
+    it 'should accept a hash of tokens' do
+      ZeroPush.auth_tokens = {
+        apns: 'test-apns-token',
+        gcm: 'test-gcm-token'
+      }
+      ZeroPush.apns.auth_token.must_equal 'test-apns-token'
+      ZeroPush.gcm.auth_token.must_equal 'test-gcm-token'
+    end
+  end
+
   describe '.client' do
     it 'should return a client instance' do
       ZeroPush.client.class.must_equal ZeroPush::Client

data/zero_push.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake',            '~> 10.3.2'
   gem.add_development_dependency 'railties',        '~> 4.1.4'
   gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'webmock',         '~> 1.20.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zero_push
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Stefan Natchev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -123,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
 description: ZeroPush is a simple service for sending iOS push notifications. (http://zeropush.com)
 email:
 - stefan.natchev@gmail.com
@@ -133,17 +147,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/generators/zero_push/install_generator.rb
 - lib/generators/zero_push/templates/zero_push.rb
 - lib/zero_push.rb
 - lib/zero_push/client.rb
+- lib/zero_push/compatibility.rb
 - lib/zero_push/version.rb
-- spec/fixtures/responses.rb
 - spec/generator_spec.rb
 - spec/spec_helper.rb
 - spec/zero_push_client_spec.rb
@@ -170,13 +185,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A gem for interacting with the ZeroPush API. (http://zeropush.com)
 test_files:
-- spec/fixtures/responses.rb
 - spec/generator_spec.rb
 - spec/spec_helper.rb
 - spec/zero_push_client_spec.rb
 - spec/zero_push_spec.rb
+has_rdoc: 

data/spec/fixtures/responses.rb

@@ -1,25 +0,0 @@
-class ZeroPush::Client
-  def client
-    Faraday.new do |builder|
-      builder.token_auth self.auth_token
-      builder.response :json, :content_type => /\bjson$/ # parse responses to JSON
-      builder.adapter :test do |stub|
-        stub.get('/verify_credentials') do |env|
-          if env.request_headers['Authorization'] == "Token token=\"not a valid token\""
-            [401, {'Content-Type' => 'application/json'}, '{"error": "unauthorized"}']
-          else
-            [200, {'Content-Type' => 'application/json'}, '{"message": "authenticated"}']
-          end
-        end
-        stub.post('/register') { [200, {'Content-Type' => 'application/json'}, '{"message":"ok"}'] }
-        stub.delete('/unregister') { [200, {'Content-Type' => 'application/json'}, '{"message":"ok"}'] }
-        stub.post('/notify') { [200, {'Content-Type' => 'application/json'}, '{"sent_count":1, "inactive_tokens":[]}'] }
-        stub.post('/broadcast') { [200, {'Content-Type' => 'application/json'}, '{"sent_count":10}'] }
-        stub.post('/subscribe/foo_channel') { [200, {'Content-Type' => 'application/json'}, '{"device_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channels":["foo_channel"]}'] }
-        stub.delete('/subscribe/foo_channel') { [200, {'Content-Type' => 'application/json'}, '{"device_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channels":[]}'] }
-        stub.post('/set_badge') { [200, {'Content-Type' => 'application/json'}, '{"message":"ok"}'] }
-        stub.get('/inactive_tokens') { [200, {'Content-Type' => 'application/json'}, '[{"device_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","marked_inactive_at": "2013-03-11T16:25:14-04:00"}]'] }
-      end
-    end
-  end
-end