apipie-rails 0.0.21 → 0.0.22

data/.travis.yml

@@ -3,3 +3,4 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0

data/CHANGELOG

@@ -2,6 +2,12 @@
  Changelog
 ===========
 
+v0.0.22
+-------
+
+* fix "named_resources" option
+* fix generating static files when concerns used
+
 v0.0.21
 -------
 

data/README.rst

@@ -2,7 +2,8 @@
  API Documentation Tool
 ========================
 
-.. image:: https://secure.travis-ci.org/Pajk/apipie-rails.png?branch=master
+.. image:: https://travis-ci.org/Pajk/apipie-rails.png?branch=master
+    :target: https://travis-ci.org/Pajk/apipie-rails
 
 Apipie-rails is a DSL and Rails engine for documenting you RESTful
 API. Instead of traditional use of ``#comments``, Apipie let's you
@@ -131,7 +132,6 @@ Example:
 
    resource_description do
      short 'Site members'
-     path '/users'
      formats ['json']
      param :id, Fixnum, :desc => "User ID", :required => false
      param :resource_param, Hash, :desc => 'Param description for all methods' do
@@ -147,20 +147,20 @@ Example:
         These can now be accessed in <tt>shared/header</tt> with:
           Headline: <%= headline %>
           First name: <%= person.first_name %>
-    
+
         If you need to find out whether a certain local variable has been
         assigned a value in a particular render call, you need to use the
         following pattern:
-    
+
         <% if local_assigns.has_key? :headline %>
            Headline: <%= headline %>
         <% end %>
-    
+
        Testing using <tt>defined? headline</tt> will not work. This is an
        implementation restriction.
-    
+
        === Template caching
-    
+
        By default, Rails will compile each template to a method in order
        to render it. When you alter a template, Rails will check the
        file's modification time and recompile it in development mode.
@@ -218,7 +218,7 @@ Example:
    param :regexp_param, /^[0-9]* years/, :desc => "regexp param"
    param :array_param, [100, "one", "two", 1, 2], :desc => "array validator"
    param :boolean_param, [true, false], :desc => "array validator with boolean"
-   param :proc_param, lambda { |val| 
+   param :proc_param, lambda { |val|
      val == "param value" ? true : "The only good value is 'param value'."
    }, :desc => "proc validator"
    description "method description"
@@ -656,23 +656,23 @@ So we create apipie_validators.rb initializer with this content:
 .. code:: ruby
 
    class IntegerValidator < Apipie::Validator::BaseValidator
-    
+
      def initialize(param_description, argument)
        super(param_description)
        @type = argument
      end
-    
+
      def validate(value)
        return false if value.nil?
        !!(value.to_s =~ /^[-+]?[0-9]+$/)
      end
-    
+
      def self.build(param_description, argument, options, block)
        if argument == Integer || argument == Fixnum
          self.new(param_description, argument)
        end
      end
-    
+
      def description
        "Must be #{@type}."
      end
@@ -832,10 +832,62 @@ tests or a running server, setting ``APIPIE_RECORD=examples``
    APIPIE_RECORD=examples rake test:functionals
    APIPIE_RECORD=examples rails server
 
-The data are written into ``doc/apipie_examples.yml``. By default,
+The data is written into ``doc/apipie_examples.yml``. By default,
 only the first example is shown for each action. You can customize
 this by setting ``show_in_doc`` attribute at each example.
 
+.. code::
+
+   --- !omap
+     - announcements#index:
+       - !omap
+         - verb: :GET
+         - path: /api/blabla/1
+         - versions:
+           - '1.0'
+         - query:
+         - request_data:
+         - response_data:
+           ...
+         - code: 200
+         - show_in_doc: 1   # If 1, show. If 0, do not show.
+         - recorded: true
+
+In RSpec you can add metadata to examples. We can use that feature
+to mark selected examples – the ones that perform the requests that we want to
+show as examples in the documentation.
+
+For example, we can add ``show_in_doc`` to examples, like this:
+
+.. code:: ruby
+
+   describe "This is the correct path" do
+     it "some test", :show_in_doc do
+       ....
+     end
+   end
+
+   context "These are edge cases" do
+     it "Can't authenticate" do
+       ....
+     end
+
+      it "record not found" do
+        ....
+      end
+   end
+
+And then configure RSpec in this way:
+
+.. code:: ruby
+
+   RSpec.configure do |config|
+     config.treat_symbols_as_metadata_keys_with_true_values = true
+     config.filter_run :show_in_doc => true if ENV['APIPIE_RECORD']
+   end
+
+This way, when running in recording mode, only the tests that has been marked with the
+``:show_in_doc`` metadata will be ran, and hence only those will be used as examples.
 
 ====================
  Bindings Generator

data/apipie-rails.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["pajkycz@gmail.com", "inecas@redhat.com"]
   s.homepage    = "http://github.com/Pajk/apipie-rails"
   s.summary     = %q{Rails REST API documentation tool}
-  s.description = %q{Maintain your API documentation up to date!}
+  s.description = %q{Rails REST API documentation tool}
 
 
   s.files         = `git ls-files`.split("\n")
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency "rails", ">= 3.0.10"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "sqlite3"
-  s.add_development_dependency "minitest"
+  s.add_development_dependency "minitest", '~> 4.0'
   s.add_development_dependency "maruku"
   s.add_development_dependency "RedCloth"
   s.add_development_dependency "rake"

data/lib/apipie/application.rb

@@ -292,8 +292,13 @@ module Apipie
 
     def version_prefix(klass)
       version = controller_versions(klass).first
-      path = Apipie.configuration.api_base_url[version]
-      path[1..-1] + "/"
+      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)

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.21'
+  VERSION = '0.0.22'
 end

data/lib/tasks/apipie.rake

@@ -124,7 +124,7 @@ namespace :apipie do
 
   def with_loaded_documentation
     Apipie.configuration.use_cache = false # we don't want to skip DSL evaluation
-    Dir[File.join(Rails.root, "app", "controllers", "**","*.rb")].each {|f| load f}
+    Apipie.reload_documentation
     yield
   end
 

data/spec/lib/application_spec.rb

@@ -4,19 +4,34 @@ describe Apipie::Application do
 
   describe "get_resource_name" do
     subject {Apipie.get_resource_name(Api::V2::Nested::ArchitecturesController)}
+
     context "with namespaced_resources enabled" do
       before { Apipie.configuration.namespaced_resources = true }
+      context "with a defined base url" do
+        
+        it "should not overwrite the parent resource" do
+          should_not eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
+        end
+        
+      end
 
-      it "should not overwrite the parent resource" do
-        subject.should_not eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
+      context "with an undefined base url" do
+        before {Apipie.app.stub(:get_base_url) { nil }}
+
+        it "should not raise an error" do
+          expect { Apipie.get_resource_name(Api::V2::ArchitecturesController) }.
+            not_to raise_error
+        end
       end
+
+      after { Apipie.configuration.namespaced_resources = false }
     end
 
     context "with namespaced_resources enabled" do
       before { Apipie.configuration.namespaced_resources = false }
 
       it "should overwrite the the parent" do
-        subject.should eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
+        should eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,17 +65,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: maruku
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +124,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Maintain your API documentation up to date!
+description: Rails REST API documentation tool
 email:
 - pajkycz@gmail.com
 - inecas@redhat.com