tiny_png 0.1.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 Chris Sturgill, chris.thesturgills.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+## Table Of Contents
+
+- [What Is TinyPNG] (#what-is-tinypng)
+- [What Does This Gem Do?] (#what-does-this-gem-do)
+- [Installation] (#installation)
+- [Usage] (#usage)
+
+## What Is TinyPNG
+
+[TinyPNG](http://www.tinypng.org) is a web-based service for shrinking the size of your PNG files.
+The process employed preserves full alpha transparency.  In short, it's a free service that makes
+PNGs smaller (which reduces bandwidth and increases site performance).
+
+## What Does This Gem Do
+
+TinyPNG has opened up a private beta for programmatically calling using their services.  Before
+this API was introduced, TinyPNG could only be used from their [web interface](http://www.tinypng.org).
+And while their homepage is cool and all, manually uploading and saving files is a less-than-enjoyable
+process.  The kind of process a computer was made to do for you.  Ergo this gem.
+
+This gem interacts with TinyPNG's API to replace a given PNG with its shrunken counterpart.
+
+## Installation
+
+If you're using bundler, just add the following to your Gemfile:
+
+```ruby
+gem 'tiny_png'
+```
+
+## Usage
+
+Create an instance of the `TinyPng::Shrink` class, passing in your API key:
+
+```ruby
+@tiny = TinyPng::Shrink.new API_KEY
+```
+
+If you want to work with a list of images, and want to silently suppress exceptions, just pass that in the options field:
+
+```ruby
+@tiny = TinyPng::Shrink.new API_KEY, { :suppress_exceptions => true }
+```
+
+Next, pass in the full path to the image you want to shrink
+
+```ruby
+@tiny.shrink '/FULL/PATH/TO/IMAGE.png'
+```
+
+The shrunken image will be saved in the same path, effectively overwriting the old file.
+
+**NOTE:**
+
+- There must be a file already at the specified path
+- That file must be readable and writeable
+- The file name *must* end in `.png`

data/lib/tiny_png/exception_handling.rb

@@ -0,0 +1,9 @@
+module TinyPng::ExceptionHandling
+  #
+  # If exceptions are suppressed, just return false.  Otherwise, raise the given exception
+  #
+  def raise_exception exception, message
+    return false if @options[:suppress_exceptions]
+    raise exception, message
+  end
+end

data/lib/tiny_png/exceptions.rb

@@ -0,0 +1,14 @@
+class InvalidFileType < Exception
+end
+
+class FileDoesntExist < Exception
+end
+
+class FileNotReadable < Exception
+end
+
+class FileNotWriteable < Exception
+end
+
+class ShrinkingFailed < Exception
+end

data/lib/tiny_png/tiny_png.rb

@@ -0,0 +1,74 @@
+require 'base64'
+require 'httparty'
+require File.join File.dirname(__FILE__), 'exceptions'
+require File.join File.dirname(__FILE__), 'exception_handling'
+
+module TinyPng
+  class Shrink
+    include TinyPng::ExceptionHandling
+    
+    include HTTParty
+    base_uri 'api.tinypng.org'
+    
+    #
+    # Create a new instance of the TinyPng::Shrink class
+    #
+    # 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.
+    #
+    # Returns: TinyPng::Shrink instance
+    #
+    def initialize api_key, options={}
+      @options = { :suppress_exceptions => false }.merge options
+      @auth = { :username => 'api', :password => api_key }
+    end
+    
+    #
+    # 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.
+    #
+    # Arguments:
+    # - image_path (String)
+    #   The full path to the image that should be shrunk. Requirements:
+    #   - Must be the full and absolute path (not a relative path)
+    #   - Path must end in `.png`
+    #   - Path must be readable
+    #   - Path must be writeable
+    #
+    # Returns: Boolean (whether or not the action was successful)
+    #
+    def shrink image_path
+      # check to make sure everything looks kosher before sending data to TinyPNG
+      return raise_exception InvalidFileType, 'The file must be a PNG' unless image_path.downcase.match(/\.png$/)
+      return raise_exception FileDoesntExist, "Can't find a file at the specified path" unless File.exists? image_path
+      return raise_exception FileNotReadable, "Can't read the requested file" unless File.readable? image_path
+      return raise_exception FileNotWriteable, "Can't write to the specifed file" unless File.writable? image_path
+      
+      # store current content in case we need to rollback later
+      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'))
+      
+      # abort unless TinyPNG successfully did its thing
+      return raise_exception ShrinkingFailed, response.message unless response.code == 200
+      
+      # only overwrite if the new file is smaller than the old
+      if response['output']['ratio'] < 1
+        begin
+          open(image_path, 'wb') { |f| f.write HTTParty.get(response['output']['url']).parsed_response }
+        rescue # if the writing process fails for whatever reason, rollback and raise custom error
+          open(image_path, 'wb') { |f| f.write current_content }
+          return raise_exception ShrinkingFailed, "Couldn't write new content"
+        end
+      end
+      
+      true
+    end
+  end
+end

data/lib/tiny_png.rb

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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: tiny_png
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Sturgill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2152385040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152385040
+description: Use the TinyPNG service to minimize the size of your image files.
+email: chris@thesturgills.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tiny_png/exception_handling.rb
+- lib/tiny_png/exceptions.rb
+- lib/tiny_png/tiny_png.rb
+- lib/tiny_png.rb
+- LICENSE
+- README.md
+homepage: http://chris.thesturgills.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: tiny_png
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Make your PNGs tiny
+test_files: []