bmo 0.8.10 → 0.8.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjY1MWQ5Nzk5Yjg0ZWRkZjJmOTA2MTQwMjA0NWU0NjI5NjhhOGQ0Mw==
+    YWVjNzg2YTQ0NmNkMWNkYjI5NTYyZjZkNzg2NGM1NjE5NGI4OGY3Zg==
   data.tar.gz: !binary |-
-    OWY3Mjg3YzZhOWE2OTA3MDgxMWQwYzMyOWVmNTc0YTdhMDEzOWIyYg==
+    ZjdmZjgxZDNkYTgzZmE5Yzc0MjY4ZTg1M2E0MDQzYTI3ZmQzOTY1YQ==
 SHA512:
   metadata.gz: !binary |-
-    YTRjMjZkZjE3ZmIxYmRkNzJjNmY1Njc3ZDhiMmE5MjhlMTY0ZDI2NzdlNWFm
-    ODU2OWIwNTM5NjI5Y2M2NjIzOGVjNDEwYTMxNjI4YmE0Y2YwMGM3OWE1N2I0
-    YjcyNjUyM2VkYTZkOTBiYjEzYzYxNmU3NjUzNjNjNzg3MzcxZmE=
+    ZTI5ZmYwOTBlYTRmNWMyNWEwMjAzNWY4MWFjNWEwNDc4MjFiN2RlMjQ4MGI2
+    ZmE5ODA2MzVhOTU5NzY1OGIwODk0NTdkZjFkN2RmNzk1MDI0M2E0YTMxMDY1
+    NDA4OWU0ZWZlODc2YjlkYjNmZWE0Y2UxM2Y4ODQwZTg1OGQwNDg=
   data.tar.gz: !binary |-
-    ZTgzZGI1Y2ZjZDBjZjhjYjIyYjgzY2M3Y2U3M2Y4MDA5YjBjMmQzYWU3MmNh
-    ZjU3M2EzNmYyZDhiMDQxYTlmNzU5OTY0YTZmY2YwYmEzZjMzMTk4ZjQ5MDdi
-    N2U2ZjU3ZTg2ZTk2MGU1Nzc2Nzg3NmE4ODY4ZDAyMTU2ZTdhM2I=
+    ZmI0NWNhZGI0MGFlYjczZmI5ZGI4YmRlNjFiZTFjZTQ3MmVhZGY0OTA2ZTFk
+    ZjhiNWZlNzg2NWI2MmNiMDdjNjg0OGFkNGM1ZmEyMDBlMmUzZGE5NzVkNzVj
+    NGVhNTlhMjhkNTMwZWY0NWQ0MGZmNjBhYzVkYjAxYmNlNTBhM2Q=

data/Gemfile.lock

@@ -26,7 +26,7 @@ GIT
 PATH
   remote: .
   specs:
-    bmo (0.8.8)
+    bmo (0.8.7)
       equalizer (~> 0.0.0)
       faraday (> 0.8.0)
 

data/lib/bmo/apns/notification.rb

@@ -8,9 +8,9 @@ module BMO
 
       attr_reader :device_token, :payload
 
-      def initialize(device_token, payload)
+      def initialize(device_token, payload, options = {})
         @device_token = DeviceToken.new(device_token)
-        @payload      = Payload.new(payload)
+        @payload      = Payload.new(payload, options)
       end
 
       def to_package
@@ -40,23 +40,42 @@ module BMO
         # Define ==
         include Equalizer.new(:data)
 
-        attr_reader :data
+        attr_reader :data, :truncable_field, :options
 
-        def initialize(data)
-          @data = Utils.coerce_to_symbols(data)
+        def initialize(data, options = {})
+          @data            = data
+          @truncable_field = options[:truncable_field]
+          @options         = options
         end
 
         def to_package
-          data.to_json.bytes.to_a.pack('C*')
+          truncate_field! if truncable_field && !valid?
+          validate!
+          package
         end
 
         def validate!
-          if to_package.bytesize > MAX_BYTE_SIZE
-            str = "Payload byte size (#{to_package.bytesize})" \
-              " should be less than #{Payload::MAX_BYTE_SIZE} bytes"
-            fail PayloadTooLarge, str
-          end
-          true
+          return true if valid?
+          str = "Payload byte size (#{package.bytesize})" \
+            " should be less than #{Payload::MAX_BYTE_SIZE} bytes"
+          fail PayloadTooLarge, str
+        end
+
+        def package
+          data.to_json.bytes.to_a.pack('C*')
+        end
+
+        def truncate_field!
+          return unless data[:apns] && data[:apns][truncable_field]
+          string                = data[:apns][truncable_field]
+          diff_bytesize         = package.bytesize - MAX_BYTE_SIZE
+          desirable_bytesize    = (string.bytesize - diff_bytesize) - 1
+          data[:apns][truncable_field] = Utils
+            .bytesize_force_truncate(string, desirable_bytesize, options)
+        end
+
+        def valid?
+          package.bytesize < MAX_BYTE_SIZE
         end
       end # class Payload
 

data/lib/bmo/gcm/notification.rb

@@ -37,7 +37,7 @@ module BMO
         attr_reader :data
 
         def initialize(data)
-          @data = Utils.coerce_to_symbols(data)
+          @data = data
         end
 
         def to_package

data/lib/bmo/utils.rb

@@ -11,5 +11,33 @@ module BMO
       end
       hash_symbolized
     end
+
+    # Byte aware truncation
+    def self.bytesize_force_truncate(string, bytesize, options = {})
+      if bytesize <= 0
+        return ''
+      elsif bytesize > string.bytesize
+        return string.dup
+      end
+
+      options[:omission] ||= '...'
+      computed_bytesize = bytesize - options[:omission].bytesize
+      return bytesize_force_truncate(options[:omission],
+                                     bytesize,
+                                     omission: '') if computed_bytesize <= 0
+      new_string = ''
+
+      string.chars.each_with_index do |char, i|
+        break if (new_string + char).bytesize > computed_bytesize
+        new_string << char
+      end
+
+      stop =  if options[:separator]
+                new_string.rindex(options[:separator]) || new_string.length
+              else
+                new_string.length
+              end
+      (new_string[0...stop] + options[:omission]).to_s
+    end
   end
 end

data/lib/bmo/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # Main BMO module, version get right here
 module BMO
-  VERSION = '0.8.10'.freeze
+  VERSION = '0.8.11'.freeze
 end

data/lib/bmo.rb

@@ -25,14 +25,19 @@ module BMO
   #
   # @param device_token [String]
   # @param data [Hash] The data you want to send
+  # @option options :truncable_field If the payload is too large
+  #  this field will be truncated, it must be in a apns hash
+  # @option options :omission ('...') The omission in truncate
+  # @option options :separator The separator use in truncation
   #
   # @return The Socket#write return
   #
   # @see https://developer.apple.com/library/ios/documentation/
   #   NetworkingInternet/Conceptual/RemoteNotificationsPG/
   #   Chapters/ApplePushService.html
-  def self.send_ios_notification(device_token, data)
-    notification = APNS::Notification.new(device_token, data)
+  def self.send_ios_notification(device_token, data, options = {})
+    data = Utils.coerce_to_symbols(data)
+    notification = APNS::Notification.new(device_token, data, options)
     notification.validate!
     apns_client.send_notification(notification)
   end
@@ -55,6 +60,7 @@ module BMO
   #
   # @see http://developer.android.com/google/gcm/server.html]
   def self.send_android_notification(device_token, data)
+    data = Utils.coerce_to_symbols(data)
     notification = GCM::Notification.new(device_token, data)
     notification.validate!
     gcm_client.send_notification(notification)

data/spec/bmo/apns/notification_spec.rb

@@ -31,21 +31,6 @@ describe BMO::APNS::Notification::DeviceToken do
 end
 
 describe BMO::APNS::Notification::Payload do
-  it 'coerce hash keys to symbols' do
-    payload = described_class.new('Finn' => 'The Human')
-    expect(payload.data).to eq(Finn: 'The Human')
-  end
-
-  it "doesn't coerce incompatible types" do
-    payload = described_class.new(1 => 'For Money')
-    expect(payload.data).to eq(1 => 'For Money')
-  end
-
-  it 'returns true for equality between coerced hash and symbolized hash ' do
-    payload = described_class.new('Jake' => 'The Dog')
-    expect(payload).to eq(described_class.new(Jake: 'The Dog'))
-  end
-
   describe '#validate!' do
     it 'returns true if the payload is valid' do
       payload = described_class.new(apns: 'a' * 200)
@@ -57,4 +42,41 @@ describe BMO::APNS::Notification::Payload do
         BMO::APNS::Notification::Payload::PayloadTooLarge)
     end
   end
+
+  describe '#to_package' do
+    it 'truncates if there is a truncable field and this is not valid' do
+      options = { truncable_field: :message }
+      payload = described_class.new({ apns: { message: 'a' * 256 } }, options)
+      expect(payload.to_package).to eq("{\"apns\":{\"message\":\"#{'a' * 229}...\"}}")
+    end
+
+    it 'truncates to respect the MAX_BYTE_SIZE' do
+      options = { truncable_field: :message }
+      payload = described_class.new({ apns: { message: 'a' * 256 } }, options)
+      expect(payload.to_package.bytesize).to be < BMO::APNS::Notification::Payload::MAX_BYTE_SIZE
+    end
+  end
+
+  describe '#truncable_field!' do
+    it 'truncates the corresponding field in apns' do
+      options = { truncable_field: :message }
+      payload = described_class.new({ apns: { message: 'a' * 256 } }, options)
+      payload.truncate_field!
+      expect(payload.data[:apns][:message]).to eq(('a' * 229) + '...')
+    end
+
+    it 'truncates with omission' do
+      options = { truncable_field: :message, omission: '[more]' }
+      payload = described_class.new({ apns: { message: 'a' * 256 } }, options)
+      payload.truncate_field!
+      expect(payload.data[:apns][:message]).to eq(('a' * 226) + '[more]')
+    end
+
+    it 'truncates with separator' do
+      options = { truncable_field: :message, separator: ' ' }
+      payload = described_class.new({ apns: { message: 'test ' + ('a' * 255) } }, options)
+      payload.truncate_field!
+      expect(payload.data[:apns][:message]).to eq('test...')
+    end
+  end
 end

data/spec/bmo/utils_spec.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe BMO::Utils do
+  describe '#bytesize_force_truncate' do
+
+    it 'truncates the string' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', 10, omission: ''))
+        .to eq('Ça a déb')
+    end
+
+    it 'adds a default omission' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', 10))
+        .to eq('Ça a d...')
+    end
+
+    it 'adds accepts an optional omission params' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', 10, omission: '[more]'))
+        .to eq('Ça [more]')
+    end
+
+    it 'forces the returned string to be less or equal to the length' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', 10, omission: '[more]').bytesize)
+        .to be 10
+    end
+
+    it 'does not mutate the string' do
+      string = 'Ça a débuté comme ça.'
+      BMO::Utils.bytesize_force_truncate(string, 10)
+      expect(string.bytesize)
+        .to be > 10
+    end
+
+    it 'returns an empty string if the length if less than 1' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', -2))
+        .to eq('')
+    end
+
+    it 'returns the whole string if the length is more than the string length' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', 100000))
+        .to eq('Ça a débuté comme ça.')
+    end
+
+    it 'accepts a separator param' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', 20, separator: ' '))
+        .to eq('Ça a débuté...')
+    end
+
+    it 'returns an empty string if the length if less than 1' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', -2))
+        .to eq('')
+    end
+
+    it 'truncates the omission too' do
+      expect(BMO::Utils.bytesize_force_truncate('Ça a débuté comme ça.', 2))
+        .to eq('..')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bmo
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.8.11
 platform: ruby
 authors:
 - Antoine Lyset
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equalizer
@@ -95,6 +95,7 @@ files:
 - lib/bmo/utils.rb
 - lib/bmo/version.rb
 - spec/bmo/apns/notification_spec.rb
+- spec/bmo/utils_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/antoinelyset/bmo
 licenses:
@@ -122,5 +123,6 @@ specification_version: 4
 summary: Push notifications to iOS and Android devices
 test_files:
 - spec/bmo/apns/notification_spec.rb
+- spec/bmo/utils_spec.rb
 - spec/spec_helper.rb
 has_rdoc: