asset_cloud 2.5.1 → 2.7.0

data/lib/asset_cloud/base.rb

@@ -1,3 +1,5 @@
+require 'uri/rfc2396_parser'
+
 module AssetCloud
 
   class IllegalPath < StandardError
@@ -27,6 +29,8 @@ module AssetCloud
       )\z/x
     MATCH_BUCKET = /^(\w+)(\/|$)/
 
+    URI_PARSER = URI::RFC2396_Parser.new
+
     attr_accessor :url, :root
 
     class_attribute :root_bucket_class
@@ -91,7 +95,7 @@ module AssetCloud
     end
 
     def url_for(key, options={})
-      File.join(@url, Addressable::URI.encode_component(key, Addressable::URI::CharacterClasses::PATH))
+      File.join(@url, URI_PARSER.escape(key))
     end
 
     def path_for(key)
@@ -147,6 +151,12 @@ module AssetCloud
       bucket_for(key).write(key, value)
     end
 
+    def write!(key, value)
+      asset = self[key]
+      asset.value = value
+      asset.store!
+    end
+
     def read(key)
       logger.info { "  [#{self.class.name}] Reading from #{key}" } if logger
 

data/lib/asset_cloud/buckets/gcs_bucket.rb

@@ -17,7 +17,7 @@ module AssetCloud
       bucket.create_file(
         data,
         absolute_key(key),
-        options
+        **options,
       )
     end
 

data/lib/asset_cloud/metadata.rb

@@ -1,6 +1,6 @@
 module AssetCloud
   class Metadata
-    attr_accessor :exist, :size, :created_at, :updated_at, :value_hash
+    attr_accessor :exist, :size, :created_at, :updated_at, :value_hash, :checksum
 
     def new?
       !self.exist
@@ -10,9 +10,16 @@ module AssetCloud
       self.exist
     end
 
-    def initialize(exist, size = nil, created_at = nil, updated_at = nil, value_hash = nil)
-      self.exist, self.size, self.created_at, self.updated_at, self.value_hash = exist, size, created_at, updated_at, value_hash
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(exist, size = nil, created_at = nil, updated_at = nil, value_hash = nil, checksum = nil)
+      self.exist = exist
+      self.size = size
+      self.created_at = created_at
+      self.updated_at = updated_at
+      self.value_hash = value_hash
+      self.checksum = checksum
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def self.existing
       self.new(true)

data/spec/active_record_bucket_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 MockRecords = Object.new
@@ -5,7 +6,9 @@ MockRecords = Object.new
 class MockActiveRecordBucket < AssetCloud::ActiveRecordBucket
   self.key_attribute = 'name'
   self.value_attribute = 'body'
+
   protected
+
   def records
     MockRecords
   end
@@ -19,49 +22,49 @@ describe AssetCloud::ActiveRecordBucket do
   directory = File.dirname(__FILE__) + '/files'
 
   before do
-    @cloud = RecordCloud.new(directory , 'http://assets/files' )
+    @cloud = RecordCloud.new(directory, 'http://assets/files')
     @bucket = @cloud.buckets[:stuff]
   end
 
   describe '#ls' do
     before do
-      MockRecords.should_receive(:connection).and_return(@mock_connection = double("connection"))
-      @mock_connection.should_receive(:quote_column_name).with('name').and_return("`name`")
-      (@mock_record = double("record")).should_receive(:name).and_return('stuff/a1')
+      expect(MockRecords).to(receive(:connection).and_return(@mock_connection = double("connection")))
+      expect(@mock_connection).to(receive(:quote_column_name).with('name').and_return("`name`"))
+      expect(@mock_record = double("record")).to(receive(:name).and_return('stuff/a1'))
     end
 
     it "should return a list of assets which start with the given prefix" do
-      MockRecords.should_receive(:all).with(:conditions => ["`name` LIKE ?", "stuff/a%"]).and_return([@mock_record])
+      expect(MockRecords).to(receive(:all).with(conditions: ["`name` LIKE ?", "stuff/a%"]).and_return([@mock_record]))
 
-      @bucket.ls('stuff/a').size.should == 1
+      expect(@bucket.ls('stuff/a').size).to(eq(1))
     end
 
     it "should return a list of all assets when a prefix is not given" do
-      MockRecords.should_receive(:all).with(:conditions => ["`name` LIKE ?", "stuff%"]).and_return([@mock_record])
+      expect(MockRecords).to(receive(:all).with(conditions: ["`name` LIKE ?", "stuff%"]).and_return([@mock_record]))
 
-      @bucket.ls.size.should == 1
+      expect(@bucket.ls.size).to(eq(1))
     end
   end
 
   describe '#read' do
     it "should return the value of a key when it exists" do
-      (@mock_record = double("record")).should_receive(:body).and_return('foo')
-      MockRecords.should_receive(:first).with(:conditions => {'name' => 'stuff/a1'}).and_return(@mock_record)
+      expect(@mock_record = double("record")).to(receive(:body).and_return('foo'))
+      expect(MockRecords).to(receive(:first).with(conditions: { 'name' => 'stuff/a1' }).and_return(@mock_record))
 
       @bucket.read('stuff/a1')
     end
     it "should raise AssetNotFoundError when nothing is there" do
-      MockRecords.should_receive(:first).with(:conditions => {'name' => 'stuff/a1'}).and_return(nil)
+      expect(MockRecords).to(receive(:first).with(conditions: { 'name' => 'stuff/a1' }).and_return(nil))
 
-      lambda {@bucket.read('stuff/a1')}.should raise_error(AssetCloud::AssetNotFoundError)
+      expect { @bucket.read('stuff/a1') }.to(raise_error(AssetCloud::AssetNotFoundError))
     end
   end
 
   describe '#write' do
     it "should write to the DB" do
-      (@mock_record = double("record")).should_receive(:body=).with('foo').and_return('foo')
-      @mock_record.should_receive(:save!).and_return(true)
-      MockRecords.should_receive(:find_or_initialize_by_name).with('stuff/a1').and_return(@mock_record)
+      expect(@mock_record = double("record")).to(receive(:body=).with('foo').and_return('foo'))
+      expect(@mock_record).to(receive(:save!).and_return(true))
+      expect(MockRecords).to(receive(:find_or_initialize_by_name).with('stuff/a1').and_return(@mock_record))
 
       @bucket.write('stuff/a1', 'foo')
     end
@@ -69,8 +72,8 @@ describe AssetCloud::ActiveRecordBucket do
 
   describe '#delete' do
     it "should destroy records" do
-      (@mock_record = double("record")).should_receive(:destroy).and_return(true)
-      MockRecords.should_receive(:first).with(:conditions => {'name' => 'stuff/a1'}).and_return(@mock_record)
+      expect(@mock_record = double("record")).to(receive(:destroy).and_return(true))
+      expect(MockRecords).to(receive(:first).with(conditions: { 'name' => 'stuff/a1' }).and_return(@mock_record))
 
       @bucket.delete('stuff/a1')
     end
@@ -78,18 +81,15 @@ describe AssetCloud::ActiveRecordBucket do
 
   describe '#stat' do
     it "should return appropriate metadata" do
-      (@mock_record = double("record")).should_receive(:created_at).and_return(1982)
-      @mock_record.should_receive(:updated_at).and_return(2002)
-      @mock_record.should_receive(:body).and_return('foo')
-      MockRecords.should_receive(:first).with(:conditions => {'name' => 'stuff/a1'}).and_return(@mock_record)
+      expect(@mock_record = double("record")).to(receive(:created_at).and_return(1982))
+      expect(@mock_record).to(receive(:updated_at).and_return(2002))
+      expect(@mock_record).to(receive(:body).and_return('foo'))
+      expect(MockRecords).to(receive(:first).with(conditions: { 'name' => 'stuff/a1' }).and_return(@mock_record))
 
       metadata = @bucket.stat('stuff/a1')
-      metadata.created_at.should == 1982
-      metadata.updated_at.should == 2002
-      metadata.size.should == 3
+      expect(metadata.created_at).to(eq(1982))
+      expect(metadata.updated_at).to(eq(2002))
+      expect(metadata.size).to(eq(3))
     end
   end
-
-
-
 end

data/spec/asset_cloud/metadata_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'asset_cloud/metadata'
+
+module AssetCloud
+  describe Metadata do
+    it "exposes the checksum" do
+      exist = true
+      size = 1
+      created_at = Time.utc(2020, 5, 19, 13, 14, 15)
+      updated_at = Time.utc(2020, 5, 19, 16, 17, 18)
+      value_hash = "abc123"
+      checksum = "def456"
+
+      metadata = Metadata.new(exist, size, created_at, updated_at, value_hash, checksum)
+
+      expect(metadata.checksum).to(eq("def456"))
+    end
+
+    it "defaults the checksum to nil if not provided" do
+      exist = true
+      size = 1
+      created_at = Time.utc(2020, 5, 19, 13, 14, 15)
+      updated_at = Time.utc(2020, 5, 19, 16, 17, 18)
+      value_hash = "abc123"
+
+      metadata = Metadata.new(exist, size, created_at, updated_at, value_hash)
+
+      expect(metadata.checksum).to(be(nil))
+    end
+  end
+end

data/spec/asset_extension_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 class NoCatsAsset < AssetCloud::Asset
@@ -5,6 +6,7 @@ class NoCatsAsset < AssetCloud::Asset
   before_store :asset_callback
 
   private
+
   def no_cats
     add_error('no cats allowed!') if value =~ /cat/i
   end
@@ -16,8 +18,9 @@ class CssAssetExtension < AssetCloud::AssetExtension
   validate :valid_css
 
   private
+
   def valid_css
-    add_error "not enough curly brackets!" unless asset.value =~ /\{.*\}/
+    add_error("not enough curly brackets!") unless asset.value =~ /\{.*\}/
   end
 end
 
@@ -32,17 +35,18 @@ class XmlAssetExtension < AssetCloud::AssetExtension
   end
 
   private
+
   def valid_xml
-    add_error "not enough angle brackets!" unless asset.value =~ /\<.*\>/
+    add_error("not enough angle brackets!") unless asset.value =~ /\<.*\>/
   end
 end
 
 class CatsAndDogsCloud < AssetCloud::Base
-  bucket :dog_pound, AssetCloud::MemoryBucket, :asset_class => NoCatsAsset
+  bucket :dog_pound, AssetCloud::MemoryBucket, asset_class: NoCatsAsset
   bucket :cat_pen, AssetCloud::MemoryBucket
 
-  asset_extensions CssAssetExtension, :only => :cat_pen
-  asset_extensions XmlAssetExtension, :except => :cat_pen
+  asset_extensions CssAssetExtension, only: :cat_pen
+  asset_extensions XmlAssetExtension, except: :cat_pen
 end
 
 describe "AssetExtension" do
@@ -55,7 +59,7 @@ describe "AssetExtension" do
   describe "applicability" do
     it "should work" do
       asset = @cloud['cat_pen/cats.xml']
-      XmlAssetExtension.applies_to_asset?(asset).should == true
+      expect(XmlAssetExtension.applies_to_asset?(asset)).to(eq(true))
     end
   end
 
@@ -63,31 +67,31 @@ describe "AssetExtension" do
     it "should be added to assets in the right bucket with the right extension" do
       asset = @cloud['cat_pen/cats.css']
       asset.value = 'foo'
-      asset.store.should == false
-      asset.errors.should == ["not enough curly brackets!"]
+      expect(asset.store).to(eq(false))
+      expect(asset.errors).to(eq(["not enough curly brackets!"]))
     end
 
     it "should not squash existing validations on the asset" do
       asset = @cloud['dog_pound/cats.xml']
       asset.value = 'cats!'
-      asset.store.should == false
-      asset.errors.should == ['no cats allowed!', "not enough angle brackets!"]
+      expect(asset.store).to(eq(false))
+      expect(asset.errors).to(eq(['no cats allowed!', "not enough angle brackets!"]))
     end
 
     it "should not apply to non-matching assets or those in exempted buckets" do
       asset = @cloud['cat_pen/cats.xml']
       asset.value = "xml"
-      asset.store.should == true
+      expect(asset.store).to(eq(true))
     end
   end
 
   describe "callbacks" do
     it "should run alongside the asset's callbacks" do
       asset = @cloud['dog_pound/dogs.xml']
-      asset.should_receive(:asset_callback)
-      asset.extensions.first.should_receive(:xml_callback)
+      expect(asset).to(receive(:asset_callback))
+      expect(asset.extensions.first).to(receive(:xml_callback))
       asset.value = '<dogs/>'
-      asset.store.should == true
+      expect(asset.store).to(eq(true))
     end
   end
 
@@ -96,7 +100,7 @@ describe "AssetExtension" do
       asset = @cloud['dog_pound/dogs.xml']
       asset.value = 'dogs'
       asset.turn_into_xml
-      asset.value.should == '<xml>dogs</xml>'
+      expect(asset.value).to(eq('<xml>dogs</xml>'))
     end
 
     it "does not swallow NotImplementedError" do
@@ -106,9 +110,8 @@ describe "AssetExtension" do
 
       asset = @cloud['dog_pound/dogs.xml']
 
-      expect(asset).to respond_to(:my_unimplemented_extension)
-      expect { asset.my_unimplemented_extension }.to raise_error(NotImplementedError)
+      expect(asset).to(respond_to(:my_unimplemented_extension))
+      expect { asset.my_unimplemented_extension }.to(raise_error(NotImplementedError))
     end
   end
-
 end

data/spec/asset_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe "Asset" do
   include AssetCloud
 
   before do
-    @cloud = double('Cloud', :asset_extension_classes_for_bucket => [])
+    @cloud = double('Cloud', asset_extension_classes_for_bucket: [])
   end
 
   describe "when first created (without a value)" do
@@ -13,116 +14,109 @@ describe "Asset" do
     end
 
     it "should be return new_asset? => true" do
-      @asset.new_asset?.should == true
+      expect(@asset.new_asset?).to(eq(true))
     end
 
     it "should have a key" do
-      @asset.key.should == 'products/key.txt'
+      expect(@asset.key).to(eq('products/key.txt'))
     end
 
     it "should have a value of nil" do
-
-      @asset.value.should == nil
+      expect(@asset.value).to(eq(nil))
     end
 
     it "should have a basename" do
-      @asset.basename.should == 'key.txt'
+      expect(@asset.basename).to(eq('key.txt'))
     end
 
     it "should have a basename without ext (if required)" do
-      @asset.basename_without_ext.should == 'key'
+      expect(@asset.basename_without_ext).to(eq('key'))
     end
 
     it "should have an ext" do
-      @asset.extname.should == '.txt'
+      expect(@asset.extname).to(eq('.txt'))
     end
 
     it "should have a relative_key_without_ext" do
-      @asset.relative_key_without_ext.should == 'key'
+      expect(@asset.relative_key_without_ext).to(eq('key'))
     end
 
     it "should have a bucket_name" do
-      @asset.bucket_name.should == 'products'
+      expect(@asset.bucket_name).to(eq('products'))
     end
 
     it "should have a bucket" do
-      @cloud.should_receive(:buckets).and_return(:products => :products_bucket)
-      @asset.bucket.should == :products_bucket
+      expect(@cloud).to(receive(:buckets).and_return(products: :products_bucket))
+      expect(@asset.bucket).to(eq(:products_bucket))
     end
 
     it "should store data to the bucket" do
-      @cloud.should_receive(:write).with("products/key.txt", 'value')
+      expect(@cloud).to(receive(:write).with("products/key.txt", 'value'))
 
       @asset.value = 'value'
       @asset.store
     end
 
     it "should not try to store data when it's value is nil" do
-      @cloud.should_receive(:write).never
+      expect(@cloud).to(receive(:write).never)
 
       @asset.store
     end
 
     it "should not try to read data from bucket if its a new_asset" do
-      @cloud.should_receive(:read).never
+      expect(@cloud).to(receive(:read).never)
 
-      @asset.value.should == nil
+      expect(@asset.value).to(eq(nil))
     end
 
     it "should simply ignore calls to delete" do
-      @cloud.should_receive(:delete).never
+      expect(@cloud).to(receive(:delete).never)
 
       @asset.delete
     end
-
   end
 
-
   describe "when first created (without a value) with subdirectory" do
     before do
       @asset = AssetCloud::Asset.new(@cloud, "products/retail/key.txt")
     end
 
     it "should have a relative_key_without_ext" do
-      @asset.relative_key_without_ext.should == 'retail/key'
+      expect(@asset.relative_key_without_ext).to(eq('retail/key'))
     end
 
     it "should have a relative_key" do
-      @asset.relative_key.should == 'retail/key.txt'
+      expect(@asset.relative_key).to(eq('retail/key.txt'))
     end
   end
 
-
   describe "when first created with value" do
     before do
       @asset = AssetCloud::Asset.new(@cloud, "products/key.txt", 'value')
     end
 
     it "should be return new_asset? => true" do
-      @asset.new_asset?.should == true
+      expect(@asset.new_asset?).to(eq(true))
     end
 
-
     it "should have a value of 'value'" do
-      @asset.value.should == 'value'
+      expect(@asset.value).to(eq('value'))
     end
 
     it "should return false when asked if it exists because its still a new_asset" do
-      @asset.exist?.should == false
+      expect(@asset.exist?).to(eq(false))
     end
 
-
     it "should not try to read data from bucket if its a new_asset" do
-      @cloud.should_receive(:read).never
+      expect(@cloud).to(receive(:read).never)
 
-      @asset.value.should == 'value'
+      expect(@asset.value).to(eq('value'))
     end
 
     it "should write data to the bucket" do
-      @cloud.should_receive(:write).with("products/key.txt", 'value')
+      expect(@cloud).to(receive(:write).with("products/key.txt", 'value'))
       @asset.store
     end
-
   end
 
   describe "when fetched from the bucket" do
@@ -131,45 +125,42 @@ describe "Asset" do
     end
 
     it "should be return new_asset? => false" do
-      @asset.new_asset?.should == false
+      expect(@asset.new_asset?).to(eq(false))
     end
 
     it "should indicate that it exists" do
-
-      @asset.exist?.should == true
+      expect(@asset.exist?).to(eq(true))
     end
 
-
     it "should read the value from the bucket" do
-      @asset.value.should == 'value'
+      expect(@asset.value).to(eq('value'))
     end
 
-
     it "should simply ignore calls to delete" do
-      @cloud.should_receive(:delete).and_return(true)
+      expect(@cloud).to(receive(:delete).and_return(true))
 
       @asset.delete
     end
 
     it "should ask the bucket to create a full url" do
-      @cloud.should_receive(:url_for).with('products/key.txt', {}).and_return('http://assets/products/key.txt')
+      expect(@cloud).to(receive(:url_for).with('products/key.txt', {}).and_return('http://assets/products/key.txt'))
 
-      @asset.url.should == 'http://assets/products/key.txt'
+      expect(@asset.url).to(eq('http://assets/products/key.txt'))
     end
 
     it "should ask the bucket whether or not it is versioned" do
       bucket = double('Bucket')
-      @cloud.should_receive(:buckets).and_return(:products => bucket)
-      bucket.should_receive(:versioned?).and_return(true)
+      expect(@cloud).to(receive(:buckets).and_return(products: bucket))
+      expect(bucket).to(receive(:versioned?).and_return(true))
 
-      @asset.versioned?.should == true
+      expect(@asset.versioned?).to(eq(true))
     end
 
     it "should validate its key" do
       asset = AssetCloud::Asset.new(@cloud, "products/foo, bar.txt", "data")
-      asset.store.should == false
-      asset.errors.size.should == 1
-      asset.errors.first.should =~ /illegal characters/
+      expect(asset.store).to(eq(false))
+      expect(asset.errors.size).to(eq(1))
+      expect(asset.errors.first).to(match(/illegal characters/))
     end
   end
 
@@ -183,14 +174,14 @@ describe "Asset" do
       it "is equal if cloud and key of both assets are equal" do
         other_asset = AssetCloud::Asset.new(@cloud, @key)
 
-        expect(@asset == other_asset).to eq(true)
+        expect(@asset == other_asset).to(eq(true))
       end
 
       it "is not equal if key of both assets are not equal" do
         other_key = "products/other_key.txt"
         other_asset = AssetCloud::Asset.new(@cloud, other_key)
 
-        expect(@asset == other_asset).to eq(false)
+        expect(@asset == other_asset).to(eq(false))
       end
     end
 
@@ -198,15 +189,15 @@ describe "Asset" do
       it "is not equal to a non-Asset object" do
         AssetCloud::Asset.new(@cloud, "products/foo, bar.txt", "data")
 
-        expect(@asset == "some_string").to eq(false)
-        expect(@asset == :some_symbol).to eq(false)
-        expect(@asset == []).to eq(false)
-        expect(@asset == nil).to eq(false)
+        expect(@asset == "some_string").to(eq(false))
+        expect(@asset == :some_symbol).to(eq(false))
+        expect(@asset == []).to(eq(false))
+        expect(@asset.nil?).to(eq(false))
 
-        expect(@asset <=> "some_string").to eq(nil)
-        expect(@asset <=> :some_symbol).to eq(nil)
-        expect(@asset <=> []).to eq(nil)
-        expect(@asset <=> nil).to eq(nil)
+        expect(@asset <=> "some_string").to(eq(nil))
+        expect(@asset <=> :some_symbol).to(eq(nil))
+        expect(@asset <=> []).to(eq(nil))
+        expect(@asset <=> nil).to(eq(nil))
       end
     end
   end