expiring_asset_links 1.2.0 → 1.3.1

data/README.md

@@ -30,22 +30,10 @@ or add it to your Gemfile
 
 your configuration must satisfy the following requirements:
 
-* specify `storage :fog`
-* use the default `store_dir` string or one that ends with `folder/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}`
+* define `storage :fog`
+* set `Expires` in `s3_headers`
 
-  any of the following will work
-
-<pre>
-uploads/#{Rails.env}/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
-uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
-#{Rails.env}/uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
-#{Rails.env}/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
-a/series/of/folder/names/or/1/numbers/2/that_do/not/contain/spaces/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
-</pre>
-
-* `s3_headers` must include a value for `Expires`
-
-for example
+> 
 
     class AssetUploader < CarrierWave::Uploader::Base
       storage :fog
@@ -60,6 +48,21 @@ for example
     
     end
 
+### add an initializer with your CarrierWave Uploader `store_dir` matching Regexp
+
+if you wish to change the default `store_dir` in your CarrierWave Uploader you will need to create a Regexp that captures the object class name and id from the path
+
+create an initializer, such as `config/initializers/expiring_asset_links.rb` and include your configuration with Regexp
+
+    ExpiringAssetLinks.configure do |conf|
+      conf.fog_directory = /\/\S+\/(?<name>[a-z_]+)\/[a-z_]+\/(?<id>\d+)/
+    end
+
+the path defined in CarrierWave Uploader `store_dir`, such as `uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}`, must match the Regexp in your configuration once generated by CarrierWave and must capture the class name as `<name>` and the object id as `<id>`
+
+    /\/\S+\/(?<name>[a-z_]+)\/[a-z_]+\/(?<id>\d+)/.match("uploads/class_name/uploader_name/100")
+      #=> #<MatchData "uploads/class_name/uploader_name/100" name:"model_class_name" id:"100">
+
 ### mount an uploader for any class containing an assets
 
 you may use as many different classes as you would like, but each may only contain one mounted uploader
@@ -87,3 +90,28 @@ the attributes specified should contain fully qualified asset URLs generated by
       attr_expiring_asset_links :summary, :body
     
     end
+
+## Notes
+
+the url that is generated by CarrierWave may not immediately follow a letter or underscore in the content of the attribute specified as `attr_expiring_asset_links`, this will prevent the gem from properly parsing the data
+
+example of proper placement (the double quote character is no a letter or an underscore)
+
+    <h2>
+      Section One
+    </h2>
+    <p>
+      This is the first section in the body of the document.
+      It includes an image.
+    </p>
+    <img src="https://test.s3-us-east-1.amazonaws.com/uploads/test/99/asset/file_attachment/sample.jpg">
+
+example of improper placement (no space between 'at' and 'https')
+
+    <h2>
+      Section One
+    </h2>
+    <p>
+      This is the first section in the body of the document.
+      It includes an image, you may view it athttps://test.s3-us-east-1.amazonaws.com/uploads/test/99/asset/file_attachment/sample.jpg
+    </p>

data/lib/expiring_asset_links.rb

@@ -1,12 +1,22 @@
 require 'active_record'
+require 'expiring_asset_links/configuration'
 
 module ExpiringAssetLinks
   autoload :Version, 'expiring_asset_links/version'
-
-  def self.extended(base)
-    base.class_eval do
-      @expiring_asset_link_attributes = []
-      include InstanceMethods
+  extend ExpiringAssetLinks::Configuration
+  
+  class << self
+    
+    def extended(base)
+      base.class_eval do
+        @expiring_asset_link_attributes = []
+        include InstanceMethods
+      end
+    end
+  
+    def remove_asset_tags(value)
+      asset_url = Regexp::new "https://" + [/#{CarrierWave::Uploader::Base.fog_directory}\.s3\S+[amazon|amazonaws]\.com\//, self.fog_directory, /\/\S+Expires=[\d]{10}/].flatten.map{ |re| re.source }.join.gsub('\\/\\/', '\\/')
+      value.gsub(asset_url, '\k<name>{{\k<id>}}').gsub(/([A-Za-z_]+)\{\{(\d+)\}\}/) { "#{$1.classify}{{#{$2}}}" }
     end
   end
 
@@ -33,12 +43,11 @@ module ExpiringAssetLinks
     protected
 
     def remove_asset_tags(attribute)
-      self[attribute.to_sym].gsub(/https:\/\/#{CarrierWave::Uploader::Base.fog_directory}\.s3.\S+\/([a-z_]+)\/[a-z_]+\/(\d+)\/\S+Expires=[\d]{10}/) { "#{$1.classify}{{#{$2}}}" }
+      ExpiringAssetLinks.remove_asset_tags(self[attribute.to_sym])
     end
 
     def add_asset_tags(attribute)
-      linked_attribute = 
-      self[attribute.to_sym].gsub(/([A-Za-z]+)\{\{(\d+)\}\}/) { $1.constantize.find($2).send($1.constantize.uploaders.keys.first).url(:default) }
+      linked_attribute = self[attribute.to_sym].gsub(/([A-Za-z]+)\{\{(\d+)\}\}/) { $1.constantize.find($2).send($1.constantize.uploaders.keys.first).url(:default) }
     end
 
     def remove_all_asset_tags!

data/lib/expiring_asset_links/configuration.rb

@@ -0,0 +1,22 @@
+module ExpiringAssetLinks
+  module Configuration
+    VALID_CONFIG_KEYS = [:fog_directory].freeze
+    DEFAULT_FOG_DIRECTORY ||= /\S+\/(?<name>[a-z_]+)\/[a-z_]+\/(?<id>\d+)/
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.fog_directory = DEFAULT_FOG_DIRECTORY
+    end
+
+    def configure
+      yield self
+      raise TypeError, "expected fog_directory to be a Regexp" unless self.fog_directory.is_a?(Regexp)
+      missing_names = ["name", "id"] - self.fog_directory.names
+      raise RegexpError, "fog_directory must capture #{missing_names.join(' and ')}" unless missing_names.empty?
+    end
+  end
+end

data/lib/expiring_asset_links/version.rb

@@ -2,8 +2,8 @@ module ExpiringAssetLinks
   # Contains information about this gem's version
   module Version
     MAJOR = 1
-    MINOR = 2
-    PATCH = 0
+    MINOR = 3
+    PATCH = 1
 
     # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
     #

data/test/expiring_asset_links_test.rb

@@ -1,11 +1,10 @@
 require File.expand_path('../test_helper', __FILE__)
 
 class ExpiringAssetLinksTest < Test::Unit::TestCase
-
   def setup
     CarrierWave.configure do |config|
       # config.cache_dir = "#{Rails.root}/tmp/assets"
-      # 
+      #
       # config.root = Rails.root.join('tmp')
       # config.cache_dir = "assets"
       # config.fog_credentials = {
@@ -19,12 +18,118 @@ class ExpiringAssetLinksTest < Test::Unit::TestCase
     end
   end
 
-  def test_should_assert_true
-    file_attachment = FileAttachment.create(name: "test", asset: AssetUploader.new("https://test.s3-us-east-1.amazonaws.com/uploads/test/file_attachment/asset/1/sample.jpg"))
+  def test_class_id_path
+    ExpiringAssetLinks.configure do |conf|
+      conf.fog_directory = /\S+\/(?<name>[a-z_]+)\/[a-z_]+\/(?<id>\d+)/
+    end
+
+    file_attachment = FileAttachment.create(name: "test")
+    file_path = "https://test.s3-us-east-1.amazonaws.com/uploads/test/file_attachment/asset/#{file_attachment.id}/sample.jpg"
+    file_attachment.update_attributes({asset: AssetUploader.new(file_path)})
+    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">")
+
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{#{file_attachment.id}}}\">", Document.find(document.id).attributes["body"]
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_path}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body
+  end
+
+  def test_id_class_path
+    ExpiringAssetLinks.configure do |conf|
+      conf.fog_directory = /\S+\/(?<id>\d+)\/[a-z_]+\/(?<name>[a-z_]+)/
+    end
+
+    file_attachment = FileAttachment.create(name: "test")
+    file_path = "https://test.s3-us-east-1.amazonaws.com/uploads/test/#{file_attachment.id}/asset/file_attachment/sample.jpg"
+    file_attachment.update_attributes({asset: AssetUploader.new(file_path)})
+    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">")
+
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{#{file_attachment.id}}}\">", Document.find(document.id).attributes["body"]
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_path}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body
+  end
+
+  def test_default_configuration
+    file_attachment = FileAttachment.create(name: "test")
+    file_path = "https://test.s3-us-east-1.amazonaws.com/uploads/test/file_attachment/asset/#{file_attachment.id}/sample.jpg"
+    file_attachment.update_attributes({asset: AssetUploader.new(file_path)})
+    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">")
+
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{#{file_attachment.id}}}\">", Document.find(document.id).attributes["body"]
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_path}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body
+  end
+
+  def test_wrong_type_fog_directory_configuration
+    assert_raises(TypeError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = "" } }
+    assert_raises(TypeError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = "test" } }
+    assert_raises(TypeError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = "\S+\/(?<id>\d+)\/[a-z_]+\/(?<name>[a-z_]+)" } }
+  end
+
+  def test_invalid_fog_directory_configuration
+    assert_raises(RegexpError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = // } }
+    assert_raises(RegexpError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = /\S+\/(\d+)\/[a-z_]+\/([a-z_]+)/ } }
+    assert_raises(RegexpError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = /\S+\/(\d+)\/[a-z_]+\/(?<name>[a-z_]+)/ } }
+    assert_raises(RegexpError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = /\S+\/(?<id>\d+)\/[a-z_]+\/([a-z_]+)/ } }
+    assert_raises(RegexpError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = /\S+\/(?<ids>\d+)\/[a-z_]+\/(?<name>[a-z_]+)/ } }
+    assert_raises(RegexpError) { ExpiringAssetLinks.configure { |conf| conf.fog_directory = /\S+\/(?<id>\d+)\/[a-z_]+\/(?<names>[a-z_]+)/ } }
+  end
+  
+  def test_extra_names_fog_directory_configuration
+    ExpiringAssetLinks.configure do |conf|
+      conf.fog_directory = /\S+\/(?<id>\d+)\/(?<mount>[a-z_]+)\/(?<name>[a-z_]+)/
+    end
+
+    file_attachment = FileAttachment.create(name: "test")
+    file_path = "https://test.s3-us-east-1.amazonaws.com/uploads/test/#{file_attachment.id}/asset/file_attachment/sample.jpg"
+    file_attachment.update_attributes({asset: AssetUploader.new(file_path)})
+    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">")
+
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{#{file_attachment.id}}}\">", Document.find(document.id).attributes["body"]
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_path}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body
+  end
+
+  def test_non_matching_fog_directory_configuration
+    # there is essentially no way of knowing that a non-matching URL string should have matched the Regexp,
+    # no validation of any type is performed when adding or removing asset links
+    ExpiringAssetLinks.configure do |conf|
+      conf.fog_directory = /\S+\/(?<id>\d+)\/[a-z_]+\/(?<name>[a-z_]+)\/error/
+    end
+
+    file_attachment = FileAttachment.create(name: "test")
+    file_path = "https://test.s3-us-east-1.amazonaws.com/uploads/test/#{file_attachment.id}/asset/file_attachment/sample.jpg"
+    file_attachment.update_attributes({asset: AssetUploader.new(file_path)})
+    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">")
+
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">", Document.find(document.id).attributes["body"]
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">", Document.find(document.id).body
+  end
+
+  def test_multiple_assets
+    ExpiringAssetLinks.configure do |conf|
+      conf.fog_directory = /\S+\/(?<id>\d+)\/[a-z_]+\/(?<name>[a-z_]+)/
+    end
+
+    file_attachment_a = FileAttachment.create(name: "test")
+    file_path_a = "https://test.s3-us-east-1.amazonaws.com/uploads/test/#{file_attachment_a.id}/asset/file_attachment/sample.jpg"
+    file_attachment_a.update_attributes({asset: AssetUploader.new(file_path_a)})
+    file_attachment_b = FileAttachment.create(name: "test")
+    file_path_b = "https://test.s3-us-east-1.amazonaws.com/uploads/test/#{file_attachment_b.id}/asset/file_attachment/sample.jpg"
+    file_attachment_b.update_attributes({asset: AssetUploader.new(file_path_b)})
+    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment_a.send(FileAttachment.uploaders.keys.first).url}\"><p>And another image.</p><img src=\"#{file_attachment_b.send(FileAttachment.uploaders.keys.first).url}\">")
+
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{#{file_attachment_a.id}}}\"><p>And another image.</p><img src=\"FileAttachment{{#{file_attachment_b.id}}}\">", Document.find(document.id).attributes["body"]
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_path_a}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\"><p>And another image.</p><img src=\"#{file_path_b}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body
+  end
+
+  def test_with_leading_forward_slash_path
+    ExpiringAssetLinks.configure do |conf|
+      conf.fog_directory = /\/\S+\/(?<name>[a-z_]+)\/[a-z_]+\/(?<id>\d+)/
+    end
+
+    file_attachment = FileAttachment.create(name: "test")
+    file_path = "https://test.s3-us-east-1.amazonaws.com/uploads/test/file_attachment/asset/#{file_attachment.id}/sample.jpg"
+    file_attachment.update_attributes({asset: AssetUploader.new(file_path)})
     document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">")
 
-    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{1}}\">", Document.find(document.id).attributes["body"]
-    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"https://test.s3-us-east-1.amazonaws.com/uploads/test/file_attachment/asset/1/sample.jpg?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{#{file_attachment.id}}}\">", Document.find(document.id).attributes["body"]
+    assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_path}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body
   end
 
 end

data/test/test_helper.rb

@@ -12,19 +12,16 @@ ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":me
 
 ActiveRecord::Schema.define(:version => 1) do
   create_table :documents do |t|
-    t.integer :id
     t.string :title
     t.text :body
   end
   create_table :file_attachments do |t|
-    t.integer :id
-    t.integer :name
-    t.binary  :asset
+    t.string :name
+    t.binary :asset
   end
   create_table :image_attachments do |t|
-    t.integer :id
-    t.integer :name
-    t.binary  :asset
+    t.string :name
+    t.binary :asset
   end
 end
 
@@ -60,5 +57,3 @@ class AssetUploader < Struct.new(:my_url)
     "#{self.my_url}?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222"
   end
 end
-    
-  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: expiring_asset_links
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -88,6 +88,7 @@ files:
 - Rakefile
 - expiring_asset_links.gemspec
 - lib/expiring_asset_links.rb
+- lib/expiring_asset_links/configuration.rb
 - lib/expiring_asset_links/version.rb
 - test/expiring_asset_links_test.rb
 - test/test_helper.rb