refile 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66457e73d63efd2eafa3b150152d7615fc4c940a
-  data.tar.gz: e7e6744055b448670fd328a29fa97d122a332b4a
+  metadata.gz: bd423a66e8cd66e1dbb128aad4724806341335ea
+  data.tar.gz: 8eef6a2838a39c3d74b87fe03467905ea548145e
 SHA512:
-  metadata.gz: bf353ab538163c2716a2114f887855e87b083493186911dc61ca064a971d96b1b72a7282ec3531530da66187964f15243243d8b027655c5a192336e61e0a50c6
-  data.tar.gz: ebd0c248bdccaa5ad714764df5fc2dcac65922a0148019a9a897fc676bf1cabde9cb74794a7a5620c23d238e2f56f697d8b3ee4ebc163395deaf01ba3ab80fea
+  metadata.gz: 7b2b30128fd4f7980a5b3e1b490fa47f17acf38c7bc458b0eec8a117856c90d087606341055ff1af77b9b37138849020a219c9cd59d6640ff30334595d4d6162
+  data.tar.gz: 4a01443db981b687b7933463cfa5a1a1837f8e16470cfdbf4d4fb3bf9f609d2334afebbb803c8735cf1836626ef1e3e0ace656ceae19bbce49132fbea873b2af

data/History.md

@@ -1,3 +1,9 @@
+# 0.3.0
+
+Release date: 2014-12-14
+
+- [ADDED] Can upload files via URL
+
 # 0.2.5
 
 Release date: 2014-12-12

data/README.md

@@ -506,6 +506,34 @@ end
 Now when you check this checkbox and submit the form, the previously attached
 file will be removed.
 
+## Fetching remote files by URL
+
+You might want to give you users the option of uploading a file by its URL.
+This could be either just via a textfield or through some other interface.
+Refile makes it easy to fetch this file and upload it. Just add a field like
+this:
+
+``` erb
+<%= form_for @user do |form| %>
+  <%= form.label :profile_image, "Attach image" %>
+  <%= form.attachment_field :profile_image %>
+
+  <%= form.label :remote_profile_image_url, "Or specify URL" %>
+  <%= form.text_field :remote_profile_image_url %>
+<% end %>
+```
+
+Then permit this field in your controller:
+
+``` ruby
+def user_params
+  params.require(:user).permit(:profile_image, :profile_image_cache_id, :remote_profile_image_url)
+end
+```
+
+Refile will now fetch the file from the given URL, following redirects if
+needed.
+
 ## Cache expiry
 
 Files will accumulate in your cache, and you'll probably want to remove them

data/Rakefile

@@ -3,6 +3,11 @@ $LOAD_PATH.unshift(File.expand_path("spec", File.dirname(__FILE__)))
 require "bundler/gem_tasks"
 require "refile/test_app"
 require "rspec/core/rake_task"
+require "yard"
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["README.md", "lib/**/*.rb"]
+end
 
 RSpec::Core::RakeTask.new(:spec)
 

data/config/locales/en.yml

@@ -3,3 +3,4 @@ en:
     errors:
       messages:
         too_large: "is too large"
+        download_failed: "could not be downloaded"

data/lib/refile.rb

@@ -1,47 +1,140 @@
 require "uri"
 require "fileutils"
 require "tempfile"
+require "rest_client"
 
 module Refile
   class Invalid < StandardError; end
 
   class << self
-    attr_accessor :read_chunk_size, :app, :host, :direct_upload
-    attr_writer :store, :cache
 
+    # The number of bytes to read when files are streamed. Refile
+    # uses this in a couple of places where files should be streamed
+    # in a memory efficient way instead of reading the entire file into
+    # memory at once. The default value of this is `3000`.
+    #
+    # @return [Fixnum]
+    attr_accessor :read_chunk_size
+
+    # A shortcut to the instance of the Rack application. This should be
+    # set when the application is initialized. `refile/rails` sets this
+    # value.
+    #
+    # @return [Refile::App, nil]
+    attr_accessor :app
+
+    # The host name that the Rack application can be reached at. If not set,
+    # Refile will use an absolute URL without hostname. It is strongly
+    # recommended to run Refile behind a CDN and to set this to the hostname of
+    # the CDN distribution. A protocol relative URL is recommended for this
+    # value.
+    #
+    # @return [String, nil]
+    attr_accessor :host
+
+    # A list of names which identify backends in the global backend registry.
+    # The Rack application allows POST requests to only the backends specified
+    # in this config option. This defaults to `["cache"]`, only allowing direct
+    # uploads to the cache backend.
+    #
+    # @return [Array[String]]
+    attr_accessor :direct_upload
+
+    # A global registry of backends.
+    #
+    # @return [Hash{String => Backend}]
     def backends
       @backends ||= {}
     end
 
+    # A global registry of processors. These will be used by the Rack
+    # application to manipulate files prior to serving them up to the user,
+    # based on options sent trough the URL. This can be used for example to
+    # resize images or to convert files to another file format.
+    #
+    # @return [Hash{String => Proc}]
     def processors
       @processors ||= {}
     end
 
+    # Adds a processor. The processor must respond to `call`, both receiving
+    # and returning an IO-like object. Alternatively a block can be given to
+    # this method which also receives and returns an IO-like object.
+    #
+    # An IO-like object is recommended to be an instance of the `IO` class or
+    # one of its subclasses, like `File` or a `StringIO`, or a `Refile::File`.
+    # It can also be any other object which responds to `size`, `read`, `eof`?
+    # and `close` and mimics the behaviour of IO objects for these methods.
+    #
+    # @example With processor class
+    #   class Reverse
+    #     def call(file)
+    #       StringIO.new(file.read.reverse)
+    #     en
+    #   end
+    #   Refile.processor(:reverse, Reverse)
+    #
+    # @example With block
+    #   Refile.processor(:reverse) do |file|
+    #     StringIO.new(file.read.reverse)
+    #   end
+    #
+    # @param [#to_s] name           The name of the processor
+    # @param [Proc, nil] processor  The processor, must respond to `call` and.
+    # @yield [Refile::File]         The file to modify
+    # @yieldreturn [IO]             An IO-like object representing the processed file
     def processor(name, processor = nil, &block)
       processor ||= block
       processors[name.to_s] = processor
     end
 
+    # A shortcut to retrieving the backend named "store" from the global
+    # registry.
+    #
+    # @return [Backend]
     def store
       backends["store"]
     end
 
+    # A shortcut to setting the backend named "store" in the global registry.
+    #
+    # @param [Backend] backend
     def store=(backend)
       backends["store"] = backend
     end
 
+    # A shortcut to retrieving the backend named "cache" from the global
+    # registry.
+    #
+    # @return [Backend]
     def cache
       backends["cache"]
     end
 
+    # A shortcut to setting the backend named "cache" in the global registry.
+    #
+    # @param [Backend] backend
     def cache=(backend)
       backends["cache"] = backend
     end
 
+    # Yield the Refile module as a convenience for configuring multiple
+    # config options at once.
+    #
+    # @yield Refile
     def configure
       yield self
     end
 
+    # Verify that the given uploadable is indeed a valid uploadable. This
+    # method is used by backends as a sanity check, you should not have to use
+    # this method unless you are writing a backend.
+    #
+    # @param [IO] uploadable    The uploadable object to verify
+    # @param [Fixnum] max_size  The maximum size of the uploadable object
+    # @raise [ArgumentError]    If the uploadable is not an IO-like object
+    # @raise [Refile::Invalid]  If the uploadable's size is too large
+    # @return [true]            Always returns true if it doesn't raise
     def verify_uploadable(uploadable, max_size)
       [:size, :read, :eof?, :close].each do |m|
         unless uploadable.respond_to?(m)

data/lib/refile/app.rb

@@ -9,6 +9,7 @@ module Refile
       @allow_origin = allow_origin
     end
 
+    # @api private
     class Proxy
       def initialize(peek, file)
         @peek = peek

data/lib/refile/attachment.rb

@@ -1,9 +1,8 @@
 module Refile
   module Attachment
-    IMAGE_TYPES = %w[jpg jpeg gif png]
-
+    # @api private
     class Attachment
-      attr_reader :record, :name, :cache, :store, :cache_id, :options
+      attr_reader :record, :name, :cache, :store, :cache_id, :options, :errors
       attr_accessor :remove
 
       def initialize(record, name, **options)
@@ -24,7 +23,7 @@ module Refile
       end
 
       def file
-        if cache_id and not cache_id == ""
+        if cached?
           cache.get(cache_id)
         elsif id and not id == ""
           store.get(id)
@@ -40,6 +39,16 @@ module Refile
         raise if @options[:raise_errors]
       end
 
+      def download(url)
+        if url and not url == ""
+          raw_response = RestClient::Request.new(method: :get, url: url, raw_response: true).execute
+          self.file = raw_response.file
+        end
+      rescue RestClient::Exception
+        @errors = [:download_failed]
+        raise if @options[:raise_errors]
+      end
+
       def cache_id=(id)
         @cache_id = id unless @cache_file
       end
@@ -65,20 +74,28 @@ module Refile
       end
 
       def remove?
-        remove.present? and remove !~ /\A0|false$\z/
+        remove and remove != "" and remove !~ /\A0|false$\z/
       end
 
-      def errors
-        @errors
-      end
-
-      private
+    private
 
       def cached?
         cache_id and not cache_id == ""
       end
     end
 
+    # Macro which generates accessors for the given column which make it
+    # possible to upload and retrieve previously uploaded files through the
+    # generated accessors.
+    #
+    # The +raise_errors+ option controls whether assigning an invalid file
+    # should immediately raise an error, or save the error and defer handling
+    # it until later.
+    #
+    # @param [String] name                 Name of the column which accessor are generated for
+    # @param [#to_s] cache                 Name of a backend in +Refile.backends+ to use as transient cache
+    # @param [#to_s] store                 Name of a backend in +Refile.backends+ to use as permanent store
+    # @param [true, false] raise_errors    Whether to raise errors in case an invalid file is assigned
     def attachment(name, cache: :cache, store: :store, raise_errors: true)
       attachment = :"#{name}_attachment"
 
@@ -112,6 +129,13 @@ module Refile
       define_method "remove_#{name}" do
         send(attachment).remove
       end
+
+      define_method "remote_#{name}_url=" do |url|
+        send(attachment).download(url)
+      end
+
+      define_method "remote_#{name}_url" do
+      end
     end
   end
 end

data/lib/refile/attachment/active_record.rb

@@ -3,6 +3,9 @@ module Refile
     module Attachment
       include Refile::Attachment
 
+      # Attachment method which hooks into ActiveRecord models
+      #
+      # @see Refile::Attachment#attachment
       def attachment(name, cache: :cache, store: :store, raise_errors: false)
         super
 

data/lib/refile/backend/s3.rb

@@ -2,7 +2,10 @@ require "aws-sdk"
 
 module Refile
   module Backend
+
+    # A refile backend which stores files in Amazon S3
     class S3
+
       # Emulates an IO-object like interface on top of S3Object#read. To avoid
       # memory allocations and unnecessary complexity, this treats the `length`
       # parameter to read as a boolean flag instead. If given, it will read the

data/lib/refile/rails.rb

@@ -2,17 +2,6 @@ require "refile"
 require "refile/rails/attachment_helper"
 
 module Refile
-  module Controller
-    def show
-      file = Refile.backends.fetch(params[:backend_name]).get(params[:id])
-
-      options = { disposition: "inline" }
-      options[:type] = Mime::Type.lookup_by_extension(params[:format]).to_s if params[:format]
-
-      send_data file.read, options
-    end
-  end
-
   module AttachmentFieldHelper
     def attachment_field(method, options = {})
       self.multipart = true

data/lib/refile/rails/attachment_helper.rb

@@ -2,6 +2,7 @@ module Refile
   module AttachmentHelper
     def attachment_url(record, name, *args, filename: nil, format: nil)
       file = record.send(name)
+      return unless file
 
       filename ||= name.to_s
 

data/lib/refile/random_hasher.rb

@@ -1,4 +1,9 @@
+# A file hasher which ignores the file contents and always returns a random string.
 class Refile::RandomHasher
+
+  # Generate a random string
+  #
+  # @return [String]
   def hash(uploadable=nil)
     SecureRandom.hex(30)
   end

data/lib/refile/version.rb

@@ -1,3 +1,3 @@
 module Refile
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

data/refile.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "spec"]
 
   spec.required_ruby_version = ">= 2.1.0"
+  spec.add_dependency "rest-client", "~> 1.7.2"
 
+  spec.add_development_dependency "webmock", "~> 1.20.4"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
@@ -31,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rails", "~> 4.1.8"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "yard"
 end

data/spec/refile/attachment_spec.rb

@@ -31,6 +31,64 @@ describe Refile::Attachment do
     end
   end
 
+  describe "remote_:name_url=" do
+    it "does nothign when nil is assigned" do
+      instance.remote_document_url = nil
+      expect(instance.document).to be_nil
+    end
+
+    it "does nothign when empty string is assigned" do
+      instance.remote_document_url = nil
+      expect(instance.document).to be_nil
+    end
+
+    context "without redirects" do
+      before(:each) do
+        stub_request(:get, "http://www.example.com/some_file").to_return(status: 200, body: "abc", headers: { "Content-Length" => 3 })
+      end
+
+      it "downloads file, caches it and sets the _id parameter" do
+        instance.remote_document_url = "http://www.example.com/some_file"
+        expect(Refile.cache.get(instance.document.id).read).to eq("abc")
+        expect(Refile.cache.get(instance.document_cache_id).read).to eq("abc")
+      end
+    end
+
+    context "with redirects" do
+      before(:each) do
+        stub_request(:get, "http://www.example.com/1").to_return(status: 302, headers: { "Location" => "http://www.example.com/2" })
+        stub_request(:get, "http://www.example.com/2").to_return(status: 200, body: "woop", headers: { "Content-Length" => 4 })
+        stub_request(:get, "http://www.example.com/loop").to_return(status: 302, headers: { "Location" => "http://www.example.com/loop" })
+      end
+
+      it "follows redirects and fetches the file, caches it and sets the _id parameter" do
+        instance.remote_document_url = "http://www.example.com/1"
+        expect(Refile.cache.get(instance.document.id).read).to eq("woop")
+        expect(Refile.cache.get(instance.document_cache_id).read).to eq("woop")
+      end
+
+      context "when errors enabled" do
+        let(:options) { { raise_errors: true } }
+        it "handles redirect loops by trowing errors" do
+          expect do
+            instance.remote_document_url = "http://www.example.com/loop"
+          end.to raise_error(RestClient::MaxRedirectsReached)
+        end
+      end
+
+      context "when errors disabled" do
+        let(:options) { { raise_errors: false } }
+        it "handles redirect loops by setting generic download error" do
+          expect do
+            instance.remote_document_url = "http://www.example.com/loop"
+          end.not_to raise_error
+          expect(instance.document_attachment.errors).to eq([:download_failed])
+          expect(instance.document).to be_nil
+        end
+      end
+    end
+  end
+
   describe ":name_cache_id" do
     it "doesn't overwrite a cached file" do
       instance.document = Refile::FileDouble.new("hello")

data/spec/refile/features/normal_upload_spec.rb

@@ -60,4 +60,17 @@ feature "Normal HTTP Post file uploads" do
     expect(page).to have_selector("h1", text: "A cool post")
     expect(page).to_not have_selector(:link, "Document")
   end
+
+  scenario "Upload a file from a remote URL" do
+    stub_request(:get, "http://www.example.com/some_file").to_return(status: 200, body: "abc", headers: { "Content-Length" => 3 })
+
+    visit "/normal/posts/new"
+    fill_in "Title", with: "A cool post"
+    fill_in "Remote document url", with: "http://www.example.com/some_file"
+    click_button "Create"
+
+    expect(page).to have_selector("h1", text: "A cool post")
+    click_link("Document")
+    expect(page.source.chomp).to eq("abc")
+  end
 end

data/spec/refile/spec_helper.rb

@@ -1,5 +1,6 @@
 require "refile"
 require "refile/backend_examples"
+require "webmock/rspec"
 
 tmp_path = Dir.mktmpdir
 
@@ -15,13 +16,13 @@ class FakePresignBackend < Refile::Backend::FileSystem
 
   def presign
     id = Refile::RandomHasher.new.hash
-    Signature.new("file", id, "/presigned/posts/upload", { token: "xyz123", id: id })
+    Signature.new("file", id, "/presigned/posts/upload", token: "xyz123", id: id)
   end
 end
 
 Refile.backends["limited_cache"] = FakePresignBackend.new(File.expand_path("default_cache", tmp_path), max_size: 100)
 
-Refile.direct_upload = ["cache", "limited_cache"]
+Refile.direct_upload = %w(cache limited_cache)
 
 Refile.processor(:reverse) do |file|
   StringIO.new(file.read.reverse)
@@ -48,7 +49,6 @@ Refile.processor(:convert_case) do |file, format:|
   end
 end
 
-
 class Refile::FileDouble
   def initialize(data)
     @io = StringIO.new(data)
@@ -79,5 +79,7 @@ end
 
 RSpec.configure do |config|
   config.include PathHelper
+  config.before(:all) do
+    WebMock.disable_net_connect!(allow_localhost: true)
+  end
 end
-

data/spec/refile/test_app/app/controllers/normal_posts_controller.rb

@@ -34,6 +34,6 @@ class NormalPostsController < ApplicationController
   private
 
   def post_params
-    params.require(:post).permit(:title, :image, :image_cache_id, :document, :document_cache_id, :remove_document)
+    params.require(:post).permit(:title, :image, :image_cache_id, :document, :document_cache_id, :remove_document, :remote_document_url)
   end
 end

data/spec/refile/test_app/app/views/normal_posts/_form.html.erb

@@ -18,6 +18,10 @@
     <%= form.label :remove_document %>
     <%= form.check_box :remove_document %>
   </p>
+  <p>
+    <%= form.label :remote_document_url %>
+    <%= form.text_field :remote_document_url %>
+  </p>
   <p>
     <%= form.submit %>
   </p>

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: refile
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonas Nicklas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jonas.nicklas@gmail.com
@@ -298,3 +340,4 @@ test_files:
 - spec/refile/test_app/config/routes.rb
 - spec/refile/test_app/public/favicon.ico
 - spec/refile_spec.rb
+has_rdoc: