five_mobile_push 0.4.1 → 0.4.2

data/Rakefile

@@ -1,2 +1,13 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Build the gemfile"
+task :build do
+  sh "gem build five_mobile_push.gemspec"
+end
+task :gem => :build

data/lib/five_mobile_push/message.rb

@@ -21,7 +21,7 @@ module FiveMobilePush
 
       # @private
       def to_payload
-        FiveMobilePush::Payload.new(@body, @meta_data)
+        FiveMobilePush::Payload.new(@body, @meta_data || {})
       end
     end
   end

data/lib/five_mobile_push/payload.rb

@@ -2,17 +2,27 @@ module FiveMobilePush
   # @private Used internally. You'll never use this class directly.
   #   Documented for the benefit of contributors.
   class Payload
-    attr_reader   :message
-    attr_accessor :meta_data
+    MAXIMUM_MESSAGE_LENGTH = 128
+
+    # This exception is raised when a payload meta data exceed its maximum length
+    class MessageTooLargeError < ArgumentError
+    end
+
+    attr_reader :message, :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)
+    def initialize(message, meta_data={})
       self.message   = message
       self.meta_data = meta_data
     end
 
+    def meta_data=(new_meta_data)
+      validate_meta_data!(new_meta_data)
+      @meta_data = new_meta_data
+    end
+
     # @param [#to_s] message The message you wish to send with a notice
     def message=(message)
       @message = message.to_s
@@ -25,17 +35,33 @@ module FiveMobilePush
 
     private
 
+    def validate_meta_data!(meta_data)
+      meta_data_is_correct_type!(meta_data)
+      meta_data_messages_is_valid_length!(meta_data)
+    end
+
+    def meta_data_is_correct_type!(meta_data)
+      unless meta_data.is_a?(Hash)
+        raise ArgumentError, 'meta_data must be a Hash'
+      end
+    end
+
+    # @todo Better error message for lengthy meta data
+    def meta_data_messages_is_valid_length!(meta_data)
+      unless meta_data.all? { |k, v| v.length <= MAXIMUM_MESSAGE_LENGTH }
+        raise MessageTooLargeError
+      end
+    end
+
     def as_json
-      payload = {
+      {
         'msg' => {
           'type'  => 'string',
           'value' => message
         },
         'sound'  => 'default',
         'launch' => true
-      }
-      payload['meta'] = meta_data if meta_data
-      payload
+      }.merge(meta_data)
     end
   end
 end

data/lib/five_mobile_push/version.rb

@@ -1,3 +1,3 @@
 module FiveMobilePush
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/spec/five_mobile_push/notifier_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'uri'
 
 describe FiveMobilePush::Notifier do
-
   let(:client) { Fabricate.build(:client) }
 
   subject { FiveMobilePush::Notifier.new(client) }
@@ -15,15 +14,14 @@ describe FiveMobilePush::Notifier do
 
       subject.broadcast(:iphone) do |message|
         message.body "Minor downtime tonight from 7PM-9PM EST"
+        message.meta_data :a => '/a/b/c'
       end
 
       a_request(:post, broadcast_endpoint).should have_been_made
     end
-
   end
 
   describe '#notify_devices' do
-
     let(:notify_devices_endpoint) { notifier_endpoint('toDevices') }
 
     it "notifies a list of devices" do
@@ -31,15 +29,14 @@ describe FiveMobilePush::Notifier do
 
       subject.notify_devices(['abc', 'def']) do |message|
         message.body 'You win a prize!'
+        message.meta_data :a => '/a/b/c'
       end
 
       a_request(:post, notify_devices_endpoint).should have_been_made
     end
-
   end
 
   describe "#notify_by_tags" do
-
     let(:notify_by_tags_endpoint) { notifier_endpoint('toTags') }
 
     it "notifies devices by tags" do
@@ -47,15 +44,14 @@ describe FiveMobilePush::Notifier do
 
       subject.notify_by_tags([:iphone, :android], ['tag1', 'tag2']) do |message|
         message.body 'tag1 and tag2'
+        message.meta_data :a => '/a/b/c'
       end
 
       a_request(:post, notify_by_tags_endpoint).should have_been_made
     end
-
   end
 
   def notifier_endpoint(name)
     "https://push.fivemobile.com/rest/notify/#{name}"
   end
-
 end

data/spec/five_mobile_push/payload_spec.rb

@@ -1,6 +1,30 @@
 require 'spec_helper'
 
 describe FiveMobilePush::Payload do
+  describe '#meta_data=' do
+    subject { Fabricate.build(:payload) }
+
+    it 'sets meta data' do
+      subject.meta_data = meta_data = { a: 'b' }
+      subject.meta_data.should == meta_data
+    end
+
+    it 'raises an ArgumentError if a Hash is not provided' do
+      expect {
+        subject.meta_data = nil
+      }.to raise_error(ArgumentError, 'meta_data must be a Hash')
+    end
+
+    it 'raises a MessageTooLargeError if a value is too large in the meta data' do
+      expect {
+        subject.meta_data = {
+          just_right: 'c' * FiveMobilePush::Payload::MAXIMUM_MESSAGE_LENGTH,
+          too_long:   'f' * FiveMobilePush::Payload::MAXIMUM_MESSAGE_LENGTH.next
+        }
+      }.to raise_error(FiveMobilePush::Payload::MessageTooLargeError)
+    end
+  end
+
   describe '#to_json' do
     subject { Fabricate.build(:payload) }
 
@@ -8,13 +32,9 @@ describe FiveMobilePush::Payload 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')
+    it 'includes any meta data' do
+      subject.meta_data = { a: 'b' }
+      subject.to_json.should include('"a":"b"')
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: five_mobile_push
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Kevin Faustino
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 -04:00
+date: 2011-05-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency