tiny_png 0.2.0 → 0.3.0.pre

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+tiny_png*.gem
+Gemfile.lock
+.rvmrc

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+0.3.0.pre - October 11, 2012
+
+- Use of config file
+- Introduce rake task to perform shrinking action on images / directories
+
+0.2.0 - October 10, 2012
+
+- Allow for shrinking multiple images / directories at one time
+- Move from TinyPng::Shrink.new to TinyPng::Client.new
+
+0.1.1 - October 10, 2012
+
+- First release

data/README.md

@@ -4,6 +4,7 @@
 - [What Does This Gem Do?] (#what-does-this-gem-do)
 - [Installation] (#installation)
 - [Usage] (#usage)
+	- [Using From Rake](#using-from-rake)
 
 ## What Is TinyPNG
 
@@ -37,16 +38,24 @@ gem 'tiny_png'
 
 ## Usage
 
-Create an instance of the `TinyPng::Client` class, passing in your API key:
+Create an instance of the `TinyPng::Client` class:
 
 ```ruby
-@client = TinyPng::Client.new API_KEY
+@client = TinyPng::Client.new
 ```
 
-If you want to work with a list of images, and want to silently suppress exceptions, just pass that in the options field:
+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).
+If you choose to not use the config file, you will need to pass in your API key in the optional hash:
 
 ```ruby
-@client = TinyPng::Client.new API_KEY, { :suppress_exceptions => true }
+@client = TinyPng::Client.new :api_key => 'my_api_key'
+```
+
+If you want to work with a list of images, and want to silently suppress exceptions, change that in the config file or
+pass it into the optional hash:
+
+```ruby
+@client = TinyPng::Client.new :suppress_exceptions => true
 ```
 
 Next, pass in the full paths to the images you want to shrink (you can also pass in whole directories)
@@ -83,4 +92,69 @@ For each image path analyzed (whether sent in directly or picked out of a folder
 
 - There must be a file already at the specified path
 - That file must be readable and writeable
-- The file name *must* end in `.png`
+- The file name *must* end in `.png`
+
+### Using From Rake
+
+Create a Rakefile in your app's root (or add this to an existing Rakefile):
+
+```ruby
+require 'your/app'
+require 'tiny_png/tasks'
+```
+
+The `rake tiny_png:shrink` task can be called to shrink images from the command line.  To use this rake task,
+you must pass a environment variable called `SHRINK`.  `SHRINK` should be a comma-separated list of paths you want shrunk.
+As with the `@client.shrink` method, the SHRINK variable accepts both directory and specific image paths.
+
+**NOTE:** Because this works by splitting the environment string into an array based on a comma separator, it follows
+that you can't have commas in your directory or image paths.
+
+The same constraints exist from rake as do from the method call: namely, you must supply the full path, and specific
+image paths must exist, be readable, be writable, and end in `.png`.
+
+**Examples:**
+
+Shrink a single file:
+
+```ruby
+SHRINK=/path/to/image.png rake tiny_png:shrink
+```
+
+Shrink multiple files:
+
+```ruby
+SHRINK=/path/to/first.png,/path/to/second.png rake tiny_png:shrink
+```
+
+Shrink a whole directory:
+
+```ruby
+SHRINK=/image/directory rake tiny_png:shrink
+```
+
+Combining directories and specific image files:
+
+```ruby
+SHRINK=/image/directory,/path/to/image.png rake tiny_png:shrink
+```
+
+By default, this rake task will use the settings in config/tiny_png.yml.  You can overwrite specific settings by passing
+environment variables.  For example, if I do not suppress exceptions in my base config, but want
+to when running a rake task, all I would need to do is set the `SUPPRESS_EXCEPTIONS` environment variable to true:
+
+```ruby
+SUPPRESS_EXCEPTIONS=true SHRINK=/some/image.png rake tiny_png:shrink
+```
+
+You can pass in an api key in a similar way:
+
+```ruby
+API_KEY=my_api_key SHRINK=/some/image.png rake tiny_png:shrink
+```
+
+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
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'rubygems'

data/lib/tiny_png.rb

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

data/lib/tiny_png/client.rb

@@ -24,9 +24,18 @@ module TinyPng
     #
     # Returns: TinyPng::Client instance
     #
-    def initialize api_key, options={}
-      @options = { :suppress_exceptions => false }.merge options
-      @auth = { :username => 'api', :password => api_key }
+    def initialize options={}
+      if defined?(Rails) && Rails.try(:root) && Rails.try(:env)
+        config_path = File.join(Rails.root, 'config', 'tiny_png.yml')
+        config = YAML.load_file(config_path)[Rails.env] if File.exists? config_path
+      end
+      config ||= {}
+      
+      @options = {
+        :suppress_exceptions => config['suppress_exceptions'] || false,
+        :api_key => config['api_key'] || '',
+        :username => config['api_user'] || 'api'
+      }.merge(options)
     end
   end
 end

data/lib/tiny_png/shrink.rb

@@ -46,7 +46,11 @@ module TinyPng::Shrink
     current_content = File.read image_path
     
     # passes our quick checks, so let's fire off the request
-    response = self.class.post('/api/shrink', :basic_auth => @auth, :body => current_content.force_encoding('BINARY'))
+    response = self.class.post(
+      '/api/shrink',
+      :basic_auth => { :username => @options[:username], :password => @options[:api_key] },
+      :body => current_content.force_encoding('BINARY')
+    )
     
     # abort unless TinyPNG successfully did its thing
     return raise_exception ShrinkingFailed, response.message unless response.code == 200

data/lib/tiny_png/tasks.rb

@@ -0,0 +1,21 @@
+namespace :tiny_png do
+  desc 'Shrink the images/directory: the SHRINK env variable must be set (comma-separated list of all files / directories you want shrunk)'
+  task :shrink => :environment 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|
+      env_key = key.to_s.upcase
+      options[key] = ENV[env_key] unless ENV[env_key].nil?
+    end
+    
+    unless ENV['SUPPRESS_EXCEPTIONS'].nil?
+      unless ['true', 'false'].include?(ENV['SUPPRESS_EXCEPTIONS'].downcase)
+        abort "SUPPRESS_EXCEPTIONS can only be set to true or false: #{ENV['SUPPRESS_EXCEPTIONS']} is not a valid boolean value."
+      end
+      options[:suppress_exceptions] = ENV['SUPPRESS_EXCEPTIONS'].downcase == 'true'
+    end
+    
+    TinyPng::Client.new(options).shrink ENV['SHRINK'].split(',')
+  end
+end

data/lib/tiny_png/version.rb

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

data/sample_config.yml

@@ -0,0 +1,3 @@
+development:
+  suppress_exceptions: false
+  api_key: my_api_key_here

data/tiny_png.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift 'lib'
+require 'tiny_png/version'
+
+Gem::Specification.new do |s|
+  s.name = 'tiny_png'
+  s.version = TinyPng::Version
+  s.platform = Gem::Platform::RUBY
+  s.rubyforge_project = 'tiny_png'
+  s.summary = 'Make your PNGs tiny'
+  s.description = "Use the TinyPNG service to minimize the size of your image files."
+  s.author = 'Chris Sturgill'
+  s.email = 'chris@thesturgills.com'
+  s.files = `git ls-files`.split($/)
+  s.homepage = 'https://github.com/sturgill/tiny_png'
+  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
+    
+  }
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: tiny_png
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0.pre
+  prerelease: 6
 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: &2152072180 !ruby/object:Gem::Requirement
+  requirement: &2152185580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,24 +21,33 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152072180
+  version_requirements: *2152185580
 description: Use the TinyPNG service to minimize the size of your image files.
 email: chris@thesturgills.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/tiny_png.rb
 - lib/tiny_png/client.rb
 - lib/tiny_png/exception_handling.rb
 - lib/tiny_png/exceptions.rb
 - lib/tiny_png/shrink.rb
-- lib/tiny_png.rb
-- LICENSE
-- README.md
+- lib/tiny_png/tasks.rb
+- lib/tiny_png/version.rb
+- sample_config.yml
+- tiny_png.gemspec
 homepage: https://github.com/sturgill/tiny_png
 licenses:
 - MIT
-post_install_message: 
+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
+  \ "
 rdoc_options: []
 require_paths:
 - lib
@@ -51,9 +60,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: tiny_png
 rubygems_version: 1.8.16