apipie-rails 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3557cb98f666126a55faa4fe95a955403adcaedf
-  data.tar.gz: 6fd75fb4ebd5e4b0652b81c77c0df65f6d96a41b
+  metadata.gz: 8f1836e9d470aab5a5fd2592c5bd020670d7644f
+  data.tar.gz: 915e53c2aed478f60375817066e059dc0b955e66
 SHA512:
-  metadata.gz: 1f9c181cc455758e9411f0631f3e5a5d67953ce8eb6209ad079862ce2e4ab3c1550cd5deb05fae1541d8e48d6d4f27753c994876484d185551f3049583a2ec47
-  data.tar.gz: 77b58f2a00111e3dab471de451c9ddcf9ec82622dde6b3ba14d3e23f2138ec571157521092fdebc0a76c73ae22350a3c2d7693147d65b248285e5f608734398f
+  metadata.gz: dc7d88e8c09ada1e11c86ce87e2535876c9c553532eb4ef07b66b862583308352e80ca47c2e656a43e85a9764725cea834c46bc20e5eae6321364509b5f9e21f
+  data.tar.gz: c6580080b5dc965477997baba13787948d2c749657156a02ab771a2890adab3195f04791fa736f832cdc4c1c20b6f4157edddace1441e7e453a87fe23c2126d2

data/.travis.yml

@@ -1,21 +1,22 @@
 language: ruby
 sudo: false
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.7
   - 2.2.3
   - 2.3.3
 gemfile:
-  - Gemfile.rails40
   - Gemfile.rails41
   - Gemfile.rails42
   - Gemfile.rails50 # Min ruby 2.2.2
+  - Gemfile.rails51 # Min ruby 2.2.2
 matrix:
   exclude:
-    - rvm: 1.9.3
-      gemfile: Gemfile.rails50
     - rvm: 2.0.0
       gemfile: Gemfile.rails50
+    - rvm: 2.0.0
+      gemfile: Gemfile.rails51
     - rvm: 2.1.7
       gemfile: Gemfile.rails50
+    - rvm: 2.1.7
+      gemfile: Gemfile.rails51

data/CHANGELOG.md

@@ -2,6 +2,16 @@
  Changelog
 ===========
 
+v0.5.0
+------
+
+- Fix Rails 5.1 deprecations [\#530](https://github.com/Apipie/apipie-rails/pull/530) ([@Onumis](https://github.com/Onumis) [@sedx](https://github.com/sedx))
+  - **This release is no longer compatible with Ruby 1.9.x**
+- Do not mutate strings passed as config options, fixes \#461 [\#537](https://github.com/Apipie/apipie-rails/pull/537) ([samphilipd](https://github.com/samphilipd))
+- Added recursion for documentation, fixed bug in examples with paperclip [\#531](https://github.com/Apipie/apipie-rails/pull/531) ([blddmnd](https://github.com/blddmnd))
+- Added locales/ja.yml for Japanese [\#529](https://github.com/Apipie/apipie-rails/pull/529) ([kikuchi0808](https://github.com/kikuchi0808))
+
+
 v0.4.0
 ------
 

data/{Gemfile.rails40 → Gemfile.rails51}

@@ -2,6 +2,6 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rails', '~> 4.0.0'
+gem 'rails', '~> 5.1.0.rc1'
 gem 'mime-types', '~> 2.99.3'
-gem 'json', '~> 1.8'
+gem 'rails-controller-testing'

data/apipie-rails.gemspec

@@ -10,14 +10,13 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/Apipie/apipie-rails"
   s.summary     = %q{Rails REST API documentation tool}
   s.description = %q{Rails REST API documentation tool}
-
+  s.required_ruby_version = '>= 2.0.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", ">= 4.0"
-  s.add_dependency 'json'
+  s.add_dependency "rails", ">= 4.1"
   s.add_development_dependency "rspec-rails", "~> 3.0"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest"

data/app/controllers/apipie/apipies_controller.rb

@@ -114,9 +114,13 @@ module Apipie
 
     def get_format
       [:resource, :method, :version].each do |par|
-        if params[par]
-          params[:format] = :html unless params[par].sub!('.html', '').nil?
-          params[:format] = :json unless params[par].sub!('.json', '').nil?
+        next unless params[par]
+        [:html, :json].each do |format|
+          extension = ".#{format}"
+          if params[par].include?(extension)
+            params[par] = params[par].sub(extension, '')
+            params[:format] = format
+          end
         end
       end
       request.format = params[:format] if params[:format]

data/config/locales/ja.yml

@@ -0,0 +1,31 @@
+ja:
+  apipie:
+    resources: "リソース"
+    resource: "リソース"
+    description: "記述"
+    no_docs_found: "ドキュメントが見つかりませんでした。"
+    no_docs_found_descr: "あなたのAPIにあう資料が見つかりませんでした。"
+    follow_instructions_html: "コントローラーをどう説明するのか%{href}を参考にしてください。"
+    follow_instructions_href: "具体的な説明"
+    oops: "おっと！"
+    resource_not_found_html: "リソース%{resource}が見つかりませんでした。"
+    method_not_found_html: "リソース%{resource}のためのメソッド%{method}が見つかりませんでした。 ."
+    goto_homepage_html: "%{href}へ移ります。"
+    goto_homepage_href: "%{app_name}APIドキュメントのホームページ"
+    required: "必須"
+    optional: "任意"
+    nil_allowed: "nil可"
+    param_name: "パラメーター名"
+    params: "パラメーター"
+    examples: "例"
+    metadata: "メタデータ"
+    errors: "エラー"
+    error_code: "エラーコード"
+    error_description: "エラー説明"
+    error_metadata: "エラーメタデータ"
+    supported_formats: "サポートフォーマット"
+    enable_javascript_html: "%{comments_href}のJavaScriptをオンにしてください。"
+    comments_powered_by_disqus: "%{disqus}によるコメント"
+    api_documentation: "APIドキュメント"
+    headers: "ヘッダー"
+    header_name: "ヘッダー名"

data/lib/apipie-rails.rb

@@ -1,4 +1,5 @@
 require 'i18n'
+require 'json'
 require 'active_support/hash_with_indifferent_access'
 
 require "apipie/routing"

data/lib/apipie/application.rb

@@ -424,10 +424,10 @@ module Apipie
     # as this would break loading of the controllers.
     def rails_mark_classes_for_reload
       unless Rails.application.config.cache_classes
-        ActionDispatch::Reloader.cleanup!
+        Rails.application.reloader.reload!
         init_env
         reload_examples
-        ActionDispatch::Reloader.prepare!
+        Rails.application.reloader.prepare!
       end
     end
 

data/lib/apipie/dsl_definition.rb

@@ -237,7 +237,7 @@ module Apipie
               # Only allow params passed in that are defined keys in the api
               # Auto skip the default params (format, controller, action)
               if Apipie.configuration.validate_key?
-                params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_key do |param|
+                params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_pair do |param, _|
                   # params allowed
                   raise UnknownParam.new(param) if method_params.select {|_,p| p.name.to_s == param.to_s}.empty?
                 end

data/lib/apipie/extractor.rb

@@ -17,7 +17,7 @@ class Apipie::Railtie
     end
     app.middleware.use ::Apipie::Extractor::Recorder::Middleware
     ActionController::TestCase::Behavior.instance_eval do
-      include Apipie::Extractor::Recorder::FunctionalTestRecording
+      prepend Apipie::Extractor::Recorder::FunctionalTestRecording
     end
   end
 end

data/lib/apipie/extractor/recorder.rb

@@ -145,12 +145,8 @@ module Apipie
       end
 
       module FunctionalTestRecording
-        def self.included(base)
-          base.alias_method_chain :process, :api_recording
-        end
-
-        def process_with_api_recording(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
-          ret = process_without_api_recording(*args)
+        def process(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+          ret = super(*args)
           if Apipie.configuration.record
             Apipie::Extractor.call_recorder.analyze_functional_test(self)
             Apipie::Extractor.call_finished

data/lib/apipie/extractor/writer.rb

@@ -78,21 +78,26 @@ module Apipie
         %w[title verb path versions query request_data response_data code show_in_doc recorded].each do |k|
           next unless call.has_key?(k)
           ordered_call[k] = case call[k]
-                       when ActiveSupport::HashWithIndifferentAccess
-                         # UploadedFiles break the to_json call, turn them into a string so they don't break
-                         call[k].each do |pkey, pval|
-                           if (pval.is_a?(Rack::Test::UploadedFile) || pval.is_a?(ActionDispatch::Http::UploadedFile))
-                             call[k][pkey] = "<FILE CONTENT '#{pval.original_filename}'>"
-                           end
-                         end
-                         JSON.parse(call[k].to_json) # to_hash doesn't work recursively and I'm too lazy to write the recursion:)
-                       else
-                         call[k]
-                       end
-        end
+                     when ActiveSupport::HashWithIndifferentAccess
+                       convert_file_value(call[k]).to_hash
+                     else
+                       call[k]
+                     end
+      end
         return ordered_call
       end
 
+      def convert_file_value hash
+        hash.each do |k, v|
+          if (v.is_a?(Rack::Test::UploadedFile) || v.is_a?(ActionDispatch::Http::UploadedFile))
+            hash[k] = "<FILE CONTENT '#{v.original_filename}'>"
+          elsif v.is_a?(Hash)
+            hash[k] = convert_file_value(v)
+          end
+        end
+        hash
+      end
+
       def load_recorded_examples
         self.class.load_recorded_examples
       end
@@ -131,7 +136,7 @@ module Apipie
             new_example[:title] ||= old_example["title"] if old_example["title"].present?
           end
           new_example
-        end 
+        end
       end
 
       def load_new_examples

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/controllers/concerns_controller_spec.rb

@@ -13,7 +13,7 @@ describe ConcernsController do
   end
 
   it "should pass if required parameter is missing" do
-    expect { get :show, :id => '5' }.not_to raise_error
+    expect { get :show, :params => { :id => '5' } }.not_to raise_error
   end
 
   it "peserved the order of methods being defined in file" do

data/spec/controllers/users_controller_spec.rb

@@ -71,7 +71,7 @@ describe UsersController do
       end
 
       it "should pass if required parameter is missing" do
-        expect { get :show, :id => 5 }.not_to raise_error
+        expect { get :show, :params => { :id => 5 } }.not_to raise_error
       end
 
     end
@@ -205,7 +205,7 @@ describe UsersController do
           end
 
           it "should work with Hash validator" do
-            post :create, :user => { :name => "root", :pass => "12345", :membership => "standard" }
+            post :create, params: { :user => { :name => "root", :pass => "12345", :membership => "standard" } }
             assert_response :success
 
             a = Apipie[UsersController, :create]
@@ -219,18 +219,18 @@ describe UsersController do
             hash_params[2].name == :membership
 
             expect {
-              post :create, :user => { :name => "root", :pass => "12345", :membership => "____" }
+              post :create, :params => { :user => { :name => "root", :pass => "12345", :membership => "____" } }
             }.to raise_error(Apipie::ParamInvalid, /membership/)
 
             expect {
-              post :create, :user => { :name => "root" }
+              post :create, :params => { :user => { :name => "root" } }
             }.to raise_error(Apipie::ParamMissing, /pass/)
 
             expect {
-              post :create, :user => "a string is not a hash"
+              post :create, :params => { :user => "a string is not a hash" }
             }.to raise_error(Apipie::ParamInvalid, /user/)
 
-            post :create, :user => { :name => "root", :pass => "pwd" }
+            post :create, :params => { :user => { :name => "root", :pass => "pwd" } }
             assert_response :success
           end
 
@@ -251,23 +251,27 @@ describe UsersController do
 
           it "should allow nil when allow_nil is set to true" do
             post :create,
-                 :user => {
-                   :name => "root",
-                   :pass => "12345",
-                   :membership => "standard",
-                 },
-                 :facts => { :test => 'test' }
+                 :params => {
+                   :user => {
+                     :name => "root",
+                     :pass => "12345",
+                     :membership => "standard",
+                   },
+                   :facts => { :test => 'test' }
+                 }
             assert_response :success
           end
 
           it "should allow blank when allow_blank is set to true" do
             post :create,
-              :user => {
-                :name => "root",
-                :pass => "12345",
-                :membership => "standard"
-              },
-              :age => ""
+              :params => {
+                :user => {
+                  :name => "root",
+                  :pass => "12345",
+                  :membership => "standard"
+                },
+                :age => ""
+              }
             assert_response :success
           end
 
@@ -276,7 +280,7 @@ describe UsersController do
             context "with valid input" do
               it "should succeed" do
                 put :update,
-                    {
+                    :params => {
                       :id => 5,
                       :user => {
                         :name => "root",
@@ -319,7 +323,7 @@ describe UsersController do
             end
             it "should work with empty array" do
               put :update,
-                  {
+                  :params => {
                     :id => 5,
                     :user => {
                       :name => "root",
@@ -567,7 +571,7 @@ describe UsersController do
                           :expected_type=>"string"},
                          {:required=>true,
                           :allow_nil => false,
-                          :allow_blank => false,   
+                          :allow_blank => false,
                           :validator=>"Must be a String",
                           :description=>"\n<p>Password for login</p>\n",
                           :name=>"apassword", :full_name=>"resource_param[apassword]",
@@ -709,13 +713,13 @@ EOS2
     end
 
     it "process correctly the parameters" do
-      post :create, :user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard' }, :facts => {:test => 'test'}
+      post :create, :params => {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard' }, :facts => {:test => 'test'}}
 
       expect(assigns(:api_params).with_indifferent_access).to eq({:user => {:name=>"dummy", :pass=>"dummy", :membership=>"standard"}, :facts => {:test => 'test'}}.with_indifferent_access)
     end
 
     it "ignore not described parameters" do
-      post :create, {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard', :id => 0}}
+      post :create, :params => {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard', :id => 0}}
 
       expect(assigns(:api_params).with_indifferent_access).to eq({:user => {:name=>"dummy", :pass=>"dummy", :membership=>"standard"}}.with_indifferent_access)
     end

data/spec/dummy/app/controllers/concerns/sample_controller.rb

@@ -4,13 +4,13 @@ module Concerns
 
     api!
     def index
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :GET, '/:resource_id/:id'
     param :id, String
     def show
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     def_param_group :concern do
@@ -23,19 +23,19 @@ module Concerns
     api :POST, '/:resource_id', "Create a :concern"
     param_group :concern
     def create
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :PUT, '/:resource_id/:id'
     param :id, String
     param_group :concern
     def update
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :GET, '/:resource_id/:custom_subst'
     def custom
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
   end
 end

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

@@ -192,15 +192,15 @@ class UsersController < ApplicationController
   end
   def show
     unless params[:session] == "secret_hash"
-      render :text => "Not authorized", :status => 401
+      render :plain => "Not authorized", :status => 401
       return
     end
 
     unless params[:id].to_i == 5
-      render :text => "Not Found", :status => 404 and return
+      render :plain => "Not Found", :status => 404 and return
     end
 
-    render :text => "OK"
+    render :plain => "OK"
   end
 
   def_param_group :credentials do
@@ -223,7 +223,7 @@ class UsersController < ApplicationController
   param :facts, Hash, :desc => "Additional optional facts about the user", :allow_nil => true
   param :age, :number, :desc => "Age is just a number", :allow_blank => true
   def create
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :PUT, "/users/:id", "Update an user"
@@ -232,13 +232,13 @@ class UsersController < ApplicationController
     param :comment, String
   end
   def update
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :POST, "/users/admin", "Create admin user"
   param_group :user, :as => :create
   def admin_create
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :GET, "/users", "List users"
@@ -248,14 +248,14 @@ class UsersController < ApplicationController
   param :oauth, nil,
         :desc => "Hide this global param (eg dont need auth here)"
   def index
-    render :text => "List of users"
+    render :plain => "List of users"
   end
 
   api :GET, '/company_users', 'Get company users'
   api :GET, '/company/:id/users', 'Get users working in given company'
   param :id, Integer, :desc => "Company ID"
   def two_urls
-    render :text => 'List of users'
+    render :plain => 'List of users'
   end
 
   api :GET, '/users/see_another', 'Boring method'
@@ -264,14 +264,14 @@ class UsersController < ApplicationController
   see 'development#users#index', "very interesting method reference"
   desc 'This method is boring, look at users#create.  It is hidden from documentation.'
   def see_another
-    render :text => 'This is very similar to create action'
+    render :plain => 'This is very similar to create action'
   end
 
 
   api :GET, '/users/desc_from_file', 'desc from file'
   document 'users/desc_from_file.md'
   def desc_from_file
-    render :text => 'document from file action'
+    render :plain => 'document from file action'
   end
 
   api! 'Create user'

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

@@ -6,7 +6,7 @@ Apipie.configure do |config|
   # can be overriden in resource_description
   # by default is it 1.0 if not specified anywhere
   # this must be defined before api_base_url and app_info
-  config.default_version = "development"
+  config.default_version = "development".freeze
 
   config.doc_base_url = "/apidoc"
 

data/spec/spec_helper.rb

@@ -11,12 +11,8 @@ require 'apipie-rails'
 
 module Rails4Compatibility
   module Testing
-    def process_with_rails4_compat(*args)
-      compatible_request(*args) { |*new_args| process_without_rails4_compat(*new_args) }
-    end
-
-    def self.included(base)
-      base.alias_method_chain :process, :rails4_compat
+    def process(*args)
+      compatible_request(*args) { |*new_args| super(*new_args) }
     end
 
     def compatible_request(method, action, hash = {})
@@ -71,5 +67,4 @@ RSpec.configure do |config|
 end
 
 require 'action_controller/test_case.rb'
-# TODO: replace with prepend once we deprecate ruby 2.0.0
-ActionController::TestCase::Behavior.send(:include, Rails4Compatibility::Testing)
+ActionController::TestCase::Behavior.send(:prepend, Rails4Compatibility::Testing)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-18 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,28 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -151,10 +137,10 @@ files:
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
 - Gemfile
-- Gemfile.rails40
 - Gemfile.rails41
 - Gemfile.rails42
 - Gemfile.rails50
+- Gemfile.rails51
 - MIT-LICENSE
 - NOTICE
 - README.rst
@@ -192,6 +178,7 @@ files:
 - config/locales/en.yml
 - config/locales/es.yml
 - config/locales/it.yml
+- config/locales/ja.yml
 - config/locales/pl.yml
 - config/locales/pt-BR.yml
 - config/locales/ru.yml
@@ -304,7 +291,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="