shutterbug 0.2.5 → 0.4.3

data/lib/shutterbug/phantom_job.rb

@@ -1,7 +1,6 @@
 module Shutterbug
   class PhantomJob
-
-    attr_accessor :png_file
+    attr_accessor :image_file
     attr_accessor :html_file
 
     def program
@@ -12,17 +11,19 @@ module Shutterbug
       File.join(File.dirname(__FILE__),'rasterize.js')
     end
 
-    def initialize(base_url, html, css="", width=1000, height=700)
+    def initialize(base_url, html, css="", width=1000, height=700, format="png", quality=10)
       @base_url = base_url
       @html     = html
       @css      = css
       @width    = width
       @height   = height
+      @format   = format
+      @quality  = quality
       @config   = Configuration.instance
     end
 
     def cache_key
-      @cache_key ||= Digest::SHA1.hexdigest("#{@html}#{@css}#{@base_url}")[0..10]
+      @cache_key ||= Digest::SHA1.hexdigest("#{@html}#{@css}#{@base_url}#{@format}#{@quality}")[0..10]
     end
 
     def document
@@ -47,8 +48,8 @@ module Shutterbug
       "#{cache_key}.html"
     end
 
-    def png_file_name
-      "#{cache_key}.png"
+    def image_file_name
+      "#{cache_key}.#{@format}"
     end
 
     def input_path
@@ -56,11 +57,11 @@ module Shutterbug
     end
 
     def output_path
-      @config.fs_path_for(png_file_name)
+      @config.fs_path_for(image_file_name)
     end
 
     def rasterize_cl
-      %x[#{self.program} --ignore-ssl-errors=true --ssl-protocol=any #{self.rasterize_js} #{self.input_path} #{self.output_path} #{@width}*#{@height}]
+      %x[#{self.program} --ignore-ssl-errors=true --ssl-protocol=any #{self.rasterize_js} #{self.input_path} #{self.output_path} #{@width}*#{@height} #{@quality}]
     end
 
     def rasterize
@@ -68,8 +69,8 @@ module Shutterbug
         f.write(document)
       end
       rasterize_cl()
-      self.png_file  = @config.storage.new(png_file_name, Shutterbug::Handlers::FileHandlers::PngFile.new)
-      self.html_file = @config.storage.new(html_file_name,  Shutterbug::Handlers::FileHandlers::HtmlFile.new)
+      self.image_file = @config.storage.new(image_file_name)
+      self.html_file = @config.storage.new(html_file_name)
     end
   end
 end

data/lib/shutterbug/rackapp.rb

@@ -3,17 +3,16 @@ module Shutterbug
   class Rackapp
 
     DefaultHandlers = [
-      Shutterbug::Handlers::ConvertHandler ,
+      Shutterbug::Handlers::ConvertHandler,
+      Shutterbug::Handlers::DirectUploadHandler,
       Shutterbug::Handlers::JsFileHandler,
-      Shutterbug::Handlers::FileHandlers::PngFile,
-      Shutterbug::Handlers::FileHandlers::HtmlFile
+      Shutterbug::Handlers::FileHandler
     ]
 
-    attr_accessor :handlers
     def add_handler(klass)
-      instance = klass.new(@config)
-      log "adding handler for #{instance.regex} ➙ #{klass.name}"
-      self.handlers[instance.regex] = instance
+      instance = klass.new
+      log "adding handler for #{klass.regex} ➙ #{klass.name}"
+      @handlers[klass.regex] = instance
     end
 
     def add_default_handlers
@@ -29,26 +28,25 @@ module Shutterbug
       log "initialized"
     end
 
-    def call env
-      req      = Rack::Request.new(env)
-      result   = false
-      handlers.keys.each do |path_regex|
+    def call(env)
+      req    = Rack::Request.new(env)
+      result = false
+      @handlers.keys.each do |path_regex|
         if req.path =~ path_regex
-          result = handlers[path_regex].handle(self, req, env)
+          result = @handlers[path_regex].handle(self, req, env)
         end
       end
       result || skip(env)
     end
 
-    def good_response(content, type, cachable=true)
+    def response(content, type, status=200, cachable=true)
       headers = {}
       size = content.respond_to?(:bytesize) ? content.bytesize : content.size
       headers['Content-Length'] = size.to_s
       headers['Content-Type']   = type
       headers['Cache-Control']  = 'no-cache' unless cachable
-      # content must be enumerable.
-      content = [content] if content.kind_of? String
-      return [200, headers, content]
+      content = [content] unless content.respond_to? 'each'
+      return [status, headers, content]
     end
 
     def log(string)
@@ -57,8 +55,7 @@ module Shutterbug
 
     def skip(env)
       # call the applicaiton default
-      @app.call env if @app
+      @app.call(env) if @app
     end
-
   end
 end

data/lib/shutterbug/rasterize.js

@@ -2,11 +2,10 @@
 
 var page = require('webpage').create(),
     system = require('system'),
-    address, output, size;
+    address, output, quality, size;
 
 if (system.args.length < 3 || system.args.length > 5) {
-    console.log('Usage: rasterize.js URL filename [paperwidth*paperheight|paperformat] [zoom]');
-    console.log('  paper (pdf output) examples: "5in*7.5in", "10cm*20cm", "A4", "Letter"');
+    console.log('Usage: rasterize.js URL filename quality(0-100)');
     phantom.exit(1);
 } else {
     address = system.args[1];
@@ -15,6 +14,7 @@ if (system.args.length < 3 || system.args.length > 5) {
     if (system.args.length > 3) {
         size = system.args[3].split('*');
         page.viewportSize = { width: size[0], height: size[1] };
+        quality = system.args[4];
     }
 
     page.open(address, function (status) {
@@ -23,7 +23,7 @@ if (system.args.length < 3 || system.args.length > 5) {
             phantom.exit();
         } else {
             window.setTimeout(function () {
-                page.render(output);
+                page.render(output, {quality: quality});
                 phantom.exit();
             }, 200);
         }

data/lib/shutterbug/storage.rb

@@ -3,4 +3,4 @@ module Shutterbug
     autoload :FileStorage,  "shutterbug/storage/file_storage"
     autoload :S3Storage,    "shutterbug/storage/s3_storage"
   end
-end
+end

data/lib/shutterbug/storage/file_storage.rb

@@ -1,20 +1,33 @@
 module Shutterbug
   module Storage
     class FileStorage
-      attr_accessor :filename
-      attr_accessor :config
-      attr_accessor :url
+      attr_reader :filename
+      attr_reader :url
 
-      def initialize(filename, file_handler)
+      MIME_TYPES = {
+        '.png'  => 'image/png',
+        '.jpeg' => 'image/jpeg',
+        '.jpg'  => 'image/jpeg',
+        '.html' => 'text/html',
+        ''      => 'text/html'
+      }
+
+      def self.get_url(name)
+        "#{Handlers::FileHandler.uri_prefix}/#{name}"
+      end
+
+      def initialize(filename)
         @filename = Configuration.instance.fs_path_for(filename)
-        @url = file_handler.urlify(filename)
+        @url = self.class.get_url(filename)
       end
 
       def get_content
-        file = File.open(@filename, 'r')
-        return file
+        File.open(@filename, 'r')
       end
 
+      def mime_type
+        MIME_TYPES[File.extname(@filename)]
+      end
     end
   end
-end
+end

data/lib/shutterbug/storage/s3_storage.rb

@@ -3,15 +3,16 @@ module Shutterbug
     class S3Storage
       require 'fog'
 
-      attr_accessor :filename
-      attr_accessor :url
-      attr_accessor :stream_file
+      attr_reader :filename
+      attr_reader :url
+
+      PUT_URL_EXP_TIME = 300 # seconds
 
       def self.connect!
         Fog::Storage.new({
-          :provider                 => 'AWS',
-          :aws_access_key_id        => Configuration.instance.s3_key,
-          :aws_secret_access_key    => Configuration.instance.s3_secret
+          :provider              => 'AWS',
+          :aws_access_key_id     => Configuration.instance.s3_key,
+          :aws_secret_access_key => Configuration.instance.s3_secret
         })
       end
 
@@ -29,47 +30,41 @@ module Shutterbug
         @s3_bin ||= self.create_bin
       end
 
-      def self.write(name, filename)
+      def self.write(filename)
         full_path = Configuration.instance.fs_path_for(filename)
         if self.fs_path_exists? full_path
           self.s3_bin.files.create(
-            :key    => name,
+            :key    => filename,
             :body   => File.open(full_path),
             :public => true)
         end
       end
 
-      def self.find(path)
-        self.s3_bin.files.get(path)
+      def self.fs_path_exists?(filename)
+        File.exists?(filename)
       end
 
-      def self.fs_path_exists?(long_path)
-        File.exists? long_path
+      def self.get_url(filename)
+        # Manual URL construction, no proper method implemented in FOG.
+        # But should be available soon, see: https://github.com/fog/fog/issues/3263
+        "https://#{Configuration.instance.s3_bin}.s3.amazonaws.com/#{filename}"
       end
 
-      def self.handler_for(type)
-        return self.handlers[type]
+      def self.put_url(filename)
+        expiry = (Time.now + PUT_URL_EXP_TIME).to_i
+        headers = {}
+        query = {
+          'x-amz-acl' => 'public-read'
+        }
+        options = { path_style: true, query: query }
+        self.connection.put_object_url(Configuration.instance.s3_bin, filename, expiry, headers, options)
       end
 
-      def initialize(long_path, filetype)
-        @filename = File.basename(long_path)
-        @source = long_path
-        @stream_file = S3Storage.write(@filename, long_path)
+      def initialize(filename)
+        @filename = filename
+        @stream_file = S3Storage.write(filename)
         @url = @stream_file.public_url
       end
-
-      def get_content
-        @stream_file.body
-      end
-
-      def size
-        @stream_file.content_length
-      end
-
-      def redirect_s3
-        return [301, {"Location" => self.url}, []]
-      end
-
     end
   end
 end

data/shutterbug.gemspec

@@ -35,5 +35,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rack"
   spec.add_dependency "fog"
-
 end

data/spec/shared_examples_for_handlers.rb

@@ -1,26 +1,30 @@
 shared_examples "a request handler" do
-  let(:config)  { Shutterbug::Configuration.new()}
   let(:rackapp) { mock }
   let(:req)     { mock }
   let(:env)     { mock }
-  let(:handler) { described_class.new(config) }
+  let(:handler) { described_class.new }
   let(:mock_storage) do
     mock({
       :new => mock({
-        :get_content => "content"
+        :get_content => "content",
+        :mime_type => "text/plain",
+        :filename => "file",
+        :url => "url"
       })
     })
   end
   before(:each) do
-    config.stub!(:storage => mock_storage)
+    Shutterbug::Configuration.instance.stub!(:storage => mock_storage)
   end
+
   it "should respond to regex" do
-    handler.should respond_to :regex
-    handler.regex.should be_kind_of Regexp
+    handler.class.should respond_to :regex
+    handler.class.regex.should be_kind_of Regexp
   end
+
   it "should respond to handle" do
     handler.should respond_to :handle
-    rackapp.should_receive :good_response
-    handler.handle(rackapp,req,env)
+    rackapp.should_receive :response
+    handler.handle(rackapp, req, env)
   end
-end
+end

data/spec/shared_examples_for_storage.rb

@@ -1,17 +1,21 @@
 shared_examples "a storage provider" do
-  let(:filetype) { Shutterbug::Handlers::FileHandlers::HtmlFile.new}
   let(:filename) { "somefilename.html" }
-  let(:provider) { described_class.new(filename,filetype) }
 
-  it "should respond to filename" do
-    provider.should respond_to :filename
+  describe "class" do
+    it "should respond to get_url(name)" do
+      described_class.should respond_to :get_url
+    end
   end
 
-  it "should respond to url" do
-    provider.should respond_to :url
-  end
+  describe "instance" do
+    let(:instance) { described_class.new(filename) }
+
+    it "should respond to filename" do
+      instance.should respond_to :filename
+    end
 
-  it "should respond to get_content" do
-    provider.should respond_to :get_content
+    it "should respond to url" do
+      instance.should respond_to :url
+    end
   end
-end
+end

data/spec/shutterbug/configuration_spec.rb

@@ -1,6 +1,4 @@
-
 describe Shutterbug::Configuration do
-
   let(:uri_prefix)       { "http://blah.com/" }
   let(:path_prefix)      { "/shutterbug" }
   let(:resource_dir)     { "resource_dir"}
@@ -20,10 +18,6 @@ describe Shutterbug::Configuration do
     }
   end
 
-
-    # def js_file
-
-
   subject { Shutterbug::Configuration.new(opts) }
 
   describe "#fs_path_for(filename)" do |variable|
@@ -56,8 +50,6 @@ describe Shutterbug::Configuration do
     end
   end
 
-
-
   describe "use_s3?" do
     describe "with no S3 information" do
       its(:use_s3?) { should be_false }
@@ -78,6 +70,4 @@ describe Shutterbug::Configuration do
       end
     end
   end
-
-
-end
+end

data/spec/shutterbug/convert_handler_spec.rb

@@ -1,4 +1,5 @@
 require 'shared_examples_for_handlers'
+
 describe Shutterbug::Handlers::ConvertHandler do
   let(:mock_post) do
     mock(:POST => {},
@@ -14,16 +15,16 @@ describe Shutterbug::Handlers::ConvertHandler do
 
   describe "calling phantom" do
     let(:mock_results) { mock }
-    let(:rackapp) { mock(:good_response => true )}
+    let(:rackapp) { mock(:response => true )}
     let(:env)     { mock }
     let(:fake_file)   { mock(:filename => "blub", :url => "glub")}
-    let(:mock_fantom) { mock(:cache_key => "1", :html_file => fake_file, :png_file => fake_file) }
+    let(:mock_fantom) { mock(:cache_key => "1", :html_file => fake_file, :image_file => fake_file) }
     before(:each) do
       Shutterbug::PhantomJob.stub!(:new => mock_fantom)
     end
     it "should invoke phantom" do
       mock_fantom.should_receive(:rasterize).and_return(mock_results)
-      subject.handle(rackapp,req,env)
+      subject.handle(rackapp, req, env)
     end
   end
-end
+end