paperclip-oracle-object-storage 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 74757b0832bbddbcfac8c67a3df9960e8c88987b61663b690a02e7a2888016d1
+  data.tar.gz: e9ad53eae7206b1861a6629d812f710c03eae02959937e9210c18ab6583dca72
+SHA512:
+  metadata.gz: e3bb72a8fa83b7b9f1030166b62f115ef9347235d26b3baf920a1c878549ff9e1876997003778e9811e71788a3e7219b2d59d709f8f4c58b1bce4bbd4ed436ba
+  data.tar.gz: 278182025b77b4f420a801a39fe244c26273c9e68fdc382d0ec89fc47a7ccfd80d0ee5320797468c36ed37e2dc1dfc7aef1e7a2d96cdea6a3e9c6764583c39f2

data/lib/paperclip/storage/oracle_object_storage/version.rb

@@ -0,0 +1,7 @@
+module Paperclip
+  module Storage
+    module OracleObjectStorage
+      VERSION = "0.2.0"
+    end
+  end
+end

data/lib/paperclip/storage/oracle_object_storage.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Paperclip
+  module Storage
+    module OracleObjectStorage
+      def self.extended(base)
+        begin
+          require "oci"
+        rescue LoadError => e
+          raise("#{e.message} (You may need to install the oci gem)")
+        end
+
+        base.instance_eval do
+          #TODO: Load config by file.
+          # if oci_credentials[:config_file]
+          #   @config = OCI::ConfigFileLoader.load_config(
+          #         oci_credentials[:config_file],
+          #         oci_credentials[:profile] || "DEFAULT"
+          #       )
+          # end
+          @config = OCI::Config.new
+
+          @config.user = oci_credentials[:user]
+          @config.fingerprint = oci_credentials[:fingerprint]
+          @config.tenancy = oci_credentials[:tenancy]
+          @config.region = oci_credentials[:region]
+          @config.key_file = oci_credentials[:key_file]
+
+
+          @bucket_name = oci_credentials[:bucket_name]
+          @options[:path] = path_option.gsub(/:url/, @options[:url]).sub(/\A:rails_root\/public\/system/, "")
+          @options[:url] = @options[:url].inspect if @options[:url].is_a?(Symbol)
+        end
+      end
+
+      def oci_credentials
+        @oci_credentials ||= parse_credentials(@options[:oci_credentials])
+      end
+
+      def bucket_name
+        @bucket_name
+      end
+
+      def namespace
+        @namespace ||= begin
+          configured = @options[:namespace] || oci_credentials[:namespace]
+
+          return configured if configured.present?
+
+          object_storage_client.get_namespace.data
+        end
+      end
+
+      def object_storage_client
+        # Doc of OCI client: https://docs.oracle.com/en-us/iaas/tools/ruby/2.22.0/OCI/ObjectStorage/ObjectStorageClient.html#put_object_lifecycle_policy-instance_method
+        @object_storage_client ||= OCI::ObjectStorage::ObjectStorageClient.new(config: @config)
+      end
+
+      def object_name(style = default_style)
+        path(style).sub(%r{\A/}, "").unicode_normalize(:nfc).then { |p| I18n.transliterate(p) }
+      end
+
+      def exists?(style = default_style)
+        return false unless original_filename
+
+        object_storage_client.head_object(
+          namespace,
+          bucket_name,
+          object_name(style)
+        )
+
+        true
+      rescue OCI::Errors::ServiceError => e
+        return false if e.status_code == 404
+
+        raise
+      end
+
+      def expiring_url(time = 3600, style = default_style)
+        expires_at = Time.now.utc + time
+
+        details =
+          OCI::ObjectStorage::Models::CreatePreauthenticatedRequestDetails.new(
+            name: "paperclip-#{SecureRandom.hex(8)}",
+            object_name: object_name(style),
+            access_type: "ObjectRead",
+            time_expires: expires_at
+          )
+
+        response =
+          object_storage_client.create_preauthenticated_request(
+            namespace,
+            bucket_name,
+            details
+          )
+
+        endpoint = object_storage_client.endpoint
+
+        "#{endpoint.chomp("/")}#{response.data.access_uri}"
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style, file|
+          begin
+            log("saving to Oracle object storage #{path(style)}")
+            object_storage_client.put_object(
+              object_storage_client.get_namespace.data,
+              bucket_name,
+              object_name(style),
+              File.open(file.path),
+              {
+                content_type: file.content_type
+              }
+            )
+          rescue => e
+            log("error saving to Oracle object storage #{path(style)}")
+            raise e
+          end
+        end
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting #{path}")
+            object_storage_client.delete_object(
+              object_storage_client.get_namespace.data,
+              bucket_name,
+              object_name
+            )
+          rescue
+            log("error deleting #{path}")
+            raise e
+          end
+        end
+        @queued_for_delete = []
+      end
+
+      def copy_to_local_file(style, local_dest_path)
+        log("copying #{path(style)} to #{local_dest_path}")
+
+        response =
+          object_storage_client.get_object(
+            namespace,
+            bucket_name,
+            object_name(style)
+          )
+
+        File.binwrite(local_dest_path, response.data)
+      rescue OCI::Errors::ServiceError => e
+        warn("#{e} - cannot copy #{path(style)}")
+        false
+      end
+
+      def create_bucket
+        details =
+          OCI::ObjectStorage::Models::CreateBucketDetails.new(
+            name: bucket_name,
+            compartment_id: compartment_id
+          )
+
+        object_storage_client.create_bucket(
+          namespace,
+          details
+        )
+      end
+
+      private
+
+      def compartment_id
+        @options[:compartment_id] ||
+          oci_credentials[:compartment_id]
+      end
+
+      def parse_credentials(creds)
+        creds = creds.call(self) if creds.respond_to?(:call)
+
+        case creds
+        when File
+          load_credentials_from_file(creds.path)
+        when String, Pathname
+          load_credentials_from_file(creds)
+        when Hash
+          creds.symbolize_keys
+        when NilClass
+          {}
+        else
+          raise ArgumentError,
+                "Credentials given are not a path, file, proc, or hash."
+        end
+      end
+
+      def load_credentials_from_file(path)
+        YAML.safe_load(
+          ERB.new(File.read(path)).result,
+          aliases: true
+        ).symbolize_keys
+      end
+    end
+  end
+end

data/lib/paperclip-oracle-object-storage.rb

@@ -0,0 +1,2 @@
+require "paperclip"
+require "paperclip/storage/oracle_object_storage"

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-oracle-object-storage
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Luiz Filipe
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.22.0
+- !ruby/object:Gem::Dependency
+  name: kt-paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.4.1
+description: Paperclip storage lib to save to Oracle Object Storage
+email:
+- luiz.neves@prosas.com.br
+- luizfilipeneves@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/paperclip-oracle-object-storage.rb
+- lib/paperclip/storage/oracle_object_storage.rb
+- lib/paperclip/storage/oracle_object_storage/version.rb
+homepage: https://github.com/prosas/paperclip-oracle-object-storage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/prosas/paperclip-oracle-object-storage
+  source_code_uri: https://github.com/prosas/paperclip-oracle-object-storage
+  changelog_uri: https://github.com/prosas/paperclip-oracle-object-storage/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.1
+specification_version: 4
+summary: Paperclip storage lib to save to Oracle Object Storage
+test_files: []