apipie-rails 0.2.5 → 0.2.6

data/CHANGELOG.md

@@ -2,6 +2,14 @@
  Changelog
 ===========
 
+v0.2.6
+------
+
+* better handling on cases where resource/method is not found when cache is turned off
+  [#284](https://github.com/Apipie/apipie-rails/pull/284) [@iNecas][]
+* fix disqus integration
+  [#281](https://github.com/Apipie/apipie-rails/pull/281) [@RajRoR][]
+
 v0.2.5
 ------
 
@@ -210,3 +218,4 @@ v0.0.15
 [@mourad-ifeelgoods]: https://github.com/mourad-ifeelgoods
 [@domcleal]: https://github.com/domcleal
 [@dustint-rh]: https://github.com/dustint-rh
+[@RajRoR]: https://github.com/RajRoR

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

@@ -10,4 +10,4 @@
 <noscript><%= t('apipie.enable_javascript_html', :comments_href => link_to(
         t('apipie.comments_powered_by_disqus', :disqus => 'Disqus'),
         "http://disqus.com/?ref_noscript")) %></noscript>
-<a href="http://disqus.com" class="dsq-brlink"><%= t('apipie.comments_powered_by_disqus', :disqus => "<span class="logo-disqus">Disqus</span>") %></a>
+<a href="http://disqus.com" class="dsq-brlink"><%= t('apipie.comments_powered_by_disqus', :disqus => "<span class='logo-disqus'>Disqus</span>") %></a>

data/lib/apipie/application.rb

@@ -216,7 +216,7 @@ module Apipie
 
     def to_json(version, resource_name, method_name, lang)
 
-      return unless resource_descriptions.has_key?(version)
+      return unless valid_search_args?(version, resource_name, method_name)
 
       _resources = if resource_name.blank?
         # take just resources which have some methods because
@@ -324,6 +324,20 @@ module Apipie
 
     private
 
+    # Make sure that the version/resource_name/method_name are valid combination
+    # resource_name and method_name can be nil
+    def valid_search_args?(version, resource_name, method_name)
+      return false unless self.resource_descriptions.has_key?(version)
+      if resource_name
+        return false unless self.resource_descriptions[version].has_key?(resource_name)
+        if method_name
+          resource_description = self.resource_descriptions[version][resource_name]
+          return false unless resource_description.valid_method_name?(method_name)
+        end
+      end
+      return true
+    end
+
     def version_prefix(klass)
       version = controller_versions(klass).first
       base_url = get_base_url(version)

data/lib/apipie/resource_description.rb

@@ -81,7 +81,14 @@ module Apipie
 
     def api_url; "#{Apipie.api_base_url(_version)}#{@_path}"; end
 
+    def valid_method_name?(method_name)
+      @_methods.keys.map(&:to_s).include?(method_name.to_s)
+    end
+
     def to_json(method_name = nil, lang = nil)
+      if method_name && !valid_method_name?(method_name)
+        raise "Method #{method_name} not found for resource #{_name}"
+      end
 
       methods = if method_name.blank?
         @_methods.collect { |key, method_description| method_description.to_json(lang) }

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.2.5'
+  VERSION = '0.2.6'
 end

data/spec/controllers/apipies_controller_spec.rb

@@ -5,12 +5,47 @@ describe Apipie::ApipiesController do
 
   describe "GET index" do
 
-    it "test if route exists" do
+    it "succeeds on index" do
       get :index
 
       assert_response :success
     end
 
+    it "succeeds on version details" do
+      get :index, :version => "2.0"
+
+      assert_response :success
+    end
+
+    it "returns not_found on wrong version" do
+      get :index, :version => "wrong_version"
+
+      assert_response :not_found
+    end
+
+    it "succeeds on resource details" do
+      get :index, :version => "2.0", :resource => "architectures"
+
+      assert_response :success
+    end
+
+    it "returns not_found on wrong resource" do
+      get :index, :version => "2.0", :resource => "wrong_resource"
+
+      assert_response :not_found
+    end
+
+    it "succeeds on method details" do
+      get :index, :version => "2.0", :resource => "architectures", :method => "index"
+
+      assert_response :success
+    end
+
+    it "returns not_found on wrong method" do
+      get :index, :version => "2.0", :resource => "architectures", :method => "wrong_method"
+
+      assert_response :not_found
+    end
   end
 
   describe "reload_controllers" do

metadata

@@ -1,165 +1,169 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: apipie-rails
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.2.6
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 5
-  version: 0.2.5
 platform: ruby
-authors: 
+authors:
 - Pavel Pokorny
 - Ivan Necas
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-08-22 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 3
-        - 0
-        - 10
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.10
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+- !ruby/object:Gem::Dependency
+  name: json
+  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: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec-rails
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 2
-        - 14
-        - 2
+      - !ruby/object:Gem::Version
         version: 2.14.2
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: *id005
-- !ruby/object:Gem::Dependency 
-  name: maruku
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  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: *id006
-- !ruby/object:Gem::Dependency 
-  name: RedCloth
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  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: *id007
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rails REST API documentation tool
-email: 
+email:
 - pajkycz@gmail.com
 - inecas@redhat.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -297,41 +301,31 @@ files:
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
 - spec/support/rake.rb
-has_rdoc: true
 homepage: http://github.com/Pajk/apipie-rails
 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.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Rails REST API documentation tool
-test_files: 
+test_files:
 - spec/controllers/api/v1/architectures_controller_spec.rb
 - spec/controllers/api/v2/architectures_controller_spec.rb
 - spec/controllers/api/v2/nested/resources_controller_spec.rb
@@ -396,3 +390,4 @@ test_files:
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
 - spec/support/rake.rb
+has_rdoc: