unofficial-cloudflare-images 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a03b334986d3cb2ae0b77e75d830d647bc02a438d15e0ed590f14d0c9d7c589
+  data.tar.gz: 15891097d89f87728d4bb651ecbf935f9eaa8e8eabb1e1c63ca08bd2baa55093
+SHA512:
+  metadata.gz: c153622c7ceac696bfd183f373ceb2a045029504bfbb58de063bd2ac1b0225d1b98d7bfbb24588d7988fecbd97cd402aceb81910f9d6e033d4eca654ddc30db9
+  data.tar.gz: 77fe4d421704b47229e1bcc51f666e009ccfa337673f1e8da137f4e9b7aa17a43e78d80ca51b81a6286ee93e466f685568558353c7f71c36580dc30fdb134640

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Paul Sojan
+
+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/README.md

@@ -0,0 +1,35 @@
+# UnofficialCloudflareImagesGem
+
+Short description and motivation.
+
+## Usage
+
+How to use my plugin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "unofficial_cloudflare_images"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install unofficial_cloudflare_images_gem
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

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

@@ -0,0 +1,15 @@
+/*
+ * 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/unofficial_cloudflare_images/application_controller.rb

@@ -0,0 +1,4 @@
+module UnofficialCloudflareImages
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/unofficial_cloudflare_images/cloudflare_images_controller.rb

@@ -0,0 +1,36 @@
+module UnofficialCloudflareImages
+  class CloudflareImagesController < ApplicationController
+    include HTTParty
+    base_uri "https://api.cloudflare.com/client/v4"
+
+    def create
+      response = create_direct_upload_request
+
+      if response.success?
+        render json: response.parsed_response
+      else
+        render json: {
+          error: "Upload failed",
+          message: response.parsed_response
+        }, status: response.code
+      end
+    rescue StandardError => e
+      render json: { error: e.message }, status: :internal_server_error
+    end
+
+    private
+
+    def create_direct_upload_request
+      account_id = Rails.application.credentials.dig(:cloudflare_image, :account_id)
+      token = Rails.application.credentials.dig(:cloudflare_image, :token)
+
+      self.class.post(
+        "/accounts/#{account_id}/images/v2/direct_upload",
+        headers: {
+          "Authorization" => "Bearer #{token}"
+        },
+        timeout: 10
+      )
+    end
+  end
+end

data/app/controllers/unofficial_cloudflare_images/direct_uploads_controller.rb

@@ -0,0 +1,16 @@
+module UnofficialCloudflareImages
+  class DirectUploadsController < ActiveStorage::DirectUploadsController
+    def create
+      blob = ActiveStorage::Blob.create_before_direct_upload!(**blob_params)
+      render json: direct_upload_json(blob)
+    end
+
+    private
+
+    def blob_params
+      params
+        .require(:blob)
+        .permit(:filename, :byte_size, :checksum, :service_name, :content_type, metadata: {}).to_h.symbolize_keys
+    end
+  end
+end

data/app/helpers/unofficial_cloudflare_images/application_helper.rb

@@ -0,0 +1,4 @@
+module UnofficialCloudflareImages
+  module ApplicationHelper
+  end
+end

data/app/jobs/unofficial_cloudflare_images/application_job.rb

@@ -0,0 +1,4 @@
+module UnofficialCloudflareImages
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/unofficial_cloudflare_images/destroy_cloudflare_image_job.rb

@@ -0,0 +1,8 @@
+module UnofficialCloudflareImages
+  class DestroyCloudflareImageJob < ApplicationJob
+    def perform(blob)
+      service = UnofficialCloudflareImages::CloudflareImageDestroyService.new(blob)
+      service.process
+    end
+  end
+end

data/app/mailers/unofficial_cloudflare_images/application_mailer.rb

@@ -0,0 +1,6 @@
+module UnofficialCloudflareImages
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/unofficial_cloudflare_images/application_record.rb

@@ -0,0 +1,5 @@
+module UnofficialCloudflareImages
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/services/unofficial_cloudflare_images/cloudflare_image_destroy_service.rb

@@ -0,0 +1,41 @@
+module UnofficialCloudflareImages
+  class CloudflareImageDestroyService
+    class CloudflareDeleteError < StandardError; end
+
+    include HTTParty
+    base_uri "https://api.cloudflare.com/client/v4"
+
+    attr_reader :blob
+
+    def initialize(blob)
+      @blob = blob
+    end
+
+    def process
+      response = destroy_image
+
+      unless response.success?
+        raise CloudflareDeleteError,
+              "Cloudflare image delete failed. (#{response.code}): #{response.body}"
+      end
+
+      response
+    end
+
+    private
+
+    def destroy_image
+      account_id = Rails.application.credentials.dig(:cloudflare_image, :account_id)
+      token = Rails.application.credentials.dig(:cloudflare_image, :token)
+      image_id   = blob["metadata"]["id"]
+
+      self.class.delete(
+        "/accounts/#{account_id}/images/v1/#{image_id}",
+        headers: {
+          "Authorization" => "Bearer #{token}",
+          "Content-Type"  => "application/json"
+        }
+      )
+    end
+  end
+end

data/app/services/unofficial_cloudflare_images/cloudflare_image_uploader_service.rb

@@ -0,0 +1,81 @@
+require "multipart/post"
+
+module UnofficialCloudflareImages
+  class CloudflareImageUploaderService
+    class UploadError < StandardError; end
+
+    attr_reader :io, :blob
+
+    def initialize(io, blob)
+      @io = io
+      @blob = blob
+    end
+
+    def upload
+      response = HTTParty.post(
+        upload_url,
+        headers: headers,
+        body: build_upload_body
+      )
+      handle_response(response)
+      update_blob(response)
+    end
+
+    private
+
+    def upload_url
+      account_id = Rails.application.credentials.dig(:cloudflare_image, :account_id)
+      "https://api.cloudflare.com/client/v4/accounts/#{account_id}/images/v1"
+    end
+
+    def headers
+      api_token = Rails.application.credentials.dig(:cloudflare_image, :token)
+      {
+        "Authorization" => "Bearer #{api_token}"
+      }
+    end
+
+    def build_upload_body
+      mime_type = blob.content_type.to_s
+
+      upload_io =
+        if io.respond_to?(:read)
+          UploadIO.new(io, mime_type, blob.filename.to_s)
+        else
+          UploadIO.new(StringIO.new(io), mime_type, filename)
+        end
+      {
+        file: upload_io
+      }
+    end
+
+    def update_blob(response)
+      blob.update!(
+        metadata: blob.metadata.merge(
+          {
+            **response["result"],
+            url: response["result"]["variants"][0],
+            isCropped: false
+          })
+      )
+    end
+
+    def handle_response(response)
+      unless response.success?
+        error_message = parse_error_message(response)
+        raise UploadError, "Cloudflare upload failed (#{response.code}): #{error_message}"
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def parse_error_message(response)
+      body = JSON.parse(response.body) rescue {}
+      if body["errors"]&.any?
+        body["errors"].map { |e| e["message"] }.join(", ")
+      else
+        response.body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Unofficial cloudflare images</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "unofficial_cloudflare_images/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+UnofficialCloudflareImages::Engine.routes.draw do
+  defaults format: :json do
+    resources :cloudflare_images, only: [ :index, :create ]
+    resources :direct_uploads, only: [ :create ]
+  end
+end

data/lib/active_storage/active_storage.rb

@@ -0,0 +1,7 @@
+require_relative "./service/cloudflare_image_service"
+
+begin
+  require "active_storage"
+rescue LoadError
+  puts "Add gem activestorage to use this service"
+end

data/lib/active_storage/service/cloudflare_image_service.rb

@@ -0,0 +1,90 @@
+require "active_storage/service"
+
+class DownloaderExtension < ::ActiveStorage::Downloader
+  def open(key, checksum:, name: "ActiveStorage-", tmpdir: nil, **options)
+    open_tempfile(name, tmpdir) do |file|
+      download key, file
+      yield file
+    end
+  end
+end
+
+module ActiveStorage
+  class Service::CloudflareImageService < Service
+    def initialize(**config)
+      super
+      @config = config
+    end
+
+    def upload(key, io, checksum: nil, content_type: nil, disposition: nil, filename: nil, custom_metadata: {}, **)
+      instrument :upload, key: key do
+        blob = ActiveStorage::Blob.find_by_key(key)
+        service = UnofficialCloudflareImages::CloudflareImageUploaderService.new(io, blob)
+        service.upload
+      end
+    end
+
+    def url_for_direct_upload(key, **options)
+      Rails.logger.warn("Direct upload is not supported for Cloudflare Images service")
+    end
+
+    def url(key, filename: nil, content_type: "", **options)
+      blob = ActiveStorage::Blob.find_by_key(key)
+      blob.metadata[:url]
+    end
+
+    def download(key, &block)
+      if block_given?
+        instrument(:stream_file, key:) do
+          stream_file(key, &block)
+        end
+      else
+        instrument(:download, key:) do
+          cloudflare_image_file(key)
+        end
+      end
+    end
+
+    def download_chunk(key, range)
+      raise NotImplementedError, "Chunk download is not implemented for Cloudflare Images service"
+    end
+
+    def delete_prefixed(prefix)
+      raise NotImplementedError, "Prefix deletion is not supported for Cloudflare Images service"
+    end
+
+    def delete(key)
+      blob = ActiveStorage::Blob.find_by_key(key)
+
+      nil unless blob
+
+      UnofficialCloudflareImages::DestroyCloudflareImageJob.perform_later(blob.as_json)
+    end
+
+    def open(*args, **options, &block)
+      DownloaderExtension.new(self).open(*args, **options, &block)
+    end
+
+    private
+
+      def cloudflare_image_file(key)
+        image_url = url(key)
+
+        response = HTTParty.get(image_url, stream_body: false)
+
+        unless response.success?
+          raise "Failed to download Cloudflare image (#{response.code})"
+        end
+
+        response.body
+      end
+
+      def stream_file(key)
+        image_url = url(key)
+
+        HTTParty.get(image_url, stream_body: true) do |fragment|
+          yield fragment
+        end
+      end
+  end
+end

data/lib/tasks/unofficial_cloudflare_images_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :unofficial_cloudflare_images do
+#   # Task goes here
+# end

data/lib/unofficial-cloudflare-images.rb

@@ -0,0 +1,6 @@
+require "unofficial_cloudflare_images/version"
+require "unofficial_cloudflare_images/engine"
+require "unofficial_cloudflare_images/railtie"
+
+module UnofficialCloudflareImages
+end

data/lib/unofficial_cloudflare_images/engine.rb

@@ -0,0 +1,5 @@
+module UnofficialCloudflareImages
+  class Engine < ::Rails::Engine
+    isolate_namespace UnofficialCloudflareImages
+  end
+end

data/lib/unofficial_cloudflare_images/railtie.rb

@@ -0,0 +1,19 @@
+module UnofficialCloudflareImages
+  class Railtie < Rails::Railtie
+    initializer "unofficial_cloudflare_images.active_storage" do
+      ActiveSupport.on_load(:active_storage_blob) do
+        before_destroy :delete_from_cloudflare, if: :cloudflare_image_service?
+
+        private
+
+        def cloudflare_image_service?
+          service_name == "cloudflare_image"
+        end
+
+        def delete_from_cloudflare
+          service.delete(key)
+        end
+      end
+    end
+  end
+end

data/lib/unofficial_cloudflare_images/version.rb

@@ -0,0 +1,3 @@
+module UnofficialCloudflareImages
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: unofficial-cloudflare-images
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Paul Sojan
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2.2
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  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: '0'
+email:
+- paul.eliassojan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/unofficial_cloudflare_images/application.css
+- app/controllers/unofficial_cloudflare_images/application_controller.rb
+- app/controllers/unofficial_cloudflare_images/cloudflare_images_controller.rb
+- app/controllers/unofficial_cloudflare_images/direct_uploads_controller.rb
+- app/helpers/unofficial_cloudflare_images/application_helper.rb
+- app/jobs/unofficial_cloudflare_images/application_job.rb
+- app/jobs/unofficial_cloudflare_images/destroy_cloudflare_image_job.rb
+- app/mailers/unofficial_cloudflare_images/application_mailer.rb
+- app/models/unofficial_cloudflare_images/application_record.rb
+- app/services/unofficial_cloudflare_images/cloudflare_image_destroy_service.rb
+- app/services/unofficial_cloudflare_images/cloudflare_image_uploader_service.rb
+- app/views/layouts/unofficial_cloudflare_images/application.html.erb
+- config/routes.rb
+- lib/active_storage/active_storage.rb
+- lib/active_storage/service/cloudflare_image_service.rb
+- lib/tasks/unofficial_cloudflare_images_tasks.rake
+- lib/unofficial-cloudflare-images.rb
+- lib/unofficial_cloudflare_images/engine.rb
+- lib/unofficial_cloudflare_images/railtie.rb
+- lib/unofficial_cloudflare_images/version.rb
+homepage: https://github.com/paulsojan/unofficial-cloudflare-images-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/paulsojan/unofficial-cloudflare-images-gem
+  source_code_uri: https://github.com/paulsojan/unofficial-cloudflare-images-gem
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Unofficial gem to upload images to Cloudflare Images
+test_files: []