dink 0.0.4

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dink.gemspec
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# Dink
+
+### Currently under development, you probably don't want to download this.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/dink.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dink/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dink"
+  s.version     = Dink::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Graham Powrie"]
+  s.email       = ["graham@developmentnow.com"]
+  s.homepage    = ""
+  s.summary     = %q{On-the-fly image resizing and management for mobile devices}
+  s.description = %q{}
+
+  s.rubyforge_project = "dink"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('addressable', '~> 2.2.2')
+  s.add_dependency('json', '~> 1.4.6')
+end

data/lib/dink/batch.rb

@@ -0,0 +1,39 @@
+module Dink
+  class Batch
+    
+    attr_accessor :images
+    
+    # Batch is just an array of images
+    def initialize
+      self.images = []
+    end
+    
+    # Send images to Dink for transformation, first +screen+ and translate +to_json+
+    def deliver
+      Dink.sender.send_image_process_data(self.to_json)
+    end
+    
+    # Ready images for transport across voidy vastness of teh interweb
+    def to_json
+      JSON.generate(self.images.collect{|i| i.to_hash})
+    end
+    
+    # :nodoc:
+    def << image
+      self.images << image
+    end
+    
+    # :nodoc:
+    def size
+      self.images.size
+    end
+    alias_method :length, :size
+    
+    # :nodoc:
+    def empty?
+      return true if self.size == 0
+      false
+    end
+
+  end
+end

data/lib/dink/configuration.rb

@@ -0,0 +1,104 @@
+module Dink
+  # Used to set up and modify settings for the notifier.
+  class Configuration
+
+    OPTIONS = [:api_key, :host, :http_open_timeout, :http_read_timeout, :project_root,
+    :port, :protocol, :secure, :framework].freeze
+
+    # The API key for your project, found on the project edit form.
+    attr_accessor :api_key
+
+    # The host to connect to
+    attr_accessor :host
+    
+    # The CDN host to connect to
+    attr_accessor :cdn_host
+
+    # The port on which your server runs (defaults to 443 for secure
+    # connections, 80 for insecure connections).
+    attr_accessor :port
+
+    # +true+ for https connections, +false+ for http connections.
+    attr_accessor :secure
+
+    # The path to the project in which the error occurred, such as the RAILS_ROOT
+    attr_accessor :project_root
+
+    # The logger used by 
+    attr_accessor :logger
+
+    # The framework is configured to use
+    attr_accessor :framework
+    
+    # The HTTP open timeout in seconds (defaults to 2).
+    attr_accessor :http_open_timeout
+
+    # The HTTP read timeout in seconds (defaults to 5).
+    attr_accessor :http_read_timeout
+
+    alias_method :secure?, :secure
+
+    def initialize
+      @secure                   = false
+      @host                     ||= 'dink.developmentnow.com'
+      @port                     ||= 80
+      @cdn_host                 = 'd15ceu2kbcb932.cloudfront.net'
+      @framework                = 'Standalone'
+      @protocol                 = protocol
+      @http_open_timeout        = 2
+      @http_read_timeout        = 10
+    end
+
+    # Allows config options to be read like a hash
+    #
+    # @param [Symbol] option Key for a given attribute
+    def [](option)
+      send(option)
+    end
+    
+    def url
+      url = URI::HTTP.build({
+        :host => @host,
+        :scheme => protocol,
+        :path => "/",
+        :port => @port
+      })
+    end
+
+    # Returns a hash of all configurable options
+    def to_hash
+      OPTIONS.inject({}) do |hash, option|
+        hash.merge(option.to_sym => send(option))
+      end
+    end
+
+    # Returns a hash of all configurable options merged with +hash+
+    #
+    # @param [Hash] hash A set of configuration options that will take precedence over the defaults
+    def merge(hash)
+      to_hash.merge(hash)
+    end
+
+    def port
+      @port || default_port
+    end
+
+    def protocol
+      if secure?
+        'https'
+      else
+        'http'
+      end
+    end
+
+    private
+
+    def default_port
+      if secure?
+        443
+      else
+        80
+      end
+    end
+  end
+end

data/lib/dink/image.rb

@@ -0,0 +1,72 @@
+module Dink
+
+  # Intermediate utility class for image manipulation
+  class Image
+
+    SLUG_ABBREVIATIONS = { 
+      :device_width_ratio => "dwr"
+    }
+    
+    PROCESS_OPTIONS = [
+      "device_width_ratio"
+    ]
+
+    # The public location of the image
+    attr_accessor :source, :device_width_ratio
+    
+    # :nodoc:
+    def initialize(source, options)
+      self.source               = source
+      self.device_width_ratio   = options[:device_width_ratio] || 1
+    end
+    
+    # Generates a SHA1 represenation for a particular URL
+    def url_id
+      Digest::SHA1.hexdigest(self.source)
+    end
+    
+    # Combines resizing parameters into a short, unique slug to be appended to the final image name
+    def params_slug
+      PROCESS_OPTIONS.map do |option|
+        param_slug(option)
+      end.join("")
+    end
+    
+    # The full image name, a combination of +url_id+ and +params_slug+
+    def name
+      url_id + "_" + params_slug
+    end
+    
+    # Location on server that will server this image
+    def cdn_url
+      Dink.configuration.protocol + "://" +
+      Dink.configuration.cdn_host +
+      "/images/" +
+      Dink.configuration.api_key + "/" +
+      self.name
+    end
+    
+    def deliver
+      Dink.sender.send_image_process_data("[#{self.to_json}]")
+    end
+    
+    # Ready images for transport across voidy vastness of teh interweb
+    def to_json
+      JSON.generate(self.to_hash)
+    end
+    
+    # A hash representation of the image attributes
+    def to_hash
+      {
+        :source => self.source,
+        :name => self.name,
+      }
+    end
+    
+    private
+    def param_slug(param_name)
+      SLUG_ABBREVIATIONS[param_name.to_sym] + self.send(param_name).to_s
+    end
+
+  end
+end

data/lib/dink/rack.rb

@@ -0,0 +1,14 @@
+# Simply grab the headers out of the request for use later
+module Dink
+  class Rack
+    
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Dink.sender.user_agent = env["HTTP_USER_AGENT"]
+      @app.call(env)
+    end
+  end
+end

data/lib/dink/rails/helpers.rb

@@ -0,0 +1,31 @@
+module Dink
+  module Helpers
+    include ActionView::Helpers
+    
+    # Take image transform parameters and generate an image tag and stick it into the batch
+    def dink!(source, process_options = {}, image_options = {})
+      image = Dink::Image.new(source, process_options).deliver
+      Rails.logger.debug{ image.inspect }
+      # @image_batch << image
+      image_tag(image["results"]["url"], image_options)
+    end
+
+    # def stream_resize(image_source)
+    #   b = Benchmark.measure do
+    #     @params = Addressable::URI.parse(url.to_s) # TODO get URI.parse out of Addressable to remove the dependency
+    #     @params.query_values = {:image_source => image_source, :stream => "1"}
+    #   end
+    #   # logger.debug { "STREAM BENCHMARK :: #{b}" }
+    # 
+    #   stream_url = url
+    #   stream_url.path = "/resize"
+    #   stream_url.query = @params.query
+    #   stream_url.to_s
+    # end
+    
+    def logger
+      Dink.configuration.logger
+    end
+
+  end
+end

data/lib/dink/rails/hooks.rb

@@ -0,0 +1,17 @@
+module Dink
+  module Hooks
+  
+    def self.included(base)
+      base.before_filter :image_batch
+      base.append_before_filter :deliver_batch
+    end
+
+    def image_batch
+      @image_batch = Dink::Batch.new
+    end
+    def deliver_batch
+      @image_batch.deliver unless @image_batch.empty?
+    end
+    
+  end
+end

data/lib/dink/railtie.rb

@@ -0,0 +1,34 @@
+require 'dink'
+require 'rails'
+
+module Dink
+  class Railtie < Rails::Railtie
+    initializer "dink.use_rack_middleware" do |app|
+      app.config.middleware.use "Dink::Rack"
+    end
+
+    config.before_initialize do
+      Dink.configure do |config|
+        # config.host             = "localhost"
+        # config.port             = 3000
+        config.logger           ||= Rails.logger
+        config.framework        = "Rails: #{::Rails::VERSION::STRING}"
+      end
+
+      config.to_prepare do
+        require 'dink/rails/hooks'
+        ActiveSupport.on_load(:action_controller) do
+          include Dink::Hooks
+        end
+      end
+
+
+      if defined?(ActionView::Base)
+
+        require 'dink/rails/helpers'
+        ActionView::Base.send :include, Dink::Helpers
+
+      end
+    end
+  end
+end

data/lib/dink/receiver.rb

@@ -0,0 +1,29 @@
+module Dink
+  class Receiver
+
+    def initialize(options = {})
+    end
+    
+    def receive(response)
+      case response
+      when Net::HTTPSuccess then
+        log :info, "Success: #{response.class}", response
+        
+        return JSON.parse(response.body)
+      else
+        log :error, "Failure: #{response.class}", response
+      end
+    end
+
+    def logger
+      Dink.configuration.logger
+    end
+
+    def log(level, message, response = nil)
+      logger.send level, LOG_PREFIX + message if logger
+      Dink.report_environment_info
+      Dink.report_response_body(response.body) if response && response.respond_to?(:body)
+    end
+
+  end
+end

data/lib/dink/sender.rb

@@ -0,0 +1,55 @@
+module Dink
+  class Sender
+    PROCESS_HEADERS = {
+      'Content-Type'    => 'application/json',
+      'Accept'          => 'application/json'
+    }
+
+    HTTP_ERRORS = [Timeout::Error,
+      Errno::EINVAL,
+      Errno::ECONNRESET,
+      EOFError,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+    Errno::ECONNREFUSED].freeze
+
+    attr_accessor :user_agent
+
+    def initialize(options = {})
+      [:protocol, :host, :port, :secure, :http_open_timeout, :http_read_timeout].each do |option|
+        instance_variable_set("@#{option}", options[option])
+      end
+    end
+
+    def send_image_process_data(data)
+      http              = Net::HTTP.new(@host, @port)
+
+      http.read_timeout = @http_read_timeout
+      http.open_timeout = @http_open_timeout
+      http.use_ssl      = false
+      headers           = PROCESS_HEADERS.merge({'User-Agent' => user_agent})
+
+      log :debug "Sending to: #{@host}:#{@port}"
+      response = begin
+        http.post("/link/#{Dink.configuration.api_key}", data, headers)
+      rescue *HTTP_ERRORS => e
+        log :error, "Timeout while contacting the server. #{e}"
+        nil
+      end
+
+      Dink.receiver.receive(response)
+    end
+
+    def log(level, message, response = nil)
+      logger.send level, LOG_PREFIX + message if logger
+      Dink.report_environment_info
+      Dink.report_response_body(response.body) if response && response.respond_to?(:body)
+    end
+
+    def logger
+      Dink.configuration.logger
+    end
+
+  end
+end

data/lib/dink/version.rb

@@ -0,0 +1,3 @@
+module Dink
+  VERSION = "0.0.4"
+end

data/lib/dink.rb

@@ -0,0 +1,67 @@
+module Dink
+  require 'net/http'
+  require 'net/https'
+  require 'addressable/uri'
+  require 'json'
+  # begin
+  #   require 'active_support'
+  # rescue LoadError
+  #   require 'activesupport'
+  # end
+  
+  require 'dink/configuration'
+  require 'dink/sender'
+  require 'dink/receiver'
+  require 'dink/rack'
+  require 'dink/image'
+  require 'dink/batch'
+  require 'dink/railtie' if defined?(Rails)
+  
+  LOG_PREFIX = "[Dink] "
+
+  class << self
+    
+    # The sender object is responsible for delivering formatted data to the server.
+    attr_accessor :sender
+
+    # A configuration object. Must act like a hash and return sensible
+    # values for all configuration options. See Dink::Configuration.
+    attr_accessor :configuration
+    
+    # A receiver of requests
+    attr_accessor :receiver
+    
+    def configure(silent = false)
+      self.configuration ||= Configuration.new
+      yield(configuration)
+      self.sender = Sender.new(configuration)
+      self.receiver = Receiver.new(configuration)
+    end
+    
+    def logger
+      self.configuration.logger
+    end
+    
+    # Prints out the environment info to the log for debugging help
+    def report_environment_info
+      write_verbose_log("Environment Info: #{environment_info}")
+    end
+
+    # Prints out the response body from Dink for debugging help
+    def report_response_body(response)
+      write_verbose_log("Response from Server: \n#{response}")
+    end
+
+    # Returns the Ruby version, Rails version, and current Rails environment
+    def environment_info
+      info = "[Ruby: #{RUBY_VERSION}]"
+      info << " [#{configuration.framework}]"
+    end
+
+    # Writes out the given message to the #logger
+    def write_verbose_log(message)
+      logger.info LOG_PREFIX + message if logger
+    end
+
+  end
+end

data/spec/batch_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink/batch')
+
+describe Dink::Batch do
+  before(:each) do
+    @image1, @image2 = random_image, random_image
+    @batch = Dink::Batch.new
+  end
+  
+  it "should gather up all the images on a page for resizing" do
+    pending "This should really be an integration test"
+  end
+
+  it "should accept new images like an array" do
+    @batch << @image1
+    @batch.size.should be 1
+  end
+  
+  it "should respond to empty?" do
+    @batch.empty?.should be true
+    @batch << @image1
+    @batch.empty?.should be false
+  end
+  
+  it "should respond to #to_json" do
+    @batch << @image1
+    @batch << @image2
+    @batch.to_json.should be_a_kind_of(String)
+  end
+
+  describe "#deliver" do
+    before(:each) do
+      @batch << @image1
+      @batch << @image2
+    end
+    
+    it "should send a hash of unprocessed images to Dink" do
+      Dink.sender.user_agent = "Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ (KHTML, like Gecko) Version/3.0 Mobile/1A543a Safari/419.3"
+      @batch.deliver
+    end
+  end
+
+  # describe "#screen" do
+  #   it "should check local cache to see if any of the images have already been processed" do
+  #     pending
+  #   end
+  #   it "should skip sending of already processed images to Dink" do
+  #     pending
+  #     # cache fake result, try to resend image
+  #   end
+  # end
+
+  
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink/rails/helpers')
+
+describe Dink::Configuration do
+
+  it "should bla" do
+    pending
+  end
+
+  def assert_config_default(option, default_value, config = nil)
+    config ||= Dink::Configuration.new
+    assert_equal default_value, config.send(option)
+  end
+
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,22 @@
+require "rails"
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink/rails/helpers')
+include Dink::Helpers
+
+describe Dink::Helpers do  
+  
+  before(:each) do
+    @image_batch = Dink::Batch.new
+    @image = test_images[rand(3)]
+  end
+  
+  describe "#transform" do
+    it "should respond with some image tag HTML" do
+      
+      transform_image("http://bla.com/image.jpg", {}).should =~ /^\<img/
+      
+      
+    end
+  end
+  
+end

data/spec/hooks_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink/rails/hooks')
+
+describe Dink::Hooks do
+  
+end

data/spec/image_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink/image')
+
+describe Dink::Image do  
+  
+  before(:each) do
+    @image = random_image
+  end
+  
+  it "should have some default values assigned" do
+    assert_default_value :device_width_ratio, 1
+  end
+  
+  describe "#url_id" do
+    it "should generate a unique id for an image based on it's URL" do
+      id = @image.url_id
+      id.should be_a_kind_of(String)
+      id.length.should be 40
+    end
+  end
+  
+  describe "#params_slug" do
+    it "should respond with a string representation of the transform parameters " do
+      @image.params_slug.should be_a_kind_of(String)
+    end
+  end
+  
+  describe "#name" do
+    it "should respond with the url_id and abbreviated transform params" do
+      @image.name.should =~ /^[\w\d]{40}_[\w\d]+$/
+    end
+  end
+  
+  describe "#s3_url" do
+    it "should respond with the full url of a post-transform and distributed image" do
+      @image.cdn_url.should =~ /^http:\/\//
+    end
+  end
+  
+  describe "#to_hash" do
+    it "should respond to to_hash" do
+      @image.to_hash.should be_a_kind_of(Hash)
+    end
+    it "should have some specific keys" do
+      hash = @image.to_hash
+      hash[:source].should_not be nil
+      hash[:name].should_not be nil
+    end
+  end
+  
+  describe "#cached?" do
+    it "should return true if the image name is in local cache" do
+      pending
+    end
+    it "should return false if the image name is not found in local cache" do
+      pending
+    end
+  end
+  
+  describe "#to_json" do
+    it "should respond to to_json" do
+      json = @image.to_json
+      json.should be_a_kind_of(String)
+      JSON.parse(json).should be_a_kind_of(Hash)
+    end
+  end
+  
+  def assert_default_value(option, default_value)
+    default_value.should be @image.send(option)
+  end
+  
+end

data/spec/receiver_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink/receiver')
+
+describe Dink::Receiver do
+
+  it "should log the round-trip time" do
+    pending
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink')
+require "rails/all"
+
+RSpec.configure do |config|
+  # == Mock Framework
+  config.mock_with :rspec
+end
+
+
+def test_images
+  [
+    { :source => "http://www.crazy-frog.us/donthotlink-crazy-frog-1024x768-1.jpg",
+      :options => {} },
+    { :source => "https://totalfright.websitesource.net/mm5/pics/32901.jpg",
+      :options => {} },
+    { :source => "http://iamthatmommy.files.wordpress.com/2010/04/unicorn1.jpg",
+      :options => {} }
+  ]
+end
+
+def random_image
+  image_number = rand(test_images.size) 
+  Dink::Image.new(test_images[image_number][:source], test_images[image_number][:options])
+end
+
+Dink.configure do |c|
+  c.api_key = "1234123412341234"
+end

data/spec/stilts_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../lib/dink')
+
+describe Dink do  
+  
+  describe "#configure" do
+    it "should have with an API key or raise an error" do
+      pending
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: dink
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Graham Powrie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id002
+description: ""
+email: 
+- graham@developmentnow.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- dink.gemspec
+- lib/dink.rb
+- lib/dink/batch.rb
+- lib/dink/configuration.rb
+- lib/dink/image.rb
+- lib/dink/rack.rb
+- lib/dink/rails/.DS_Store
+- lib/dink/rails/helpers.rb
+- lib/dink/rails/hooks.rb
+- lib/dink/railtie.rb
+- lib/dink/receiver.rb
+- lib/dink/sender.rb
+- lib/dink/version.rb
+- spec/batch_spec.rb
+- spec/configuration_spec.rb
+- spec/helpers_spec.rb
+- spec/hooks_spec.rb
+- spec/image_spec.rb
+- spec/receiver_spec.rb
+- spec/spec_helper.rb
+- spec/stilts_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: dink
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: On-the-fly image resizing and management for mobile devices
+test_files: 
+- spec/batch_spec.rb
+- spec/configuration_spec.rb
+- spec/helpers_spec.rb
+- spec/hooks_spec.rb
+- spec/image_spec.rb
+- spec/receiver_spec.rb
+- spec/spec_helper.rb
+- spec/stilts_spec.rb