brick 1.0.106 → 1.0.107

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 988907627ce35c257a41cbcf4b455ec852c9635fe4f8721c5af167e416fbb4ef
-  data.tar.gz: c4a2fe612aa26a628f347d830197f961cf21b67c825ff968fa589e6bd342d1d7
+  metadata.gz: 74bd7cd6539a5f048aecc3e02be8912e1bc77851ac8b9f65402892e964a024de
+  data.tar.gz: c32c53d0012f2a9292463d803d0c679d4f32800c8931c3361469aa22c09a3fc5
 SHA512:
-  metadata.gz: 3488a28db2bf8f3c7f363e9b2eb4355e9de2d4021db9a39fb45656f896046bee412a7fd310861f522915bbc244af35a2707005757357ee6b9f9877ea331e7240
-  data.tar.gz: 8a44cbbadde246520b028d0e474226cdf2d43e8d51bed023e20f21a0d5b6cc0e690a397908bcdbdb9b7ef21c7743bec64130258b859d1583b6c0facffd8edf5f
+  metadata.gz: f84ee2aae03622a4ca67a6921daf7e975f85601e66fc608c2357613da976414d2ceeec87276887232a832413116ec1495638c883ecc712db3706f51c34efbd44
+  data.tar.gz: e97fbe41eca4d839795f7567bfd3e8a3d6494d4887032fa5f0f87d88ba3c9fdc810bde8a259c3cbf0b8f944c8b345c33290aa5d1e8f7aa67737e7fe7be248a6d

data/lib/brick/extensions.rb

@@ -1560,44 +1560,53 @@ class Object
               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_paths = api_vers[current_api_ver])
+                          !(api_ver_paths = api_vers[current_api_ver] || api_vers[nil])
 
-                  # 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('.', '/')
+                  schema_tag = {}
+                  if (schema_name = relation.last&.fetch(:schema, nil))
+                    schema_tag['tags'] = [schema_name]
+                  end
+                  all_actions = relation.last.key?(:isView) ? [:index, :show] : ::Brick::ALL_API_ACTIONS
+                  (api_ver_paths || { relation.first => all_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}",
+                    { :index => [:get, 'list'], :create => [:post, 'create a'] }.each do |k, v|
+                      unless actions&.exclude?(k)
+                        this_resource = (s["#{current_api_root}#{relation_name}"] ||= {})
+                        this_resource[v.first] = {
+                          'summary': "#{v[1]} #{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))
+                          'parameters': relation.last[:cols].map do |k2, v2|
+                                          param = { in: 'query', 'name': k2, 'schema': { 'type': v2.first } }
+                                          if (col_descrip = relation.last.fetch(:col_descrips, nil)&.fetch(k2, nil))
                                             param['description'] = col_descrip
                                           end
                                           param
                                         end,
                           'responses': { '200': { 'description': 'successful' } }
-                        }
-                      }
+                        }.merge(schema_tag)
+                      end
                     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)
+                    # We have not yet implemented the #show action
+                    if (id_col = relation.last[:pkey]&.values&.first&.first) # ... ID-dependent stuff
+                      { :update => [:patch, 'update'], :destroy => [:delete, 'delete'] }.each do |k, v|
+                        unless actions&.exclude?(k)
+                          this_resource = (s["#{current_api_root}#{relation_name}/{#{id_col}}"] ||= {})
+                          this_resource[v.first] = {
+                            'summary': "#{v[1]} a #{relation.first.singularize}",
+                            'description': table_description,
+                            'parameters': relation.last[:cols].reject { |k1, _v1| Brick.config.metadata_columns.include?(k1) }.map do |k2, v2|
+                              param = { 'name': k2, 'schema': { 'type': v2.first } }
+                              if (col_descrip = relation.last.fetch(:col_descrips, nil)&.fetch(k2, nil))
+                                param['description'] = col_descrip
+                              end
+                              param
+                            end,
+                            'responses': { '200': { 'description': 'successful' } }
+                          }.merge(schema_tag)
+                        end
+                      end
                     end
                   end # Do multiple api_ver_paths
                 end

data/lib/brick/version_number.rb

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

data/lib/brick.rb

@@ -678,7 +678,10 @@ In config/initializers/brick.rb appropriate entries would look something like:
           ::Brick.relations.each do |k, v|
             next if !(controller_name = v.fetch(:resource, nil)&.pluralize) || existing_controllers.key?(controller_name)
 
-            schema_name = v.fetch(:schema, nil)
+            object_name = k.split('.').last # Take off any first schema part
+            if (schema_name = v.fetch(:schema, nil))
+              schema_prefix = "#{schema_name}."
+            end
             options = {}
             options[:only] = [:index, :show] if v.key?(:isView)
             # First do the API routes if necessary
@@ -687,14 +690,11 @@ 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] == '_'
-                next if api_done_views.key?(unversioned = k[ver.length + 1..-1])
-
-                # # if ().length.positive? # Does it have a version number?
-                # try_num = (ver_num = (ver = ver[1..-1].gsub('_', '.')).to_d)
+              if v.key?(:isView) && (ver = object_name.match(/^v([\d_]*)/)&.captures&.first) && ver[-1] == '_'
+                core_object_name = object_name[ver.length + 1..-1]
+                next if api_done_views.key?(unversioned = "#{schema_prefix}v_#{core_object_name}")
 
                 # Expect that the last item in the path generally holds versioning information
                 api_ver = api_root.split('/')[-1]&.gsub('_', '.')
@@ -707,79 +707,95 @@ In config/initializers/brick.rb appropriate entries would look something like:
 
                 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
+                                          found = "#{schema_prefix}v#{test_ver_num}_#{core_object_name}", nil
                                         ))
                 api_done_views[unversioned] = nil # Mark that for this API version this view is done
 
                 # puts "Found #{found}" if view_relation
                 # If we haven't found "v3_view_name" or "v2_view_name" or so forth, at the last
                 # fall back to simply looking for "v_view_name", and then finally  "view_name".
-                unversioned = "v_#{unversioned}"
-                view_relation ||= ::Brick.relations.fetch(found = unversioned,
-                                                          ::Brick.relations.fetch(found = unversioned, nil)
-                                                         )
-                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
+                no_v_prefix_name = "#{schema_prefix}#{core_object_name}"
+              else
+                unversioned = k
+              end
+
+              view_relation ||= ::Brick.relations.fetch(found = unversioned, nil) ||
+                                (no_v_prefix_name && ::Brick.relations.fetch(found = no_v_prefix_name, nil))
+              if view_relation
+                actions = view_relation.key?(:isView) ? [:index, :show] : ::Brick::ALL_API_ACTIONS # By default all actions are allowed
+                # 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
+                                  num_args = filter.arity.negative? ? 6 : filter.arity
+                                  filter.call(*[unversioned, k, actions, api_ver_num, found, test_ver_num][0...num_args])
+                                rescue StandardError => e
+                                  puts "::Brick.api_filter Proc error: #{e.message}"
                                 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
+                # 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
+                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
-                    actions &= proc_result[2] if proc_result[2] # allowed_actions
                   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
-                (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
-              # %%% 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" })
+                (view_relation[:api][api_ver_num] ||= {})[unversioned] = actions # Add to the list of API paths this resource responds to
+
+                # view_ver_num = if (first_part = k.split('_').first) =~ /^v[\d_]+/
+                #                  first_part[1..-1].gsub('_', '.').to_i
+                #                end
+
+                controller_name = if (last = view_relation.fetch(:resource, nil)&.pluralize)
+                                    "#{schema_prefix}#{last}"
+                                  else
+                                    found
+                                  end.tr('.', '/')
+
+                { :index => 'get', :create => 'post' }.each do |action, method|
+                  if actions.include?(action)
+                    # Normally goes to something like:  /api/v1/employees
+                    send(method, "#{api_root}#{unversioned.tr('.', '/')}", { to: "#{controller_prefix}#{controller_name}##{action}" })
+                  end
+                end
+                # %%% We do not yet surface the #show action
+                if (id_col = view_relation[:pk]&.first) # ID-dependent stuff
+                  { :update => ['put', 'patch'], :destroy => ['delete'] }.each do |action, methods|
+                    if actions.include?(action)
+                      methods.each do |method|
+                        send(method, "#{api_root}#{unversioned.tr('.', '/')}/:#{id_col}", { to: "#{controller_prefix}#{controller_name}##{action}" })
+                      end
+                    end
+                  end
                 end
               end
             end
@@ -792,7 +808,7 @@ In config/initializers/brick.rb appropriate entries would look something like:
               else
                 table_class_length = class_name.length if class_name.length > table_class_length
                 tables
-              end << [class_name, full_resource || v[:resource]]
+              end << [class_name, "#{schema_prefix&.tr('.', '/')}#{v[:resource]}"]
             end
 
             # Now the normal routes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brick
 version: !ruby/object:Gem::Version
-  version: 1.0.106
+  version: 1.0.107
 platform: ruby
 authors:
 - Lorin Thwaits
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord