ree_lib 1.3.7 → 1.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c9b3f24637ea89df5a633bb65b00165bdcf89193dc870cacd6521ead772c5a
-  data.tar.gz: fa3c84478540381ba0dba7046bf41dc472e3de75fed7bc99b53e78cddc14de4c
+  metadata.gz: 237cf0a00005f59af6c0741f79302159d84433b60b63e401baa4ae95ab0dd2ae
+  data.tar.gz: f9c00515a41e9d78fc2c3ac1785d5a8a21d1f4142461537299e4c1678d4a6b61
 SHA512:
-  metadata.gz: 7f7c74ea3f1d7a72b9c61dc8ddf2291dc4493a863c89cbda641f42ffbb8a505b5fe7537cb2d39bb03c65fc805350a3d5788c68b77e5a86a05dbbc70061f077c3
-  data.tar.gz: 8ad1a702714b65592c6c37f932d22d86727263240faa64e3b23c48a2b330d7f2cfab37c162bdb8d9ad0edb0b9e004871f0ae266dbfc0d1097f4899239c31a5e7
+  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.6)
+    ree_lib (1.3.9)
       bigdecimal
       binding_of_caller
       i18n

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

@@ -11,14 +11,18 @@ class Roda
     module ReeLogger
       REE_LOGGER_DEFAULTS = {
         method: :info,
-        log_params: true
+        log_params: true,
+        filter_params: [],
+        filter_params_placeholder: '[FILTERED]'
       }
 
       def self.configure(app, **opts)
         opts = REE_LOGGER_DEFAULTS.merge(opts)
-        app.opts[:ree_logger] = ::ReeLogger::Logger.new
+        app.opts[:ree_logger] = opts[:ree_logger] || ::ReeLogger::Logger.new
         app.opts[:ree_logger_filter] = opts[:filter] if opts[:filter]
         app.opts[:ree_logger_log_params] = !!opts[:log_params]
+        app.opts[:ree_logger_filter_params] = opts[:filter_params].map(&:to_s)
+        app.opts[:ree_logger_filter_params_placeholder] = opts[:filter_params_placeholder]
       end
 
       def self.start_timer
@@ -46,7 +50,7 @@ class Roda
 
           message = <<~DOC
             Request/Response details:
-              Request: #{env["REQUEST_METHOD"]} #{env["QUERY_STRING"] && !env["QUERY_STRING"].empty? ? env["SCRIPT_NAME"].to_s + env["PATH_INFO"] + "?#{env["QUERY_STRING"]}": env["SCRIPT_NAME"].to_s + env["PATH_INFO"]} #{opts[:ree_logger_log_params] ? "\n  Params: " + request.params.inspect : ""}
+              Request: #{env["REQUEST_METHOD"]} #{env["QUERY_STRING"] && !env["QUERY_STRING"].empty? ? env["SCRIPT_NAME"].to_s + env["PATH_INFO"] + "?#{env["QUERY_STRING"]}": env["SCRIPT_NAME"].to_s + env["PATH_INFO"]} #{opts[:ree_logger_log_params] ? "\n  Params: " + _ree_logger_filtered_params.inspect : ""}
               Response status: #{response.status || "-"}#{(400..499).include?(response.status) ? "\n  Response body: " + response.body[0].to_s : ""}
               Time Taken: #{elapsed_time}
           DOC
@@ -54,6 +58,19 @@ class Roda
           opts[:ree_logger].info(message)
         end
 
+        def _ree_logger_filtered_params
+          params = request.params
+          filter_keys = opts[:ree_logger_filter_params]
+
+          return params if filter_keys.empty?
+
+          placeholder = opts[:ree_logger_filter_params_placeholder]
+
+          params.each_with_object({}) do |(k, v), h|
+            h[k] = filter_keys.include?(k.to_s) ? placeholder : v
+          end
+        end
+
         # Create timer instance used for timing
         def _roda_before_05__ree_logger
           @_request_timer = ReeLogger.start_timer

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_roda/spec/ree_roda/plugins/ree_logger_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal = true
+
+package_require("ree_roda/plugins/ree_logger")
+
+RSpec.describe :ree_logger do
+  it "filters request params" do
+    class TestFilterApp < ReeRoda::App
+      route do |r|
+        r.get "health" do
+          "success"
+        end
+
+        r.ree_routes
+      end
+    end
+
+    env = { "REQUEST_METHOD" => "GET", "PATH_INFO" => "/health", "QUERY_STRING" => "email=test@example.com&password=password" }
+
+    class TestFilterLogger
+      def info(msg)
+        @logs ||= []
+        @logs << msg
+      end
+
+      def logs
+        @logs
+      end
+    end
+    logger = TestFilterLogger.new
+
+    TestFilterApp.plugin(:ree_logger, ree_logger: logger, filter_params: ['password'])
+    TestFilterApp.app.call(env)
+
+    expect(logger.logs.first).to match('"password" => "\[FILTERED\]"')
+  end
+end

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.7"
+  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.7
+  version: 1.3.9
 platform: ruby
 authors:
 - Ruslan Gatiyatov
@@ -891,6 +891,7 @@ files:
 - lib/ree_lib/packages/ree_roda/package/ree_roda/services/build_swagger_from_routes.rb
 - lib/ree_lib/packages/ree_roda/package/ree_roda/services/status_from_error.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/app_spec.rb
+- lib/ree_lib/packages/ree_roda/spec/ree_roda/plugins/ree_logger_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/build_routing_tree_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/build_swagger_from_routes_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/locales/en.yml