five_mobile_push 0.4.6 → 0.4.7

data/lib/five_mobile_push.rb

@@ -15,6 +15,7 @@ module FiveMobilePush
   class GeneralError         < StandardError; end
   class ServerError          < StandardError; end
   class InvalidPlatformError < StandardError; end
+  class InvalidToken         < StandardError; end
 
   DEFAULT_ID_TYPE = 'native'
 

data/lib/five_mobile_push/client.rb

@@ -1,4 +1,3 @@
-require 'uri'
 require 'faraday'
 
 module FiveMobilePush
@@ -10,7 +9,7 @@ module FiveMobilePush
 
     def initialize(options={})
       self.application_uid = options[:application_uid] || FiveMobilePush.application_uid
-      self.api_token = options[:api_token]             || FiveMobilePush.api_token
+      self.api_token       = options[:api_token]       || FiveMobilePush.api_token
     end
 
     def get(path, options={})
@@ -21,31 +20,38 @@ module FiveMobilePush
       perform_request(:post, path, options)
     end
 
-    def device(device_uid)
-      FiveMobilePush::Device.new(self, device_uid)
+    def device(device_uid, device_token=nil)
+      FiveMobilePush::Device.new(self, device_uid, device_token)
     end
 
     def notifier
       FiveMobilePush::Notifier.new(self)
     end
 
-    def tag(device_uid)
-      FiveMobilePush::Tag.new(self, device_uid)
+    def tag(device_uid, device_token)
+      FiveMobilePush::Tag.new(self, device_uid, device_token)
     end
 
     private
 
       def perform_request(method, path, options={})
-        options.merge!({:api_token => self.api_token, :application_id =>  self.application_uid })
-
-        uri = [DEFAULT_ENDPOINT, path].join('/')
+        options.merge!(
+          :api_token      => options[:api_token] || api_token,
+          :application_id => application_uid
+        )
+
+        conn = Faraday.new(:url => DEFAULT_ENDPOINT)
+        resp = conn.send(method) do |req|
+          req.url path, options
+        end
 
-        case method
-        when :get
-          Faraday.get(uri, options)
-        when :post
-          Faraday.post(uri, options)
+        # TODO Add error processor here.
+        # Basic error checking
+        if resp.status == 400
+          raise InvalidToken if resp.body =~ /Invalid API token/i
         end
+
+        resp
       end
   end
 end

data/lib/five_mobile_push/device.rb

@@ -3,15 +3,16 @@ module FiveMobilePush
 
     VALID_OPTION_KEYS = [:alias, :email]
 
-    attr_reader :device_uid
+    attr_reader :uid, :token
 
     # @param [FiveMobilePush::Client] client The Client to use to send this request
     #
-    # @param [String] device_uid The ID of the device being registered.
+    # @param [String] uid The ID of the device being registered.
     #   Maximum of 64 characters.
-    def initialize(client, device_uid)
-      @client     = client
-      @device_uid = device_uid
+    def initialize(client, uid, token=nil)
+      @client = client
+      @uid    = uid
+      @token  = token
     end
 
     # Registers a device for receiving push notifications from an application.
@@ -34,29 +35,43 @@ module FiveMobilePush
     # @option device_info [String] :platform_ver Software platform version.
     #
     # @return [Hash] Has unique device API key. Required for many other calls.
-    def register(device_info, registration_data=nil)
+    def register(info, registration_data=nil)
       options = {
-        :device_id   => @device_uid,
-        :device_info => MultiJson.encode(device_info)
+        :device_id   => @uid,
+        :device_info => MultiJson.encode(info)
       }
 
       options[:reg_data] = registration_data unless registration_data.nil?
       response = @client.post 'device/register', options
-      MultiJson.decode(response.body)
+      
+      if response.headers['content-type'] =~ /json/i
+        MultiJson.decode(response.body)
+      else
+        response.body
+      end
     end
 
     def resume
