rai 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e3e45323e085e138807ed68cb37d8c59d02b7d0
-  data.tar.gz: 8a23e4f8448d84c90cabb0f5e1eb501977c1a0d1
+  metadata.gz: fbd2639a30affd2ab6bb5e765ceaba2f712227dd
+  data.tar.gz: 4b18403ea39077a3bae28c3bc3f515d2223fd8ad
 SHA512:
-  metadata.gz: 11b1deacc4d2fff0b5fedd45fabff32391df3759a5216ddd716aeebff6da7ba77c7375218cd529142fde08d0d0230edc5246e1578d0a7c6802e19b841154b4c7
-  data.tar.gz: f430662073ad9123d3b5b9c47ad25b106b44e0431c54a7289d43950279a465bfb4841fe6ade4e0cee1ede3292d0531de7682e0d82e5db356e0f0620b87c383bd
+  metadata.gz: 02914b17f67e9081d661d1b0f30241c0b16385847d8c29aa327695bbd741a437b7226c0391132060d19c18b5af65e25091f03ef504e29ce6796c716df7ee2dfe
+  data.tar.gz: 09daca9694b60a4af3d7ed8cc28ded965d155827970f5d01499e7a129505dccbd1beebafc6bb254ebf63a54bd6f81a9fceef4cc6bbde418729f8ebf154b291c0

data/.gitignore

@@ -2,3 +2,4 @@
 pkg
 *.cache
 Gemfile.lock
+config.ru

data/README.md

@@ -1,20 +1,23 @@
 # Ruby Adaptive-Images
-This is a ruby port of Adaptive-Images (http://adaptive-images.com/, originally by Matt Wilcox). It does not contain all features, but it does more or less the same in the same way. It uses ImageMagick (via mini_magick) in stead of GD.
+This is a ruby port of Adaptive-Images (http://adaptive-images.com/,
+originally by Matt Wilcox). It does not contain all features, but it does more
+or less the same in the same way. It uses ImageMagick (via mini\_magick) in
+stead of GD.
 
 It runs as a sinatra application that can be mounted using Rack.
 
 # Installation
 
-To install, run: `gem install rai`
+`gem install rai`
 
 # Configuration
 
 Put something like this in your config.ru:
 
-```
+```ruby
 require 'rai'
 
-map '/gallery' do
+map '/images' do
   Rai::App.set :img_path, '/path/to/your/images'
   Rai::App.set :cache_path, '/path/to/your/cache'
   run Rai::App
@@ -24,40 +27,61 @@ end
 
 ## Settings
 
-### :watch_cache
+### :watch\_cache
 Keep an eye on the cache to see if it needs updating.
+
 Values: true/false
+
 Default: true
 
 ### :resolutions
 Resolution break-points (screen widths).
+
 Value: array
-Default: [1382, 992, 768, 480, 320]
 
-### :jpg_quality
+Default: [2560, 1920, 1440, 1024, 768, 480]
+
+### :jpg\_quality
 JPG compression ratio, 0-100.
+
 Value: integer, 0-100
-Default: 75
+
+Default: 85
 
 ### :sharpen
 Wether image should be sharpened or not.
+
 Value: true/false
+
 Default: true
 
-### :cache_max_age
+### :cache\_max\_age
 Browser cache TTL
+
 Value: integer, seconds
+
 Default: 60*60*24*7 (7 days)
 
-### :img_path
+### :img\_path
 Where images are placed.
+
 Value: string, path
-Default:File.join(File.dirname(__FILE__), 'images')
 
-### :cache_path
+Default:File.join(File.dirname(__FILE__), '..', 'images')
+
+### :cache\_path
 Where cached versions are placed.
+
 Value: string, path
-Default: File.join(File.dirname(__FILE__), 'images', 'cache')
+
+Default: File.join(File.dirname(__FILE__), '..', 'images', 'rai-cache')
+
+### :cookie\_name
+The name of the resolution cookie.
+
+Value: string
+
+Default: rai-resolution
 
 # Author
 Kim Nørgaard <jasen@jasen.dk>

data/Rakefile

@@ -1,11 +1,3 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "rai/version"
 require 'bundler/gem_tasks'
-
-#task :build do
-#  system "gem build rai.gemspec"
-#end
-
-#task :release => :build do
-#  system "gem push rai-#{RAI::VERSION}.gem"
-#end

data/TODO.md

@@ -0,0 +1,8 @@
+# TODO
+  √ delete cookie if invalid
+  √ option to disable caching via parameter or route (nocache=1)
+  - maybe md5-sum for cache path (md5(request_path))
+  - transparent gift, transparent pngs
+  - check up on cookie-stuff - https://github.com/MattWilcox/Adaptive-Images/pull/139
+  - android pixel density - https://github.com/MattWilcox/Adaptive-Images/issues/99
+  - http client hints: https://github.com/MattWilcox/Adaptive-Images/pull/128

data/config.ru.sample

@@ -0,0 +1,7 @@
+require 'rai'
+
+map '/images' do
+  Rai::App.set :img_path, '/path/to/your/images'
+  Rai::App.set :cache_path, '/path/to/your/cache'
+  run Rai::App
+end

data/lib/rai.rb

@@ -1,146 +1,65 @@
-require 'sinatra'
+require 'sinatra/base'
 require 'mini_magick'
 require 'fileutils'
 
+require_relative 'rai/helpers'
+
 module Rai
   class App < Sinatra::Base
-    # keep an eye on the cache to see if it needs updating
+    # Keep an eye on the cache to see if it needs updating
     set :watch_cache, true
-    # resolution break-points (screen widths)
-    set :resolutions, [1382, 992, 768, 480, 320]
-    # jpg compression ratio, 0-100
-    set :jpg_quality, 75
-    # wether image should be sharpened or not
+
+    # Resolution break-points (screen widths)
+    set :resolutions, [2560, 1920, 1440, 1024, 768, 480]
+
+    # JPG compression ratio, 0-100
+    set :jpg_quality, 85
+
+    # Sharpen images after resize
     set :sharpen, true
-    # 7 days
+
+    # Cache Time-To-Live
     set :cache_max_age, 60*60*24*7
-    # where images are placed
-    set :img_path, File.join(File.dirname(__FILE__), 'images')
-    # where cached versions are placed
-    set :cache_path, File.join(File.dirname(__FILE__), 'images', 'cache')
 
-    get %r{.*?\.(jpg|jpeg|png|gif)$} do
-      @img_file = File.join(settings.img_path, @request_path)
-      not_found unless File.exists? @img_file
-      @cache_file = File.join(settings.cache_path, @resolution.to_s, @request_path)
-      @extension = params[:captures][0].downcase
+    # Image location
+    set :img_path, File.join(File.dirname(__FILE__), '..', 'images')
 
-      expires settings.cache_max_age, :private, :must_revalidate
+    # Cache location
+    set :cache_path, File.join(File.dirname(__FILE__), '..', 'images', 'rai-cache')
 
-      if File.exists? @cache_file
-        refresh_cache
-      else
-        update_cached_image
-      end
-      send_file @cache_file
-    end
+    # Cookie name
+    set :cookie_name, 'rai-resolution'
 
-    before do
-      @request_path = URI.decode(request.path_info)
-      settings.resolutions.sort!{|x,y| y <=> x }
-      @resolution = get_resolution
-    end
+    # Supported image types
+    set :supported_image_types, ['jpg', 'jpeg', 'gif', 'png']
+
+    helpers Rai::Helpers
+
+    get %r{.*?(\.(?<image_type>[\w]+))?$} do
+      halt(406, "No image type/extension given") unless params[:image_type]
+      halt(406, "Unsupported image type: #{params[:image_type]}") unless settings.supported_image_types.include? params[:image_type]
+
+      @request_path     = URI.decode(request.path_info)
+      @resolution       = get_resolution
+      @requested_image  = File.join(settings.img_path, @request_path)
+      not_found unless File.file? @requested_image
+      @cached_image     = File.join(settings.cache_path, @resolution.to_s, @request_path)
+
+      # Just send the original image if the nocache parameter is set to 1
+      send_file @requested_image if params[:nocache] == '1'
+
+      # Generate image or use cached version
+      update_image
+
+      # Set caching headers
+      expires settings.cache_max_age, :private, :must_revalidate
+      last_modified File.mtime(@requested_image)
 
-    helpers do
-      def get_resolution
-        get_resolution_from_cookie || get_resolution_from_user_agent
-      end
-
-      def get_resolution_from_cookie
-        if res_cookie = request.cookies['resolution']
-          cookie_data = res_cookie.split(',')
-          total_width = client_width = cookie_data[0].to_i
-          # the device's pixel density factor (physical pixels per CSS pixel)
-          pixel_density = cookie_data[1] ? cookie_data[1].to_i : 1
-          # by default use the largest supported break-point
-          resolution = settings.resolutions.first
-
-          if pixel_density != 1
-            total_width = client_width * pixel_density
-          end
-
-          resolution =
-            settings.resolutions.select {|res| total_width <= res}.last
-          resolution ||= settings.resolutions.first
-
-          if total_width > settings.resolutions.first
-            resolution *= pixel_density
-          end
-
-          return resolution
-        end
-      end
-
-      def get_resolution_from_user_agent
-        is_mobile ? settings.resolutions.min : settings.resolutions.max
-      end
-
-      def is_mobile
-        request.user_agent.downcase.match(/mobile/)
-      end
-
-      def refresh_cache
-        return unless settings.watch_cache
-        return if File.mtime(@cache_file) >= File.mtime(@img_file)
-
-        File.delete @cache_file
-        update_cached_image
-      end
-
-      def update_cached_image
-        cache_dir = File.dirname(@cache_file)
-        begin
-          #Dir.mkdir(settings.cache_path, 0755) unless File.directory?(settings.cache_path)
-          FileUtils.mkdir_p(cache_dir, :mode => 0755) unless File.directory?(cache_dir)
-        rescue SystemCallError => e
-          halt(500, "Unable to create caching directory. #{e}")
-        rescue => e
-          halt(500, "Unable to create caching directory. #{e}")
-        end
-
-        begin
-          image = MiniMagick::Image.open(@img_file)
-        rescue Exception => e
-          halt(500, "Error loading image: #{e}")
-        end
-
-        # Do we need to downscale the image?
-        if image[:width] <= @resolution
-          @cache_file = @img_file
-          return
-        end
-
-        ratio      = image["%[fx:w/h]"].to_f
-        new_width  = @resolution
-        new_height = (new_width*ratio).ceil
-
-        if @extension == 'jpg'
-          image.combine_options do |c|
-            c.interlace 'plane'
-            c.quality settings.jpg_quality
-          end
-        end
-
-        if settings.sharpen
-          radius    = 0.5
-          sigma     = 0.5
-          amount    = 1.0
-          threshold = 0.02
-          image.unsharp "#{radius}x#{sigma}+#{amount}+#{threshold}"
-        end
-
-        image.resize "#{new_width}x#{new_height}"
-
-        begin
-          image.write @cache_file
-        rescue Exception => e
-          halt(500, "Error writing cache file: #{e}")
-        end
-      end
+      send_file @cached_image
     end
 
     not_found do
-      "Not found: #{@request_path} not found."
+      "Not Found: #{request.path}"
     end
   end
 end

data/lib/rai/helpers.rb

@@ -0,0 +1,101 @@
+module Rai
+  module Helpers
+    def get_resolution
+      settings.resolutions.sort!{|x,y| y <=> x }
+      get_resolution_from_cookie || get_resolution_from_user_agent
+    end
+
+    def get_resolution_from_cookie
+      return false unless res_cookie = request.cookies[settings.cookie_name]
+
+      if res_cookie !~ /^[0-9]+[,]*[0-9\.]+$/
+        response.delete_cookie settings.cookie_name
+      else
+        cookie_data = res_cookie.split(',')
+        total_width = client_width = cookie_data[0].to_i
+        # the device's pixel density factor (physical pixels per CSS pixel)
+        pixel_density = cookie_data[1] ? cookie_data[1].to_i : 1
+        # by default use the largest supported break-point
+        resolution = settings.resolutions.first
+
+        total_width = client_width * pixel_density
+
+        resolution =
+          settings.resolutions.select {|res| total_width <= res}.last
+        resolution ||= settings.resolutions.first
+
+        if total_width > settings.resolutions.first
+          resolution *= pixel_density
+        end
+
+        return resolution
+      end
+    end
+
+    def get_resolution_from_user_agent
+      is_mobile ? settings.resolutions.min : settings.resolutions.max
+    end
+
+    def is_mobile
+      request.user_agent.downcase.match(/mobi|android|touch|mini/)
+    end
+
+    def update_image
+      # Refresh the image if the cached version is too old
+      if File.exists? @cached_image
+        return unless settings.watch_cache
+        return if File.mtime(@cached_image) >= File.mtime(@requested_image)
+        File.delete @cached_image
+      end
+
+      begin
+        image = MiniMagick::Image.open(@requested_image)
+      rescue Exception => e
+        halt(500, "Error loading image: #{e}")
+      end
+
+      # Do we need to downscale the image?
+      if image[:width] <= @resolution
+        @cached_image = @requested_image
+        return
+      end
+
+      cache_dir = File.dirname(@cached_image)
+
+      begin
+        FileUtils.mkdir_p(cache_dir, :mode => 0755) unless File.directory?(cache_dir)
+      rescue SystemCallError => e
+        halt(500, "Unable to create caching directory. #{e}")
+      rescue => e
+        halt(500, "Unable to create caching directory. #{e}")
+      end
+
+      ratio      = image["%[fx:w/h]"].to_f
+      new_width  = @resolution
+      new_height = (new_width*ratio).ceil
+
+      if params[:image_type] == 'jpg'
+        image.combine_options do |c|
+          c.interlace 'plane'
+          c.quality settings.jpg_quality
+        end
+      end
+
+      image.resize "#{new_width}x#{new_height}"
+
+      if settings.sharpen
+        radius    = 0.5
+        sigma     = 0.5
+        amount    = 1.0
+        threshold = 0.02
+        image.unsharp "#{radius}x#{sigma}+#{amount}+#{threshold}"
+      end
+
+      begin
+        image.write @cached_image
+      rescue Exception => e
+        halt(500, "Error writing cache file: #{e}")
+      end
+    end
+  end
+end

data/lib/rai/version.rb

@@ -1,3 +1,3 @@
 module Rai
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rai
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kim Nørgaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -48,8 +48,10 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- config.ru
+- TODO.md
+- config.ru.sample
 - lib/rai.rb
+- lib/rai/helpers.rb
 - lib/rai/version.rb
 - rai.gemspec
 homepage: https://github.com/KimNorgaard/rai

data/config.ru

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
-require 'rai'
-
-map('/photos') { run Rai::App }