stilts 0.0.3 → 0.0.4

data/lib/stilts.rb

@@ -2,6 +2,7 @@ module Stilts
   require 'net/http'
   require 'net/https'
   require 'addressable/uri'
+  require 'json'
   # begin
   #   require 'active_support'
   # rescue LoadError
@@ -10,8 +11,10 @@ module Stilts
   
   require 'stilts/configuration'
   require 'stilts/sender'
+  require 'stilts/receiver'
   require 'stilts/rack'
   require 'stilts/image'
+  require 'stilts/batch'
   require 'stilts/railtie' if defined?(Rails)
   
   LOG_PREFIX = "[Stilts] "
@@ -19,17 +22,20 @@ module Stilts
   class << self
     
     # The sender object is responsible for delivering formatted data to the server.
-    # Must respond to #send_to_hoptoad. See Stilts::Sender.
     attr_accessor :sender
 
     # A configuration object. Must act like a hash and return sensible
     # values for all configuration options. See Stilts::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

data/lib/stilts/batch.rb

@@ -0,0 +1,39 @@
+module Stilts
+  class Batch
+    
+    attr_accessor :images
+    
+    # Batch is just an array of images
+    def initialize
+      self.images = []
+    end
+    
+    # Send images to Stilts for transformation, first +screen+ and translate +to_json+
+    def deliver
+      Stilts.sender.send_image_transform_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/stilts/configuration.rb

@@ -3,13 +3,16 @@ module Stilts
   class Configuration
 
     OPTIONS = [:api_key, :host, :http_open_timeout, :http_read_timeout, :project_root,
-    :port, :protocol, :proxy_host, :secure, :framework].freeze
+    :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).
@@ -21,20 +24,31 @@ module Stilts
     # 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                     = 'localhost'
+      # @host                     = 'stilts.developmentnow.com'
+      # @port                     = 80
+      @host                     = "localhost"
+      @port                     = 3000
+      @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

data/lib/stilts/image.rb

@@ -12,17 +12,17 @@ module Stilts
     ]
 
     # The public location of the image
-    attr_accessor :url, :device_width_ratio
+    attr_accessor :source, :device_width_ratio
     
     # :nodoc:
-    def initialize(args)
-      self.url                  = args[:url]
-      self.device_width_ratio   = args[:device_width_ratio] || 1
+    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.url)
+      Digest::SHA1.hexdigest(self.source)
     end
     
     # Combines resizing parameters into a short, unique slug to be appended to the final image name
@@ -38,18 +38,27 @@ module Stilts
     end
     
     # Location on server that will server this image
-    def transformed_url
+    def cdn_url
       Stilts.configuration.protocol + "://" +
-      Stilts.configuration.host +
-      "/transform/" +
-      Stilts.configuration.api_key +
-      "/" + self.name
+      Stilts.configuration.cdn_host +
+      "/images/" +
+      Stilts.configuration.api_key + "/" +
+      self.name
+    end
+    
+    def deliver
+      Stilts.sender.send_image_transform_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
       {
-        :url => self.url,
+        :source => self.source,
         :name => self.name,
       }
     end

data/lib/stilts/rails/helpers.rb

@@ -2,28 +2,25 @@ module Stilts
   module Helpers
     include ActionView::Helpers
     
-    def transform(image)
-      image = Stilts::Image.new(image)
-      # @response = Stilts.sender.send_to_resizer({:image_source => image_source}.to_json.to_s)
-      image_tag(image.transformed_url)
+    # Take image transform parameters and generate an image tag and stick it into the batch
+    def transform_image(source, transform_options = {}, image_options = {})
+      image = Stilts::Image.new(source, transform_options).deliver
+      # @image_batch << image
+      image_tag(image["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 url
-      Stilts.configuration.url.dup
-    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
       Stilts.configuration.logger

data/lib/stilts/rails/hooks.rb

@@ -1,16 +1,16 @@
 module Stilts
   module Hooks
-
+  
     def self.included(base)
-      base.before_filter :clear_resize_batch
-      base.after_filter :resize_batch
+      base.before_filter :image_batch
+      base.append_before_filter :deliver_batch
     end
 
-    def clear_resize_batch
-      @resize_batch = []
+    def image_batch
+      @image_batch = Stilts::Batch.new
     end
-    def resize_batch
-      @resize_batch
+    def deliver_batch
+      @image_batch.deliver unless @image_batch.empty?
     end
     
   end

data/lib/stilts/receiver.rb

@@ -1,9 +1,29 @@
 module Stilts
   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
       Stilts.configuration.logger
     end
 
+    def log(level, message, response = nil)
+      logger.send level, LOG_PREFIX + message if logger
+      Stilts.report_environment_info
+      Stilts.report_response_body(response.body) if response && response.respond_to?(:body)
+    end
+
   end
 end

data/lib/stilts/sender.rb

@@ -1,16 +1,10 @@
 module Stilts
   class Sender
-    RESIZER_PATH = "/resize"
-    RESIZER_HEADERS = {
-      'Content-Type'             => 'application/json',
-      'Accept'                   => 'application/json'
+    TRANSFORM_HEADERS = {
+      'Content-Type'    => 'application/json',
+      'Accept'          => 'application/json'
     }
 
-    STREAMER_PATH = "/resize"
-    STREAMER_HEADERS = {
-      'Content-Type'             => 'image/jpeg',
-      'Accept'                   => 'image/jpeg'
-    }
     HTTP_ERRORS = [Timeout::Error,
       Errno::EINVAL,
       Errno::ECONNRESET,
@@ -23,64 +17,27 @@ module Stilts
     attr_accessor :user_agent
 
     def initialize(options = {})
-      [:protocol, :host, :port, :secure].each do |option|
+      [:protocol, :host, :port, :secure, :http_open_timeout, :http_read_timeout].each do |option|
         instance_variable_set("@#{option}", options[option])
       end
-      # , :http_open_timeout, :http_read_timeout
-    end
-
-    def send_to_resizer(data)
-      http =
-      Net::HTTP.new(url.host, url.port)
-
-      http.read_timeout = 5
-      http.open_timeout = 5
-      http.use_ssl      = false
-      headers           = RESIZER_HEADERS.merge({'User-Agent' => user_agent})
-
-      response = begin
-        logger.debug{"POSTED JSON: #{data} TO: #{url.to_s}" }
-        http.post(RESIZER_PATH, data, headers)
-      rescue *HTTP_ERRORS => e
-        log :error, "Timeout while contacting the server. #{e}"
-        nil
-      end
-
-      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 send_to_streamer(data)
-      http =
-      Net::HTTP.new(url.host, url.port)
+    def send_image_transform_data(data)
+      http              = Net::HTTP.new(@host, @port)
 
-      http.read_timeout = 5
-      http.open_timeout = 5
+      http.read_timeout = @http_read_timeout
+      http.open_timeout = @http_open_timeout
       http.use_ssl      = false
+      headers           = TRANSFORM_HEADERS.merge({'User-Agent' => user_agent})
 
       response = begin
-        http.get(STREAMER_PATH+data, STREAMER_HEADERS)
+        http.post("/transform/#{Stilts.configuration.api_key}", data, headers)
       rescue *HTTP_ERRORS => e
         log :error, "Timeout while contacting the server. #{e}"
         nil
       end
 
-      case response
-      when Net::HTTPSuccess then
-        log :info, "Success: #{response.class}", response
-        return response.body
-      else
-        log :error, "Failure: #{response.class}", response
-      end
-    end
-
-    def url
-      Stilts.configuration.url.dup
+      Stilts.receiver.receive(response)
     end
 
     def log(level, message, response = nil)

data/lib/stilts/version.rb

@@ -1,3 +1,3 @@
 module Stilts
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 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/stilts/batch')
+
+describe Stilts::Batch do
+  before(:each) do
+    @image1, @image2 = random_image, random_image
+    @batch = Stilts::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 Stilts" do
+      Stilts.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 Stilts" do
+  #     pending
+  #     # cache fake result, try to resend image
+  #   end
+  # end
+
+  
+end

data/spec/helpers_spec.rb

@@ -6,13 +6,14 @@ include Stilts::Helpers
 describe Stilts::Helpers do  
   
   before(:each) do
+    @image_batch = Stilts::Batch.new
     @image = test_images[rand(3)]
   end
   
   describe "#transform" do
     it "should respond with some image tag HTML" do
       
-      transform(@image).should =~ /^\<img/
+      transform_image("http://bla.com/image.jpg", {}).should =~ /^\<img/
       
       
     end

data/spec/hooks_spec.rb

@@ -2,18 +2,5 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require File.expand_path(File.dirname(__FILE__) + '/../lib/stilts/rails/hooks')
 
 describe Stilts::Hooks do
-  it "should gather up all the images on a page for resizing" do
-    pending "This should really be an integration test"
-  end
-  it "should check local cache to see if any of the images have already been processed" do
-    pending
-  end
-  it "should send a hash of unprocessed images to Stilts" do
-    pending
-  end
-  it "should skip sending of already processed images to Stilts" do
-    pending
-    # cache fake result, try to resend image
-  end
   
 end

data/spec/image_spec.rb

@@ -4,7 +4,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../lib/stilts/image')
 describe Stilts::Image do  
   
   before(:each) do
-    @image = Stilts::Image.new(test_images[rand(3)])
+    @image = random_image
   end
   
   it "should have some default values assigned" do
@@ -31,9 +31,9 @@ describe Stilts::Image do
     end
   end
   
-  describe "#transformed_url" do
-    it "should respond with the full url of a post-transform image" do
-      @image.transformed_url.should =~ /^http:\/\//
+  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
   
@@ -43,11 +43,28 @@ describe Stilts::Image do
     end
     it "should have some specific keys" do
       hash = @image.to_hash
-      hash[:url].should_not be nil
+      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

data/spec/receiver_spec.rb

@@ -6,4 +6,5 @@ describe Stilts::Receiver do
   it "should log the round-trip time" do
     pending
   end
+  
 end

data/spec/spec_helper.rb

@@ -9,12 +9,20 @@ end
 
 def test_images
   [
-    { :url => "http://www.crazy-frog.us/donthotlink-crazy-frog-1024x768-1.jpg" },
-    { :url => "https://totalfright.websitesource.net/mm5/pics/32901.jpg" },
-    { :url => "http://iamthatmommy.files.wordpress.com/2010/04/unicorn1.jpg"}
+    { :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) 
+  Stilts::Image.new(test_images[image_number][:source], test_images[image_number][:options])
+end
+
 Stilts.configure do |c|
   c.api_key = "1234123412341234"
 end

data/stilts.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_dependency('addressable', '~> 2.2.2')
+  s.add_dependency('json', '~> 1.4.6')
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Graham Powrie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 -08:00
+date: 2011-01-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,21 @@ dependencies:
         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
@@ -47,6 +62,7 @@ files:
 - README.md
 - Rakefile
 - lib/stilts.rb
+- lib/stilts/batch.rb
 - lib/stilts/configuration.rb
 - lib/stilts/image.rb
 - lib/stilts/rack.rb
@@ -57,6 +73,7 @@ files:
 - lib/stilts/receiver.rb
 - lib/stilts/sender.rb
 - lib/stilts/version.rb
+- spec/batch_spec.rb
 - spec/configuration_spec.rb
 - spec/helpers_spec.rb
 - spec/hooks_spec.rb
@@ -98,6 +115,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