SyncAttributeToApiNamespace Plugin : External API Connection that backfills attributes on API Namespace + API Resources

[alis-khadka]

SyncAttributeToApiNamespace Plugin

For the latest version of this plugin see here:
https://github.com/restarone/violet_rails/blob/master/test/plugin_fixtures/sync_attribute_to_api_namespace.yml

search for SyncAttributeToApiNamespace

    class SyncAttributeToApiNamespace
      def initialize(parameters)  
        @external_api_client = parameters[:external_api_client]
        @api_namespace = @external_api_client.api_namespace
        @api_form = @api_namespace.api_form
      end
      def start
        # Fetching provided inputs (attribute_name, default_value)
        attribute_name = @external_api_client.metadata["ATTRIBUTE_NAME"]
        default_value = @external_api_client.metadata["DEFAULT_VALUE"].nil? ? '' : @external_api_client.metadata["DEFAULT_VALUE"]
        raise 'ATTRIBUTE_NAME is missing!' if attribute_name.nil?
        raise 'The provided attribute is already defined in the ApiNamespace' if @api_namespace.properties.keys.include?(attribute_name)
        # Adding the new-attribute in ApiNamespace
        new_properties = @api_namespace.properties.merge(attribute_name => default_value)
        @api_namespace.has_form = @api_namespace.api_form.present? ? '1' : '0'
        @api_namespace.update!(properties: new_properties)
        # Making the new-attribute non-renderable
        form_properties = @api_form.properties
        form_properties[attribute_name]['renderable'] = '0'
        @api_form.update!(properties: form_properties)
        # Adding the new-attribute to its ApiResources
        @api_namespace.api_resources.find_in_batches(batch_size: 500).each do |resources_batch|
          resources_batch.each do |api_resource|
            # Does not mutate the api-resource if it already has the provided new-attribute
            next if api_resource.properties.keys.include?(attribute_name)
            new_resource_properties = api_resource.properties.merge(attribute_name => default_value)
            api_resource.update!(properties: new_resource_properties)
          end
        end
      end
    end
    # at the end of the file we have to implicitly return the class 
    SyncAttributeToApiNamespace

The following metadata needs to be included for the plugin to work:

ATTRIBUTE_NAME: The name of the new attribute that needs to added.
DEFAULT_VALUE: The default value that will be added in the api-namespace and its api-resources properties' value.

Output

Note:
The newly added attribute is non-renderable.
We cannot provide files as DEFAULT_VALUE as of now.