adck 0.1.0 → 0.2.0

data/README.md

@@ -31,7 +31,7 @@ You can set the defaults for all connections created by setting them on the `ADC
 ### Quick send one notification
 
 	device_token = '123abc456def'
-	
+
 	ADCK(device_token, 'POPUP!')
 
 is equivalent to
@@ -41,7 +41,7 @@ is equivalent to
 also the same
 
 	ADCK.send_notification(device_token, body: 'POPUP!')
-	
+
 All of these quick sendings use the default server values and open and close the connection for each notification.
 
 ### Multiple notifications
@@ -57,7 +57,7 @@ The `Message` creates the payload which is sent to the iPhone.
 To send many messages quickly
 
 	n2 = ADCK::Notification.new(device_token, 'POPUP2!)
-	
+
 	ADCK.send_notifications([n1,n2])
 
 or you can
@@ -89,11 +89,11 @@ Messages are passed all the way though so in the previous example where we ran `
 Here are some examples of messages:
 
 	ADCK::Message.new(body: 'This is what the user sees')
-	
+
 Now lets add a sound and a badge count:
-	
+
 	ADCK::Message.new(body: 'This is what the user sees', sound: 'default', badge: 5)
-	
+
 What if we don't want to show an action button, just want to pop up a notification with an "OK" button.
 
 	ADCK::Message.new(body: 'Something you cant do anything about', action_loc_key: nil)
@@ -109,7 +109,7 @@ This will open and close a new connection to the server. If you want to use an e
 
 	conn = ADCK::Connection.new
 	m.connection = conn
-	
+
 	conn.open
 	m.send_to([token1,token2,…,tokenN])
 	m.send_to([token1,token2,…,tokenN])
@@ -123,11 +123,11 @@ There's one caviat, the message is compiled and frozen upon sending to improve p
 	m.body = 'Cute Kitty2' #=> RuntimeError: can't modify frozen ADCK::Message
 
 You can however dupe
-	
+
 	m = m.dup
 	m.body = 'Cute Kitty2'
 	m.send_to([token1,token2,…,tokenN])
-	
+
 or you can tell the message to not freeze it
 
 	m = ADCK::Message.new(body: 'Cute Kitty!', action_loc_key: "PET_IT", freeze: false)
@@ -135,15 +135,22 @@ or you can tell the message to not freeze it
 	m.body = 'Cute Kitty2'
 	m.send_to([token1,token2,…,tokenN])
 
+#### Extra parameters
+
+* freeze: if set to false the message wont be frozen when packaged up
+* validate: disable valdation of size and other values
+* truncate: Truncate the value of `body` if it would cause the message to be too
+large
+
 ### Connection
 
 A good example of when you'd want to use multiple connections is if you have different `.pem` files (for different apps maybe) that you want to use.
 
 	conn_iphone = ADCK::Connection.new(pem: Rails.root+'config/pem/iphone.pem')
 	conn_ipad = ADCK::Connection.new(pem: Rails.root+'config/pem/ipad.pem')
-	
+
 	n = ADCK::Notification.new(token, "Sent to both iPhone and iPad apps")
 	n2 = ADCK::Notification.new(token2, "Sent to iPad app")
-	
+
 	conn_iphone.send_notification(n)
 	conn_ipad.send_notifications([n,n2])

data/lib/adck/message.rb

@@ -7,23 +7,37 @@ module ADCK
       :alert, :badge, :sound, :other
     ]
     attr_accessor *FIELDS
-    attr_accessor :connection
+    attr_accessor :connection, :truncate
 
     def initialize(message)
       if message.is_a? Hash
         @validate = message[:validate]
         @freeze = message[:freeze]
+        @truncate = message.delete(:truncate)
       end
 
-      set_values_from_arg(message)
-
       self.other ||= {}
+
+      set_values_from_arg(message)
     end
 
-    def alert
+    def alert test=false
       a = {}
 
-      a[:body] = body if body
+      if test
+        a[:body] = ''
+      elsif body
+        if truncate && body.bytesize > @max_body_length
+          truncate_with = truncate.is_a?(String) ? truncate : '...'
+
+          set_body = body[0...(@max_body_length-truncate_with.length)]
+          set_body << truncate_with
+        else
+          set_body = body
+        end
+
+        a[:body] = set_body
+      end
 
       if action_loc_key # is not false or nil
         a[:'action-loc-key'] = action_loc_key
@@ -48,15 +62,20 @@ module ADCK
       @action_loc_key = val.nil? ? false : val
     end
 
-    def aps
+    def aps test=false
       a = {}
-      _alert = alert
+      _alert = alert(test)
       a[:alert] = _alert unless _alert.empty?
       a[:badge] = badge if badge
       a[:sound] = sound if sound
       a
     end
 
+    def test_payload
+      allowed = MultiJson.dump(other.merge(aps: aps(true))).bytesize
+      @max_body_length = 255-allowed
+    end
+
     def payload(options={})
       other.merge(aps: aps)
     end
@@ -144,6 +163,8 @@ module ADCK
       else
         raise "Message needs to have either a hash or string"
       end
+
+      test_payload
     end
 
     class PayloadTooLarge < RuntimeError; end

data/lib/adck/version.rb

@@ -1,3 +1,3 @@
 module ADCK
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/adck/message_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ADCK::Message do
+
+  context "message is too long" do
+    let(:message) {'hello ' *100}
+
+    it "should truncate with dots default" do
+      msg = ADCK::Message.new(body: message, truncate: true)
+      json = msg.package
+
+      MultiJson.load(json)['aps']['alert']['body'][-3,3].should == '...'
+    end
+
+    it "should truncate with defined value" do
+      msg = ADCK::Message.new(body: message, truncate: '[end]')
+      json = msg.package
+
+      MultiJson.load(json)['aps']['alert']['body'][-5,5].should == '[end]'
+    end
+
+    it "should raise error" do
+      msg = ADCK::Message.new(body: message)
+      expect {msg.package}.to raise_error(ADCK::Message::PayloadTooLarge)
+    end
+  end
+
+end

data/spec/adck/notification_spec.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ADCK::Notification do
+
+end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
 gem 'rspec', '>= 1.2.8'
 require 'rspec'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'apns')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'adck')
 require 'base64'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adck
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -63,7 +63,8 @@ files:
 - lib/adck/message.rb
 - lib/adck/notification.rb
 - lib/adck/version.rb
-- spec/apns/notification_spec.rb
+- spec/adck/message_spec.rb
+- spec/adck/notification_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/delight-labs/ADCK
 licenses: []
@@ -90,5 +91,6 @@ signing_key:
 specification_version: 3
 summary: Simple Apple push notification service gem
 test_files:
-- spec/apns/notification_spec.rb
+- spec/adck/message_spec.rb
+- spec/adck/notification_spec.rb
 - spec/spec_helper.rb

data/spec/apns/notification_spec.rb

@@ -1,44 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-describe ADCK::Notification do
-
-  it "should take a string as the message" do
-    n = ADCK::Notification.new('device_token', 'Hello')
-    n.alert.should == 'Hello'
-  end
-
-  it "should take a hash as the message" do
-    n = ADCK::Notification.new('device_token', {:alert => 'Hello iPhone', :badge => 3})
-    n.alert.should == "Hello iPhone"
-    n.badge.should == 3
-  end
-
-  describe '#packaged_message' do
-
-    it "should return JSON with notification information" do
-      n = ADCK::Notification.new('device_token', {:alert => 'Hello iPhone', :badge => 3, :sound => 'awesome.caf'})
-      n.packaged_message.should  == "{\"aps\":{\"alert\":\"Hello iPhone\",\"badge\":3,\"sound\":\"awesome.caf\"}}"
-    end
-
-    it "should not include keys that are empty in the JSON" do
-      n = ADCK::Notification.new('device_token', {:badge => 3})
-      n.packaged_message.should == "{\"aps\":{\"badge\":3}}"
-    end
-
-  end
-
-  describe '#package_token' do
-    it "should package the token" do
-      n = ADCK::Notification.new('<5b51030d d5bad758 fbad5004 bad35c31 e4e0f550 f77f20d4 f737bf8d 3d5524c6>', 'a')
-      Base64.encode64(n.packaged_token).should == "W1EDDdW611j7rVAEutNcMeTg9VD3fyDU9ze/jT1VJMY=\n"
-    end
-  end
-
-  describe '#packaged_notification' do
-    it "should package the token" do
-      n = ADCK::Notification.new('device_token', {:alert => 'Hello iPhone', :badge => 3, :sound => 'awesome.caf'})
-      Base64.encode64(n.packaged_notification).should == "AAAg3vLO/YTnAEB7ImFwcyI6eyJhbGVydCI6IkhlbGxvIGlQaG9uZSIsImJh\nZGdlIjozLCJzb3VuZCI6ImF3ZXNvbWUuY2FmIn19\n"
-    end
-  end
-
-end