zeppelin 0.7.0 → 0.8.1

data/Changelog.md

@@ -1,3 +1,15 @@
+# dev
+
+# 0.8.1
+
+* Fixes a problem running specs with JRuby and REE
+
+# 0.8.0
+
+## Enhancements
+
+* Support Blackberry API
+
 # 0.7.0
 
 ## Enhancements

data/Gemfile

@@ -8,3 +8,5 @@ group :development do
   gem 'guard-bundler'
   gem 'guard-rspec'
 end
+
+gem 'simplecov', :group => :test, :platforms => :mri_19, :require => false

data/lib/zeppelin.rb

@@ -31,7 +31,7 @@ class Zeppelin
     @connection = initialize_connection
   end
 
-  # Registers a device token.
+  # Registers an iPhone device token.
   #
   # @param [String] device_token
   # @param [Hash] payload the payload to send during registration
@@ -44,58 +44,47 @@ class Zeppelin
     put_request(uri, payload)
   end
 
-  # Retrieves information on a device token.
-  #
-  # @param [String] device_token
-  # @return [Hash, nil]
-  #
-  # @raise [Zeppelin::ResourceNotFound] invalid device token provided
-  def device_token(device_token)
-    uri = device_token_uri(device_token)
-    get_request(uri)
-  end
-
-  # Deletes a device token.
-  #
-  # @param [String] device_token
-  #
-  # @return [Boolean] whether or not the deletion was successful
-  #
-  # @raise [Zeppelin::ResourceNotFound] invalid device token provided
-  def delete_device_token(device_token)
-    uri = device_token_uri(device_token)
-    delete_request(uri)
-  end
-
-  # Retrieve a page of device tokens
+  # Registers an Android APID.
   #
-  # @param [Integer] page (nil) Page of device tokens to retrieve
+  # @param [String] apid
   #
-  # @return [Hash] result set. See documentation for details
+  # @param [Hash] payload the payload to send during registration
   #
-  # @Note that the next page number is included in the result set instead of the
-  #   raw URI to request for the next page
+  # @return [Boolean] whether or not the registration was successful
   #
-  # @raise [Zeppelin::ClientError] invalid request
-  def device_tokens(page=nil)
-    uri = device_token_uri(nil, :page => page)
-    get_paged_request(uri)
+  # @raise [Zeppelin::ClientError] invalid payload format
+  def register_apid(apid, payload = {})
+    uri = apid_uri(apid)
+    put_request(uri, payload)
   end
 
-  # Registers an APID.
+  # Registers a Blackberry PIN
   #
-  # @param [String] apid
+  # @param [String] pin
   #
   # @param [Hash] payload the payload to send during registration
   #
   # @return [Boolean] whether or not the registration was successful
   #
   # @raise [Zeppelin::ClientError] invalid payload format
-  def register_apid(apid, payload = {})
-    uri = apid_uri(apid)
+  #
+  # @see http://urbanairship.com/docs/blackberry.html#registration
+  def register_pin(pin, payload = {})
+    uri = pin_uri(pin)
     put_request(uri, payload)
   end
 
+  # Retrieves information on a device token.
+  #
+  # @param [String] device_token
+  # @return [Hash, nil]
+  #
+  # @raise [Zeppelin::ResourceNotFound] invalid device token provided
+  def device_token(device_token)
+    uri = device_token_uri(device_token)
+    get_request(uri)
+  end
+
   # Retrieves information on an APID.
   #
   # @param [String] apid
@@ -108,6 +97,28 @@ class Zeppelin
     get_request(uri)
   end
 
+  # @param [String] pin
+  #
+  # @return [Hash, nil]
+  #
+  # @raise [Zeppelin::ResourceNotFound] invalid PIN provided
+  def pin(pin)
+    uri = pin_uri(pin)
+    get_request(uri)
+  end
+
+  # Deletes a device token.
+  #
+  # @param [String] device_token
+  #
+  # @return [Boolean] whether or not the deletion was successful
+  #
+  # @raise [Zeppelin::ResourceNotFound] invalid device token provided
+  def delete_device_token(device_token)
+    uri = device_token_uri(device_token)
+    delete_request(uri)
+  end
+
   # Deletes an APID.
   #
   # @param [String] apid
@@ -120,6 +131,33 @@ class Zeppelin
     delete_request(uri)
   end
 
+  # Deletes a PIN
+  #
+  # @param [String] pin
+  #
+  # @return [Boolean] whether or not deletion was successful
+  #
+  # @raise [Zeppelin::ResourceNotFound] invalid PIN provided
+  def delete_pin(pin)
+    uri = pin_uri(pin)
+    delete_request(uri)
+  end
+
+  # Retrieve a page of device tokens
+  #
+  # @param [Integer] page (nil) Page of device tokens to retrieve
+  #
+  # @return [Hash] result set. See documentation for details
+  #
+  # @Note that the next page number is included in the result set instead of the
+  #   raw URI to request for the next page
+  #
+  # @raise [Zeppelin::ClientError] invalid request
+  def device_tokens(page=nil)
+    uri = device_token_uri(nil, :page => page)
+    get_paged_request(uri)
+  end
+
   # Retrieve a page of APIDs
   #
   # @param [Integer] page (nil) Page of APIDs to retrieve
@@ -339,6 +377,10 @@ class Zeppelin
   def device_tag_uri(device_token, tag_name)
     device_token_uri(device_token) + "/tags/#{tag_name}"
   end
+
+  def pin_uri(pin)
+    "/api/device_pins/#{pin}/"
+  end
 end
 
 require 'zeppelin/middleware'

data/lib/zeppelin/version.rb

@@ -1,3 +1,3 @@
 class Zeppelin
-  VERSION = '0.7.0'
+  VERSION = '0.8.1'
 end

data/spec/spec_helper.rb

@@ -1,6 +1,14 @@
 require 'rubygems'
 require 'bundler/setup'
 
+if RUBY_VERSION =~ /^1.9/ && RUBY_DESCRIPTION =~ /jruby|enterprise/i
+  require 'simplecov'
+
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
 require 'zeppelin'
 
 RSpec.configure do |config|

data/spec/zeppelin_spec.rb

@@ -551,6 +551,113 @@ describe Zeppelin do
     end
   end
 
+  describe '#tags' do
+    let(:uri) { '/api/tags/' }
+
+    let(:response_body) { { :tags => %w[foo bar baz] } }
+
+    it 'is true when request is successful' do
+      stub_requests do |stub|
+        stub.get(uri) { [200, { 'Content-Type' => 'application/json' }, MultiJson.encode(response_body)] }
+      end
+
+      subject.tags
+    end
+
+    it 'raises an error when the request fails' do
+      stub_requests do |stub|
+        stub.get(uri) { [500, {}, ''] }
+      end
+
+      expect {
+        subject.tags
+      }.to raise_error(Zeppelin::ClientError)
+    end
+  end
+
+  describe '#register_pin' do
+    let(:pin) { '12345678' }
+
+    let(:uri) { "/api/device_pins/#{pin}/" }
+
+    it 'is true when the request is successful' do
+      stub_requests do |stub|
+        stub.put(uri) { [201, {}, ''] }
+      end
+
+      subject.register_pin(pin).should be_true
+    end
+
+    it 'raises an error when the request fails' do
+      stub_requests do |stub|
+        stub.put(uri) { [500, {}, ''] }
+      end
+
+      expect {
+        subject.register_pin(pin)
+      }.to raise_error(Zeppelin::ClientError)
+    end
+  end
+
+  describe '#pin' do
+    let(:pin) { '12345678' }
+
+    let(:uri) { "/api/device_pins/#{pin}/" }
+
+    let(:response_body) {
+      {
+        :device_pin => pin,
+        :alias => 'my alias',
+        :last_registration => Time.mktime(2009, 11, 6, 20, 41, 6),
+        :created => Time.mktime(2009, 11, 6, 20, 41, 6),
+        :active => true,
+        :tags => %w[one two]
+      }
+    }
+
+    it 'responds with information about a device with a PIN when successful' do
+      stub_requests do |stub|
+        stub.get(uri) { [200, { 'Content-Type' => 'application/json' }, response_body] }
+      end
+
+      subject.pin(pin).should eql(response_body)
+    end
+
+    it 'raises an error when the PIN resource cannot be found' do
+      stub_requests do |stub|
+        stub.get(uri) { [404, {}, ''] }
+      end
+
+      expect {
+        subject.pin(pin)
+      }.to raise_error(Zeppelin::ResourceNotFound)
+    end
+  end
+
+  describe '#delete_pin' do
+    let(:pin) { '12345678' }
+
+    let(:uri) { "/api/device_pins/#{pin}/" }
+
+    it 'is true when the request succeeds' do
+      stub_requests do |stub|
+        stub.delete(uri) { [204, {}, ''] }
+      end
+
+      subject.delete_pin(pin).should be_true
+    end
+
+    it 'raises an error when the request fails' do
+      stub_requests do |stub|
+        stub.delete(uri) { [404, {}, ''] }
+      end
+
+      expect {
+        subject.delete_pin(pin)
+      }.to raise_error(Zeppelin::ResourceNotFound)
+    end
+  end
+
   def stub_requests
     subject.connection.builder.handlers.delete(Faraday::Adapter::NetHttp)
     subject.connection.adapter :test do |stubs|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeppelin
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000 Z
+date: 2012-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70196652109980 !ruby/object:Gem::Requirement
+  requirement: &70331113343920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70196652109980
+  version_requirements: *70331113343920
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70196652109320 !ruby/object:Gem::Requirement
+  requirement: &70331113343360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70196652109320
+  version_requirements: *70331113343360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70196652108780 !ruby/object:Gem::Requirement
+  requirement: &70331113342860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196652108780
+  version_requirements: *70331113342860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70196652108000 !ruby/object:Gem::Requirement
+  requirement: &70331113342360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196652108000
+  version_requirements: *70331113342360
 description: Ruby client for the Urban Airship Push Notification API
 email:
 - alex@kernul.com