image_vise 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fd7e2b6f4a49ab832e600a46708d2974b74ed17
-  data.tar.gz: 1b13d15d9e99308a001ee62aeed21bf3e45c7429
+  metadata.gz: ec4d4b81f950cbc31ce3ac5c43d311c0049a5497
+  data.tar.gz: d3558ea48e705fe17e18fff1036d48f8c1ecdd3d
 SHA512:
-  metadata.gz: 04fcaa4b8fba508845ba29634636edf9f67758d21687754d9d2117d82eefb22282cb22a678de26f4f0e31980a509beb9f6e62b229e08ebfe6dc1b2d5718f83b6
-  data.tar.gz: 6ac6c1bda81dbfa6b2ce27106277d016ff725ac80a51a116cba447a51fc878cb89393110e53f4c06befc65d617f041d6fc865a824103c1b9d8803ec776408989
+  metadata.gz: b21bc99a45b1b6830d7f38b6b507103d50603e5fd370167a9f1d2ba9eb941d332580fa5d713f20a80e58eeb21cb2e0e9a79a2ea8054e12a816d7260a33299d50
+  data.tar.gz: e14e15cf5306b14cb53e7f89e306753bc1e4c3db601f689716d7c146636b8d701e02d2f1144fa152c26a4aa1ff07925945a2eae55db608f697d534a8d39b0a0a

data/README.md

@@ -23,30 +23,38 @@ take care of encoding the source URL and the commands in the right way, as well
 
 Mount ImageVise in your `routes.rb`:
 
-    mount '/images' => ImageVise
+```ruby
+mount '/images' => ImageVise
+```
 
 and add an initializer (like `config/initializers/image_vise_config.rb`) to set up the permitted hosts
 
-    ImageVise.add_allowed_host! your_application_hostname
-    ImageVise.add_secret_key! ENV.fetch('IMAGE_VISE_SECRET')
+```ruby
+ImageVise.add_allowed_host! your_application_hostname
+ImageVise.add_secret_key! ENV.fetch('IMAGE_VISE_SECRET')
+```
 
 You might want to define a helper method for generating signed URLs as well, which will look something like this:
 
-    def thumb_url(source_image_url)
-      qs_params = ImageVise.image_params(src_url: source_image_url, secret: ENV.fetch('IMAGE_VISE_SECRET')) do |pipeline|
-         # For example, you can also yield `pipeline` to the caller
-        pipeline.fit_crop width: 128, height: 128, gravity: 'c'
-      end
-      '/images?' + Rack::Utils.build_query(qs_params) # or use url_for...
-    end
+```ruby
+def thumb_url(source_image_url)
+  qs_params = ImageVise.image_params(src_url: source_image_url, secret: ENV.fetch('IMAGE_VISE_SECRET')) do |pipeline|
+     # For example, you can also yield `pipeline` to the caller
+    pipeline.fit_crop width: 128, height: 128, gravity: 'c'
+  end
+  '/images?' + Rack::Utils.build_query(qs_params) # or use url_for...
+end
+```
 
 ## Using ImageVise within a Rack application
 
 Mount ImageVise under a script name in your `config.ru`:
 
-    map '/images' do
-      run ImageVise
-    end
+```ruby
+map '/images' do
+  run ImageVise
+end
+```
 
 and add the initialization code either to `config.ru` proper or to some file in your application:
 
@@ -55,16 +63,17 @@ and add the initialization code either to `config.ru` proper or to some file in
 
 You might want to define a helper method for generating signed URLs as well, which will look something like this:
 
-    def thumb_url(source_image_url)
-      qs_params = ImageVise.image_params(src_url: source_image_url, secret: ENV.fetch('IMAGE_VISE_SECRET')) do |pipe|
-        pipe.fit_crop width: 256, height: 256, gravity: 'c'
-        pipe.sharpen sigma: 0.5, radius: 2
-        pipe.ellipse_stencil
-      end
-      # Output a URL to the app
-      '/images?' + Rack::Utils.build_query(image_request)
-    end
-
+```ruby
+def thumb_url(source_image_url)
+  qs_params = ImageVise.image_params(src_url: source_image_url, secret: ENV.fetch('IMAGE_VISE_SECRET')) do |pipe|
+    pipe.fit_crop width: 256, height: 256, gravity: 'c'
+    pipe.sharpen sigma: 0.5, radius: 2
+    pipe.ellipse_stencil
+  end
+  # Output a URL to the app
+  '/images?' + Rack::Utils.build_query(image_request)
+end
+```
 
 ## Processing files on the local filesystem instead of remote ones
 
@@ -93,27 +102,32 @@ of decent image filtering choices in ImageMagick proper).
 
 Here is an example pipeline, JSON-encoded (this is what is passed in the URL):
 
-    [
-      ["auto_orient", {}],
-      ["geom", {"geometry_string": "512x512"}],
-      ["fit_crop", {"width": 32, "height": 32, "gravity": "se"}],
-      ["sharpen", {"radius": 0.75, "sigma": 0.5}],
-      ["ellipse_stencil", {}]
-    ]
+```json
+[
+  ["auto_orient", {}],
+  ["geom", {"geometry_string": "512x512"}],
+  ["fit_crop", {"width": 32, "height": 32, "gravity": "se"}],
+  ["sharpen", {"radius": 0.75, "sigma": 0.5}],
+  ["ellipse_stencil", {}]
+]
+```
 
 The same pipeline can be created using the `Pipeline` DSL:
 
-    pipe = Pipeline.new.
-      auto_orient.
-      geom(geometry_string: '512x512').
-      fit_crop(width: 32, height: 32, gravity: 'se').
-      sharpen(radius: 0.75, sigma: 0.5).
-      ellipse_stencil
-
+```ruby
+pipe = Pipeline.new.
+  auto_orient.
+  geom(geometry_string: '512x512').
+  fit_crop(width: 32, height: 32, gravity: 'se').
+  sharpen(radius: 0.75, sigma: 0.5).
+  ellipse_stencil
+```
 and can then be applied to a `Magick::Image` object:
 
-     image = Magick::Image.read(my_image_path)[0]
-     pipe.apply!(image)
+```ruby
+image = Magick::Image.read(my_image_path)[0]
+pipe.apply!(image)
+```
 
 ## Performance and memory
 
@@ -161,7 +175,9 @@ CDN.
 To allow `ImageVise` to recognize the signature when the signature is going to be received, add it to the list
 of the shared keys on the `ImageVise` server:
 
-    ImageVise.add_secret_key!('ahoy! this is a secret!')
+```ruby
+ImageVise.add_secret_key!('ahoy! this is a secret!')
+```
 
 A single `ImageVise` server can maintain multiple signature keys, so that you will be able to generate thumbnails from
 multiple applications all using different keys for their signatures. Every request will be validated against
@@ -173,18 +189,72 @@ accepted and the request will be allowed to go through.
 By default, `ImageVise` will refuse to process images from URLs on "unknown" hosts. To mark a host as "known"
 tell `ImageVise` to
 
-    ImageVise.add_allowed_host!('my-image-store.ourcompany.co.uk')
+```ruby
+ImageVise.add_allowed_host!('my-image-store.ourcompany.co.uk')
+```
 
 If you want to permit images from the local server filesystem to be accessed, add the glob pattern
 to the set of allowed filesystem patterns:
 
-    ImageVise.allow_filesystem_source!(Rails.root + '/public/*.jpg')
+```ruby
+ImageVise.allow_filesystem_source!(Rails.root + '/public/*.jpg')
+```
 
 Note that these are _glob_ patterns. The image path will be checked against them using `File.fnmatch`.
 
+## Handling errors within the rendering Rack app
+
+By default, the Rack app within ImageVise swallows all exceptions and returns the error message
+within a machine-readable JSON payload. If that doesn't work for you, or you want to add error
+handling using some error tracking provider, either subclass `ImageVise::RenderEngine` or prepend
+a module into it that will intercept the errors. For example, [Sentry](https://sentry.io) has a neat
+property of picking up `rack.exception` from the Rack request env. Using the hooks in the render engine,
+you can add Sentry support by using the following module:
+
+```ruby
+module ImageViseSentrySupport
+  ImageVise::RenderEngine.prepend self
+
+  def setup_error_handling(rack_env)
+    @env = rack_env
+  end
+
+  def handle_request_error(err)
+    @env['rack.exception'] = err
+  end
+
+  def handle_generic_error(err)
+    @env['rack.exception'] = err
+  end
+end
+```
+
+For [Appsignal](https://appsignal.com) you can use the following module instead:
+
+```ruby
+module ImageViseAppsignal
+  ImageVise::RenderEngine.prepend self
+  
+  def setup_error_handling(rack_env)
+    txn = Appsignal::Transaction.current
+    txn.set_action('%s#%s' % [self.class, 'call'])
+  end
+
+  def handle_request_error(err)
+    Appsignal.add_exception(err)
+  end
+
+  def handle_generic_error(err)
+    Appsignal.add_exception(err)
+  end
+end
+```
+
+In both cases you need the overall Rack error handling middleware to be wrapping ImageVise, of course.
+
 ## State
 
-Except for the HTTP cache for redirects et.al no state is stored (`ImageVise` does not care whether you store
+Except for the HTTP cache no state is stored (`ImageVise` does not care whether you store
 your images using Dragonfly, CarrierWave or some custom handling code). All the app needs is the full URL.
 
 ## Running the tests, versioning, contributing

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.0.19 ruby lib
+# stub: image_vise 0.0.20 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "image_vise"
-  s.version = "0.0.19"
+  s.version = "0.0.20"
 
   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-16"
+  s.date = "2016-10-17"
   s.description = "Image processing via URLs"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "lib/image_vise/sRGB_v4_ICC_preference_displayclass.icc",
     "lib/image_vise/sharpen.rb",
     "lib/image_vise/srgb.rb",
+    "lib/image_vise/strip_metadata.rb",
     "spec/image_vise/auto_orient_spec.rb",
     "spec/image_vise/crop_spec.rb",
     "spec/image_vise/ellipse_stencil_spec.rb",
@@ -49,6 +50,7 @@ Gem::Specification.new do |s|
     "spec/image_vise/render_engine_spec.rb",
     "spec/image_vise/sharpen_spec.rb",
     "spec/image_vise/srgb_spec.rb",
+    "spec/image_vise/strip_metadata_spec.rb",
     "spec/image_vise_spec.rb",
     "spec/spec_helper.rb",
     "spec/test_server.rb",

data/lib/image_vise.rb

@@ -4,9 +4,11 @@ require 'patron'
 require 'rmagick'
 require 'magic_bytes'
 require 'thread'
+require 'base64'
+require 'rack'
 
 class ImageVise
-  VERSION = '0.0.19'
+  VERSION = '0.0.20'
   S_MUTEX = Mutex.new
   private_constant :S_MUTEX
   

data/lib/image_vise/image_request.rb

@@ -1,6 +1,3 @@
-require 'base64'
-require 'rack'
-
 class ImageVise::ImageRequest < Ks.strict(:src_url, :pipeline)
   class InvalidRequest < ArgumentError; end
   class SignatureError < InvalidRequest; end

data/lib/image_vise/render_engine.rb

@@ -1,6 +1,4 @@
 class ImageVise::RenderEngine
-  require_relative 'image_request'
-  require_relative 'file_response'
   class UnsupportedInputFormat < StandardError; end
   class EmptyRender < StandardError; end
 

data/lib/image_vise/strip_metadata.rb

@@ -0,0 +1,10 @@
+# Strips metadata from the image (EXIF, IPTC etc.) using the
+# RMagick `strip!` method
+#
+# The corresponding Pipeline method is `strip_metadata`.
+class ImageVise::StripMetadata
+  def apply!(magick_image)
+    magick_image.strip!
+  end
+  ImageVise.add_operator 'strip_metadata', self
+end

data/spec/image_vise/geom_spec.rb

@@ -5,6 +5,22 @@ describe ImageVise::Geom do
     expect { described_class.new(geometry_string: nil) }.to raise_error(ArgumentError)
   end
 
+  it 'fits to height' do
+    image = Magick::Image.read(test_image_path)[0]
+    crop = described_class.new(geometry_string: 'x200')
+    crop.apply!(image)
+    expect(image.rows).to eq(200)
+    examine_image(image, 'fit-height-200')
+  end
+
+  it 'fits to width' do
+    image = Magick::Image.read(test_image_path)[0]
+    crop = described_class.new(geometry_string: '100x')
+    crop.apply!(image)
+    expect(image.columns).to eq(100)
+    examine_image(image, 'fit-width-100')
+  end
+
   it 'applies various geometry strings' do
     %w( ^220x110 !20x20 !10x100 ).each do |geom_string|
       image = Magick::Image.read(test_image_path)[0]

data/spec/image_vise/pipeline_spec.rb

@@ -37,8 +37,10 @@ describe ImageVise::Pipeline do
     pipeline = subject.
       auto_orient.
       fit_crop(width: 48, height: 48, gravity: 'c').
+      srgb.
       sharpen(radius: 2, sigma: 0.5).
-      ellipse_stencil
+      ellipse_stencil.
+      strip_metadata
     
     image = Magick::Image.read(test_image_path)[0]
     pipeline.apply! image

data/spec/image_vise/strip_metadata_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe ImageVise::StripMetadata do
+  it 'applies the strip! method to the image' do
+    image = Magick::Image.read(test_image_path).first
+    expect(image).to receive(:strip!).and_call_original
+    described_class.new.apply!(image)
+  end
+
+  it 'is registered with the operator registry' do
+    op = ImageVise.operator_from('strip_metadata')
+    expect(op).to eq(described_class)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: image_vise
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-16 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -267,6 +267,7 @@ files:
 - lib/image_vise/sRGB_v4_ICC_preference_displayclass.icc
 - lib/image_vise/sharpen.rb
 - lib/image_vise/srgb.rb
+- lib/image_vise/strip_metadata.rb
 - spec/image_vise/auto_orient_spec.rb
 - spec/image_vise/crop_spec.rb
 - spec/image_vise/ellipse_stencil_spec.rb
@@ -278,6 +279,7 @@ files:
 - spec/image_vise/render_engine_spec.rb
 - spec/image_vise/sharpen_spec.rb
 - spec/image_vise/srgb_spec.rb
+- spec/image_vise/strip_metadata_spec.rb
 - spec/image_vise_spec.rb
 - spec/spec_helper.rb
 - spec/test_server.rb