crusade-apns 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b99d15d9bd5de7752db570201d229fe1ff16e6bd
-  data.tar.gz: 04bfd747ca356f60c9a03cddf688a5013d203f8c
+  metadata.gz: 0586aee6082f8c106b83cfb352e88a0c0a8bb348
+  data.tar.gz: 1948a8c7e2baccc2a20c3be98a90f8dca1c830ef
 SHA512:
-  metadata.gz: a0447cf0e5df77f18b0ce32df590f95b7ab90be81bea9790f46d60bf87958d4b572cee2af05c9fa2a5d44ff8ea7597e58f5ffbd74a76a1c4bc6832707f2cbe8a
-  data.tar.gz: 7213bfce39dce624752ab0439b26eb78c3d2283921568b31a69c1fd834e458846eb05e5db813d73b185b2ff515330252f5b7ce4247afae4909fd0a3064195396
+  metadata.gz: 2534d6f2fb94d062f5bc90724d3a5c6283fd70230835d5329ab1399c13fc0a789ebf6fe99bc64ecaa90d1e8da108a8528bdec114f17bb40c2fa887980f966168
+  data.tar.gz: 758a16b9e8470388a53cca1f91c71f7e533dde02c26ccdfea16f8037fb02f74d0410492c9f925f369727ab36131afb6b1fcca1e2d89d4f5a9670e26bc26e7626

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+.ruby-version

data/.travis.yml

@@ -6,4 +6,6 @@ rvm:
   - 2.0.0
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
+    - rvm:
+      - jruby-19mode
+      - rbx-19mode

data/lib/crusade/apns/notification.rb

@@ -0,0 +1,48 @@
+module Crusade
+  module APNS
+    class Notification
+      attr_accessor :title, :body, :action, :url_args, :device_token
+
+      def initialize(attrs = {} )
+        self.title        =  attrs.fetch(:title)       { nil }
+        self.body         = attrs.fetch(:body)         { nil }
+        self.action       = attrs.fetch(:action)       { nil }
+        self.url_args     = attrs.fetch(:url_args)     { []  }
+        self.device_token = attrs.fetch(:device_token) { nil }
+      end
+
+      def to_json
+        payload.to_json
+      end
+
+      def json_size
+        to_json.size
+      end
+
+      private
+
+      def payload
+        {
+          "aps" => aps
+        }
+      end
+
+      def alert
+        h = {
+          "title" => title,
+          "body" => body
+        }
+        h.update "action" => action if action
+        h
+      end
+
+      def aps
+        h = {
+          "alert" => alert,
+        }
+        h.update "url-args" => url_args if url_args.any?
+        h
+      end
+    end
+  end
+end

data/lib/crusade/apns/notification_builder.rb

@@ -0,0 +1,46 @@
+require 'crusade/apns/notification'
+
+module Crusade
+  module APNS
+    class NotificationBuilder
+
+      def initialize
+        self.notification = Crusade::APNS::Notification.new
+      end
+
+      def build
+        notification
+      end
+
+      def with_title(title)
+        notification.title = title
+        self
+      end
+
+      def with_body(body)
+        notification.body = body
+        self
+      end
+
+      def with_action(action)
+        notification.action = action
+        self
+      end
+
+      def with_url_args(url_args)
+        notification.url_args = url_args
+        self
+      end
+
+      def with_device_token(device_token)
+        notification.device_token = device_token
+        self
+      end
+
+      private
+
+      attr_accessor :notification
+
+    end
+  end
+end

data/lib/crusade/apns/notification_encoder.rb

@@ -0,0 +1,38 @@
+module Crusade
+  module APNS
+    class NotificationEncoder
+      def initialize configuration
+        self.configuration = configuration
+      end
+
+      def encode notification
+        to_binary(notification)
+      end
+
+      private
+
+      attr_accessor :configuration
+
+      def to_binary(notification)
+        [
+           1,
+           id_for_pack,
+           expiry,
+           0,
+           32,
+           notification.device_token,
+           notification.json_size,
+           notification.to_json
+        ].pack("cNNccH*na*")
+      end
+
+      def expiry
+        86400
+      end
+
+      def id_for_pack
+        0
+      end
+    end
+  end
+end

