apipie-rails 0.0.24 → 0.1.0

data/spec/dummy/app/controllers/api/v1/architectures_controller.rb

@@ -18,6 +18,7 @@ module Api
       def_param_group :arch do
         param :architecture, Hash, :required => true do
           param :name, String, :required => true
+          param :description, String, :required => true
           param_group :timestamps
         end
       end

data/spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb

@@ -1,29 +1,31 @@
 module Api
   module V2
-    class Nested::ArchitecturesController < V2::BaseController
-      resource_description { name 'Architectures' }
-      api :GET, "/nested/architectures/", "List all nested architectures."
-      def index
-      end
+    module Nested
+      class ArchitecturesController < V2::BaseController
+        resource_description { name 'Architectures' }
+        api :GET, "/nested/architectures/", "List all nested architectures."
+        def index
+        end
 
-      api :GET, "/nested/architectures/:id/", "Show a nested architecture."
-      def show
-      end
+        api :GET, "/nested/architectures/:id/", "Show a nested architecture."
+        def show
+        end
 
-      api :POST, "/nested/architectures/", "Create a nested architecture."
-      param_group :arch, Api::V1::ArchitecturesController
-      def create
-      end
+        api :POST, "/nested/architectures/", "Create a nested architecture."
+        param_group :arch, Api::V1::ArchitecturesController
+        def create
+        end
 
-      api :PUT, "/nested/architectures/:id/", "Update a nested architecture."
-      param :architecture, Hash, :required => true do
-        param :name, String
-      end
-      def update
-      end
+        api :PUT, "/nested/architectures/:id/", "Update a nested architecture."
+        param :architecture, Hash, :required => true do
+          param :name, String
+        end
+        def update
+        end
 
-      api :DELETE, "/architecturess/:id/", "Delete a nested architecture."
-      def destroy
+        api :DELETE, "/architecturess/:id/", "Delete a nested architecture."
+        def destroy
+        end
       end
     end
   end

data/spec/dummy/app/controllers/concerns/sample_controller.rb

@@ -1,39 +1,41 @@
-module Concerns::SampleController
-  extend Apipie::DSL::Concern
+module Concerns
+  module SampleController
+    extend Apipie::DSL::Concern
 
-  api :GET, '/:controller_path'
-  def index
-    render :text => "OK #{params.inspect}"
-  end
+    api :GET, '/:controller_path'
+    def index
+      render :text => "OK #{params.inspect}"
+    end
 
-  api :GET, '/:resource_id/:id'
-  param :id, String
-  def show
-    render :text => "OK #{params.inspect}"
-  end
+    api :GET, '/:resource_id/:id'
+    param :id, String
+    def show
+      render :text => "OK #{params.inspect}"
+    end
 
-  def_param_group :concern do
-    param :concern, Hash, :required => true, :action_aware => true do
-      param :name, String, "Name of a :concern"
-      param :concern_type, String
+    def_param_group :concern do
+      param :concern, Hash, :required => true, :action_aware => true do
+        param :name, String, "Name of a :concern"
+        param :concern_type, String
+      end
     end
-  end
 
-  api :POST, '/:resource_id', "Create a :concern"
-  param_group :concern
-  def create
-    render :text => "OK #{params.inspect}"
-  end
+    api :POST, '/:resource_id', "Create a :concern"
+    param_group :concern
+    def create
+      render :text => "OK #{params.inspect}"
+    end
 
-  api :PUT, '/:resource_id/:id'
-  param :id, String
-  param_group :concern
-  def update
-    render :text => "OK #{params.inspect}"
-  end
+    api :PUT, '/:resource_id/:id'
+    param :id, String
+    param_group :concern
+    def update
+      render :text => "OK #{params.inspect}"
+    end
 
-  api :GET, '/:resource_id/:custom_subst'
-  def custom
-    render :text => "OK #{params.inspect}"
+    api :GET, '/:resource_id/:custom_subst'
+    def custom
+      render :text => "OK #{params.inspect}"
+    end
   end
 end

data/spec/dummy/app/controllers/users_controller.rb

@@ -5,13 +5,16 @@ class UsersController < ApplicationController
     path '/users'
     formats ['json']
     param :id, Fixnum, :desc => "User ID", :required => false
-    param :resource_param, Hash, :desc => 'Param description for all methods' do
-      param :ausername, String, :desc => "Username for login", :required => true
-      param :apassword, String, :desc => "Password for login", :required => true
+    param :legacy_param, Hash, :desc => 'Deprecated parameter not documented', :show => false, :required => false do
+      param :resource_param, Hash, :desc => 'Param description for all methods' do
+        param :ausername, String, :desc => "Username for login", :required => true
+        param :apassword, String, :desc => "Password for login", :required => true
+      end
     end
     api_version "development"
