sinatra-helpers-http-vary 0.1.0

data/README.md

@@ -0,0 +1,36 @@
+Sinatra helpers to set the HTTP "`Vary`" header.
+
+See [RFC 2616 (HTTP/1.1): Vary](http://tools.ietf.org/html/rfc2616#section-14.44)
+
+Author: Philipp Kempgen, [http://kempgen.net](http://kempgen.net)
+
+
+## Usage
+
+Include the module in your Sinatra application:
+
+	helpers ::Sinatra::Helpers::HTTP::Vary
+
+Example:
+
+	vary! 'Accept'
+	vary! 'Accept-Language'
+	# headers['Vary'] is now "Accept, Accept-Language"
+
+Example:
+
+	vary! '*'
+	# headers['Vary'] is now "*"
+
+Example:
+
+	vary! '*'
+	vary! 'Accept-Language'
+	# headers['Vary'] is now "*"
+
+Example:
+
+	vary! 'Accept-Language'
+	vary! '*'
+	# headers['Vary'] is now "*"
+

data/lib/sinatra-helpers/http/vary.rb

@@ -0,0 +1,67 @@
+require 'sinatra/base'
+
+# see Sinatra
+module Sinatra
+	# see Sinatra
+	module Helpers
+		
+		# HTTP helpers
+		module HTTP
+			
+			# Helpers to set the HTTP "`Vary`" header.
+			#
+			# Usage:
+			#
+			# Include the module in your Sinatra application:
+			#
+			#   helpers ::Sinatra::Helpers::HTTP::Vary
+			#
+			module Vary
+				
+				VARY_HEADER = 'Vary'.freeze
+				VARY_UNSPECIFIED = '*'.freeze
+				
+				# Sets the HTTP "`Vary`" header in Sinatra's response
+				# `headers`.
+				#
+				# @param   hdr_name  [String]   The HTTP header name.
+				# @return                       The updated `headers`.
+				#
+				def vary!( hdr_name )
+					hdr_name = hdr_name.to_s  if ! hdr_name.kind_of?( ::String )
+					
+					# Shortcut to avoid expensive splitting in the
+					# simple "*" case:
+					if hdr_name == VARY_UNSPECIFIED
+						headers[ VARY_HEADER ] = VARY_UNSPECIFIED.dup  unless (headers[ VARY_HEADER ] == VARY_UNSPECIFIED)
+						
+					# Normal operation:
+					else
+						vary_hdrs = headers[ VARY_HEADER ].to_s.
+							split( /\s*(?:,\s*)+/ )
+						
+						if vary_hdrs.include?( VARY_UNSPECIFIED )
+							headers[ VARY_HEADER ] = VARY_UNSPECIFIED.dup
+						else
+							headers[ VARY_HEADER ] =
+								vary_hdrs.
+								push( hdr_name ).
+								uniq( & :downcase ).
+								join( ',' )
+						end
+					end
+					return headers[ VARY_HEADER ]
+				end
+				
+				#def vary=( str )
+				#	headers[ VARY_HEADER ] = str
+				#end
+				
+			end
+		end
+	end
+	
+	#helpers Helpers::HTTP::Vary
+	#::Sinatra::Base.helpers Helpers::HTTP::Vary
+end
+

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-helpers-http-vary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Philipp Kempgen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Helpers for setting the HTTP Vary header in Sinatra.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sinatra-helpers/http/vary.rb
+- README.md
+homepage: https://github.com/philipp-kempgen/sinatra-helpers-http-vary
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Sinatra helpers to set the HTTP Vary header.
+test_files: []
+has_rdoc: