jmoses_apipie-rails 0.0.23

data/spec/lib/param_group_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe "param groups" do
+
+  it "lets reuse the params description in more actions" do
+    user_create_desc = Apipie["users#create"].params[:user]
+    user_create_params = user_create_desc.validator.hash_params_ordered.map(&:name)
+
+    user_update_desc = Apipie["users#update"].params[:user]
+    user_update_params = user_update_desc.validator.hash_params_ordered.map(&:name)
+
+    common = user_update_params & user_create_params
+    common.sort_by(&:to_s).should == user_update_params.sort_by(&:to_s)
+  end
+
+  it "allows using groups is nested param descriptions" do
+    user_create_desc = Apipie["users#update"].params[:user]
+    user_create_params = user_create_desc.validator.hash_params_ordered.map(&:name)
+    user_create_params.map(&:to_s).sort.should == %w[membership name pass]
+  end
+
+  it "should allow adding additional params to group" do
+    user_create_desc = Apipie["users#create"].params[:user]
+    user_create_params = user_create_desc.validator.hash_params_ordered.map(&:name)
+    user_create_params.map(&:to_s).sort.should == %w[membership name pass permalink]
+  end
+
+  context "hash param" do
+    it "influences only its childs" do
+      Apipie["users#create"].params[:user].required.should be true
+      Apipie["users#update"].params[:user].required.should be true
+    end
+  end
+
+  it "lets you reuse a group definition from different controller" do
+    arch_v1_desc = Apipie["1.0#architectures#create"].params[:architecture]
+    arch_v1_params = arch_v1_desc.validator.hash_params_ordered.map(&:name)
+
+    arch_v2_desc = Apipie["2.0#architectures#create"].params[:architecture]
+    arch_v2_params = arch_v2_desc.validator.hash_params_ordered.map(&:name)
+
+    arch_v1_params.sort_by(&:to_s).should == arch_v2_params.sort_by(&:to_s)
+  end
+end
+

data/spec/lib/resource_description_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Apipie::ResourceDescription do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  describe "methods descriptions" do
+
+    before(:each) do
+      @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
+      a = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      b = Apipie::MethodDescription.new(:b, @resource, dsl_data)
+      c = Apipie::MethodDescription.new(:c, @resource, dsl_data)
+      @resource.add_method_description(a)
+      @resource.add_method_description(b)
+      @resource.add_method_description(c)
+    end
+
+    it "should be ordered" do
+      @resource._methods.keys.should == [:a, :b, :c]
+      @resource.to_json[:methods].map{|h| h[:name]}.should == ['a', 'b', 'c']
+    end
+
+    it "should be still ordered" do
+      @resource._methods.keys.should == [:a, :b, :c]
+      @resource.to_json[:methods].map{|h| h[:name]}.should == ['a', 'b', 'c']
+    end
+
+  end
+end

data/spec/lib/validator_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Apipie::Validator do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, "users")
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  let(:params_desc) do
+    Apipie::ParamDescription.new(method_desc, :param, nil)
+  end
+
+  describe 'TypeValidator' do
+
+    context "expected type" do
+
+      it "should return hash for type Hash" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Hash)
+        validator.expected_type.should == 'hash'
+      end
+
+      it "should return array for type Array" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Array)
+        validator.expected_type.should == 'array'
+      end
+
+      it "should return numeric for type Numeric" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Numeric)
+        validator.expected_type.should == 'numeric'
+      end
+
+      it "should return string by default" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Symbol)
+        validator.expected_type.should == 'string'
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler/setup'
+
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../dummy/config/environment", __FILE__)
+
+require 'rspec/rails'
+require 'rspec/autorun'
+
+require 'apipie-rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+end

metadata

@@ -0,0 +1,337 @@
+--- !ruby/object:Gem::Specification
+name: jmoses_apipie-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.23
+  prerelease: 
+platform: ruby
+authors:
+- Jon Moses
+- Pavel Pokorny
+- Ivan Necas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-31 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.0.10
+  type: :runtime
+  prerelease: false
+  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: !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
+        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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  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: RedCloth
+  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: rake
+  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: Rails REST API documentation tool (fork by jmoses)
+email:
+- jon@burningbush.us
+- pajkycz@gmail.com
+- inecas@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- APACHE-LICENSE-2.0
+- CHANGELOG
+- Gemfile
+- MIT-LICENSE
+- NOTICE
+- README.rst
+- Rakefile
+- apipie-rails.gemspec
+- app/controllers/apipie/apipies_controller.rb
+- app/public/apipie/javascripts/apipie.js
+- app/public/apipie/javascripts/bundled/bootstrap-collapse.js
+- app/public/apipie/javascripts/bundled/bootstrap.js
+- app/public/apipie/javascripts/bundled/jquery-1.7.2.js
+- app/public/apipie/javascripts/bundled/prettify.js
+- app/public/apipie/stylesheets/application.css
+- app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css
+- app/public/apipie/stylesheets/bundled/bootstrap.min.css
+- app/public/apipie/stylesheets/bundled/prettify.css
+- app/views/apipie/apipies/_disqus.html.erb
+- app/views/apipie/apipies/_params.html.erb
+- app/views/apipie/apipies/_params_plain.html.erb
+- app/views/apipie/apipies/apipie_404.html.erb
+- app/views/apipie/apipies/getting_started.html.erb
+- app/views/apipie/apipies/index.html.erb
+- app/views/apipie/apipies/method.html.erb
+- app/views/apipie/apipies/plain.html.erb
+- app/views/apipie/apipies/resource.html.erb
+- app/views/apipie/apipies/static.html.erb
+- app/views/layouts/apipie/apipie.html.erb
+- lib/apipie-rails.rb
+- lib/apipie/apipie_module.rb
+- lib/apipie/application.rb
+- lib/apipie/client/generator.rb
+- lib/apipie/configuration.rb
+- lib/apipie/dsl_definition.rb
+- lib/apipie/error_description.rb
+- lib/apipie/errors.rb
+- lib/apipie/extractor.rb
+- lib/apipie/extractor/collector.rb
+- lib/apipie/extractor/recorder.rb
+- lib/apipie/extractor/writer.rb
+- lib/apipie/helpers.rb
+- lib/apipie/markup.rb
+- lib/apipie/method_description.rb
+- lib/apipie/param_description.rb
+- 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
+- lib/generators/apipie/install/README
+- lib/generators/apipie/install/install_generator.rb
+- lib/generators/apipie/install/templates/initializer.rb.erb
+- lib/tasks/apipie.rake
+- rel-eng/packages/.readme
+- rel-eng/packages/rubygem-apipie-rails
+- 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/concerns_controller_spec.rb
+- spec/controllers/users_controller_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/api/base_controller.rb
+- spec/dummy/app/controllers/api/v1/architectures_controller.rb
+- 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/architectures_controller.rb
+- spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/sample_controller.rb
+- spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/twitter_example_controller.rb
+- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/apipie.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/.gitkeep
+- spec/dummy/doc/apipie_examples.yml
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/javascripts/application.js
+- spec/dummy/public/javascripts/controls.js
+- spec/dummy/public/javascripts/dragdrop.js
+- spec/dummy/public/javascripts/effects.js
+- spec/dummy/public/javascripts/prototype.js
+- spec/dummy/public/javascripts/rails.js
+- spec/dummy/public/stylesheets/.gitkeep
+- spec/dummy/script/rails
+- spec/lib/application_spec.rb
+- spec/lib/method_description_spec.rb
+- spec/lib/param_description_spec.rb
+- spec/lib/param_group_spec.rb
+- spec/lib/resource_description_spec.rb
+- spec/lib/validator_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jmoses/apipie-rails
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails REST API documentation tool (fork by jmoses)
+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/concerns_controller_spec.rb
+- spec/controllers/users_controller_spec.rb
+- spec/dummy/Rakefile
+- spec/dummy/app/controllers/api/base_controller.rb
+- spec/dummy/app/controllers/api/v1/architectures_controller.rb
+- 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/architectures_controller.rb
+- spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/sample_controller.rb
+- spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/twitter_example_controller.rb
+- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/apipie.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/.gitkeep
+- spec/dummy/doc/apipie_examples.yml
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/public/javascripts/application.js
+- spec/dummy/public/javascripts/controls.js
+- spec/dummy/public/javascripts/dragdrop.js
+- spec/dummy/public/javascripts/effects.js
+- spec/dummy/public/javascripts/prototype.js
+- spec/dummy/public/javascripts/rails.js
+- spec/dummy/public/stylesheets/.gitkeep
+- spec/dummy/script/rails
+- spec/lib/application_spec.rb
+- spec/lib/method_description_spec.rb
+- spec/lib/param_description_spec.rb
+- spec/lib/param_group_spec.rb
+- spec/lib/resource_description_spec.rb
+- spec/lib/validator_spec.rb
+- spec/spec_helper.rb