apipie-rails 0.0.18 → 0.0.19

data/.gitignore

@@ -7,3 +7,5 @@ spec/dummy/tmp/
 .idea
 Gemfile.lock
 .rvmrc
+
+.DS_Store

data/CHANGELOG

@@ -2,6 +2,12 @@
  Changelog
 ===========
 
+v0.0.19
+-------
+
+* fix examples recording when resource_id is set
+* use safe_yaml for loading examples file when available
+
 v0.0.18
 -------
 

data/lib/apipie/application.rb

@@ -207,7 +207,12 @@ module Apipie
       return @recorded_examples if @recorded_examples
       tape_file = File.join(Rails.root,"doc","apipie_examples.yml")
       if File.exists?(tape_file)
-        @recorded_examples = YAML.load_file(tape_file)
+        #if SafeYAML gem is enabled, it will load examples as an array of Hash, instead of hash
+        if defined? SafeYAML
+          @recorded_examples = YAML.load_file(tape_file, :safe=>false)
+        else
+          @recorded_examples = YAML.load_file(tape_file)
+        end
       else
         @recorded_examples = {}
       end

data/lib/apipie/extractor/collector.rb

@@ -19,7 +19,7 @@ module Apipie
       def ignore_call?(record)
         return true unless record[:controller]
         return true if @ignored.include?(record[:controller].name)
-        return true if @ignored.include?("#{record[:controller].name}##{record[:action]}")
+        return true if @ignored.include?("#{Apipie.get_resource_name(record[:controller].name)}##{record[:action]}")
         return true unless @api_controllers_paths.include?(controller_full_path(record[:controller]))
       end
 
@@ -33,7 +33,7 @@ module Apipie
       end
 
       def add_to_records(record)
-        key = "#{record[:controller].controller_name}##{record[:action]}"
+        key = "#{Apipie.get_resource_name(record[:controller])}##{record[:action]}"
         @records[key] << record
       end
 

data/lib/apipie/extractor/recorder.rb

@@ -13,6 +13,7 @@ module Apipie
         @params.merge!(env["action_dispatch.request.request_parameters"] || {})
         if data = parse_data(env["rack.input"].read)
           @request_data = data
+          env["rack.input"].rewind
         end
       end
 

data/lib/apipie/extractor/writer.rb

@@ -99,7 +99,11 @@ module Apipie
 
       def load_old_examples
         if File.exists?(@examples_file)
-          return YAML.load(File.read(@examples_file))
+           if defined? SafeYAML
+              return YAML.load_file(@examples_file, :safe=>false)
+            else
+              return YAML.load_file(@examples_file)
+            end
         end
         return {}
       end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

data/spec/controllers/api/v2/nested/resources_controller_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Api::V2::Nested::ResourcesController do
+  describe "resource id" do
+    subject { Apipie.get_resource_name(Api::V2::Nested::ResourcesController) }
+
+    it "should have resource_id set" do
+      subject.should eq("resource")
+    end
+  end
+end

data/spec/dummy/app/controllers/api/v2/nested/resources_controller.rb

@@ -0,0 +1,33 @@
+module Api
+  module V2
+    class Nested::ResourcesController < V2::BaseController
+      resource_description do 
+        name 'Resources'
+        resource_id "resource"
+      end
+      api :GET, "/nested/resources/", "List all nested resources."
+      def index
+      end
+
+      api :GET, "/nested/resources/:id/", "Show a nested resource."
+      def show
+      end
+
+      api :POST, "/nested/resources/", "Create a nested resource."
+      param_group :arch, Api::V1::ArchitecturesController
+      def create
+      end
+
+      api :PUT, "/nested/resources/:id/", "Update a nested resource."
+      param :architecture, Hash, :required => true do
+        param :name, String
+      end
+      def update
+      end
+
+      api :DELETE, "/resources/:id/", "Delete a nested resource."
+      def destroy
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &10023700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: 3.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *10023700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &10023280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10023280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &10022820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10022820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &10022400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +70,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10022400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &10021980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +86,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10021980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &10021560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +102,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10021560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10047700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +118,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10047700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Maintain your API documentation up to date!
 email:
 - pajkycz@gmail.com
@@ -161,6 +196,7 @@ files:
 - rel-eng/tito.props
 - 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
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
@@ -169,6 +205,7 @@ files:
 - spec/dummy/app/controllers/api/v1/base_controller.rb
 - spec/dummy/app/controllers/api/v2/architectures_controller.rb
 - spec/dummy/app/controllers/api/v2/base_controller.rb
+- spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
@@ -228,13 +265,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Rails REST API documentation tool
 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
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
@@ -243,6 +281,7 @@ test_files:
 - spec/dummy/app/controllers/api/v1/base_controller.rb
 - spec/dummy/app/controllers/api/v2/architectures_controller.rb
 - spec/dummy/app/controllers/api/v2/base_controller.rb
+- spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb