editable-image 0.22

data/README

@@ -0,0 +1,7 @@
+This is currently alpha software.
+
+A gem for interacting with online image editors. Currently, only Picnik is 
+supported. This is not a straight API wrapper.
+
+See http://github.com/haikuwebdev/editable_image_sample/ for a sample Rails app
+using attachment_fu and this gem to edit images.

data/editable-image.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "editable-image"
+  s.version = "0.22"
+  s.date = "2008-06-12"
+  s.summary = "Simplified interface to web-based image editors."
+  s.email = "tj@haikuwebdev.com"
+  s.homepage = "http://github.com/haikuwebdev/editable-image/"
+  s.description = "Simplified interface to web-based image editors."
+  s.has_rdoc = false
+  s.authors = ["TJ Stankus"]
+  s.files = ["README", "editable-image.gemspec", "lib/multipart.rb", "lib/picnik.rb"]
+  s.test_files = ["test/picnik_test.rb", "test/files/logo.gif"]
+  s.add_dependency("mime-types", [">= 1.15"])
+  s.add_dependency("Shoulda", [">= 1.1.1"])
+end

data/lib/multipart.rb

@@ -0,0 +1,37 @@
+# See http://pivots.pivotallabs.com/users/damon/blog/articles/227-standup-04-27-07-testing-file-uploads
+
+require 'net/http'
+require 'mime/types'
+
+class Net::HTTP::Post
+  
+  def multipart_params=(params = {})
+    boundary_token = [Array.new(8) {rand(256)}].join
+    self.content_type = "multipart/form-data; boundary=#{boundary_token}"
+    boundary_marker = "--#{boundary_token}\r\n"
+    self.body = params.map { |param_name, param_value|
+      boundary_marker + case param_value
+      when String
+        text_to_multipart(param_name, param_value)
+      when File
+        file_to_multipart(param_name, param_value)
+      end
+    }.join('') + "--#{boundary_token}--\r\n"
+  end
+
+  protected
+
+  def file_to_multipart(key, file)
+    filename = File.basename(file.path)
+    mime_types = MIME::Types.of(filename)
+    mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
+    part = "Content-Disposition: form-data; name=#{key}; filename=#{filename}\r\n"
+    part += "Content-Transfer-Encoding: binary\r\n"
+    part += "Content-Type: #{mime_type}\r\n\r\n#{file.read}\r\n"
+  end
+
+  def text_to_multipart(key,value)
+    "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n#{value}\r\n"
+  end
+
+end

data/lib/picnik.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'multipart'
+
+class Picnik
+  
+  PICNIK_API_PARAMETERS = %w(
+    apikey import returntype title export export_agent export_field 
+    export_method export_title imageid original_thumb redirect replace exclude
+    host_name default_in default_out page close_target expand_button
+  )
+  
+  class << self
+    
+    def url(full_filename, parameters)
+      url = ''
+      File.open(full_filename) do |file|
+        http = Net::HTTP.new('www.picnik.com')
+        http.start do |http|
+          request = Net::HTTP::Post.new('/service/')
+          request.multipart_params = request_parameters(file, parameters)
+          response = http.request(request)
+          url = parse_image_url_from(response)
+        end
+      end
+      url
+    end
+    
+    private
+    
+    def request_parameters(file, parameters)
+      import_parameters = { :import => 'image_data', :image_data => file }
+      scrub_parameters(import_parameters.merge(parameters))
+    end
+    
+    def scrub_parameters(parameters)
+      scrubbed_parameters = {}
+      parameters.each do |key, value| 
+        scrubbed_parameters[parameter_key(key)] = value
+      end
+      scrubbed_parameters
+    end
+    
+    def parameter_key(key)
+      key = key.to_s
+      PICNIK_API_PARAMETERS.include?(key) ? '_' + key : key
+    end
+    
+    def parse_image_url_from(response)
+      body = response.body
+      start_index = body.index('>') + 1
+      end_index = body.index('<', start_index)
+      body.slice((start_index...end_index))
+    end
+    
+  end
+  
+end

data/test/picnik_test.rb

@@ -0,0 +1,71 @@
+require File.dirname(__FILE__) + '/../lib/picnik'
+require 'test/unit'
+require 'shoulda'
+
+class PicnikTest < Test::Unit::TestCase
+  
+  # TODO: test response
+  # TODO: test bad filename passed to url
+  # TODO: test non-image filename passed to url
+  # TODO: exception for not passing apikey to parameters?
+  
+  context "Request parameters" do
+    setup do
+      def Picnik.public_request_parameters(*args)
+        request_parameters(*args)
+      end
+      @file = File.open("files/logo.gif")
+      parameters = {:apikey => 'this_is_a_test_picnik_apikey'}
+      @request_parameters = Picnik.public_request_parameters(@file, parameters)
+    end
+    
+    teardown do
+      @file.close
+    end
+    
+    should "include _import with correct value" do
+      assert @request_parameters.keys.include?('_import')
+    end
+    
+    should "have correct value for _import" do
+      assert_equal 'image_data', @request_parameters['_import']
+    end
+    
+    should "include image_data" do
+      assert @request_parameters.keys.include?('image_data')
+    end
+    
+    should "not have nil image_data" do
+      assert_not_nil @request_parameters['image_data']
+    end    
+  end
+  
+  context "Parameter key" do
+    setup do
+      def Picnik.public_parameter_key(*args)
+        parameter_key(*args)
+      end
+    end
+    
+    should "be stringified" do
+      assert_equal 'foo', Picnik.public_parameter_key(:foo)
+    end
+    
+    should "add underscore for Picnik API parameter" do
+      assert_equal '_apikey', Picnik.public_parameter_key(:apikey)
+    end
+    
+    should "not add underscore for non-Picnik API parameter" do
+      assert_equal 'foo', Picnik.public_parameter_key('foo')
+    end
+    
+    should "not add underscore for Picnik API parameter that already has one" do
+      assert_equal '_apikey', Picnik.public_parameter_key('_apikey')
+    end
+    
+    should "keep underscore for non Picnik API parameter" do
+      assert_equal '_method', Picnik.public_parameter_key('_method')
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: editable-image
+version: !ruby/object:Gem::Version 
+  version: "0.22"
+platform: ruby
+authors: 
+- TJ Stankus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: Shoulda
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+description: Simplified interface to web-based image editors.
+email: tj@haikuwebdev.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- editable-image.gemspec
+- lib/multipart.rb
+- lib/picnik.rb
+has_rdoc: false
+homepage: http://github.com/haikuwebdev/editable-image/
+post_install_message: 
+rdoc_options: []
+
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Simplified interface to web-based image editors.
+test_files: 
+- test/picnik_test.rb
+- test/files/logo.gif