cdn-image-tag 0.0 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fadd836c3c3e48ed3b05fc0681f49aac84d460b10236254a55ce6edd12cbd3e8
-  data.tar.gz: 2f6e8707ace19287b43af52547672883f7fdd0a0fba2a394d08d9c0e9c0a4f9c
+  metadata.gz: 7b309b40b05d9d8d915847f2c102c2b5e0b459a525b6b978f81ee70d060dca90
+  data.tar.gz: 1a4e999e6aef4729065b1079e4c62b30c48f162f63b262729163b95d4d88a389
 SHA512:
-  metadata.gz: 16210151ef66fe0ab21049cec8b94f5f5753121e206aa98e97c455191b89a0c1acb3fa83e8c1f0e3cc120ec56353f2e91ac26f1af9d82081b630e0f16a93c870
-  data.tar.gz: 77692cc2829e3008c4ffe4fa181709b4be92e36298c3c3e4f64080b41c5b69bcc92eec15a1d3dabc149860df94f58bc45c6e2a0385eea2007a50607b2ddd83c6
+  metadata.gz: 68aa9789622898cca1e451d9d7681d34c3bfcb3c75cd4b9eb790751a5cf5a1002f3032d225afb182585a7a5d75c819aa612e22e916f1facb94bc7ea40dbe0c8d
+  data.tar.gz: 22b43ed47dcec6d9dea57e4f58aaaa70d25f49980f297778d023272c94f0bff52ad0f5cc33e5d276e0449f2c20b273138a42b3ab025a342f8b565877931631d5

data/README.md

@@ -0,0 +1,64 @@
+
+
+This gem is for Rails 8 to allow you to serve images + Active Storage assets from a CDN, via Active Storage proxy.
+
+
+In Active storage proxy mode, assets are stored on S3 but served from the Rails app. 
+
+To speed performance and reduce load on the Rails app, you use a CDN that **points to the Rails app itself** (not S3)
+
+Go to your CDN and create a distribution with an origin that points back to the domain of your Rails app. 
+
+# AWS Cloudfront
+
+For AWS Cloudfront: On the Origin edit screen, set these:
+
+- Protocol: "HTTPS only"  
+- Minimum Origin SSL protocol: "TLSv1.2"
+
+
+Then go to the Behaviors tab on the distribution, select the default behavior ("0"), and check these settings:
+
+- Viewer protocol policy: Https only
+- Allowed HTTP methods: GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE
+- Restrict viewer access: No
+- Cache policy: CachingOptimized
+- Origin request policy: AllViewerExceptHostHeader
+
+
+# INSTALL
+- Setup S3 (see Active Storage docs + example below)
+- Set Cloudfront or another CDN (see above)
+- Set an ENV variable `CDN_TO_SELF` to the CDN distribution domain; (sub)domain only (not including protocol)
+- Include this gem in your gemfile
+- Wherever you would use `image_tag`, instead use `cdn_image_tag`
+
+// production.rb
+
+```
+config.active_storage.service = :amazon
+config.action_mailer.asset_host = "https://#{ENV['CDN_TO_SELF']}"
+config.active_storage.cdn_host = ENV['CDN_TO_SELF']
+config.active_storage.routes_host = ENV["CDN_TO_SELF"]
+config.active_storage.resolve_model_to_route = :rails_storage_proxy
+``` 
+// DO NOT SET config.action_controller.default_url_options
+
+
+// storage.yml
+```
+amazon:
+    service: S3
+    access_key_id: <%= ENV['AWS_ACCESS_KEY_ID'] %>
+    secret_access_key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
+    region: <%= ENV['AWS_REGION'] %>
+    bucket: myapp-<%= Rails.env %>
+```
+
+(I like my bucket names to be `myapp-production` and `myapp-devlepment` to match the Rails env, but you can modify this as needed)
+
+Verify:
+- Deploy your app, look at an image, right-click to "Open image in new tab", and confirm that the CDN is used instead of the Rails app domain.
+- You can swap the CDN domain for your Rails app domain and get the same image
+- The images from the asset pipeline should have the pipeline's thumbprint
+- Images served from Active storage have URLs like `/rails/active_storage/representations/proxy/`

data/app/helpers/cdn_image_helper.rb

@@ -0,0 +1,72 @@
+# app/helpers/cdn_image_helper.rb
+module CdnImageHelper
+  #
+  # Public method — drop-in replacement for image_tag.
+  #
+  # Works with:
+  #   cdn_image_tag("logo.png")
+  #   cdn_image_tag(@record.image)
+  #
+  def cdn_image_tag(source, **options)
+    image_tag(cdn_image_url(source), **options)
+  end
+
+  #
+  # Builds the URL, then rewrites the host if CDN is configured.
+  #
+  def cdn_image_url(source)
+    url = if active_storage?(source)
+            url_for(source)
+          else
+            asset_pipeline_url(source)
+          end
+
+    rewrite_to_cdn(url)
+  end
+
+  private
+
+  # True if this is an ActiveStorage attachment or representation.
+  def active_storage?(source)
+    source.respond_to?(:attachment) ||
+      source.respond_to?(:blob) ||
+      source.respond_to?(:processed) ||
+      source.respond_to?(:representable?)
+  end
+
+  #
+  # Always get a digested pipeline asset URL.
+  #
+  # asset_url returns either:
+  #   - full URL if default_url_options[:host] is set
+  #   - relative path (/assets/...) otherwise — which is perfect
+  #
+  def asset_pipeline_url(source)
+    ActionController::Base.helpers.asset_url(source)
+  end
+
+  #
+  # Rewrites any URL (relative or absolute) to use the CDN hostname.
+  #
+  def rewrite_to_cdn(url)
+    cdn_host = ENV["CDN_TO_SELF"]
+    return url if cdn_host.blank? # local dev
+
+    uri = URI.parse(url)
+
+    # If it's a relative path, construct a full CDN URL
+    if uri.host.nil?
+      return URI::HTTPS.build(
+        host: cdn_host,
+        path: uri.path,
+        query: uri.query
+      ).to_s
+    end
+
+    # Absolute URL → rewrite scheme + host
+    uri.scheme = "https"
+    uri.host   = cdn_host
+    uri.port   = nil
+    uri.to_s
+  end
+end

data/lib/cdn-image-tag.rb

@@ -0,0 +1,6 @@
+require "cdnimagetag/engine"
+
+module CdnImageTag
+
+
+end

data/lib/cdnimagetag/version.rb

@@ -1,5 +1,5 @@
 module CdnImageTag
   class Version
-    CURRENT = '0.0'
+    CURRENT = '0.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdn-image-tag
 version: !ruby/object:Gem::Version
-  version: '0.0'
+  version: '0.1'
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
@@ -30,6 +30,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- app/helpers/cdn_image_helper.rb
+- lib/cdn-image-tag.rb
 - lib/cdnimagetag/engine.rb
 - lib/cdnimagetag/version.rb
 homepage: ''