em_apn_manager 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce5404fa96a8fb4011755d83fac888407fb0d459
-  data.tar.gz: 2930eb22b3c1d7cd7affbafc2f938a9123ca3ae6
+  metadata.gz: 7488d9d6b4d3ffca37840e1efd52dd3bc555c4cb
+  data.tar.gz: 39053f313b6bdd6bb04469d2804c650ec0ca549f
 SHA512:
-  metadata.gz: a1b5274c66621788d2b2991af6beff40cf4a2be3d93984c72b924af8f31bc9f0b316bfb32f7a3276b87b43431b055d09274143431e66d6b6c63adbe607397f09
-  data.tar.gz: 560211b2323f0c76c3fedb45166761e87196d7941f67f0dfc010253324c01d265d6ec1d6495ea8c324d0795c5ecbc1d5ca2a6ad0418dd0384e3e72f1bb24e7be
+  metadata.gz: 4a9906727741db1583fe89b897c7876944a31ce5b0fa231c955195371e6f624ff633b3c606868aa47204a379933bf5ef6c3038952516ad2256e38a44d795786c
+  data.tar.gz: a0e2b04ee2a8d50f83d10931ddd6b94f9ac08051905ea1edb93a6c25a27c48ae412cf4177bf260d65908d16777f540ee24c28eaef06a630d0cf156fe040a3ca3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    em_apn_manager (0.0.2)
+    em_apn_manager (0.1.0)
       em-hiredis (>= 0.2.1)
       em_apn_manager
       eventmachine (>= 1.0.0)

data/README.md

@@ -3,24 +3,40 @@ EventMachine APN Manager
 
 EventMachine APN Connection Manager, The purpose is to support multiple cert and multiple application with one process.
 
-Steps to use this gem.
-1. Add `gem 'em_apn_manager', git: 'git@github.com:hlxwell/em_apn_manager.git'`
-2. Run `bundle exec rails g event_machine:apn_manager:install` to generate 'config/em_apn_manager.yml' file.
-3. Run `bundle exec em_apn_manager -e development`
-4. Put this in your code
+Steps for running with *Rails*:
+
+1. Add `gem 'em_apn_manager', git: 'git@github.com:hlxwell/em_apn_manager.git'` to *Gemfile*.
+
+2. Run `bundle exec rails g event_machine:apn_manager:install` to generate `config/em_apn_manager.yml` file.
+
+3. Run `bundle exec em_apn_manager server -e development`.
+
+
+Steps for running `Standalone`:
+
+1. Run `gem install em_apn_manager`
+
+2. Run `em_apn_manager server --redis-host 127.0.0.1 --redis-port 6379` or `em_apn_manager server --config CONFIG_FILE_PATH`
+
+Put below line to your code for sending push notification:
+
 `EM::ApnManager.push_notification({
-  cert: READ_YOUR_CERT_CONTENT,
+  env: CERT_ENVIRONMENT,
+  cert: PEM_CERT_TEXT_CONTENT,
   token: DEVICE_TOKEN,
   message: YOUR_MESSAGE
 })`
 
+Running server in background:
+
+`em_apn_manager server --daemon`
 
 Generate pem from p12
 ==================
+
+This is how you get `p12` file:
+http://docs.urbanairship.com/build/ios.html#set-up-your-application-with-apple
+
 You have to convert p12 format to pem format by below command line.
 `openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts`
 
-
-TO DOs
-==================
-1. Implement running `bundle exec em_apn_manager -e development` in background, support `-daemon` and `-pid_file`

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/bin/em_apn_manager

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+
 require 'em_apn_manager/cli'
 
+### When in development mode run this `ruby -Ilib ./bin/em_apn_manager`
 EM::ApnManager::CLI.start(ARGV)

data/em_apn_manager.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "em_apn_manager"
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael He"]
-  s.date = "2013-07-16"
+  s.date = "2013-07-17"
   s.description = "EventMachine multiple APNs connections Management Solution. You can use multiple cert and connection to apple's APNs server."
   s.email = "m.he@skillupjapan.co.jp"
   s.executables = ["em_apn_manager"]
@@ -99,6 +99,16 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_runtime_dependency(%q<thor>, ["~> 0.16"])
       s.add_runtime_dependency(%q<eventmachine>, [">= 1.0.0"])
       s.add_runtime_dependency(%q<yajl-ruby>, [">= 0.8.2"])
@@ -157,6 +167,16 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<thor>, ["~> 0.16"])
       s.add_dependency(%q<eventmachine>, [">= 1.0.0"])
       s.add_dependency(%q<yajl-ruby>, [">= 0.8.2"])
@@ -216,6 +236,16 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<thor>, ["~> 0.16"])
     s.add_dependency(%q<eventmachine>, [">= 1.0.0"])
     s.add_dependency(%q<yajl-ruby>, [">= 0.8.2"])

data/lib/em_apn_manager.rb

@@ -13,10 +13,11 @@ module EventMachine
     def push_notification options = {}
       # FIXME Check options
       $apn_manager_redis.publish "push-notification", {
+        env: options[:env],
         cert: options[:cert],
         token: options[:token],
         message: options[:message]
       }.to_json
     end
   end
-end
+end

data/lib/em_apn_manager/cli.rb

@@ -16,34 +16,48 @@ $apn_manager_redis = nil
 module EventMachine
   module ApnManager
     class CLI < Thor
-      class_option :config, :aliases => ["-c"], :type => :string
-      class_option :environment, :aliases => ["-e"], :type => :string
+      class_option :config,       :aliases => ["-c"], :type => :string
+      class_option :environment,  :aliases => ["-e"], :type => :string
+      class_option :redis,        :aliases => ["-r"], :type => :string
 
+      ### 3 ways to specify the redis
+      # 1. config yml file
+      # 2. pass redis-url is 'redis://username:password@host:port/database'
+      # like `redis://test:test@localhost:6379/em_apn_manager`
+      #
       def initialize(args = [], opts = [], config = {})
         super(args, opts, config)
 
-        # Read config option, or use default config yml
-        config_path = options[:config] || File.join(".", "config", "em_apn_manager.yml")
-        if config_path && File.exists?(config_path)
-          EM::ApnManager.config = Thor::CoreExt::HashWithIndifferentAccess.new(YAML.load_file(config_path))
-        else
-          raise "No config file is specified or specified config file doesn't exist."
-        end
+        redis_config = options[:redis]
+        if redis_config.nil?
+          # read the environment var.
+          @environment = ENV["RAILS_ENV"] || "development"
+          @environment = options[:environment] if %w{test development production}.include? options[:environment]
+
+          # Read config option, or use default config yml
+          config_path = options[:config] || File.join(".", "config", "em_apn_manager.yml")
+          if config_path && File.exists?(config_path)
+            EM::ApnManager.config = Thor::CoreExt::HashWithIndifferentAccess.new(YAML.load_file(config_path))
+            redis_config = EM::ApnManager.config[@environment]
+          end
 
-        # read the environment var.
-        @environment = "test"
-        @environment = options[:environment] if %w{test development production}.include? options[:environment]
+          # default redis
+          redis_config ||= "redis://localhost:6379/em_apn_manager"
+        end
 
         # create redis connection
-        $apn_manager_redis = Redis.new EM::ApnManager.config[@environment] || { host:"127.0.0.1", port:6379 }
+        $apn_manager_redis = Redis.new url: redis_config
       end
 
       desc "server", "Start manager server."
-      # option :daemon,       :aliases => ["-d"], :type => :boolean
-      # option :pid_file,     :aliases => ["-p"], :type => :string
+      option :daemon,       :aliases => ["-d"], :type => :boolean
+      option :pid_file,     :aliases => ["-p"], :type => :string
       def server
+        daemonize if options[:daemon]
+        write_pid_file(options[:pid_file]) if options[:pid_file]
+
         EM::ApnManager.logger.info("Starting APN Manager")
-        EM.run { EM::ApnManager::Manager.run env: @environment }
+        EM.run { EM::ApnManager::Manager.run }
       end
 
       ### For Testing ##################################################
