active_shrine 0.1.0 → 0.1.1

data/lib/generators/active_shrine/install/templates/db/migrate/create_active_shrine_attachments.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class CreateActiveShrineAttachments < ActiveRecord::Migration[7.0]
+  def change
+    create_table :active_shrine_attachments do |t|
+      t.belongs_to :record, polymorphic: true, null: true
+      t.string :name, null: false
+      t.string :type, null: false, default: "ActiveShrine::Attachment"
+      if ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
+        t.jsonb :file_data, null: false
+        t.jsonb :metadata, default: {}, null: false
+      else
+        t.json :file_data, null: false
+        t.json :metadata, default: {}, null: false
+      end
+
+      t.timestamps
+    end
+    add_index :active_shrine_attachments, :name
+    if ActiveRecord::Base.connection.adapter_name.downcase.include?("postgresql")
+      add_index :active_shrine_attachments, :file_data, using: :gin
+      add_index :active_shrine_attachments, :metadata, using: :gin
+    else
+      add_index :active_shrine_attachments, :file_data
+      add_index :active_shrine_attachments, :metadata
+    end
+  end
+end

data/sig/active_shrine.rbs

@@ -0,0 +1,4 @@
+module ActiveShrine
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,100 +1,172 @@
 --- !ruby/object:Gem::Specification
 name: active_shrine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- Stefan Froelich
+- Radioactive Labs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-11 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: shrine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: stoplight
+  name: activestorage
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-description: Building blocks for building API Clients
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: combustion
+  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: appraisal
+  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'
+description: Write a longer description or delete this line.
 email:
-- sfroelich01@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- ".DS_Store"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
 - README.md
 - Rakefile
-- app/assets/config/api_base_manifest.js
-- app/assets/stylesheets/api_base/application.css
-- app/controllers/api_base/application_controller.rb
-- app/helpers/api_base/application_helper.rb
-- app/jobs/api_base/application_job.rb
-- app/mailers/api_base/application_mailer.rb
-- app/models/api_base/api_log.rb
-- app/models/api_base/application_record.rb
-- app/views/layouts/api_base/application.html.erb
-- config/routes.rb
-- db/migrate/20220612165032_create_api_logs.rb
-- lib/api_base.rb
-- lib/api_base/behaviours/get_json.rb
-- lib/api_base/behaviours/post_json.rb
-- lib/api_base/behaviours/shared.rb
-- lib/api_base/concerns/filterer.rb
-- lib/api_base/concerns/traceable.rb
-- lib/api_base/connection.rb
-- lib/api_base/endpoint.rb
-- lib/api_base/engine.rb
-- lib/api_base/errors/api_error.rb
-- lib/api_base/errors/processing_error.rb
-- lib/api_base/service.rb
-- lib/api_base/version.rb
-- lib/tasks/api_base_tasks.rake
-homepage: https://github.com/ussd-engine/api-base
+- config.ru
+- lib/.DS_Store
+- lib/active_shrine.rb
+- lib/active_shrine/attached.rb
+- lib/active_shrine/attached/base.rb
+- lib/active_shrine/attached/changes.rb
+- lib/active_shrine/attached/changes/create_many.rb
+- lib/active_shrine/attached/changes/create_one.rb
+- lib/active_shrine/attached/changes/create_one_of_many.rb
+- lib/active_shrine/attached/changes/delete_many.rb
+- lib/active_shrine/attached/changes/delete_one.rb
+- lib/active_shrine/attached/changes/detach_many.rb
+- lib/active_shrine/attached/changes/detach_one.rb
+- lib/active_shrine/attached/changes/purge_many.rb
+- lib/active_shrine/attached/changes/purge_one.rb
+- lib/active_shrine/attached/many.rb
+- lib/active_shrine/attached/one.rb
+- lib/active_shrine/attachment.rb
+- lib/active_shrine/job.rb
+- lib/active_shrine/job/destroy_shrine_attachment.rb
+- lib/active_shrine/job/promote_shrine_attachment.rb
+- lib/active_shrine/model.rb
+- lib/active_shrine/railtie.rb
+- lib/active_shrine/reflection.rb
+- lib/active_shrine/version.rb
+- lib/generators/.DS_Store
+- lib/generators/active_shrine/install/install_generator.rb
+- lib/generators/active_shrine/install/templates/app/jobs/destroy_shrine_attachment_job.rb
+- lib/generators/active_shrine/install/templates/app/jobs/promote_shrine_attachment_job.rb
+- lib/generators/active_shrine/install/templates/config/initializers/shrine.rb
+- lib/generators/active_shrine/install/templates/db/migrate/create_active_shrine_attachments.rb
+- sig/active_shrine.rbs
+homepage: https://rubygems.org
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/ussd-engine/api-base
-  source_code_uri: https://github.com/ussd-engine/api-base
-  changelog_uri: https://github.com/ussd-engine/api-base
+  homepage_uri: https://rubygems.org
+  source_code_uri: https://rubygems.org
+  changelog_uri: https://rubygems.org
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -103,15 +175,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: Building blocks for building API Clients
+summary: A compatible ActiveStorage api for attaching Shrine uploads to ActiveRecord
+  models
 test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2022 Stefan Froelich
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app/assets/config/api_base_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/api_base .css

data/app/assets/stylesheets/api_base/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/api_base/application_controller.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  class ApplicationController < ActionController::Base
-  end
-end

data/app/helpers/api_base/application_helper.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  module ApplicationHelper
-  end
-end

data/app/jobs/api_base/application_job.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/api_base/application_mailer.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
-  end
-end

data/app/models/api_base/api_log.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-# == Schema Information
-#
-# Table name: api_logs
-#
-#  id               :bigint           not null, primary key
-#  api              :text             not null
-#  duration         :float
-#  endpoint         :text             not null
-#  exception        :jsonb
-#  method           :text             not null
-#  origin           :text             not null
-#  request_body     :jsonb
-#  request_headers  :jsonb
-#  response_body    :jsonb
-#  response_headers :jsonb
-#  source           :text             not null
-#  status_code      :integer
-#  created_at       :datetime         not null
-#  updated_at       :datetime         not null
-#
-require 'English'
-
-module ApiBase
-  class ApiLog < ApplicationRecord
-    attribute :sanitized, :boolean, default: false
-
-    validate :ensure_nothing_changed, unless: :new_record?
-    validate :ensure_data_sanitized
-
-    validates_presence_of :api, :origin, :source, :endpoint
-
-    validates :source, presence: true, inclusion: { in: %w[outgoing_request incoming_webhook] }
-    validates :method, presence: true, inclusion: { in: %w[GET POST DELETE PUT] }
-
-    def self.start_outgoing_request(origin, method, endpoint, payload)
-      ApiLog.new api: origin.identifier, origin: origin.class.to_s, source: 'outgoing_request',
-                 endpoint: "#{origin.connection.url_prefix}#{endpoint}", method:,
-                 request_headers: origin.connection.headers, request_body: payload
-    end
-
-    def complete_outgoing_request(response, duration)
-      # Ensure we are recording the actual headers that were sent on the request.
-      # The ones set from the connection might not be the final headers.
-      self.request_headers = response.env.request_headers
-      # Set the rest of the response attributes.
-      assign_attributes status_code: response.status, duration:,
-                        response_body: response.body, response_headers: response.headers
-    end
-
-    def self.start_webhook_request(origin, request)
-      ApiLog.new api: origin, origin: origin.class.to_s, source: 'incoming_webhook',
-                 endpoint: request.fullpath, method: request.method,
-                 request_headers: request.headers.env.reject { |key|
-                   key.to_s.include?('.')
-                 }, request_body: request.params
-    end
-
-    def complete_webhook_request(response, duration)
-      # Set the rest of the response attributes.
-      assign_attributes status_code: response.status, duration:,
-                        response_body: response.body, response_headers: response.headers
-    end
-
-    def filter_sensitive_data
-      parse_json_fields
-
-      %i[request_headers request_body response_headers response_body exception].each do |prop|
-        self[prop] = yield(self[prop]) if self[prop].is_a?(Hash)
-      end
-
-      self.sanitized = true
-    end
-
-    private
-
-    def ensure_nothing_changed
-      errors.add(:base, 'Record is read-only') if changed?
-    end
-
-    def ensure_data_sanitized
-      errors.add(:base, 'Data must be sanitized') unless sanitized?
-    end
-
-    def parse_json_fields
-      %i[request_headers request_body response_headers response_body exception].each do |prop|
-        self[prop] = safely_parse_json(self[prop])
-      end
-    end
-
-    def safely_parse_json(value)
-      case value
-      when nil, Hash
-        value
-      when String
-        JSON.parse value
-      when StandardError
-        [e.message, *e.backtrace].join($INPUT_RECORD_SEPARATOR).to_json
-      else
-        value.to_s.to_json
-      end
-    rescue StandardError
-      # Something we can't encode. Let's preserve it as a string.
-      value.to_s.to_json
-    end
-  end
-end

data/app/models/api_base/application_record.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/api_base/application.html.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Api base</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "api_base/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/config/routes.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-ApiBase::Engine.routes.draw do
-end

data/db/migrate/20220612165032_create_api_logs.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-class CreateApiLogs < ActiveRecord::Migration[6.0]
-  def change
-    create_table :api_base_api_logs do |t|
-      t.text :api, null: false
-      t.text :origin, null: false
-      t.text :source, null: false
-      t.text :endpoint, null: false
-      t.text :method, null: false
-      t.jsonb :request_headers
-      t.jsonb :request_body
-      t.integer :status_code
-      t.jsonb :response_headers
-      t.jsonb :response_body
-      t.float :duration
-      t.jsonb :exception
-
-      t.timestamps
-    end
-  end
-end

data/lib/api_base/behaviours/get_json.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  module Behaviours
-    # Shared concern that adds the ability to get json from an endpoint
-    module GetJson
-      include Shared
-
-      alias get_json behaviour_delegate
-
-      protected
-
-      def execute_request(endpoint, _payload)
-        execute do
-          connection.get(endpoint) do |req|
-            req.headers['Content-Type'] = 'application/json'
-          end
-        end
-      end
-
-      def method
-        'GET'
-      end
-    end
-  end
-end

data/lib/api_base/behaviours/post_json.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  module Behaviours
-    # Shared concern that adds the ability to post json to an endpoint
-    module PostJson
-      include Shared
-
-      alias post_json behaviour_delegate
-
-      protected
-
-      def execute_request(endpoint, payload)
-        execute do
-          connection.post(endpoint, payload) do |req|
-            req.body = payload.to_json
-            req.headers['Content-Type'] = 'application/json'
-          end
-        end
-      end
-
-      def method
-        'POST'
-      end
-    end
-  end
-end

data/lib/api_base/behaviours/shared.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  module Behaviours
-    # Shared module that adds common methods to api behaviours
-    module Shared
-      def behaviour_delegate(endpoint, payload = {})
-        api_log = ApiBase::ApiLog.start_outgoing_request(self, method, endpoint, payload)
-        response, duration = make_request(endpoint, payload)
-        api_log.complete_outgoing_request response, duration
-
-        response
-      rescue StandardError => e
-        api_log.exception = e if api_log.present?
-        raise
-      ensure
-        if api_log.present?
-          api_log.filter_sensitive_data { |data| filter_object(data) }
-          api_log.save!
-        end
-
-        validate_status_code response if response.present?
-      end
-
-      protected
-
-      def make_request(endpoint, payload)
-        trace_active_tag('request.endpoint', endpoint)
-        trace_active_tag('request.payload', filter_object(payload))
-
-        start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        response = execute_request(endpoint, payload)
-        duration = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
-
-        trace_active_tag('response.status', response.status)
-        trace_active_tag('response.body', filter_object(response.body))
-        trace_active_tag('response.duration', duration)
-
-        [response, duration]
-      end
-
-      def method
-        raise NotImplementedError, 'method is not implemented'
-      end
-
-      def execute_request
-        raise NotImplementedError, 'execute_request is not implemented'
-      end
-    end
-  end
-end

data/lib/api_base/concerns/filterer.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module ApiBase
-  module Concerns
-    module Filterer
-      protected
-
-      def filterer
-        @filterer ||= ActiveSupport::ParameterFilter.new(Rails.application.config.filter_parameters)
-      end
-
-      def filter_object(obj)
-        return if obj.nil?
-
-        case obj
-        when Array then filter_array(obj)
-        when Hash then filter_hash(obj)
-        else obj
-        end
-      end
-
-      def filter_array(array)
-        return if array.nil?
-
-        array.map do |item|
-          case item
-          when Array then filter_array(item)
-          when Hash then filter_hash(item)
-          else item
-          end
-        end
-      end
-
-      def filter_hash(hash)
-        return if hash.nil?
-
-        hash.each do |key, value|
-          case value
-          when Array then hash[key] = filter_array(value)
-          when Hash then hash[key] = filter_hash(value)
-          end
-        end
-        filterer.filter (hash.try(:permit!) || hash).to_hash
-      end
-    end
-  end
-end