five_mobile_push 0.2.0 → 0.3.0

data/five_mobile_push.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", ["~> 2.5.0"]
   s.add_development_dependency "yajl-ruby"
   s.add_development_dependency "webmock"
+  s.add_development_dependency "fabrication", ["~> 0.9.5"]
 end

data/lib/five_mobile_push/device.rb

@@ -3,6 +3,8 @@ module FiveMobilePush
 
     VALID_OPTION_KEYS = [:alias, :email]
 
+    attr_reader :device_uid
+
     # @param [FiveMobilePush::Client] client The Client to use to send this request
     #
     # @param [String] device_uid The ID of the device being registered.

data/lib/five_mobile_push/notifier.rb

@@ -5,31 +5,54 @@ module FiveMobilePush
       @client = client
     end
 
-    def broadcast(platforms, payload)
-      @client.post 'notify/broadcast', :platforms => self.class.build_platforms_string(platforms), :payload => MultiJson.encode(payload)
+    def broadcast(platforms, &block)
+      @client.post 'notify/broadcast',
+        :platforms => build_platforms_string(platforms),
+        :payload   => capture_payload(&block).to_json
     end
-    
-    def notify_devices(devices, payload)
-      @client.post 'notify/toDevices', :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_values => devices.join(','), :payload => MultiJson.encode(payload)
+
+    def notify_devices(devices, &block)
+      @client.post 'notify/toDevices',
+        :id_type   => FiveMobilePush::DEFAULT_ID_TYPE,
+        :id_values => devices.join(','),
+        :payload   => capture_payload(&block).to_json
     end
 
-    def notify_by_tags(platforms, tags, payload)
-      @client.post 'notify/toTags', 
-        :platforms => self.class.build_platforms_string(platforms),
-        :tags => tags.join(','),
-        :payload => MultiJson.encode(payload)
+    def notify_by_tags(platforms, tags, &block)
+      @client.post 'notify/toTags',
+        :platforms => build_platforms_string(platforms),
+        :tags      => tags.join(','),
+        :payload   => capture_payload(&block).to_json
     end
 
-    class << self
+    private
+
+    def capture_payload(&block)
+      payload_proxy = PayloadProxy.new
+      block.call(payload_proxy)
+      payload_proxy.to_payload
+    end
 
-      def build_platforms_string(platforms)      
-        if platforms.kind_of?(Enumerable)
-          platforms.join(',')
-        else
-          platforms.to_s
-        end
+    def build_platforms_string(platforms)
+      if platforms.kind_of?(Enumerable)
+        platforms.join(',')
+      else
+        platforms.to_s
       end
+    end
 
+    class PayloadProxy
+      def message(message)
+        @message = message
+      end
+
+      def meta_data(meta_data)
+        @meta_data = meta_data
+      end
+
+      def to_payload
+        FiveMobilePush::Payload.new(@message, @meta_data)
+      end
     end
 
   end

data/lib/five_mobile_push/payload.rb

@@ -0,0 +1,39 @@
+module FiveMobilePush
+  class Payload
+    attr_reader   :message
+    attr_accessor :meta_data
+
+    # @param [#to_s] message The message you wish to send with a notice
+    # @param [Hash] meta_data (nil) Any meta data to send along with the
+    #   notice. Leave as +nil+ if none is to be sent.
+    def initialize(message, meta_data=nil)
+      self.message   = message
+      self.meta_data = meta_data
+    end
+
+    # @param [#to_s] message The message you wish to send with a notice
+    def message=(message)
+      @message = message.to_s
+    end
+
+    # @return [String] JSON representation of the Payload
+    def to_json
+      MultiJson.encode(as_json)
+    end
+
+    private
+
+    def as_json
+      payload = {
+        'msg' => {
+          'type'  => 'string',
+          'value' => message
+        },
+        'sound'  => 'default',
+        'launch' => true
+      }
+      payload['meta'] = meta_data if meta_data
+      payload
+    end
+  end
+end

data/lib/five_mobile_push/version.rb

@@ -1,3 +1,3 @@
 module FiveMobilePush
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/five_mobile_push.rb

@@ -4,13 +4,14 @@ require 'five_mobile_push/client'
 module FiveMobilePush
   extend self
 
-  autoload :Device, 'five_mobile_push/device'
+  autoload :Device,   'five_mobile_push/device'
   autoload :Notifier, 'five_mobile_push/notifier'
-  autoload :Tag, 'five_mobile_push/tag'
+  autoload :Tag,      'five_mobile_push/tag'
+  autoload :Payload,  'five_mobile_push/payload'
 
   class UnauthorizedError < StandardError; end
-  class GeneralError < StandardError; end
-  class ServerError < StandardError; end
+  class GeneralError      < StandardError; end
+  class ServerError       < StandardError; end
 
 
   VALID_OPTION_KEYS = [:api_token, :application_uid]

data/spec/fabricators/client.rb

@@ -0,0 +1,4 @@
+Fabricator(:client, :class_name => FiveMobilePush::Client) do
+  api_token       'token'
+  application_uid 'nulayer'
+end

data/spec/fabricators/device.rb

@@ -0,0 +1,3 @@
+Fabricator(:device, :class_name => FiveMobilePush::Device) do
+  on_init { init_with(Fabricate.build(:client), '2b6f0cc904d137be2e1730235f5664094b831186') }
+end

data/spec/fabricators/payload.rb

@@ -0,0 +1,3 @@
+Fabricator(:payload, :class_name => FiveMobilePush::Payload) do
+  on_init { init_with('bacon', 'foo' => 'bar') }
+end

data/spec/five_mobile_push/device_spec.rb

@@ -2,17 +2,11 @@ require 'spec_helper'
 
 describe FiveMobilePush::Device do
 
-  let(:api_token)       { 'token' }
-
-  let(:application_uid) { 'nulayer' }
-
-  let(:client) { FiveMobilePush::Client.new(:api_token => api_token, :application_uid => application_uid) }
-
-  let(:device_uid) { '2b6f0cc904d137be2e1730235f5664094b831186' }
+  let(:client) { Fabricate.build(:client) }
 
   let(:device_token) { 'ABCDEFG' }
 
-  subject { FiveMobilePush::Device.new(client, device_uid) }
+  subject { Fabricate.build(:device) }
 
   describe '#register' do
 
@@ -29,7 +23,7 @@ describe FiveMobilePush::Device do
 
     context "registration data is provided" do
 
-      let(:body) { build_request_body(:device_id => device_uid, :reg_data => device_token, :device_info => MultiJson.encode(device_info)) }
+      let(:body) { build_request_body(client, :device_id => subject.device_uid, :reg_data => device_token, :device_info => MultiJson.encode(device_info)) }
       
       before(:each) do
         stub_request(:post, register_endpoint).to_return(:body => load_fixture('register.json'))
@@ -50,7 +44,7 @@ describe FiveMobilePush::Device do
     context "registration data is not provided" do
 
       it "registers a device" do
-        body = build_request_body(:device_id => device_uid, :device_info => device_info)
+        body = build_request_body(client, :device_id => subject.device_uid, :device_info => device_info)
         stub_request(:post, register_endpoint)
         subject.register(device_info)
 
@@ -63,7 +57,7 @@ describe FiveMobilePush::Device do
 
   context "id_value and id_type passed to service" do
 
-    let(:body) { build_request_body(:id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid) }
+    let(:body) { build_request_body(client, :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => subject.device_uid) }
 
     describe '#resume' do
 

data/spec/five_mobile_push/notifier_spec.rb

@@ -3,28 +3,20 @@ require 'uri'
 
 describe FiveMobilePush::Notifier do
 
-  let(:api_token) { 'token' }
-  let(:application_uid) { 'nulayer' }
-  let(:client) { FiveMobilePush::Client.new :api_token => api_token, :application_uid => application_uid }
-
-  subject { FiveMobilePush::Notifier.new client }
-
-  let(:payload) do
-    {
-      :msg => {
-        :type => "string",
-        :value => "You sir are awesome"
-      }
-    }
-  end
+  let(:client) { Fabricate.build(:client) }
 
-  describe "#broadcast" do
+  subject { FiveMobilePush::Notifier.new(client) }
 
+  describe "#broadcast" do
     let(:broadcast_endpoint) { notifier_endpoint('broadcast') }
 
     it "broadcasts a notification to one or more platforms of the application" do
       stub_request(:post, broadcast_endpoint)
-      subject.broadcast :iphone, payload
+
+      subject.broadcast(:iphone) do |payload|
+        payload.message "Minor downtime tonight from 7PM-9PM EST"
+      end
+
       a_request(:post, broadcast_endpoint).should have_been_made
     end
 
@@ -36,7 +28,11 @@ describe FiveMobilePush::Notifier do
 
     it "notifies a list of devices" do
       stub_request(:post, notify_devices_endpoint)
-      subject.notify_devices ['abc', 'def'], payload
+
+      subject.notify_devices(['abc', 'def']) do |payload|
+        payload.message 'You win a prize!'
+      end
+
       a_request(:post, notify_devices_endpoint).should have_been_made
     end
 
@@ -48,7 +44,11 @@ describe FiveMobilePush::Notifier do
 
     it "notifies devices by tags" do
       stub_request(:post, notify_by_tags_endpoint)
-      subject.notify_by_tags [:iphone, :android], ['tag1', 'tag2'], payload
+
+      subject.notify_by_tags([:iphone, :android], ['tag1', 'tag2']) do |payload|
+        payload.message 'tag1 and tag2'
+      end
+
       a_request(:post, notify_by_tags_endpoint).should have_been_made
     end
 

data/spec/five_mobile_push/payload_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe FiveMobilePush::Payload do
+  describe '#to_json' do
+    subject { Fabricate.build(:payload) }
+
+    it 'includes the message' do
+      subject.to_json.should include(subject.message)
+    end
+
+    it 'includes meta data' do
+      subject.to_json.should include(MultiJson.encode(subject.meta_data))
+    end
+
+    it 'excludes meta data if there is none' do
+      subject.meta_data = nil
+      subject.to_json.should_not include('meta')
+    end
+  end
+end

data/spec/five_mobile_push/tags_spec.rb

@@ -2,12 +2,10 @@ require 'spec_helper'
 
 describe FiveMobilePush::Tag do
 
-  let(:api_token) { 'token' }
-  let(:application_uid) { 'nulayer' }
-  let(:client) { FiveMobilePush::Client.new :api_token => api_token, :application_uid => application_uid }
+  let(:client)     { Fabricate.build(:client) }
   let(:device_uid) { 'ABCD123' }
 
-  subject { FiveMobilePush::Tag.new client, device_uid }
+  subject { FiveMobilePush::Tag.new(client, device_uid) }
 
   describe "#create" do
 
@@ -15,14 +13,14 @@ describe FiveMobilePush::Tag do
     let(:tags) { %w(tag1 tag2) }
 
     it "adds new tags to Five Mobile" do
-      body = build_request_body(:id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => escape(tags.join(',')) )
+      body = build_request_body(client, :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => escape(tags.join(',')) )
       stub_request(:post, add_tag_endpoint).with(:body => body)
       subject.create tags
       a_request(:post, add_tag_endpoint).with(:body => body).should have_been_made
     end
 
     it "adds a new tag to Five Mobile" do
-      body = build_request_body(:id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => "cheese")
+      body = build_request_body(client, :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => "cheese")
       stub_request(:post, add_tag_endpoint).with(:body => body)
       subject.create("cheese")
       a_request(:post, add_tag_endpoint).with(:body => body).should have_been_made
@@ -36,14 +34,14 @@ describe FiveMobilePush::Tag do
     let(:delete_tag_endpoint) { tag_endpoint("delete") }
 
     it "unsubscribes from further notifications for tags" do
-      body = build_request_body(:id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => escape(tags.join(',')))
+      body = build_request_body(client, :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => escape(tags.join(',')))
       stub_request(:post, delete_tag_endpoint).with(:body => body)
       subject.delete(tags)
       a_request(:post, delete_tag_endpoint).with(:body => body).should have_been_made
     end
 
     it "unsubscribes from further notifications for tag" do
-      body = build_request_body(:id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => "bacon")
+      body = build_request_body(client, :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => device_uid, :tags => "bacon")
       stub_request(:post, delete_tag_endpoint).with(:body => body)
       subject.delete("bacon")
       a_request(:post, delete_tag_endpoint).with(:body => body).should have_been_made

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'rspec'
 require 'webmock/rspec'
 require 'yajl'
 require 'uri'
+require 'fabrication'
 
 RSpec.configure do |config|
   config.mock_with :rspec
@@ -12,8 +13,8 @@ def load_fixture(name)
   File.read File.expand_path("../fixtures/#{name}", __FILE__)
 end
 
-def build_request_body(data)
-  data = data.merge(:api_token => api_token, :application_id => application_uid)
+def build_request_body(client, data)
+  data = data.merge(:api_token => client.api_token, :application_id => client.application_uid)
   String.new.tap do |body|
     data.each do |key,value|
       body << "#{key}=#{value}"

metadata

@@ -2,7 +2,7 @@
 name: five_mobile_push
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kevin Faustino
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-01 00:00:00 -04:00
+date: 2011-04-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,6 +69,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: fabrication
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+  type: :development
+  version_requirements: *id006
 description: API wrapper for Five Mobile Push notification service
 email: 
 - kevin.faustino@gmail.com
@@ -90,11 +101,16 @@ files:
 - lib/five_mobile_push/client.rb
 - lib/five_mobile_push/device.rb
 - lib/five_mobile_push/notifier.rb
+- lib/five_mobile_push/payload.rb
 - lib/five_mobile_push/tag.rb
 - lib/five_mobile_push/version.rb
+- spec/fabricators/client.rb
+- spec/fabricators/device.rb
+- spec/fabricators/payload.rb
 - spec/five_mobile_push/client_spec.rb
 - spec/five_mobile_push/device_spec.rb
 - spec/five_mobile_push/notifier_spec.rb
+- spec/five_mobile_push/payload_spec.rb
 - spec/five_mobile_push/tags_spec.rb
 - spec/five_mobile_push_spec.rb
 - spec/fixtures/register.json
@@ -128,9 +144,13 @@ signing_key:
 specification_version: 3
 summary: API wrapper for Five Mobile Push notification service
 test_files: 
+- spec/fabricators/client.rb
+- spec/fabricators/device.rb
+- spec/fabricators/payload.rb
 - spec/five_mobile_push/client_spec.rb
 - spec/five_mobile_push/device_spec.rb
 - spec/five_mobile_push/notifier_spec.rb
+- spec/five_mobile_push/payload_spec.rb
 - spec/five_mobile_push/tags_spec.rb
 - spec/five_mobile_push_spec.rb
 - spec/fixtures/register.json