restful_spec 1.0.0

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 restful_spec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jason Waldrip
+
+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,58 @@
+# RestfulSpec
+
+Restful spec is an easy way to add a machine readable, comprehensive specification to your apis, without having to write a lot of documentation. The gem automatically discovers routes and builds out resources accordingly. With the option to customize a bit with a handy DSL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'restful_spec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restful_spec
+
+## Usage
+
+### Include the Module
+```
+class MyController < ApplicationController
+  include RestfulSpec
+
+  # ...
+end
+
+```
+
+### Add a bit of customization. Only if you want!
+```
+class MyController < ApplicationController
+  include RestfulSpec
+
+  specification do
+    description "An API for MyController"
+    attributes except: [:id, :created_at]
+    accepts_formats :json, :xml
+    accepts_parameters attributes: :all, for: 'POST /my'
+    responds_with :collection, for: 'GET /my'
+    responds_with :member, for: 'GET /my/:id'
+  end
+
+  #...
+
+end
+
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/restful_spec.rb

@@ -0,0 +1,42 @@
+require "restful_spec/version"
+
+module RestfulSpec
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+
+  autoload :Specification
+  autoload :Error
+
+  included do
+
+    class_attribute :current_specification
+    self.current_specification = Specification.new self
+
+    private :current_specification
+
+    specification do
+      accepts_parameters for: %w(PUT POST)
+      accepts_formats :json, :xml
+      responds_with :member, for: %w(GET POST)
+      responds_with :specification, for: 'OPTIONS'
+      responds_with :collection, for: controller.controller_name
+      responds_with :success, for: %w(PUT DELETE)
+    end
+  end
+
+  def spec
+    render json: current_specification
+  end
+
+  module ClassMethods
+
+    def specification(resource = nil, &block)
+      current_specification.resource = resource if resource
+      current_specification.parse(&block) if block_given?
+    end
+
+  end
+
+end
+
+require 'restful_spec/railtie' if defined?(Rails) && Rails.version >= '3.2'

data/lib/restful_spec/error.rb

@@ -0,0 +1,12 @@
+module RestfulSpec::Error
+
+  class InvalidAction < StandardError
+
+    def initialize(message, actions)
+      message += "\n\nValid actions are: \n\n#{actions.join("\n")}\n\n"
+      super(message)
+    end
+
+  end
+
+end

data/lib/restful_spec/railtie.rb

@@ -0,0 +1,33 @@
+class RestfulSpec::Railtie < Rails::Railtie
+
+  initializer "Add spec/options route to routing" do
+    ActiveSupport.on_load :action_controller do
+      ActionDispatch::Routing::Mapper.send :include, SpecRoutes
+    end
+  end
+
+  module SpecRoutes
+
+    def resources(*resources, &block)
+      super
+      options = resources.extract_options!
+      resource_scope(:resources, ActionDispatch::Routing::Mapper::Resources::Resource.new(resources.pop, options)) do
+        collection do
+          match '/' => "#{parent_resource.controller}#spec", via: :options, as: :specification
+        end
+      end
+    end
+
+    def resource(*resources, &block)
+      super
+      options = resources.extract_options!
+      resource_scope(:resource, ActionDispatch::Routing::Mapper::Resources::SingletonResource.new(resources.pop, options)) do
+        collection do
+          match '/' => "#{parent_resource.controller}#spec", via: :options, as: :specification
+        end
+      end
+    end
+
+  end
+
+end

data/lib/restful_spec/specification.rb

@@ -0,0 +1,153 @@
+class RestfulSpec::Specification
+  extend ActiveSupport::Autoload
+
+  autoload :Action
+
+  attr_reader :controller, :resource
+  delegate :as_json, to: :spec_hash
+
+  def resource=(val)
+    @resource = val.classify.constantize
+  end
+
+  def parse(&block)
+    instance_eval(&block) if block_given?
+  end
+
+  private
+
+  def initialize(controller)
+    @controller = controller
+    self.resource = controller.controller_name
+    @attributes = @resource.column_names.map(&:to_sym) if active_record?
+    @attributes ||= []
+    @description = "Api for #{resource_name}"
+    @actions = nil
+    @formats = []
+  end
+
+  def resource_name
+    resource.name.titleize
+  end
+
+  def accepts_formats(*args)
+    @formats = args.map{ |i| i.is_a?(Set) ? i.to_a : i }.flatten
+  end
+
+  alias :accepts_format :accepts_formats
+
+  def accessible_attributes
+    resource.respond_to?(:accessible_attributes) ? resource.accessible_attributes : Set.new
+  end
+
+  def accepts_parameters(options={})
+
+    raise RestfulSpec::Error::InvalidAction,
+          "accepts_parameter requires a valid action!",
+          actions unless (actions = Array.wrap(options.delete :for)).present?
+
+    actions = actions.map { |a| get_action(a) }.flatten
+
+    params = SmartSelect.new(accessible_attributes, options[:attributes]) do
+      select :only
+      reject :except
+    end
+
+    actions.reduce([]) do |action_map, action|
+      raise RestfulSpec::Error::InvalidAction,
+            "#{action_string} is not a valid action for #{@controller.class.name}!", self.actions unless action.present?
+
+      action.parameters = params.to_a.select(&:present?)
+      action_map << action
+    end
+
+  end
+
+  alias :accepts_parameter :accepts_parameters
+
+  def responds_with(responder, options)
+    raise RestfulSpec::Error::InvalidAction,
+          "responds_with requires a valid action!",
+          actions unless options[:for].present?
+    actions = [options[:for]].flatten.map { |a| get_action(a) }.flatten
+    actions.each do |action|
+      raise RestfulSpec::Error::InvalidAction,
+            "#{action_string} is not a valid action for #{@controller.class.name}!",
+            actions unless action.present?
+      action.responds_with = responder
+    end
+  end
+
+  def get_action(string)
+    Array.wrap(actions).select do |action|
+      action.match?(string)
+    end
+  end
+
+  def actions
+    @actions ||= Action.from_routes(controller)
+  end
+
+  def description(string)
+    @description = string
+  end
+
+  def attributes(*args)
+
+    options = args.extract_options!
+    args = @attributes unless args.present?
+    @attributes = SmartSelect.new(args, options) do
+      select :only
+      reject :except
+      add    :methods
+    end
+
+  end
+
+  def spec_hash
+    {
+      resource: resource.to_s.titleize,
+      description: @description,
+      formats: @formats,
+      attributes: @attributes,
+      actions: actions
+    }
+  end
+
+  def active_record?
+    resource.ancestors.include?(ActiveRecord::Base)
+  end
+
+  class SmartSelect < Array
+
+    attr_reader :options
+
+    def _included_(matcher)
+      ->(item) { Array.wrap(options[matcher]).include?(item) }
+    end
+
+    def initialize(*args, &block)
+      @options = args.extract_options!
+      super(args.first.to_a)
+      instance_eval(&block) if block_given?
+    end
+
+    def add(matcher)
+      self.replace self + Array.wrap(options[matcher])
+    end
+
+    def select(matcher)
+      self.replace( super &_included_(matcher) ) if options[matcher].present?
+    end
+
+    alias :select! :select
+
+    def reject(matcher)
+      self.replace( super &_included_(matcher) ) if options[matcher].present?
+    end
+
+    alias :reject! :reject
+
+  end
+
+end

data/lib/restful_spec/specification/action.rb

@@ -0,0 +1,61 @@
+class RestfulSpec::Specification::Action
+
+  attr_accessor :parameters, :responds_with
+  attr_reader :route
+
+  def self.from_routes(controller)
+    Rails.application.routes.routes.reduce([]) do |actions, route|
+      verbs = if route.verb.is_a?(Regexp)
+                array = route.verb.source.split('|')
+                array.map { |verb| verb.gsub(/[^a-z]/i, '') }
+              elsif route.verb.present?
+                Array.wrap(route.verb)
+              else
+                %w(GET POST PUT DELETE)
+              end
+
+      verbs.each do |verb|
+        action = new(verb, route, controller)
+        actions << action if action.exists?
+      end
+
+      actions
+    end
+  end
+
+  def initialize(verb, route, controller)
+    @route = route
+    @controller = controller
+
+    @name = route.name
+    @path = route.path.respond_to?(:spec) ? route.path.spec.to_s : route.path
+    @path.gsub!(/\(\.:format\)$/,'')
+    @method = verb
+
+    self.parameters = Set.new
+    self.responds_with = nil
+  end
+
+  def exists?
+    route.defaults[:controller] == @controller.controller_path && @controller.method_defined?(route.defaults[:action])
+  end
+
+  def as_json(*args)
+    hash = {}
+    hash[:method] = @method
+    hash[:path] = @path
+    hash[:name] = @name
+    hash[:parameters] = parameters
+    hash[:responds_with] = responds_with
+    hash.as_json(*args)
+  end
+
+  def match?(string)
+    to_s == string || @method == string || @name == string || @path == string
+  end
+
+  def to_s
+    [@method, @path].join(' ')
+  end
+
+end

data/lib/restful_spec/version.rb

@@ -0,0 +1,3 @@
+module RestfulSpec
+  VERSION = "1.0.0"
+end

data/restful_spec.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restful_spec/version'
+
+Gem::Specification.new do |gem|
+
+  gem.name          = "restful_spec"
+  gem.version       = RestfulSpec::VERSION
+  gem.authors       = ["Jason Waldrip"]
+  gem.email         = ["jason@waldrip.net"]
+  gem.description   = %q{Restful spec is an easy way to add a machine readable, comprehensive specification to your apis, without having to write a lot of documentation. The gem automatically discovers routes and builds out resources accordingly. With the option to customize a bit with a handy DSL.}
+  gem.summary       = %q{Specifications your your rest API's}
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport"
+  #gem.add_dependency "rails", "> 3.2"
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: restful_spec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Waldrip
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Restful spec is an easy way to add a machine readable, comprehensive
+  specification to your apis, without having to write a lot of documentation. The
+  gem automatically discovers routes and builds out resources accordingly. With the
+  option to customize a bit with a handy DSL.
+email:
+- jason@waldrip.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/restful_spec.rb
+- lib/restful_spec/error.rb
+- lib/restful_spec/railtie.rb
+- lib/restful_spec/specification.rb
+- lib/restful_spec/specification/action.rb
+- lib/restful_spec/version.rb
+- restful_spec.gemspec
+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.23
+signing_key: 
+specification_version: 3
+summary: Specifications your your rest API's
+test_files: []
+has_rdoc: