grape_sinatra_helpers 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape_sinatra_helpers.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Derek Lindahl
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Grape Sinatra Helpers
+
+This is a small subset of helper methods available in `Sinatra::Base` that I
+have ported over to [Grape]
+
+* `cache_control`
+* `expires`
+* `last_modified`
+* `etag`
+
+And a few others that the above directly depend on.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape_sinatra_helpers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape_sinatra_helpers
+
+## Usage
+
+Use these methods as you normally would with the Sinatra equivalent.
+
+## TODO
+
+* Port over Sinatra test cases
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[grape]: https://github.com/intridea/grape

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/grape_sinatra_helpers.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grape_sinatra_helpers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Derek Lindahl"]
+  gem.email         = ["dlindahl@customink.com"]
+  gem.description   = %q{Small subset of Sinatra helper methods ported to Grape}
+  gem.summary       = %q{A small subset of Sinatra::Base helper methods that have been ported over to Grape}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "grape_sinatra_helpers"
+  gem.require_paths = ["lib"]
+  gem.version       = GrapeSinatraHelpers::VERSION
+end

data/lib/grape_sinatra_helpers/version.rb

@@ -0,0 +1,3 @@
+module GrapeSinatraHelpers
+  VERSION = "0.0.1"
+end

data/lib/grape_sinatra_helpers.rb

@@ -0,0 +1,158 @@
+require "grape_sinatra_helpers/version"
+
+module GrapeSinatraHelpers
+
+  def self.included( klass )
+    klass.send(:helpers) do
+
+      # Specify response freshness policy for HTTP caches (Cache-Control header).
+      # Any number of non-value directives (:public, :private, :no_cache,
+      # :no_store, :must_revalidate, :proxy_revalidate) may be passed along with
+      # a Hash of value directives (:max_age, :min_stale, :s_max_age).
+      #
+      #   cache_control :public, :must_revalidate, :max_age => 60
+      #   => Cache-Control: public, must-revalidate, max-age=60
+      #
+      # See RFC 2616 / 14.9 for more on standard cache control directives:
+      # http://tools.ietf.org/html/rfc2616#section-14.9.1
+      def cache_control(*values)
+        if values.last.kind_of?(Hash)
+          hash = values.pop
+          hash.reject! { |k,v| v == false }
+          hash.reject! { |k,v| values << k if v == true }
+        else
+          hash = {}
+        end
+
+        values.map! { |value| value.to_s.tr('_','-') }
+        hash.each do |key, value|
+          key = key.to_s.tr('_', '-')
+          value = value.to_i if key == "max-age"
+          values << [key, value].join('=')
+        end
+
+        header 'Cache-Control', values.join(', ') if values.any?
+      end
+
+      # Set the Expires header and Cache-Control/max-age directive. Amount
+      # can be an integer number of seconds in the future or a Time object
+      # indicating when the response should be considered "stale". The remaining
+      # "values" arguments are passed to the #cache_control helper:
+      #
+      #   expires 500, :public, :must_revalidate
+      #   => Cache-Control: public, must-revalidate, max-age=60
+      #   => Expires: Mon, 08 Jun 2009 08:50:17 GMT
+      #
+      def expires(amount, *values)
+        values << {} unless values.last.kind_of?(Hash)
+
+        if amount.is_a? Integer
+          time    = Time.now + amount.to_i
+          max_age = amount
+        else
+          time    = time_for amount
+          max_age = time - Time.now
+        end
+
+        values.last.merge!(:max_age => max_age)
+        cache_control(*values)
+
+        header 'Expires', time.httpdate
+      end
+
+      # Set the last modified time of the resource (HTTP 'Last-Modified' header)
+      # and halt if conditional GET matches. The +time+ argument is a Time,
+      # DateTime, or other object that responds to +to_time+.
+      #
+      # When the current request includes an 'If-Modified-Since' header that is
+      # equal or later than the time specified, execution is immediately halted
+      # with a '304 Not Modified' response.
+      def last_modified(time)
+        return unless time
+        time = time_for time
+        header 'Last-Modified', time.httpdate
+        return if request.env['HTTP_IF_NONE_MATCH']
+
+        if request.env['HTTP_IF_MODIFIED_SINCE']
+          # compare based on seconds since epoch
+          since = Time.httpdate(request.env['HTTP_IF_MODIFIED_SINCE']).to_i
+          error!('304 Not Modified', 304) if since >= time.to_i
+        end
+
+        if request.env['HTTP_IF_UNMODIFIED_SINCE']
+          # compare based on seconds since epoch
+          since = Time.httpdate(request.env['HTTP_IF_UNMODIFIED_SINCE']).to_i
+          error!('412 Precondition Failed', 412) if since < time.to_i
+        end
+      rescue ArgumentError
+      end
+
+      # Set the response entity tag (HTTP 'ETag' header) and halt if conditional
+      # GET matches. The +value+ argument is an identifier that uniquely
+      # identifies the current version of the resource. The +kind+ argument
+      # indicates whether the etag should be used as a :strong (default) or :weak
+      # cache validator.
+      #
+      # When the current request includes an 'If-None-Match' header with a
+      # matching etag, execution is immediately halted. If the request method is
+      # GET or HEAD, a '304 Not Modified' response is sent.
+      def etag(value, options = {})
+        # Before touching this code, please double check RFC 2616 14.24 and 14.26.
+        options      = {:kind => options} unless Hash === options
+        kind         = options[:kind] || :strong
+        new_resource = options.fetch(:new_resource) { request.post? }
+
+        unless [:strong, :weak].include?(kind)
+          raise ArgumentError, ":strong or :weak expected"
+        end
+
+        # value = '"%s"' % value
+        value = "%s" % value
+        value = 'W/' + value if kind == :weak
+        header 'ETag', value
+
+        if etag_matches? request.env['HTTP_IF_NONE_MATCH'], new_resource
+          request.safe? ? error!('304 Not Modified', 304) : error!('412 Precondition Failed', 412)
+        end
+
+        if request.env['HTTP_IF_MATCH']
+          error!('412 Precondition Failed', 412) unless etag_matches? request.env['HTTP_IF_MATCH'], new_resource
+        end
+      end
+
+      # Helper method checking if a ETag value list includes the current ETag.
+      def etag_matches?(list, new_resource = request.post?)
+        return !new_resource if list == '*'
+        list.to_s.split(/\s*,\s*/).include? header['ETag']
+      end
+
+      # Generates a Time object from the given value.
+      # Used by #expires and #last_modified.
+      def time_for(value)
+        if value.respond_to? :to_time
+          value.to_time
+        elsif value.is_a? Time
+          value
+        elsif value.respond_to? :new_offset
+          # DateTime#to_time does the same on 1.9
+          d = value.new_offset 0
+          t = Time.utc d.year, d.mon, d.mday, d.hour, d.min, d.sec + d.sec_fraction
+          t.getlocal
+        elsif value.respond_to? :mday
+          # Date#to_time does the same on 1.9
+          Time.local(value.year, value.mon, value.mday)
+        elsif value.is_a? Numeric
+          Time.at value
+        else
+          Time.parse value.to_s
+        end
+      rescue ArgumentError => boom
+        raise boom
+      rescue Exception
+        raise ArgumentError, "unable to convert #{value.inspect} to a Time object"
+      end
+
+    end
+  end
+
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: grape_sinatra_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Derek Lindahl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-17 00:00:00.000000000Z
+dependencies: []
+description: Small subset of Sinatra helper methods ported to Grape
+email:
+- dlindahl@customink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grape_sinatra_helpers.gemspec
+- lib/grape_sinatra_helpers.rb
+- lib/grape_sinatra_helpers/version.rb
+homepage: ''
+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.10
+signing_key: 
+specification_version: 3
+summary: A small subset of Sinatra::Base helper methods that have been ported over
+  to Grape
+test_files: []