zeppelin 0.4.0 → 0.5.0

data/lib/zeppelin.rb

@@ -1,9 +1,8 @@
 require 'faraday'
-require 'yajl'
 require 'time'
 
 # A very tiny Urban Airship Push Notification API client.
-# 
+#
 # Provides thin wrappers around API calls to the most common API tasks. For more
 # information on how the requests and responses are formatted, visit the [Urban
 # Airship Push Notification API docs](http://urbanairship.com/docs/push.html).
@@ -12,140 +11,138 @@ class Zeppelin
   PUSH_URI = '/api/push/'
   BATCH_PUSH_URI = '/api/push/batch/'
   BROADCAST_URI = '/api/push/broadcast/'
-  SUCCESSFUL_STATUS_CODES = (200..299)
   JSON_HEADERS = { 'Content-Type' => 'application/json' }
-  
-  # The connection to `https://go.urbanairship.com`.
-  attr_reader :connection
-  
-  # Creates a new client.
-  # 
+
   # @param [String] application_key your Urban Airship Application Key
+  #
   # @param [String] application_master_secret your Urban Airship Application
   #   Master Secret
   def initialize(application_key, application_master_secret, options = {})
-    @connection = Faraday::Connection.new(BASE_URI, options) do |builder|
-      builder.request :json
-      builder.adapter :net_http
-    end
-    
-    @connection.basic_auth(application_key, application_master_secret)
+    @application_key = application_key
+    @application_master_secret = application_master_secret
+    @options = options
+  end
+
+  # The connection to UrbanAirship
+  def connection
+    return @connection unless @connection.nil?
+    @connection = initialize_connection
   end
-  
+
   # Registers a device token.
-  # 
+  #
   # @param [String] device_token
   # @param [Hash] payload the payload to send during registration
   # @return [Boolean] whether or not the registration was successful
   def register_device_token(device_token, payload = {})
     uri = device_token_uri(device_token)
-    
+
     if payload.empty?
-      response = @connection.put(uri)
+      response = connection.put(uri)
     else
-      response = @connection.put(uri, payload, JSON_HEADERS)
+      response = connection.put(uri, payload, JSON_HEADERS)
     end
-    
-    successful?(response)
+
+    response.success?
   end
-  
+
   # Retrieves information on a device token.
-  # 
+  #
   # @param [String] device_token
   # @return [Hash, nil]
   def device_token(device_token)
-    response = @connection.get(device_token_uri(device_token))
-    successful?(response) ? parse(response.body) : nil
+    response = connection.get(device_token_uri(device_token))
+    response.success? ? response.body : nil
   end
-  
+
   # Deletes a device token.
-  # 
+  #
   # @param [String] device_token
   # @return [Boolean] whether or not the deletion was successful
   def delete_device_token(device_token)
-    response = @connection.delete(device_token_uri(device_token))
-    successful?(response)
+    response = connection.delete(device_token_uri(device_token))
+    response.success?
   end
-  
+
   # Registers an APID.
-  # 
+  #
   # @param [String] apid
   # @param [Hash] payload the payload to send during registration
   # @return [Boolean] whether or not the registration was successful
   def register_apid(apid, payload = {})
     uri = apid_uri(apid)
-    
+
     if payload.empty?
-      response = @connection.put(uri)
+      response = connection.put(uri)
     else
-      response = @connection.put(uri, payload, JSON_HEADERS)
+      response = connection.put(uri, payload, JSON_HEADERS)
     end
-    
-    successful?(response)
+
+    response.success?
   end
-  
+
   # Retrieves information on an APID.
-  # 
+  #
   # @param [String] apid
   # @return [Hash, nil]
   def apid(apid)
-    response = @connection.get(apid_uri(apid))
-    successful?(response) ? parse(response.body) : nil
+    response = connection.get(apid_uri(apid))
+    response.success? ? response.body : nil
   end
-  
+
   # Deletes an APID.
-  # 
+  #
   # @param [String] apid
   # @return [Boolean] whether or not the deletion was successful
   def delete_apid(apid)
-    response = @connection.delete(apid_uri(apid))
-    successful?(response)
+    response = connection.delete(apid_uri(apid))
+    response.success?
   end
-  
+
   # Pushes a message.
-  # 
+  #
   # @param [Hash] payload the payload of the message
   # @return [Boolean] whether or not pushing the message was successful
   def push(payload)
-    response = @connection.post(PUSH_URI, payload, JSON_HEADERS)
-    successful?(response)
+    response = connection.post(PUSH_URI, payload, JSON_HEADERS)
+    response.success?
   end
-  
+
   # Batch pushes multiple messages.
-  # 
+  #
   # @param [<Hash>] payload the payloads of each message
   # @return [Boolean] whether or not pushing the messages was successful
   def batch_push(*payload)
-    response = @connection.post(BATCH_PUSH_URI, payload, JSON_HEADERS)
-    successful?(response)
+    response = connection.post(BATCH_PUSH_URI, payload, JSON_HEADERS)
+    response.success?
   end
-  
+
   # Broadcasts a message.
-  # 
+  #
   # @param [Hash] payload the payload of the message
   # @return [Boolean] whether or not broadcasting the message was successful
   def broadcast(payload)
-    response = @connection.post(BROADCAST_URI, payload, JSON_HEADERS)
-    successful?(response)
+    response = connection.post(BROADCAST_URI, payload, JSON_HEADERS)
+    response.success?
   end
-  
+
   # Retrieves feedback on device tokens.
-  # 
+  #
   # This is useful for removing inactive device tokens for the database.
-  # 
+  #
   # @param [Time] since the time to retrieve inactive tokens from
   # @return [Hash, nil]
   def feedback(since)
-    response = @connection.get(feedback_uri(since))
-    successful?(response) ? parse(response.body) : nil
+    response = connection.get(feedback_uri(since))
+    response.success? ? response.body : nil
   end
 
   # Retrieve all tags on the service
   #
   # @return [Hash, nil]
   def tags
-    response = @connection.get(tag_uri(nil))
-    successful?(response) ? parse(response.body) : nil
+    response = connection.get(tag_uri(nil))
+    response.success? ? response.body : nil
   end
 
   # Modifies device tokens associated with a tag.
@@ -156,7 +153,7 @@ class Zeppelin
   #
   # @see http://urbanairship.com/docs/tags.html#modifying-device-tokens-on-a-tag
   def modify_device_tokens_on_tag(tag_name, payload = {})
-    @connection.post(tag_uri(tag_name), payload, JSON_HEADERS)
+    connection.post(tag_uri(tag_name), payload, JSON_HEADERS)
   end
 
   # Creates a tag that is not associated with any device
@@ -165,8 +162,8 @@ class Zeppelin
   #
   # @return [Boolean] whether or not the request was successful
   def add_tag(name)
-    response = @connection.put(tag_uri(name))
-    successful?(response)
+    response = connection.put(tag_uri(name))
+    response.success?
   end
 
   # Removes a tag from the service
@@ -176,16 +173,16 @@ class Zeppelin
   # @return [Boolean] true when the request was successful. Note that this
   #   method will return false if the tag has already been removed.
   def remove_tag(name)
-    response = @connection.delete(tag_uri(name))
-    successful?(response)
+    response = connection.delete(tag_uri(name))
+    response.success?
   end
 
   # @param [String] device_token
   #
   # @return [Hash, nil]
   def device_tags(device_token)
-    response = @connection.get(device_tag_uri(device_token, nil))
-    successful?(response) ? parse(response.body) : nil
+    response = connection.get(device_tag_uri(device_token, nil))
+    response.success? ? response.body : nil
   end
 
   # @param [String] device_token
@@ -195,8 +192,8 @@ class Zeppelin
   # @return [Boolean] whether or not a tag was successfully associated with
   #   a device
   def add_tag_to_device(device_token, tag_name)
-    response = @connection.put(device_tag_uri(device_token, tag_name))
-    successful?(response)
+    response = connection.put(device_tag_uri(device_token, tag_name))
+    response.success?
   end
 
   # @param [String] device_token
@@ -206,20 +203,34 @@ class Zeppelin
   # @return [Boolean] whether or not a tag was successfully dissociated from
   #   a device
   def remove_tag_from_device(device_token, tag_name)
-    response = @connection.delete(device_tag_uri(device_token, tag_name))
-    successful?(response)
+    response = connection.delete(device_tag_uri(device_token, tag_name))
+    response.success?
   end
-  
+
   private
-  
+
+  def initialize_connection
+    conn = Faraday::Connection.new(BASE_URI, @options) do |builder|
+      builder.request :json
+
+      builder.use Zeppelin::JsonParserMiddleware
+
+      builder.adapter :net_http
+    end
+
+    conn.basic_auth(@application_key, @application_master_secret)
+
+    conn
+  end
+
   def device_token_uri(device_token)
     "/api/device_tokens/#{device_token}"
   end
-  
+
   def apid_uri(apid)
     "/api/apids/#{apid}"
   end
-  
+
   def feedback_uri(since)
     "/api/device_tokens/feedback/?since=#{since.utc.iso8601}"
   end
@@ -231,14 +242,7 @@ class Zeppelin
   def device_tag_uri(device_token, tag_name)
     device_token_uri(device_token) + "/tags/#{tag_name}"
   end
-  
-  def successful?(response)
-    SUCCESSFUL_STATUS_CODES.include?(response.status)
-  end
-
-  def parse(json)
-    Yajl::Parser.parse(json)
-  end
 end
 
+require 'zeppelin/json_parser_middleware'
 require 'zeppelin/version'

data/lib/zeppelin/json_parser_middleware.rb

@@ -0,0 +1,35 @@
+require 'yajl'
+
+class Zeppelin
+  # Middleware for Faraday that parses JSON response bodies. Based on code in
+  # the FaradayMiddleware project.
+  #
+  # @private
+  class JsonParserMiddleware < Faraday::Middleware
+    CONTENT_TYPE = 'Content-Type'
+
+    def initialize(app=nil)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env).on_complete do
+        parse_response(env) if process_content_type?(env) && parse_response?(env)
+      end
+    end
+
+    private
+
+    def parse_response(env)
+      env[:body] = Yajl::Parser.parse(env[:body])
+    end
+
+    def process_content_type?(env)
+      env[:response_headers][CONTENT_TYPE].to_s =~ /\bjson$/
+    end
+
+    def parse_response?(env)
+      env[:body].respond_to? :to_str
+    end
+  end
+end

data/lib/zeppelin/version.rb

@@ -1,3 +1,3 @@
 class Zeppelin
-  VERSION = '0.4.0'
-end
+  VERSION = '0.5.0'
+end

data/test/json_parser_middleware_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class JsonParserMiddlewareTest < Zeppelin::TestCase
+  def setup
+    @json_body = "{\"foo\":\"bar\"}"
+    @expected_parsed_body = { 'foo' => 'bar' }
+  end
+
+  test 'parses a standard JSON content type' do
+    assert_equal @expected_parsed_body, process(@json_body, 'application/json').body
+  end
+
+  test 'parses vendor JSON content type' do
+    assert_equal @expected_parsed_body, process(@json_body, 'application/vnd.urbanairship+json').body
+  end
+
+  test 'does not change nil body' do
+    assert process(nil).body.nil?
+  end
+
+  test 'does not parse non-JSON content types' do
+    assert_equal '<hello>world</hello>', process('<hello>world</hello>', 'text/xml').body
+  end
+
+  def process(body, content_type=nil, options={})
+    env = { :body => body, :response_headers => Faraday::Utils::Headers.new }
+    env[:response_headers]['content-type'] = content_type if content_type
+
+    middleware = Zeppelin::JsonParserMiddleware.new(
+      lambda { |env| Faraday::Response.new(env) }
+    )
+
+    middleware.call(env)
+  end
+end

data/test/zeppelin_test.rb

@@ -12,6 +12,7 @@ class ZeppelinTest < Zeppelin::TestCase
     assert_equal 'go.urbanairship.com', @client.connection.host
     assert_includes @client.connection.builder.handlers, Faraday::Adapter::NetHttp
     assert_includes @client.connection.builder.handlers, Faraday::Request::JSON
+    assert_includes @client.connection.builder.handlers, Zeppelin::JsonParserMiddleware
     assert_equal 'Basic YXBwIGtleTphcHAgbWFzdGVyIHNlY3JldA==', @client.connection.headers['Authorization']
   end
   
@@ -70,7 +71,7 @@ class ZeppelinTest < Zeppelin::TestCase
     response_body = { 'foo' => 'bar' }
     stub_requests @client.connection do |stub|
       stub.get("/api/device_tokens/#{@device_token}") do
-        [200, {}, Yajl::Encoder.encode(response_body)]
+        [200, { 'Content-Type' => 'application/json' }, Yajl::Encoder.encode(response_body)]
       end
     end
     
@@ -160,7 +161,7 @@ class ZeppelinTest < Zeppelin::TestCase
     response_body = { 'foo' => 'bar' }
     stub_requests @client.connection do |stub|
       stub.get("/api/apids/#{@apid}") do
-        [200, {}, Yajl::Encoder.encode(response_body)]
+        [200, { 'Content-Type' => 'application/json' }, Yajl::Encoder.encode(response_body)]
       end
     end
     
@@ -289,7 +290,7 @@ class ZeppelinTest < Zeppelin::TestCase
     
     stub_requests @client.connection do |stub|
       stub.get('/api/device_tokens/feedback/?since=1970-01-01T00%3A00%3A00Z') do
-        [200, {}, Yajl::Encoder.encode(response_body)]
+        [200, { 'Content-Type' => 'application/json' }, Yajl::Encoder.encode(response_body)]
       end
     end
     
@@ -315,7 +316,7 @@ class ZeppelinTest < Zeppelin::TestCase
 
     stub_requests @client.connection do |stub|
       stub.get('/api/tags/') do
-        [200, {}, Yajl::Encoder.encode(response_body)]
+        [200, { 'Content-Type' => 'application/json' }, Yajl::Encoder.encode(response_body)]
       end
     end
 
@@ -382,7 +383,7 @@ class ZeppelinTest < Zeppelin::TestCase
 
     stub_requests @client.connection do |stub|
       stub.get("/api/device_tokens/#{device_token}/tags/") do
-        [200, {}, Yajl::Encoder.encode(response_body)]
+        [200, { 'Content-Type' => 'application/json' }, Yajl::Encoder.encode(response_body)]
       end
     end
 

data/zeppelin.gemspec

@@ -11,19 +11,20 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/CapnKernul/zeppelin'
   s.summary     = %q{Urban Airship library for Ruby}
   s.description = %q{Ruby client for the Urban Airship Push Notification API}
-  
+
   s.rubyforge_project = 'zeppelin'
-  
+
   s.add_dependency 'faraday'
   s.add_dependency 'yajl-ruby'
-  
+
   s.add_development_dependency 'minitest', '~> 2.0'
   s.add_development_dependency 'journo'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'test_declarative'
-  
+  s.add_development_dependency 'rake'
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeppelin
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
+date: 2012-02-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2165051200 !ruby/object:Gem::Requirement
+  requirement: &70115497098880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165051200
+  version_requirements: *70115497098880
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2165050780 !ruby/object:Gem::Requirement
+  requirement: &70115497097860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165050780
+  version_requirements: *70115497097860
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2165050280 !ruby/object:Gem::Requirement
+  requirement: &70115497095520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2165050280
+  version_requirements: *70115497095520
 - !ruby/object:Gem::Dependency
   name: journo
-  requirement: &2165049860 !ruby/object:Gem::Requirement
+  requirement: &70115497094220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165049860
+  version_requirements: *70115497094220
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2165049400 !ruby/object:Gem::Requirement
+  requirement: &70115497092480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165049400
+  version_requirements: *70115497092480
 - !ruby/object:Gem::Dependency
   name: test_declarative
-  requirement: &2165048980 !ruby/object:Gem::Requirement
+  requirement: &70115497090680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165048980
+  version_requirements: *70115497090680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70115497089600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70115497089600
 description: Ruby client for the Urban Airship Push Notification API
 email:
 - alex@kernul.com
@@ -93,7 +104,9 @@ files:
 - README.md
 - Rakefile
 - lib/zeppelin.rb
+- lib/zeppelin/json_parser_middleware.rb
 - lib/zeppelin/version.rb
+- test/json_parser_middleware_test.rb
 - test/test_helper.rb
 - test/zeppelin_test.rb
 - zeppelin.gemspec
@@ -109,18 +122,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 437314845617063875
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 437314845617063875
 requirements: []
 rubyforge_project: zeppelin
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Urban Airship library for Ruby
 test_files:
+- test/json_parser_middleware_test.rb
 - test/test_helper.rb
 - test/zeppelin_test.rb