five_mobile_push 0.3.1 → 0.4.0

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Kevin Faustino, James F. Herdman
+
+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/lib/faraday/errors.rb

@@ -1,5 +1,7 @@
 require 'faraday'
 
+# Provides us protection against the FiveMobilePush API's error handling which
+# is currently incomplete.
 module Faraday
   class Response::Errors < Response::Middleware
 

data/lib/five_mobile_push/message.rb

@@ -0,0 +1,28 @@
+module FiveMobilePush
+  class Notifier
+    # Simple proxy class for building messages. Do not use this class directly.
+    class Message
+      # @param [String] body The text to send
+      def body(body)
+        @body = body
+      end
+
+      # @param [Hash] meta_data (optional) The optional meta data to send.
+      def meta_data(meta_data)
+        @meta_data = meta_data
+      end
+
+      # @private
+      def self.dsl(&block)
+        instance = new
+        block.call(instance)
+        instance.to_payload
+      end
+
+      # @private
+      def to_payload
+        FiveMobilePush::Payload.new(@message, @meta_data)
+      end
+    end
+  end
+end

data/lib/five_mobile_push/notifier.rb

@@ -1,15 +1,6 @@
 module FiveMobilePush
   # @todo Validate provided platforms
-  # @todo Simplify platform selection
   class Notifier
-
-    # The following are platforms supported by the Five Mobile Push platform
-
-    ALL        = "all"
-    IPHONE     = "iphone"
-    BLACKBERRY = "blackberry"
-    ANDROID    = "android"
-
     # @param [FiveMobilePush::Client] client The Client object to use when
     #   sending notices
     def initialize(client)
@@ -18,13 +9,6 @@ module FiveMobilePush
 
     # Broadcast a notification to one or more platforms of an application.
     #
-    # == Supported Platforms
-    #
-    # * all
-    # * iphone
-    # * blackberry
-    # * android
-    #
     # @param [Array<String>, String] platforms Any of the supported platforms.
     #
     # @yield [message] Provides a mini-DSL for constructing the message to
@@ -34,13 +18,15 @@ module FiveMobilePush
     #
     # @example Simple usage
     #   n = FiveMobilePush::Notifier.new(client)
-    #   n.broadcast(FiveMobilePush::Notifier::ALL) do |message|
+    #   n.broadcast(FiveMobilePush::Platform::ALL) do |message|
     #     message.body "Downtime this weekend"
     #   end
+    #
+    # @see FiveMobilePush::Platform.supported_platforms
     def broadcast(platforms, &block)
       @client.post 'notify/broadcast',
-        :platforms => build_platforms_string(platforms),
-        :payload   => capture_message(&block).to_json
+        :platforms => Platform.new(platforms).build_list,
+        :payload   => Message.dsl(&block).to_json
     end
 
     # Send a notification to any number of specified devices
@@ -61,18 +47,11 @@ module FiveMobilePush
       @client.post 'notify/toDevices',
         :id_type   => FiveMobilePush::DEFAULT_ID_TYPE,
         :id_values => devices.join(','),
-        :payload   => capture_message(&block).to_json
+        :payload   => Message.dsl(&block).to_json
     end
 
     # Notifies any device registered with the provided tags.
     #
-    # == Supported Platforms
-    #
-    # * all
-    # * iphone
-    # * blackberry
-    # * android
-    #
     # @param [Array<String>, String] platforms Any of the supported platforms.
     # @param [Array<String>] tags Any tag that is registered
     #
@@ -83,49 +62,16 @@ module FiveMobilePush
     #
     # @example Simple usage
     #   n = FiveMobilePush::Notifier.new(client)
-    #   n.notify_by_tags(FiveMobilePush::Notifier::ALL, ['muffin', 'bacon']) do |message|
+    #   n.notify_by_tags(FiveMobilePush::Platform::ALL, ['muffin', 'bacon']) do |message|
     #     message.body "Downtime this weekend"
     #   end
+    #
+    # @see FiveMobilePush::Platform.supported_platforms
     def notify_by_tags(platforms, tags, &block)
       @client.post 'notify/toTags',
-        :platforms => build_platforms_string(platforms),
+        :platforms => Platform.new(platforms).build_list,
         :tags      => tags.join(','),
-        :payload   => capture_message(&block).to_json
+        :payload   => Message.dsl(&block).to_json
     end
-
-    # Simple proxy class for building messages. Do not use this class directly.
-    class Message
-      # @param [String] body The text to send
-      def body(body)
-        @body = body
-      end
-
-      # @param [Hash] meta_data (optional) The optional meta data to send.
-      def meta_data(meta_data)
-        @meta_data = meta_data
-      end
-
-      # @private
-      def to_payload
-        FiveMobilePush::Payload.new(@message, @meta_data)
-      end
-    end
-
-    private
-
-    def capture_message(&block)
-      payload_proxy = Message.new
-      block.call(payload_proxy)
-      payload_proxy.to_payload
-    end
-
-    def build_platforms_string(platforms)
-      if platforms.kind_of?(Enumerable)
-        platforms.join(',')
-      else
-        platforms.to_s
-      end
-    end
-
   end
 end

data/lib/five_mobile_push/platform.rb

@@ -0,0 +1,67 @@
+module FiveMobilePush
+  ##
+  # Stores supported platform names as defined constants.
+  #--
+  # Internal to this gem, this class also aids in building and verifying
+  # selected platforms.
+  class Platform
+    ALL        = "all"
+    IPHONE     = "iphone"
+    BLACKBERRY = "blackberry"
+    ANDROID    = "android"
+
+    SUPPORTED_PLATFORMS = [
+      ALL,
+      IPHONE,
+      BLACKBERRY,
+      ANDROID
+    ]
+
+    # @private
+    attr_reader :target_platforms
+
+    # @param [Array<String>, String] target_platforms The platforms being
+    #   targeted
+    #
+    # @private
+    def initialize(*target_platforms)
+      self.target_platforms = target_platforms
+      validate!
+    end
+
+    # @return [String] a formatted String with a list of the target platforms
+    #
+    # @private
+    def build_list
+      target_platforms.join(',')
+    end
+
+    # @param [Array<String>, String] target_platforms The platforms being
+    #   targeted
+    #
+    # @private
+    def target_platforms=(*target_platforms)
+      @target_platforms = target_platforms.flatten.map(&:to_s)
+    end
+
+    # @raise [InvalidPlatformError] raised when an invalid target platform has been
+    #   selected
+    #
+    # @private
+    def validate!
+      validates_target_platforms
+    end
+
+    private
+
+    def invalid_target_platforms
+      target_platforms - SUPPORTED_PLATFORMS
+    end
+
+    def validates_target_platforms
+      unless invalid_target_platforms.empty?
+        raise FiveMobilePush::InvalidPlatformError, "The following platforms are invalid: #{invalid_target_platforms}"
+      end
+    end
+  end
+end

data/lib/five_mobile_push/version.rb

@@ -1,3 +1,3 @@
 module FiveMobilePush
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/five_mobile_push.rb

@@ -8,21 +8,28 @@ module FiveMobilePush
   autoload :Notifier, 'five_mobile_push/notifier'
   autoload :Tag,      'five_mobile_push/tag'
   autoload :Payload,  'five_mobile_push/payload'
+  autoload :Message,  'five_mobile_push/message'
+  autoload :Platform, 'five_mobile_push/platform'
 
-  class UnauthorizedError < StandardError; end
-  class GeneralError      < StandardError; end
-  class ServerError       < StandardError; end
-
-
-  VALID_OPTION_KEYS = [:api_token, :application_uid]
-  SUPPORTED_PLATFORMS = %w(iphone blackberry android)
+  class UnauthorizedError    < StandardError; end
+  class GeneralError         < StandardError; end
+  class ServerError          < StandardError; end
+  class InvalidPlatformError < StandardError; end
 
   DEFAULT_ID_TYPE = 'native'
 
-  attr_accessor *VALID_OPTION_KEYS
+  attr_accessor :api_token, :application_uid
 
   attr_writer :adapter
 
+  # @yield [config] Provides a block to conveniently configure the library
+  #
+  # @example Simple usage
+  #
+  #   FiveMobilePush.configure do |config|
+  #     config.api_token       = '12345'
+  #     config.application_uid = 'myfancyapp'
+  #   end
   def configure
     yield self
   end

data/spec/fabricators/platform.rb

@@ -0,0 +1,5 @@
+Fabricator(:platform, :class_name => FiveMobilePush::Platform) do
+  on_init {
+    init_with(FiveMobilePush::Platform::ALL, FiveMobilePush::Platform::IPHONE)
+  }
+end

data/spec/five_mobile_push/notifier_spec.rb

@@ -13,8 +13,8 @@ describe FiveMobilePush::Notifier do
     it "broadcasts a notification to one or more platforms of the application" do
       stub_request(:post, broadcast_endpoint)
 
-      subject.broadcast(:iphone) do |payload|
-        payload.message "Minor downtime tonight from 7PM-9PM EST"
+      subject.broadcast(:iphone) do |message|
+        message.body "Minor downtime tonight from 7PM-9PM EST"
       end
 
       a_request(:post, broadcast_endpoint).should have_been_made
@@ -29,8 +29,8 @@ describe FiveMobilePush::Notifier do
     it "notifies a list of devices" do
       stub_request(:post, notify_devices_endpoint)
 
-      subject.notify_devices(['abc', 'def']) do |payload|
-        payload.message 'You win a prize!'
+      subject.notify_devices(['abc', 'def']) do |message|
+        message.body 'You win a prize!'
       end
 
       a_request(:post, notify_devices_endpoint).should have_been_made
@@ -45,8 +45,8 @@ describe FiveMobilePush::Notifier do
     it "notifies devices by tags" do
       stub_request(:post, notify_by_tags_endpoint)
 
-      subject.notify_by_tags([:iphone, :android], ['tag1', 'tag2']) do |payload|
-        payload.message 'tag1 and tag2'
+      subject.notify_by_tags([:iphone, :android], ['tag1', 'tag2']) do |message|
+        message.body 'tag1 and tag2'
       end
 
       a_request(:post, notify_by_tags_endpoint).should have_been_made

data/spec/five_mobile_push/platform_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe FiveMobilePush::Platform do
+  describe '.new' do
+    it 'sets a list of target platforms' do
+      described_class.new(FiveMobilePush::Platform::ALL).
+        target_platforms.should include(FiveMobilePush::Platform::ALL)
+    end
+
+    it 'raises an InvalidPlatformError exception if an invalid platform was selected' do
+      expect {
+        described_class.new('fakeplatform')
+      }.to raise_error(FiveMobilePush::InvalidPlatformError)
+    end
+  end
+
+  describe '#build_list' do
+    subject { Fabricate.build(:platform) }
+
+    it 'includes each targetted platform' do
+      subject.target_platforms.all? { |p| subject.build_list.include?(p) }.should be_true
+    end
+
+    it 'separates values by a comma' do
+      subject.build_list.should =~ /.+,.+/
+    end
+  end
+
+  describe '#target_platforms=' do
+    it 'flattens the provided argument' do
+      subject.target_platforms = [[FiveMobilePush::Platform::ALL]]
+      subject.target_platforms.should == [FiveMobilePush::Platform::ALL]
+    end
+  end
+end

data/spec/five_mobile_push_spec.rb

@@ -20,29 +20,26 @@ describe FiveMobilePush do
 
   end
 
-  describe 'configure' do
+  describe '.configure' do
+    it 'can set the API token' do
+      api_token = '12345'
 
-    FiveMobilePush::VALID_OPTION_KEYS.each do |key|
-
-      it "sets the key #{key}" do
-        FiveMobilePush.configure do |config|
-          config.send("#{key}=", key)
-        end
-        FiveMobilePush.send(key).should == key
+      FiveMobilePush.configure do |config|
+        config.api_token = api_token
       end
 
+      FiveMobilePush.api_token.should == api_token
     end
 
-  end
-
-  describe 'platforms' do
+    it 'can set the application UID' do
+      application_uid = 'cheesebacon'
 
-    %w(iphone blackberry android).each do |platform|
-
-      specify { FiveMobilePush::SUPPORTED_PLATFORMS.should include(platform) }
+      FiveMobilePush.configure do |config|
+        config.application_uid = application_uid
+      end
 
+      FiveMobilePush.application_uid.should == application_uid
     end
-
   end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: five_mobile_push
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kevin Faustino
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 -04:00
+date: 2011-04-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,23 +106,28 @@ files:
 - .rspec
 - .yardopts
 - Gemfile
+- MIT-LICENSE
 - Rakefile
 - five_mobile_push.gemspec
 - lib/faraday/errors.rb
 - lib/five_mobile_push.rb
 - lib/five_mobile_push/client.rb
 - lib/five_mobile_push/device.rb
+- lib/five_mobile_push/message.rb
 - lib/five_mobile_push/notifier.rb
 - lib/five_mobile_push/payload.rb
+- lib/five_mobile_push/platform.rb
 - lib/five_mobile_push/tag.rb
 - lib/five_mobile_push/version.rb
 - spec/fabricators/client.rb
 - spec/fabricators/device.rb
 - spec/fabricators/payload.rb
+- spec/fabricators/platform.rb
 - spec/five_mobile_push/client_spec.rb
 - spec/five_mobile_push/device_spec.rb
 - spec/five_mobile_push/notifier_spec.rb
 - spec/five_mobile_push/payload_spec.rb
+- spec/five_mobile_push/platform_spec.rb
 - spec/five_mobile_push/tags_spec.rb
 - spec/five_mobile_push_spec.rb
 - spec/fixtures/register.json
@@ -159,10 +164,12 @@ test_files:
 - spec/fabricators/client.rb
 - spec/fabricators/device.rb
 - spec/fabricators/payload.rb
+- spec/fabricators/platform.rb
 - spec/five_mobile_push/client_spec.rb
 - spec/five_mobile_push/device_spec.rb
 - spec/five_mobile_push/notifier_spec.rb
 - spec/five_mobile_push/payload_spec.rb
+- spec/five_mobile_push/platform_spec.rb
 - spec/five_mobile_push/tags_spec.rb
 - spec/five_mobile_push_spec.rb
 - spec/fixtures/register.json