RubyGems - grosser-smusher - Versions diffs - 0.1 - Mend

grosser-smusher 0.1

Files changed (16) hide show

data/README.markdown ADDED Viewed

@@ -0,0 +1,52 @@
+Problem
+=======
+ - Images are too large because they are not optimized
+ - Users & your bandwidth is wasted for useless metadata
+ - local image optimization requires tons of programs / libaries / knowledge
+Solution
+========
+ - *LOSSLESS* size reduction (10-97% size reduction) in the cloud
+ - optmizes all images(jpg+png) from a given folder
+Install
+=======
+    install ruby + rubygems
+    sudo gem install grosser-smusher --source http://gems.github.com/
+Usage
+=====
+    # your pictures MUST be online in order to be optimized
+    smusher /apps/x/public/images www.x.com/images
+    smusher LOCAL_FOLDER REMOTE_FOLDER
+Protection
+==========
+Smusher makes .backup copies of any image before optimizing.
+Any image that returns a failure code, is larger than before,
+or is empty will be reverted.
+Example
+======
+  smusher /apps/ts/public/images xx.com/images
+  sushing http://xx.com/images/social/facebook_icon.png -> /apps/rs/public/images/social/facebook_icon.png
+  2887 -> 132                              = 4%
+  sushing http://xx.com/images/social/myspace_icon.png -> /apps/rs/public/images/social/myspace_icon.png
+  3136 -> 282                              = 8%
+  sushing http://xx.com/images/dvd/dvd_1.png -> /apps/rs/public/images/dvd/dvd_1.png
+  5045 -> 9677                             = 191%
+  reverted!
+  ...
+TODO
+====
+ - no need for files to be online (direct upload)
+ - windows support?
+Author
+======
+Michael Grosser
+grosser.michael@gmail.com
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile ADDED Viewed

@@ -0,0 +1,20 @@
+desc "Run all specs in spec directory"
+task :default do |t|
+  require 'spec'
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+#Gemspec
+require 'echoe'
+porject_name = 'smusher'
+Echoe.new(porject_name , '0.1') do |p|
+  p.description    = "Automatic Lossless Reduction Of All Your Images"
+  p.url            = "http://github.com/grosser/#{porject_name}"
+  p.author         = "Michael Grosser"
+  p.email          = "grosser.michael@gmail.com"
+  p.dependencies   = %w[rake json]
+end
+task :update_gemspec => [:manifest, :build_gemspec]

data/bin/smusher ADDED Viewed

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'smusher'
+folder, url = ARGV
+if ARGV.length < 2 or not File.directory?(folder)
+  puts "smusher DIRECTORY_TO_SMUSH BASE_URL"
+  puts "smusher /apps/x/public/images www.x.com/images"
+  exit
+end
+Smusher.store_smushed_folder(url,folder)

data/lib/smusher.rb ADDED Viewed

@@ -0,0 +1,114 @@
+require 'rubygems'
+require 'rake'
+module Smusher
+  extend self
+  #http://smushit.com/ws.php?img=http%3A%2F%2Fwww.famfamfam.com%2Flab%2Ficons%2Fsilk%2Ficons%2Fdrink_empty.png&task=89266837334214400&id=paste2
+  SMUSHIT_FAILURE_SIZE = 9667
+  EMPTY_FILE_SIZE = 4
+  def store_smushed_image(url,file)
+    url = sanitize_url(url)
+    with_protection(file) do
+      with_logging(url,file) do
+        write_smushed_data(url,file)
+      end
+    end
+  end
+  def store_smushed_folder(base_url,folder)
+    base_url = sanitize_url(base_url)
+    folder = sanitize_folder(folder)
+    images_in_folder(folder).each do |file|
+      relative_path_to_folder = file.sub(folder+'/','')
+      url = "#{base_url}/#{relative_path_to_folder}"
+      store_smushed_image(url,file)
+      puts ''
+    end
+  end
+private
+  def write_smushed_data(url,file)
+    File.open(file,'w') do |f|
+      data = smushed_image_data_for(url)
+      raise data if data =~ /<html>/i
+      f.puts data
+    end
+  end
+  def sanitize_url(url)
+    url = url.sub(%r[/$],'')#remove tailing slash
+    url = url.sub(url,"http://#{url}") unless url.include?('://')#add http if protocol is missing
+    url
+  end
+  def sanitize_folder(folder)
+    folder.sub(%r[/$],'')#remove tailing slash
+  end
+  def images_in_folder(folder)
+    images = %w[png jpg jpeg JPG].map {|ext| "#{folder}/**/*.#{ext}"}
+    FileList[*images]
+  end
+  def with_protection(file)
+    if File.exist?(file)
+      backup = "#{file}.backup"
+      FileUtils.cp(file,backup)#backup
+      before = size(file)
+      yield
+      after = size(file)
+      if after == EMPTY_FILE_SIZE or after == SMUSHIT_FAILURE_SIZE or after > before
+        FileUtils.mv(backup,file,:force=>true)#revert
+        puts "reverted!"
+      else
+        FileUtils.rm(backup)
+      end
+    else#is created
+      yield
+      after = size(file)
+      if after == SMUSHIT_FAILURE_SIZE or after == EMPTY_FILE_SIZE
+        FileUtils.rm file
+      end
+    end
+  end
+  def size(file)
+    File.exist?(file) ? File.size(file) : 0
+  end
+  def with_logging(url,file)
+    puts "sushing #{url} -> #{file}"
+    before = size(file)
+    yield
+    after = size(file)
+    result = before == 0 ?  "CREATED" : "#{(100*after)/before}%"
+    puts "#{before} -> #{after}".ljust(40) + " = #{result}"
+  end
+  def smushed_image_data_for(url)
+    require 'cgi'
+    url = CGI.escape url
+    require 'net/http'
+    require 'net/https'
+    require 'rubygems'
+    require 'json'
+    http = Net::HTTP.new('smushit.com')
+    path = "/ws.php?img=#{url}&task=89266837334214400&id=paste2"
+    resp, data = http.get(path, nil)
+    raise "oops #{resp}" unless resp.is_a? Net::HTTPOK
+    path = "/#{JSON.parse(data)['dest']}"
+    resp, data = http.get(path, nil)
+    data
+  end
+end