data/lib/crusade/apns/push_notification.rb

@@ -0,0 +1,28 @@
+require 'crusade/apns/socket_connection'
+
+module Crusade
+  module APNS
+    class PushNotification
+      attr_reader :configuration
+
+      def initialize(configuration, connection = nil)
+        self.configuration = configuration
+        self.encoder = NotificationEncoder.new(configuration)
+        self.connection = connection
+      end
+
+      def send notification
+        connection.send encoder.encode notification
+      end
+
+      private
+
+      attr_accessor :encoder
+      attr_writer   :configuration, :connection
+
+      def connection
+        @connection ||= Crusade::APNS::SocketConnection.new(configuration)
+      end
+    end
+  end
+end

data/lib/crusade/apns/push_package_generator.rb

@@ -12,6 +12,9 @@ module Crusade
       end
 
       def generate user_id
+        FileUtils.remove_entry_secure configuration.temp_dir
+        FileUtils.mkdir configuration.temp_dir
+
         push_package = File.join(configuration.temp_dir, file_name(user_id))
 
         DirectoryStructureGenerator.new(configuration).generate
@@ -30,8 +33,9 @@ module Crusade
         [ user_token, push_package ]
       end
 
-      def clean
-        # FileUtils.remove_entry_secure destination
+      def clean(push_package)
+        FileUtils.remove_entry_secure push_package
+      rescue Errno::ENOENT => e
       end
 
       private

data/lib/crusade/apns/socket_connection.rb

@@ -0,0 +1,54 @@
+module Crusade
+  module APNS
+    class SocketConnection
+      attr_accessor :host, :port
+
+      def initialize(configuration)
+        self.configuration = configuration
+
+        self.host = 'gateway.push.apple.com'
+        self.port = 2195
+      end
+
+      def send data
+        write data
+      end
+
+      private
+
+      attr_accessor :configuration
+
+      def open_connection
+        sock         = TCPSocket.new(host, port)
+        ssl          = OpenSSL::SSL::SSLSocket.new(sock, context)
+        ssl.connect
+
+        return sock, ssl
+      end
+
+      def write binary
+        sock, ssl = open_connection
+
+        ssl.write(binary)
+
+        ssl.close
+        sock.close
+      end
+
+      def context
+        ssl_context      = OpenSSL::SSL::SSLContext.new
+        ssl_context.cert = OpenSSL::X509::Certificate.new(p12_certificate.certificate.to_pem)
+        ssl_context.key  = OpenSSL::PKey::RSA.new(p12_certificate.key.to_pem)
+
+        ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+        ssl_context
+      end
+
+      def p12_certificate
+        @p12 ||= OpenSSL::PKCS12.new File.read(configuration.certificate),
+                                     configuration.certificate_password
+      end
+    end
+  end
+end

data/lib/crusade/apns/version.rb

@@ -1,5 +1,5 @@
 module Crusade
   module APNS
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/test/integration/push_notification_test.rb

@@ -0,0 +1,43 @@
+require File.expand_path '../../test_helper.rb', __FILE__
+
+require 'fixtures'
+require 'fake_apns_server'
+require 'base64'
+require 'timeout'
+
+describe Crusade::APNS::PushNotification do
+  let(:options) { Fixtures.default_configuration }
+  subject { Crusade::APNS::PushNotification.new options, connection }
+  let(:connection) { Crusade::APNS::SocketConnection.new options }
+
+  describe 'send' do
+    let(:server) { FakeApnsServer.new options }
+
+    before do
+      connection.host = '127.0.0.1'
+      server.start
+    end
+
+    after  { server.stop  }
+
+    let(:binary) do
+<<-eof
+AQAAAAAAAVGAACASNKAAXHsiYXBzIjp7ImFsZXJ0Ijp7InRpdGxlIjoidGhl
+IHRpdGxlIiwiYm9keSI6InRoZSBib2R5IiwiYWN0aW9uIjoic3VibWl0In0s
+InVybC1hcmdzIjpbImEiXX19
+eof
+    end
+
+    it 'sends the binary representation of the notification' do
+      subject.send Fixtures.default_notification
+
+      Timeout::timeout(1, ThreadError) { while(server.received.size == 0) ; end }
+
+      server.received.last.must_equal Base64.decode64 binary
+    end
+  end
+
+  describe 'configuration' do
+    it { subject.configuration.must_be_same_as options }
+  end
+end

