apipie-rails 0.0.11 → 0.0.12

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.11'
+  VERSION = '0.0.12'
 end

data/lib/tasks/apipie.rake

@@ -40,10 +40,15 @@ namespace :apipie do
   task :cache => :environment do
     with_loaded_documentation do
       cache_dir = Apipie.configuration.cache_dir
+      subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"")
+
       file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
+      Apipie.url_prefix = "./#{subdir}"
       doc = Apipie.to_json
       generate_index_page(file_base, doc, true)
+      Apipie.url_prefix = "../#{subdir}"
       generate_resource_pages(file_base, doc, true)
+      Apipie.url_prefix = "../../#{subdir}"
       generate_method_pages(file_base, doc, true)
     end
   end

data/rubygem-apipie-rails.spec

@@ -1,73 +1,112 @@
-%global gemname apipie-rails
+%global gem_name apipie-rails
 
-%global gemdir %(ruby -rubygems -e 'puts Gem::dir' 2>/dev/null)
-%global geminstdir %{gemdir}/gems/%{gemname}-%{version}
 %if 0%{?rhel} == 6 || 0%{?fedora} < 17
 %define rubyabi 1.8
 %else
-%define rubyabi 1.9
+%define rubyabi 1.9.1
+%endif
+%if 0%{?rhel} == 6
+%global gem_dir %(ruby -rubygems -e 'puts Gem::dir' 2>/dev/null)
+%global gem_docdir %{gem_dir}/doc/%{gem_name}-%{version}
+%global gem_cache %{gem_dir}/cache/%{gem_name}-%{version}.gem
+%global gem_spec %{gem_dir}/specifications/%{gem_name}-%{version}.gemspec
+%global gem_instdir %{gem_dir}/gems/%{gem_name}-%{version}
+%global gem_libdir %{gem_dir}/gems/%{gem_name}-%{version}/lib
 %endif
 
-Summary: Rails API documentation tool and client generator.
-Name: rubygem-%{gemname}
-Version: 0.0.9
-Release: 0%{?dist}
+Summary: Rails API documentation tool and client generator
+Name: rubygem-%{gem_name}
+Version: 0.0.11
+Release: 3%{?dist}
 Group: Development/Libraries
 License: MIT
 URL: http://github.com/Pajk/apipie-rails
-Source0: http://rubygems.org/downloads/%{gemname}-%{version}.gem
+Source0: http://rubygems.org/downloads/%{gem_name}-%{version}.gem
 Requires: ruby(abi) >= %{rubyabi}
 Requires: rubygems
+%if 0%{?fedora}
+BuildRequires: rubygems-devel
+%endif
 BuildRequires: ruby(abi) >= %{rubyabi}
 BuildRequires: rubygems
 BuildArch: noarch
-Provides: rubygem(%{gemname}) = %{version}
+Provides: rubygem(%{gem_name}) = %{version}
 
 %description
 This gem adds new methods to Rails controllers that can be used to describe
-resources exposed by API. Informations entered with provided DSL are used
+resources exposed by API. Information entered with provided DSL are used
 to generate documentation, client or to validate incoming requests.
 
+%package doc
+BuildArch:  noarch
+Requires:   %{name} = %{version}-%{release}
+Summary:    Documentation for rubygem-%{gem_name}
+
+%description doc
+This package contains documentation for rubygem-%{gem_name}.
+
 %prep
 %setup -q -c -T
-mkdir -p .%{gemdir}
-gem install --local --install-dir .%{gemdir} \
-            --force %{SOURCE0}
+mkdir -p .%{gem_dir}
+gem install --local --install-dir .%{gem_dir} \
+            --force %{SOURCE0} --no-rdoc --no-ri
 
 %build
 
 %install
-mkdir -p %{buildroot}%{gemdir}
-cp -a .%{gemdir}/* \
-        %{buildroot}%{gemdir}/
-
+mkdir -p %{buildroot}%{gem_dir}
+cp -a .%{gem_dir}/* \
+        %{buildroot}%{gem_dir}/
 
 %files
-%{geminstdir}/app
-%{geminstdir}/lib
-%{geminstdir}/apipie-rails.gemspec
-%{geminstdir}/Gemfile
-%{geminstdir}/Gemfile.lock
-%{geminstdir}/Rakefile
-%{gemdir}/specifications/%{gemname}-%{version}.gemspec
-
-%exclude %{geminstdir}/spec
-%exclude %{geminstdir}/rel-eng
-%exclude %{geminstdir}/.gitignore
-%exclude %{geminstdir}/.rspec
-%exclude %{geminstdir}/.rvmrc
-%exclude %{geminstdir}/.travis.yml
-%exclude %{geminstdir}/rubygem-apipie-rails.spec
-%exclude %{geminstdir}/.yardoc
-%exclude %{gemdir}/cache/%{gemname}-%{version}.gem
-%exclude %{gemdir}/doc/%{gemname}-%{version}
-
-%doc %{geminstdir}/MIT-LICENSE
-%doc %{geminstdir}/README.rdoc
-%doc %{geminstdir}/APACHE-LICENSE-2.0
-%doc %{geminstdir}/NOTICE
+%dir %{gem_instdir}
+%{gem_instdir}/app
+%{gem_instdir}/lib
+%exclude %{gem_instdir}/Gemfile.lock
+%exclude %{gem_cache}
+%{gem_spec}
+%doc %{gem_instdir}/MIT-LICENSE
+%doc %{gem_instdir}/APACHE-LICENSE-2.0
+
+%exclude %{gem_instdir}/spec
+%exclude %{gem_instdir}/rel-eng
+%exclude %{gem_instdir}/.gitignore
+%exclude %{gem_instdir}/.rspec
+%exclude %{gem_instdir}/.rvmrc
+%exclude %{gem_instdir}/.travis.yml
+%exclude %{gem_instdir}/rubygem-apipie-rails.spec
+%exclude %{gem_dir}/cache/%{gem_name}-%{version}.gem
+
+%files doc
+%doc %{gem_instdir}/MIT-LICENSE
+%doc %{gem_instdir}/README.rdoc
+%doc %{gem_instdir}/NOTICE
+%{gem_instdir}/Rakefile
+%{gem_instdir}/Gemfile
+%{gem_instdir}/%{gem_name}.gemspec
 
 %changelog
+* Fri Sep 07 2012 Miroslav Suchý <msuchy@redhat.com> 0.0.11-3
+- summary should not end with dot (msuchy@redhat.com)
+- fix spelling (msuchy@redhat.com)
+- do not package Gemfile.lock (msuchy@redhat.com)
+
+* Fri Aug 17 2012 Ivan Necas <inecas@redhat.com> 0.0.11-2
+- fix building for F17 reusing the macros from rubygem- devel
+
+* Wed Aug 15 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.11-1
+- apipie-rails v0.0.11
+- cli client improvements
+
+* Tue Jul 31 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.9-2
+- exclude documentation from rpm
+
+* Tue Jul 31 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.9-1
+- New version of apipie-rails gem (pajkycz@gmail.com)
+- fixed client generator
+- resource level error descriptions
+- response supported formats
+
 * Thu Jul 26 2012 Pavel Pokorný <pajkycz@gmail.com> 0.0.8-3
 - Require rubygems in spec file
 

data/spec/controllers/users_controller_spec.rb

@@ -85,15 +85,15 @@ describe UsersController do
       end
 
       it "should fail if required parameter is missing" do
-        lambda { get :show, :id => 5 }.should raise_error(ArgumentError, / session /)
+        lambda { get :show, :id => 5 }.should raise_error(Apipie::ParamMissing, /\bsession\b/)
       end
 
-      it "should work with Type validator" do
+      it "should work with custom Type validator" do
         lambda {
           get :show,
               :id => "not a number",
               :session => "secret_hash"
-        }.should raise_error(ArgumentError, / id /)
+        }.should raise_error(Apipie::ParamError, /id/) # old-style error rather than ParamInvalid
       end
 
       it "should work with Regexp validator" do
@@ -108,7 +108,7 @@ describe UsersController do
               :id => 5,
               :session => "secret_hash",
               :regexp_param => "ten years"
-        }.should raise_error(ArgumentError, / regexp_param /)
+        }.should raise_error(Apipie::ParamInvalid, /regexp_param/)
       end
 
       it "should work with Array validator" do
@@ -126,14 +126,14 @@ describe UsersController do
               :id => 5,
               :session => "secret_hash",
               :array_param => "blabla"
-        }.should raise_error(ArgumentError, / array_param /)
+        }.should raise_error(Apipie::ParamInvalid, /array_param/)
 
         lambda {
           get :show,
               :id => 5,
               :session => "secret_hash",
               :array_param => 3
-        }.should raise_error(ArgumentError, / array_param /)
+        }.should raise_error(Apipie::ParamInvalid, /array_param/)
       end
 
       it "should work with Proc validator" do
@@ -142,7 +142,7 @@ describe UsersController do
               :id => 5,
               :session => "secret_hash",
               :proc_param => "asdgsag"
-        }.should raise_error(ArgumentError, / proc_param /)
+        }.should raise_error(Apipie::ParamInvalid, /proc_param/)
 
         get :show,
             :id => 5,
@@ -167,11 +167,11 @@ describe UsersController do
 
         lambda {
           post :create, :user => { :name => "root", :pass => "12345", :membership => "____" }
-        }.should raise_error(ArgumentError, / membership /)
+        }.should raise_error(Apipie::ParamInvalid, /membership/)
 
         lambda {
           post :create, :user => { :name => "root" }
-        }.should raise_error(ArgumentError, / pass /)
+        }.should raise_error(Apipie::ParamInvalid, /pass/)
 
         post :create, :user => { :name => "root", :pass => "pwd" }
         assert_response :success
@@ -181,7 +181,7 @@ describe UsersController do
         params = Apipie[UsersController, :create].to_json[:params]
         params.should include(:name => "facts",
                               :full_name => "facts",
-                              :validator => "Parameter has to be Hash.",
+                              :validator => "Must be Hash",
                               :description => "\n<p>Additional optional facts about the user</p>\n",
                               :required => false,
                               :allow_nil => true,
@@ -263,8 +263,8 @@ describe UsersController do
 
     it "should contain all params description" do
       a = Apipie.get_method_description(UsersController, :show)
-      a.params.count.should == 8
-      a.instance_variable_get('@params_ordered').count.should == 6
+      a.params.count.should == 9
+      a.instance_variable_get('@params_ordered').count.should == 7
     end
 
     it "should contain all api method description" do
@@ -294,11 +294,11 @@ describe UsersController do
         :params => [{:full_name=>"oauth",
                      :required=>false,
                      :allow_nil => false,
-                     :validator=>"Parameter has to be String.",
+                     :validator=>"Must be String",
                      :description=>"\n<p>Authorization</p>\n",
                      :name=>"oauth",
                      :expected_type=>"string"},
-                    {:validator=>"Has to be hash.",
+                    {:validator=>"Must be a Hash",
                      :description=>"\n<p>Param description for all methods</p>\n",
                      :expected_type=>"hash",
                      :allow_nil=>false,
@@ -308,13 +308,13 @@ describe UsersController do
                      :params=>
                       [{:required=>true,
                         :allow_nil => false,
-                        :validator=>"Parameter has to be String.",
+                        :validator=>"Must be String",
                         :description=>"\n<p>Username for login</p>\n",
                         :name=>"ausername", :full_name=>"resource_param[ausername]",
                         :expected_type=>"string"},
                        {:required=>true,
                         :allow_nil => false,
-                        :validator=>"Parameter has to be String.",
+                        :validator=>"Must be String",
                         :description=>"\n<p>Password for login</p>\n",
                         :name=>"apassword", :full_name=>"resource_param[apassword]",
                         :expected_type=>"string"}
@@ -394,8 +394,11 @@ EOS2
       param = a.params[:proc_param]
       param.desc.should eq("\n<p>proc validator</p>\n")
       param.validator.class.should be(Apipie::Validator::ProcValidator)
+
+      param = a.params[:briefer_dsl]
+      param.desc.should eq("\n<p>You dont need :desc =&gt; from now</p>\n")
+      param.validator.class.should be(Apipie::Validator::TypeValidator)
     end
 
   end
-
 end

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

@@ -177,6 +177,7 @@ class UsersController < ApplicationController
   param :proc_param, lambda { |val|
     val == "param value" ? true : "The only good value is 'param value'."
   }, :desc => "proc validator"
+  param :briefer_dsl, String, "You dont need :desc => from now"
   def show
     unless params[:session] == "secret_hash"
       render :text => "Not authorized", :status => 401

data/spec/dummy/app/views/layouts/application.html.erb

@@ -1,14 +1,21 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag :all %>
-  <%= javascript_include_tag :defaults %>
-  <%= csrf_meta_tag %>
+  <title>Dummy API</title>
+  <%= Apipie.include_stylesheets %>
 </head>
-<body>
-
-<%= yield %>
+<body style='background-color: #F5F6F7;'>
+<div class="container">
+  <div class="row">
+    <div id='container' style='background-color: white;padding:10px;box-shadow:0px 0px 10px rgba(68,68,68,0.6);'>
+      <%= yield %>
+      <%= render 'disqus' if Apipie.configuration.use_disqus? %>
+    </div>
+  </div>
+  <hr>
+  <footer><%= yield :apipie_footer %></footer>
+</div>
 
+<%= Apipie.include_javascripts %>
 </body>
 </html>

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

@@ -28,6 +28,19 @@ Apipie.configure do |config|
 
   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
+
+  # use custom layout
+  # use Apipie.include_stylesheets and Apipie.include_javascripts
+  # to include apipies css and js
+  config.layout = "application"
+
+  # specify disqus site shortname to show discusion on each page
+  # to show it in custom layout, use `render 'disqus' if Apipie.configuration.use_disqus?`
+  # config.disqus_shortname = 'paveltest'
 end
 
 
@@ -51,6 +64,8 @@ class Apipie::Validator::IntegerValidator < Apipie::Validator::BaseValidator
   end
 
   def error
+    # Newer style is to return an instance of ParamInvalid.  Keeping this
+    # to test backwards compatibility.
     "Parameter #{param_name} expecting to be #{@type.name}, got: #{@error_value.class.name}"
   end
 

data/spec/lib/parameter_description_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Apipie::ParamDescription do
+
+  describe "required_by_default config option" do
+
+    context "parameters required by default" do
+
+      before { Apipie.configuration.required_by_default = true }
+
+      it "should set param as required by default" do
+        param = Apipie::ParamDescription.new(:required_by_default, String)
+        param.required.should be_true
+      end
+
+      it "should be possible to set param as optional" do
+        param = Apipie::ParamDescription.new(:optional, String, :required => false)
+        param.required.should be_false
+      end
+
+    end
+
+    context "parameters optional by default" do
+
+      before { Apipie.configuration.required_by_default = false }
+
+      it "should set param as optional by default" do
+        param = Apipie::ParamDescription.new(:optional_by_default, String)
+        param.required.should be_false
+      end
+
+      it "should be possible to set param as required" do
+        param = Apipie::ParamDescription.new(:required, String, 'description','required' => true)
+        param.required.should be_true
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: apipie-rails
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 0
-  - 11
-  version: 0.0.11
+  - 12
+  version: 0.0.12
 platform: ruby
 authors: 
 - Pavel Pokorny
@@ -16,12 +16,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-14 00:00:00 Z
+date: 2012-10-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: rspec-rails
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +30,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
   type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: rails
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -46,12 +46,12 @@ dependencies:
         - 0
         - 10
         version: 3.0.10
-  requirement: *id002
   type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: sqlite3
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,12 +60,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id003
   type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: minitest
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,12 +74,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
   type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: redcarpet
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -88,12 +88,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id005
   type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: RedCloth
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -102,12 +102,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id006
   type: :development
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: rake
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -116,12 +116,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id007
   type: :development
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: rest-client
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -130,12 +130,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id008
   type: :development
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  prerelease: false
   name: oauth
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -144,8 +144,8 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id009
   type: :development
+  version_requirements: *id009
 description: Maintain your API documentation up to date!
 email: 
 - pajkycz@gmail.com
@@ -179,8 +179,10 @@ files:
 - app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css
 - app/public/apipie/stylesheets/bundled/bootstrap.min.css
 - app/public/apipie/stylesheets/bundled/prettify.css
+- app/views/apipie/apipies/_disqus.html.erb
 - app/views/apipie/apipies/_params.html.erb
 - app/views/apipie/apipies/_params_plain.html.erb
+- app/views/apipie/apipies/apipie_404.html.erb
 - app/views/apipie/apipies/index.html.erb
 - app/views/apipie/apipies/method.html.erb
 - app/views/apipie/apipies/plain.html.erb
@@ -190,21 +192,25 @@ files:
 - lib/apipie-rails.rb
 - lib/apipie/apipie_module.rb
 - lib/apipie/application.rb
+- lib/apipie/client/base.rb
+- lib/apipie/client/cli_command.rb
 - lib/apipie/client/generator.rb
+- lib/apipie/client/main.rb
+- lib/apipie/client/rest_client_oauth.rb
 - lib/apipie/client/template/Gemfile.tt
 - lib/apipie/client/template/README.tt
 - lib/apipie/client/template/Rakefile.tt
-- lib/apipie/client/template/base.rb.tt
-- lib/apipie/client/template/bin.rb.tt
-- lib/apipie/client/template/cli.rb.tt
-- lib/apipie/client/template/cli_command.rb.tt
-- lib/apipie/client/template/client.gemspec.tt
-- lib/apipie/client/template/client.rb.tt
-- lib/apipie/client/template/resource.rb.tt
-- lib/apipie/client/template/rest_client_oauth.rb.tt
-- lib/apipie/client/template/version.rb.tt
+- lib/apipie/client/template/a_name.gemspec.tt
+- lib/apipie/client/template/bin/bin.rb.tt
+- lib/apipie/client/template/lib/a_name.rb.tt
+- lib/apipie/client/template/lib/a_name/commands/cli.rb.tt
+- lib/apipie/client/template/lib/a_name/config.yml
+- lib/apipie/client/template/lib/a_name/resources/resource.rb.tt
+- lib/apipie/client/template/lib/a_name/version.rb.tt
+- lib/apipie/client/thor.rb
 - lib/apipie/dsl_definition.rb
 - lib/apipie/error_description.rb
+- lib/apipie/errors.rb
 - lib/apipie/extractor.rb
 - lib/apipie/extractor/collector.rb
 - lib/apipie/extractor/recorder.rb
@@ -261,6 +267,8 @@ files:
 - spec/dummy/public/javascripts/rails.js
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
+- spec/lib/param_description_spec.rb
+- spec/lib/parameter_description_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/Pajk/apipie-rails
 licenses: []
@@ -333,4 +341,6 @@ test_files:
 - spec/dummy/public/javascripts/rails.js
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
+- spec/lib/param_description_spec.rb
+- spec/lib/parameter_description_spec.rb
 - spec/spec_helper.rb