data/smusher.gemspec ADDED Viewed

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{smusher}
+  s.version = "0.1"
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-01-24}
+  s.default_executable = %q{smusher}
+  s.description = %q{Automatic Lossless Reduction Of All Your Images}
+  s.email = %q{grosser.michael@gmail.com}
+  s.executables = ["smusher"]
+  s.extra_rdoc_files = ["lib/smusher.rb", "bin/smusher", "README.markdown"]
+  s.files = ["Manifest", "nbproject/private/rake-d.txt", "nbproject/project.xml", "nbproject/project.properties", "lib/smusher.rb", "spec/out/people.jpg", "spec/spec_helper.rb", "spec/smusher_spec.rb", "spec/images/logo.gif", "spec/images/woman.jpeg", "spec/images/add.png", "spec/images/drink_empty.png", "spec/images/people.jpg", "spec/images/water.JPG", "spec/reduced/fam.png", "bin/smusher", "Rakefile", "README.markdown", "smusher.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/grosser/smusher}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Smusher", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{smusher}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Automatic Lossless Reduction Of All Your Images}
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/spec/images/add.png ADDED Viewed

Binary file

data/spec/images/drink_empty.png ADDED Viewed

Binary file

data/spec/images/logo.gif ADDED Viewed

Binary file

data/spec/images/people.jpg ADDED Viewed

Binary file

data/spec/images/water.JPG ADDED Viewed

Binary file

data/spec/images/woman.jpeg ADDED Viewed

Binary file

data/spec/out/people.jpg ADDED Viewed

Binary file

data/spec/reduced/fam.png ADDED Viewed

Binary file

data/spec/smusher_spec.rb ADDED Viewed

@@ -0,0 +1,183 @@
+ROOT = File.expand_path(File.dirname(__FILE__))
+require File.join(ROOT,"spec_helper")
+URL = "http://famfamfam.com/lab/icons/silk/icons/drink_empty.png"
+ESCAPED_URL = "http%3A%2F%2Fwww.famfamfam.com%2Flab%2Ficons%2Fsilk%2Ficons%2Fdrink_empty.png"
+describe :smusher do
+  def size
+    File.size(@file)
+  end
+  before do
+    #prepare output folder
+    @out = File.join(ROOT,'out')
+    FileUtils.rm_r @out, :force=>true
+    FileUtils.mkdir @out
+    FileUtils.cp(File.join(ROOT,'images','people.jpg'), @out)
+    @file = File.join(@out,'people.jpg')
+  end
+  describe :store_smushed_image do
+    it "stores the image in an reduced size" do
+      original_size = size
+      Smusher.store_smushed_image(URL,@file)
+      size.should < original_size
+    end
+    it "uses cleaned url" do
+      Smusher.expects(:write_smushed_data).with("http://xx",@file)
+      Smusher.store_smushed_image('xx',@file)
+    end
+  end
+  describe :store_smushed_folder do
+    before do
+      FileUtils.rm @file
+      @files = []
+      %w[add.png drink_empty.png].each do |name|
+        file = File.join(ROOT,'images',name)
+        @files << File.join(@out,name)
+        FileUtils.cp file, @out
+      end
+      @before = @files.map {|f|File.size(f)}
+    end
+    it "smushes all images" do
+      Smusher.store_smushed_folder(File.dirname(URL),@out)
+      new_sizes = @files.map {|f|File.size(f)}
+      puts new_sizes * ' x '
+      new_sizes.size.times {|i| new_sizes[i].should < @before[i]}
+    end
+  end
+  describe :sanitize_url do
+    it "cleans a url" do
+      Smusher.send(:sanitize_url,'xx').should == "http://xx"
+    end
+    it "does not cleans a url if it contains a protocol" do
+      Smusher.send(:sanitize_url,'ftp://xx').should == "ftp://xx"
+    end
+  end
+  describe :sanitize_folder do
+    it "cleans a folders trailing slash" do
+      Smusher.send(:sanitize_folder,"xx/").should == 'xx'
+    end
+    it "does not clean if there is no trailing slash" do
+      Smusher.send(:sanitize_folder,"/x/ccx").should == '/x/ccx'
+    end
+  end
+  describe :images_in_folder do
+    it "finds all non-gif images" do
+      folder = File.join(ROOT,'images')
+      all = %w[add.png drink_empty.png people.jpg water.JPG woman.jpeg].map{|name|"#{folder}/#{name}"}
+      result = Smusher.send(:images_in_folder,folder)
+      (all+result).uniq.size.should == all.size
+    end
+    it "finds nothing if folder is empty" do
+      Smusher.send(:images_in_folder,File.join(ROOT,'empty')).should == []
+    end
+  end
+  describe :with_protection do
+    def failure_data
+      'x' * (Smusher::SMUSHIT_FAILURE_SIZE-1)
+    end
+    def write(data)
+      File.open(@file,'w') {|f|f.puts data}
+    end
+    def copy
+      FileUtils.cp(File.join(ROOT,'images','people.jpg'),@file)
+    end
+    before do
+      @before = size
+      @before.should_not == 0
+    end
+    it "reverts a file that got larger" do
+      Smusher.send(:with_protection,@file) do
+        write(File.open(@file).read + 'x')
+        @before.should_not == size
+      end
+      @before.should == size
+    end
+    it "does not revert a file that got created" do
+      FileUtils.rm @file
+      File.exist?(@file).should be_false
+      Smusher.send(:with_protection,@file) do
+        copy
+      end
+      File.exist?(@file).should be_true
+    end
+    it "reverts a file that got empty" do
+      Smusher.send(:with_protection,@file) do
+        write nil
+        size.should == Smusher::EMPTY_FILE_SIZE
+      end
+      size.should == @before
+    end
+    it "reverts a file that has error-suggesting size" do
+      #a file larger that failure data
+      write(failure_data+failure_data)
+      @before = size
+      @before.should > Smusher::SMUSHIT_FAILURE_SIZE
+      #gets overwritten by failure data size
+      Smusher.send(:with_protection,@file) do
+        write failure_data
+        size.should == Smusher::SMUSHIT_FAILURE_SIZE
+      end
+      #and should be reverted
+      size.should_not == Smusher::SMUSHIT_FAILURE_SIZE
+      size.should == @before
+    end
+    it "reverts a file that got created and has error suggesting size" do
+      FileUtils.rm @file
+      Smusher.send(:with_protection,@file) do
+        write failure_data
+        File.exist?(@file).should be_true
+      end
+      File.exist?(@file).should be_false
+    end
+  end
+  describe :size do
+    it "find the size of a file" do
+      Smusher.send(:size,@file).should == File.size(@file)
+    end
+    it "returns 0 for missing file" do
+      Smusher.send(:size,File.join(ROOT,'xxxx','dssdfsddfs')).should == 0
+    end
+  end
+  describe :logging do
+    it "yields" do
+      val = 0
+      Smusher.send(:with_logging,URL,@file) {val = 1}
+      val.should == 1
+    end
+  end
+  describe :smushed_image_data_for do
+    it "loads the reduced image" do
+      expected_result = File.join(ROOT,'reduced','fam.png')
+      received = (Smusher.send(:smushed_image_data_for,URL)+"\n")
+      received.should == File.open(expected_result).read
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+require 'mocha'
+require 'lib/smusher'
+# ---- rspec
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+# ---- bugfix
+#`exit?': undefined method `run?' for Test::Unit:Module (NoMethodError)
+#can be solved with require test/unit but this will result in extra test-output
+unless defined? Test::Unit
+  module Test
+    module Unit
+      def self.run?
+        true
+      end
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: grosser-smusher
+version: !ruby/object:Gem::Version
+  version: "0.1"
+platform: ruby
+authors:
+- Michael Grosser
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-01-24 00:00:00 -08:00
+default_executable: smusher
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: json
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: echoe
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: Automatic Lossless Reduction Of All Your Images
+email: grosser.michael@gmail.com
+executables:
+- smusher
+extensions: []
+extra_rdoc_files:
+- lib/smusher.rb
+- bin/smusher
+- README.markdown
+files:
+- Manifest
+- nbproject/private/rake-d.txt
+- nbproject/project.xml
+- nbproject/project.properties
+- lib/smusher.rb
+- spec/out/people.jpg
+- spec/spec_helper.rb
+- spec/smusher_spec.rb
+- spec/images/logo.gif
+- spec/images/woman.jpeg
+- spec/images/add.png
+- spec/images/drink_empty.png
+- spec/images/people.jpg
+- spec/images/water.JPG
+- spec/reduced/fam.png
+- bin/smusher
+- Rakefile
+- README.markdown
+- smusher.gemspec
+has_rdoc: true
+homepage: http://github.com/grosser/smusher
+post_install_message:
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Smusher
+- --main
+- README.markdown
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "1.2"
+  version:
+requirements: []
+rubyforge_project: smusher
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: Automatic Lossless Reduction Of All Your Images
+test_files: []