rapidoc 0.0.6 → 0.0.7

data/spec/lib/config_spec.rb

@@ -7,6 +7,10 @@ describe Rapidoc::Config do
     reset_structure
   end
 
+  after :all do
+    remove_structure
+  end
+
   it "config_dir returns correct dir" do
     config_dir().should eql( ::Rails.root.to_s + '/config/rapidoc' )
   end
@@ -50,7 +54,7 @@ describe Rapidoc::Config do
       it "controller_dir returns correct dir" do
         File.open( config_file_path, 'w') { |file| file.write "controllers_route: \"vim\"" }
         load_config
-        controller_dir().should eql( ::Rails.root.to_s + '/vim' )
+        controller_dir().should eq("#{::Rails.root}/vim" )
       end
     end
   end
@@ -63,7 +67,7 @@ describe Rapidoc::Config do
       end
 
       it "returns correct route" do
-        target_dir.should ==  ::Rails.root.to_s + "/vim"
+        target_dir.should eq("#{::Rails.root.to_s}/public/docs/vim")
       end
     end
 
@@ -74,7 +78,7 @@ describe Rapidoc::Config do
       end
 
       it "returns default route" do
-        target_dir.should == ::Rails.root.to_s + "/rapidoc"
+        target_dir.should  eq("#{::Rails.root}/public/docs")
       end
     end
 
@@ -128,7 +132,7 @@ describe Rapidoc::Config do
       end
 
       it "returns correct route" do
-        actions_dir.should ==  ::Rails.root.to_s + "/vim/actions"
+        actions_dir.should eq("#{::Rails.root}/public/docs/vim/actions")
       end
     end
 
@@ -139,7 +143,7 @@ describe Rapidoc::Config do
       end
 
       it "returns default route" do
-        actions_dir.should == ::Rails.root.to_s + "/rapidoc/actions"
+        actions_dir.should eq("#{::Rails.root.to_s}/public/docs/actions")
       end
     end
 
@@ -166,7 +170,7 @@ describe Rapidoc::Config do
     end
     context "when config file hasn't an example dir" do
       before do
-        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }   
+        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }
         load_config
       end
 
@@ -189,7 +193,7 @@ describe Rapidoc::Config do
 
     context "when config file has not resources_black_list" do
       it "returns empty array" do
-        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }   
+        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }
         load_config
         resources_black_list.should == []
       end

data/spec/lib/controller_extractor_spec.rb

@@ -9,7 +9,9 @@ describe ControllerExtractor do
       @extractor = ControllerExtractor.new "users_controller.rb"
     end
 
-    context
+    after :all do
+      remove_structure
+    end
 
     context "when call get_actions_info function" do
       before :all do
@@ -85,6 +87,7 @@ describe ControllerExtractor do
 
     context "when use custom controllers route" do
       it "use .yml extension for controllers files" do
+        create_config_structure
         File.open( config_file_path, 'w') { |file| file.write "controllers_route: \"vim\"" }
         load_config
 

data/spec/lib/http_response_spec.rb

@@ -25,7 +25,7 @@ describe "When check HttpResponse class" do
   context "when check get_description function" do
     before do
       @codes = [ 200, 201, 401, 404, 422, 403, 409 ]
