rocket_pants 1.0.0.rc.1

data/lib/rocket_pants/locale/en.yml

@@ -0,0 +1,8 @@
+en:
+  rocket_pants:
+    errors:
+      throttled: "You have gone over your allotted amount of requests and have been throttled."
+      unauthenticated: "This action requires authentication to continue."
+      invalid_version: "This action is not available in the given version of the api."
+      not_implemented: "The feature you requested has not yet been implemented and hence is currently unavailable."
+      not_found: "The requested resource could not be found."

data/lib/rocket_pants/railtie.rb

@@ -0,0 +1,44 @@
+module RocketPants
+  class Railtie < Rails::Railtie
+
+    config.rocket_pants = ActiveSupport::OrderedOptions.new
+    config.rocket_pants.use_caching = nil
+
+    config.i18n.railties_load_path << File.expand_path('../locale/en.yml', __FILE__)
+
+    initializer "rocket_pants.logger" do
+      ActiveSupport.on_load(:rocket_pants) { self.logger ||= Rails.logger }
+    end
+
+    initializer "rocket_pants.configuration" do |app|
+      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
+      # Set the rocket pants cache if present.
+      RocketPants.cache = rp_config.cache if rp_config.cache
+    end
+
+    initializer "rocket_pants.url_helpers" do |app|
+      ActiveSupport.on_load(:rocket_pants) do
+        include app.routes.url_helpers
+      end
+    end
+
+    initializer "rocket_pants.setup_testing" do |app|
+      ActiveSupport.on_load(:rocket_pants) do
+        include ActionController::Testing if Rails.env.test?
+      end
+    end
+
+    initializer "rocket_pants.setup_caching" do |app|
+      if RocketPants.caching_enabled?
+        app.middleware.insert 'Rack::Runtime', RocketPants::CacheMiddleware
+      end
+    end
+
+    rake_tasks do
+      load "rocket_pants/tasks/rocket_pants.rake"
+    end
+
+  end
+end

data/lib/rocket_pants/routing.rb

@@ -0,0 +1,26 @@
+module RocketPants
+  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 => {:version => versions_regexp},
+        :path        => ':version',
+        :defaults    => {:format => 'json'}
+      })
+      scope options, &blk
+    end
+    alias api rocket_pants
+
+  end
+end

data/lib/rocket_pants/rspec_matchers.rb

@@ -0,0 +1,117 @@
+module RocketPants
+  module RSpecMatchers
+    extend RSpec::Matchers::DSL
+
+    def self.normalised_error(e)
+      if e.is_a?(String) || e.is_a?(Symbol)
+        Errors[e]
+      else
+        e
+      end
+    end
+
+    def self.normalise_urls(object)
+      if object.is_a?(Array)
+        object.each { |o| o['url'] = nil }
+      elsif object.is_a?(Hash) || object.is_a?(APISmith::Smash)
+        object['url'] = nil
+      end
+      object
+    end
+
+    # Converts it to JSON and back again.
+    def self.normalise_as_json(object, options = {})
+      options = options.reverse_merge(:compact => true) if object.is_a?(Array)
+      object = RocketPants::Respondable.normalise_object(object, options)
+      j = ActiveSupport::JSON
+      j.decode(j.encode({'response' => object}))['response']
+    end
+
+    def self.normalise_response(response, options = {})
+      normalise_urls normalise_as_json response, options
+    end
+
+    def self.valid_for?(response, allowed, disallowed)
+      body = response.decoded_body
+      return false if body.blank?
+      body = body.to_hash
+      return false if body.has_key?("error")
+      allowed.all? { |f| body.has_key?(f) } && !disallowed.any? { |f| body.has_key?(f) }
+    end
+
+    def self.differ
+      @_differ ||= RSpec::Expectations::Differ.new
+    end
+
+    matcher :_be_api_error do |error_type|
+
+      match do |response|
+        @error = response.decoded_body.error
+        @error.present? && (error_type.blank? || RSpecMatchers.normalised_error(@error) == error_type)
+      end
+
+      failure_message_for_should do |response|
+        if @error.blank?
+          "expected #{error_type || "any error"} on response, got no error"
+        else error_type.present? && (normalised = RSpecMatchers.normalised_error(@error)) != error_type
+          "expected #{error_type || "any error"} but got #{normalised} instead"
+        end
+      end
+
+      failure_message_for_should_not do |response|
+        "expected response to not have an #{error_type || "error"}, but it did (#{@error})"
+      end
+
+    end
+
+    matcher :be_singular_resource do
+
+      match do |response|
+        RSpecMatchers.valid_for? response, %w(), %w(count pagination)
+      end
+
+    end
+
+    matcher :be_collection_resource do
+
+      match do |response|
+        RSpecMatchers.valid_for? response, %w(count), %w(pagination)
+      end
+
+    end
+
+    matcher :be_paginated_resource do
+
+      match do |response|
+        RSpecMatchers.valid_for? response, %w(count pagination), %w()
+      end
+
+    end
+
+    matcher :have_exposed do |*args|
+      normalised_response = RSpecMatchers.normalise_response(*args)
+
+      match do |response|
+        @decoded = RSpecMatchers.normalise_urls(response.parsed_body["response"])
+        normalised_response == @decoded
+      end
+
+      failure_message_for_should do |response|
+        message = "expected api to have exposed #{normalised_response.inspect}, got #{@decoded.inspect} instead."
+        message << "\n\nDiff: #{RSpecMatchers.differ.diff_as_object(@decoded, normalised_response)}"
+        message
+      end
+
+      failure_message_for_should_not do |response|
+        "expected api to not have exposed #{normalised_response.inspect}"
+      end
+
+    end
+
+    def be_api_error(error = nil)
+      _be_api_error error
+    end
+
+
+  end
+end

data/lib/rocket_pants/tasks/rocket_pants.rake

@@ -0,0 +1,32 @@
+namespace :rocket_pants do
+
+  desc "Generates a pretty listing of errors registered in the application"
+  task :errors => :environment do
+    errors = RocketPants::Errors.all
+    output = [["Error Name", "HTTP Status", "Class Name"]]
+    errors.keys.map(&:to_s).sort.each do |key|
+      klass = errors[key.to_sym]
+      http_status = klass.respond_to?(:http_status) && klass.http_status
+      status_code = Rack::Utils.status_code(http_status)
+      status_name = http_status.is_a?(Integer) ?  Rack::Utils::HTTP_STATUS_CODES[http_status] : http_status.to_s.titleize
+      output << [key, "#{status_code} #{status_name}", klass.name]
+    end
+    total_width = 8
+    0.upto(2) do |column|
+      fields = output.map { |i| i[column] }
+      length = fields.map(&:length).max + 2
+      total_width += length
+      fields.each_with_index do |item, idx|
+        output[idx][column] = item.ljust(length)
+      end
+    end
+    puts("+#{"-" * total_width}+")
+    puts "| #{output[0] * " | "} |"
+    puts("+#{"-" * total_width}+")
+    output[1..-1].each do |row|
+      puts "| #{row * " | "} |"
+    end
+    puts("+#{"-" * total_width}+")
+  end
+
+end

data/lib/rocket_pants/test_helper.rb

@@ -0,0 +1,94 @@
+require 'hashie/mash'
+
+module RocketPants
+  module TestHelper
+    extend ActiveSupport::Concern
+
+    included do
+      # Extend the response on first include.
+      class_attribute :_default_version
+      unless ActionController::TestResponse < ResponseHelper
+        ActionController::TestResponse.send :include, ResponseHelper
+      end
+    end
+
+    module ResponseHelper
+
+      def parsed_body
+        @_parsed_body ||= begin
+          ActiveSupport::JSON.decode(body)
+        rescue StandardError => e
+          nil
+        end
+      end
+
+      def decoded_body
+        @_decoded_body ||= begin
+          decoded = parsed_body
+          if decoded.is_a?(Hash)
+            Hashie::Mash.new(decoded)
+          else
+            decoded
+          end
+        end
+      end
+
+    end
+
+    module ClassMethods
+
+      def default_version(value)
+        self._default_version = value
+      end
+
+    end
+
+    def decoded_response
+      value = response.decoded_body.try(:response)
+    end
+
+    def decoded_pagination
+      response.decoded_body.try :pagination
+    end
+
+    def decoded_count
+      response.decoded_body.try :count
+    end
+
+    def decoded_error_class
+      error = response.decoded_body.try :error
+      error.presence && RocketPants::Errors[error]
+    end
+
+    # RSpec matcher foo.
+
+    def have_decoded_response(value)
+      response = normalise_value(value)
+    end
+
+    protected
+
+    # Like process, but automatically adds the api version.
+    def process(action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+      parameters ||= {}
+      if _default_version.present? && parameters[:version].blank? && parameters['version'].blank?
+        parameters[:version] = _default_version
+      end
+      super
+    end
+
+    def normalise_value(value)
+      if value.is_a?(Hash)
+        value.inject({}) do |acc, (k, v)|
+          acc[k.to_s] = normalise_value(v)
+          acc
+        end
+      elsif value.is_a?(Array)
+        value.map { |v| normalise_value v }
+      else
+        value
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: rocket_pants
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc.1
+  prerelease: 6
+platform: ruby
+authors:
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70156424600020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70156424600020
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70156424599460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70156424599460
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: &70156424598940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70156424598940
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70156424598420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70156424598420
+- !ruby/object:Gem::Dependency
+  name: api_smith
+  requirement: &70156424598020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70156424598020
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: &70156424754640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70156424754640
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: &70156424754180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70156424754180
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70156424753680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70156424753680
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70156424753060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70156424753060
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70156424752600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70156424752600
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70156424751900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70156424751900
+description: Rocket Pants adds JSON API love to Rails and ActionController, making
+  it simpler to build resource-oriented controllers.
+email:
+- sutto@sutto.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rocket_pants/base.rb
+- lib/rocket_pants/cache_middleware.rb
+- lib/rocket_pants/cacheable.rb
+- lib/rocket_pants/client.rb
+- lib/rocket_pants/controller/caching.rb
+- lib/rocket_pants/controller/error_handling.rb
+- lib/rocket_pants/controller/instrumentation.rb
+- lib/rocket_pants/controller/rescuable.rb
+- lib/rocket_pants/controller/respondable.rb
+- lib/rocket_pants/controller/url_for.rb
+- lib/rocket_pants/controller/versioning.rb
+- lib/rocket_pants/exceptions.rb
+- lib/rocket_pants/locale/en.yml
+- lib/rocket_pants/railtie.rb
+- lib/rocket_pants/routing.rb
+- lib/rocket_pants/rspec_matchers.rb
+- lib/rocket_pants/tasks/rocket_pants.rake
+- lib/rocket_pants/test_helper.rb
+- lib/rocket_pants.rb
+homepage: http://github.com/filtersquad
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: JSON API love for Rails and ActionController
+test_files: []