RubyGems - jmoses_apipie-rails - Versions diffs - 0.0.23 - Mend

jmoses_apipie-rails 0.0.23

Files changed (120) hide show

data/.gitignore +11 -0
data/.rspec +2 -0
data/.travis.yml +4 -0
data/APACHE-LICENSE-2.0 +202 -0
data/CHANGELOG +55 -0
data/Gemfile +3 -0
data/MIT-LICENSE +20 -0
data/NOTICE +4 -0
data/README.rst +938 -0
data/Rakefile +13 -0
data/apipie-rails.gemspec +26 -0
data/app/controllers/apipie/apipies_controller.rb +105 -0
data/app/public/apipie/javascripts/apipie.js +6 -0
data/app/public/apipie/javascripts/bundled/bootstrap-collapse.js +138 -0
data/app/public/apipie/javascripts/bundled/bootstrap.js +1726 -0
data/app/public/apipie/javascripts/bundled/jquery-1.7.2.js +9404 -0
data/app/public/apipie/javascripts/bundled/prettify.js +28 -0
data/app/public/apipie/stylesheets/application.css +20 -0
data/app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css +12 -0
data/app/public/apipie/stylesheets/bundled/bootstrap.min.css +689 -0
data/app/public/apipie/stylesheets/bundled/prettify.css +30 -0
data/app/views/apipie/apipies/_disqus.html.erb +11 -0
data/app/views/apipie/apipies/_params.html.erb +29 -0
data/app/views/apipie/apipies/_params_plain.html.erb +16 -0
data/app/views/apipie/apipies/apipie_404.html.erb +12 -0
data/app/views/apipie/apipies/getting_started.html.erb +4 -0
data/app/views/apipie/apipies/index.html.erb +43 -0
data/app/views/apipie/apipies/method.html.erb +71 -0
data/app/views/apipie/apipies/plain.html.erb +70 -0
data/app/views/apipie/apipies/resource.html.erb +98 -0
data/app/views/apipie/apipies/static.html.erb +101 -0
data/app/views/layouts/apipie/apipie.html.erb +26 -0
data/lib/apipie-rails.rb +15 -0
data/lib/apipie/apipie_module.rb +62 -0
data/lib/apipie/application.rb +334 -0
data/lib/apipie/client/generator.rb +135 -0
data/lib/apipie/configuration.rb +128 -0
data/lib/apipie/dsl_definition.rb +379 -0
data/lib/apipie/error_description.rb +25 -0
data/lib/apipie/errors.rb +38 -0
data/lib/apipie/extractor.rb +151 -0
data/lib/apipie/extractor/collector.rb +113 -0
data/lib/apipie/extractor/recorder.rb +124 -0
data/lib/apipie/extractor/writer.rb +367 -0
data/lib/apipie/helpers.rb +52 -0
data/lib/apipie/markup.rb +48 -0
data/lib/apipie/method_description.rb +191 -0
data/lib/apipie/param_description.rb +204 -0
data/lib/apipie/railtie.rb +9 -0
data/lib/apipie/resource_description.rb +102 -0
data/lib/apipie/routing.rb +15 -0
data/lib/apipie/see_description.rb +39 -0
data/lib/apipie/static_dispatcher.rb +59 -0
data/lib/apipie/validator.rb +310 -0
data/lib/apipie/version.rb +3 -0
data/lib/generators/apipie/install/README +6 -0
data/lib/generators/apipie/install/install_generator.rb +25 -0
data/lib/generators/apipie/install/templates/initializer.rb.erb +7 -0
data/lib/tasks/apipie.rake +166 -0
data/rel-eng/packages/.readme +3 -0
data/rel-eng/packages/rubygem-apipie-rails +1 -0
data/rel-eng/tito.props +5 -0
data/spec/controllers/api/v1/architectures_controller_spec.rb +30 -0
data/spec/controllers/api/v2/architectures_controller_spec.rb +12 -0
data/spec/controllers/api/v2/nested/resources_controller_spec.rb +11 -0
data/spec/controllers/apipies_controller_spec.rb +141 -0
data/spec/controllers/concerns_controller_spec.rb +42 -0
data/spec/controllers/users_controller_spec.rb +473 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/controllers/api/base_controller.rb +4 -0
data/spec/dummy/app/controllers/api/v1/architectures_controller.rb +42 -0
data/spec/dummy/app/controllers/api/v1/base_controller.rb +11 -0
data/spec/dummy/app/controllers/api/v2/architectures_controller.rb +30 -0
data/spec/dummy/app/controllers/api/v2/base_controller.rb +11 -0
data/spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb +30 -0
data/spec/dummy/app/controllers/api/v2/nested/resources_controller.rb +33 -0
data/spec/dummy/app/controllers/application_controller.rb +6 -0
data/spec/dummy/app/controllers/concerns/sample_controller.rb +39 -0
data/spec/dummy/app/controllers/concerns_controller.rb +8 -0
data/spec/dummy/app/controllers/twitter_example_controller.rb +302 -0
data/spec/dummy/app/controllers/users_controller.rb +251 -0
data/spec/dummy/app/views/layouts/application.html.erb +21 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +45 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +21 -0
data/spec/dummy/config/environment.rb +8 -0
data/spec/dummy/config/environments/development.rb +25 -0
data/spec/dummy/config/environments/production.rb +49 -0
data/spec/dummy/config/environments/test.rb +35 -0
data/spec/dummy/config/initializers/apipie.rb +102 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +10 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +22 -0
data/spec/dummy/db/.gitkeep +0 -0
data/spec/dummy/doc/apipie_examples.yml +28 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +26 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/public/javascripts/application.js +2 -0
data/spec/dummy/public/javascripts/controls.js +965 -0
data/spec/dummy/public/javascripts/dragdrop.js +974 -0
data/spec/dummy/public/javascripts/effects.js +1123 -0
data/spec/dummy/public/javascripts/prototype.js +6001 -0
data/spec/dummy/public/javascripts/rails.js +202 -0
data/spec/dummy/public/stylesheets/.gitkeep +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/lib/application_spec.rb +38 -0
data/spec/lib/method_description_spec.rb +30 -0
data/spec/lib/param_description_spec.rb +174 -0
data/spec/lib/param_group_spec.rb +45 -0
data/spec/lib/resource_description_spec.rb +30 -0
data/spec/lib/validator_spec.rb +46 -0
data/spec/spec_helper.rb +32 -0
metadata +337 -0

data/app/views/layouts/apipie/apipie.html.erb ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>API documentation</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+  <%= Apipie.include_stylesheets %>
+  <link type='text/css' rel='stylesheet' href='<%= Apipie.full_url("stylesheets/application.css")%>'/>
+  <!-- IE6-8 support of HTML5 elements -->
+  <!--[if lt IE 9]>
+    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+</head>
+<body>
+  <div class="container">
+    <div class="row">
+      <div id='container'>
+        <%= yield %>
+        <%= render 'disqus' if Apipie.configuration.use_disqus? %>
+      </div>
+    </div>
+    <hr>
+    <footer><%= yield :apipie_footer %></footer>
+  </div>
+  <%= Apipie.include_javascripts %>
+</body>
+</html>

data/lib/apipie-rails.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require "apipie/routing"
+require "apipie/markup"
+require "apipie/apipie_module"
+require "apipie/dsl_definition"
+require "apipie/configuration"
+require "apipie/method_description"
+require "apipie/resource_description"
+require "apipie/param_description"
+require "apipie/errors"
+require "apipie/error_description"
+require "apipie/see_description"
+require "apipie/validator"
+require "apipie/railtie"
+require 'apipie/extractor'
+require "apipie/version"

data/lib/apipie/apipie_module.rb ADDED Viewed

@@ -0,0 +1,62 @@
+require "apipie/helpers"
+require "apipie/application"
+module Apipie
+  extend Apipie::Helpers
+  def self.app
+    @application ||= Apipie::Application.new
+  end
+  def self.to_json(version = nil, resource_name = nil, method_name = nil)
+    version ||= Apipie.configuration.default_version
+    app.to_json(version, resource_name, method_name)
+  end
+  # all calls delegated to Apipie::Application instance
+  def self.method_missing(method, *args, &block)
+    app.respond_to?(method) ? app.send(method, *args, &block) : super
+  end
+  def self.configure
+    yield configuration
+  end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  def self.debug(message)
+    puts message if Apipie.configuration.debug
+  end
+  # get application description for given or default version
+  def self.app_info(version = nil)
+    if app_info_version_valid? version
+      Apipie.markup_to_html(self.configuration.app_info[version])
+    elsif app_info_version_valid? Apipie.configuration.default_version
+      Apipie.markup_to_html(self.configuration.app_info[Apipie.configuration.default_version])
+    else
+      "Another API description"
+    end
+  end
+  def self.api_base_url(version = nil)
+    if api_base_url_version_valid? version
+      self.configuration.api_base_url[version]
+    elsif api_base_url_version_valid? Apipie.configuration.default_version
+      self.configuration.api_base_url[Apipie.configuration.default_version]
+    else
+      "/api"
+    end
+  end
+  def self.app_info_version_valid?(version)
+    version && self.configuration.app_info.has_key?(version)
+  end
+  def self.api_base_url_version_valid?(version)
+    version && self.configuration.api_base_url.has_key?(version)
+  end
+end

data/lib/apipie/application.rb ADDED Viewed

@@ -0,0 +1,334 @@
+require 'apipie/static_dispatcher'
+require 'yaml'
+module Apipie
+  class Application
+    # we need engine just for serving static assets
+    class Engine < Rails::Engine
+      initializer "static assets" do |app|
+        app.middleware.use ::Apipie::StaticDispatcher, "#{root}/app/public", Apipie.configuration.doc_base_url
+      end
+    end
+    attr_reader :resource_descriptions
+    def initialize
+      super
+      init_env
+    end
+    def available_versions
+      @resource_descriptions.keys.sort
+    end
+    def set_resource_id(controller, resource_id)
+      @controller_to_resource_id[controller] = resource_id
+    end
+    # create new method api description
+    def define_method_description(controller, method_name, dsl_data)
+      return if ignored?(controller, method_name)
+      ret_method_description = nil
+      versions = dsl_data[:api_versions] || []
+      versions = controller_versions(controller) if versions.empty?
+      versions.each do |version|
+        resource_name_with_version = "#{version}##{get_resource_name(controller)}"
+        resource_description = get_resource_description(resource_name_with_version)
+        if resource_description.nil?
+          resource_description = define_resource_description(controller, version)
+        end
+        method_description = Apipie::MethodDescription.new(method_name, resource_description, dsl_data)
+        # we create separate method description for each version in
+        # case the method belongs to more versions. We return just one
+        # becuase the version doesn't matter for the purpose it's used
+        # (to wrap the original version with validators)
+        ret_method_description ||= method_description
+        resource_description.add_method_description(method_description)
+      end
+      return ret_method_description
+    end
+    # create new resource api description
+    def define_resource_description(controller, version, dsl_data = nil)
+      return if ignored?(controller)
+      resource_name = get_resource_name(controller)
+      resource_description = @resource_descriptions[version][resource_name]
+      if resource_description
+        # we already defined the description somewhere (probably in
+        # some method. Updating just meta data from dsl
+        resource_description.update_from_dsl_data(dsl_data) if dsl_data
+      else
+        resource_description = Apipie::ResourceDescription.new(controller, resource_name, dsl_data, version)
+        Apipie.debug("@resource_descriptions[#{version}][#{resource_name}] = #{resource_description}")
+        @resource_descriptions[version][resource_name] ||= resource_description
+      end
+      return resource_description
+    end
+    # recursively searches what versions has the controller specified in
+    # resource_description? It's used to derivate the default value of
+    # versions for methods.
+    def controller_versions(controller)
+      ret = @controller_versions[controller]
+      return ret unless ret.empty?
+      if controller == ActionController::Base || controller.nil?
+        return [Apipie.configuration.default_version]
+      else
+        return controller_versions(controller.superclass)
+      end
+    end
+    def set_controller_versions(controller, versions)
+      @controller_versions[controller] = versions
+    end
+    def add_param_group(controller, name, &block)
+      key = "#{controller.name}##{name}"
+      @param_groups[key] = block
+    end
+    def get_param_group(controller, name)
+      key = "#{controller.name}##{name}"
+      if @param_groups.has_key?(key)
+        return @param_groups[key]
+      else
+        raise "param group #{key} not defined"
+      end
+    end
+    # get api for given method
+    #
+    # There are two ways how this method can be used:
+    # 1) Specify both parameters
+    #   resource_name:
+    #       controller class - UsersController
+    #       string with resource name (plural) and version - "v1#users"
+    #   method_name: name of the method (string or symbol)
+    #
+    # 2) Specify only first parameter:
+    #   resource_name: string containing both resource and method name joined
+    #   with '#' symbol.
+    #   - "users#create" get default version
+    #   - "v2#users#create" get specific version
+    def get_method_description(resource_name, method_name = nil)
+      if resource_name.is_a?(String)
+        crumbs = resource_name.split('#')
+        if method_name.nil?
+          method_name = crumbs.pop
+        end
+        resource_name = crumbs.join("#")
+        resource_description = get_resource_description(resource_name)
+      elsif resource_name.respond_to? :apipie_resource_descriptions
+        resource_description = get_resource_description(resource_name)
+      else
+        raise ArgumentError.new("Resource #{resource_name} does not exists.")
+      end
+      unless resource_description.nil?
+        resource_description.method_description(method_name.to_sym)
+      end
+    end
+    alias :[] :get_method_description
+    # options:
+    # => "users"
+    # => "v2#users"
+    # =>  V2::UsersController
+    def get_resource_description(resource, version = nil)
+      if resource.is_a?(String)
+        crumbs = resource.split('#')
+        if crumbs.size == 2
+          version = crumbs.first
+        end
+        version ||= Apipie.configuration.default_version
+        if @resource_descriptions.has_key?(version)
+          return @resource_descriptions[version][crumbs.last]
+        end
+      else
+        resource_name = get_resource_name(resource)
+        if version
+          resource_name = "#{version}##{resource_name}"
+        end
+        if resource_name.nil?
+          return nil
+        end
+        resource_description = get_resource_description(resource_name)
+        if resource_description && resource_description.controller == resource
+          return resource_description
+        end
+      end
+    end
+    # get all versions of resource description
+    def get_resource_descriptions(resource)
+      available_versions.map do |version|
+        get_resource_description(resource, version)
+      end.compact
+    end
+    # get all versions of method description
+    def get_method_descriptions(resource, method)
+      get_resource_descriptions(resource).map do |resource_description|
+        resource_description.method_description(method.to_sym)
+      end.compact
+    end
+    def remove_method_description(resource, versions, method_name)
+      versions.each do |version|
+        resource = get_resource_name(resource)
+        if resource_description = get_resource_description("#{version}##{resource}")
+          resource_description.remove_method_description(method_name)
+        end
+      end
+    end
+    # initialize variables for gathering dsl data
+    def init_env
+      @resource_descriptions = HashWithIndifferentAccess.new { |h, version| h[version] = {} }
+      @controller_to_resource_id = {}
+      @param_groups = {}
+      # what versions does the controller belong in (specified by resource_description)?
+      @controller_versions = Hash.new { |h, controller| h[controller] = [] }
+    end
+    def recorded_examples
+      return @recorded_examples if @recorded_examples
+      tape_file = File.join(Rails.root,"doc","apipie_examples.yml")
+      if File.exists?(tape_file)
+        #if SafeYAML gem is enabled, it will load examples as an array of Hash, instead of hash
+        if defined? SafeYAML
+          @recorded_examples = YAML.load_file(tape_file, :safe=>false)
+        else
+          @recorded_examples = YAML.load_file(tape_file)
+        end
+      else
+        @recorded_examples = {}
+      end
+      @recorded_examples
+    end
+    def reload_examples
+      @recorded_examples = nil
+    end
+    def to_json(version, resource_name, method_name)
+      _resources = if resource_name.blank?
+        # take just resources which have some methods because
+        # we dont want to show eg ApplicationController as resource
+        resource_descriptions[version].inject({}) do |result, (k,v)|
+          result[k] = v.to_json unless v._methods.blank?
+          result
+        end
+      else
+        [@resource_descriptions[version][resource_name].to_json(method_name)]
+      end
+      url_args = Apipie.configuration.version_in_url ? version : ''
+      {
+        :docs => {
+          :name => Apipie.configuration.app_name,
+          :info => Apipie.app_info(version),
+          :copyright => Apipie.configuration.copyright,
+          :doc_url => Apipie.full_url(url_args),
+          :api_url => Apipie.api_base_url(version),
+          :resources => _resources
+        }
+      }
+    end
+    def api_controllers_paths
+      Dir[Apipie.configuration.api_controllers_matcher]
+    end
+    def reload_documentation
+      rails_mark_classes_for_reload
+      init_env
+      reload_examples
+      api_controllers_paths.each do |f|
+        load_controller_from_file f
+      end
+    end
+    # Is there a reason to interpret the DSL for this run?
+    # with specific setting for some environment there is no reason the dsl
+    # should be interpreted (e.g. no validations and doc from cache)
+    def active_dsl?
+      Apipie.configuration.validate? || ! Apipie.configuration.use_cache? || Apipie.configuration.force_dsl?
+    end
+    def get_resource_name(klass)
+      if klass.class == String
+        klass
+      elsif @controller_to_resource_id.has_key?(klass)
+        @controller_to_resource_id[klass]
+      elsif Apipie.configuration.namespaced_resources? && klass.respond_to?(:controller_path)
+        return nil if klass == ActionController::Base
+        path = klass.controller_path
+        path.gsub(version_prefix(klass), "").gsub("/", "-")
+      elsif klass.respond_to?(:controller_name)
+        return nil if klass == ActionController::Base
+        klass.controller_name
+      else
+        raise "Apipie: Can not resolve resource #{klass} name."
+      end
+    end
+    private
+    def version_prefix(klass)
+      version = controller_versions(klass).first
+      base_url = get_base_url(version)
+      return "/" if base_url.nil?
+      base_url[1..-1] + "/"
+    end
+    def get_base_url(version)
+      Apipie.configuration.api_base_url[version]
+    end
+    def get_resource_version(resource_description)
+      if resource_description.respond_to? :_version
+        resource_description._version
+      else
+        Apipie.configuration.default_version
+      end
+    end
+    def load_controller_from_file(controller_file)
+      controller_class_name = controller_file.gsub(/\A.*\/app\/controllers\//,"").gsub(/\.\w*\Z/,"").camelize
+      controller_class_name.constantize
+    end
+    def ignored?(controller, method = nil)
+      ignored = Apipie.configuration.ignored
+      return true if ignored.include?(controller.name)
+      return true if ignored.include?("#{controller.name}##{method}")
+    end
+    # Since Rails 3.2, the classes are reloaded only on file change.
+    # We need to reload all the controller classes to rebuild the
+    # docs, therefore we just force to reload all the code. This
+    # happens only when reload_controllers is set to true and only
+    # when showing the documentation.
+    def rails_mark_classes_for_reload
+      ActiveSupport::DescendantsTracker.clear
+      ActiveSupport::Dependencies.clear
+    end
+  end
+end

data/lib/apipie/client/generator.rb ADDED Viewed

@@ -0,0 +1,135 @@
+#!/bin/env ruby
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'thor'
+require 'thor/group'
+require 'fileutils'
+require 'active_support/inflector'
+require 'apipie/client/base'
+module Apipie
+  module Client
+    class Generator < Thor::Group
+      include Thor::Actions
+      # Define arguments and options
+      argument :name
+      argument :subject
+      argument :suffix
+      argument :version
+      attr_reader :doc, :resource, :resource_key
+      def initialize(*args)
+        super
+        @doc = Apipie.to_json(version)[:docs]
+      end
+      def self.source_root
+        File.expand_path("../template", __FILE__)
+      end
+      def self.destination_root(name, suffix)
+        File.join(FileUtils.pwd, "#{name}#{suffix}")
+      end
+      def self.start(client_name, subject = :all, suffix = '_client', version = nil)
+        name = client_name.parameterize.underscore
+        suffix = suffix.parameterize.underscore
+        super([name, subject, suffix, version], :destination_root => destination_root(name, suffix))
+      end
+      def all?
+        subject == :all
+      end
+      def generate_cli
+        full_name = "#{name}#{suffix}"
+        template("README.tt", "README")
+        template("Gemfile.tt", "Gemfile")
+        template("Rakefile.tt", "Rakefile")
+        template("a_name.gemspec.tt", "#{full_name}.gemspec")
+        template("lib/a_name.rb.tt", "lib/#{full_name}.rb")
+        template("lib/a_name/version.rb.tt", "lib/#{full_name}/version.rb")
+        create_file "lib/#{full_name}/documentation.json", JSON.dump(Apipie.to_json)
+        copy_file "lib/a_name/config.yml", "lib/#{full_name}/config.yml"
+        if all?
+          template("bin/bin.rb.tt", "bin/#{full_name}")
+          chmod("bin/#{full_name}", 0755)
+        end
+        doc[:resources].each do |key, resource|
+          @resource_key, @resource = key, resource
+          if all?
+            template("lib/a_name/commands/cli.rb.tt", "lib/#{full_name}/commands/#{resource_name}.thor")
+          end
+          template("lib/a_name/resources/resource.rb.tt", "lib/#{full_name}/resources/#{resource_name}.rb")
+        end
+      end
+      protected
+      def camelizer(string)
+        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$2.capitalize}" }
+      end
+      def class_base
+        @class_base ||= camelizer(name)
+      end
+      def class_suffix
+        @class_suffix ||= camelizer(suffix)
+      end
+      def plaintext(text)
+        text.gsub(/<.*?>/, '').gsub("\n", ' ').strip
+      end
+      # Resource related helper methods:
+      def resource_name
+        resource[:name].gsub(/\s/, "_").downcase.singularize
+      end
+      def api(method)
+        method[:apis].first
+      end
+      def params_in_path(method)
+        api(method)[:api_url].scan(/:([^\/]*)/).map(&:first)
+      end
+      def client_args(method)
+        params_in_path(method).dup
+      end
+      def substituted_url(method)
+        params_in_path(method).reduce(api(method)[:api_url]) { |u, p| u.sub(":#{p}", "\#{#{p}}") }
+      end
+      def transformation_hash(method)
+        method[:params].find_all { |p| p[:expected_type] == "hash" && !p[:params].nil? }.reduce({ }) do |h, p|
+          h.update(p[:name] => p[:params].map { |pp| pp[:name] })
+        end
+      end
+      def validation(method)
+        stringify = lambda do |object|
+          case object
+            when Hash
+              clone = object.dup
+              object.keys.each { |key| clone[key.to_s] = stringify[clone.delete(key)] }
+              clone
+            when Array
+              object.map { |value| stringify[value] }
+            else
+              object
+          end
+        end
+        Apipie::Client::Base.construct_validation_hash(stringify[method])
+      end
+    end
+  end
+end