brick 1.0.105 → 1.0.106

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48fc69654d7cbdf5c7feb9ba7803b7a953c6c0ccd3c176614fe9a61994bb39e1
-  data.tar.gz: f3a4837d334cf97cb491cacd658cb6e6d8e3f3a5c640f80c151a083bf6811b7a
+  metadata.gz: 988907627ce35c257a41cbcf4b455ec852c9635fe4f8721c5af167e416fbb4ef
+  data.tar.gz: c4a2fe612aa26a628f347d830197f961cf21b67c825ff968fa589e6bd342d1d7
 SHA512:
-  metadata.gz: e51134710bae78f033b9dcf7827cd7c087cfd642ef8bc6244e2429f22158a80e9f804022bc703f55fa55f85cbc009ff25440289205ade1b415f5ba0af3d44c77
-  data.tar.gz: d6069676ad70e8401f7597b92b641f0f95e3c28fffa54747f630932500c778d7b4ac967c5bbd70059647d11d398598362d9c0bb5c82ef0500b1025371104a578
+  metadata.gz: 3488a28db2bf8f3c7f363e9b2eb4355e9de2d4021db9a39fb45656f896046bee412a7fd310861f522915bbc244af35a2707005757357ee6b9f9877ea331e7240
+  data.tar.gz: 8a44cbbadde246520b028d0e474226cdf2d43e8d51bed023e20f21a0d5b6cc0e690a397908bcdbdb9b7ef21c7743bec64130258b859d1583b6c0facffd8edf5f

data/lib/brick/config.rb

@@ -95,20 +95,19 @@ module Brick
     end
 
     def api_roots
-      ver = api_version
-      @mutex.synchronize { @api_roots || ["/api/#{ver}/"] }
+      @mutex.synchronize { @api_roots || ["/api/v1/"] }
     end
 
     def api_roots=(path)
       @mutex.synchronize { @api_roots = path }
     end
 
-    def api_version
-      @mutex.synchronize { @api_version || 'v1' }
+    def api_filter
+      @mutex.synchronize { @api_filter }
     end
 
-    def api_version=(ver)
-      @mutex.synchronize { @api_version = ver }
+    def api_filter=(proc)
+      @mutex.synchronize { @api_filter = proc }
     end
 
     # Additional table associations to use (Think of these as virtual foreign keys perhaps)

data/lib/brick/extensions.rb

@@ -1526,9 +1526,10 @@ class Object
         self.protect_from_forgery unless: -> { self.request.format.js? }
         unless is_avo
           self.define_method :index do
+            request_ver = request.path.split('/')[-2]
             current_api_root = ::Brick.config.api_roots.find do |ar|
               request.path.start_with?(ar) || # Exact match?
-              request.path.split('/')[-2] == ar.split('/').last # Version at least matches?
+              request_ver == ar.split('/').last # Version at least matches?
             end
             if (current_api_root || is_openapi) &&
                !params&.key?('_brick_schema') &&
@@ -1542,51 +1543,63 @@ class Object
             _schema, @_is_show_schema_list = ::Brick.set_db_schema(params || api_params)
 
             if is_openapi
+              api_name = Rswag::Ui.config.config_object[:urls].find do |api_url|
+                api_url[:url] == request.path
+              end&.fetch(:name, 'API documentation')
               current_api_ver = current_api_root.split('/').last&.[](1..-1).to_i
-              json = { 'openapi': '3.0.1', 'info': { 'title': Rswag::Ui.config.config_object[:urls].last&.fetch(:name, 'API documentation'), 'version': ::Brick.config.api_version },
+              json = { 'openapi': '3.0.1', 'info': { 'title': api_name, 'version': request_ver },
                        'servers': [
-                         { 'url': '{scheme}://{defaultHost}', 'variables': {
-                           'scheme': { 'default': request.env['rack.url_scheme'] },
-                           'defaultHost': { 'default': request.env['HTTP_HOST'] }
-                         } }
+                         { 'url': '{scheme}://{defaultHost}',
+                           'variables': {
+                             'scheme': { 'default': request.env['rack.url_scheme'] },
+                             'defaultHost': { 'default': request.env['HTTP_HOST'] }
+                           }
+                         }
                        ]
                      }
-              json['paths'] = relations.each_with_object({}) do |relation, s|
-                unless ::Brick.config.enable_api == false
+              unless ::Brick.config.enable_api == false
+                json['paths'] = relations.each_with_object({}) do |relation, s|
                   next if (api_vers = relation.last.fetch(:api, nil)) &&
-                          !(api_ver_path = api_vers[current_api_ver])
-
-                  relation_name = api_ver_path || relation.first.tr('.', '/')
-                  table_description = relation.last[:description]
-                  s["#{current_api_root}#{relation_name}"] = {
-                    'get': {
-                      'summary': "list #{relation.first}",
-                      'description': table_description,
-                      'parameters': relation.last[:cols].map do |k, v|
-                                      param = { in: 'query', 'name' => k, 'schema': { 'type': v.first } }
-                                      if (col_descrip = relation.last.fetch(:col_descrips, nil)&.fetch(k, nil))
-                                        param['description'] = col_descrip
-                                      end
-                                      param
-                                    end,
-                      'responses': { '200': { 'description': 'successful' } }
-                    }
-                  }
-
-                  s["#{current_api_root}#{relation_name}/{id}"] = {
-                    'patch': {
-                      'summary': "update a #{relation.first.singularize}",
-                      'description': table_description,
-                      'parameters': relation.last[:cols].reject { |k, v| Brick.config.metadata_columns.include?(k) }.map do |k, v|
-                        param = { 'name' => k, 'schema': { 'type': v.first } }
-                        if (col_descrip = relation.last.fetch(:col_descrips, nil)&.fetch(k, nil))
-                          param['description'] = col_descrip
-                        end
-                        param
-                      end,
-                      'responses': { '200': { 'description': 'successful' } }
-                    }
-                  } unless relation.last.fetch(:isView, nil)
+                          !(api_ver_paths = api_vers[current_api_ver])
+
+                  # binding.pry if relation.last.fetch(:isView, nil) && api_ver_paths != { relation.first => ::Brick::ALL_API_ACTIONS }
+                  (api_ver_paths || { relation.first => ::Brick::ALL_API_ACTIONS }).each do |api_ver_path, actions|
+                    relation_name = api_ver_path || relation.first.tr('.', '/')
+                    table_description = relation.last[:description]
+                    unless actions&.exclude?(:index)
+                      s["#{current_api_root}#{relation_name}"] = {
+                        'get': {
+                          'summary': "list #{relation.first}",
+                          'description': table_description,
+                          'parameters': relation.last[:cols].map do |k, v|
+                                          param = { in: 'query', 'name' => k, 'schema': { 'type': v.first } }
+                                          if (col_descrip = relation.last.fetch(:col_descrips, nil)&.fetch(k, nil))
+                                            param['description'] = col_descrip
+                                          end
+                                          param
+                                        end,
+                          'responses': { '200': { 'description': 'successful' } }
+                        }
+                      }
+                    end
+
+                    unless actions&.exclude?(:update)
+                      s["#{current_api_root}#{relation_name}/{id}"] = {
+                        'patch': {
+                          'summary': "update a #{relation.first.singularize}",
+                          'description': table_description,
+                          'parameters': relation.last[:cols].reject { |k, v| Brick.config.metadata_columns.include?(k) }.map do |k, v|
+                            param = { 'name' => k, 'schema': { 'type': v.first } }
+                            if (col_descrip = relation.last.fetch(:col_descrips, nil)&.fetch(k, nil))
+                              param['description'] = col_descrip
+                            end
+                            param
+                          end,
+                          'responses': { '200': { 'description': 'successful' } }
+                        }
+                      } unless relation.last.fetch(:isView, nil)
+                    end
+                  end # Do multiple api_ver_paths
                 end
               end
               render inline: json.to_json, content_type: request.format
@@ -1600,11 +1613,11 @@ class Object
               end
               render inline: exported_csv, content_type: request.format
               return
-            elsif request.format == :js || current_api_root # Asking for JSON?
-              # %%% Add:  where, order, page, page_size, offset, limit
-              data = (model.is_view? || !Object.const_defined?('DutyFree')) ? model.limit(1000) : model.df_export(model.brick_import_template)
-              render inline: { data: data }.to_json, content_type: request.format == '*/*' ? 'application/json' : request.format
-              return
+            # elsif request.format == :js || current_api_root # Asking for JSON?
+            #   # %%% Add:  where, order, page, page_size, offset, limit
+            #   data = (model.is_view? || !Object.const_defined?('DutyFree')) ? model.limit(1000) : model.df_export(model.brick_import_template)
+            #   render inline: { data: data }.to_json, content_type: request.format == '*/*' ? 'application/json' : request.format
+            #   return
             end
 
             # Normal (not swagger or CSV) request
@@ -1616,8 +1629,15 @@ class Object
 
             ar_relation = ActiveRecord.version < Gem::Version.new('4') ? model.preload : model.all
             @_brick_params = ar_relation.brick_select(params, (selects ||= []), order_by,
-                                                               translations = {},
-                                                               join_array = ::Brick::JoinArray.new)
+                                                      translations = {},
+                                                      join_array = ::Brick::JoinArray.new)
+
+            if request.format == :js || current_api_root # Asking for JSON?
+              data = ar_relation.respond_to?(:_select!) ? ar_relation.dup._select!(*selects) : ar_relation.select(selects)
+              render inline: { data: data }.to_json, content_type: request.format == '*/*' ? 'application/json' : request.format
+              return
+            end
+
             # %%% Add custom HM count columns
             # %%% What happens when the PK is composite?
             counts = model._br_hm_counts.each_with_object([]) do |v, s|
@@ -2127,7 +2147,7 @@ ORDER BY 1, 2, c.internal_column_id, acc.position"
           # AND kcu2.TABLE_NAME = ?;", Apartment::Tenant.current, table_name
         fk_references = ActiveRecord::Base.execute_sql(sql)
       when 'SQLite'
-        sql = "SELECT m.name, fkl.\"from\", fkl.\"table\", m.name || '_' || fkl.\"from\" AS constraint_name
+        sql = "SELECT NULL AS constraint_schema, m.name, fkl.\"from\", NULL AS primary_schema, fkl.\"table\", m.name || '_' || fkl.\"from\" AS constraint_name
         FROM sqlite_master m
           INNER JOIN pragma_foreign_key_list(m.name) fkl ON m.type = 'table'
         ORDER BY m.name, fkl.seq"

data/lib/brick/version_number.rb

@@ -5,7 +5,7 @@ module Brick
   module VERSION
     MAJOR = 1
     MINOR = 0
-    TINY = 105
+    TINY = 106
 
     # PRE is nil unless it's a pre-release (beta, RC, etc.)
     PRE = nil

data/lib/brick.rb

@@ -124,6 +124,8 @@ if Gem::Specification.all_names.any? { |g| g.start_with?('rails-') }
   require 'brick/frameworks/rails'
 end
 module Brick
+  ALL_API_ACTIONS = [:index, :show, :create, :update, :destroy]
+
   class << self
     def sti_models
       @sti_models ||= {}
@@ -347,6 +349,16 @@ module Brick
       Brick.config.api_roots
     end
 
+    # @api public
+    def api_filter=(proc)
+      Brick.config.api_filter = proc
+    end
+
+    # @api public
+    def api_filter
+      Brick.config.api_filter
+    end
+
     # @api public
     def skip_database_views=(value)
       Brick.config.skip_database_views = value
@@ -675,6 +687,7 @@ In config/initializers/brick.rb appropriate entries would look something like:
               api_done_views = (versioned_views[api_root] ||= {})
               found = nil
               view_relation = nil
+              actions = ::Brick::ALL_API_ACTIONS # By default all actions are allowed
               # If it's a view then see if there's a versioned one available by searching for resource names
               # versioned with the closest number (equal to or less than) compared with our API version number.
               if v.key?(:isView) && (ver = k.match(/^v([\d_]*)/).captures.first)[-1] == '_'
@@ -687,15 +700,15 @@ In config/initializers/brick.rb appropriate entries would look something like:
                 api_ver = api_root.split('/')[-1]&.gsub('_', '.')
                 vn_idx = api_ver.rindex(/[^\d._]/) # Position of the first numeric digit at the end of the version number
                 # Was:  .to_d
-                api_ver_num = api_ver[vn_idx + 1..-1].gsub('_', '.').to_i # Attempt to turn something like "v3" into the decimal value 3
+                test_ver_num = api_ver_num = api_ver[vn_idx + 1..-1].gsub('_', '.').to_i # Attempt to turn something like "v3" into the decimal value 3
                 # puts [api_ver, vn_idx, api_ver_num, unversioned].inspect
 
                 next if ver.to_i > api_ver_num # Don't surface any newer views in an older API
 
-                api_ver_num -= 1 until api_ver_num.zero? ||
-                                       (view_relation = ::Brick.relations.fetch(
-                                         found = "v#{api_ver_num}_#{k[ver.length + 1..-1]}", nil
-                                       ))
+                test_ver_num -= 1 until test_ver_num.zero? ||
+                                        (view_relation = ::Brick.relations.fetch(
+                                         found = "v#{test_ver_num}_#{k[ver.length + 1..-1]}", nil
+                                        ))
                 api_done_views[unversioned] = nil # Mark that for this API version this view is done
 
                 # puts "Found #{found}" if view_relation
@@ -705,21 +718,69 @@ In config/initializers/brick.rb appropriate entries would look something like:
                 view_relation ||= ::Brick.relations.fetch(found = unversioned,
                                                           ::Brick.relations.fetch(found = unversioned, nil)
                                                          )
-                if found && view_relation && k != (found = unversioned)
-                  view_relation[:api][api_ver_num] = found
+                if found && view_relation && k != unversioned
+                  # Call proc that limits which endpoints get surfaced based on version, table or view name, method (get list / get one / post / patch / delete)
+                  # Returning nil makes it do nothing, false makes it skip creating this endpoint, and an array of up to
+                  # these 3 things controls and changes the nature of the endpoint that gets built:
+                  # (updated api_name, name of different relation to route to, allowed actions such as :index, :show, :create, etc)
+                  proc_result = if (filter = ::Brick.config.api_filter).is_a?(Proc)
+                                  begin
+                                    filter.call(unversioned, k, actions, api_ver_num, found, test_ver_num)
+                                  rescue StandardError => e
+                                    puts "::Brick.api_filter Proc error: #{e.message}"
+                                  end
+                                end
+                  # proc_result expects to receive back: [updated_api_name, to_other_relation, allowed_actions]
+
+                  case proc_result
+                  when NilClass
+                    # Do nothing differently than what normal behaviour would be
+                  when FalseClass # Skip implementing this endpoint
+                    view_relation[:api][api_ver_num] = nil
+                    next
+                  when Array # Did they give back an array of actions?
+                    unless proc_result.any? { |pr| ::Brick::ALL_API_ACTIONS.exclude?(pr) }
+                      proc_result = [unversioned, to_relation, proc_result]
+                    end
+                    # Otherwise don't change this array because it's probably legit
+                  when String
+                    proc_result = [proc_result] # Treat this as the surfaced api_name (path) they want to use for this endpoint
+                  else
+                    puts "::Brick.api_filter Proc warning: Unable to parse this result returned: \n  #{proc_result.inspect}"
+                    proc_result = nil # Couldn't understand what in the world was returned
+                  end
+
+                  if proc_result&.present?
+                    if proc_result[1] # to_other_relation
+                      if (new_view_relation = ::Brick.relations.fetch(proc_result[1], nil))
+                        k = proc_result[1] # Route this call over to this different relation
+                        view_relation = new_view_relation
+                      else
+                        puts "::Brick.api_filter Proc warning: Unable to find new suggested relation with name #{proc_result[1]} -- sticking with #{k} instead."
+                      end
+                    end
+                    if proc_result.first&.!=(k) # updated_api_name -- a different name than this relation would normally have
+                      found = proc_result.first
+                    end
+                    actions &= proc_result[2] if proc_result[2] # allowed_actions
+                  end
                 end
+                (view_relation[:api][api_ver_num] ||= {})[found] = actions # Add to the list of API paths this resource responds to
               end
 
               # view_ver_num = if (first_part = k.split('_').first) =~ /^v[\d_]+/
               #                  first_part[1..-1].gsub('_', '.').to_i
               #                end
               controller_name = view_relation.fetch(:resource, nil)&.pluralize if view_relation
-              if schema_name
-                full_resource = "#{schema_name}/#{found || v[:resource]}"
-                send(:get, "#{api_root}#{full_resource}", { to: "#{controller_prefix}#{schema_name}/#{controller_name}#index" })
-              else
-                # Normally goes to something like:  /api/v1/employees
-                send(:get, "#{api_root}#{found || v[:resource]}", { to: "#{controller_prefix}#{controller_name}#index" })
+              # %%% So far we can only surface the #index action
+              if actions.include?(:index)
+                if schema_name
+                  full_resource = "#{schema_name}/#{found || v[:resource]}"
+                  send(:get, "#{api_root}#{full_resource}", { to: "#{controller_prefix}#{schema_name}/#{controller_name}#index" })
+                else
+                  # Normally goes to something like:  /api/v1/employees
+                  send(:get, "#{api_root}#{found || v[:resource]}", { to: "#{controller_prefix}#{controller_name}#index" })
+                end
               end
             end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.105
+  version: 1.0.106
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-17 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: rswag-ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement