grocer 0.0.10 → 0.0.11

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/highgroove/grocer.png)](http://travis-ci.org/highgroove/grocer)
 [![Dependency Status](https://gemnasium.com/highgroove/grocer.png)](https://gemnasium.com/highgroove/grocer)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/highgroove/grocer)
 
 **grocer** interfaces with the [Apple Push Notification
 Service](http://developer.apple.com/library/mac/#documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/ApplePushService/ApplePushService.html)
@@ -12,7 +13,8 @@ cleanest, most extensible, and friendliest.
 
 ## Requirements
 
-* Ruby/MRI 1.9.x *or* Rubinius in 1.9 mode (JRuby in 1.9 is broken due to some problem with 'json' not being in the stdlib?)
+* Ruby/MRI 1.9.x *or* Rubinius in 1.9 mode (JRuby in 1.9 is broken due to some
+  problem with `json` not being in the stdlib?)
 
 ## Installation
 
@@ -46,7 +48,7 @@ pusher = Grocer.pusher(
 * `gateway`: Defaults to different values depending on the `RAILS_ENV` or
   `RACK_ENV` environment variables. If set to `production`, defaults to
   `gateway.push.apple.com`, if set to `test`, defaults to `localhost` (see
-  "Acceptance Testing" later), otherwise defaults to
+  [Acceptance Testing](#acceptance-testing) later), otherwise defaults to
   `gateway.sandbox.push.apple.com`.
 * `retries`: The number of times **grocer** will retry writing to or reading
   from the Apple Push Notification Service before raising any errors to client
@@ -127,7 +129,7 @@ end
   from the Apple Push Notification Service before raising any errors to client
   code.
 
-## Acceptance Testing
+### Acceptance Testing
 
 Grocer ships with framework to setup a real looking APNS server. It listens on
 a real SSL-capable socket bound to localhost.
@@ -165,7 +167,7 @@ describe "apple push notifications" do
 end
 ```
 
-### Device Token
+## Device Token
 
 A device token is obtained from within the iOS app. More details are in Apple's
 [Registering for Remote
@@ -191,15 +193,17 @@ The key code for this purpose is:
 }
 ```
 
-### Certificate File
+## Certificate File
 
 Login to the [iOS Provisioning Portal (App IDs)](https://developer.apple.com/ios/manage/bundles/index.action).
 
-Configure the appropriate certificate for push notifications and download the certificate:
+Configure the appropriate certificate for push notifications and download the
+certificate:
 
 ![Downloading the Push Notification Certificate](https://img.skitch.com/20120402-gtj3bkqi1kq92kgw2pbr5puk5d.png)
 
-Open the file in Keychain Access, then expand the certificate to show both the certificate *and* the private key. Command select so both are highlighted:
+Open the file in Keychain Access, then expand the certificate to show both the
+certificate *and* the private key. Command select so both are highlighted:
 
 ![Selecting both the certificate and private key](https://img.skitch.com/20120402-e8deartr2uhimaiatgccttkggi.png)
 
@@ -207,7 +211,8 @@ Control click and select to export the 2 items:
 
 ![Exporting the certificate and private key](https://img.skitch.com/20120402-mbmgjrybyym846cy58a9kpyxp5.png)
 
-Save the items as a `.p12` file. Open a terminal window and run the following command:
+Save the items as a `.p12` file. Open a terminal window and run the following
+command:
 
 ```bash
 openssl pkcs12 -in exported_certificate.p12 -out certificate.pem -nodes -clcerts

data/lib/grocer.rb

@@ -1,10 +1,10 @@
-require_relative 'grocer/feedback'
-require_relative 'grocer/notification'
-require_relative 'grocer/feedback_connection'
-require_relative 'grocer/push_connection'
-require_relative 'grocer/pusher'
-require_relative 'grocer/version'
-require_relative 'grocer/server'
+require 'grocer/feedback'
+require 'grocer/notification'
+require 'grocer/feedback_connection'
+require 'grocer/push_connection'
+require 'grocer/pusher'
+require 'grocer/version'
+require 'grocer/server'
 
 module Grocer
 

data/lib/grocer/extensions/deep_symbolize_keys.rb

@@ -0,0 +1,16 @@
+module Grocer
+  module Extensions
+    module DeepSymbolizeKeys
+
+      def deep_symbolize_keys
+        result = {}
+        each do |key, value|
+          result[(key.to_sym rescue key)] = value.is_a?(Hash) ?
+            (value.extend DeepSymbolizeKeys).deep_symbolize_keys : value
+        end
+        result
+      end
+
+    end
+  end
+end

data/lib/grocer/failed_delivery_attempt.rb

@@ -1,4 +1,4 @@
-require_relative 'invalid_format_error'
+require 'grocer/invalid_format_error'
 
 module Grocer
   class FailedDeliveryAttempt

data/lib/grocer/feedback.rb

@@ -1,4 +1,4 @@
-require_relative 'failed_delivery_attempt'
+require 'grocer/failed_delivery_attempt'
 
 module Grocer
   class Feedback

data/lib/grocer/feedback_connection.rb

@@ -1,5 +1,6 @@
 require 'delegate'
-require_relative 'connection'
+require 'grocer/extensions/deep_symbolize_keys'
+require 'grocer/connection'
 
 module Grocer
   class FeedbackConnection < SimpleDelegator
@@ -8,7 +9,8 @@ module Grocer
     SANDBOX_GATEWAY = 'feedback.sandbox.push.apple.com'
 
     def initialize(options)
-      options = defaults.merge(options)
+      options.extend Extensions::DeepSymbolizeKeys
+      options = defaults.merge(options.deep_symbolize_keys)
       super(Connection.new(options))
     end
 

data/lib/grocer/notification.rb

@@ -1,5 +1,5 @@
 require 'json'
-require_relative 'no_payload_error'
+require 'grocer/no_payload_error'
 
 module Grocer
   class Notification

data/lib/grocer/notification_reader.rb

@@ -1,5 +1,5 @@
 require 'json'
-require_relative 'notification'
+require 'grocer/notification'
 
 module Grocer
   class NotificationReader

data/lib/grocer/push_connection.rb

@@ -1,5 +1,6 @@
 require 'delegate'
-require_relative 'connection'
+require 'grocer/extensions/deep_symbolize_keys'
+require 'grocer/connection'
 
 module Grocer
   class PushConnection < SimpleDelegator
@@ -9,7 +10,8 @@ module Grocer
     SANDBOX_GATEWAY = 'gateway.sandbox.push.apple.com'
 
     def initialize(options)
-      options = defaults.merge(options)
+      options.extend Extensions::DeepSymbolizeKeys
+      options = defaults.merge(options.deep_symbolize_keys)
       super(Connection.new(options))
     end
 

data/lib/grocer/server.rb

@@ -1,6 +1,6 @@
 require 'thread'
-require_relative 'notification_reader'
-require_relative 'ssl_server'
+require 'grocer/notification_reader'
+require 'grocer/ssl_server'
 
 module Grocer
   class Server

data/lib/grocer/ssl_connection.rb

@@ -20,7 +20,7 @@ module Grocer
     end
 
     def connect
-      context      = OpenSSL::SSL::SSLContext.new
+      context = OpenSSL::SSL::SSLContext.new
 
       if certificate
         cert_data    = File.read(certificate)

data/lib/grocer/ssl_server.rb

@@ -1,13 +1,15 @@
 require 'openssl'
 require 'socket'
 require 'thread'
+require 'grocer/extensions/deep_symbolize_keys'
 
 module Grocer
   class SSLServer
     attr_accessor :port
 
     def initialize(options = {})
-      options = defaults.merge(options)
+      options.extend Extensions::DeepSymbolizeKeys
+      options = defaults.merge(options.deep_symbolize_keys)
       options.each { |k, v| send("#{k}=", v) }
     end
 

data/lib/grocer/version.rb

@@ -1,3 +1,3 @@
 module Grocer
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/spec/grocer/extensions/deep_symbolize_keys_spec.rb

@@ -0,0 +1,36 @@
+require 'grocer/extensions/deep_symbolize_keys'
+
+describe Grocer::Extensions::DeepSymbolizeKeys do
+  let(:nested_strings) { { 'a' => { 'b' => { 'c' => 3 } } } }
+  let(:nested_symbols) { { :a => { :b => { :c => 3 } } } }
+  let(:nested_mixed) { { 'a' => { :b => { 'c' => 3 } } } }
+  let(:nested_fixnums) { {  0  => { 1  => { 2 => 3} } } }
+  let(:nested_illegal_symbols) { { [] => { [] => 3} } }
+  before do
+    nested_symbols.extend described_class
+    nested_strings.extend described_class
+    nested_mixed.extend described_class
+    nested_fixnums.extend described_class
+    nested_illegal_symbols.extend described_class
+  end
+
+  it 'does not change nested symbols' do
+    nested_symbols.deep_symbolize_keys.should == nested_symbols
+  end
+
+  it 'symbolizes nested strings' do
+    nested_strings.deep_symbolize_keys.should == nested_symbols
+  end
+
+  it 'symbolizes a mix of nested strings and symbols' do
+    nested_mixed.deep_symbolize_keys.should == nested_symbols
+  end
+
+  it 'preserves fixnum keys' do
+    nested_fixnums.deep_symbolize_keys.should == nested_fixnums
+  end
+
+  it 'preserves keys that cannot be symbolized' do
+    nested_illegal_symbols.deep_symbolize_keys.should == nested_illegal_symbols
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grocer
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000 Z
+date: 2012-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -117,6 +117,7 @@ files:
 - grocer.gemspec
 - lib/grocer.rb
 - lib/grocer/connection.rb
+- lib/grocer/extensions/deep_symbolize_keys.rb
 - lib/grocer/failed_delivery_attempt.rb
 - lib/grocer/feedback.rb
 - lib/grocer/feedback_connection.rb
@@ -139,6 +140,7 @@ files:
 - spec/fixtures/example.key
 - spec/fixtures/example.pem
 - spec/grocer/connection_spec.rb
+- spec/grocer/extensions/deep_symbolize_keys_spec.rb
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb
 - spec/grocer/feedback_spec.rb
@@ -163,18 +165,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3763223415178507043
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3763223415178507043
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -186,6 +182,7 @@ test_files:
 - spec/fixtures/example.key
 - spec/fixtures/example.pem
 - spec/grocer/connection_spec.rb
+- spec/grocer/extensions/deep_symbolize_keys_spec.rb
 - spec/grocer/failed_delivery_attempt_spec.rb
 - spec/grocer/feedback_connection_spec.rb
 - spec/grocer/feedback_spec.rb