-    error 404, "Missing"
+    error 404, "Missing", :meta => {:some => "metadata"}
     error 500, "Server crashed for some <%= reason %>"
+    meta :new_style => true, :author => { :name => 'John', :surname => 'Doe' }
     description <<-EOS
       == Long description
 
@@ -177,6 +180,13 @@ class UsersController < ApplicationController
     val == "param value" ? true : "The only good value is 'param value'."
   }, :desc => "proc validator"
   param :briefer_dsl, String, "You dont need :desc => from now"
+  param :meta_param, String, :desc => "A parameter with some additional metadata", :meta => [:some, :more, :info]
+  meta :success_message => "Some message"
+  param :hash_param, Hash, :desc => "Hash param" do
+    param :dummy_hash, Hash do
+      param :dummy_2, String, :required => true
+    end
+  end
   def show
     unless params[:session] == "secret_hash"
       render :text => "Not authorized", :status => 401
@@ -212,8 +222,11 @@ class UsersController < ApplicationController
     render :text => "OK #{params.inspect}"
   end
 
-  api :PUT, "/users/:id", "Create user"
+  api :PUT, "/users/:id", "Update an user"
   param_group :user
+  param :comments, Array do
+    param :comment, String
+  end
   def update
     render :text => "OK #{params.inspect}"
   end

data/spec/lib/method_description_spec.rb

@@ -4,6 +4,28 @@ describe Apipie::MethodDescription do
 
   let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
 
+  describe "metadata" do
+
+    before(:each) do
+      @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
+    end
+
+    it "should return nil when no metadata is provided" do
+      method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      method.to_json[:metadata].should == nil
+    end
+
+    it "should return the metadata" do
+      meta = {
+        :lenght => 32,
+        :weight => '830g'
+      }
+      method = Apipie::MethodDescription.new(:a, @resource, dsl_data.update(:meta => meta))
+      method.to_json[:metadata].should == meta
+    end
+
+  end
+
   describe "params descriptions" do
 
     before(:each) do

data/spec/lib/param_description_spec.rb

@@ -12,6 +12,73 @@ describe Apipie::ParamDescription do
     Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
   end
 
+  describe "metadata" do
+
+    it "should return nil when no metadata is provided" do
+      param = Apipie::ParamDescription.new(method_desc, :some_param, String)
+      param.to_json[:metadata].should == nil
+    end
+
+    it "should return the metadata" do
+      meta = {
+        :lenght => 32,
+        :weight => '830g'
+      }
+      param = Apipie::ParamDescription.new(method_desc, :some_param, String, :meta => meta)
+      param.to_json[:metadata].should == meta
+    end
+
+  end
+
+  describe "show option" do
+
+    it "should return true when show option is not provided" do
+      param = Apipie::ParamDescription.new(method_desc, :some_param, String)
+      param.to_json[:show].should == true
+    end
+
+    it "should return the show option" do
+      param = Apipie::ParamDescription.new(method_desc, :some_param, String, :show => true)
+      param.to_json[:show].should == true
+
+      param = Apipie::ParamDescription.new(method_desc, :some_param, String, :show => false)
+      param.to_json[:show].should == false
+    end
+
+  end
+
+  describe "full_name" do
+    context "with no nested parameters" do
+
+      it "should return name" do
+        param = Apipie::ParamDescription.new(method_desc, :some_param, String)
+        param.to_json[:full_name].should == 'some_param'
+      end
+
+    end
+
+    context "with nested parameters" do
+
+      it "should return the parameter's name nested in the parents name" do
+        parent_param = Apipie::ParamDescription.new(method_desc, :parent, String)
+        nested_param = Apipie::ParamDescription.new(method_desc, :nested, String, :parent => parent_param)
+
+        nested_param.to_json[:full_name].should == 'parent[nested]'
+      end
+
+      context "with the parent parameter set to not show" do
+
+        it "should return just the parameter's name" do
+          parent_param = Apipie::ParamDescription.new(method_desc, :parent, String, :show => false)
+          nested_param = Apipie::ParamDescription.new(method_desc, :nested, String, :parent => parent_param)
+
+          nested_param.to_json[:full_name].should == 'nested'
+        end
+
+      end
+    end
+  end
+
   describe "validator selection" do
 
     it "should allow nil validator" do
@@ -171,4 +238,14 @@ describe Apipie::ParamDescription do
       end
     end
   end
+
+
+  describe "Array with classes" do
+    it "should be valid for objects included in class array" do
+      param = Apipie::ParamDescription.new(method_desc, :param, [Fixnum, String])
+      expect { param.validate("1") }.should_not raise_error
+      expect { param.validate(Fixnum) }.should raise_error
+    end
+  end
+
 end

data/spec/lib/rake_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe 'rake tasks' do
+  include_context "rake"
+
+  before do
+    Apipie.stub(:reload_documentation)
+    subject.invoke(*task_args)
+  end
+
+  describe 'static pages' do
+
+    let(:apidoc_html) do
+      File.read("#{doc_output}.html")
+    end
+
+    let(:doc_output) do
+      File.join(::Rails.root, 'doc', 'apidoc')
+    end
+
+    after do
+      Dir["#{doc_output}*"].each { |static_file| FileUtils.rm_rf(static_file) }
+    end
+
+    describe 'apipie:static' do
+      it "generates static files for the default version of apipie docs" do
+        apidoc_html.should =~ /Test app #{Apipie.configuration.default_version}/
+      end
+
+      it "includes the stylesheets" do
+        apidoc_html.should include('./apidoc/stylesheets/bundled/bootstrap.min.css')
+        File.should exist(File.join(doc_output, 'stylesheets/bundled/bootstrap.min.css'))
+      end
+    end
+
+    describe 'apipie:static[2.0]' do
+      it "generates static files for the default version of apipie docs" do
+        apidoc_html.should =~ /Test app 2.0/
+      end
+
+      it "includes the stylesheets" do
+        apidoc_html.should include('./apidoc/stylesheets/bundled/bootstrap.min.css')
+        File.should exist(File.join(doc_output, 'stylesheets/bundled/bootstrap.min.css'))
+      end
+    end
+  end
+
+  describe 'apipie:cache' do
+    let(:cache_output) do
+      File.join(::Rails.root, 'public', 'apipie-cache')
+    end
+
+    let(:apidoc_html) do
+      File.read("#{cache_output}.html")
+    end
+
+    after do
+      Dir["#{cache_output}*"].each { |static_file| FileUtils.rm_rf(static_file) }
+    end
+
+    it "generates cache files" do
+      File.should exist(File.join(cache_output, 'apidoc.html'))
+      File.should exist(File.join(cache_output, 'apidoc/development.html'))
+      File.should exist(File.join(cache_output, 'apidoc/development/users.html'))
+
+    end
+  end
+end

data/spec/lib/resource_description_spec.rb

@@ -4,6 +4,24 @@ describe Apipie::ResourceDescription do
 
   let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
 
+  describe "metadata" do
+
+    it "should return nil when no metadata is provided" do
+      resource = Apipie::ResourceDescription.new(ApplicationController, "dummy", dsl_data)
+      resource.to_json[:metadata].should == nil
+    end
+
+    it "should return the metadata" do
+      meta = {
+        :lenght => 32,
+        :weight => '830g'
+      }
+      resource = Apipie::ResourceDescription.new(ApplicationController, "dummy", dsl_data.update(:meta => meta))
+      resource.to_json[:metadata].should == meta
+    end
+
+  end
+
   describe "methods descriptions" do
 
     before(:each) do

data/spec/lib/validator_spec.rb

@@ -43,4 +43,13 @@ describe Apipie::Validator do
     end
 
   end
+
+  describe 'ArrayClassValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Fixnum, String])
+      validator.validate("1").should be_true
+      validator.validate(1).should be_true
+      validator.validate({ 1 => 1 }).should be_false
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'bundler/setup'
 
 ENV["RAILS_ENV"] ||= 'test'
+APIPIE_ROOT = File.expand_path('../..', __FILE__)
 require File.expand_path("../dummy/config/environment", __FILE__)
 
 require 'rspec/rails'
@@ -11,7 +12,7 @@ require 'apipie-rails'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
 
 RSpec.configure do |config|
 

data/spec/support/rake.rb

@@ -0,0 +1,21 @@
+require "rake"
+
+# inspired by http://robots.thoughtbot.com/test-rake-tasks-like-a-boss
+shared_context "rake" do
+  let(:rake)      { Rake::Application.new }
+  let(:task_name) { rake.parse_task_string(self.class.description).first }
+  let(:task_args) { rake.parse_task_string(self.class.description).last }
+  let(:task_path) { "lib/tasks/apipie" }
+  subject         { rake[task_name] }
+
+  def loaded_files_excluding_current_rake_file
+    $".reject {|file| file == File.expand_path("#{task_path}.rake", APIPIE_ROOT) }
+  end
+
+  before do
+    Rake.application = rake
+    Rake.application.rake_require(task_path, [APIPIE_ROOT], loaded_files_excluding_current_rake_file)
+
+    Rake::Task.define_task(:environment)
+  end
+end