apipie-rails 0.0.16 → 0.0.17

data/CHANGELOG

@@ -2,10 +2,16 @@
  Changelog
 ===========
 
+v0.0.17
+-------
+
+* support for multiple see links at action and ability to provide
+  description of see links
+
 v0.0.16
 -------
 
-* Fix getting started being rendered even when documentation was available.
+* Fix getting started being rendered even when documentation was available
 
 v0.0.15
 -------

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    apipie-rails (0.0.13)
+    apipie-rails (0.0.16)
+      rails (>= 3.0.10)
 
 GEM
   remote: http://rubygems.org/
@@ -51,7 +52,6 @@ GEM
     mime-types (1.19)
     minitest (3.2.0)
     multi_json (1.3.6)
-    oauth (0.4.6)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -78,8 +78,6 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -101,10 +99,10 @@ GEM
     syntax (1.0.0)
     thor (0.15.4)
     tilt (1.3.3)
-    treetop (1.4.10)
+    treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby
@@ -114,9 +112,6 @@ DEPENDENCIES
   apipie-rails!
   maruku
   minitest
-  oauth
-  rails (>= 3.0.10)
   rake
-  rest-client
   rspec-rails
   sqlite3

data/README.rst

@@ -224,7 +224,8 @@ Example:
    description "method description"
    formats ['json', 'jsonp', 'xml']
    example " 'user': {...} "
-   see "users#showme"
+   see "users#showme", "link description"
+   see :link => "users#update", :desc => "another link description"
    def show
      #...
    end

data/app/views/apipie/apipies/method.html.erb

@@ -23,8 +23,8 @@
 <% end %>
 
 <div>
-  <% unless @method[:see_url].blank? %>
-    Also see <%= link_to @method[:see], @method[:see_url] %>.
+  <% unless @method[:see].empty? %>
+    Also see <%= @method[:see].map { |s| link_to(s[:description], "#{s[:link]}.html") }.to_sentence.html_safe %>.
   <% end %>
 
   <%= raw @method[:full_description] %>

data/app/views/apipie/apipies/resource.html.erb

@@ -47,8 +47,8 @@
       <% end %>
     </div>
 
-    <% unless m[:see_url].blank? %>
-      Also see <%= link_to m[:see], m[:see_url] %>
+    <% unless m[:see].empty? %>
+      Also see <%= m[:see].map { |s| link_to(s[:description], "#{s[:link]}.html") }.to_sentence.html_safe %>.
     <% end %>
 
     <div id='description-<%= m[:name] %>' class='collapse accordion-body'>

data/lib/apipie-rails.rb

@@ -7,6 +7,7 @@ require "apipie/resource_description"
 require "apipie/param_description"
 require "apipie/errors"
 require "apipie/error_description"
+require "apipie/see_description"
 require "apipie/validator"
 require "apipie/dsl_definition"
 require "apipie/railtie"

data/lib/apipie/application.rb

@@ -212,7 +212,7 @@ module Apipie
         :short_description => nil,
         :description       => nil,
         :examples          => [],
-        :see               => nil,
+        :see               => [],
         :formats           => nil,
         :api_versions      => []
       }

data/lib/apipie/dsl_definition.rb

@@ -125,10 +125,9 @@ module Apipie
     #   api :PUT, '/articles/:id'
     #   see "articles#create"
     #   def update; end
-    def see(method_key)
+    def see(*args)
       return unless Apipie.active_dsl?
-      raise "'See' method called twice." if Apipie.last_dsl_data[:see]
-      Apipie.last_dsl_data[:see] = method_key
+      Apipie.last_dsl_data[:see] << Apipie::SeeDescription.new(args)
     end
 
     # Show some example of what does the described

data/lib/apipie/method_description.rb

@@ -105,16 +105,6 @@ module Apipie
       end
     end
 
-    def see_url
-      if @see
-        method_description = Apipie[@see]
-        if method_description.nil?
-          raise ArgumentError.new("Method #{@see} referenced in 'see' does not exist.")
-        end
-        method_description.doc_url
-      end
-    end
-
     def see
       @see
     end
@@ -133,8 +123,7 @@ module Apipie
         :errors => errors.map(&:to_json),
         :params => params_ordered.map(&:to_json).flatten,
         :examples => @examples,
-        :see => @see,
-        :see_url => see_url
+        :see => see.map(&:to_json)
       }
     end
 

data/lib/apipie/see_description.rb

@@ -0,0 +1,39 @@
+module Apipie
+
+  class SeeDescription
+
+    attr_reader :link, :description
+
+    def initialize(args)
+      if args.first.is_a? Hash
+        args = args.first
+      elsif args.count == 2
+        if args.last.is_a? Hash
+          args = {:link => args.first}.merge(args.last)
+        else
+          args = {:link => args.first, :description => args.second}
+        end
+      elsif args.count == 1 && args.first.is_a?(String)
+        args = {:link => args.first, :description => args.first}
+      else
+        raise ArgumentError "ApipieError: Bad use of see method."
+      end
+      @link = args[:link] || args['link']
+      @description = args[:desc] || args[:description] || args['desc'] || args['description']
+    end
+
+    def to_json
+      {:link => see_url, :description => description}
+    end
+
+    def see_url
+      method_description = Apipie[@link]
+      if method_description.nil?
+        raise ArgumentError.new("Method #{@link} referenced in 'see' does not exist.")
+      end
+      method_description.doc_url
+    end
+
+  end
+
+end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.16'
+  VERSION = '0.0.17'
 end

data/spec/controllers/users_controller_spec.rb

@@ -234,20 +234,28 @@ describe UsersController do
       context "the key is valid" do
         it "should contain reference to another method" do
           api = Apipie[UsersController, :see_another]
-          api.see.should eq('development#users#create')
+          see = api.see.first
+          see.see_url.should == Apipie[UsersController, :create].doc_url
+          see.link.should == 'development#users#create'
+          see.description.should == 'development#users#create'
+
+          see_with_desc = api.see.last
+          see_with_desc.see_url.should == Apipie[UsersController, :index].doc_url
+          see_with_desc.link.should == 'development#users#index'
+          see_with_desc.description.should == 'very interesting method reference'
+
           Apipie['development#users#see_another'].should eq(Apipie[UsersController, :see_another])
-          api.see_url.should eq(Apipie[UsersController, :create].doc_url)
         end
       end
 
       context "the key is not valid" do
         it "should raise exception" do
           api = Apipie[UsersController, :see_another]
-          api.instance_variable_set :@see, 'doesnot#exist'
+          api.instance_variable_set :@see, [Apipie::SeeDescription.new(['doesnot#exist'])]
           lambda {
-            api.see_url
+            api.see.first.see_url
           }.should raise_error(ArgumentError, /does not exist/)
-          api.instance_variable_set :@see, nil
+          api.instance_variable_set :@see, []
         end
       end
     end

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

@@ -220,6 +220,7 @@ class UsersController < ApplicationController
 
   api :GET, '/users/see_another', 'Boring method'
   see 'development#users#create'
+  see 'development#users#index', "very interesting method reference"
   desc 'This method is boring, look at users#create'
   def see_another
     render :text => 'This is very similar to create action'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000Z
+date: 2013-02-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &22093740 !ruby/object:Gem::Requirement
+  requirement: &21190160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *22093740
+  version_requirements: *21190160
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &22093320 !ruby/object:Gem::Requirement
+  requirement: &21189740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22093320
+  version_requirements: *21189740
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &22092860 !ruby/object:Gem::Requirement
+  requirement: &21189280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22092860
+  version_requirements: *21189280
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &22092440 !ruby/object:Gem::Requirement
+  requirement: &21188860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22092440
+  version_requirements: *21188860
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &22118600 !ruby/object:Gem::Requirement
+  requirement: &21215040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22118600
+  version_requirements: *21215040
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &22118180 !ruby/object:Gem::Requirement
+  requirement: &21214620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22118180
+  version_requirements: *21214620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22117760 !ruby/object:Gem::Requirement
+  requirement: &21214200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22117760
+  version_requirements: *21214200
 description: Maintain your API documentation up to date!
 email:
 - pajkycz@gmail.com
@@ -150,6 +150,7 @@ files:
 - lib/apipie/railtie.rb
 - lib/apipie/resource_description.rb
 - lib/apipie/routing.rb
+- lib/apipie/see_description.rb
 - lib/apipie/static_dispatcher.rb
 - lib/apipie/validator.rb
 - lib/apipie/version.rb