zero_push_woosh 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b79acd64d3607ad7c5e4b55e48cccdb4b3e2f738
+  data.tar.gz: 0b4d4685e5050b196e745ee9962f77223b93ce8b
+SHA512:
+  metadata.gz: 11a6d6e212fab18168261ea0db70e7f18d78be02856df243b05ecd528d47bbf20e18e78726c93a0887a280a7f3d2a4cf34b79dc1a9c429d9e23a68349dfb37d3
+  data.tar.gz: ff22ab600fc3b85d1193adf776a259c03e82f7c71d907f758a8909e91d5c89368a0b582721cdb3c456b059b40ef3bb861d005260ffe3ab70a90e99b374c16d69

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+
+spec/tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.1
+- 2.2.0
+- jruby-19mode
+notifications:
+  email:
+  - adam.v.duke@gmail.com
+  - stefan.natchev@gmail.com

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 2.5.1 (2015-01-30)
+Increment the version due to the 2.5.0 tag pointing at the wrong commit. 
+
+## 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

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

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    zero_push_woosh (1.0.0)
+      faraday (~> 0.9.0)
+      faraday_middleware (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.4)
+      actionview (= 4.1.4)
+      activesupport (= 4.1.4)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.4)
+      activesupport (= 4.1.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activesupport (4.1.4)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      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.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.2)
+      faraday (>= 0.7.4, < 0.10)
+    i18n (0.6.9)
+    json (1.8.1)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.3.5)
+    minitest-around (0.2.0)
+      minitest (~> 5.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multipart-post (2.0.0)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.4)
+      actionpack (= 4.1.4)
+      activesupport (= 4.1.4)
+      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
+
+DEPENDENCIES
+  minitest (~> 5.3.5)
+  minitest-around (~> 0.2.0)
+  mocha (~> 1.1.0)
+  pry
+  railties (~> 4.1.4)
+  rake (~> 10.3.2)
+  webmock (~> 1.20.4)
+  zero_push_woosh!

data/LICENSE.md

@@ -0,0 +1,25 @@
+## License
+
+Copyright (c) 2015 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/README.md

@@ -0,0 +1,85 @@
+# Important notice about this Gem
+
+[ZeroPush has been acquired by Twitter](https://zeropush.com/acquisition) and will be shutting their doors on January 31, 2016.  They have partnered with [PushWoosh](http://www.pushwoosh.com) to provide a ["code free" migration path](http://docs.pushwoosh.com/docs/zeropush-migration).  This gem offers a bridge between the former ZeroPush API and mirror PushWoosh API.  Please note there have been only two minor changes:
+
+1.  This gem and its files have been renamed from zero_push to zero_push_woosh to mark the bridge between the two providers
+2.  The ZeroPush API endpoint URL has been replaced by the PushWoosh bridge API endpoint url (i.e. https://zeropush.pushwoosh.com)
+
+Otherwise, all of the code remain the same as before.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zero_push_woosh'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zero_push_woosh
+
+## Usage
+
+### Rails Generator
+Generate the ZeroPushWoosh initializer if you are using Ruby on Rails.
+
+    $ rails g zero_push_woosh:install
+
+### API Client
+
+The easiest way to use the API client is to set the server `auth_token` at the module level and call methods on the ZeroPushWoosh module. You can find the token on settings page for your app.
+
+```ruby
+  ZeroPushWoosh.auth_token = 'iosprod_your-server-token'
+  ZeroPushWoosh.notify(device_tokens: ['abcdef'], alert: 'hello, world', badge: '+1', info: {user_id: 1234})
+```
+
+If your web application supports must support multiple mobile apps, you may configure it like this:
+
+```ruby
+  if Rails.env == 'development'  #or ENV['RACK_ENV']
+    ZeroPushWoosh.auth_tokens = {
+      apns: 'iosdev_XYZ',
+      gcm: 'gcmdev_ABC',
+    }
+  else
+    ZeroPushWoosh.auth_tokens = {
+      apns: 'iosprod_XYZ',
+      gcm: 'gcmprod_ABC',
+    }
+  end
+```
+
+You may then instantiate clients by calling the method that matches the auth token key:
+
+```ruby
+  ZeroPushWoosh.apns.broadcast( ... )
+  ZeroPushWoosh.gcm.broadcast( ... )
+```
+
+
+Lastly, if you have many apps you may instantiate clients API Clients
+
+```ruby
+  client_1 = ZeroPushWoosh.client('iosprod_app-server-token-1')
+  client_1.broadcast(alert: 'hello, app1')
+
+  client_2 = ZeroPushWoosh.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 ZeroPushWoosh](https://zeropush.com/documentation)
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Write tests for your feature
+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

data/Rakefile

@@ -0,0 +1,11 @@
+require "rake/testtask"
+require "bundler/gem_tasks"
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'spec'
+  t.test_files = Dir["spec/**/*_spec.rb"]
+  t.verbose = true
+end
+

data/lib/generators/zero_push_woosh/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module ZeroPushWoosh
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_initializer_file
+      @production_token = ask 'Production auth_token:'
+      @development_token = ask 'Development auth_token:'
+      template('zero_push_woosh.rb', 'config/initializers/zero_push_woosh.rb')
+    end
+
+    private
+
+    def self.installation_message
+      'Generates the initializer'
+    end
+
+    desc installation_message
+
+  end
+end
+
+

data/lib/generators/zero_push_woosh/templates/zero_push_woosh.rb

@@ -0,0 +1,5 @@
+if Rails.env.production?
+  ZeroPushWoosh.auth_token = '<%= @production_token %>'
+else
+  ZeroPushWoosh.auth_token = '<%= @development_token %>'
+end

data/lib/zero_push_woosh.rb

@@ -0,0 +1,44 @@
+require 'zero_push_woosh/version'
+require 'zero_push_woosh/client'
+require 'faraday'
+
+module ZeroPushWoosh
+  class << self
+    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,
+      :device,
+      :set_device,
+      :update_device,
+      :channels,
+      :channel,
+      :delete_channel
+
+    def client(auth_token = self.auth_token)
+      ZeroPushWoosh::Client.new(auth_token)
+    end
+
+    def config
+      @config ||= {:http_adapter => Faraday.default_adapter, request_encoding: :json}
+    end
+
+    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_woosh/client.rb

@@ -0,0 +1,268 @@
+require 'zero_push_woosh/compatibility'
+require 'faraday_middleware'
+
+module ZeroPushWoosh
+  class Client
+    URL = 'https://zeropush.pushwoosh.com'.freeze
+
+    attr_accessor :auth_token
+
+    def initialize(auth_token)
+      self.auth_token = auth_token
+      self.extend(Compatibility)
+    end
+
+    # verifies credentials
+    #
+    # @return [Boolean]
+    def verify_credentials
+      response = http.get('/verify_credentials')
+      response.status == 200
+    end
+
+    # Sends a notification to the list of devices
+    #
+    # @param params [Hash]
+    #
+    # Example response
+    # {"sent_count":10,"inactive_tokens":[],"unregistered_tokens":["abc"]}
+    def notify(params)
+      http.post('/notify', params)
+    end
+
+    # Sends a notification to all of the devices registered with the ZeroPushWoosh backend
+    #
+    # @param params [Hash]
+    #
+    # Example response
+    # {"sent_count":10}
+    def broadcast(params)
+      http.post('/broadcast', params)
+    end
+
+    # Subscribes a device to a particular notification channel
+    #
+    # @param device_token [String]
+    # @param channel      [String]
+    #
+    # Example response
+    # {"device_token":"abc", "channels":["foo"]}
+    def subscribe(device_token, channel)
+      http.post("/subscribe/#{channel}", device_token:device_token)
+    end
+
+    # Unsubscribes a device from a particular notification channel
+    #
+    # @param device_token [String]
+    # @param channel      [String]
+    #
+    # Example response
+    # {"device_token":"abc", "channels":[]}
+    def unsubscribe(device_token, channel)
+      http.delete("/subscribe/#{channel}", device_token:device_token)
+    end
+
+    # Registers a device token with the ZeroPushWoosh backend
+    #
+    # @param device_token
+    #
+    # Example response
+    # {"message":"ok"}
+    def register(device_token, channel=nil)
+      params = {device_token: device_token}
+      params.merge!(channel: channel) unless channel.nil?
+      http.post('/register', params)
+    end
+
+    # Unregisters a device token that has previously been registered with
+    # ZeroPushWoosh
+    #
+    # @param device_token
+    #
+    # Example response
+    # {"message":"ok"}
+    def unregister(device_token)
+      http.delete('/unregister', device_token: device_token)
+    end
+
+    # Sets the badge for a particular device
+    #
+    # @param device_token
+    # @param badge
+    #
+    # Example response
+    # {"message":"ok"}
+    def set_badge(device_token, badge)
+      http.post('/set_badge', device_token: device_token, badge: badge)
+    end
+
+    # Returns a list of tokens that have been marked inactive
+    #
+    # Example response
+    # [
+    #   {
+    #     "device_token":"238b8cb09011850cb4bd544dfe0c8f5eeab73d7eeaae9bdca59076db4ae49947",
+    #     "marked_inactive_at":"2013-07-17T01:27:53-04:00"
+    #   },
+    #   {
+    #     "device_token":"8c97be6643eea2143322005bc4c44a1aee5e549bce5e2bb2116114f45484ddaf",
+    #     "marked_inactive_at":"2013-07-17T01:27:50-04:00"
+    #   }
+    # ]
+    def inactive_tokens(params = {page:1})
+      http.get('/inactive_tokens', params)
+    end
+
+    # Returns a paginated list of devices
+    # https://zeropush.com/documentation/api_reference#devices_index
+    #
+    # 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
+    #
+    # ZeroPushWoosh.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
+    #
+    # ZeroPushWoosh.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    http_config[:request_encoding]
+        c.response   :json, :content_type => /\bjson$/ # parse responses to JSON
+        c.adapter    http_config[:http_adapter]
+      end
+    end
+    alias client http
+
+    protected
+      def http_config
+        @http_config ||= ZeroPushWoosh.config.dup
+      end
+  end
+end

data/lib/zero_push_woosh/compatibility.rb

@@ -0,0 +1,21 @@
+module ZeroPushWoosh
+  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_woosh/version.rb

@@ -0,0 +1,3 @@
+module ZeroPushWoosh
+  VERSION = '1.0.0'
+end

data/spec/generator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'rails/generators/test_case'
+require 'generators/zero_push_woosh/install_generator'
+
+class ZeroPushWoosh::GeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path('../tmp', __FILE__)
+  tests ZeroPushWoosh::InstallGenerator
+  test 'it copies the initializer' do
+    production_token = 'production'
+    development_token = 'development'
+    ZeroPushWoosh::InstallGenerator.any_instance.stubs(:ask).returns(production_token).then.returns(development_token)
+
+    run_generator
+
+    assert_file 'config/initializers/zero_push_woosh.rb' do |initializer|
+      production_config = %Q|ZeroPushWoosh.auth_token = '#{production_token}'|
+      assert(initializer.include?(production_config), "The initializer doesn't include the production configuration")
+
+      development_config = %Q|ZeroPushWoosh.auth_token = '#{development_token}'|
+      assert(initializer.include?(development_config), "The initializer doesn't include the development configuration")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'webmock/minitest'
+require 'zero_push_woosh'
+require 'pry'
+
+ENV['AUTH_TOKEN'] ||= 'test-token'
+
+WebMock.enable!

data/spec/zero_push_woosh_client_spec.rb

@@ -0,0 +1,316 @@
+require 'spec_helper'
+require 'json'
+
+describe ZeroPushWoosh::Client do
+
+  let(:auth_token){ ENV['AUTH_TOKEN'] }
+  let(:client){ ZeroPushWoosh.client(auth_token) }
+  let(:device_token) { 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' }
+  before do
+    stub_request(:post, "https://zeropush.pushwoosh.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://zeropush.pushwoosh.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 'compatibility' do
+    it 'uses url_encoding if `info` or `data` params are strings' do
+      request = stub_request(:post, "https://zeropush.pushwoosh.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 'uses JSON encoding if `info` or `data` params are hashes' do
+      request = stub_request(:post, "https://zeropush.pushwoosh.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 'instantiates 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 'verifies credentials successfully' do
+      stub_request(:get, "https://zeropush.pushwoosh.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 'fails to verify credentials' do
+      stub_request(:get, "https://zeropush.pushwoosh.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 = ZeroPushWoosh.client('not a valid token')
+      client.verify_credentials.must_equal false
+    end
+  end
+
+  describe '#notify' do
+    before do
+      stub_request(:post, "https://zeropush.pushwoosh.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
+
+    after do
+      client.unregister(device_token)
+    end
+
+    let(:response){client.notify(device_tokens: [device_token], alert: 'hi')}
+
+    it 'returns a hash' do
+      response.body.class.must_equal Hash
+    end
+
+    it 'constructs the request' do
+      response.body['sent_count'].must_equal 1
+      response.body['inactive_tokens'].must_equal []
+    end
+  end
+
+  describe '#register' do
+    describe 'without a channel parameter' do
+      it 'returns a hash' do
+        client.register(device_token).body.class.must_equal Hash
+      end
+
+      it 'registers the device' do
+        client.register(device_token).body['message'].must_equal 'ok'
+      end
+    end
+
+    describe 'with a channel parameter' do
+      before do
+        stub_request(:post, "https://zeropush.pushwoosh.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 'returns a hash' do
+        client.register(device_token, 'foo').body.class.must_equal Hash
+      end
+
+      it 'registers the device' do
+        client.register(device_token, 'foo').body['message'].must_equal 'ok'
+      end
+    end
+  end
+
+  describe '#unregister' do
+    before do
+      client.register(device_token)
+    end
+
+    describe 'when the device has been registered' do
+      before do
+        stub_request(:delete, "https://zeropush.pushwoosh.com/unregister?device_token=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").
+          to_return(status: 200, body: '{"message":"ok"}', headers: {'Content-Type' => 'application/json'})
+      end
+
+      it 'returns a hash' do
+        client.unregister(device_token).body.class.must_equal Hash
+      end
+
+      it 'unregisters the device' do
+        client.unregister(device_token).body['message'].must_equal 'ok'
+      end
+    end
+  end
+
+  describe '#subscribe' do
+    before do
+      stub_request(:post, "https://zeropush.pushwoosh.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')}
+
+    it 'returns a hash' do
+      response.body.class.must_equal Hash
+    end
+
+    it 'subscribes a device to a channel' do
+      response.body['device_token'].must_equal device_token
+      response.body['channels'].must_include 'foo_channel'
+    end
+  end
+
+  describe '#unsubscribe' do
+    before do
+      stub_request(:delete, "https://zeropush.pushwoosh.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')}
+
+    it 'returns a hash' do
+      response.body.class.must_equal Hash
+    end
+
+    it 'subscribes a device to a channel' do
+      response.body['device_token'].must_equal device_token
+      response.body['channels'].wont_include 'foo_channel'
+    end
+  end
+
+  describe '#broadcast' do
+    before do
+      stub_request(:post, "https://zeropush.pushwoosh.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 'returns a hash' do
+      response.body.class.must_equal Hash
+    end
+
+    it 'broadcasts a notification to all the devices' do
+      response.body['sent_count'].must_equal 10
+    end
+
+    it 'uses json encoding for custom data' do
+      request = stub_request(:post, "https://zeropush.pushwoosh.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
+      stub_request(:post, "https://zeropush.pushwoosh.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)}
+
+    it 'returns a hash' do
+      response.body.class.must_equal Hash
+    end
+
+    it 'sets the device\'s badge' do
+      response.body['message'].must_equal 'ok'
+    end
+  end
+
+  describe '#inactive_tokens' do
+
+    let(:response){client.inactive_tokens}
+    before do
+      stub_request(:get, "https://zeropush.pushwoosh.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 'returns an array' do
+      response.body.class.must_equal Array
+    end
+
+    it 'gets a list of inactive tokens' do
+      response.body.count.must_equal 1
+    end
+  end
+
+  describe '#devices' do
+    let(:response){client.devices}
+    before do
+      stub_request(:get, "https://zeropush.pushwoosh.com/devices?page=1").
+        to_return(status: 200, body: '[]', headers: {'Content-Type' => 'application/json', 'Link' => '<https://zeropush.pushwoosh.com/devices?page=10&per_page=25>; rel="last",<https://zeropush.pushwoosh.com/devices?page=2&per_page=25>; rel="next"'})
+    end
+    it 'returns an array' do
+      response.body.class.must_equal Array
+    end
+    it 'has paginated results' do
+      response.headers["link"].must_equal '<https://zeropush.pushwoosh.com/devices?page=10&per_page=25>; rel="last",<https://zeropush.pushwoosh.com/devices?page=2&per_page=25>; rel="next"'
+    end
+  end
+
+  describe '#device' do
+    before do
+      stub_request(:get, "https://zeropush.pushwoosh.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 'returns 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://zeropush.pushwoosh.com/channels?page=1").
+        to_return(status: 200, body: '["player-1","foobar"]', headers: {'Content-Type'=>'application/json', 'Link' => '<https://zeropush.pushwoosh.com/channels?page=10&per_page=25>; rel="last",<https://zeropush.pushwoosh.com/channels?page=2&per_page=25>; rel="next"'})
+    end
+    let(:response){client.channels}
+    it 'returns an array' do
+      response.body.class.must_equal Array
+    end
+    it 'has paginated results' do
+      response.headers["link"].must_equal '<https://zeropush.pushwoosh.com/channels?page=10&per_page=25>; rel="last",<https://zeropush.pushwoosh.com/channels?page=2&per_page=25>; rel="next"'
+    end
+  end
+
+  describe '#channel' do
+    before do
+      stub_request(:get, 'https://zeropush.pushwoosh.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 'returns 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://zeropush.pushwoosh.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 'returns 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_woosh_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe ZeroPushWoosh do
+  before do
+    ZeroPushWoosh.auth_token = ENV['AUTH_TOKEN'] || 'test_token'
+  end
+
+  describe 'using different auth_tokens' do
+    it 'accepts a hash of tokens' do
+      ZeroPushWoosh.auth_tokens = {
+        apns: 'test-apns-token',
+        gcm: 'test-gcm-token'
+      }
+      ZeroPushWoosh.apns.auth_token.must_equal 'test-apns-token'
+      ZeroPushWoosh.gcm.auth_token.must_equal 'test-gcm-token'
+    end
+  end
+
+  describe '.client' do
+    it 'returns a client instance' do
+      ZeroPushWoosh.client.class.must_equal ZeroPushWoosh::Client
+    end
+  end
+
+  describe 'methods the module responds to' do
+    [:verify_credentials, :notify, :broadcast, :subscribe, :unsubscribe, :register, :unregister, :set_badge, :inactive_tokens, :devices, :device, :set_device, :update_device, :channels, :channel, :delete_channel, :client].each do |method|
+      it "responds to #{method}" do
+        ZeroPushWoosh.respond_to?(method).must_equal(true)
+      end
+    end
+  end
+end

data/zero_push_woosh.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zero_push_woosh/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "zero_push_woosh"
+  gem.version       = ZeroPushWoosh::VERSION
+  gem.authors       = ["Stefan Natchev", "Adam Duke"]
+  gem.email         = ["stefan.natchev@gmail.com", "adam.v.duke@gmail.com"]
+  gem.summary       = %q{A gem for interacting with the ZeroPushWoosh API. (http://zeropush.com)}
+  gem.description   = %q{ZeroPushWoosh is a simple service for sending iOS push notifications. (http://zeropush.com)}
+  gem.homepage      = "https://zeropush.com"
+  gem.license       = 'MIT'
+
+  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.require_paths = ["lib"]
+  gem.required_ruby_version = '>= 1.9'
+
+  gem.add_dependency "faraday", "~> 0.9.0"
+  gem.add_dependency "faraday_middleware", "~> 0.9.0"
+
+  gem.add_development_dependency 'minitest',        '~> 5.3.5'
+  gem.add_development_dependency 'minitest-around', '~> 0.2.0'
+  gem.add_development_dependency 'mocha',           '~> 1.1.0'
+  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

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: zero_push_woosh
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stefan Natchev
+- Adam Duke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.5
+- !ruby/object:Gem::Dependency
+  name: minitest-around
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: ZeroPushWoosh is a simple service for sending iOS push notifications.
+  (http://zeropush.com)
+email:
+- stefan.natchev@gmail.com
+- adam.v.duke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/generators/zero_push_woosh/install_generator.rb
+- lib/generators/zero_push_woosh/templates/zero_push_woosh.rb
+- lib/zero_push_woosh.rb
+- lib/zero_push_woosh/client.rb
+- lib/zero_push_woosh/compatibility.rb
+- lib/zero_push_woosh/version.rb
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+- spec/zero_push_woosh_client_spec.rb
+- spec/zero_push_woosh_spec.rb
+- zero_push_woosh.gemspec
+- zeropush-header.png
+homepage: https://zeropush.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: A gem for interacting with the ZeroPushWoosh API. (http://zeropush.com)
+test_files:
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+- spec/zero_push_woosh_client_spec.rb
+- spec/zero_push_woosh_spec.rb