rapnd 0.2.5 → 0.3.0

data/README.markdown

@@ -0,0 +1,53 @@
+# rapnd
+
+rapnd is an easy-to-use daemon that opens a persistent connection to the Apple Push Notification servers and sends notifications you specify to Apple.
+
+It intentionally has very little in the way of model-level assumptions: this daemon is intended only to send notifications and does almost nothing to validate the content of the notifications (besides ensuring that the length is correct and a device_token is provided). Your models should validate that the messages they send to rapnd conform to the behavior you expect.
+
+Each rapnd daemon operates on a separate resque queue, and multiple daemons can service one queue. Thus you can use rapnd with multiple Apple certs (if you have multiple applications you're trying to send notifications for) and, if you expect a lot of traffic, you can even have multiple daemons servicing one queue.
+
+## Daemon usage
+
+```
+Usage: rapnd [options]
+        --cert=MANDATORY             Location of the cert pem file
+        --password=OPTIONAL          Password for the cert pem file
+        --redis_host=OPTIONAL        Redis hostname
+        --redis_port=OPTIONAL        Redis port
+        --environment=OPTIONAL       Specify sandbox or production
+        --queue=OPTIONAL             Name of the redis queue
+        --foreground                 Run in the foreground
+        --dir=OPTIONAL               Directory to start in
+        --airbrake=OPTIONAL          Airbrake API key
+        --help                       Show help
+```
+
+## Client usage
+
+```ruby
+require 'rapnd'
+
+Rapnd.configure do |config|
+  config.redis_host = 'localhost'
+  config.redis_port = 6379
+end
+
+message = {:badge => 1, :alert => 'This is a test from rapnd!', :sound => 'flash.caf', :custom_properties => {:test_id => 1234, :happiness => true}}
+queue_name = 'rapnd_queue'
+
+Rapnd.queue(queue_name, message)
+```
+
+## Contributing to rapnd
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Josh Symonds. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.3.0

data/lib/rapnd/config.rb

@@ -0,0 +1,34 @@
+module Rapnd
+  module Config
+    extend self
+    
+    def option(name, options = {})
+      defaults[name] = settings[name] = options[:default]
+
+      class_eval <<-RUBY
+        def #{name}
+          settings[#{name.inspect}]
+        end
+
+        def #{name}=(value)
+          settings[#{name.inspect}] = value
+        end
+
+        def #{name}?
+          #{name}
+        end
+      RUBY
+    end
+    
+    def defaults
+      @defaults ||= {}
+    end
+    
+    def settings
+      @settings ||= {}
+    end
+    
+    option :redis_host, :default => 'localhost'
+    option :redis_port, :default => 6879
+  end
+end

data/lib/rapnd.rb

@@ -1,6 +1,22 @@
 require 'rapnd/daemon'
 require 'rapnd/notification'
+require 'rapnd/config'
+require 'redis'
 
 module Rapnd
+  extend self
   
+  def queue(queue_name, message)
+    self.redis.lpush(queue_name, Marshal.dump(message))
+  end
+  
+  def redis
+    @redis ||= Redis.new(:host => Rapnd.config.redis_host, :port => Rapnd.config.redis_port)
+  end
+  
+  def configure
+    block_given? ? yield(Config) : Config
+  end
+  alias :config :configure
+
 end

data/rapnd.gemspec

@@ -5,17 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = "rapnd"
-  s.version = "0.2.5"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Symonds"]
-  s.date = "2012-02-20"
+  s.date = "2012-02-21"
   s.description = "redis APN daemon"
   s.email = "veraticus@gmail.com"
   s.executables = ["rapnd"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
@@ -23,16 +23,19 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "bin/rapnd",
     "lib/rapnd.rb",
+    "lib/rapnd/config.rb",
     "lib/rapnd/daemon.rb",
     "lib/rapnd/notification.rb",
     "rapnd.gemspec",
+    "spec/config_spec.rb",
     "spec/daemon_spec.rb",
     "spec/notification_spec.rb",
+    "spec/rapnd_spec.rb",
     "spec/redis-test.conf",
     "spec/spec_helper.rb"
   ]

data/spec/config_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Rapnd::Config" do  
+  it 'has a default value' do
+    Rapnd.config.redis_host.should == 'localhost'
+  end
+  
+  it 'overrides a default value with an assigner' do
+    Rapnd.config.redis_host = 'testhost'
+    
+    Rapnd.config.redis_host.should == 'testhost'
+  end
+  
+  it 'overrides a default value with a block' do
+    Rapnd.config do |config|
+      config.redis_host = 'testhost'
+    end
+    
+    Rapnd.config.redis_host.should == 'testhost'
+  end
+  
+  it 'checks a value has been assigned' do
+    Rapnd.config.redis_host?.should be_true
+    
+    Rapnd.config.redis_host = nil
+    
+    Rapnd.config.redis_host?.should be_false
+  end
+end

data/spec/rapnd_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Rapnd" do  
+  before do
+    Rapnd.config do |config|
+      config.redis_host = 'localhost'
+      config.redis_port = 9876
+    end
+    
+    @redis = Redis.new(:host => 'localhost', :port => 9876)
+  end
+  
+  it 'enqueues a message' do
+    Rapnd.queue('test_queue', {:alert => 'Hi!'})
+    
+    @redis.llen('test_queue').should == 1
+    Marshal.load(@redis.lpop('test_queue')).should == {:alert => 'Hi!'}
+  end
+  
+  it 'gets a redis connection' do
+    Rapnd.redis.ping.should == "PONG"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapnd
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-20 00:00:00.000000000 Z
+date: 2012-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis
-  requirement: &70343078307700 !ruby/object:Gem::Requirement
+  requirement: &70356622859940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *70343078307700
+  version_requirements: *70356622859940
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70343078306440 !ruby/object:Gem::Requirement
+  requirement: &70356623103620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70343078306440
+  version_requirements: *70356623103620
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70343078305100 !ruby/object:Gem::Requirement
+  requirement: &70356623099520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70343078305100
+  version_requirements: *70356623099520
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &70343078303920 !ruby/object:Gem::Requirement
+  requirement: &70356622733060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.6
   type: :runtime
   prerelease: false
-  version_requirements: *70343078303920
+  version_requirements: *70356622733060
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70343076992780 !ruby/object:Gem::Requirement
+  requirement: &70356622728740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70343076992780
+  version_requirements: *70356622728740
 - !ruby/object:Gem::Dependency
   name: airbrake
-  requirement: &70343076990700 !ruby/object:Gem::Requirement
+  requirement: &70356622742900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70343076990700
+  version_requirements: *70356622742900
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70343076989260 !ruby/object:Gem::Requirement
+  requirement: &70356622749900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70343076989260
+  version_requirements: *70356622749900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70343077777920 !ruby/object:Gem::Requirement
+  requirement: &70356622692640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70343077777920
+  version_requirements: *70356622692640
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70343078090600 !ruby/object:Gem::Requirement
+  requirement: &70356622690300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70343078090600
+  version_requirements: *70356622690300
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70343078089960 !ruby/object:Gem::Requirement
+  requirement: &70356622697380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70343078089960
+  version_requirements: *70356622697380
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70343078089220 !ruby/object:Gem::Requirement
+  requirement: &70356622693920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70343078089220
+  version_requirements: *70356622693920
 description: redis APN daemon
 email: veraticus@gmail.com
 executables:
@@ -139,23 +139,26 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files:
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - bin/rapnd
 - lib/rapnd.rb
+- lib/rapnd/config.rb
 - lib/rapnd/daemon.rb
 - lib/rapnd/notification.rb
 - rapnd.gemspec
+- spec/config_spec.rb
 - spec/daemon_spec.rb
 - spec/notification_spec.rb
+- spec/rapnd_spec.rb
 - spec/redis-test.conf
 - spec/spec_helper.rb
 homepage: http://github.com/Veraticus/rapnd
@@ -173,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3694734249324367104
+      hash: -1178494822573940370
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= rapnd
-
-An extremely beta daemon that persists a connection to Apple's servers and sends messages to it, using redis for persistence.
-
-== Contributing to rapnd
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Josh Symonds. See LICENSE.txt for
-further details.
-