-      @descriptions = [ 'OK', 'Created', 'Unauthorized', 'Not found',
+      @descriptions = [ 'OK', 'Created', 'Access Denied', 'Not found',
                         'Unprocessable Entity', 'Forbidden', '' ]
     end
 

data/spec/lib/param_errors_spec.rb

@@ -31,6 +31,7 @@ describe ParamErrors do
 
   context "when use config messaes and descriptions" do
     before :all do
+      create_config_structure
 
       File.open( config_file_path, 'w') do |file| 
         file.write "default_errors: true\n"
@@ -42,6 +43,10 @@ describe ParamErrors do
       load_config
     end
 
+    after :all do
+      remove_config
+    end
+
     context "when call get_required_error_info" do
       it "return correct error info" do
         info = get_required_error_info( 'name' )

data/spec/lib/rake_spec.rb

@@ -13,27 +13,88 @@ def capture_stdout(&block)
 end
 
 describe Rake do
-  context 'rapidoc:generate' do
+  before :all do
+    Rake.application.rake_require "tasks/rapidoc"
+    Rake::Task.define_task(:environment)
+  end
+
+  let :install_task do
+    Rake::Task["rapidoc:install"].reenable
+    Rake.application.invoke_task "rapidoc:install"
+  end
+
+  let :generate_task do
+    Rake::Task["rapidoc:generate"].reenable
+    Rake.application.invoke_task "rapidoc:generate"
+  end
+
+  let :clean_task do
+    Rake::Task["rapidoc:clean"].reenable
+    Rake.application.invoke_task "rapidoc:clean"
+  end
+
+  context "rapidoc:install" do
     before do
-      Rake.application.rake_require "tasks/rapidoc"
-      Rake::Task.define_task(:environment)
+      install_task
     end
 
-    after do
-      remove_doc 
+    after :all do
+      remove_structure
     end
 
-    let :run_rake_task do
-      Rake::Task["rapidoc:generate"].reenable
-      Rake.application.invoke_task "rapidoc:generate"
+    it "create directory and files" do
+      File.directory?("#{::Rails.root}/config/rapidoc").should be_true
+      File.directory?("#{::Rails.root}/config/rapidoc/examples").should be_true
+      File.exists?( "#{::Rails.root}/config/rapidoc/rapidoc.yml" ).should be_true
     end
+  end
+
+  context 'rapidoc:generate' do
+    context "when rapidoc is installed" do
+      before do
+        install_task
+      end
 
-    it "should create documentation" do
-      output = capture_stdout { run_rake_task }
-      output.should be_include( 'Generating API documentation...' )
-      output.should be_include( 'Completed API documentation generation' )
+      after :all do
+        remove_structure
+      end
+
+      it "create documentation" do
+        output = capture_stdout { generate_task }
+        output.should be_include( 'Generating API documentation...' )
+        output.should be_include( 'Completed API documentation generation' )
+        File.exists?( "#{::Rails.root}/public/docs/index.html" ).should be_true
+      end
+    end
+
+    context "when rapidoc is not installed" do
+      after :all do
+        remove_structure
+      end
+
+      it "show a message with information" do
+        output = capture_stdout { generate_task }
+        output.should be_include( 'Need install rapidoc for run it, for install run rapidoc:install task' )
+        File.exists?( "#{::Rails.root}/public/docs/index.html" ).should be_false
+      end
+    end
+  end
+
+  context "rapidoc:clean" do
+    before do
+      install_task
+      capture_stdout { generate_task }
+      clean_task
+    end
+
+    after :all do
+      remove_structure
+    end
 
-      File.exists?( ::Rails.root.to_s + "/rapidoc/index.html" ).should == true
+    it "remove docs files" do
+      File.directory?("#{::Rails.root}/public/docs").should be_false
+      File.directory?("#{::Rails.root}/config/rapidoc").should be_true
+      File.exists?( "#{::Rails.root}/config/rapidoc/rapidoc.yml" ).should be_true
     end
   end
 end

data/spec/lib/rapidoc_spec.rb

@@ -3,58 +3,53 @@ require "spec_helper"
 include Rapidoc
 
 describe Rapidoc do
-
-  context "when all is ok" do
-    before :all do
-      create_structure
-      load_config
+  context "when is installing rapidoc" do
+    before do
+      create_config_structure
     end
 
-    after :all do
-      remove_doc
-    end
+    it { File.directory?("#{::Rails.root}/config/rapidoc").should be_true }
+    it { File.directory?("#{::Rails.root}/config/rapidoc/examples").should be_true }
+    it { File.exists?(config_dir("rapidoc.yml")).should be_true }
+  end
 
-    context "when create estructure" do
-      it "should create config files" do
-        File.exists?( config_dir( "rapidoc.yml" ) ).should == true
+  context "when is generating the doc" do
+    context "with a default doc_routes" do
+      before do
+        create_doc_structure
+        generate_doc
       end
 
-      it "should create target dir" do
-        File.directory?( target_dir ).should == true
+      after :all do
+        remove_doc
       end
 
-      it "should create example dir" do
-        File.directory?( examples_dir ).should == true
-      end
+      it { File.directory?("#{::Rails.root}/public/docs").should be_true }
+      it { File.directory?("#{::Rails.root}/public/docs/actions").should be_true }
+      it { File.directory?("#{::Rails.root}/public/docs/assets").should be_true }
+      it { File.exists?("#{::Rails.root}/public/docs/index.html").should be_true }
     end
 
-    context "when executing genarate_doc function" do
+    context "with a diferent doc_route" do
       before do
+        File.open( config_file_path, 'w') { |file| file.write "doc_route: api/v1" }
+        load_config
+        create_doc_structure
         generate_doc
       end
 
-      it "should create new index.html file" do
-        File.exists?( ::Rails.root.to_s + "/rapidoc/index.html" ).should == true
+      after :all do
+        remove_doc
       end
-    end
-  end
-
-  context "when there is an error" do
-    before :all do
-      create_structure
-
-      File.open( config_file_path, 'w') { |file| file.write "controllers_route: \"public\"" }
-      load_config
 
-      controller = controller_dir 'users_controller.yml'
-      File.open( controller, 'w' ) { |file|
-        file.write "# =begin action\nhttp_status:\n  - 201\n  #params:\n  - name: 'name'\n# =end\n"
-      }
-
-      generate_doc
+      it { File.directory?("#{::Rails.root.to_s}/public/docs/api/v1").should be_true }
+      it { File.directory?("#{::Rails.root.to_s}/public/docs/api/v1/actions").should be_true }
+      it { File.directory?("#{::Rails.root.to_s}/public/docs/api/v1/assets").should be_true }
+      it { File.exists?("#{::Rails.root.to_s}/public/docs/api/v1/index.html").should be_true }
     end
+  end
 
-    it "should return error" do
-    end
+  after :all do
+    remove_structure
   end
 end

data/spec/lib/resource_doc_spec.rb

@@ -10,6 +10,10 @@ describe ResourceDoc do
     @routes_actions_info = get_routes_doc.get_actions_route_info( :users )
   end
 
+  after :all do
+    remove_structure
+  end
+
   context "when create new valid instance only with resource name" do
     before do
       @resource_name = "users"
@@ -29,7 +33,7 @@ describe ResourceDoc do
     end
 
     it "returns name without '/'" do
-      @rdoc.simple_name.should == "OneTwo"
+      @rdoc.simple_name.should == "Two"
     end
   end
 

data/spec/lib/resources_extractor_spec.rb

@@ -87,6 +87,8 @@ describe Rapidoc::ResourcesExtractor do
 
     context "when config has resources_black_list" do
       before do
+        create_config_structure
+
         File.open("#{config_dir}/rapidoc.yml", 'w') do |file|
           file.write "resources_black_list: images, albums"
         end
@@ -94,6 +96,10 @@ describe Rapidoc::ResourcesExtractor do
         load_config
       end
 
+      after :all do
+        remove_config
+      end
+
       it "returns correct resources names" do
         names = get_resources.map(&:name)
         names.should_not be_include( "images" )

data/spec/lib/templates_generator_spec.rb

@@ -10,7 +10,7 @@ describe TemplatesGenerator do
   end
 
   after do
-    #remove_doc
+    remove_structure
   end
 
   context "when call generate_index_template" do
@@ -37,7 +37,7 @@ describe TemplatesGenerator do
       @resources.each do |resource|
         resource.actions_doc.each do |action_doc|
           if action_doc.has_controller_info
-            route = actions_dir + "/#{resource.name}_#{action_doc.action}.html"
+            route = actions_dir + "/#{resource.name}/#{action_doc.action}.html"
             File.exists?( route ).should == true
           end
         end
@@ -53,14 +53,15 @@ describe TemplatesGenerator do
       info = resource_info.group_by{ |entrie| entrie[:action] }['create'].first
       controller_info = extractor.get_action_info( 'create' )
       @action_doc = ActionDoc.new( info, controller_info, examples_dir )
-      
+
       create_action_template( get_action_template, @action_doc )
     end
 
     it "should create new action html file" do
-      route = actions_dir + "/#{@action_doc.resource}_#{@action_doc.action}.html"
+      route = actions_dir + "/#{@action_doc.resource}/#{@action_doc.action}.html"
       File.exists?( route ).should == true
     end
+
   end
 
   context "when call get_action_template function" do

metadata

@@ -1,68 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: rapidoc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.0.7
 platform: ruby
 authors:
-- Rafael Jurado
+- Rafael Jurado, Harold Rangel, Luis Rodriguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: handlebars
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,43 +69,40 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Generates REST API documentation.
 email:
-- rjurado@nosolosoftware.biz
+- rjurado@openmailbox.org, aarold.rangel@koombea.com, luis.rodriguez@koombea.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -210,35 +198,29 @@ files:
 - spec/lib/templates_generator_spec.rb
 - spec/lib/yaml_parser_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/drinor/rapidoc.git
-licenses: []
+homepage: https://github.com/drinor/rapidoc
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3398396139760812886
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3398396139760812886
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generates REST API documentation.
 test_files:
 - spec/dummy/.gitignore