apipie-rails 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21e987c452e1e522365932db32bb06b9d4dabf51
-  data.tar.gz: 92d447975ab9539f24b52c19e0fa22875b0fe039
+  metadata.gz: ff402148f82601329555c80c61abcf03b5aad5f8
+  data.tar.gz: 3e813a085a3f97ac4a22c0bb4868d2794aa92d66
 SHA512:
-  metadata.gz: 097757c953763f1a70eb1005dda15fb0734e6e9670e235a6b534a0ef3a109ab087e7e7e01459edb822cc4f887009d57ad17a733c081c14eac72deae2d384bb6f
-  data.tar.gz: 2ef85b2507dc949756c8816c31c340efdc4f59f259c92fe0342972f4f799240c1443f637ca2f4e91114fbfbd283ed3a30a3afdbd553a95307444e32531cd5fed
+  metadata.gz: 8ec2b8a330539a058e6c9a1b454635016ffcdc53374a661fb58eed1de6adb404ab0085f18d2e99f4ed7c99a091cb7ddf649bcc74fa5676dad4ed24f2a02e05ac
+  data.tar.gz: cd298cfd7e25d2ad6abcc1cc78c1d63d406f2a41a7f12505b0f2261302a319df3229878c1db0af2cd389b0e1c72b57b02cb2a1c980defff283ab8d324e992277

data/CHANGELOG.md

@@ -1,6 +1,13 @@
  Changelog
 ===========
 
+v0.5.2
+------
+
+- A way to extend an exiting API via concern [\#554](https://github.com/Apipie/apipie-rails/pull/554) ([iNecas](https://github.com/iNecas))
+- Fallback to apipie views when application override isn't present [\#552](https://github.com/Apipie/apipie-rails/pull/552) ([tstrachota](https://github.com/tstrachota))
+- Updated setting default locale for api documentation [\#543](https://github.com/Apipie/apipie-rails/pull/543) ([DmitryKK](https://github.com/DmitryKK))
+
 v0.5.1
 ------
 

data/Gemfile

@@ -0,0 +1 @@
+Gemfile.rails50

data/Gemfile.rails50

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
+gem 'pry'
 gem 'rails', '~> 5.0'
 gem 'mime-types', '~> 2.99.3'
 gem 'rails-controller-testing'

data/README.rst

@@ -504,6 +504,32 @@ Example
    end
 
 
+Sometimes, it's needed to extend an existing controller method with additional
+parameters (usually when extending exiting API from plugins/rails engines).
+The concern can be also used for this purposed, using `update_api` method.
+The params defined in this block are merged with the params of the original method
+in the controller this concern is included to.
+
+Example
+~~~~~~~
+
+.. code:: ruby
+
+   module Concerns
+     module OauthConcern
+       extend Apipie::DSL::Concern
+
+       update_api(:create, :update) do
+         param :user, Hash do
+           param :oauth, String, :desc => 'oauth param'
+         end
+       end
+     end
+   end
+
+The concern needs to be included to the controller after the methods are defined
+(either at the end of the class, or by using
+``Controller.send(:include, Concerns::OauthConcern)``.
 
 =========================
  Configuration Reference
@@ -999,7 +1025,7 @@ the default version is used instead.
 ========
 
 The default markup language is `RDoc
-<http://rdoc.rubyforge.org/RDoc/Markup.html>`_. It can be changed in
+<https://rdoc.github.io/rdoc/RDoc/Markup.html>`_. It can be changed in
 the config file (``config.markup=``) to one of these:
 
 Markdown
@@ -1231,7 +1257,7 @@ one example per method) by adding a 'title' attribute.
          - recorded: true
 
 In RSpec you can add metadata to examples. We can use that feature
-to mark selected examples – the ones that perform the requests that we want to
+to mark selected examples - the ones that perform the requests that we want to
 show as examples in the documentation.
 
 For example, we can add ``show_in_doc`` to examples, like this:

data/app/controllers/apipie/apipies_controller.rb

@@ -79,7 +79,7 @@ module Apipie
     helper_method :heading
 
     def get_language
-      lang = nil
+      lang = Apipie.configuration.default_locale
       [:resource, :method, :version].each do |par|
         if params[par]
           splitted = params[par].split('.')

data/lib/apipie/dsl_definition.rb

@@ -8,6 +8,14 @@ module Apipie
     module Base
       attr_reader :apipie_resource_descriptions, :api_params
 
+      def _apipie_eval_dsl(*args, &block)
+        raise 'The Apipie DLS data need to be cleared before evaluating new block' if @_apipie_dsl_data
+        instance_exec(*args, &block)
+        return _apipie_dsl_data
+      ensure
+        _apipie_dsl_data_clear
+      end
+
       private
 
       def _apipie_dsl_data
@@ -381,6 +389,37 @@ module Apipie
         _apipie_concern_subst.merge!(subst_hash)
       end
 
+      # Allows to update existing params after definition was made (usually needed
+      # when extending the API form plugins).
+      #
+      #     UsersController.apipie_update_params([:create, :update]) do
+      #       param :user, Hash do
+      #         param :oauth, String
+      #       end
+      #      end
+      #
+      # The block is evaluated in scope of the controller. Ohe can pass some additional
+      # objects via additional arguments like this:
+      #
+      #     UsersController.apipie_update_params([:create, :update], [:name, :secret]) do |param_names|
+      #       param :user, Hash do
+      #         param_names.each { |p| param p, String }
+      #       end
+      #      end
+      def apipie_update_params(methods, *args, &block)
+        methods.each do |method|
+          method_description = Apipie.get_method_description(self, method)
+          unless method_description
+            raise "Could not find method description for #{self}##{method}. Was the method defined?"
+          end
+          dsl_data = _apipie_eval_dsl(*args, &block)
+          params_ordered = dsl_data[:params].map do |args|
+            Apipie::ParamDescription.from_dsl_data(method_description, args)
+          end
+          ParamDescription.unify(method_description.params_ordered_self + params_ordered)
+        end
+      end
+
       def _apipie_concern_subst
         @_apipie_concern_subst ||= {:controller_path => self.controller_path,
                                     :resource_id => Apipie.get_resource_name(self)}
@@ -428,12 +467,19 @@ module Apipie
           description = Apipie.define_method_description(controller, method_name, _apipie_dsl_data)
           controller._apipie_define_validators(description)
         end
+        _apipie_concern_update_api_blocks.each do |(methods, block)|
+          controller.apipie_update_params(methods, &block)
+        end
       end
 
       def _apipie_concern_data
         @_apipie_concern_data ||= []
       end
 
+      def _apipie_concern_update_api_blocks
+        @_apipie_concern_update_api_blocks ||= []
+      end
+
       def apipie_concern?
         true
       end
@@ -449,6 +495,10 @@ module Apipie
         _apipie_dsl_data_clear
       end
 
+      def update_api(*methods, &block)
+        _apipie_concern_update_api_blocks << [methods, block]
+      end
+
     end
 
     class ResourceDescriptionDsl
@@ -461,14 +511,9 @@ module Apipie
         @controller = controller
       end
 
-      def _eval_dsl(&block)
-        instance_eval(&block)
-        return _apipie_dsl_data
-      end
-
       # evaluates resource description DSL and returns results
       def self.eval_dsl(controller, &block)
-        dsl_data  = self.new(controller)._eval_dsl(&block)
+        dsl_data  = self.new(controller)._apipie_eval_dsl(&block)
         if dsl_data[:api_versions].empty?
           dsl_data[:api_versions] = Apipie.controller_versions(controller)
         end

data/lib/apipie/method_description.rb

@@ -65,6 +65,10 @@ module Apipie
       params_ordered.reduce(ActiveSupport::OrderedHash.new) { |h,p| h[p.name] = p; h }
     end
 
+    def params_ordered_self
+      @params_ordered
+    end
+
     def params_ordered
       all_params = []
       parent = Apipie.get_resource_description(@resource.controller.superclass)

data/lib/apipie/param_description.rb

@@ -21,6 +21,19 @@ module Apipie
                                    &block)
     end
 
+    def to_s
+      "ParamDescription: #{method_description.id}##{name}"
+    end
+
+    def ==(other)
+      return false unless self.class == other.class
+      if method_description == other.method_description && @options == other.options
+        true
+      else
+        false
+      end
+    end
+
     def initialize(method_description, name, validator, desc_or_options = nil, options = {}, &block)
 
       if desc_or_options.is_a?(Hash)
@@ -146,7 +159,7 @@ module Apipie
       self
     end
 
-    # merge param descripsiont. Allows defining hash params on more places
+    # merge param descriptions. Allows defining hash params on more places
     # (e.g. in param_groups). For example:
     #
     #     def_param_group :user do

data/lib/apipie/validator.rb

@@ -13,6 +13,16 @@ module Apipie
         @param_description = param_description
       end
 
+      def inspected_fields
+        [:param_description]
+      end
+
+      def inspect
+        string = "#<#{self.class.name}:#{self.object_id} "
+        fields = inspected_fields.map {|field| "#{field}: #{self.send(field)}"}
+        string << fields.join(", ") << ">"
+      end
+
       def self.inherited(subclass)
         @validators ||= []
         @validators.insert 0, subclass
@@ -67,13 +77,22 @@ module Apipie
       end
 
       def merge_with(other_validator)
-        raise NotImplementedError, "Dont know how to merge #{self.inspect} with #{other_validator.inspect}"
+        return self if self == other_validator
+        raise NotImplementedError, "Don't know how to merge #{self.inspect} with #{other_validator.inspect}"
       end
 
       def params_ordered
         nil
       end
 
+      def ==(other)
+        return false unless self.class == other.class
+        if param_description == other.param_description
+          true
+        else
+          false
+        end
+      end
     end
 
     # validate arguments type

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/lib/tasks/apipie.rake

@@ -100,17 +100,14 @@ namespace :apipie do
   # Attempt to use the Rails application views, otherwise default to built in views
   def renderer
     return @apipie_renderer if @apipie_renderer
-    base_path = if File.directory?("#{Rails.root}/app/views/apipie/apipies")
-                  "#{Rails.root}/app/views/apipie/apipies"
-                else
-                  File.expand_path("../../../app/views/apipie/apipies", __FILE__)
-                end
-    layouts_path = if File.directory?("#{Rails.root}/app/views/layouts/apipie")
-                     "#{Rails.root}/app/views/layouts"
-                   else
-                     File.expand_path("../../../app/views/layouts", __FILE__)
-                   end
-    @apipie_renderer = ActionView::Base.new([base_path, layouts_path])
+
+    base_paths = [File.expand_path("../../../app/views/apipie/apipies", __FILE__)]
+    base_paths.unshift("#{Rails.root}/app/views/apipie/apipies") if File.directory?("#{Rails.root}/app/views/apipie/apipies")
+
+    layouts_paths = [File.expand_path("../../../app/views/layouts", __FILE__)]
+    layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie")
+
+    @apipie_renderer = ActionView::Base.new(base_paths + layouts_paths)
     @apipie_renderer.singleton_class.send(:include, ApipieHelper)
     return @apipie_renderer
   end

data/spec/controllers/extended_controller_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe ExtendedController do
+
+  it 'should include params from both original controller and extending concern' do
+    user_param = Apipie["extended#create"].params[:user]
+    expect(user_param.validator.params_ordered.map(&:name)).to eq [:name, :password, :from_concern]
+  end
+end
+

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

@@ -0,0 +1,11 @@
+module Concerns
+  module ExtendingConcern
+    extend Apipie::DSL::Concern
+
+    update_api(:create) do
+      param :user, Hash do
+        param :from_concern, String, :desc => 'param from concern', :allow_nil => false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+class ExtendedController < ApplicationController
+
+  api :POST, '/extended'
+  param :user, Hash do
+    param :name, String
+    param :password, String
+  end
+  def create
+  end
+
+  include Concerns::ExtendingConcern
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -225,6 +225,7 @@ files:
 - spec/controllers/api/v2/nested/resources_controller_spec.rb
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
+- spec/controllers/extended_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -235,8 +236,10 @@ files:
 - 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/extending_concern.rb
 - spec/dummy/app/controllers/concerns/sample_controller.rb
 - spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/extended_controller.rb
 - spec/dummy/app/controllers/files_controller.rb
 - spec/dummy/app/controllers/overridden_concerns_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
@@ -299,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool
@@ -309,6 +312,7 @@ test_files:
 - spec/controllers/api/v2/nested/resources_controller_spec.rb
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
+- spec/controllers/extended_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -319,8 +323,10 @@ test_files:
 - 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/extending_concern.rb
 - spec/dummy/app/controllers/concerns/sample_controller.rb
 - spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/extended_controller.rb
 - spec/dummy/app/controllers/files_controller.rb
 - spec/dummy/app/controllers/overridden_concerns_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 5.0'
-gem 'mime-types', '~> 2.99.3'
-gem 'rails-controller-testing'