restapi 0.0.4 → 0.0.5

data/restapi.gemspec

@@ -17,6 +17,4 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "rcov"
-  s.add_development_dependency "weary"
 end

data/spec/controllers/restapis_controller_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'fileutils'
 
 describe Restapi::RestapisController do
 
@@ -16,13 +17,12 @@ describe Restapi::RestapisController do
 
     RSpec::Matchers.define :reload_documentation do
       match do
+        Restapi.should_receive(:reload_documentation)
+        get :index
         begin
-          orig = Restapi.get_resource_description("users")._short_description.dup
-          Restapi.get_resource_description("users")._short_description << 'Modified'
-          get :index
-          ret = Restapi.get_resource_description("users")._short_description == orig
-        ensure
-          Restapi.get_resource_description("users")._short_description.gsub!('Modified', "")
+          RSpec::Mocks.verify
+        rescue RSpec::Mocks::MockExpectationError
+          false
         end
       end
 
@@ -94,4 +94,39 @@ describe Restapi::RestapisController do
       it { should_not reload_documentation }
     end
   end
+
+  describe "documentation cache" do
+
+    let(:cache_dir) { File.join(Rails.root, "tmp", "restapi-cache") }
+
+    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" }
+
+      Restapi.configuration.use_cache = true
+      Restapi.configuration.cache_dir = cache_dir
+    end
+
+    after do
+      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.json cache"
+      get :index, :format => "html", :resource => "resource"
+      response.body.should == "resource.html cache"
+      get :index, :format => "html", :resource => "resource", :method => "method"
+      response.body.should == "method.html cache"
+    end
+
+  end
 end

data/spec/controllers/users_controller_spec.rb

@@ -21,7 +21,7 @@ describe UsersController do
 
     it "should contain all resource methods" do
       methods = subject._methods
-      methods.count.should == 4
+      methods.count.should == 5
       methods.should include("users#show")
       methods.should include("users#create")
       methods.should include("users#index")
@@ -147,7 +147,7 @@ describe UsersController do
       end
 
       it "should work with Hash validator" do
-        post :create, :user => { :username => "root", :password => "12345", :membership => "standard" }
+        post :create, :user => { :name => "root", :pass => "12345", :membership => "standard" }
         assert_response :success
 
         a = Restapi[UsersController, :create]
@@ -156,19 +156,19 @@ describe UsersController do
         param.first.validator.class.should eq(Restapi::Validator::HashValidator)
         hash_params = param.first.validator.hash_params_ordered
         hash_params.count.should == 3
-        hash_params[0].name == :username
-        hash_params[1].name == :password
+        hash_params[0].name == :name
+        hash_params[1].name == :pass
         hash_params[2].name == :membership
 
         lambda {
-          post :create, :user => { :username => "root", :password => "12345", :membership => "____" }
+          post :create, :user => { :name => "root", :pass => "12345", :membership => "____" }
         }.should raise_error(ArgumentError, / membership /)
 
         lambda {
-          post :create, :user => { :username => "root" }
-        }.should raise_error(ArgumentError, / password /)
+          post :create, :user => { :name => "root" }
+        }.should raise_error(ArgumentError, / pass /)
 
-        post :create, :user => { :username => "root", :password => "pwd" }
+        post :create, :user => { :name => "root", :pass => "pwd" }
         assert_response :success
       end
 
@@ -186,8 +186,8 @@ describe UsersController do
       it "should allow nil when allow_nil is set to true" do
         post :create,
              :user => {
-               :username => "root",
-               :password => "12345",
+               :name => "root",
+               :pass => "12345",
                :membership => "standard",
              },
              :facts => nil
@@ -220,6 +220,29 @@ describe UsersController do
       b.full_description.length.should be > 400
     end
 
+    context "contain :see option" do
+
+      context "the key is valid" do 
+        it "should contain reference to another method" do
+          api = Restapi[UsersController, :see_another]
+          api.see.should eq('users#create')
+          Restapi['users#see_another'].should eq(Restapi[UsersController, :see_another])
+          api.see_url.should eq(Restapi[UsersController, :create].doc_url)
+        end
+      end
+
+      context "the key is not valid" do
+        it "should raise exception" do
+          api = Restapi[UsersController, :see_another]
+          api.instance_variable_set :@see, 'doesnot#exist'
+          lambda {
+            api.see_url
+          }.should raise_error(ArgumentError, /does not exist/)
+          api.instance_variable_set :@see, nil
+        end
+      end
+    end
+
     it "should contain possible errors description" do
       a = Restapi.get_method_description(UsersController, :show)
 
@@ -276,13 +299,13 @@ describe UsersController do
                         :allow_nil => false,
                         :validator=>"Parameter has to be String.",
                         :description=>"\n<p>Username for login</p>\n",
-                        :name=>"username", :full_name=>"resource_param[username]",
+                        :name=>"ausername", :full_name=>"resource_param[ausername]",
                         :expected_type=>"string"},
                        {:required=>true,
                         :allow_nil => false,
                         :validator=>"Parameter has to be String.",
                         :description=>"\n<p>Password for login</p>\n",
-                        :name=>"password", :full_name=>"resource_param[password]",
+                        :name=>"apassword", :full_name=>"resource_param[apassword]",
                         :expected_type=>"string"}
                       ]
                     },
@@ -311,6 +334,22 @@ describe UsersController do
 
   end
 
+  describe "examples" do
+
+    it "should be able to load examples from yml file" do
+      Restapi.get_method_description(UsersController, :show).examples.should == [<<EOS1, <<EOS2].map(&:chomp)
+GET /users/14?verbose=true
+200
+{
+  "name": "Test User"
+}
+EOS1
+GET /users/15
+404
+EOS2
+    end
+  end
+
   describe "param description" do
 
     it "should contain all specified information" do

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

@@ -3,6 +3,4 @@ class ApplicationController < ActionController::Base
   resource_description do
     param :oauth, String, :desc => "Authorization", :required => false
   end
-
-  protect_from_forgery
 end

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

@@ -150,21 +150,16 @@ class TwitterExampleController < ApplicationController
     render :text => 'search'
   end
   
-  api :GET, '/twitter_example/show', 'Returns extended information of a given user, specified by ID or screen name as per the required id parameter.'
-  param :user_id, Integer, :required => true, :desc => <<-EOS
+  api :GET, '/twitter_example/:id', 'Returns extended information of a given user, specified by ID or screen name as per the required id parameter.'
+  param :id, :number, :required => true, :desc => <<-EOS
     The ID of the user for whom to return results for. Either an id or screen_name is required for this method.
-    _Note_: Specifies the ID of the user to befriend. Helpful for disambiguating when a valid user ID is also a valid screen name.
   EOS
-  param :screen_name, String, :desc => 'The screen name of the user for whom to return results for. Either a id or screen_name is required for this method.'
+  param :screen_name, String, :desc => 'The screen name of the user for...'
   description <<-EDOC
     Returns extended information of a given user, specified by ID or screen name as per the required id parameter. The author's most recent status will be returned inline.
-    
-    You must be following a protected user to be able to see their most recent status update. If you don't follow a protected user, or request this method without autenticating, the users status will be removed.
-
-    The URL pattern <tt>/version/twitter_example/show/:screen_name_or_user_id.format</tt> is still accepted but not recommended. As a sequence of numbers is a valid screen name we recommend using the +screen_name+ or +user_id+ parameter instead.
   EDOC
   def show
-    render :text => 'show'
+    render :text => "show #{params}"
   end
   
   api :GET, '/twitter_example/contributors', 'Returns an array of users who can contribute to the specified account.'

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

@@ -7,8 +7,8 @@ class UsersController < ApplicationController
     version '1.0 - 3.4.2012'
     param :id, Fixnum, :desc => "User ID", :required => false
     param :resource_param, Hash, :desc => 'Param description for all methods' do
-      param :username, String, :desc => "Username for login", :required => true
-      param :password, String, :desc => "Password for login", :required => true
+      param :ausername, String, :desc => "Username for login", :required => true
+      param :apassword, String, :desc => "Password for login", :required => true
     end
     description <<-EOS
       == Long description
@@ -163,8 +163,8 @@ class UsersController < ApplicationController
     More builder documentation can be found at http://builder.rubyforge.org.
   eos
   api :GET, "/users/:id", "Show user profile"
-  error :code => 401, :desc => "Unauthorized"
-  error :code => 404, :desc => "Not Found"
+  error 401, "Unauthorized"
+  error :code => 404, :description => "Not Found"
   param :id, Integer, :desc => "user id", :required => true
   param :session, String, :desc => "user is logged in", :required => true
   param :regexp_param, /^[0-9]* years/, :desc => "regexp param"
@@ -188,8 +188,8 @@ class UsersController < ApplicationController
 
   api :POST, "/users", "Create user"
   param :user, Hash, :desc => "User info", :required => true do
-    param :username, String, :desc => "Username for login", :required => true
-    param :password, String, :desc => "Password for login", :required => true
+    param :name, String, :desc => "Username for login", :required => true
+    param :pass, String, :desc => "Password for login", :required => true
     param :membership, ["standard","premium"], :desc => "User membership"
   end
   param :facts, Hash, :desc => "Additional optional facts about the user", :allow_nil => true
@@ -213,4 +213,11 @@ class UsersController < ApplicationController
   def two_urls
     render :text => 'List of users'
   end
+
+  api :GET, '/users/see_another', 'Boring method'
+  see 'users#create'
+  desc 'This method is boring, look at users#create'
+  def see_another
+    render :text => 'This is very similar to create action'
+  end
 end

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

@@ -4,6 +4,13 @@ Restapi.configure do |config|
   config.doc_base_url = "/apidoc"
   config.api_base_url = "/api"
 
+  # set to true to turn on/off the cache. To generate the cache use:
+  #
+  #     rake restapi:cache
+  #
+  # config.use_cache = Rails.env.production?
+  # config.cache_dir = File.join(Rails.root, "public", "restapi-cache") # optional
+
   # set to enable/disable reloading controllers (and the documentation with it),
   # by default enabled in development
   # config.reload_controllers = false

data/spec/dummy/doc/restapi_examples.yml

@@ -0,0 +1,28 @@
+--- 
+users#show: 
+- verb: :GET
+  path: /users/15
+  query: 
+  request_data: 
+  response_data: 
+  code: 404
+  show_in_doc: 2
+  recorded: true
+- verb: :GET
+  path: /users/14
+  query: "verbose=true"
+  request_data: 
+  response_data: 
+    name: Test User
+  code: 200
+  show_in_doc: 1
+  recorded: true
+- verb: :GET
+  path: /users/15
+  query: "verbose=true"
+  request_data: 
+  response_data: 
+    name: Test User
+  code: 200
+  show_in_doc: 0
+  recorded: true

metadata

@@ -1,74 +1,39 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: restapi
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Pavel Pokorny
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec-rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: weary
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Maintain your API documentation up to date!
-email: 
+email:
 - pajkycz@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .autotest
 - .gitignore
 - .rspec
@@ -80,7 +45,6 @@ files:
 - README.rdoc
 - Rakefile
 - app/controllers/restapi/restapis_controller.rb
-- app/helpers/restapi/restapis_helper.rb
 - app/public/restapi/javascripts/bundled/bootstrap-collapse.js
 - app/public/restapi/javascripts/bundled/bootstrap.js
 - app/public/restapi/javascripts/bundled/jquery-1.7.2.js
@@ -91,14 +55,30 @@ files:
 - app/public/restapi/stylesheets/bundled/bootstrap.min.css
 - app/public/restapi/stylesheets/bundled/prettify.css
 - app/views/layouts/restapi/restapi.html.erb
+- app/views/restapi/restapis/_params.html.erb
+- app/views/restapi/restapis/_params_plain.html.erb
 - app/views/restapi/restapis/index.html.erb
 - app/views/restapi/restapis/method.html.erb
+- app/views/restapi/restapis/plain.html.erb
 - app/views/restapi/restapis/resource.html.erb
 - app/views/restapi/restapis/static.html.erb
 - lib/restapi.rb
 - lib/restapi/application.rb
+- lib/restapi/client/generator.rb
+- lib/restapi/client/template/Gemfile.tt
+- lib/restapi/client/template/README.tt
+- lib/restapi/client/template/base.rb.tt
+- lib/restapi/client/template/bin.rb.tt
+- lib/restapi/client/template/cli.rb.tt
+- lib/restapi/client/template/cli_command.rb.tt
+- lib/restapi/client/template/client.rb.tt
+- lib/restapi/client/template/resource.rb.tt
 - lib/restapi/dsl_definition.rb
 - lib/restapi/error_description.rb
+- lib/restapi/extractor.rb
+- lib/restapi/extractor/collector.rb
+- lib/restapi/extractor/recorder.rb
+- lib/restapi/extractor/writer.rb
 - lib/restapi/helpers.rb
 - lib/restapi/markup.rb
 - lib/restapi/method_description.rb
@@ -135,6 +115,7 @@ files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/doc/restapi_examples.yml
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -150,38 +131,29 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/Pajk/rails-restapi
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: REST API documentation tool
-test_files: 
+test_files:
 - spec/controllers/restapis_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
@@ -205,6 +177,7 @@ test_files:
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
+- spec/dummy/doc/restapi_examples.yml
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html