image_vise 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9dbe4f26897009011c3a9f42b233e7e232d6634
-  data.tar.gz: 6910d9c75d0a2c2c13b9a3688d7302cd22758992
+  metadata.gz: 8fd6c51aedf4fe76ee330a75a0a967da91397452
+  data.tar.gz: 7ce66027f5c46d4812591884efea60047ceefca7
 SHA512:
-  metadata.gz: 1bb4e6b545fc8d847ed9a6462c4cf5c2bc3b4cec035df034e0c5cc7da982d9cc8bc680fc438c467ea5e6e3b063a2eb26c31daf250bcb59324899488e7a14f58d
-  data.tar.gz: 01d4a26bf68dead0b3c58d5c6ecbf07759be957a8c5594e57ca3b9e792d92dbd061ad7ee46cf7301f113cc730eea473d87e8c626ec05b7dc4c12590858fc62b2
+  metadata.gz: f5ef54f0cd31ebde260bcb9f580dabf303e3bf10a9b451bea1eb0999a89cb71c3b8a55124bb86313fbaba4f5f25143250fabaf78318758f6426fb8c4a8a43a6c
+  data.tar.gz: ccd3a779a38de87d4f7e35c9d11cebeef2b8c748a3fbd5331716c749f1e7d4d223ace28bc352ba5b7447630b85330ee030fd229b3b0784b34f8e1ccdd257a214

data/DEVELOPMENT.md

@@ -55,7 +55,20 @@ it:
     
     ImageVise.register_fetcher 'profilepictures', self
 
-Once done, you can use URLs like `profilepictures:/5674`
+Once done, you can use URLs like `profilepictures:/5674`. A very simple Fetcher would just
+override the standard filesystem one (be mindful that the filesystem fetcher still checks
+path access using the glob whitelist)
+
+    class PicFetcher < ImageVise::FetcherFile
+      def self.fetch_uri_to_tempfile(uri_object)
+        # Convert an internal "pic://sites/uploads/abcdef.jpg" to a full path URL
+        partial_path = URI.decode(uri_object.path)
+        full_path = File.join(Mappe::ROOT, 'sites', partial_path)
+        full_path_uri = URI('file://' + URI.encode(full_path))
+        super(full_path_uri)
+      end
+      ImageVise.register_fetcher 'pic', self
+    end
 
 ## Overriding the render engine
 
@@ -95,4 +108,15 @@ actually using them. If you are using a library it is a one-time cost, with very
 
 Also note that image operators are not per definition Imagemagick-specific - it's completely possible to not only use
 a different library for processing them, but even to use a different image processing server complying to the
-same protocol (a signed JSON-encodded waybill of HTTP(S) source-URL + pipeline instructions).
+same protocol (a signed JSON-encodded waybill of HTTP(S) source-URL + pipeline instructions).
+
+## Using forked child processes for RMagick tasks
+
+You can optionally set the `IMAGE_VISE_ENABLE_FORK` environment variable to `yes` to enable forking. When this
+variable is set, ImageVise will fork a child process and perform the image processing task within that process,
+killing it afterwards and deallocating all the memory. This can be extremely efficient for dealing with potential
+memory bloat issues in ImageMagick/RMagick. However, loading images into RMagick may hang in a forked child. This
+will lead to the child being timeout-terminated, and no image is going to be rendered. This issue is known and
+also platform-dependent (it does not happen on OSX but does happen on Docker within Ubuntu Trusty for instance).
+
+So, this feature _does_ exist but your mileage may vary with regards to it's use.

data/README.md

@@ -176,17 +176,6 @@ within a machine-readable JSON payload. If that doesn't work for you, or you wan
 handling using some error tracking provider, either subclass `ImageVise::RenderEngine` or prepend
 a module into it that will intercept the errors. See error handling in `examples/` for more.
 
-## Using forked child processes for RMagick tasks
-
-You can optionally set the `IMAGE_VISE_ENABLE_FORK` environment variable to `yes` to enable forking. When this
-variable is set, ImageVise will fork a child process and perform the image processing task within that process,
-killing it afterwards and deallocating all the memory. This can be extremely efficient for dealing with potential
-memory bloat issues in ImageMagick/RMagick. However, loading images into RMagick may hang in a forked child. This
-will lead to the child being timeout-terminated, and no image is going to be rendered. This issue is known and
-also platform-dependent (it does not happen on OSX but does happen on Docker within Ubuntu Trusty for instance).
-
-So, this feature _does_ exist but your mileage may vary with regards to it's use.
-
 ## State
 
 Except for the HTTP cache no state is stored (`ImageVise` does not care whether you store

data/image_vise.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: image_vise 0.1.0 ruby lib
+# stub: image_vise 0.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "image_vise"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2016-10-20"
+  s.date = "2016-10-22"
   s.description = "Image processing via URLs"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -49,6 +49,8 @@ Gem::Specification.new do |s|
     "spec/image_vise/auto_orient_spec.rb",
     "spec/image_vise/crop_spec.rb",
     "spec/image_vise/ellipse_stencil_spec.rb",
+    "spec/image_vise/fetcher_file_spec.rb",
+    "spec/image_vise/fetcher_http_spec.rb",
     "spec/image_vise/file_response_spec.rb",
     "spec/image_vise/fit_crop_spec.rb",
     "spec/image_vise/geom_spec.rb",

data/lib/image_vise/fetchers/fetcher_file.rb

@@ -20,7 +20,7 @@ class ImageVise::FetcherFile
     patterns = ImageVise.allowed_filesystem_sources
     matches = patterns.any? { |glob_pattern| File.fnmatch?(glob_pattern, path_on_filesystem) }
     raise AccessError, "filesystem access is disabled" unless patterns.any?
-    raise AccessError, "#{src_url} is not on the path whitelist" unless matches
+    raise AccessError, "#{path_on_filesystem} is not on the path whitelist" unless matches
   end
 
   ImageVise.register_fetcher 'file', self

data/lib/image_vise/fetchers/fetcher_http.rb

@@ -33,9 +33,8 @@ class ImageVise::FetcherHTTP
   
   def self.verify_uri_access!(uri)
     host = uri.host
-    unless ImageVise.allowed_hosts.include?(uri.host)
-      raise AccessError, "#{uri} is not permitted as source"
-    end
+    return if ImageVise.allowed_hosts.include?(uri.host)
+    raise AccessError, "#{uri} is not permitted as source"
   end
 
   ImageVise.register_fetcher 'http', self

data/lib/image_vise/file_response.rb

@@ -1,7 +1,7 @@
 # Wrappers a given Tempfile for a Rack response.
 # Will close _and_ unlink the Tempfile it contains.
 class ImageVise::FileResponse
-  ONE_CHUNK_BYTES = 1024 * 512
+  ONE_CHUNK_BYTES = 1024 * 1024 * 2
   def initialize(file)
     @file = file
   end

data/lib/image_vise.rb

@@ -8,7 +8,7 @@ require 'base64'
 require 'rack'
 
 class ImageVise
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   S_MUTEX = Mutex.new
   private_constant :S_MUTEX
   

data/spec/image_vise/fetcher_file_spec.rb

@@ -0,0 +1,48 @@
+require_relative '../spec_helper'
+
+describe ImageVise::FetcherFile do
+  it 'is a class (can be inherited from)' do
+    expect(ImageVise::FetcherFile).to be_kind_of(Class)
+  end
+
+  it 'is registered as a fetcher for file://' do
+    expect(ImageVise.fetcher_for('file')).to eq(ImageVise::FetcherFile)
+  end
+  
+  it 'returns a Tempfile containing this test suite' do
+    path = File.expand_path(__FILE__)
+    ruby_files_in_this_directory = __dir__ + '/*.rb'
+    ImageVise.allow_filesystem_source! ruby_files_in_this_directory
+    
+    uri = URI('file://' + URI.encode(path))
+    fetched = ImageVise::FetcherFile.fetch_uri_to_tempfile(uri)
+
+    expect(fetched).to be_kind_of(Tempfile)
+    expect(fetched.size).to eq(File.size(__FILE__))
+    expect(fetched.pos).to be_zero
+  end
+
+  it 'raises a meaningful exception if no file sources are permitted' do
+    path = File.expand_path(__FILE__)
+
+    ImageVise.deny_filesystem_sources!
+
+    uri = URI('file://' + URI.encode(path))
+    expect {
+      ImageVise::FetcherFile.fetch_uri_to_tempfile(uri)
+    }.to raise_error(ImageVise::FetcherFile::AccessError)
+  end
+  
+  it 'raises a meaningful exception if this file is not permitted as source' do
+    path = File.expand_path(__FILE__)
+
+    text_files_in_this_directory = __dir__ + '/*.txt'
+    ImageVise.deny_filesystem_sources!
+    ImageVise.allow_filesystem_source! text_files_in_this_directory
+
+    uri = URI('file://' + URI.encode(path))
+    expect {
+      ImageVise::FetcherFile.fetch_uri_to_tempfile(uri)
+    }.to raise_error(ImageVise::FetcherFile::AccessError)
+  end
+end

data/spec/image_vise/fetcher_http_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../spec_helper'
+
+describe ImageVise::FetcherHTTP do
+  it 'is a class (can be inherited from)' do
+    expect(ImageVise::FetcherHTTP).to be_kind_of(Class)
+  end
+
+  it 'is registered as a fetcher for http:// and https://' do
+    expect(ImageVise.fetcher_for('http')).to eq(ImageVise::FetcherHTTP)
+    expect(ImageVise.fetcher_for('https')).to eq(ImageVise::FetcherHTTP)
+  end
+
+  it 'raises an AccessError if the host of the URL is not on the whitelist' do
+    uri = URI('https://wrong-origin.com/image.psd')
+    expect {
+      ImageVise::FetcherHTTP.fetch_uri_to_tempfile(uri)
+    }.to raise_error(ImageVise::FetcherHTTP::AccessError, /is not permitted as source/)
+  end
+
+  it 'raises an UpstreamError if the upstream fetch returns an error-ish status code' do
+    uri = URI('http://localhost:9001/forbidden')
+    ImageVise.add_allowed_host! 'localhost'
+    
+    expect {
+      ImageVise::FetcherHTTP.fetch_uri_to_tempfile(uri)
+    }.to raise_error {|e|
+      expect(e).to be_kind_of(ImageVise::FetcherHTTP::UpstreamError)
+      expect(e.message).to include(uri.to_s)
+      expect(e.message).to include('403')
+      expect(e.http_status).to eq(403)
+    }
+  end
+
+  it 'fetches the image into a Tempfile' do
+    uri = URI(public_url_psd)
+    ImageVise.add_allowed_host! 'localhost'
+
+    result = ImageVise::FetcherHTTP.fetch_uri_to_tempfile(uri)
+
+    expect(result).to be_kind_of(Tempfile)
+    expect(result.size).to be_nonzero
+    expect(result.pos).to be_zero
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_vise
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -292,6 +292,8 @@ files:
 - spec/image_vise/auto_orient_spec.rb
 - spec/image_vise/crop_spec.rb
 - spec/image_vise/ellipse_stencil_spec.rb
+- spec/image_vise/fetcher_file_spec.rb
+- spec/image_vise/fetcher_http_spec.rb
 - spec/image_vise/file_response_spec.rb
 - spec/image_vise/fit_crop_spec.rb
 - spec/image_vise/geom_spec.rb