tiny_png 0.3.0.pre → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+Edge
+
+- Capistrano recipe to shrink images on deploy
+
 0.3.0.pre - October 11, 2012
 
 - Use of config file

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -5,6 +5,7 @@
 - [Installation] (#installation)
 - [Usage] (#usage)
 	- [Using From Rake](#using-from-rake)
+	- [Using With Capistrano](#using-with-capistrano)
 
 ## What Is TinyPNG
 
@@ -28,6 +29,10 @@ When you pass a full path into the `shrink` method, it will replace the source i
 returned by TinyPNG.  If this process fails for whatever reason, the original image will be restored.
 On success, the original image is completely overwritten and is no longer available.
 
+These features can also be used via [Rake](#using-from-rake) or [Capistrano](#using-with-capistrano).
+The latter gives you the option of setting up your deploy to automatically convert your images on your
+external servers!
+
 ## Installation
 
 If you're using bundler, just add the following to your Gemfile:
@@ -44,7 +49,7 @@ Create an instance of the `TinyPng::Client` class:
 @client = TinyPng::Client.new
 ```
 
-Note that this will look for the configuration file in `config/tiny_png.yml`.  See the [sample config](https://github.com/sturgill/tiny_png/sample_config.yml).
+Note that this will look for the configuration file in `config/tiny_png.yml`.  See the [sample config](https://github.com/sturgill/tiny_png/blob/master/sample_config.yml).
 If you choose to not use the config file, you will need to pass in your API key in the optional hash:
 
 ```ruby
@@ -157,4 +162,40 @@ Naturally, these can all be combined in any fashion:
 
 ```ruby
 SUPPRESS_EXCEPTIONS=true API_KEY=my_api_key SHRINK=/image/directory,/some/image.png rake tiny_png:shrink
+```
+
+### Using In Capistrano
+
+Since Photoshop doesn't support indexed PNGs with alpha transparency, you might not want to convert the
+images on your local box.  With the included Capistrano recipe, you can automatically shrink all files
+in your deploy path.
+
+First, include the recipe in your deploy script:
+
+```ruby
+require 'tiny_png/recipes'
+```
+
+Now you can define the callback wherever makes sense for you.  I would recommend calling this before
+the assets are precompiled so that it isn't run multiple times per image:
+
+```ruby
+before 'deploy:assets:precompile', 'tiny_png:shrink'
+```
+
+By default, this script uses the settings found in config/tiny_png.yml.  It also runs through the entire
+release directory.  Each option can be overwritten by setting Capistrano variables.  These variables will
+be sent directly to a Rake task, so the expected format of these variables is the same as listed above:
+
+```ruby
+set :tiny_png_shrink, '/image/directory,/some/image.png'
+set :tiny_png_api_key, 'my_api_key'
+set :tiny_png_suppress_exceptions, true
+```
+
+Also by default, the task is only run on web servers.  This can be modified by setting the `tiny_png_server_role`
+variable:
+
+```ruby
+set :tiny_png_server_role, [:web, :app]
 ```

data/lib/tiny_png.rb

@@ -1,5 +1,5 @@
 module TinyPng
 end
 
-require File.join File.dirname(__FILE__), 'tiny_png', 'client'
-require File.join File.dirname(__FILE__), 'tiny_png', 'version'
+require 'tiny_png/client'
+require 'tiny_png/version'

data/lib/tiny_png/client.rb

@@ -1,8 +1,8 @@
 require 'base64'
 require 'httparty'
-require File.join File.dirname(__FILE__), 'exceptions'
-require File.join File.dirname(__FILE__), 'shrink'
-require File.join File.dirname(__FILE__), 'exception_handling'
+require 'tiny_png/exceptions'
+require 'tiny_png/shrink'
+require 'tiny_png/exception_handling'
 
 module TinyPng
   class Client
@@ -13,14 +13,22 @@ module TinyPng
     base_uri 'api.tinypng.org'
     
     #
-    # Create a new instance of the TinyPng::Shrink class
+    # Create a new instance of the TinyPng::Shrink class.  Any key not passed into the
+    # options hash will use the corresponding value from config/tiny_png.yml. If the config
+    # file does not exist, or if the config file does not define a given value, sensible defaults 
+    # (as outlined below) will be used.
     #
     # Arguments:
-    # - api_key (String)
     # - options (Hash)
     #   - :suppress_exceptions (Boolean)
     #     Default: false
-    #     If false (the default), exceptions will be raised when the process fails.  If suppression is turned on, exceptions will not be raised, but a false value will be returned if shrinking fails for any reason.
+    #     If false (the default), exceptions will be raised when the process fails.  If suppression is 
+    #     turned on, exceptions will not be raised, but a false value will be returned if shrinking fails 
+    #     for any reason.
+    #   - :api_key (String)
+    #     Default: ''
+    #   - :api_user (String)
+    #     Default: 'api'
     #
     # Returns: TinyPng::Client instance
     #
@@ -34,7 +42,7 @@ module TinyPng
       @options = {
         :suppress_exceptions => config['suppress_exceptions'] || false,
         :api_key => config['api_key'] || '',
-        :username => config['api_user'] || 'api'
+        :api_user => config['api_user'] || 'api'
       }.merge(options)
     end
   end

data/lib/tiny_png/recipes.rb

@@ -0,0 +1,35 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :tiny_png do
+    def rails_env
+      fetch(:rails_env, 'production')
+    end
+    
+    def roles
+      fetch(:tiny_png_server_role, :web)
+    end
+    
+    def shrinkwrap
+      fetch(:tiny_png_shrink, current_path)
+    end
+    
+    def rake_env
+      env = ["RAILS_ENV=#{rails_env}", "SHRINK=#{shrinkwrap}"]
+      env.push "API_KEY=#{self[:tiny_png_api_key]}" unless self[:tiny_png_api_key].nil?
+      env.push "API_USER=#{self[:tiny_png_api_user]}" unless self[:tiny_png_api_user].nil?
+      env.push "SUPPRESS_EXCEPTIONS=#{self[:tiny_png_suppress_exceptions]}" unless self[:tiny_png_suppress_exceptions].nil?
+      env
+    end
+
+    def rake(*tasks)
+      rake = fetch(:rake, "rake")
+      tasks.each do |t|
+        run "if [ -d #{release_path} ]; then cd #{release_path}; else cd #{current_path}; fi; if [ -f Rakefile ]; then #{rake} #{rake_env.join(' ')} #{t}; fi;"
+      end
+    end
+
+    desc "Send the requested images to TinyPNG.org for shrinking"
+    task :shrink, :roles => lambda { roles } do
+      rake 'tiny_png:shrink'
+    end
+  end
+end

data/lib/tiny_png/shrink.rb

@@ -2,7 +2,8 @@ module TinyPng::Shrink
   #
   # Replace an image at a given path with its shrunken version
   #
-  # The image at the given path will be submitted to TinyPNG and the new version will overwrite the original.  If this process fails for any reason, the original file will be rolled back.
+  # The image at the given path will be submitted to TinyPNG and the new version will overwrite the original.
+  # If this process fails for any reason, the original file will be rolled back.
   #
   # Arguments:
   # - shrinkwrap (any number of objects to be shrunk)
@@ -10,7 +11,7 @@ module TinyPng::Shrink
   #
   #   If you send in a path to a specific file, it must end in `.png` or it will not be sent to TinyPNG for processing.
   #
-  #   Likewise, when traversing through a directory, only files that end in `.png` will be processed.
+  #   Likewise, when traversing through a directory, only files that end in `.png` will be examined.
   #
   #   All paths to specific files (whether sent in directly or picked out from the directory) need to be readable and writeable.
   #
@@ -48,7 +49,7 @@ module TinyPng::Shrink
     # passes our quick checks, so let's fire off the request
     response = self.class.post(
       '/api/shrink',
-      :basic_auth => { :username => @options[:username], :password => @options[:api_key] },
+      :basic_auth => { :username => @options[:api_user], :password => @options[:api_key] },
       :body => current_content.force_encoding('BINARY')
     )
     

data/lib/tiny_png/tasks.rb

@@ -4,7 +4,7 @@ namespace :tiny_png do
     abort "set SHRINK env var, e.g., $ SHRINK=/path/to/image.png,/path/to/another.png rake tiny_png:shrink" if ENV['SHRINK'].nil?
 
     options = {}    
-    [:api_key, :user_name].each do |key|
+    [:api_key, :api_user].each do |key|
       env_key = key.to_s.upcase
       options[key] = ENV[env_key] unless ENV[env_key].nil?
     end

data/lib/tiny_png/version.rb

@@ -1,3 +1,3 @@
 module TinyPng
-  Version = VERSION = '0.3.0.pre'
+  Version = VERSION = '1.0.0'
 end

data/recipes/tiny_png.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'tiny_png', 'recipes'))

data/tiny_png.gemspec

@@ -1,5 +1,4 @@
-$LOAD_PATH.unshift 'lib'
-require 'tiny_png/version'
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'tiny_png', 'version'))
 
 Gem::Specification.new do |s|
   s.name = 'tiny_png'
@@ -11,12 +10,12 @@ Gem::Specification.new do |s|
   s.author = 'Chris Sturgill'
   s.email = 'chris@thesturgills.com'
   s.files = `git ls-files`.split($/)
-  s.homepage = 'https://github.com/sturgill/tiny_png'
+  s.homepage = 'http://chris.thesturgills.com'
   s.require_paths = ['lib']
   s.add_dependency 'httparty'
   s.license = 'MIT'
   s.post_install_message = %q{For easiest use, create a config file at config/tiny_png.yml file.  Example:
-    https://github.com/sturgill/tiny_png/sample_config.yml
+    https://github.com/sturgill/tiny_png/blob/master/sample_config.yml
     
   }
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: tiny_png
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Chris Sturgill
@@ -13,7 +13,7 @@ date: 2012-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2152185580 !ruby/object:Gem::Requirement
+  requirement: &2156392360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152185580
+  version_requirements: *2156392360
 description: Use the TinyPNG service to minimize the size of your image files.
 email: chris@thesturgills.com
 executables: []
@@ -30,6 +30,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - CHANGELOG.md
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -37,17 +38,19 @@ files:
 - lib/tiny_png/client.rb
 - lib/tiny_png/exception_handling.rb
 - lib/tiny_png/exceptions.rb
+- lib/tiny_png/recipes.rb
 - lib/tiny_png/shrink.rb
 - lib/tiny_png/tasks.rb
 - lib/tiny_png/version.rb
+- recipes/tiny_png.rb
 - sample_config.yml
 - tiny_png.gemspec
-homepage: https://github.com/sturgill/tiny_png
+homepage: http://chris.thesturgills.com
 licenses:
 - MIT
 post_install_message: ! "For easiest use, create a config file at config/tiny_png.yml
-  file.  Example:\n    https://github.com/sturgill/tiny_png/sample_config.yml\n    \n
-  \ "
+  file.  Example:\n    https://github.com/sturgill/tiny_png/blob/master/sample_config.yml\n
+  \   \n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -60,9 +63,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: tiny_png
 rubygems_version: 1.8.16