data/test/integration/push_package_generator_test.rb

@@ -8,15 +8,15 @@ require 'zip_support'
 
 describe Crusade::APNS::PushPackageGenerator do
   let(:options) { Fixtures.default_configuration }
-  subject { Crusade::APNS::PushPackageGenerator.new options }
+  let(:user_id) { '1234' }
 
-  describe 'generate' do
-    let(:user_id) { '1234' }
+  let(:generated)    { subject.generate user_id }
+  let(:push_package) { generated[1] }
+  let(:user_token)   { generated[0] }
 
-    let(:generated)    { subject.generate user_id }
-    let(:push_package) { generated[1] }
-    let(:user_token)   { generated[0] }
+  subject { Crusade::APNS::PushPackageGenerator.new options }
 
+  describe 'generate' do
     let(:tmp_dir) { Dir.mktmpdir }
 
     after do
@@ -36,5 +36,26 @@ describe Crusade::APNS::PushPackageGenerator do
       files.must_equal_contents %w(manifest.json website.json signature icon.iconset/) + icons
       user_token.wont_be_nil
     end
+
+    it 'can generate twice in a row' do
+      subject.generate user_id
+      subject.generate user_id
+
+      File.exists?(push_package).must_be_truthy
+    end
+  end
+
+  describe 'clean' do
+    it 'removes the push package' do
+      push_package
+
+      subject.clean push_package
+
+      File.exists?(push_package).must_equal false
+    end
+
+    it 'does not blow up if the file does not exist' do
+      subject.clean 'foo'
+    end
   end
 end

data/test/support/fake_apns_server.rb

@@ -0,0 +1,51 @@
+require "socket"
+require "openssl"
+require "thread"
+
+class FakeApnsServer
+  attr_reader :received
+
+  def initialize(configuration)
+    self.port = 2195
+    self.configuration = configuration
+    self.received = []
+  end
+
+  def start
+    cert = OpenSSL::PKCS12.new(File.read(configuration.certificate), configuration.certificate_password)
+    
+    server = TCPServer.new(port)
+
+    ssl_context = OpenSSL::SSL::SSLContext.new
+
+    ssl_context.cert = OpenSSL::X509::Certificate.new(cert.certificate.to_pem)
+    ssl_context.key  = OpenSSL::PKey::RSA.new(cert.key.to_pem)
+    ssl_server       = OpenSSL::SSL::SSLServer.new(server, ssl_context)
+
+    launch_thread(ssl_server)
+  end
+
+  def stop
+    thread.terminate
+  end
+
+  private
+
+  attr_accessor :port, :configuration, :thread
+  attr_writer :received
+
+  def launch_thread(ssl_server)
+    self.thread = Thread.new {
+      loop do
+        connection = ssl_server.accept
+        while (line_in = connection.gets)
+          register_received line_in.chomp
+        end
+      end
+    }
+  end
+
+  def register_received line
+    received << line
+  end
+end

data/test/support/fixtures.rb

@@ -1,5 +1,7 @@
 require 'tmpdir'
 
+require 'crusade/apns/push_notification'
+
 class Fixtures
   def self.default_configuration
     OpenStruct.new({
@@ -15,4 +17,14 @@ class Fixtures
       certificate_password: 'test'
     })
   end
+
+  def self.default_notification
+    Crusade::APNS::Notification.new({
+      title: 'the title',
+      body: 'the body',
+      action: 'submit',
+      url_args: ['a'],
+      device_token: '1234a'
+    })
+  end
 end

data/test/unit/notification_builder_test.rb

@@ -0,0 +1,76 @@
+require File.expand_path '../../test_helper.rb', __FILE__
+
+require 'crusade/apns/notification_builder'
+
+describe Crusade::APNS::NotificationBuilder do
+  let(:described_class) { Crusade::APNS::NotificationBuilder }
+  subject { described_class.new }
+
+  describe 'build' do
+    it' creates a notification' do
+      notification = subject.build
+
+      notification.is_a?(Crusade::APNS::Notification).must_be_true
+    end
+  end
+
+  describe 'with_title' do
+    it 'returns the builder' do
+      subject.with_title('test').must_be_same_as subject
+    end
+
+    it 'sets the title of the notification' do
+      notif = subject.with_title('test').build
+
+      notif.title.must_equal 'test'
+    end
+  end
+
+  describe 'with_body' do
+    it 'returns the builder' do
+      subject.with_body('test').must_be_same_as subject
+    end
+
+    it 'sets the body of the notification' do
+      notif = subject.with_body('test').build
+
+      notif.body.must_equal 'test'
+    end
+  end
+
+  describe 'with_action' do
+    it 'returns the builder' do
+      subject.with_action('test').must_be_same_as subject
+    end
+
+    it 'sets the action of the notification' do
+      notif = subject.with_action('test').build
+
+      notif.action.must_equal 'test'
+    end
+  end
+
+  describe 'with_url_args' do
+    it 'returns the builder' do
+      subject.with_url_args('test').must_be_same_as subject
+    end
+
+    it 'sets the url_args of the notification' do
+      notif = subject.with_url_args(['test']).build
+
+      notif.url_args.must_equal ['test']
+    end
+  end
+
+  describe 'with_device_token' do
+    it 'returns the builder' do
+      subject.with_device_token('test').must_be_same_as subject
+    end
+
+    it 'sets the url_args of the notification' do
+      notif = subject.with_device_token('test').build
+
+      notif.device_token.must_equal 'test'
+    end
+  end
+end

data/test/unit/notification_encoder_test.rb

@@ -0,0 +1,29 @@
+require File.expand_path '../../test_helper.rb', __FILE__
+
+require 'crusade/apns/notification_encoder'
+
+require 'base64'
+require 'fixtures'
+
+describe Crusade::APNS::NotificationEncoder do
+  let(:described_class) { Crusade::APNS::NotificationEncoder }
+
+  let(:options) { Fixtures.default_configuration }
+
+  subject { Crusade::APNS::NotificationEncoder.new options }
+
+  describe 'encode' do
+    let(:notification) { Fixtures.default_notification }
+    let(:expected) do
+<<-eof
+AQAAAAAAAVGAACASNKAAXHsiYXBzIjp7ImFsZXJ0Ijp7InRpdGxlIjoidGhl
+IHRpdGxlIiwiYm9keSI6InRoZSBib2R5IiwiYWN0aW9uIjoic3VibWl0In0s
+InVybC1hcmdzIjpbImEiXX19
+eof
+    end
+
+    let(:encoded) { subject.encode notification }
+
+    it { encoded.must_equal Base64.decode64(expected) }
+  end
+end

data/test/unit/notification_test.rb

@@ -0,0 +1,88 @@
+require File.expand_path '../../test_helper.rb', __FILE__
+
+require 'crusade/apns/notification'
+
+describe Crusade::APNS::Notification do
+  let(:described_class) { Crusade::APNS::Notification }
+
+  let(:attrs) do
+    {
+      title: 'the title',
+      body: 'the body',
+      action: 'submit',
+      url_args: ['a'],
+      device_token: '1234a'
+    }
+  end
+
+  describe 'initialize' do
+    subject { described_class.new }
+
+    it 'initializes the title' do
+      subject.title.must_be_nil
+    end
+
+    it 'initializes the body' do
+      subject.body.must_be_nil
+    end
+
+    it 'initializes the action' do
+      subject.action.must_be_nil
+    end
+
+    it 'initializes the url_args' do
+      subject.url_args.must_equal []
+    end
+
+    it 'initializes the device_token' do
+      subject.device_token.must_be_nil
+    end
+
+    describe 'with a hash' do
+      subject { described_class.new attrs }
+
+      it { subject.title.must_equal 'the title' }
+      it { subject.body.must_equal 'the body' }
+      it { subject.action.must_equal 'submit' }
+      it { subject.url_args.must_equal ['a'] }
+      it { subject.device_token.must_equal '1234a' }
+    end
+
+    describe 'payload and co' do
+      subject { described_class.new attrs }
+
+      let(:parsed_payload) { JSON.parse(subject.to_json) }
+      let(:expected_payload) do
+        {
+          "aps" => {
+            "alert" => {
+              "title" => 'the title',
+              "body" => 'the body',
+              "action" => 'submit'
+            },
+            "url-args" => ['a']
+          }
+        }
+      end
+
+      it { parsed_payload.must_equal expected_payload }
+      it { subject.json_size.must_equal 92 }
+
+      describe 'no url_args' do
+        before do
+          subject.url_args = []
+        end
+
+        it { parsed_payload['aps'].has_key?('url-args').must_be_false }
+      end
+
+      describe 'no action' do
+        before do
+          subject.action = nil
+        end
+
+        it { parsed_payload['aps']['alert'].has_key?('action').must_be_false }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crusade-apns
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - David Rouchy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-17 00:00:00.000000000 Z
+date: 2013-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -111,12 +111,17 @@ files:
 - lib/crusade/apns.rb
 - lib/crusade/apns/configuration.rb
 - lib/crusade/apns/crypto/user_token_generator.rb
+- lib/crusade/apns/notification.rb
+- lib/crusade/apns/notification_builder.rb
+- lib/crusade/apns/notification_encoder.rb
+- lib/crusade/apns/push_notification.rb
 - lib/crusade/apns/push_package/directory_structure_generator.rb
 - lib/crusade/apns/push_package/manifest_generator.rb
 - lib/crusade/apns/push_package/signature_generator.rb
 - lib/crusade/apns/push_package/website_file_generator.rb
 - lib/crusade/apns/push_package/zip_file_generator.rb
 - lib/crusade/apns/push_package_generator.rb
+- lib/crusade/apns/socket_connection.rb
 - lib/crusade/apns/version.rb
 - signature
 - test/fixtures/config.yml
@@ -136,19 +141,23 @@ files:
 - test/fixtures/ssl/manifest_example.json
 - test/fixtures/ssl/signature
 - test/fixtures/ssl/signature_example
+- test/integration/push_notification_test.rb
 - test/integration/push_package_generator_test.rb
 - test/integration/user_token_generator_test.rb
+- test/support/fake_apns_server.rb
 - test/support/fixtures.rb
 - test/support/ssl_support.rb
 - test/support/zip_support.rb
 - test/test_helper.rb
 - test/unit/configuration_test.rb
+- test/unit/notification_builder_test.rb
+- test/unit/notification_encoder_test.rb
+- test/unit/notification_test.rb
 - test/unit/push_package/directory_structure_generator_test.rb
 - test/unit/push_package/manifest_generator_test.rb
 - test/unit/push_package/signature_generator_test.rb
 - test/unit/push_package/website_file_generator_test.rb
 - test/unit/push_package/zip_file_generator_test.rb
-- test/unit/push_package_generator_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -191,16 +200,20 @@ test_files:
 - test/fixtures/ssl/manifest_example.json
 - test/fixtures/ssl/signature
 - test/fixtures/ssl/signature_example
+- test/integration/push_notification_test.rb
 - test/integration/push_package_generator_test.rb
 - test/integration/user_token_generator_test.rb
+- test/support/fake_apns_server.rb
 - test/support/fixtures.rb
 - test/support/ssl_support.rb
 - test/support/zip_support.rb
 - test/test_helper.rb
 - test/unit/configuration_test.rb
+- test/unit/notification_builder_test.rb
+- test/unit/notification_encoder_test.rb
+- test/unit/notification_test.rb
 - test/unit/push_package/directory_structure_generator_test.rb
 - test/unit/push_package/manifest_generator_test.rb
 - test/unit/push_package/signature_generator_test.rb
 - test/unit/push_package/website_file_generator_test.rb
 - test/unit/push_package/zip_file_generator_test.rb
-- test/unit/push_package_generator_test.rb

data/test/unit/push_package_generator_test.rb

@@ -1,6 +0,0 @@
-require File.expand_path '../../test_helper.rb', __FILE__
-
-require 'crusade/apns/push_package_generator'
-
-describe Crusade::APNS::PushPackageGenerator do
-end