-      @client.post 'device/resume', :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => @device_uid
+      client_operation 'device/resume'
     end
 
     def suspend
-      @client.post 'device/suspend', :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => @device_uid
+      client_operation 'device/suspend'
     end
 
     def unregister
-      @client.post 'device/unregister', :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => @device_uid
+      client_operation 'device/unregister'
     end
 
+    private
+    
+      def client_operation(method)
+        @client.post method,
+          :id_type => FiveMobilePush::DEFAULT_ID_TYPE,
+          :id_value => @uid,
+          :api_token => token
+      end
+
   end
 
 end

data/lib/five_mobile_push/tag.rb

@@ -1,19 +1,42 @@
 module FiveMobilePush
   class Tag
+    attr_reader :client
 
-    attr_accessor :device_uid
+    attr_accessor :device_uid, :device_token
 
-    def initialize(client, device_uid)
-      @client = client
-      self.device_uid = device_uid
+    def initialize(client, device_uid, device_token)
+      @client           = client
+      self.device_uid   = device_uid
+      self.device_token = device_token
     end
-    
+
     def create(*tags)
-      @client.post(end_point(:add), :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => self.device_uid, :tags => normalize_tags(tags))
+      client.post end_point(:add),
+        :id_type   => FiveMobilePush::DEFAULT_ID_TYPE,
+        :id_value  => device_uid,
+        :tags      => normalize_tags(tags),
+        :api_token => device_token
     end
 
     def delete(*tags)
-      @client.post(end_point(:delete), :id_type => FiveMobilePush::DEFAULT_ID_TYPE, :id_value => self.device_uid, :tags => normalize_tags(tags))
+      client.post end_point(:delete),
+        :id_type   => FiveMobilePush::DEFAULT_ID_TYPE,
+        :id_value  => device_uid,
+        :tags      => normalize_tags(tags),
+        :api_token => device_token
+    end
+
+    def get
+      response = client.get end_point(:get),
+        :id_type   => FiveMobilePush::DEFAULT_ID_TYPE,
+        :id_value  => device_uid,
+        :api_token => device_token
+        
+      if response.headers['content-type'] =~ /json/i
+        MultiJson.decode(response.body)
+      else
+        response.body
+      end
     end
 
     private
@@ -25,6 +48,5 @@ module FiveMobilePush
     def end_point(action)
       "device/tags/#{action}"
     end
-
   end
 end

data/lib/five_mobile_push/version.rb

@@ -1,3 +1,3 @@
 module FiveMobilePush
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

data/spec/integration/client_spec.rb

@@ -5,8 +5,12 @@ FiveMobilePush.configure do |config|
   config.application_uid  = ''
 end
 
+FakeDevice = Struct.new(:id, :uid, :token) unless defined?(FakeDevice)
+
 describe FiveMobilePush::Client do
