ree_lib 1.3.8 → 1.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91fc8dfb82375a041a8174ecb6845cc67b808ff127789f7a0cfc7acf77dd070d
-  data.tar.gz: 9559a1c0ab2a12444b80321ffeee129104eb50e3ab18b1245190747eec34e168
+  metadata.gz: 237cf0a00005f59af6c0741f79302159d84433b60b63e401baa4ae95ab0dd2ae
+  data.tar.gz: f9c00515a41e9d78fc2c3ac1785d5a8a21d1f4142461537299e4c1678d4a6b61
 SHA512:
-  metadata.gz: 043c917b9aedca9ead3eda2ebf43e1ad5404abf818b6a8aa63fc2827b677ad850785c4ebdb46b135e1f9967bb1cc66b04524b0124d6ea5218cabee98b348e90e
-  data.tar.gz: ca3d90247859cb1dde09162aa2e3479f6e9cacc038ea8b083bda2fa9704015314cce9b39154d639b0c60f9caf1f0268dd3c89bfc383e999f556b66193225ed64
+  metadata.gz: c712530b729aa1e48d53de393ee737b7605c233108940e78f09f4561c36b69c413136880f8b72f73f694d4a6ac5ee7e4010d2d46ff2dcdb30450ad1fd2bb9a56
+  data.tar.gz: e148d3f589e0c2863a9b1958d903458407c1646f0fca6ca79c5fb0839893c0bc00059b4a80a9c0b45cf6710e4e9b6802f6a94ee9b8958fa485701164cd99a240

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../ree
   specs:
-    ree (1.3.2)
+    ree (1.3.3)
       base64
       commander
       logger
@@ -9,7 +9,7 @@ PATH
 PATH
   remote: .
   specs:
-    ree_lib (1.3.8)
+    ree_lib (1.3.9)
       bigdecimal
       binding_of_caller
       i18n

data/lib/ree_lib/packages/ree_roda/package/ree_roda/plugins/ree_routes.rb

@@ -17,7 +17,8 @@ class Roda
 
       module ClassMethods
         def ree_routes(routes, swagger_title: "", swagger_description: "",
-                        swagger_version: "", swagger_url: "", api_url: "")
+                        swagger_version: "", swagger_url: "", api_url: "",
+                        swagger_include_internal: nil)
           @ree_routes ||= []
           @ree_routes += routes
 
@@ -27,12 +28,17 @@ class Roda
           opts[:ree_routes_swagger_url] = swagger_url
           opts[:ree_routes_api_url] = api_url
 
+          # nil keeps the global default (Ree.hide_internal_swagger_endpoints);
+          # pass true/false to force one app to differ from it.
+          swagger_opts = swagger_include_internal.nil? ? {} : { include_internal: swagger_include_internal }
+
           opts[:ree_routes_swagger] = ReeRoda::BuildSwaggerFromRoutes.new.call(
             @ree_routes,
             opts[:ree_routes_swagger_title],
             opts[:ree_routes_swagger_description],
             opts[:ree_routes_swagger_version],
-            opts[:ree_routes_api_url]
+            opts[:ree_routes_api_url],
+            **swagger_opts
           )
 
           build_routes_proc

data/lib/ree_lib/packages/ree_roda/package/ree_roda/services/build_swagger_from_routes.rb

@@ -7,8 +7,19 @@ class ReeRoda::BuildSwaggerFromRoutes
     link "ree_swagger/dto/endpoint_dto", -> { EndpointDto }
   end
 
-  contract(ArrayOf[ReeRoutes::Route], String, String, String, String => Hash)
-  def call(routes, title, description, version, api_url)
+  contract(
+    ArrayOf[ReeRoutes::Route], String, String, String, String,
+    Ksplat[include_internal?: Bool] => Hash
+  )
+  def call(routes, title, description, version, api_url, **opts)
+    # Defaults to the global switch (see Ree.hide_internal_swagger_endpoints),
+    # so one codebase can serve a public and an internal document.
+    include_internal = opts.fetch(:include_internal) {
+      !Ree.hide_internal_swagger_endpoints?
+    }
+
+    routes = routes.select(&:public?) if !include_internal
+
     endpoints = routes.map do |route|
       method_decorator = Ree::Contracts.get_method_decorator(
         route.action.klass, :call, scope: :instance

data/lib/ree_lib/packages/ree_routes/package/ree_routes/dsl.rb

@@ -24,6 +24,8 @@ module ReeRoutes
       include Ree::Contracts::Core
       include Ree::Contracts::ArgContracts
 
+      ADMIN_PATH_SEGMENT = "admin"
+
       def routes(name, &proc)
         raise ArgumentError.new("block is required") if !block_given?
 
@@ -87,6 +89,14 @@ module ReeRoutes
           raise ArgumentError.new("action, summary and auth scope should be provided for #{builder.get_route.inspect}")
         end
 
+        if builder.get_route.visibility.nil? && admin_path?(path)
+          raise ArgumentError.new(
+            "admin route #{path} must declare visibility explicitly: " \
+            "`visibility :internal` to keep it out of generated swagger, " \
+            "or `visibility :public` if it is intentionally documented"
+          )
+        end
+
         route = builder.get_route
 
         @dsl.link(route.action.name, from: route.action.package_name)
@@ -98,6 +108,13 @@ module ReeRoutes
         @routes << route
         route
       end
+
+      # Forgetting `visibility` on an admin route is invisible in review and
+      # silently publishes it, so make it a boot-time failure instead.
+      contract String => Bool
+      def admin_path?(path)
+        path.split("/").include?(ADMIN_PATH_SEGMENT)
+      end
     end
   end
 end

data/lib/ree_lib/packages/ree_routes/package/ree_routes/route.rb

@@ -2,7 +2,17 @@
 
 class ReeRoutes::Route
   attr_accessor :summary, :request_method, :serializer, :respond_to,
-                :sections, :action, :route, :warden_scopes, :path, :override
+                :sections, :action, :route, :warden_scopes, :path, :override,
+                :visibility
+
+  # Routing always includes every route; visibility only affects generated docs.
+  def public?
+    visibility.nil? || visibility == :public
+  end
+
+  def internal?
+    !public?
+  end
 
   def valid?
     !action.nil? && !summary.nil? && !warden_scopes.nil? && !warden_scopes.empty?

data/lib/ree_lib/packages/ree_routes/package/ree_routes/route_builder.rb

@@ -5,6 +5,8 @@ require_relative "route"
 class ReeRoutes::RouteBuilder
   Redirect = Struct.new(:path, :code)
 
+  VISIBILITIES = [:public, :internal].freeze
+
   def initialize
     @route = ReeRoutes::Route.new
     @route.respond_to = :json
@@ -42,6 +44,17 @@ class ReeRoutes::RouteBuilder
     @route.summary = str
   end
 
+  contract Symbol => Symbol
+  def visibility(value)
+    if !VISIBILITIES.include?(value)
+      raise ArgumentError.new(
+        "visibility should be one of #{VISIBILITIES.inspect}, got #{value.inspect}"
+      )
+    end
+
+    @route.visibility = value
+  end
+
   contract Symbol, Symbol => nil
   def serializer(name, from:)
     object = Ree.container.packages_facade.get_object(from, name)

data/lib/ree_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReeLib
-  VERSION = "1.3.8"
+  VERSION = "1.3.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.3.9
 platform: ruby
 authors:
 - Ruslan Gatiyatov