pushio 0.0.2 → 0.1.0

data/.gitignore

@@ -17,4 +17,5 @@ test/version_tmp
 tmp
 .DS_Store
 /.idea/
-/.rvmrc
+/.rvmrc
+/spec/pushio_config.yml

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Push IO LLC
+Copyright (c) 2013 Push IO Inc.
 
 MIT License
 

data/README.md

@@ -1,26 +1,36 @@
 # PushIoClient
 
-An easy to use client for integrating push notifications into Ruby-based applications. This gem uses the Push IO API to trigger notification delivery to whatever audience you specify. In order to get full use of this gem you will need to have an active account on https://manage.push.io and have recipient devices registered to receive notifications. Learn more at http://push.io
+An easy to use client for integrating push notifications into Ruby-based applications.
+This gem uses the Push IO API to trigger notification delivery to whatever audience you specify.
+In order to get full use of this gem you will need to have an active account on
+https://manage.push.io and have recipient devices registered to receive notifications.
+Learn more at http://push.io
 
 ## Installation
 
 Add this line to your application's Gemfile:
-
+```
     gem 'pushio'
+```
 
 And then execute:
 
+```
     $ bundle
+```
 
 Or install it yourself as:
 
+```
     $ gem install pushio
+```
+
 
 ## Usage
 
 Configure the client:
 
-```
+```ruby
 PushIo::Client.configure do |config|
   config.app_guid = [your app guid from https://manage.push.io]
   config.sender_secret = [for your app on https://manage.push.io]
@@ -28,14 +38,28 @@ end
 ```
 
 Send a broadcast push to everyone registered for your app:
-```
-push_client = PushIo::Client.new
-notification_id = push_client.broadcast :message => "Hello everyone!"
+```ruby
+notification_id = PushIo::Client.deliver_broadcast :payload => {:message => "Broadcast Test"}
 ```
 
 Send a push to an audience:
+```ruby
+notification_id = PushIo::Client.deliver_to_audience "friends", :payload => {:message => "Howdy Friends", :payload_apns => {:badge => 8}}
+```
+
+Send a push to a targeted query:
+```ruby
+notification_id = PushIo::Client.deliver_to_query "Alpha or Bravo", :payload => {:message => "Query Test"}
 ```
-push_client.deliver_to_audience "friends", :message => "Howdy friends", :count => 8
+
+Send a push to a known device ID:
+```ruby
+notification_id = PushIo::Client.deliver_to_ids "APIKEY1234_a123", ['B3606524-AE35-458A-9FE9-7B6FE8D99CE4'], :payload => {:message => "Hello Push IO"}
+```
+
+Send a push to a known device Token:
+```ruby
+notification_id = PushIo::Client.deliver_to_tokens "APIKEY1234_a123", ['abcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd'], :payload => {:message => "Hello Push IO"}
 ```
 
 

data/lib/push_io.rb

@@ -1,6 +1,7 @@
 module PushIo
   require 'multi_json'
   require 'httpclient'
+  require 'push_io/utils'
   require 'push_io/version'
   require 'push_io/errors'
   require 'push_io/configuration'

data/lib/push_io/client.rb

@@ -1,8 +1,11 @@
 module PushIo
   class Client
     attr_reader :config
+    attr_accessor :httpclient
+
     def initialize(attributes = {})
       @config = PushIo::Client.config.dup
+      self.httpclient = HTTPClient.new
       attributes.each do |name, value|
         @config.send("#{name}=", value) if @config.respond_to?("#{name}=")
       end
@@ -23,23 +26,113 @@ module PushIo
       end
     end
 
-    def broadcast(*payload)
-      send_post(payload, {:audience => "broadcast"})
+    def deliver(*args)
+      opts = args.extract_options!
+      send_post(opts) if ready_to_deliver?(opts)
+    end
+
+    def deliver_broadcast(*args)
+      opts = args.extract_options!
+      opts.delete(:audience) if opts[:audience]
+      opts.delete(:tag_query) if opts[:tag_query]
+      opts[:audience] = 'broadcast'
+      send_post(opts) if ready_to_deliver?(opts)
+    end
+
+    def deliver_to_audience(audience, *args)
+      opts = args.extract_options!
+      opts.delete(:tag_query) if opts[:tag_query]
+      opts[:audience] = audience
+      raise PushIo::MissingOptionsError, "An audience was not specified" unless opts[:audience]
+      send_post(opts) if ready_to_deliver?(opts)
+    end
+
+    def deliver_to_query(query, *args)
+      opts = args.extract_options!
+      opts.delete(:audience) if opts[:audience]
+      opts[:tag_query] = query
+      raise PushIo::MissingOptionsError, "A query was not specified" unless opts[:tag_query]
+      send_post(opts) if ready_to_deliver?(opts)
     end
 
-    def deliver_to_audience(audience, *payload)
-      send_post(payload, {:audience => audience})
+    def deliver_to_ids(api_key, device_id_array, *args)
+      opts = args.extract_options!
+      opts.delete(:audience) if opts[:audience]
+      opts.delete(:tag_query) if opts[:tag_query]
+      raise PushIo::MissingOptionsError, "A valid API Key was not specified" unless api_key =~ PushIo::API_KEY_REGEX
+      raise PushIo::MissingOptionsError, "Device IDs need to be specified in an array" unless device_id_array.is_a? Array
+      opts[:recipient_ids] = {api_key => device_id_array}
+      send_devices_post(opts) if ready_to_deliver_to_devices?(opts)
     end
 
+    def deliver_to_tokens(api_key, device_token_array, *args)
+      opts = args.extract_options!
+      opts.delete(:audience) if opts[:audience]
+      opts.delete(:tag_query) if opts[:tag_query]
+      raise PushIo::MissingOptionsError, "A valid API Key was not specified" unless api_key =~ PushIo::API_KEY_REGEX
+      raise PushIo::MissingOptionsError, "Device tokens need to be specified in an array" unless device_token_array.is_a? Array
+      opts[:recipient_tokens] = {api_key => device_token_array}
+      send_devices_post(opts) if ready_to_deliver_to_devices?(opts)
+    end
+
+
     private
+
+    def ready_to_deliver?(opts)
+      if (opts.keys & [:tag_query, :audience]).empty?
+        raise PushIo::MissingOptionsError, "No tag_query or audience was specified"
+      end
+      if (opts.keys & [:tag_query, :audience]).length == 2
+        raise PushIo::MissingOptionsError, "Please specify tag_query or audience but not both"
+      end
+      raise PushIo::MissingOptionsError, "Please specify a payload" unless opts[:payload]
+      true
+    end
+
     def send_url
       "#{@config.endpoint_url}#{PushIo::NOTIFY_APP_PATH}#{@config.app_guid}/#{@config.sender_secret}"
     end
-    def send_post(payload, args)
-      response = HTTPClient.new.post(send_url, {:body => build_post(args, payload)})
+
+    def send_post(opts)
+      response = self.httpclient.post(send_url, {:body => build_post(opts)})
+      parse_response(response)
+    end
+
+    def build_post(opts)
+      opts[:payload] = MultiJson.dump(opts[:payload])
+      opts[:recipient_ids] = MultiJson.dump(opts[:recipient_ids]) if opts[:recipient_ids]
+      opts[:recipient_tokens] = MultiJson.dump(opts[:recipient_tokens]) if opts[:recipient_tokens]
+      opts
+    end
+
+    def parse_response(response)
+      if response.code == 201
+        response_hash = MultiJson.load(response.body)
+        return response_hash['notification_guid']
+      end
+      raise PushIo::DeliveryError, response.body
     end
-    def build_post(args, payload)
-      args.merge({:payload => MultiJson.dump(payload)})
+
+
+    def send_devices_url
+      "#{@config.endpoint_url}#{PushIo::NOTIFY_DEVICES_PATH}#{@config.app_guid}/#{@config.sender_secret}"
     end
+
+    def send_devices_post(opts)
+      response = self.httpclient.post(send_devices_url, {:body => build_post(opts)})
+      parse_response(response)
+    end
+
+    def ready_to_deliver_to_devices?(opts)
+      if (opts.keys & [:recipient_ids, :recipient_tokens]).empty?
+        raise PushIo::MissingOptionsError, "No tag_query or audience was specified"
+      end
+      if (opts.keys & [:recipient_ids, :recipient_tokens]).length == 2
+        raise PushIo::MissingOptionsError, "Please specify recipient_ids or recipient_tokens but not both"
+      end
+      raise PushIo::MissingOptionsError, "Please specify a payload" unless opts[:payload]
+      true
+    end
+
   end
 end

data/lib/push_io/configuration.rb

@@ -14,4 +14,6 @@ end
 module PushIo
   ENDPOINT_URL = "https://manage.push.io"
   NOTIFY_APP_PATH = "/api/v1/notify_app/"
+  NOTIFY_DEVICES_PATH = "/api/v1/notify_devices/"
+  API_KEY_REGEX = /\A[a-zA-Z0-9]{10}_[a-zA-Z0-9]{4}\Z/
 end

data/lib/push_io/errors.rb

@@ -1,4 +1,8 @@
 module PushIo
   class UnconfiguredClientError < StandardError
   end
+  class MissingOptionsError < StandardError
+  end
+  class DeliveryError < StandardError
+  end
 end

data/lib/push_io/utils.rb

@@ -0,0 +1,5 @@
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end unless defined? Array.new.extract_options!
+end

data/lib/push_io/version.rb

@@ -1,3 +1,3 @@
 module PushIo
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/pushio.gemspec

@@ -2,7 +2,7 @@
 require File.expand_path('../lib/push_io/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Push IO LLC", "Sean McKibben"]
+  gem.authors       = ["Push IO Inc.", "Sean McKibben"]
   gem.email         = ["sean@push.io"]
   gem.description   = %q{Ruby client library to send push notifications via the Push IO API. See: http://push.io for more information and to set up your account.}
   gem.summary       = %q{This gem enables developers to easily create new notifications and send them via the Push IO API from Ruby apps.}

data/spec/push_io_spec.rb

@@ -4,21 +4,34 @@ require 'push_io'
 describe PushIo do
   context "unconfigured" do
     it "should tell you how to configure" do
-      expect{PushIo::Client.new}.to raise_error(PushIo::UnconfiguredClientError)
+      expect { PushIo::Client.new }.to raise_error(PushIo::UnconfiguredClientError)
 
     end
   end
   context "configured" do
+    test_keys_path = File.expand_path("../pushio_config.yml", __FILE__)
+    test_keys = {}
+    if File.exists? test_keys_path
+      test_keys = YAML.load_file(test_keys_path)
+    end
+    let(:endpoint_url) { test_keys[:endpoint_url] || "https://manage.push.io" }
+    let(:app_guid) { test_keys[:app_guid] || "abcdefghij" }
+    let(:api_key) { test_keys[:api_key] || "abcdefghij_apns" }
+    let(:sender_secret) { test_keys[:sender_secret] || "m42PGzAqQAdEcY1w2fpN" }
+    let(:device_id) { test_keys[:device_id] || "B3606524-AE35-458A-9FE9-7B6FE8D99CE4" }
+    let(:device_token) { test_keys[:device_token] || "abcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcd" }
     before :each do
       PushIo::Client.configure do |config|
-        config.app_guid = "1234"
-        config.sender_secret = "5678"
+        config.endpoint_url = endpoint_url
+        config.app_guid = app_guid
+        config.sender_secret = sender_secret
       end
     end
     it "should allow configuration" do
       client = PushIo::Client.new
-      client.config.app_guid.should == "1234"
-      client.config.sender_secret.should == "5678"
+      client.config.app_guid.should == app_guid
+      client.config.sender_secret.should == sender_secret
+      client.config.endpoint_url.should == endpoint_url
     end
     it "should allow configuration override" do
       client = PushIo::Client.new(:app_guid => "aaaa", :sender_secret => "qqqq")
@@ -27,11 +40,59 @@ describe PushIo do
     end
     it "makes a send url" do
       client = PushIo::Client.new
-      client.send(:send_url).should == "https://manage.push.io/api/v1/notify_app/1234/5678"
-      client = PushIo::Client.new(:app_guid => "aaaa", :sender_secret => "qqqq")
-      client.send(:send_url).should == "https://manage.push.io/api/v1/notify_app/aaaa/qqqq"
-      client = PushIo::Client.new(:endpoint_url => "http://somewhere.else.entirely.org")
-      client.send(:send_url).should == "http://somewhere.else.entirely.org/api/v1/notify_app/1234/5678"
+      client.send(:send_url).should == "#{endpoint_url}/api/v1/notify_app/#{app_guid}/#{sender_secret}"
+      client = PushIo::Client.new(:endpoint_url => "http://localhost:3000", :app_guid => "aaaa", :sender_secret => "qqqq")
+      client.send(:send_url).should == "http://localhost:3000/api/v1/notify_app/aaaa/qqqq"
+    end
+
+    it "sends inlined" do
+      notification_id = PushIo::Client.new.deliver_broadcast :payload => {:message => "Inlined Test"}
+      notification_id.should_not be_nil
+      notification_id.should start_with app_guid
+    end
+    it "sends a generic push" do
+      client = PushIo::Client.new
+      client.send(:httpclient).send(:debug_dev=, STDOUT)
+      notification_id = client.deliver :payload => {:message => "Generic Test"}, :tag_query => "Alpha or Bravo"
+      notification_id.should_not be_nil
+      notification_id.should start_with app_guid
+    end
+    it "sends a broadcast" do
+      client = PushIo::Client.new
+      client.send(:httpclient).send(:debug_dev=, STDOUT)
+      notification_id = client.deliver_broadcast :payload => {:message => "Broadcast Test"}
+      notification_id.should_not be_nil
+      notification_id.should start_with app_guid
+    end
+    it "sends to an audience" do
+      client = PushIo::Client.new
+      client.send(:httpclient).send(:debug_dev=, STDOUT)
+      notification_id = client.deliver_to_audience "broadcast", :payload => {:message => "Howdy Friends", :payload_apns => {:badge => 8}}
+      notification_id.should_not be_nil
+      notification_id.should start_with app_guid
+    end
+    it "sends a query push" do
+      client = PushIo::Client.new
+      client.send(:httpclient).send(:debug_dev=, STDOUT)
+      notification_id = client.deliver_to_query "Alpha or Bravo", :payload => {:message => "Query Test"}
+      notification_id.should_not be_nil
+      notification_id.should start_with app_guid
+    end
+
+    it "sends to device ids" do
+      client = PushIo::Client.new
+      client.send(:httpclient).send(:debug_dev=, STDOUT)
+      notification_id = client.deliver_to_ids api_key, [device_id], :payload => {:message => "Device ID Test"}
+      notification_id.should_not be_nil
+      notification_id.should start_with app_guid
+    end
+
+    it "sends to device tokens" do
+      client = PushIo::Client.new
+      client.send(:httpclient).send(:debug_dev=, STDOUT)
+      notification_id = client.deliver_to_tokens api_key, [device_token], :payload => {:message => "Device Token Test"}
+      notification_id.should_not be_nil
+      notification_id.should start_with app_guid
     end
   end
 

data/spec/pushio_config.example.yml

@@ -0,0 +1,2 @@
+:app_guid: ABCDEFGHIJ
+:sender_secret: xxxxxxxxxxxxxxxxxxxxx

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: pushio
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
-- Push IO LLC
+- Push IO Inc.
 - Sean McKibben
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &70259231551220 !ruby/object:Gem::Requirement
+  requirement: &70111734375140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 2.2.7
   type: :runtime
   prerelease: false
-  version_requirements: *70259231551220
+  version_requirements: *70111734375140
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70259231550500 !ruby/object:Gem::Requirement
+  requirement: &70111734374220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *70259231550500
+  version_requirements: *70111734374220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70259231549820 !ruby/object:Gem::Requirement
+  requirement: &70111734373300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70259231549820
+  version_requirements: *70111734373300
 description: ! 'Ruby client library to send push notifications via the Push IO API.
   See: http://push.io for more information and to set up your account.'
 email:
@@ -62,9 +62,11 @@ files:
 - lib/push_io/client.rb
 - lib/push_io/configuration.rb
 - lib/push_io/errors.rb
+- lib/push_io/utils.rb
 - lib/push_io/version.rb
 - pushio.gemspec
 - spec/push_io_spec.rb
+- spec/pushio_config.example.yml
 homepage: ''
 licenses: []
 post_install_message: 
@@ -92,3 +94,4 @@ summary: This gem enables developers to easily create new notifications and send
   via the Push IO API from Ruby apps.
 test_files:
 - spec/push_io_spec.rb
+- spec/pushio_config.example.yml