lorem-image-ware 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.rvmrc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lorem-image-ware.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brendon Murphy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Lorem::Image::Ware
+
+Rack middleware for proxying requests to [lorempixel.com](http://lorempixel.com)
+
+This mounts routing in your Rack stack so that paths like `/lorem/image/400/200` will
+serve a 400x200 random image from lorempixel.com.
+
+The middleware is primarily useful because it will cache responses from lorempixel so
+that after a few page loads, images should load much faster.  Without such local
+caching you will be stuck hammering their server on every page load, and waiting a
+few seconds for images to fill in.
+
+It is recommended to only load the middleware in development environtments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lorem-image-ware'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lorem-image-ware
+
+## Usage
+
+Mount in your app stack like:
+
+```ruby
+use LoremImageWare::Middleware
+```
+
+If you wish to serve off a directory other than the default `/lorem`, pass the `:root` option:
+
+```ruby
+use LoremImageWare::Middleware, :root => "/random_images"
+```
+
+There is a small Helpers module you can include for generating lorem image tags for you.  For example
+in Sinatra classical:
+
+```ruby
+helpers LoremImageWare::Helpers
+
+# In a view
+lorem_image_tag(:height => 400, :width => 200, :tag => "sports", :class => "some-class")
+```
+
+The helper will add a class of `lorem-image` to tags for you, as well as populate the dimensions
+and set inline height and width styling on the image.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+

data/lib/lorem-image-ware.rb

@@ -0,0 +1,90 @@
+require "lorem-image-ware/version"
+require "net/http"
+require "uri"
+
+module LoremImageWare
+  class LoremPixelProvider
+    def initialize(grayscale = false)
+      @grayscale = grayscale
+    end
+
+    def url(params)
+      tag = params[:tag] || "abstract"
+      url = ["http://lorempixel.com", @grayscale ? "g" : nil, params[:width], params[:height], tag].compact.join("/")
+      url += "/?r=#{rand(20)}"
+      url
+    end
+  end
+
+  module Helpers
+    def lorem_image_root
+      "/lorem"
+    end
+
+    def lorem_image_path(options = {})
+      height = options.fetch(:height, 200)
+      width  = options.fetch(:width, 400)
+      tag    = options.fetch(:tag, "abstract")
+
+      "#{lorem_image_root}/image/#{width}/#{height}/#{tag}?r=#{rand(99)}"
+    end
+
+    def lorem_image_tag(options = {})
+      height     = options.fetch(:height, 200)
+      width      = options.fetch(:width, 400)
+      html_class = [options[:class], "lorem-image"].compact.join(" ")
+
+      %Q{<img src="#{lorem_image_path(options)}" class="#{html_class}" width="#{width}" height="#{height}" style="height: #{height}px; width: #{width}px;" />}
+    end
+  end
+
+  class Middleware
+    def initialize(app, options = {})
+      @app     = app
+      @options = options
+    end
+
+    def call(env)
+      self.dup._call(env)
+    end
+
+    def _call(env)
+      request = Rack::Request.new(env)
+
+      if request.fullpath =~ %r{^#{root}/image/(\d+)/(\d+)/?(/(\S+))?}i
+        url = provider.url(width: $1, height: $2, tag: $4)
+        serve_image(url)
+      else
+        @app.call(env)
+      end
+    end
+
+    def serve_image(url)
+      if image_data = fetch_image(url)
+        Rack::Response.new([], 200, {"Content-Type" => "image/jpeg"}).finish do |res|
+          res.write(image_data)
+        end
+      else
+        [404, {"Content-Type" => "test/plain"}, ["Not found"]]
+      end
+    end
+
+    def fetch_image(url)
+      @@image_cache ||= Hash.new do |h, url|
+        uri = URI(url)
+        res = Net::HTTP.get_response(uri)
+        h[url] = res.body if res.code == "200"
+      end
+
+      @@image_cache[url]
+    end
+
+    def root
+      @options.fetch(:root, "/lorem")
+    end
+
+    def provider
+      @provider ||= @options.fetch(:provider, LoremPixelProvider.new)
+    end
+  end
+end

data/lib/lorem-image-ware/version.rb

@@ -0,0 +1,3 @@
+module LoremImageWare
+  VERSION = "0.0.1"
+end

data/lorem-image-ware.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/lorem-image-ware/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brendon Murphy"]
+  gem.email         = ["xternal1+github@gmail.com"]
+  gem.summary       = %q{rack middleware for proxying requests to lorempixel.com}
+  gem.description   = gem.summary
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.name          = "lorem-image-ware"
+  gem.require_paths = ["lib"]
+  gem.version       = LoremImageWare::VERSION
+
+  gem.add_dependency "rack"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rack-test"
+  gem.add_development_dependency "minitest"
+end

data/test/helpers_test.rb

@@ -0,0 +1,24 @@
+require_relative "./test_helper"
+
+class TestHelpers < MiniTest::Unit::TestCase
+  include LoremImageWare::Helpers
+
+  def test_default_image_root
+    assert_equal "/lorem", lorem_image_root
+  end
+
+  def test_default_image_path
+    path = lorem_image_path
+    assert_match %r{^/lorem/image/400/200/abstract\?r=\d+$}, path
+  end
+
+  def test_image_path
+    path = lorem_image_path(:height => 50, :width => 100, :tag => "sports")
+    assert_match %r{^/lorem/image/100/50/sports\?r=\d+$}, path
+  end
+
+  def test_image_tag
+    image_tag = lorem_image_tag(:height => 50, :width => 100, :tag => "sports", :class => "klass")
+    assert_match %r{<img src="/lorem/image/100/50/sports\?r=\d+" class="klass lorem-image" width="100" height="50" style="height: 50px; width: 100px;" />}, image_tag
+  end
+end

data/test/middleware_test.rb

@@ -0,0 +1,61 @@
+require_relative "./test_helper"
+require "ostruct"
+
+class TestCase < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+end
+
+class TestPassThru < TestCase
+  def app
+    Rack::Builder.new do
+      use LoremImageWare::Middleware
+      run lambda { |env| [200, { 'Content-Type' => "text/plain" }, ["path = #{env['PATH_INFO']}"]] }
+    end
+  end
+
+  def test_root
+    get "/"
+    assert_equal "path = /", last_response.body
+  end
+
+  def test_hello
+    get "/hello"
+    assert_equal "path = /hello", last_response.body
+  end
+end
+
+class TestSimpleLorem < TestCase
+  def setup
+    @provider = MiniTest::Mock.new
+  end
+
+  def app
+    Rack::Builder.new do
+      use LoremImageWare::Middleware
+      run lambda { |env| [200, { 'Content-Type' => "text/plain" }, ["path = #{env['PATH_INFO']}"]] }
+    end
+  end
+
+  def test_width_and_height
+    get "/lorem/image/400/200"
+    assert_equal 200, last_response.status
+    assert_equal "image/jpeg", last_response.headers["Content-Type"]
+    assert last_response.headers["Content-Length"]
+    assert last_response.headers["Content-Length"].to_i > 0
+  end
+
+  def test_tag_param
+    get "/lorem/image/400/200/sports"
+    assert_equal 200, last_response.status
+    assert_equal "image/jpeg", last_response.headers["Content-Type"]
+  end
+
+  def test_bad_url
+    response = OpenStruct.new(:code => 404, :body => "not found")
+
+    Net::HTTP.stub(:get_response, response) do   # stub goes away once the block is done
+      get "/lorem/image/100/200"
+      assert_equal 404, last_response.status
+    end
+  end
+end

data/test/providers_test.rb

@@ -0,0 +1,21 @@
+require_relative "./test_helper"
+
+class TestLoremPixelProvider < MiniTest::Unit::TestCase
+  def test_basic_color_url
+    provider = LoremImageWare::LoremPixelProvider.new
+    url = provider.url(width: 400, height: 200)
+    assert_match %r{http://lorempixel.com/400/200/abstract/\?r=\d+$}, url
+  end
+
+  def test_optional_tag
+    provider = LoremImageWare::LoremPixelProvider.new
+    url = provider.url(width: 200, height: 100, tag: "sports")
+    assert_match %r{http://lorempixel.com/200/100/sports/\?r=\d+$}, url
+  end
+
+  def test_grayscale_url
+    provider = LoremImageWare::LoremPixelProvider.new(:grayscale)
+    url = provider.url(width: 200, height: 100)
+    assert_match %r{http://lorempixel.com/g/200/100/abstract/\?r=\d+$}, url
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "minitest/unit"
+require "rack/test"
+require "minitest/autorun"
+require_relative "../lib/lorem-image-ware"
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: lorem-image-ware
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2156488720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156488720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156488300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156488300
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2156487880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156487880
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2156487460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156487460
+description: rack middleware for proxying requests to lorempixel.com
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lorem-image-ware.rb
+- lib/lorem-image-ware/version.rb
+- lorem-image-ware.gemspec
+- test/helpers_test.rb
+- test/middleware_test.rb
+- test/providers_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1682226714333622018
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1682226714333622018
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: rack middleware for proxying requests to lorempixel.com
+test_files:
+- test/helpers_test.rb
+- test/middleware_test.rb
+- test/providers_test.rb
+- test/test_helper.rb