rocket_shorts 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.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 rocket_shorts.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Justin Smestad
+
+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,50 @@
+# RocketShorts
+
+This is an extension or set of overrides that sit on top of [RocketPants](https://github.com/filtersquad/rocket_pants). This is not an elegant extension by any means, but rather a set of modules that leverage the RocketPants load order to monkey-patch functionality.
+
+## Why RocketShorts over RocketPants?
+
+There are a few differentiators: (neither is the 'right way', its personal preference)
+
+**Note** Support for points 3 and 4 are planned, but not included in the current gem.
+
+1. Version control is done through the `Accept` HTTP Header instead of a `:version` parameter.
+2. Support for a default version. Making HTTP testing possible for a single version.
+3. Pagination should use the `link` HTTP Header and not the content body.
+4. Clean up the payload body to avoid nesting under a `resource` key.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rocket_shorts'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rocket_shorts
+
+## Usage
+
+Remove `rocket_pants` from your Gemfile and replace with `rocket_shorts`.
+
+Add a `config/inititalizers/rocket_shorts.rb` and specify what header format
+your API should look for.
+
+```ruby
+# config/initializers/rocket_shorts.rb
+require 'rocket\_shorts'
+
+RocketShorts.header_format = /application\/vnd\.yourcompany\.v/
+```
+
+## 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

data/Rakefile

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

data/lib/rocket_shorts.rb

@@ -0,0 +1,19 @@
+require "rocket_pants"
+
+require "rocket_shorts/version"
+
+module RocketShorts
+  autoload :Base, 'rocket_shorts/base'
+  autoload :Routing, 'rocket_shorts/routing'
+  autoload :RoutingConstraints, 'rocket_shorts/routing_constraints'
+  autoload :Versioning, 'rocket_shorts/controller/versioning'
+
+  ActionDispatch::Routing::Mapper.send :include, RocketShorts::Routing
+
+  require 'rocket_shorts/railtie' if defined?(Rails::Railtie)
+
+
+  mattr_accessor :header_format
+
+  # self.header_format = /^application\/vnd\.example\.v/
+end

data/lib/rocket_shorts/base.rb

@@ -0,0 +1,58 @@
+require 'rocket_pants/errors'
+
+module RocketShorts
+  class Base < ActionController::Metal
+
+    abstract!
+
+    MODULES = [
+      ActionController::HideActions,
+      ActionController::UrlFor,
+      ActionController::Redirecting,
+      ActionController::ConditionalGet,
+      ActionController::RackDelegation,
+      ActionController::RecordIdentifier,
+      ActionController::HttpAuthentication::Basic::ControllerMethods,
+      ActionController::HttpAuthentication::Digest::ControllerMethods,
+      ActionController::HttpAuthentication::Token::ControllerMethods,
+      RocketPants::UrlFor,
+      RocketPants::Respondable,
+      RocketPants::HeaderMetadata,
+      RocketPants::Linking,
+      RocketShorts::Versioning,
+      RocketPants::Instrumentation,
+      RocketPants::Caching,
+      # Include earliest as possible in the request.
+      AbstractController::Callbacks,
+      ActionController::Rescue,
+      RocketPants::ErrorHandling,
+      RocketPants::Rescuable,
+      RocketPants::JSONP
+      # FormatVerification # TODO: Implement Format Verification
+    ].compact
+
+    # If possible, include the Rails controller methods in Airbrake to make it useful.
+    begin
+      require 'airbrake'
+      require 'airbrake/rails/controller_methods'
+      MODULES << Airbrake::Rails::ControllerMethods
+    rescue LoadError => e
+    end
+
+    MODULES.each do |mixin|
+      include mixin
+    end
+
+    # Bug fix for rails - include compatibility.
+    config_accessor :protected_instance_variables
+    self.protected_instance_variables = %w(@assigns @performed_redirect @performed_render
+      @variables_added @request_origin @url @parent_controller @action_name
+      @before_filter_chain_aborted @_headers @_params @_response)
+
+    ActiveSupport.run_load_hooks(:rocket_pants, self)
+
+    # Methods for integration purposes.
+    def self.helper_method(*); end
+
+  end
+end

data/lib/rocket_shorts/controller/versioning.rb

@@ -0,0 +1,38 @@
+module RocketShorts
+  module Versioning
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_version_range
+    end
+
+    module ClassMethods
+
+      def version(version)
+        version = version..version if version.is_a?(Integer)
+        self._version_range = version
+        before_filter :verify_api_version
+      end
+
+    end
+
+    protected
+
+    def version
+      if !instance_variable_defined?(:@version)
+        @version = begin
+          header = request.headers['Accept'].match(/#{RocketShorts.header_format}(\d+?)/)
+          version = header[1] rescue nil
+          version.present? && Integer(version)
+        rescue ArgumentError
+          nil
+        end
+      end
+      @version
+    end
+
+    def verify_api_version
+      error! :invalid_version if version.present? && !_version_range.include?(version)
+    end
+  end
+end

data/lib/rocket_shorts/railtie.rb

@@ -0,0 +1,12 @@
+module RocketPants
+  class Railtie < Rails::Railtie
+
+    config.rocket_shorts = ActiveSupport::OrderedOptions.new
+    config.rocket_shorts.header_format = /application\/vnd\.example\.v/
+
+    initializer "rocket_shorts.configuration" do |app|
+      rs_config                       = app.config.rocket_shorts
+      RocketShorts.header_format      = rs_config.header_format
+    end
+  end
+end

data/lib/rocket_shorts/routing.rb

@@ -0,0 +1,32 @@
+# This modifies RocketPants routing to use
+# accept headers and namespaces instead of a :version parameter.
+#
+# (see RocketPants::Routing)
+require 'rocket_pants/routing'
+
+module RocketShorts
+  module Routing
+
+    # Scopes a set of given api routes, allowing for option versions.
+    # @param [Hash] options options to pass through to the route e.g. `:module`.
+    # @option options [Array<Integer>, Integer] :versions the versions to support
+    # @option options [Array<Integer>, Integer] :version the single version to support
+    # @raise [ArgumentError] raised when the version isn't provided.
+    def rocket_pants(options = {}, &blk)
+      versions = (Array(options.delete(:versions)) + Array(options.delete(:version))).flatten.map(&:to_s)
+      versions.each do |version|
+        raise ArgumentError, "Got invalid version: '#{version}'" unless version =~ /\A\d+\Z/
+      end
+      versions_regexp = /(#{versions.uniq.join("|")})/
+      raise ArgumentError, 'please provide atleast one version' if versions.empty?
+      options = options.deep_merge({
+        constraints: RoutingConstraints.new(versions: versions_regexp, default: !!options.delete(:default)),
+      })
+      namespace :api, defaults: {format: 'json'} do
+        scope options, &blk
+      end
+    end
+    alias api rocket_pants
+
+  end
+end

data/lib/rocket_shorts/routing_constraints.rb

@@ -0,0 +1,19 @@
+module RocketShorts
+  class RoutingConstraints
+    def initialize(options)
+      @version = options[:version]
+      @versions = options[:versions]
+      @default = options[:default]
+    end
+
+    def matches?(req)
+      puts 'yoyoyo'
+      req.headers['Accept'].match(/#{RocketShorts.header_format}#{@versions}/)
+      # if @versions.present?
+        # @default ||
+      # else
+        # @default || req.headers['Accept'].match(/#{RocketShorts.header_format}#{@version}/)
+      # end
+    end
+  end
+end

data/lib/rocket_shorts/version.rb

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

data/rocket_shorts.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rocket_shorts/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin Smestad"]
+  gem.email         = ["justin.smestad@gmail.com"]
+  gem.description   = %q{Because RocketPants needs another clothing option.}
+  gem.summary       = %q{Because RocketPants needs another clothing option.}
+  gem.homepage      = "https://github.com/jsmestad/rocket_shorts"
+
+  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          = "rocket_shorts"
+  gem.require_paths = ["lib"]
+  gem.version       = RocketShorts::VERSION
+
+  gem.add_dependency 'rocket_pants', '~> 1.5.3'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'yard'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rocket_shorts'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |c|
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rocket_shorts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Smestad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rocket_pants
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Because RocketPants needs another clothing option.
+email:
+- justin.smestad@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rocket_shorts.rb
+- lib/rocket_shorts/base.rb
+- lib/rocket_shorts/controller/versioning.rb
+- lib/rocket_shorts/railtie.rb
+- lib/rocket_shorts/routing.rb
+- lib/rocket_shorts/routing_constraints.rb
+- lib/rocket_shorts/version.rb
+- rocket_shorts.gemspec
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+homepage: https://github.com/jsmestad/rocket_shorts
+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'
+      segments:
+      - 0
+      hash: 2663302009248484271
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2663302009248484271
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Because RocketPants needs another clothing option.
+test_files:
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+has_rdoc: