apipie-rails 0.0.13 → 0.0.14

data/spec/controllers/api/v1/architectures_controller_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Api::V1::ArchitecturesController do
+  describe "resource description" do
+    subject { Apipie.get_resource_description(Api::V1::ArchitecturesController, "1.0") }
+
+    it "should be version 1.0" do
+      subject._version.should eq('1.0')
+
+      Apipie.resource_descriptions['1.0'].size.should == 2
+      Apipie.resource_descriptions['1.0'].keys.should
+        include('architectures', 'base')
+    end
+
+    context "there is another version" do
+      let(:v2) { archv2 = Apipie.get_resource_description(Api::V2::ArchitecturesController, "2.0") }
+
+      it "should have unique doc url" do
+        subject.doc_url.should_not eq(v2.doc_url)
+      end
+
+      it "should have unique methods" do
+        subject._methods.keys.should include(:index)
+        v2._methods.keys.should include(:index)
+        subject._methods[:index].should_not eq(v2._methods[:index])
+      end
+
+    end
+  end
+end

data/spec/controllers/api/v2/architectures_controller_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Api::V2::ArchitecturesController do
+  describe "resource description" do
+    subject { Apipie.get_resource_description(Api::V2::ArchitecturesController, "2.0") }
+
+    it "should be version 2.0" do
+      subject._version.should eq('2.0')
+    end
+
+  end
+end

data/spec/controllers/apipies_controller_spec.rb

@@ -101,30 +101,36 @@ describe Apipie::ApipiesController do
 
     before do
       FileUtils.rm_r(cache_dir) if File.exists?(cache_dir)
-      FileUtils.mkdir_p(File.join(cache_dir, "apidoc", "resource"))
-      File.open(File.join(cache_dir, "apidoc.html"), "w") { |f| f << "apidoc.html cache" }
-      File.open(File.join(cache_dir, "apidoc.json"), "w") { |f| f << "apidoc.json cache" }
-      File.open(File.join(cache_dir, "apidoc", "resource.html"), "w") { |f| f << "resource.html cache" }
-      File.open(File.join(cache_dir, "apidoc", "resource", "method.html"), "w") { |f| f << "method.html cache" }
+      FileUtils.mkdir_p(File.join(cache_dir, "apidoc", "v1", "resource"))
+      File.open(File.join(cache_dir, "apidoc", "v1.html"), "w") { |f| f << "apidoc.html cache v1" }
+      File.open(File.join(cache_dir, "apidoc", "v2.html"), "w") { |f| f << "apidoc.html cache v2" }
+      File.open(File.join(cache_dir, "apidoc", "v1.json"), "w") { |f| f << "apidoc.json cache" }
+      File.open(File.join(cache_dir, "apidoc", "v1", "resource.html"), "w") { |f| f << "resource.html cache" }
+      File.open(File.join(cache_dir, "apidoc", "v1", "resource", "method.html"), "w") { |f| f << "method.html cache" }
 
       Apipie.configuration.use_cache = true
       Apipie.configuration.cache_dir = cache_dir
+      Apipie.configuration.default_version = 'v1'
     end
 
     after do
-      FileUtils.rm_r(cache_dir) if File.exists?(cache_dir)
+      # FileUtils.rm_r(cache_dir) if File.exists?(cache_dir)
     end
 
     it "uses the file in cache dir instead of generating the content on runtime" do
       get :index
-      response.body.should == "apidoc.html cache"
-      get :index, :format => "html"
-      response.body.should == "apidoc.html cache"
-      get :index, :format => "json"
+      response.body.should == "apidoc.html cache v1"
+      get :index, :version => 'v1'
+      response.body.should == "apidoc.html cache v1"
+      get :index, :version => 'v2'
+      response.body.should == "apidoc.html cache v2"
+      get :index, :version => 'v1', :format => "html"
+      response.body.should == "apidoc.html cache v1"
+      get :index, :version => 'v1', :format => "json"
       response.body.should == "apidoc.json cache"
-      get :index, :format => "html", :resource => "resource"
+      get :index, :version => 'v1', :format => "html", :resource => "resource"
       response.body.should == "resource.html cache"
-      get :index, :format => "html", :resource => "resource", :method => "method"
+      get :index, :version => 'v1', :format => "html", :resource => "resource", :method => "method"
       response.body.should == "method.html cache"
     end
 

data/spec/controllers/users_controller_spec.rb

@@ -21,23 +21,25 @@ end
 describe UsersController do
 
   describe "resource description" do
-    subject { a = Apipie.get_resource_description(UsersController) }
+    subject do
+      Apipie.get_resource_description(UsersController, Apipie.configuration.default_version)
+    end
 
     it "should contain all resource methods" do
       methods = subject._methods
       methods.count.should == 5
-      methods.should include("users#show")
-      methods.should include("users#create")
-      methods.should include("users#index")
-      methods.should include("users#two_urls")
+      methods.keys.should include(:show)
+      methods.keys.should include(:index)
+      methods.keys.should include(:create)
+      methods.keys.should include(:two_urls)
     end
 
     it "should contain info about resource" do
       subject._short_description.should eq('Site members')
       subject._id.should eq('users')
       subject._path.should eq('/users')
-      subject._version.should eq('1.0 - 3.4.2012')
-      subject._name.should eq('Members')
+      subject._version.should eq('development')
+      subject._name.should eq('Users')
       subject._formats.should eq(['json'])
     end
 
@@ -210,30 +212,30 @@ describe UsersController do
       a.formats.should eq(['json'])
       api = a.apis.first
       api.short_description.should eq("Create user")
-      api.api_url.should eq("/api/users")
+      api.path.should eq("/users")
       api.http_method.should eq("POST")
 
       b = Apipie.get_method_description(UsersController, :show)
       b.should eq(Apipie[UsersController, :show])
-      b.method.should eq(:show)
+      b.method.should eq('show')
       b.resource._id.should eq('users')
 
       b.apis.count.should == 1
       b.formats.should eq(['json', 'jsonp'])
       api = b.apis.first
       api.short_description.should eq("Show user profile")
-      api.api_url.should eq("#{Apipie.configuration.api_base_url}/users/:id")
+      api.path.should eq("/users/:id")
       api.http_method.should eq("GET")
       b.full_description.length.should be > 400
     end
 
     context "contain :see option" do
 
-      context "the key is valid" do 
+      context "the key is valid" do
         it "should contain reference to another method" do
           api = Apipie[UsersController, :see_another]
-          api.see.should eq('users#create')
-          Apipie['users#see_another'].should eq(Apipie[UsersController, :see_another])
+          api.see.should eq('development#users#create')
+          Apipie['development#users#see_another'].should eq(Apipie[UsersController, :see_another])
           api.see_url.should eq(Apipie[UsersController, :create].doc_url)
         end
       end
@@ -274,11 +276,11 @@ describe UsersController do
       a1, a2 = method_description.apis
 
       a1.short_description.should eq('Get company users')
-      a1.api_url.should eq('/api/company_users')
+      a1.path.should eq('/company_users')
       a1.http_method.should eq('GET')
 
       a2.short_description.should eq('Get users working in given company')
-      a2.api_url.should eq('/api/company/:id/users')
+      a2.path.should eq('/company/:id/users')
       a2.http_method.should eq('GET')
     end
 
@@ -288,7 +290,7 @@ describe UsersController do
         :errors => [{:code=>404, :description=>"Missing"},
                     {:code=>500, :description=>"Server crashed for some <%= reason %>"}],
         :examples => [],
-        :doc_url => "#{Apipie.configuration.doc_base_url}/users/two_urls",
+        :doc_url => "#{Apipie.configuration.doc_base_url}/development/users/two_urls",
         :formats=>["json"],
         :full_description => '',
         :params => [{:full_name=>"oauth",
@@ -326,16 +328,16 @@ describe UsersController do
                      :name=>"id", :full_name=>"id",
                      :expected_type=>"numeric"},
        ],
-        :name => :two_urls,
+        :name => 'two_urls',
         :apis => [
           {
             :http_method => 'GET',
             :short_description => 'Get company users',
-            :api_url => "#{Apipie.configuration.api_base_url}/company_users"
+            :api_url => "#{Apipie.api_base_url}/company_users"
           },{
             :http_method => 'GET',
             :short_description => 'Get users working in given company',
-            :api_url =>"#{Apipie.configuration.api_base_url}/company/:id/users"
+            :api_url =>"#{Apipie.api_base_url}/company/:id/users"
           }
         ]
       }
@@ -401,4 +403,39 @@ EOS2
     end
 
   end
+
+  describe "ignored option" do
+    class IgnoredController < ApplicationController; end
+
+    after do
+      Apipie.configuration.ignored = %w[]
+    end
+
+    describe "ignored action" do
+      before do
+        Apipie.configuration.ignored = %w[UsersController#ignore]
+      end
+
+      it "skips the listed  actions from the documentation" do
+        Apipie.define_method_description(UsersController, :ignore)
+        Apipie.get_method_description(UsersController, :ignore).should be_nil
+
+        Apipie.define_method_description(UsersController, :dont_ignore)
+        Apipie.get_method_description(UsersController, :dont_ignore).should_not be_nil
+      end
+    end
+
+    describe "ignored controller" do
+      before do
+        Apipie.configuration.ignored = %w[IgnoredController]
+      end
+
+      it "skips the listed controller from the documentation" do
+        Apipie.define_method_description(IgnoredController, :ignore)
+        Apipie.get_method_description(IgnoredController, :ignore).should be_nil
+        Apipie.define_method_description(IgnoredController, :ignore)
+        Apipie.get_method_description(IgnoredController, :ignore).should be_nil
+      end
+    end
+  end
 end

data/spec/dummy/app/controllers/api/base_controller.rb

@@ -0,0 +1,4 @@
+module Api
+  class BaseController < ActionController::Base
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+module Api
+  module V1
+    class BaseController < Api::BaseController
+      resource_description do
+        api_version '1.0'
+        app_info 'Version 1.0 description'
+        api_base_url '/api/v1'
+      end
+    end
+  end
+end

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

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

data/spec/dummy/app/controllers/api/v2/base_controller.rb

@@ -0,0 +1,11 @@
+module Api
+  module V2
+    class BaseController < Api::BaseController
+      resource_description do
+        api_version '2.0'
+        app_info 'Version 2.0 description'
+        api_base_url '/api/v2'
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 class TwitterExampleController < ApplicationController
   
   resource_description do
-    name 'Users'
+    name 'TwitterUsers'
     short_description 'Users are at the center of everything Twitter: they follow, they favorite, and tweet & retweet.'
     path '/twitter_example/'
     description "Long description of this resource."

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

@@ -1,16 +1,15 @@
 class UsersController < ApplicationController
 
   resource_description do
-    name 'Members'
     short 'Site members'
     path '/users'
-    version '1.0 - 3.4.2012'
     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
     end
+    api_version "development"
     error 404, "Missing"
     error 500, "Server crashed for some <%= reason %>"
     description <<-EOS
@@ -220,7 +219,7 @@ class UsersController < ApplicationController
   end
 
   api :GET, '/users/see_another', 'Boring method'
-  see 'users#create'
+  see 'development#users#create'
   desc 'This method is boring, look at users#create'
   def see_another
     render :text => 'This is very similar to create action'

data/spec/dummy/config/initializers/apipie.rb

@@ -1,14 +1,26 @@
 Apipie.configure do |config|
   config.app_name = "Test app"
   config.copyright = "© 2012 Pavel Pokorny"
+
+  # set default API version
+  # can be overriden in resource_description
+  # by default is it 1.0 if not specified anywhere
+  # this must be defined before api_base_url and app_info
+  config.default_version = "development"
+
   config.doc_base_url = "/apidoc"
+
+  # default version base url
+  # to define base url for specifid version use
+  # config.api_base_url[version] = url
+  # or define it in your base controller
   config.api_base_url = "/api"
 
   # set to true to turn on/off the cache. To generate the cache use:
   #
   #     rake apipie:cache
   #
-  # config.use_cache = Rails.env.production?
+  config.use_cache = Rails.env.production?
   # config.cache_dir = File.join(Rails.root, "public", "apipie-cache") # optional
 
   # set to enable/disable reloading controllers (and the documentation with it),
@@ -18,16 +30,27 @@ Apipie.configure do |config|
   # for reloading to work properly you need to specify where your api controllers are (like in Dir.glob):
   config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
 
-  # config.api_base_url = "/api"
   # config.markup = choose one of:
   #   Apipie::Markup::RDoc.new [default]
   #   Apipie::Markup::Markdown.new
   #   Apipie::Markup::Textile.new
   # or provide another class with to_html(text) instance method
+  # to disable markup, use
+  # config.markup = nil
+
   # config.validate = false
 
-  path = File.expand_path(File.dirname(__FILE__)+'/../../../../README.rdoc')
-  config.app_info = File.read(path)
+  # set all parameters as required by default
+  # if enabled, use param :name, val, :required => false for optional params
+  config.required_by_default = false
+
+  # set default version info, to describe specific version use
+  # config.app_info[version] = description
+  # or put this in your base or application controller
+  config.app_info = "Dummy app for testing"
+
+  # show debug informations
+  config.debug = false
 
   # set all parameters as required by default
   # if enabled, use param :name, val, :required => false for optional params
@@ -59,7 +82,7 @@ class Apipie::Validator::IntegerValidator < Apipie::Validator::BaseValidator
 
   def self.build(param_description, argument, options, block)
     if argument == Integer || argument == Fixnum
-      self.new(param_description, argument) 
+      self.new(param_description, argument)
     end
   end
 
@@ -72,7 +95,7 @@ class Apipie::Validator::IntegerValidator < Apipie::Validator::BaseValidator
   def description
     "Parameter has to be #{@type}."
   end
-  
+
   def expected_type
     'numeric'
   end