-  let(:device) { double('Device', id: 12345, uid: 'abcdef') }
+  subject { described_class.new }
+
+  let(:device) { FakeDevice.new(12345, 'abcdef') }
 
   let(:device_info) {
     {
@@ -19,11 +23,168 @@ describe FiveMobilePush::Client do
 
   let(:reg_data) { 'cafebabe' }
 
-  subject { described_class.new }
-  
-  it "register device" do
-    expect {
-      subject.device(device.uid).register(device_info, reg_data)
-    }.to_not raise_error
+  # Registers the device on the service, sets its token, and returns the response
+  def register_device(device, args={})
+    device_info.merge!(args)
+    response     = subject.device(device.uid).register(device_info, reg_data)
+    device.token = response['data']
+    response
+  end
+
+  # Unregisters the device
+  def unregister_device(device)
+    subject.device(device.uid, device.token).unregister
+  end
+
+  context 'device end points' do
+    context 'valid device registration' do
+      after(:each) do
+        unregister_device(device)
+      end
+
+      it 'registers the device device' do
+        expect {
+          register_device(device)
+        }.to_not raise_error
+      end
+
+      it 'receives a device token' do
+        response = register_device(device)
+        response['data'].should_not be_nil
+        response['type'].should == 'api_token'
+      end
+    end
+
+    context 'attempt to register device with invalid info' do
+      it 'invalid device manufacturer' do
+        response = register_device(device, 'manufacturer' => 'jello')
+        response.should include('data')
+      end
+
+      it 'invalid device model' do
+        response = register_device(device, 'model' => '###F#F23f23f!@!@xyz')
+        response.should include('data')
+      end
+
+      it 'invalid device platform' do
+        response = register_device(device, 'platform' => 'xyz')
+        response.should =~ /Unrecognized platform/
+      end
+
+      it 'invalid device platform_ver' do
+        response = register_device(device, 'platform_ver' => '###F#F23f23f!@!@xyz')
+        response.should include('data')
+      end
+    end
+
+    context 'unregistration' do
+      before(:each) do
+        register_device(device)
+      end
+
+      it 'is successful for a valid device' do
+        resp = unregister_device(device)
+        resp.status.should == 200
+        resp.body.should == ''
+      end
+
+      it 'raises an InvalidToken exception for an invalid device' do
+        unregister_device(device) # Once to clean up...
+
+        expect {
+          unregister_device(device) # Again to cause an error...
+        }.to raise_error(FiveMobilePush::InvalidToken)
+      end
+    end
+
+    context 'with a valid device' do
+      before(:each) do
+        register_device(device)
+      end
+
+      after(:each) do
+        unregister_device(device)
+      end
+
+      it 'suspends a device' do
+        resp = subject.device(device.uid, device.token).suspend
+        resp.status.should == 200
+        resp.body.should == ''
+      end
+
+      it 'suspends with an invalid token' do
+        expect {
+          subject.device(device.uid, 'wooohoo').suspend
+        }.to raise_error(FiveMobilePush::InvalidToken)
+      end
+
+      it 'resumes a subscription' do
+        resp = subject.device(device.uid, device.token).resume
+        resp.status.should == 200
+        resp.body.should == ''
+      end
+    end
+  end
+
+  context 'notification end points' do
+    let(:notifier) { subject.notifier }
+
+    it "broadcasts a message to all platforms" do
+      resp = notifier.broadcast(FiveMobilePush::Platform::ALL) do |message|
+        message.body "Heyyo it's an rspec party"
+      end
+
+      resp.status.should == 200
+    end
+
+    it "send a message to a faulty device" do
+      resp = notifier.notify_devices(['no-one']) do |message|
+        message.body "No one should get this"
+      end
+
+      resp.status.should == 200
+    end
+
+    it "send a message to devices tagged" do
+      resp = notifier.notify_by_tags(FiveMobilePush::Platform::ALL, ['mmmm', 'bacon']) do |message|
+        message.body "eat your bacon"
+      end
+
+      resp.status.should == 200
+    end
+  end
+
+  context "tag end points" do
+    let(:tag1) { 'toronto' }
+
+    let(:tag2) { 'summer' }
+
+    let(:tags) { [tag1, tag2] }
+
+    before(:each) do
+      register_device(device)
+    end
+
+    after(:each) do
+      unregister_device(device)
+    end
+
+    it "create a tag" do
+      resp = subject.tag(device.uid, device.token).create(tags)
+      resp.body.should == ''
+      resp.status.should == 200
+    end
+
+    it "delete a tag" do
+      resp = subject.tag(device.uid, device.token).delete(tag2)
+      resp.body.should == ''
+      resp.status.should == 200
+    end
+
+    it "get a device's tags" do
+      subject.tag(device.uid, device.token).create(tags)
+      resp = subject.tag(device.uid, device.token).get
+      resp.should == tags
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: five_mobile_push
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors: 
 - Kevin Faustino
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 Z
+date: 2011-07-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json