jd-paperclip-azure 3.0.0

data/spec/paperclip/storage/azure_spec.rb

@@ -0,0 +1,426 @@
+require 'spec_helper'
+require "base64"
+
+describe Paperclip::Storage::Azure do
+  let(:storage_access_key) { 'kiaY4+GkLMVxnfOK2X+eCJOE06J8QtHC6XNuXVwt8Pp4kMezYaa7cNjtYnZr4/b732RKdz5pZwl8RN9yb8gBCg==' }
+
+  describe "#parse_credentials" do
+    let(:credentials) {{
+      'production' => {key: '12345'},
+      development: {key: "54321"}
+    }}
+
+    before do
+      @proxy_settings = {host: "127.0.0.1", port: 8888, user: "foo", password: "bar"}
+      rebuild_model storage: :azure,
+                    container: "testing",
+                    azure_credentials: {not: :important}
+      @dummy = Dummy.new
+      @avatar = @dummy.avatar
+    end
+
+    it "gets the correct credentials when RAILS_ENV is production" do
+      rails_env("production") do
+        expect(@avatar.parse_credentials(credentials)).to eq({key: "12345"})
+      end
+    end
+
+    it "gets the correct credentials when RAILS_ENV is development" do
+      rails_env("development") do
+        expect(@avatar.parse_credentials(credentials)).to eq({key: "54321"})
+      end
+    end
+
+    it "returns the argument if the key does not exist" do
+      rails_env("not really an env") do
+        expect(@avatar.parse_credentials(test: "12345")).to eq({test: "12345"})
+      end
+    end
+
+  end
+
+  describe '#container_name' do
+    describe ":container option via :azure_credentials" do
+      before do
+        rebuild_model storage: :azure,
+                      azure_credentials: {container: 'testing'}
+        @dummy = Dummy.new
+      end
+
+      it "populates #container_name" do
+        expect(@dummy.avatar.container_name).to eq('testing')
+      end
+    end
+
+    describe ":container option" do
+      before do
+        rebuild_model storage: :azure,
+                      container: "testing",
+                      azure_credentials: {}
+        @dummy = Dummy.new
+      end
+
+      it "populates #container_name" do
+        expect(@dummy.avatar.container_name).to eq('testing')
+      end
+    end
+
+    describe "missing :container option" do
+      before do
+        rebuild_model storage: :azure,
+                      azure_credentials: {not: :important}
+
+        @dummy = Dummy.new
+        @dummy.avatar = stringy_file
+      end
+
+      it "raises an argument error" do
+        expect{ @dummy.avatar.container_name }.to raise_error(ArgumentError, /missing required :container option/)
+      end
+    end
+  end
+
+  describe "" do
+    before do
+      rebuild_model storage: :azure,
+                    azure_credentials: {
+                      storage_account_name: 'storage',
+                      storage_access_key: storage_access_key
+                    },
+                    container: "container",
+                    path: ":attachment/:basename:dotextension",
+                    url: ":azure_path_url"
+
+      @dummy = Dummy.new
+      @dummy.avatar = stringy_file
+
+      allow(@dummy).to receive(:new_record?).and_return(false)
+    end
+
+    it "returns urls based on Azure paths" do
+      expect(@dummy.avatar.url).to match(%r{^https://storage.blob.core.windows.net/container/avatars/data[^\.]})
+    end
+  end
+
+  describe "An attachment that uses Azure for storage and has styles that return different file types" do
+    before do
+      rebuild_model storage: :azure,
+                    styles: { large: ['500x500#', :jpg] },
+                    container: "container",
+                    path: ":attachment/:basename:dotextension",
+                    azure_credentials: {
+                      'access_key_id' => "12345",
+                      'storage_access_key' => "54321"
+                    }
+
+        File.open(fixture_file('5k.png'), 'rb') do |file|
+          @dummy = Dummy.new
+          @dummy.avatar = file
+
+          allow(@dummy).to receive(:new_record?).and_return(false)
+        end
+    end
+
+    it "returns a url containing the correct original file mime type" do
+      expect(@dummy.avatar.url).to match(/.+\/5k.png/)
+    end
+
+    it "returns a url containing the correct processed file mime type" do
+      expect(@dummy.avatar.url(:large)).to match(/.+\/5k.jpg/)
+    end
+  end
+
+  describe "An attachment that uses Azure for storage and has spaces in file name" do
+    before do
+      rebuild_model storage: :azure,
+                    styles: { large: ["500x500#", :jpg] },
+                    container: "container",
+                    azure_credentials: {
+                      "storage_access_key" => "54321"
+                    }
+
+      File.open(fixture_file("spaced file.png"), "rb") do |file|
+        @dummy = Dummy.new
+        @dummy.avatar = file
+
+        allow(@dummy).to receive(:new_record?).and_return(false)
+      end
+    end
+
+    it "returns a replaced version for path" do
+      expect(@dummy.avatar.path).to match(/.+\/spaced_file\.png/)
+    end
+
+    it "returns a replaced version for url" do
+      expect(@dummy.avatar.url).to match(/.+\/spaced_file\.png/)
+    end
+  end
+
+  describe "An attachment that uses Azure for storage and has a question mark in file name" do
+    before do
+      rebuild_model storage: :azure,
+                    styles: { large: ['500x500#', :jpg] },
+                    container: "container",
+                    azure_credentials: {
+                      'storage_access_key' => "54321"
+                    }
+
+      stringio = stringy_file
+      class << stringio
+        def original_filename
+          "question?mark.png"
+        end
+      end
+
+      file = Paperclip.io_adapters.for(stringio, Paperclip::Attachment.default_options[:adapter_options])
+
+      @dummy = Dummy.new
+      @dummy.avatar = file
+      @dummy.save
+
+      allow(@dummy).to receive(:new_record?).and_return(false)
+    end
+
+    it "returns a replaced version for path" do
+      expect(@dummy.avatar.path).to match(/.+\/question_mark\.png/)
+    end
+
+    it "returns a replaced version for url" do
+      expect(@dummy.avatar.url).to match(/.+\/question_mark\.png/)
+    end
+  end
+
+  describe ":asset_host path Interpolations" do
+    before do
+      rebuild_model storage: :azure,
+        azure_credentials: {},
+        container: "container",
+        path: ":attachment/:basename:dotextension",
+        url: ":asset_host"
+      @dummy = Dummy.new
+      @dummy.avatar = stringy_file
+      allow(@dummy).to receive(:new_record?).and_return(false)
+    end
+
+    it "returns a relative URL for Rails to calculate assets host" do
+      expect(@dummy.avatar.url).to match(%r{^avatars/data[^\.]})
+    end
+  end
+
+  describe "#expiring_url" do
+    before { @dummy = Dummy.new }
+
+    describe "with no attachment" do
+      before { expect(@dummy.avatar.exists?).to be_falsey }
+
+      it "returns the default URL" do
+        expect(@dummy.avatar.expiring_url).to eq(@dummy.avatar.url)
+      end
+
+      it 'generates a url for a style when a file does not exist' do
+        expect(@dummy.avatar.expiring_url(3600, :thumb)).to eq(@dummy.avatar.url(:thumb))
+      end
+    end
+  end
+
+  describe "Generating a url with an expiration for each style" do
+    before do
+      rebuild_model storage: :azure,
+                    azure_credentials: {
+                      production: {
+                        storage_account_name: 'prod_storage',
+                        storage_access_key: 'YWNjZXNzLWtleQ==',
+                        container: "prod_container"
+                      },
+                      development: {
+                        storage_account_name: 'dev_storage',
+                        storage_access_key: 'YWNjZXNzLWtleQ==',
+                        container: "dev_container"
+                      }
+                    },
+                    path: ":attachment/:style/:basename:dotextension"
+
+      rails_env("production") do
+        @dummy = Dummy.new
+        @dummy.avatar = stringy_file
+      end
+    end
+
+    it "generates a url for the thumb" do
+      rails_env("production") do
+        expect(@dummy.avatar.expiring_url(1800, :thumb)).to include("https://prod_storage.blob.core.windows.net/prod_container/avatars/thumb/data")
+      end
+    end
+
+    it "generates a url for the default style" do
+      rails_env("production") do
+        expect(@dummy.avatar.expiring_url(1800)).to include("https://prod_storage.blob.core.windows.net/prod_container/avatars/original/data")
+      end
+    end
+  end
+
+  context "Parsing Azure credentials with a container in them" do
+    before do
+      rebuild_model storage: :azure,
+                    azure_credentials: {
+                      production: { container: "prod_container" },
+                      development: { container: "dev_container" }
+                    }
+      @dummy = Dummy.new
+    end
+
+    it "gets the right container in production" do
+      rails_env("production") do
+        expect(@dummy.avatar.container_name).to eq("prod_container")
+      end
+    end
+
+    it "gets the right container in development" do
+      rails_env("development") do
+        expect(@dummy.avatar.container_name).to eq("dev_container")
+      end
+    end
+  end
+
+  context "An attachment with Azure storage" do
+    before do
+      rebuild_model storage: :azure,
+                    container: "testing",
+                    path: ":attachment/:style/:basename:dotextension",
+                    azure_credentials: {
+                      storage_account_name: 'storage',
+                      storage_access_key: storage_access_key
+                    }
+    end
+
+    it "is extended by the Azure module" do
+      expect(Dummy.new.avatar).to be_a(Paperclip::Storage::Azure)
+    end
+
+    it "won't be extended by the Filesystem module" do
+      expect(Dummy.new.avatar).not_to be_a(Paperclip::Storage::Filesystem)
+    end
+    end
+
+  describe "An attachment with Azure storage and container defined as a Proc" do
+    before do
+      rebuild_model storage: :azure,
+                    container: lambda { |attachment| "container_#{attachment.instance.other}" },
+                    azure_credentials: {not: :important}
+    end
+
+    it "gets the right container name" do
+      expect(Dummy.new(other: 'a').avatar.container_name).to eq("container_a")
+      expect(Dummy.new(other: 'b').avatar.container_name).to eq("container_b")
+    end
+  end
+
+  context "An attachment with Azure storage and Azure credentials defined as a Proc" do
+    before do
+      rebuild_model storage: :azure,
+                    container: {not: :important},
+                    azure_credentials: lambda { |attachment|
+                      Hash['storage_access_key' => "secret#{attachment.instance.other}"]
+                    }
+    end
+
+    it "gets the right credentials" do
+      expect(Dummy.new(other: '1234').avatar.azure_credentials[:storage_access_key]).to eq("secret1234")
+    end
+  end
+
+  context "An attachment with Azure storage and Azure credentials in an unsupported manor" do
+    before do
+      rebuild_model storage: :azure,
+                    container: "testing",
+                    azure_credentials: ["unsupported"]
+      @dummy = Dummy.new
+    end
+
+    it "does not accept the credentials" do
+      expect { @dummy.avatar.azure_credentials }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "An attachment with Azure storage and Azure credentials not supplied" do
+    before do
+      rebuild_model storage: :azure, container: "testing"
+      @dummy = Dummy.new
+    end
+
+    it "does not parse any credentials" do
+      expect(@dummy.avatar.azure_credentials).to eq({})
+    end
+  end
+
+  describe "with Azure credentials supplied as Pathname" do
+    before do
+      ENV['AZURE_CONTAINER'] = 'pathname_container'
+      ENV['AZURE_STORAGE_ACCOUNT'] = 'pathname_storage_account'
+      ENV['AZURE_STORAGE_ACCESS_KEY'] = storage_access_key
+
+      rails_env('test') do
+        rebuild_model storage: :azure,
+          azure_credentials: Pathname.new(fixture_file('azure.yml'))
+
+        Dummy.delete_all
+        @dummy = Dummy.new
+      end
+    end
+
+    it "parses the credentials" do
+      expect(@dummy.avatar.container_name).to eq('pathname_container')
+    end
+  end
+
+  describe "with Azure credentials in a YAML file" do
+    before do
+      ENV['AZURE_CONTAINER'] = 'pathname_container'
+      ENV['AZURE_STORAGE_ACCOUNT'] = 'pathname_storage_account'
+      ENV['AZURE_STORAGE_ACCESS_KEY'] = storage_access_key
+
+      rails_env('test') do
+        rebuild_model storage: :azure,
+          azure_credentials: File.new(fixture_file('azure.yml'))
+
+        Dummy.delete_all
+
+        @dummy = Dummy.new
+      end
+    end
+
+    it "runs the file through ERB" do
+      expect(@dummy.avatar.container_name).to eq('pathname_container')
+    end
+  end
+
+  describe "path is a proc" do
+    before do
+      rebuild_model storage: :azure,
+                    path: ->(attachment) { attachment.instance.attachment_path }
+
+      @dummy = Dummy.new
+      @dummy.class_eval do
+        def attachment_path
+          '/some/dynamic/path'
+        end
+      end
+      @dummy.avatar = stringy_file
+    end
+
+    it "returns a correct path" do
+      expect(@dummy.avatar.path).to eq('/some/dynamic/path')
+    end
+  end
+
+  private
+
+  def rails_env(env)
+    stored_env, Rails.env = Rails.env, env
+    begin
+      yield
+    ensure
+      Rails.env = stored_env
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rspec'
+require 'active_record'
+require 'active_record/version'
+require 'active_support'
+require 'active_support/core_ext'
+require 'ostruct'
+require 'pathname'
+require 'activerecord-import'
+require 'yaml'
+require 'paperclip'
+
+ROOT = Pathname(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+
+$LOAD_PATH << File.join(ROOT, 'lib')
+$LOAD_PATH << File.join(ROOT, 'lib', 'paperclip')
+require File.join(ROOT, 'lib', 'paperclip-azure.rb')
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config['test'])
+if ActiveRecord::VERSION::STRING >= "4.2" &&
+    ActiveRecord::VERSION::STRING < "5.0"
+  ActiveRecord::Base.raise_in_transactional_callbacks = true
+end
+Paperclip.options[:logger] = ActiveRecord::Base.logger
+
+Dir[File.join(ROOT, 'spec', 'support', '**', '*.rb')].each{|f| require f }
+
+Rails = FakeRails.new('test', Pathname.new(ROOT).join('tmp'))
+ActiveSupport::Deprecation.silenced = true
+
+RSpec.configure do |config|
+  config.include ModelReconstruction
+  config.include TestData
+  config.extend VersionHelper
+  config.before(:all) do
+    rebuild_model
+  end
+end

data/spec/support/fake_model.rb

@@ -0,0 +1,25 @@
+class FakeModel
+  attr_accessor(
+    :avatar_file_name,
+    :avatar_file_size,
+    :avatar_updated_at,
+    :avatar_content_type,
+    :avatar_fingerprint,
+    :id
+  )
+
+  def errors
+    @errors ||= []
+  end
+
+  def run_paperclip_callbacks name, *args
+  end
+
+  def valid?
+    errors.empty?
+  end
+
+  def new_record?
+    false
+  end
+end

data/spec/support/fake_rails.rb

@@ -0,0 +1,12 @@
+class FakeRails
+  def initialize(env, root)
+    @env = env
+    @root = root
+  end
+
+  attr_accessor :env, :root
+
+  def const_defined?(const)
+    false
+  end
+end

data/spec/support/fixtures/azure.yml

@@ -0,0 +1,8 @@
+development:
+  storage_access_key: 54321
+production:
+  storage_access_key: 12345
+test:
+  container: <%= ENV['AZURE_CONTAINER'] %>
+  storage_account_name: <%= ENV['AZURE_STORAGE_ACCOUNT'] %>
+  storage_access_key: <%= ENV['AZURE_STORAGE_ACCESS_KEY'] %>

data/spec/support/fixtures/bad.png

@@ -0,0 +1 @@
+This is not an image.

data/spec/support/fixtures/empty.html

@@ -0,0 +1 @@
+<html></html>

data/spec/support/fixtures/fog.yml

@@ -0,0 +1,8 @@
+development:
+    provider: AWS
+    aws_access_key_id: AWS_ID
+    aws_secret_access_key: AWS_SECRET
+test:
+    provider: AWS
+    aws_access_key_id: AWS_ID
+    aws_secret_access_key: AWS_SECRET

data/spec/support/fixtures/text.txt

@@ -0,0 +1 @@
+paperclip!

data/spec/support/mock_attachment.rb

@@ -0,0 +1,24 @@
+class MockAttachment
+  attr_accessor :updated_at, :original_filename
+  attr_reader :options
+
+  def initialize(options = {})
+    @options = options
+    @model = options[:model]
+    @responds_to_updated_at = options[:responds_to_updated_at]
+    @updated_at = options[:updated_at]
+    @original_filename = options[:original_filename]
+  end
+
+  def instance
+    @model
+  end
+
+  def respond_to?(meth)
+    if meth.to_s == "updated_at"
+      @responds_to_updated_at || @updated_at
+    else
+      super
+    end
+  end
+end

data/spec/support/mock_interpolator.rb

@@ -0,0 +1,24 @@
+class MockInterpolator
+  def initialize(options = {})
+    @options = options
+  end
+
+  def interpolate(pattern, attachment, style_name)
+    @interpolated_pattern = pattern
+    @interpolated_attachment = attachment
+    @interpolated_style_name = style_name
+    @options[:result]
+  end
+
+  def has_interpolated_pattern?(pattern)
+    @interpolated_pattern == pattern
+  end
+
+  def has_interpolated_style_name?(style_name)
+    @interpolated_style_name == style_name
+  end
+
+  def has_interpolated_attachment?(attachment)
+    @interpolated_attachment == attachment
+  end
+end

data/spec/support/mock_url_generator_builder.rb

@@ -0,0 +1,27 @@
+class MockUrlGeneratorBuilder
+  def initializer
+  end
+
+  def new(attachment)
+    @attachment = attachment
+    @attachment_options = @attachment.options
+    self
+  end
+
+  def for(style_name, options)
+    @generated_url_with_style_name = style_name
+    @generated_url_with_options = options
+    "hello"
+  end
+
+  def has_generated_url_with_options?(options)
+    # options.is_a_subhash_of(@generated_url_with_options)
+    options.inject(true) do |acc,(k,v)|
+      acc && @generated_url_with_options[k] == v
+    end
+  end
+
+  def has_generated_url_with_style_name?(style_name)
+    @generated_url_with_style_name == style_name
+  end
+end