@@ -52,8 +66,9 @@ module EventMachine
       def push_test_message
         10.times do |i|
           EM::ApnManager.push_notification({
-            cert: File.read(ENV["APN_CERT"]),
-            token: ["0F93C49EAAF3544B5218D2BAE893608C515F69B445279AB2B17511C37046C52B","D42A6795D0C6C0E5F3CC762F905C3654D2A07E72D64CDEC1E2F74AC43C4CC440"].sample,
+            env: 'test',
+            cert: File.read(ENV["APN_CERT"]), # test cert
+            token: ["0F93C49EAAF3544B5218D2BAE893608C515F69B445279AB2B17511C37046C52B", "D42A6795D0C6C0E5F3CC762F905C3654D2A07E72D64CDEC1E2F74AC43C4CC440"].sample,
             message: "Hahahaha I am going to spam you. #{i}-#{rand * 100}"
           })
         end
@@ -64,6 +79,26 @@ module EventMachine
         EM::ApnManager.logger.info("Starting Mock APN Server")
         EM.run { EM.start_server("127.0.0.1", 2195, EM::ApnManager::ApnServer) }
       end
+
+      private
+
+      # Daemonize process (ruby >= 1.9 only)
+      # @return [void] Ruby ~>1.8
+      # @return [0] Ruby 1.9+ (see Process::daemon)
+      # @raise [Errno] on failure
+      def daemonize
+        if Process.respond_to?(:daemon)
+          Process.daemon(true, true)
+        else
+          Kernel.warn "Running process as daemon requires ruby >= 1.9"
+        end
+      end
+
+      # Save worker's pid to file
+      # @return [void]
+      def write_pid_file(path = nil)
+        File.open(path, 'w'){ |f| f << Process.pid } if path
+      end
     end
   end
 end

data/lib/em_apn_manager/client.rb

@@ -20,10 +20,10 @@ module EventMachine
       end
 
       def initialize(options = {})
-        @cert = options[:cert] || ENV["APN_CERT"]
+        @cert = options[:cert]
         @port = options[:port] || PORT
         @environment = options[:env]
-        @gateway = options[:gateway] || ENV["APN_GATEWAY"]
+        @gateway = options[:gateway]
         @gateway ||=  case @environment
                       when "test"
                         TEST_GATEWAY

data/lib/em_apn_manager/generators/templates/em_apn_manager.yml

@@ -1,13 +1,3 @@
-production:
-  host: localhost
-  port: 6379
-  db: YOUR_PRODUCTION_REDIS
-  password: PASSWORD
-
-development:
-  host: localhost
-  port: 6379
-
-test:
-  host: localhost
-  port: 6379
+production: redis://username:password@host:port/database
+development: redis://localhost:6379/resque
+test: redis://localhost:6379/resque

data/lib/em_apn_manager/manager.rb

@@ -24,15 +24,17 @@ module EventMachine
 
         ### launch a new connect to apple when detected any pushs.
         @redis.pubsub.subscribe('push-notification') do |msg|
-          msg_hash = Yajl::Parser.parse(msg) # might be some wrong json
+          msg_hash = Yajl::Parser.parse(msg) # FIXME might be some wrong json
+
           # save the cert to local first, since the start_tls read from file.
           cert_filename = save_cert_to_file msg_hash["cert"]
+
           # cert filename is a key for connection pool
           client = $connection_pool[cert_filename]
 
           ### Create client connection if doesn't exist in pool.
           if client.nil?
-            client = EM::ApnManager::Client.new(options.merge!({cert: cert_filename}))
+            client = EM::ApnManager::Client.new(options.merge!({env: msg_hash["env"], cert: cert_filename}))
             # Store the connection to pool
             $connection_pool[cert_filename] = client
           end
@@ -54,8 +56,8 @@ module EventMachine
 
       private
 
+      # NOTICE should not put the 'certs' folder to a downloadable place.
       def save_cert_to_file cert_content
-        # TODO, should store Rails.root/tmp/certs and this folder should be protected.
         FileUtils.mkdir_p "certs"
         filename = Base64.encode64(cert_content)[0..50]
         filename = File.join "certs", filename

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: em_apn_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael He
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em_apn_manager
@@ -724,6 +724,146 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.4
+- !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
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !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
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement