apipie-rails 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a785ca04175c3a876a939d72f3d64c290e74659a
-  data.tar.gz: b2ad5080125c58f0f7d18e0b53d1c916fe1d9cb7
+  metadata.gz: 8915141fab6f8b930ebe4890f87cad11794dc480
+  data.tar.gz: 8e1fe85abcdc7e18817d6e03f0b0566b2d2bac2d
 SHA512:
-  metadata.gz: a9650f7f0ee8c59d9458db87fda68ab987dda7dc20a0d75999e6c801640e5685d43a5e25ca7e7788002e88d261ed6bcb8e653edb17a16edc89a92282e8832c96
-  data.tar.gz: 7e403f89361d3bc90cd62e5fd2a8eb6f4b62b92024adf9acb7cab7baebe44797cf092b3eb4bdb6cf8aadf09447dd5bf39fd22a792738ebd81eb8024389b4279e
+  metadata.gz: 3a312452202fa6f494703fc5a4949b928bbc40bf541072b49f1107302cd96563d5351f6a0986a6c7406f1e7eaabda680da5f84b609108b3df1c3ec4c8245602f
+  data.tar.gz: 38bcb49374e3046661a2a4f5ce479e52225a0f1cd880388c069eb00dd2f9c4bf514a0e72cb5cfd1e38d2166ccf458639510026871fe5fad2254b4779d9f55d04

data/CHANGELOG.md

@@ -1,6 +1,12 @@
  Changelog
 ===========
 
+v0.5.5
+------
+
+- prevent lang in url when config.translate is false [\##562](https://github.com/Apipie/apipie-rails/pull/562) ([markmoser](https://github.com/markmoser))
+- Allow for resource-level deprecations [\##567](https://github.com/Apipie/apipie-rails/pull/567) ([cross-p6](https://github.com/cross-p6))
+
 v0.5.4
 ------
 

data/README.rst

@@ -136,6 +136,9 @@ app_info
 meta
   Hash or array with custom metadata.
 
+deprecated
+  Boolean value indicating if the resource is marked as deprecated. (Default false)
+
 Example:
 ~~~~~~~~
 
@@ -154,6 +157,7 @@ Example:
      error 500, "Server crashed for some <%= reason %>", :meta => {:anything => "you can think of"}
      error :unprocessable_entity, "Could not save the entity."
      meta :author => {:name => 'John', :surname => 'Doe'}
+     deprecated false
      description <<-EOS
        == Long description
         Example resource for rest api documentation

data/app/controllers/apipie/apipies_controller.rb

@@ -79,6 +79,7 @@ module Apipie
     helper_method :heading
 
     def get_language
+      return nil unless Apipie.configuration.translate
       lang = Apipie.configuration.default_locale
       [:resource, :method, :version].each do |par|
         if params[par]

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

@@ -16,7 +16,11 @@
   <h2>
     <a href='<%= api[:doc_url] %><%= @doc[:link_extension] %>'>
       <%= api[:name] %>
-    </a><br>
+    </a>
+    <% if api[:deprecated] %>
+        <code>DEPRECATED</code>
+    <% end %>
+    <br>
     <small><%= api[:short_description] %></small>
   </h2>
   <table class='table'>

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

@@ -13,6 +13,9 @@
 <div class='page-header'>
   <h1>
     <%= @resource[:name] %>
+    <% if @resource[:deprecated] %>
+        <code>DEPRECATED</code>
+    <% end %>
     <br>
     <small><%= raw @resource[:short_description] %></small>
   </h1>

data/lib/apipie/dsl_definition.rb

@@ -42,7 +42,8 @@ module Apipie
          :formats           => nil,
          :api_versions      => [],
          :meta              => nil,
-         :show              => true
+         :show              => true,
+         :deprecated        => false
        }
       end
     end
@@ -76,6 +77,11 @@ module Apipie
       def app_info(app_info)
         _apipie_dsl_data[:app_info] = app_info
       end
+
+      def deprecated(value)
+        _apipie_dsl_data[:deprecated] = value
+      end
+
     end
 
     module Action

data/lib/apipie/method_description.rb

@@ -129,7 +129,7 @@ module Apipie
           :api_url => create_api_url(api),
           :http_method => api.http_method.to_s,
           :short_description => Apipie.app.translate(api.short_description, lang),
-          :deprecated => api.options[:deprecated]
+          :deprecated => resource._deprecated || api.options[:deprecated]
         }
       end
     end

data/lib/apipie/resource_description.rb

@@ -10,11 +10,12 @@ module Apipie
   # id - resouce name
   # formats - acceptable request/response format types
   # headers - array of headers
+  # deprecated - boolean indicating if resource is deprecated
   class ResourceDescription
 
     attr_reader :controller, :_short_description, :_full_description, :_methods, :_id,
       :_path, :_name, :_params_args, :_errors_args, :_formats, :_parent, :_metadata,
-      :_headers
+      :_headers, :_deprecated
 
     def initialize(controller, resource_name, dsl_data = nil, version = nil, &block)
 
@@ -42,6 +43,7 @@ module Apipie
       @_metadata = dsl_data[:meta]
       @_api_base_url = dsl_data[:api_base_url]
       @_headers = dsl_data[:headers]
+      @_deprecated = dsl_data[:deprecated] || false
 
       if dsl_data[:app_info]
         Apipie.configuration.app_info[_version] = dsl_data[:app_info]
@@ -109,7 +111,8 @@ module Apipie
         :formats => @_formats,
         :metadata => @_metadata,
         :methods => methods,
-        :headers => _headers
+        :headers => _headers,
+        :deprecated => @_deprecated
       }
     end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'
 end

data/spec/lib/method_description_spec.rb

@@ -36,6 +36,13 @@ describe Apipie::MethodDescription do
       method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
       expect(method.method_apis_to_json.first[:deprecated]).to eq(true)
     end
+
+    it "should return the deprecated flag if resource is deprecated" do
+      @resource.instance_variable_set("@_deprecated", true)
+      dsl_data[:api_args] = [[:GET, "/foo/bar", "description", {}]]
+      method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      expect(method.method_apis_to_json.first[:deprecated]).to eq(true)
+    end
   end
 
   describe "params descriptions" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails