apn_client 0.0.3 → 0.0.4

data/README.md

@@ -15,12 +15,14 @@ This is a RubyGem that allows sending of Apple Push Notifications to iOS devices
 ```
 require 'apn_client'
 
-message1 = ApnClient::Message.new(1,
+message1 = ApnClient::Message.new(
+  :message_id => 1,
   :device_token => "7b7b8de5888bb742ba744a2a5c8e52c6481d1deeecc283e830533b7c6bf1d099",
   :alert => "New version of the app is out. Get it now in the app store!",
   :badge => 2
 )
-message2 = ApnClient::Message.new(2,
+message2 = ApnClient::Message.new(
+  :message_id => 2,
   :device_token => "6a5g4de5888bb742ba744a2a5c8e52c6481d1deeecc283e830533b7c6bf1d044",
   :alert => "New version of the app is out. Get it now in the app store!",
   :badge => 1
@@ -34,7 +36,7 @@ delivery = ApnClient::Delivery.new([message1, message2],
   },
   :consecutive_failure_limit => 10, # If more than 10 devices in a row fail, we abort the whole delivery
   :exception_limit => 3, # If a device raises an exception three times in a row we fail/skip the device and move on
-  :connection => {
+  :connection_config => {
   	:host => 'gateway.push.apple.com', # For sandbox, use: gateway.sandbox.push.apple.com
   	:port => 2195,
   	:certificate => IO.read("my_apn_certificate.pem"),

data/lib/apn_client/delivery.rb

@@ -7,6 +7,7 @@ module ApnClient
     # Creates a new APN delivery
     #
     # @param [#next] messages should be Enumerator type object that responds to #next. If it's an Array #shift will be used instead.
+    # @param [Hash] connection_config configuration parameters for the APN connection (port, host etc.) (required)
     def initialize(messages, options = {})
       self.messages = messages
       initialize_options(options)
@@ -42,13 +43,13 @@ module ApnClient
     def initialize_options(options)
       NamedArgs.assert_valid!(options,
         :optional => [:callbacks, :consecutive_failure_limit, :exception_limit, :sleep_on_exception],
-        :required => [:connection])
+        :required => [:connection_config])
       NamedArgs.assert_valid!(options[:callbacks], :optional => [:on_write, :on_error, :on_nil_select, :on_read_exception, :on_exception, :on_failure])
       self.callbacks = options[:callbacks]
       self.consecutive_failure_limit = options[:consecutive_failure_limit] || 10
       self.exception_limit = options[:exception_limit] || 3
       self.sleep_on_exception = options[:sleep_on_exception] || 1
-      self.connection_config = options[:connection]
+      self.connection_config = options[:connection_config]
     end
     
     def current_message

data/lib/apn_client/message.rb

@@ -1,24 +1,20 @@
 module ApnClient
   class Message
-    attr_accessor :message_id, :device_token, :alert, :badge, :sound, :content_available, :custom_properties
+    attr_accessor :attributes
 
     # Creates an APN message to to be sent over SSL to the APN service.
     #
-    # @param [Fixnum] message_id a unique (at least within a delivery) integer identifier for this message
-    # @param [String] device_token A 64 byte long hex digest supplied from an app installed on a device to the server
+    # @param [Fixnum] message_id a unique (at least within a delivery) integer identifier for this message (required)
+    # @param [String] device_token A 64 byte long hex digest supplied from an app installed on a device to the server (required)
     # @param [String] alert A text message to display to the user. Should be tweet sized (payload may not exceed 256 bytes)
     # @param [Fixnum] badge the number to show on the badge on the app icon - number of new/unread items
     # @param [String] sound filename of a sound file in the app bundle to be played to the user
     # @param [Boolean] content_available set to true if the message should trigger download of new content
-    def initialize(message_id, config = {})
-      self.message_id = message_id
-      self.device_token = device_token
-      NamedArgs.assert_valid!(config,
-        :optional => [:alert, :badge, :sound, :content_available],
-        :required => [:device_token])
-      config.keys.each do |key|
-        send("#{key}=", config[key])
-      end
+    def initialize(attributes = {})
+      self.attributes = NamedArgs.symbolize_keys!(attributes)
+      NamedArgs.assert_valid!(attributes,
+        :optional => self.class.optional_attributes,
+        :required => self.class.required_attributes)
       check_payload_size!
     end
 
@@ -51,6 +47,33 @@ module ApnClient
       (Time.now + 30*seconds_per_day).to_i
     end
 
+    # Delegate attribute reading and writing (#attribute_name and #attribute_name=)
+    # to the attributes hash.
+    def method_missing(method_name, *args)
+      method_match, attribute_name, equal_sign = method_name.to_s.match(/\A([^=]+)(=)?\Z/).to_a
+      if attribute_name && self.class.valid_attributes.include?(attribute_name.to_sym)
+        if equal_sign          
+          attributes[attribute_name.to_sym] = args.first
+        else
+          attributes[attribute_name.to_sym]
+        end
+      else
+        super
+      end
+    end
+
+    def self.optional_attributes
+      [:alert, :badge, :sound, :content_available]
+    end
+
+    def self.required_attributes
+      [:message_id, :device_token]
+    end
+
+    def self.valid_attributes
+      optional_attributes + required_attributes
+    end
+    
     # The payload is a JSON formated hash with alert, sound, badge, content-available,
     # and any custom properties, example:
     # {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"}}
@@ -75,6 +98,14 @@ module ApnClient
       payload.bytesize
     end
 
+    def to_hash
+      attributes
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
     private
 
     def check_payload_size!

data/lib/apn_client/named_args.rb

@@ -21,5 +21,14 @@ module ApnClient
         raise "Missing required arguments: #{missing_keys.join(', ')}"
       end
     end
+
+    # Destructively convert all keys to symbols, as long as they respond
+    # to +to_sym+.
+    def self.symbolize_keys!(arguments)
+      arguments.keys.each do |key|
+        arguments[(key.to_sym rescue key) || key] = arguments.delete(key)
+      end
+      arguments
+    end
   end
 end

data/lib/apn_client/version.rb

@@ -1,3 +1,3 @@
 module ApnClient
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/delivery_spec.rb

@@ -2,21 +2,30 @@ require 'spec_helper'
 
 describe ApnClient::Delivery do
   before(:each) do
-    @message1 = ApnClient::Message.new(1,
+    @message1 = ApnClient::Message.new(
+      :message_id => 1,
       :device_token => "7b7b8de5888bb742ba744a2a5c8e52c6481d1deeecc283e830533b7c6bf1d099",
       :alert => "New version of the app is out. Get it now in the app store!",
       :badge => 2
     )
-    @message2 = ApnClient::Message.new(2,
+    @message2 = ApnClient::Message.new(
+      :message_id => 2,
       :device_token => "6a5g4de5888bb742ba744a2a5c8e52c6481d1deeecc283e830533b7c6bf1d044",
       :alert => "New version of the app is out. Get it now in the app store!",
       :badge => 1
     )
+    @connection_config = {
+        :host => 'gateway.push.apple.com',
+        :port => 2195,
+        :certificate => "certificate",
+        :certificate_passphrase => ''
+    }    
   end
 
   describe "#initialize" do
     it "initializes counts and other attributes" do
-      delivery = create_delivery([@message1, @message2], :connection => {})
+      delivery = create_delivery([@message1, @message2], :connection_config => @connection_config)
+      delivery.connection_config.should == @connection_config
     end
   end
 
@@ -29,7 +38,7 @@ describe ApnClient::Delivery do
           :on_write => lambda { |d, m| written_messages << m },
           :on_nil_select => lambda { |d| nil_selects += 1 }
         }
-      delivery = create_delivery(messages.dup, :callbacks => callbacks, :connection => {})
+      delivery = create_delivery(messages.dup, :callbacks => callbacks, :connection_config => @connection_config)
 
       connection = mock('connection')
       connection.expects(:write).with(@message1)
@@ -58,7 +67,7 @@ describe ApnClient::Delivery do
           :on_failure => lambda { |d, m| failures << m },
           :on_read_exception => lambda { |d, e| read_exceptions << e }
         }
-      delivery = create_delivery(messages.dup, :callbacks => callbacks, :connection => {})
+      delivery = create_delivery(messages.dup, :callbacks => callbacks, :connection_config => @connection_config)
 
       connection = mock('connection')
       connection.expects(:write).with(@message1).times(3).raises(RuntimeError)
@@ -92,7 +101,7 @@ describe ApnClient::Delivery do
           :on_read_exception => lambda { |d, e| read_exceptions << e },
           :on_error => lambda { |d, message_id, error_code| errors << [message_id, error_code] }
         }
-      delivery = create_delivery(messages.dup, :callbacks => callbacks, :connection => {})
+      delivery = create_delivery(messages.dup, :callbacks => callbacks, :connection_config => @connection_config)
 
       connection = mock('connection')
       connection.expects(:write).with(@message1)

data/spec/message_spec.rb

@@ -9,24 +9,31 @@ describe ApnClient::Message do
   end
 
   describe "#initialize" do
+    it "cannot be created without a message_id" do
+      lambda {
+        ApnClient::Message.new()
+      }.should raise_error(/message_id/)
+    end
+
     it "cannot be created without a token" do
       lambda {
-        ApnClient::Message.new(1)
+        ApnClient::Message.new(:message_id => 1)
       }.should raise_error(/device_token/)
     end
 
     it "can be created with a token and an alert" do
-      message = create_message(1, :device_token => @device_token, :alert => @alert)
+      message = create_message(:message_id => 1, :device_token => @device_token, :alert => @alert)
       message.payload_hash.should == {'aps' => {'alert' => @alert}}
     end
 
     it "can be created with a token and an alert and a badge" do
-      message = create_message(1, :device_token => @device_token, :alert => @alert, :badge => @badge)
+      message = create_message(:message_id => 1, :device_token => @device_token, :alert => @alert, :badge => @badge)
       message.payload_hash.should == {'aps' => {'alert' => @alert, 'badge' => @badge}}
     end
 
     it "can be created with a token and an alert and a badge and content-available" do
-      message = create_message(1,
+      message = create_message(
+        :message_id => 1,
         :device_token => @device_token,
         :alert => @alert,
         :badge => @badge,
@@ -37,15 +44,50 @@ describe ApnClient::Message do
     it "raises an exception if payload_size exceeds 256 bytes" do
       lambda {
         too_long_alert = "A"*1000
-        ApnClient::Message.new(1, :device_token => @device_token, :alert => too_long_alert)
+        ApnClient::Message.new(:message_id => 1, :device_token => @device_token, :alert => too_long_alert)
       }.should raise_error(/payload/i)
     end
   end
 
+  describe "attribute accessors" do
+    it "works with symbol keys" do
+      message = create_message(
+        :message_id => 1,
+        :device_token => @device_token,
+        :alert => @alert,
+        :badge => @badge,
+        :content_available => true)
+      message.message_id.should == 1
+      message.badge.should == @badge
+      message.message_id = 3
+      message.message_id.should == 3
+    end
+    
+    it "works with string keys too" do
+      message = create_message(
+        'message_id' => 1,
+        'device_token' => @device_token,
+        'alert' => @alert,
+        'badge' => @badge,
+        'content_available' => true)
+      message.message_id.should == 1
+      message.badge.should == @badge
+      message.message_id = 3
+      message.message_id.should == 3
+      message.attributes.should == {
+        :message_id => 3,
+        :device_token => @device_token,
+        :alert => @alert,
+        :badge => @badge,
+        :content_available => true        
+      }
+    end
+  end
+
   describe "#==" do
     before(:each) do
-      @message = create_message(3, :device_token => @device_token)
-      @other_message = create_message(5, :device_token => @other_device_token)
+      @message = create_message(:message_id => 3, :device_token => @device_token)
+      @other_message = create_message(:message_id => 5, :device_token => @other_device_token)
     end
     
     it "returns false for nil" do
@@ -66,15 +108,45 @@ describe ApnClient::Message do
     end
   end
 
-  describe "#payload_size" do
-    it "returns number of bytes in the payload"
+  describe "#to_hash" do
+    it "returns a hash with the attributes of the message" do
+      attributes = {
+        :message_id => 1,
+        :device_token => @device_token,
+        :alert => @alert,
+        :badge => @badge,
+        :content_available => true
+      }
+      message = create_message(attributes)
+      message.to_hash.should == attributes
+    end
+  end
+
+  describe "#to_json" do
+    it "converts the attributes hash to JSON" do
+      attributes = {
+        :message_id => 1,
+        :device_token => @device_token,
+        :alert => @alert,
+        :badge => @badge,
+        :content_available => true
+      }
+      message = create_message(attributes)
+      message.to_hash.should == attributes
+      JSON.parse(message.to_json).should == {
+        'message_id' => 1,
+        'device_token' => @device_token,
+        'alert' => @alert,
+        'badge' => @badge,
+        'content_available' => true
+      }
+    end
   end
 
-  def create_message(message_id, config = {})
-    message = ApnClient::Message.new(message_id, config)
-    message.message_id.should == message_id
-    [:device_token, :alert, :badge, :sound, :content_available].each do |attribute|
-      message.send(attribute).should == config[attribute]
+  def create_message(attributes = {})
+    message = ApnClient::Message.new(attributes)
+    attributes.keys.each do |attribute|
+      message.send(attribute).should == attributes[attribute]
     end
     message.payload_size.should < 256
     message.to_s.should_not be_nil

data/spec/named_args_spec.rb

@@ -89,4 +89,18 @@ describe ApnClient::NamedArgs do
       ApnClient::NamedArgs.assert_valid!(nil, :optional => [:bar])
     end
   end
+  
+  describe ".symbolize_keys!" do
+    it "takes a hash and symbolizes its keys" do
+      attributes = {
+        'foo' => 1,
+        :bar => 2
+      }
+      ApnClient::NamedArgs.symbolize_keys!(attributes)
+      attributes.should == {
+        :foo => 1,
+        :bar => 2
+      }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apn_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000Z
+date: 2011-12-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70265547611420 !ruby/object:Gem::Requirement
+  requirement: &70251934469880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265547611420
+  version_requirements: *70251934469880
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70265547611000 !ruby/object:Gem::Requirement
+  requirement: &70251934469460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265547611000
+  version_requirements: *70251934469460
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70265547610580 !ruby/object:Gem::Requirement
+  requirement: &70251934469040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265547610580
+  version_requirements: *70251934469040
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70265547610160 !ruby/object:Gem::Requirement
+  requirement: &70251934468620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265547610160
+  version_requirements: *70251934468620
 description: Uses the "enhanced format" Apple protocol and deals with errors and failures
   when broadcasting to many devices. Includes support for talking to the Apple Push
   Notification Feedback service for dealing with uninstalled apps.