crepe 0.0.1.pre

data/lib/crepe/middleware/head.rb

@@ -0,0 +1,30 @@
+module Crepe
+  module Middleware
+    # This middleware wraps boths sides of a request.
+    #
+    # Going in, it munges the Rack environment so that a HEAD request
+    # masquerades as a GET request by the time it hits a Crepe Endpoint. The
+    # Crepe request helper will know it's a HEAD request by referring to the
+    # `crepe.original_request_method` environment value.
+    #
+    # Going out, it ensures an empty response body.
+    class Head
+
+      def initialize app
+        @app = app
+      end
+
+      def call env
+        if env['REQUEST_METHOD'] == 'HEAD'
+          env['crepe.original_request_method'] = 'HEAD'
+          env['REQUEST_METHOD'] = 'GET'
+          status, headers, _ = @app.call env
+          [status, headers, []]
+        else
+          @app.call env
+        end
+      end
+
+    end
+  end
+end

data/lib/crepe/middleware/restful_status.rb

@@ -0,0 +1,33 @@
+module Crepe
+  module Middleware
+    # This middleware provides intelligent defaults for response status codes
+    # depending on the HTTP verb:
+    #
+    # - POST will provide 201 Created.
+    #
+    # - DELETE will provide 204 No Content (and clear the response body).
+    class RestfulStatus
+
+      def initialize app
+        @app = app
+      end
+
+      def call env
+        status, headers, body = @app.call env
+
+        if status == 200
+          case env['REQUEST_METHOD']
+          when 'POST'
+            status = 201
+          when 'DELETE'
+            status = 204
+            body = []
+          end
+        end
+
+        [status, headers, body]
+      end
+    end
+
+  end
+end

data/lib/crepe/params.rb

@@ -0,0 +1,74 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'crepe/util'
+
+module Crepe
+  #--
+  # Based on https://github.com/rails/strong_parameters, provides a security
+  # proxy object for submitted parameters.
+  #++
+  class Params < BasicObject
+
+    instance_methods.grep(/^[^_]/).each { |m| undef_method m }
+
+    # Raised when a required parameter is missing (see Crepe::Params#require).
+    class Missing < ::IndexError
+
+      attr_reader :key
+
+      def initialize key
+        @key = key
+        super "Missing parameter: #{key}"
+      end
+
+    end
+
+    # Raised when an unpermitted parameter is found (see Crepe::Params#permit).
+    class Invalid < ::StandardError
+
+      attr_reader :keys
+
+      def initialize keys
+        @keys = keys
+        super "Invalid parameter(s): #{keys.join ', '}"
+      end
+
+    end
+
+    def initialize params = {}
+      @params = ::HashWithIndifferentAccess.new params
+      ::Crepe::Util.deep_freeze @params
+      @permitted = false
+    end
+
+    def require required_key
+      fetch(required_key) { raise Missing, required_key }
+    end
+
+    def permit *secure_keys
+      insecure_keys = keys - secure_keys.map(&:to_s)
+      raise Invalid, insecure_keys unless insecure_keys.empty?
+      @permitted = true
+      self
+    end
+
+    def permitted?
+      @permitted
+    end
+
+    def dup
+      @params.dup
+    end
+
+    def respond_to? method_name, include_private = false
+      [:require, :permit, :permitted?].include? method_name or super
+    end
+
+    private
+
+      def method_missing method_name, *args, &block
+        value = @params.send method_name, *args, &block
+        value.is_a?(::Hash) ? ::Crepe::Params.new(value) : value
+      end
+
+  end
+end

data/lib/crepe/util.rb

@@ -0,0 +1,73 @@
+require 'active_support/core_ext/object/duplicable'
+
+module Crepe
+  module Util
+
+    autoload :HashStack,      'crepe/util/hash_stack'
+    autoload :ChainedInclude, 'crepe/util/chained_include'
+
+    # Deeply duplicates values in the object passed in. If the object
+    # is a Hash or Array, it recursively dups the object's values.
+    #
+    # Active Support's deep_dup does not dup array contents.
+    def deep_dup object
+      object = object.dup if object.duplicable?
+
+      case object
+        when Hash  then object.each { |k, v| object[k] = deep_dup v }
+        when Array then object.map! { |o| deep_dup o }
+      end
+
+      object
+    end
+
+    # See `deeper_merge!`: returns a copy of the original hash, rather
+    # than merging it in place.
+    def deeper_merge hash, other_hash
+      deeper_merge! hash.dup, other_hash
+    end
+
+    # Deeply merges the first hash with the second hash, concatenating
+    # any array values that are shared across keys.
+    def deeper_merge! hash, other_hash
+      other_hash.each do |key, value|
+        if hash[key].is_a?(Hash) && value.is_a?(Hash)
+          hash[key] = deeper_merge hash[key], value
+        elsif hash[key].is_a?(Array) && value.is_a?(Array)
+          hash[key] += value
+        else
+          hash[key] = value
+        end
+      end
+
+      hash
+    end
+
+    # Recursively freezes all keys and values.
+    def deep_freeze hash
+      hash.each do |key, value|
+        case value
+          when Hash  then deep_freeze value
+          when Array then value.each { |v| deep_freeze v }
+          else            value.freeze
+        end
+      end
+      hash.freeze
+    end
+
+    def normalize_path path
+      normalize_path! path.dup
+    end
+
+    def normalize_path! path
+      path.squeeze! '/'
+      path.sub! %r{/+\z}, ''
+      path.sub! %r{/([.?])}, '\1'
+      path.replace '/' if path.empty?
+      path
+    end
+
+    extend self
+
+  end
+end

data/lib/crepe/util/chained_include.rb

@@ -0,0 +1,78 @@
+module Crepe
+  module Util
+    # Forwards all future includes to objects that have already been
+    # extended by (or have included) the parent module.
+    #
+    # Default Ruby behavior:
+    #
+    #   # A module is defined...
+    #   module A
+    #   end
+    #
+    #   # ...and included in a class.
+    #   class B
+    #     include Module A
+    #   end
+    #
+    #   # Given another module...
+    #   module C
+    #     def c
+    #     end
+    #   end
+    #
+    #   # ...included in the first...
+    #   module A
+    #     include Module C
+    #   end
+    #
+    #   # ...the class will not have access to its methods.
+    #   B.new.c # NoMethodError: undefined method `c' for #<B>
+    #
+    # To prevent the above error, the original module could have been
+    # extended with ChainedInclude:
+    #
+    #   module A
+    #     extend ChainedInclude
+    #   end
+    #   class B
+    #     include Module A
+    #   end
+    #   module C
+    #     def c
+    #     end
+    #   end
+    #   module A
+    #     include Module C
+    #   end
+    #   B.new.c # => nil
+    module ChainedInclude
+
+      private
+
+        def include mod
+          super
+          extending.each { |object| object.extend mod }
+          included_by.each { |base| base.__send__ :include, mod }
+        end
+
+        def extended object
+          super
+          extending << object
+        end
+
+        def included base
+          super
+          included_by << base
+        end
+
+        def extending
+          @_extending ||= []
+        end
+
+        def included_by
+          @_included_by ||= []
+        end
+
+    end
+  end
+end

data/lib/crepe/util/hash_stack.rb

@@ -0,0 +1,57 @@
+require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/module/delegation'
+
+module Crepe
+  module Util
+    # A {Hash}-like object that scopes state changes using an underlying stack.
+    class HashStack
+
+      def initialize first = {}
+        @stack = Array.wrap first
+      end
+
+      delegate :pop, :push, :<<,
+        to: :stack
+
+      def top
+        stack.last
+      end
+
+      delegate :[]=, :delete,
+        to: :top
+
+      def key? key
+        stack.any? { |frame| frame.key? key }
+      end
+
+      def [] key
+        found_at = stack.reverse.detect { |frame| frame.key? key }
+        found_at && found_at[key]
+      end
+
+      def all key
+        stack.map { |frame| frame[key] }.flatten 1
+      end
+
+      def with frame = {}
+        self << frame
+        yield
+        pop
+      end
+
+      def to_hash
+        stack.inject({}, &:merge)
+      end
+      alias_method :to_h, :to_hash
+
+      def dup
+        self.class.new Util.deep_dup stack
+      end
+
+      attr_reader :stack
+      private :stack
+
+    end
+  end
+end
+

data/lib/crepe/version.rb

@@ -0,0 +1,10 @@
+module Crepe
+
+  MAJOR   = 0
+  MINOR   = 0
+  PATCH   = 1
+  PRE     = 'pre'
+
+  VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join '.'
+
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: crepe
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Stephen Celis
+- Evan Owen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rack-mount
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: |
+  Rack-based API framework
+email:
+- stephen@stephencelis.com
+- kainosnoema@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/crepe/api.rb
+- lib/crepe/endpoint/filter/acceptance.rb
+- lib/crepe/endpoint/filter/parser.rb
+- lib/crepe/endpoint/filter.rb
+- lib/crepe/endpoint/renderer/base.rb
+- lib/crepe/endpoint/renderer/simple.rb
+- lib/crepe/endpoint/renderer/tilt.rb
+- lib/crepe/endpoint/renderer.rb
+- lib/crepe/endpoint/request.rb
+- lib/crepe/endpoint.rb
+- lib/crepe/middleware/content_negotiation.rb
+- lib/crepe/middleware/head.rb
+- lib/crepe/middleware/restful_status.rb
+- lib/crepe/middleware.rb
+- lib/crepe/params.rb
+- lib/crepe/util/chained_include.rb
+- lib/crepe/util/hash_stack.rb
+- lib/crepe/util.rb
+- lib/crepe/version.rb
+- lib/crepe.rb
+homepage: https://github.com/stephencelis/crepe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Rack-based API framework
+test_files: []