rocket_pants 1.2.1 → 1.3.0

data/lib/rocket_pants.rb

@@ -32,17 +32,21 @@ module RocketPants
   autoload :JSONP,              'rocket_pants/controller/jsonp'
   autoload :Rescuable,          'rocket_pants/controller/rescuable'
   autoload :Respondable,        'rocket_pants/controller/respondable'
+  autoload :HeaderMetadata,     'rocket_pants/controller/header_metadata'
+  autoload :Linking,            'rocket_pants/controller/linking'
   autoload :Versioning,         'rocket_pants/controller/versioning'
   autoload :FormatVerification, 'rocket_pants/controller/format_verification'
   autoload :UrlFor,             'rocket_pants/controller/url_for'
 
-  mattr_accessor :caching_enabled
+  mattr_accessor :caching_enabled, :header_metadata
   self.caching_enabled = false
+  self.header_metadata = false
 
   mattr_writer :cache
 
   class << self
     alias caching_enabled? caching_enabled
+    alias header_metadata? header_metadata
 
     def cache
       @@cache ||= Moneta::Memory.new

data/lib/rocket_pants/base.rb

@@ -18,6 +18,8 @@ module RocketPants
       ActionController::HttpAuthentication::Token::ControllerMethods,
       UrlFor,
       Respondable,
+      HeaderMetadata,
+      Linking,
       Versioning,
       Instrumentation,
       Caching,

data/lib/rocket_pants/cache_middleware.rb

@@ -2,6 +2,7 @@ module RocketPants
   class CacheMiddleware
     
     NOT_MODIFIED = [304, {}, []]
+    DIVIDER      = ":"
     
     def initialize(app)
       @app = app
@@ -29,7 +30,6 @@ module RocketPants
 
     def has_valid_etag?
       return false if (etags = request_etags).blank?
-      debug ""
       etags.any? do |etag|
         cache_key, value = extract_cache_key_and_value etag
         debug "Processing cache key for path #{request_path}"
@@ -39,7 +39,7 @@ module RocketPants
     end
     
     def extract_cache_key_and_value(etag)
-      etag.to_s.split(":", 2)
+      etag.to_s.split(DIVIDER, 2)
     end
     
     def fresh?(key, value)
@@ -48,7 +48,7 @@ module RocketPants
     
     def request_etags
       stored = @env['HTTP_IF_NONE_MATCH']
-      stored.present? && stored.to_s.scan(/"([^"]+)"/)
+      stored.present? && stored.to_s.scan(/"([^"]+)"/).flatten.select { |i| i.include?(DIVIDER) }
     end
     
     def debug(message)

data/lib/rocket_pants/controller/header_metadata.rb

@@ -0,0 +1,38 @@
+module RocketPants
+  module HeaderMetadata
+
+    # Given a hash of request metadata, will:
+    # 1. Write out the headers for the current metadata
+    # 2. Return the hash, suitable for merging into the response hash
+    # 3. Start a dance party.
+    #
+    # @param  [Hash{Symbol => Object}] metadata the hash of the request metadata.
+    # @return [Hash{Symbol => Object}] the passed in metadata
+    def expose_metadata(metadata)
+      metadata_headers { build_header_hash(metadata) }
+      super # Call any other versions of the method.
+    end
+
+
+    # Given a block which returns a Hash, will call and merge the block iff header metadata
+    # is enabled. This is to avoid the overhead of generating headers on every request when
+    # it's disabled.
+    def metadata_headers(&blk)
+      headers.merge! blk.call if RocketPants.header_metadata?
+    end
+
+    def build_header_hash(options, hash = {}, prefix = 'X-Api')
+      options.each_pair do |k, v|
+        current = "#{prefix}-#{k.to_s.titleize.tr(" ", "-")}"
+        if v.is_a?(Hash)
+          build_header_hash v, hash, current
+        else
+          value = Array(v).join(", ")
+          hash[current] = value if value.present?
+        end
+      end
+      hash
+    end
+
+  end
+end

data/lib/rocket_pants/controller/linking.rb

@@ -0,0 +1,41 @@
+module RocketPants
+  module Linking
+
+    # Generates a Link: header with the specified rel, uri and attributes.
+    # @param [String, Symbol] rel the relation of the given link
+    # @param [String] uri the full uri to the specified link resource
+    # @param [Hash] attributes any other attributes for the link
+    def link(rel, uri, attributes = {})
+      headers['Link'] ||= []
+      attributes = {:rel => rel}.merge(attributes)
+      link = "<#{uri}>"
+      attributes.each_pair { |k, v| link << "; #{k}=\"#{v}\"" }
+      headers['Link'] << link
+    end
+
+    # Lets you add a series of links for the current resource.
+    # @param [Hash{Symbol => String}] links a hash of links. Those with nil as the value are skipped.
+    def links(links = {})
+      links.each_pair do |rel, uri|
+        link rel, uri if uri
+      end
+    end
+
+    # Hook method - Implement this to link to the current resource and we'll automatically add header links.
+    def page_url(page)
+      nil
+    end
+
+    def expose_metadata(metadata)
+      super.tap do |meta|
+        if RocketPants.header_metadata? && (pagination = meta[:pagination])
+          links :next  => (pagination[:next] && page_url(pagination[:next])),
+                :prev  => (pagination[:previous] && page_url(pagination[:previous])),                
+                :last  => (pagination[:pages] && page_url(pagination[:pages])),
+                :first => page_url(1)
+        end
+      end
+    end
+
+  end
+end

data/lib/rocket_pants/controller/respondable.rb

@@ -96,10 +96,11 @@ module RocketPants
     def collection(collection, options = {})
       pre_process_exposed_object collection, :collection, false
       options = options.reverse_merge(:compact => true)
+      meta = expose_metadata(:count => collection.length)
       render_json({
         :response => normalise_object(collection, options),
         :count    => collection.length
-      }, options)
+      }.merge(meta), options)
       post_process_exposed_object collection, :collection, false
     end
 
@@ -107,11 +108,13 @@ module RocketPants
     def paginated(collection, options = {})
       pre_process_exposed_object collection, :paginated, false
       options = options.reverse_merge(:compact => true)
-      render_json({
-        :response   => normalise_object(collection, options),
+      meta = expose_metadata({
         :count      => collection.length,
         :pagination => Respondable.extract_pagination(collection)
-      }, options)
+      })
+      render_json({
+        :response   => normalise_object(collection, options),
+      }.merge(meta), options)
       post_process_exposed_object collection, :paginated, false
     end
 
@@ -146,5 +149,16 @@ module RocketPants
     def post_process_exposed_object(resource, type, singular)
     end
 
+    # Given a hash of request metadata, will:
+    # 1. Do anything special with the request metadata
+    # 2. Return the hash, suitable for merging into the response hash
+    # 3. Start a dance party.
+    #
+    # @param  [Hash{Symbol => Object}] metadata the hash of the request metadata.
+    # @return [Hash{Symbol => Object}] the passed in metadata
+    def expose_metadata(metadata)
+      metadata
+    end
+
   end
 end

data/lib/rocket_pants/railtie.rb

@@ -1,8 +1,9 @@
 module RocketPants
   class Railtie < Rails::Railtie
 
-    config.rocket_pants = ActiveSupport::OrderedOptions.new
-    config.rocket_pants.use_caching = nil
+    config.rocket_pants                 = ActiveSupport::OrderedOptions.new
+    config.rocket_pants.use_caching     = nil
+    config.rocket_pants.header_metadata = nil
 
     config.i18n.railties_load_path << File.expand_path('../locale/en.yml', __FILE__)
 
@@ -14,6 +15,7 @@ module RocketPants
       rp_config = app.config.rocket_pants
       rp_config.use_caching = Rails.env.production? if rp_config.use_caching.nil?
       RocketPants.caching_enabled = rp_config.use_caching
+      RocketPants.header_metadata = rp_config.header_metadata unless rp_config.header_metadata.nil?
       # Set the rocket pants cache if present.
       RocketPants.cache = rp_config.cache if rp_config.cache
     end

data/lib/rocket_pants/test_helper.rb

@@ -52,7 +52,7 @@ module RocketPants
     end
 
     def decoded_count
-      response.decoded_body.try :count
+      response.decoded_body[:count]
     end
 
     def decoded_error_class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocket_pants
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-03 00:00:00.000000000 Z
+date: 2012-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -250,8 +250,10 @@ files:
 - lib/rocket_pants/controller/caching.rb
 - lib/rocket_pants/controller/error_handling.rb
 - lib/rocket_pants/controller/format_verification.rb
+- lib/rocket_pants/controller/header_metadata.rb
 - lib/rocket_pants/controller/instrumentation.rb
 - lib/rocket_pants/controller/jsonp.rb
+- lib/rocket_pants/controller/linking.rb
 - lib/rocket_pants/controller/rescuable.rb
 - lib/rocket_pants/controller/respondable.rb
 - lib/rocket_pants/controller/url_for.rb