houston 0.1.1 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 665f646fd8d10f128f8b408a5723bdfa846a6e49
+  data.tar.gz: a7d075a67f504cbdfcbebe585d21e8e26d770d9e
+SHA512:
+  metadata.gz: 00c7bc4612f323d159411ce835a21e5c28acf85395c685bab5b7ad87e9d1a7d0378d02e2c4980e29bbb10bfe32c4ad844d04447c37edb18954ff36bafa58ab87
+  data.tar.gz: 4b4be23b6122e002f391e5d4577cae6897f519696008c5c926e1e39de917055bba0e6740cf53533b967cd14da8581076e2f4d65ab5e89ff84681f4fece50e530

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    houston (0.1.1)
-      commander (~> 4.1.2)
-      json (~> 1.7.3)
+    houston (0.2.1)
+      commander (~> 4.1)
+      json
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    commander (4.1.2)
+    commander (4.1.3)
       highline (~> 1.6.11)
-    highline (1.6.15)
-    json (1.7.5)
+    highline (1.6.18)
+    json (1.7.7)
     rake (0.9.2.2)
     rspec (0.6.4)
 
@@ -20,5 +20,5 @@ PLATFORMS
 
 DEPENDENCIES
   houston!
-  rake (~> 0.9.2)
-  rspec (~> 0.6.1)
+  rake (~> 0.9)
+  rspec (~> 0.6)

data/README.md

@@ -1,23 +1,23 @@
 # Houston
 **Apple Push Notifications. No Dirigible Required**
 
-> Houston, We Have Liftoff!
-
 Push Notifications don't have to be difficult.
 
 Houston is a simple gem for sending Apple Push Notifications. Pass your credentials, construct your message, and send it.
 
 In a production application, you will probably want to schedule or queue notifications into a background job. Whether you're using [queue_classic](https://github.com/ryandotsmith/queue_classic), [resque](https://github.com/defunkt/resque), or rolling you own infrastructure, integrating Houston couldn't be simpler.
 
-Another caveat is that Houston doesn't manage device tokens for you. Infrastructures can vary dramatically for these kinds of things, so being agnostic and not forcing any conventions here is more a feature than a bug, perhaps. Treat it the same way as you would an e-mail address, associating one or many for each user account.
+Another caveat is that Houston doesn't manage device tokens for you. For that, you should check out [Helios](http://helios.io)
+
+> Houston's is named for [Houston, TX](http://en.wikipedia.org/wiki/Houston), the metonymical home of [NASA's Johnson Space Center](http://en.wikipedia.org/wiki/Lyndon_B._Johnson_Space_Center), as in _Houston, We Have Liftoff!_.
+
+> It's part of a series of world-class command-line utilities for iOS development, which includes [Cupertino](https://github.com/mattt/cupertino) (Apple Dev Center management), [Shenzhen](https://github.com/mattt/shenzhen) (Building & Distribution), [Venice](https://github.com/mattt/venice) (In-App Purchase Receipt Verification), and [Dubai](https://github.com/mattt/dubai) (Passbook pass generation).
 
-_That said, a simple web service adapter, similar to [Rack::CoreData](https://github.com/mattt/rack-core-data) is in the cards._
+> This project is also part of a series of open source libraries covering the mission-critical aspects of an iOS app's infrastructure. Be sure to check out its sister projects: [GroundControl](https://github.com/mattt/GroundControl), [SkyLab](https://github.com/mattt/SkyLab), [houston](https://github.com/mattt/houston), and [Orbiter](https://github.com/mattt/Orbiter).
 
 ## Installation
 
-```
-$ gem install houston
-```
+    $ gem install houston
 
 ## Usage
 
@@ -34,22 +34,38 @@ token = "<ce8be627 2e43e855 16033e24 b4c28922 0eeda487 9c477160 b2545e95 b68b596
 notification = Houston::Notification.new(device: token)
 notification.alert = "Hello, World!"
 
-# Notifications can also change the badge count, have a custom sound, or pass along arbitrary data.
+# Notifications can also change the badge count, have a custom sound, indicate available Newsstand content, or pass along arbitrary data.
 notification.badge = 57
 notification.sound = "sosumi.aiff"
+notification.content_available = true
 notification.custom_data = {foo: "bar"}
 
 # And... sent! That's all it takes.
 APN.push(notification)
 ```
 
+### Persistent Connections
+
+If you want to manage your own persistent connection to Apple push services, such as for background workers, here's how to do it:
+
+```ruby
+certificate = File.read("/path/to/apple_push_notification.pem")
+passphrase = "..."
+connection = Houston::Connection.new(APPLE_DEVELOPMENT_GATEWAY_URI, certificate, passphrase)
+connection.open
+
+notification = Houston::Notification.new(device: token)
+notification.alert = "Hello, World!"
+connection.write(notification.message)
+
+connection.close
+```
+
 ## Command Line Tool
 
 Houston also comes with the `apn` binary, which provides a convenient way to test notifications from the command line.
 
-```
-$ apn push "<token>" -c /path/to/apple_push_notification.pem -m "Hello from the command line!"
-```
+    $ apn push "<token>" -c /path/to/apple_push_notification.pem -m "Hello from the command line!"
 
 ## Enabling Push Notifications on iOS
 
@@ -62,8 +78,8 @@ $ apn push "<token>" -c /path/to/apple_push_notification.pem -m "Hello from the
   [[UIApplication sharedApplication] registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeBadge | UIRemoteNotificationTypeSound)];
 }
 
-- (void)application:(UIApplication *)application 
-didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken 
+- (void)application:(UIApplication *)application
+didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
 {
     NSLog(@"application:didRegisterForRemoteNotificationsWithDeviceToken: %@", deviceToken);
 
@@ -71,7 +87,7 @@ didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
 }
 
 - (void)application:(UIApplication *)application
-didFailToRegisterForRemoteNotificationsWithError:(NSError *)error 
+didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
 {
     NSLog(@"Error: %@", error);
 }
@@ -84,15 +100,13 @@ didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
 Once you have the certificate from Apple for your application, export your key
 and the apple certificate as p12 files. Here is a quick walkthrough on how to do this:
 
-1. Click the disclosure arrow next to your certificate in Keychain Access and select the certificate and the key. 
-2. Right click and choose `Export 2 items…`. 
+1. Click the disclosure arrow next to your certificate in Keychain Access and select the certificate and the key.
+2. Right click and choose `Export 2 items…`.
 3. Choose the p12 format from the drop down and name it `cert.p12`.
 
 Now covert the p12 file to a pem file:
 
-```
-$ openssl pkcs12 -in cert.p12 -out apple_push_notification.pem -nodes -clcerts
-```
+    $ openssl pkcs12 -in cert.p12 -out apple_push_notification.pem -nodes -clcerts
 
 ## Contact
 

data/Rakefile

@@ -7,5 +7,4 @@ task :build => "#{gemspec.full_name}.gem"
 
 file "#{gemspec.full_name}.gem" => gemspec.files + ["houston.gemspec"] do
   system "gem build houston.gemspec"
-  system "gem install houston-#{Houston::VERSION}.gem"
 end

data/bin/apn

@@ -25,10 +25,13 @@ command :push do |c|
   c.option '-m', '--alert ALERT', 'Body of the alert to send in the push notification'
   c.option '-b', '--badge NUMBER', 'Badge number to set with the push notification'
   c.option '-s', '--sound SOUND', 'Sound to play with the notification'
-  c.option '-e', '--environment [production|development]', 'Environment to send push notification (defaults to development)'
+  c.option '-n', '--[no]-newsstand', 'Indicates content available for Newsstand'
+  c.option '-d', '--data KEY=VALUE', Array, 'Passes custom data to payload (as comma-delimited "key=value" declarations)'
+  c.option '-P', '--payload PAYLOAD', 'JSON payload for notifications'
+  c.option '-e', '--environment ENV', [:production, :development], 'Environment to send push notification (production or development (default))'
   c.option '-c', '--certificate CERTIFICATE', 'Path to certificate (.pem) file'
   c.option '-p', '--[no]-passphrase', 'Prompt for a certificate passphrase'
-  
+
   c.action do |args, options|
     say_error "One or more device tokens required" and abort if args.empty?
 
@@ -44,21 +47,38 @@ command :push do |c|
     @alert = options.alert
     @badge = options.badge.nil? ? nil : options.badge.to_i
     @sound = options.sound
+    @content_available = options.newsstand
+
+    if options.payload
+      begin
+        @data = JSON.parse(options.payload)
+      rescue => message
+        say_error "Exception parsing JSON payload: #{message}" and abort
+      end
+    elsif options.data
+      begin
+        @data = Hash[options.data.collect{|data| data.split(/\=/)}]
+      rescue => message
+        say_error "Exception parsing JSON payload: #{message}" and abort
+      end
+    end
 
-    unless @alert or @badge
+    unless @alert or @badge or @newsstand or @data
       placeholder = "Enter your alert message"
       @alert = ask_editor placeholder
-      say_error "Alert message or badge required" and abort if @alert.nil? or @alert == placeholder
+      say_error "Payload contents required" and abort if @alert.nil? or @alert == placeholder
     end
 
-    notifications = []
+    @notifications = []
     args.each do |token|
-      notification = Houston::Notification.new(device: token)
-      notification.alert = @alert
-      notification.badge = @badge
-      notification.sound = @sound
-
-      notifications << notification
+      notification = Houston::Notification.new(@data || {})
+      notification.device = token
+      notification.alert = @alert if @alert
+      notification.badge = @badge if @badge
+      notification.sound = @sound if @sound
+      notification.content_available = @newsstand if @newsstand
+
+      @notifications << notification
     end
 
     client = @environment == :production ? Houston::Client.production : Houston::Client.development
@@ -66,9 +86,9 @@ command :push do |c|
     client.passphrase = @passphrase
 
     begin
-      client.push(*notifications)
-    rescue => e
-      say_error "Exception sending notification: #{e}" and abort
+      client.push(*@notifications)
+    rescue => message
+      say_error "Exception sending notification: #{message}" and abort
     end
 
     say_ok "Push notifications successfully sent"

data/houston.gemspec

@@ -6,17 +6,18 @@ Gem::Specification.new do |s|
   s.name        = "houston"
   s.authors     = ["Mattt Thompson"]
   s.email       = "m@mattt.me"
+  s.license     = "MIT"
   s.homepage    = "http://github.com/mattt/houston"
   s.version     = Houston::VERSION
   s.platform    = Gem::Platform::RUBY
   s.summary     = "Send Apple Push Notifications"
   s.description = "Houston is a simple gem for sending Apple Push Notifications. Pass your credentials, construct your message, and send it."
 
-  s.add_dependency "commander", "~> 4.1.2"
-  s.add_dependency "json", "~> 1.7.3"
+  s.add_dependency "commander", "~> 4.1"
+  s.add_dependency "json"
 
-  s.add_development_dependency "rspec", "~> 0.6.1"
-  s.add_development_dependency "rake",  "~> 0.9.2"
+  s.add_development_dependency "rspec", "~> 0.6"
+  s.add_development_dependency "rake",  "~> 0.9"
 
   s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/houston.rb

@@ -1,5 +1,5 @@
 module Houston
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end
 
 require 'houston/client'

data/lib/houston/client.rb

@@ -3,11 +3,27 @@ module Houston
   APPLE_PRODUCTION_FEEDBACK_URI = "apn://feedback.push.apple.com:2196"
 
   APPLE_DEVELOPMENT_GATEWAY_URI = "apn://gateway.sandbox.push.apple.com:2195"
-  APPLE_DEVELOPMENT_FEEDBACK_URI = "apn://feedback.push.apple.com:2196"
+  APPLE_DEVELOPMENT_FEEDBACK_URI = "apn://feedback.sandbox.push.apple.com:2196"
 
   class Client
     attr_accessor :gateway_uri, :feedback_uri, :certificate, :passphrase
 
+    class << self
+      def development
+        client = self.new
+        client.gateway_uri = APPLE_DEVELOPMENT_GATEWAY_URI
+        client.feedback_uri = APPLE_DEVELOPMENT_FEEDBACK_URI
+        client
+      end
+
+      def production
+        client = self.new
+        client.gateway_uri = APPLE_PRODUCTION_GATEWAY_URI
+        client.feedback_uri = APPLE_PRODUCTION_FEEDBACK_URI
+        client
+      end
+    end
+
     def initialize
       @gateway_uri = ENV['APN_GATEWAY_URI']
       @feedback_uri = ENV['APN_FEEDBACK_URI']
@@ -15,24 +31,10 @@ module Houston
       @passphrase = ENV['APN_CERTIFICATE_PASSPHRASE']
     end
 
-    def self.development
-      client = self.new
-      client.gateway_uri = APPLE_DEVELOPMENT_GATEWAY_URI
-      client.feedback_uri = APPLE_DEVELOPMENT_FEEDBACK_URI
-      client
-    end
-
-    def self.production
-      client = self.new
-      client.gateway_uri = APPLE_PRODUCTION_GATEWAY_URI
-      client.feedback_uri = APPLE_PRODUCTION_FEEDBACK_URI
-      client
-    end
-
     def push(*notifications)
       return if notifications.empty?
 
-      Connection.open(connection_options_for_endpoint(:gateway)) do |connection, socket|
+      Connection.open(@gateway_uri, @certificate, @passphrase) do |connection|
         notifications.flatten.each do |notification|
           next unless notification.kind_of?(Notification)
           next if notification.sent?
@@ -46,9 +48,9 @@ module Houston
     def devices
       devices = []
 
-      Connection.open(connection_options_for_endpoint(:feedback)) do |connection, socket|
+      Connection.open(@feedback_uri, @certificate, @passphrase) do |connection|
         while line = connection.read(38)
-          feedback = line.unpack('N1n1H140')            
+          feedback = line.unpack('N1n1H140')
           token = feedback[2].scan(/.{0,8}/).join(' ').strip
           devices << token if token
         end
@@ -56,23 +58,5 @@ module Houston
 
       devices
     end
-
-    private
-
-      def connection_options_for_endpoint(endpoint = :gateway)
-        uri = case endpoint
-                when :gateway then URI(@gateway_uri)
-                when :feedback then URI(@feedback_uri)
-                else
-                  raise ArgumentError
-              end
-
-        {
-          certificate: @certificate,
-          passphrase: @passphrase,
-          host: uri.host,
-          port: uri.port
-        }
-      end
   end
 end

data/lib/houston/connection.rb

@@ -1,32 +1,65 @@
 require 'uri'
 require 'socket'
 require 'openssl'
+require 'forwardable'
 
 module Houston
   class Connection
+    extend Forwardable
+    def_delegators :@ssl, :read, :write
+    def_delegators :@uri, :scheme, :host, :port
+
+    attr_reader :ssl, :socket, :certificate, :passphrase
+
     class << self
-      def open(options = {})
+      def open(uri, certificate, passphrase)
         return unless block_given?
 
-        [:certificate, :passphrase, :host, :port].each do |option|
-          raise ArgumentError, "Missing connection parameter: #{option}" unless option
-        end
-
-        socket = TCPSocket.new(options[:host], options[:port])
+        connection = new(uri, certificate, passphrase)
+        connection.open
 
-        context = OpenSSL::SSL::SSLContext.new
-        context.key = OpenSSL::PKey::RSA.new(options[:certificate], options[:passphrase])
-        context.cert = OpenSSL::X509::Certificate.new(options[:certificate])
+        yield connection
 
-        ssl = OpenSSL::SSL::SSLSocket.new(socket, context)
-        ssl.sync = true
-        ssl.connect
-  
-        yield ssl, socket
-  
-        ssl.close
-        socket.close
+        connection.close
       end
     end
+
+    def initialize(uri, certificate, passphrase)
+      @uri = URI(uri)
+      @certificate = certificate
+      @passphrase = passphrase
+    end
+
+    def open
+      return false if open?
+
+      @socket = TCPSocket.new(@uri.host, @uri.port)
+
+      context = OpenSSL::SSL::SSLContext.new
+      context.key = OpenSSL::PKey::RSA.new(@certificate, @passphrase)
+      context.cert = OpenSSL::X509::Certificate.new(@certificate)
+
+      @ssl = OpenSSL::SSL::SSLSocket.new(@socket, context)
+      @ssl.sync = true
+      @ssl.connect
+    end
+
+    def open?
+      not (@ssl and @socket).nil?
+    end
+
+    def close
+      return false if closed?
+
+      @ssl.close
+      @ssl = nil
+
+      @socket.close
+      @socket = nil
+    end
+
+    def closed?
+      not open?
+    end
   end
 end

data/lib/houston/notification.rb

@@ -2,7 +2,7 @@ require 'json'
 
 module Houston
   class Notification
-    attr_accessor :device, :alert, :badge, :sound, :custom_data
+    attr_accessor :device, :alert, :badge, :sound, :content_available, :custom_data
     attr_reader :sent_at
 
     def initialize(options = {})
@@ -10,6 +10,7 @@ module Houston
       @alert = options.delete(:alert)
       @badge = options.delete(:badge)
       @sound = options.delete(:sound)
+      @content_available = options.delete(:content_available)
 
       @custom_data = options
     end
@@ -17,9 +18,10 @@ module Houston
     def payload
       json = {}.merge(@custom_data || {})
       json['aps'] = {}
-      json['aps']['alert'] = @alert
-      json['aps']['badge'] = @badge.to_i rescue 0
-      json['aps']['sound'] = @sound
+      json['aps']['alert'] = @alert if @alert
+      json['aps']['badge'] = @badge.to_i rescue 0 if @badge
+      json['aps']['sound'] = @sound if @sound
+      json['aps']['content-available'] = 1 if @content_available
 
       json
     end

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: houston
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Mattt Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '0.9'
 description: Houston is a simple gem for sending Apple Push Notifications. Pass your
   credentials, construct your message, and send it.
 email: m@mattt.me
@@ -86,7 +77,6 @@ files:
 - ./apple_push_notification_production.pem
 - ./Gemfile
 - ./Gemfile.lock
-- ./houston-0.1.0.gem
 - ./houston.gemspec
 - ./lib/houston/client.rb
 - ./lib/houston/connection.rb
@@ -97,33 +87,27 @@ files:
 - ./README.md
 - bin/apn
 homepage: http://github.com/mattt/houston
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1059375513586504727
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1059375513586504727
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Send Apple Push Notifications
 test_files: []