apple_push 0.1.1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,84 @@
+# ApplePush
+
+Sinatra-based API service to send Apple Push Notifications (APN)
+
+## Why?
+
+The difference between most of other APN daemons/libraries is that
+ApplePush provides a simple HTTP API and also could be configured to use
+both live and sandbox environments with configurable connections pools.
+
+## Installation
+
+Install via rubybems:
+
+```
+gem install apple_push
+```
+
+Or clone the repo and run:
+
+```
+bundle install
+rake install
+```
+
+## Usage
+
+Create a YAML configuration file:
+
+```yml
+host: 127.0.0.1
+port: 27000
+  
+sandbox:
+  cert: path/to/your/certificate.pem
+  key: path/to/your/key.pem
+  pool: 1
+  
+live:
+  cert: path/to/your/certificate.pem
+  key: path/to/your/key.pem
+  pool: 1
+```
+
+To start server run:
+
+```
+apple_push path/to/your/config.yml
+```
+
+### Using with foreman
+
+If you want to use apple_push server with foreman, you'll need to create a ```Procfile```:
+
+```
+apn: apple_push config/apn.yml
+```
+
+## API
+
+ApplePush server provides the following routes to send notifications:
+
+```
+POST /live
+POST /sandbox
+```
+
+Test with curl:
+
+```bash
+curl -X POST -d '{"alert":"Test Message"}' "http://localhost:27000/live?token=TOKEN"
+```
+
+Also, check out an example with ruby and faraday at ```examples/apple_push_client.rb```
+
+## License
+
+Copyright (c) 2012 Dan Sosedoff.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+require 'bundler/gem_tasks'

data/apple_push.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/apple_push/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "apple_push"
+  s.version     = ApplePush::VERSION.dup
+  s.summary     = "Simple API to send APN notifications"
+  s.description = "Sinatra-based server to deliver Apple Push Notifications"
+  s.homepage    = "http://github.com/doejo/apple_push"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = ["dan.sosedoff@gmail.com"]
+    
+  s.add_runtime_dependency 'eventmachine',    '>= 0'
+  s.add_runtime_dependency 'sinatra',         '>= 0'
+  s.add_runtime_dependency 'thin',            '>= 0'
+  s.add_runtime_dependency 'connection_pool', '>= 0'
+  s.add_runtime_dependency 'multi_json',      '>= 0'
+  s.add_runtime_dependency 'hashr',           '>= 0'
+  s.add_runtime_dependency 'em-apn',          '>= 0'
+  
+  
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths      = ["lib"]
+  s.default_executable = 'apple_push'
+end

data/bin/apple_push

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'eventmachine'
+require 'thin'
+require 'apple_push'
+
+config_path = ARGV.shift.to_s.strip
+
+if config_path.empty?
+  STDERR.puts "Error: Configuration file required!"
+  exit(1)
+end
+
+config = nil
+begin
+  config = ApplePush::Configuration.load_file(config_path)
+rescue ArgumentError => ex
+  STDERR.puts "Error: #{ex.message}"
+  puts ex.backtrace
+  exit(1)
+end
+
+EM.run do
+  begin
+    ApplePush.configure(config)
+  rescue Exception => ex
+    STDERR.puts "Error: #{ex.message}"
+    exit(1)
+  end
+  
+  host = ApplePush.configuration[:host]
+  port = ApplePush.configuration[:port]
+  
+  Thin::Server.start(ApplePush::Server, host, port)
+end

data/examples/apple_push_client.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'multi_json'
+
+class PushClient
+  attr_reader :host
+
+  def initialize(host)
+    @host = host
+  end
+
+  def connection(host)
+    conn = Faraday::Connection.new(host) do |c|
+      c.use(Faraday::Request::UrlEncoded)
+      c.adapter(Faraday.default_adapter)
+    end
+  end
+
+  def notify(env, token, data)
+    params = {:token => token}
+    body = MultiJson.encode(data)
+    path = env == 'live' ? '/live' : '/sandbox'
+
+    response = connection(host).send(:post) do |request|
+      request.path   = path
+      request.params = params
+      request.body   = body
+    end
+
+    response.body
+  end
+end
+
+client = PushClient.new('http://localhost:27000')
+client.notify('live', 'TOKEN', {:alert => "Test Message"})

data/lib/apple_push/configuration.rb

@@ -0,0 +1,19 @@
+require 'hashr'
+require 'yaml'
+
+module ApplePush
+  class Configuration < Hashr
+    # Load a configuration options from file
+    #
+    # path - Path yo YAML file
+    #
+    def self.load_file(path)
+      path = File.expand_path(path)
+      if !File.exists?(path)
+        raise ArgumentError, "File \"#{path}\" does not exist."
+      end
+      data = YAML.load_file(path)
+      Configuration.new(data)
+    end
+  end
+end

data/lib/apple_push/server.rb

@@ -0,0 +1,68 @@
+require 'sinatra/base'
+require 'multi_json'
+require 'apple_push/version'
+
+module ApplePush
+  class Server < Sinatra::Base
+    set :environment, ENV['RACK_ENV'] || 'production'
+    
+    helpers do
+      def json_response(data)
+        MultiJson.encode(data)
+      end
+      
+      def error_response(error, status=400)
+        halt(400, json_response(:error => error))
+      end
+      
+      def process_payload
+        @token   = params[:token].to_s.strip
+        @payload = request.body.read
+        
+        error_response("APN token required") if @token.empty?
+        error_response("Payload required")   if @payload.empty?
+        
+        begin
+          @payload = MultiJson.decode(@payload)
+        rescue MultiJson::DecodeError
+          error_response("Invalid payload. Should be JSON", 422)
+        end
+      end
+    
+      def deliver(env, token, payload={})
+        unless ApplePush.pool?(env)
+          error_response("#{env.capitalize} is not configured.")
+        end
+        
+        notification = EM::APN::Notification.new(token, payload)
+        ApplePush.pool(env).with_connection do |apn|
+          apn.deliver(notification)
+        end
+      end
+    end
+    
+    before do
+      content_type :json, :encoding => :utf8
+    end
+    
+    error do
+      err = env['sinatra.error']
+      content_type :json, :encoding => :utf8
+      json_response(:error => {:message => err.message, :type => err.class.to_s})
+    end
+    
+    not_found do
+      json_response(:error => "Invalid request path")
+    end
+    
+    get '/' do
+      "{\"version\":\"#{ApplePush::VERSION}\"}"
+    end
+    
+    post %r{/(sandbox|live)} do |mode|
+      process_payload
+      deliver(mode, @token, @payload)
+      '{"delivered":true}'
+    end
+  end
+end

data/lib/apple_push/version.rb

@@ -0,0 +1,3 @@
+module ApplePush
+  VERSION = '0.1.1'
+end

data/lib/apple_push.rb

@@ -0,0 +1,66 @@
+require 'connection_pool'
+require 'em-apn'
+
+require 'apple_push/configuration'
+require 'apple_push/server'
+
+module ApplePush
+  LIVE_URL    = 'gateway.push.apple.com'
+  SANDBOX_URL = 'gateway.sandbox.push.apple.com'
+  
+  @@options = {}
+  @@pools   = {}
+  
+  def self.configure(options={})
+    config = ApplePush::Configuration.new(options)
+    
+    @@options.merge!(
+      :host => config.host || '127.0.0.1',
+      :port => config.port || '27000'
+    )
+    
+    if !config.sandbox? && !config.live?
+      raise ArgumentError, "At least one environment should be defined."
+    end
+    
+    self.setup_environment('sandbox', config.sandbox) if config.sandbox?
+    self.setup_environment('live', config.live)       if config.live?
+  end
+  
+  # Get current configuration options
+  #
+  def self.configuration
+    @@options
+  end
+  
+  # Get a connection from pool
+  #
+  def self.pool(env='sandbox')
+    @@pools[env]
+  end
+  
+  # Returns true if pools is configured
+  #
+  def self.pool?(env)
+    @@pools.key?(env)
+  end
+  
+  private
+  
+  # Configure an environment
+  #
+  def self.setup_environment(env, config)
+    raise ArgumentError, "Path to certificate file required." if !config.cert?      
+    raise ArgumentError, "Path to key file required." if !config.cert_key?
+  
+    pool_size = Integer(config.pool || 1)
+    
+    @@pools[env] = ConnectionPool.new(:size => pool_size, :timeout => 5) do
+      EM::APN::Client.connect(
+        :gateway => env == 'live' ? LIVE_URL : SANDBOX_URL,
+        :cert    => File.expand_path(config.cert),
+        :key     => File.expand_path(config.cert_key)
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: apple_push
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70349632289120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349632289120
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70349632287660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349632287660
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &70349632284240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349632284240
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: &70349632283260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349632283260
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70349632226680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349632226680
+- !ruby/object:Gem::Dependency
+  name: hashr
+  requirement: &70349632225640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349632225640
+- !ruby/object:Gem::Dependency
+  name: em-apn
+  requirement: &70349632224840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349632224840
+description: Sinatra-based server to deliver Apple Push Notifications
+email:
+- dan.sosedoff@gmail.com
+executables:
+- apple_push
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- apple_push.gemspec
+- bin/apple_push
+- examples/apple_push_client.rb
+- lib/apple_push.rb
+- lib/apple_push/configuration.rb
+- lib/apple_push/server.rb
+- lib/apple_push/version.rb
+homepage: http://github.com/doejo/apple_push
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple API to send APN notifications
+test_files: []
+has_rdoc: