ghazel-em-apn 0.0.3.1

data/script/test

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "bundler/setup"
+require "em-apn"
+
+ENV["APN_KEY"]  = File.join(File.dirname(__FILE__), "..", "certs", "key.pem")
+ENV["APN_CERT"] = File.join(File.dirname(__FILE__), "..", "certs", "cert.pem")
+
+TOKEN = "fe9515ba7556cfdcfca6530235c95dff682fac765838e749a201a7f6cf3792e6"
+
+def notify(client, queue)
+  if queue.empty?
+    EM.add_periodic_timer(1) { EM.stop }
+  else
+    queue.pop do |alert|
+      notification = EM::APN::Notification.new(TOKEN, :alert => alert)
+      client.deliver(notification)
+
+      interval = rand(20).to_f / 100.0
+      EM.add_timer(interval) { notify(client, queue) }
+    end
+  end
+end
+
+EM.run do
+  client = EM::APN::Client.new(:gateway => "127.0.0.1")
+  queue = EM::Queue.new
+  queue.push *((1..5).to_a)
+  queue.push "DISCONNECT"
+  queue.push *((6..10).to_a)
+  queue.push "DISCONNECT"
+  queue.push *((11..15).to_a)
+
+  EM.next_tick { notify(client, queue) }
+end

data/spec/em-apn/client_spec.rb

@@ -0,0 +1,243 @@
+require "spec_helper"
+
+describe EventMachine::APN::Client do
+  def new_client(*args)
+    client = nil
+    EM.run_block {
+      client = EM.connect("localhost", 8888, EventMachine::APN::Client, *args)
+    }
+    client
+  end
+
+  describe ".new" do
+    it "creates a new client without a connection" do
+      client = EM::APN::Client.new
+      client.connection.should be_nil
+      client.feedback_connection.should be_nil
+    end
+
+    context "configuring the gateway" do
+      before do
+        ENV["APN_GATEWAY"] = nil
+      end
+
+      let(:options) { {:key => ENV["APN_KEY"], :cert => ENV["APN_CERT"]} }
+
+      it "defaults to Apple's sandbox (gateway.sandbox.push.apple.com)" do
+        client = EM::APN::Client.new
+        client.gateway.should == "gateway.sandbox.push.apple.com"
+        client.port.should == 2195
+      end
+
+      it "uses an environment variable for the gateway host (APN_GATEWAY) if specified" do
+        ENV["APN_GATEWAY"] = "localhost"
+
+        client = EM::APN::Client.new
+        client.gateway.should == "localhost"
+        client.port.should == 2195
+      end
+
+      it "switches to the production gateway if APN_ENV is set to 'production'" do
+        ENV["APN_ENV"] = "production"
+
+        client = EM::APN::Client.new
+        client.gateway.should == "gateway.push.apple.com"
+        client.port.should == 2195
+
+        ENV["APN_ENV"] = nil
+      end
+
+      it "takes arguments for the gateway and port" do
+        client = EM::APN::Client.new(:gateway => "localhost", :port => 3333)
+        client.gateway.should == "localhost"
+        client.port.should == 3333
+      end
+    end
+
+    context "configuring SSL" do
+      it "falls back to environment variables for key and cert (APN_KEY and APN_CERT) if they are unspecified" do
+        ENV["APN_KEY"]  = "path/to/key.pem"
+        ENV["APN_CERT"] = "path/to/cert.pem"
+
+        client = EM::APN::Client.new
+        client.key.should == "path/to/key.pem"
+        client.cert.should == "path/to/cert.pem"
+      end
+
+      it "takes arguments for the key and cert" do
+        client = EM::APN::Client.new(:key => "key.pem", :cert => "cert.pem")
+        client.key.should == "key.pem"
+        client.cert.should == "cert.pem"
+      end
+    end
+  end
+
+  describe "#connect" do
+    it "creates a connection to the gateway" do
+      client = EM::APN::Client.new
+      client.connection.should be_nil
+
+      EM.run_block { client.connect }
+      client.connection.should be_an_instance_of(EM::APN::Connection)
+    end
+
+    it "passes the client to the new connection" do
+      client = EM::APN::Client.new
+      connection = double(EM::APN::Connection).as_null_object
+
+      EM::APN::Connection.should_receive(:new).with(instance_of(Fixnum), client).and_return(connection)
+      EM.run_block { client.connect }
+    end
+  end
+
+  describe "#deliver" do
+    let(:token) { "fe9515ba7556cfdcfca6530235c95dff682fac765838e749a201a7f6cf3792e6" }
+
+    it "sends a Notification object" do
+      notification = EM::APN::Notification.new(token, :alert => "Hello world")
+      delivered = nil
+
+      EM.run_block do
+        client = EM::APN::Client.new
+        client.connect
+        client.connection.stub(:send_data).and_return do |data|
+          delivered = data.unpack("cNNnH64na*")
+          nil
+        end
+        client.deliver(notification)
+      end
+
+      delivered[4].should == token
+      delivered[6].should == MultiJson.encode({:aps => {:alert => "Hello world"}})
+    end
+
+    it "logs a message" do
+      alert = "Hello world this is a long push notification to you"
+
+      test_log = StringIO.new
+      EM::APN.logger = Logger.new(test_log)
+
+      notification = EM::APN::Notification.new(token, "alert" => alert)
+
+      EM.run_block do
+        client = EM::APN::Client.new
+        client.deliver(notification)
+      end
+
+      test_log.rewind
+      test_log.read.should include("TOKEN=#{token} PAYLOAD=#{notification.payload.inspect}")
+    end
+
+    context "when the notification is not valid" do
+      it "raises an exception" do
+        notification = EM::APN::Notification.new(token)
+        notification.stub(:validate!).and_raise(RuntimeError.new("Boo"))
+
+        expect {
+          EM.run_block do
+            client = EM::APN::Client.new
+            client.deliver(notification)
+          end
+        }.to raise_error(RuntimeError)
+      end
+    end
+  end
+
+  describe "#on_error" do
+    it "sets a callback that is invoked when we receive data from Apple" do
+      error = nil
+
+      EM.run_block do
+        client = EM::APN::Client.new
+        client.connect
+        client.on_error { |e| error = e }
+        client.connection.receive_data([8, 8, 0].pack("ccN"))
+      end
+
+      error.should be
+
+      error.command.should == 8
+      error.status_code.should == 8
+      error.identifier.should == 0
+
+      error.description.should == "Invalid token"
+      error.to_s.should == "CODE=8 ID=0 DESC=Invalid token"
+    end
+  end
+
+  describe "#on_close" do
+    it "sets a callback that is invoked when the connection closes" do
+      called = false
+
+      EM.run_block do
+        client = EM::APN::Client.new
+        client.on_close { called = true }
+        client.connect
+      end
+
+      called.should be_true
+    end
+  end
+
+  describe "#on_open" do
+    before do
+      @server = TCPServer.new(EventMachine::APN::Client::PORT)
+    end
+
+    after do
+      @server.close
+    end
+
+    it "sets a callback that is invoked when the connection is opened" do
+      called = false
+
+      EM.run_block do
+        client = EM::APN::Client.new
+        client.on_open { called = true }
+        client.connect
+      end
+
+      called.should be_true
+    end
+  end
+
+  describe "#connect_feedback" do
+    it "creates a connection to the feedback service" do
+      client = EM::APN::Client.new
+      client.feedback_connection.should be_nil
+
+      EM.run_block { client.connect_feedback }
+      client.feedback_connection.should be_an_instance_of(EM::APN::FeedbackConnection)
+    end
+
+    it "passes the client to the new connection" do
+      client = EM::APN::Client.new
+      connection = double(EM::APN::FeedbackConnection).as_null_object
+
+      EM::APN::FeedbackConnection.should_receive(:new).with(instance_of(Fixnum), client).and_return(connection)
+      EM.run_block { client.connect_feedback }
+    end
+  end
+
+  describe "#on_feedback" do
+    it "sets a callback that is invoked when we receive data from Apple" do
+      failed_attempt = nil
+
+
+      timestamp = Time.utc(1995, 12, 21)
+      device_token = 'fe15a27d5df3c34778defb1f4f3980265cc52c0c047682223be59fb68500a9a2'
+      tuple = [timestamp.to_i, 32, device_token].pack('NnH64')
+
+      EM.run_block do
+        client = EM::APN::Client.new
+        client.connect_feedback
+        client.on_feedback { |data | failed_attempt = data }
+        client.feedback_connection.receive_data(tuple)
+      end
+
+      failed_attempt.should be_an_instance_of(EM::APN::FailedDeliveryAttempt)
+      failed_attempt.device_token.should == device_token
+      failed_attempt.timestamp.should == timestamp
+    end
+  end
+end

data/spec/em-apn/notification_spec.rb

@@ -0,0 +1,182 @@
+# encoding: UTF-8
+require "spec_helper"
+
+describe EventMachine::APN::Notification do
+  let(:token) { "fe9515ba7556cfdcfca6530235c95dff682fac765838e749a201a7f6cf3792e6" }
+
+  describe "#initialize" do
+    it "raises an exception if the token is blank" do
+      expect { EM::APN::Notification.new(nil) }.to raise_error
+      expect { EM::APN::Notification.new("") }.to raise_error
+    end
+
+    it "raises an exception if the token is less than or greater than 32 bytes" do
+      expect { EM::APN::Notification.new("0" * 63) }.to raise_error
+      expect { EM::APN::Notification.new("0" * 65) }.to raise_error
+    end
+  end
+
+  describe "#token" do
+    it "returns the token" do
+      notification = EM::APN::Notification.new(token)
+      notification.token.should == token
+    end
+  end
+
+  describe "#payload" do
+    it "returns aps properties encoded as JSON" do
+      notification = EM::APN::Notification.new(token, {
+        :alert => "Hello world",
+        :badge => 10,
+        :sound => "ding.aiff"
+      })
+      payload = MultiJson.decode(notification.payload)
+      payload["aps"]["alert"].should == "Hello world"
+      payload["aps"]["badge"].should == 10
+      payload["aps"]["sound"].should == "ding.aiff"
+    end
+
+    it "returns custom properties as well" do
+      notification = EM::APN::Notification.new(token, {}, {:line => "I'm super bad"})
+      payload = MultiJson.decode(notification.payload)
+      payload["line"].should == "I'm super bad"
+    end
+
+    it "handles string keys" do
+      notification = EM::APN::Notification.new(token,
+        {
+          "alert" => "Hello world",
+          "badge" => 10,
+          "sound" => "ding.aiff"
+        },
+        {
+          "custom" => "param"
+        }
+      )
+      payload = MultiJson.decode(notification.payload)
+      payload["aps"]["alert"].should == "Hello world"
+      payload["aps"]["badge"].should == 10
+      payload["aps"]["sound"].should == "ding.aiff"
+      payload["custom"].should == "param"
+    end
+  end
+
+  describe "#data" do
+    it "returns the enhanced notification in the supported binary format" do
+      notification = EM::APN::Notification.new(token, {:alert => "Hello world"})
+      data = notification.data.unpack("cNNnH64na*")
+      data[4].should == token
+      data[5].should == notification.payload.length
+      data[6].should == notification.payload
+    end
+
+    it "handles UTF-8 payloads" do
+      string = "✓ Please"
+      notification = EM::APN::Notification.new(token, {:alert => string})
+      data = notification.data.unpack("cNNnH64na*")
+      data[4].should == token
+      data[5].should == [notification.payload].pack("a*").size
+      data[6].force_encoding("UTF-8").should == notification.payload
+    end
+
+    it "defaults the identifier and expiry to 0" do
+      notification = EM::APN::Notification.new(token, {:alert => "Hello world"})
+      data = notification.data.unpack("cNNnH64na*")
+      data[1].should == 0 # Identifier
+      data[2].should == 0 # Expiry
+    end
+  end
+
+  describe "#validate!" do
+    it "raises PayloadTooLarge error if PAYLOAD_MAX_BYTES exceeded" do
+      notification = EM::APN::Notification.new(token, {:alert => "X" * 512})
+
+      lambda {
+        notification.validate!
+      }.should raise_error(EM::APN::Notification::PayloadTooLarge)
+    end
+  end
+
+  describe "#identifier=" do
+    it "sets the identifier, which is returned in the binary data" do
+      notification = EM::APN::Notification.new(token)
+      notification.identifier = 12345
+      notification.identifier.should == 12345
+
+      data = notification.data.unpack("cNNnH64na*")
+      data[1].should == notification.identifier
+    end
+
+    it "converts everything to an integer" do
+      notification = EM::APN::Notification.new(token)
+      notification.identifier = "12345"
+      notification.identifier.should == 12345
+    end
+
+    it "can be set in the initializer" do
+      notification = EM::APN::Notification.new(token, {}, {}, {:identifier => 12345})
+      notification.identifier.should == 12345
+    end
+  end
+
+  describe "#expiry=" do
+    it "sets the expiry, which is returned in the binary data" do
+      epoch = Time.now.to_i
+      notification = EM::APN::Notification.new(token)
+      notification.expiry = epoch
+      notification.expiry.should == epoch
+
+      data = notification.data.unpack("cNNnH64na*")
+      data[2].should == epoch
+    end
+
+    it "can be set in the initializer" do
+      epoch = Time.now.to_i
+      notification = EM::APN::Notification.new(token, {}, {}, {:expiry => epoch})
+      notification.expiry.should == epoch
+    end
+  end
+
+  describe "#truncate_alert!" do
+    context "when the data size would exceed the APN limit" do
+      it "truncates the alert" do
+        notification = EM::APN::Notification.new(token, { "alert" => "X" * 300 })
+        notification.data.size.should be > EM::APN::Notification::DATA_MAX_BYTES
+
+        notification.truncate_alert!
+        notification.data.size.should be <= EM::APN::Notification::DATA_MAX_BYTES
+        parsed_payload = MultiJson.decode(notification.payload)
+        parsed_payload["aps"]["alert"].size.should == 191
+      end
+
+      it "truncates the alert properly when symbol payload keys are used" do
+        notification = EM::APN::Notification.new(token, { "alert" => "X" * 300 })
+        notification.truncate_alert!
+        notification.data.size.should be <= EM::APN::Notification::DATA_MAX_BYTES
+      end
+
+      it "truncates the alert properly when it is JSON serialized into a different size" do
+        notification = EM::APN::Notification.new(token, { "alert" => '"' * 300 })
+        notification.truncate_alert!
+        parsed_payload = MultiJson.decode(notification.payload)
+        parsed_payload["aps"]["alert"].size.should == 95
+      end
+
+      it "truncates the alert properly for multi-byte Unicode characters" do
+        notification = EM::APN::Notification.new(token, { "alert" => [57352].pack('U') * 500 })
+        notification.truncate_alert!
+        parsed_payload = MultiJson.decode(notification.payload)
+        parsed_payload["aps"]["alert"].size.should == 63
+      end
+    end
+
+    context "when the data size would not exceed the APN limit" do
+      it "does not change the alert" do
+        notification = EM::APN::Notification.new(token, { "alert" => "Hello world" })
+        notification.truncate_alert!
+        parsed_payload = MultiJson.decode(notification.payload)
+        parsed_payload["aps"]["alert"].should == "Hello world"
+      end
+    end
+  end
+end

data/spec/extensions/hash_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Hash do
+  describe "stringify_keys!" do
+    it "returns the hash" do
+      {}.stringify_keys!.should eq({})
+    end
+
+    it "converts keys into strings" do
+      hash = {
+        :symbol => "value",
+        1       => "value",
+        []      => "value"
+      }
+
+      hash.stringify_keys!
+
+      hash.keys.should =~ ["symbol", "1", "[]"]
+    end
+
+    it "leaves string keys untouched" do
+      string = stub
+      string.should_receive(:kind_of?).with(String).and_return(true)
+
+      symbol = stub(to_s: "symbol")
+      symbol.should_receive(:kind_of?).with(String).and_return(false)
+
+      hash = {
+        string => "value",
+        symbol => "value"
+      }
+
+      hash.stringify_keys!
+
+      hash.keys.should =~ ["symbol", string]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "rubygems"
+require "bundler/setup"
+Bundler.require :default, :development
+
+RSpec.configure do |config|
+  config.before(:each) do
+    ENV["APN_KEY"]     = "spec/support/certs/key.pem"
+    ENV["APN_CERT"]    = "spec/support/certs/cert.pem"
+    ENV["APN_GATEWAY"] = "127.0.0.1"
+
+    EM::APN.logger = Logger.new("/dev/null")
+  end
+end

data/spec/support/certs/cert.pem

@@ -0,0 +1,17 @@
+-----BEGIN CERTIFICATE-----
+MIICqjCCAhOgAwIBAgIJAO3gD8Fv66MhMA0GCSqGSIb3DQEBBQUAMEMxCzAJBgNV
+BAYTAlVTMREwDwYDVQQIEwhOZXcgWW9yazERMA8GA1UEBxMITmV3IFlvcmsxDjAM
+BgNVBAoTBUR1bW15MB4XDTExMDYyMTE5MDAyOFoXDTIxMDYxODE5MDAyOFowQzEL
+MAkGA1UEBhMCVVMxETAPBgNVBAgTCE5ldyBZb3JrMREwDwYDVQQHEwhOZXcgWW9y
+azEOMAwGA1UEChMFRHVtbXkwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMsR
+05wNdOiFXil3/r4xGLXc7MYwU2LiZbnXAqaoGnLv3W8cN7i/0i63y8YYITNWm3ji
+lMiOkj2+TNVE/PiFizFBqhT28V/AsfOsiJrYQ4GXwLwJTsgDGTwAJgov0yPIffhK
+n9jU7NLNJjhrj0rVD++eNOT8dunvYRlI5S8lJWCNAgMBAAGjgaUwgaIwHQYDVR0O
+BBYEFISS0qC22So8BtQYTT4n/iLdYnZnMHMGA1UdIwRsMGqAFISS0qC22So8BtQY
+TT4n/iLdYnZnoUekRTBDMQswCQYDVQQGEwJVUzERMA8GA1UECBMITmV3IFlvcmsx
+ETAPBgNVBAcTCE5ldyBZb3JrMQ4wDAYDVQQKEwVEdW1teYIJAO3gD8Fv66MhMAwG
+A1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAFBGom218pNCB1zYxhDDtOiYC
+DyU9rZkLXxMVjSHCvyBtQ3EC/21Zog05LSBMvOHFmfzPbyX/IYxSglJLJlQBzGtP
+trVx1slmva3/QoKYwAKdAe5oSY8eDqejBpKO12maSGsPwbw3oREmudeWkrFFVAlP
+hlkmwpq7901kIg4CCe8=
+-----END CERTIFICATE-----

data/spec/support/certs/key.pem

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXQIBAAKBgQDLEdOcDXTohV4pd/6+MRi13OzGMFNi4mW51wKmqBpy791vHDe4
+v9Iut8vGGCEzVpt44pTIjpI9vkzVRPz4hYsxQaoU9vFfwLHzrIia2EOBl8C8CU7I
+Axk8ACYKL9MjyH34Sp/Y1OzSzSY4a49K1Q/vnjTk/Hbp72EZSOUvJSVgjQIDAQAB
+AoGBAIHk8Ef076BAlz/Naty7yQOjwqzvgpdRHCLo3uA9zVVSC4GkOhxqTwblOGqJ
+SsttDdwgi21SjUcDcGBHVc2elq6SNx9A0mwhb9uPBUI74pJdbrN3/Ue1UnaKy7KZ
+1PGlMi8GtBL5cn5+NCs/IJUZIIp3oNxURJTF54tun6ygOeddAkEA74rcrXRvFAab
+mMwQuGlFCNU1ns6Zm19tBFBadTUJQl0cB0MAS9BKveXGOsxXVChR0JvDTnTnx5a4
+SwKz3t/irwJBANkFeJdZy9Ve5mzzY3rt6sCorOPo9+lER4K01HB6h24vWB1DIFRE
+YNNiK7YBVHrnb4mcKSdP93QXlYoAugP974MCQQDrVPACVI5ADVHV5j1S/tC8ocJg
+9zW/iBtxDoQf++/Ry+maVL+4u7SCJXf/EfuFiWr/V9ejf4Sp96+sucX+YtOvAkBs
+cVts5aYBHMavsn8HMlOXqbGawRMAMOo62fk9qzx5RpcVKDHDadeoSOnmrIt2Tqdh
+b/Lwffj8vbwvlWVeEUnZAkBwGrhn+BzcfsPLIQfyfC13c1oLJNTZ/ktQdiZIp9Sn
+Zmaf4yBl3NekmgdNQUGdbPBEUl32ukVhOkfOhI2qZcbA
+-----END RSA PRIVATE KEY-----

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ghazel-em-apn
+version: !ruby/object:Gem::Version
+  version: 0.0.3.1
+platform: ruby
+authors:
+- Dave Yeu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.3
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: 
+email:
+- daveyeu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- certs/.gitignore
+- em-apn.gemspec
+- lib/em-apn.rb
+- lib/em-apn/client.rb
+- lib/em-apn/connection.rb
+- lib/em-apn/error_response.rb
+- lib/em-apn/failed_delivery_attempt.rb
+- lib/em-apn/feedback_connection.rb
+- lib/em-apn/log_message.rb
+- lib/em-apn/notification.rb
+- lib/em-apn/response.rb
+- lib/em-apn/server.rb
+- lib/em-apn/test_helper.rb
+- lib/em-apn/version.rb
+- lib/extensions/hash.rb
+- script/push
+- script/server
+- script/test
+- spec/em-apn/client_spec.rb
+- spec/em-apn/notification_spec.rb
+- spec/extensions/hash_spec.rb
+- spec/spec_helper.rb
+- spec/support/certs/cert.pem
+- spec/support/certs/key.pem
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: em-apn
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: EventMachine-driven Apple Push Notifications
+test_files:
+- spec/em-apn/client_spec.rb
+- spec/em-apn/notification_spec.rb
+- spec/extensions/hash_spec.rb
+- spec/spec_helper.rb
+- spec/support/certs/cert.pem
+- spec/support/certs/key.pem