editable-image 0.23 → 0.25

data/README

@@ -1,8 +1,10 @@
 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 
+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.
 
+You'll need the shoulda gem to run the tests.
+
 The gem is served from rubyforge. http://rubyforge.org/projects/editable-image/

data/editable-image.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |s|
   s.name = "editable-image"
-  s.version = "0.23"
-  s.date = "2008-07-01"
+  s.version = "0.25"
+  s.date = "2008-09-02"
   s.summary = "Simplified interface to web-based image editors."
   s.email = "tj@haikuwebdev.com"
-  s.homepage = "http://github.com/haikuwebdev/editable-image/"
+  s.homepage = ""
   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.files = ["editable-image.gemspec", "README", "lib/multipart.rb", "lib/editable-image.rb", "lib/editable-image/exceptions.rb", "lib/picnik/picnik.rb"]
+  s.test_files = ["test/picnik_test.rb", "test/files/logo.gif", "test/files/test.txt"]
   s.add_dependency("mime-types", [">= 1.15"])
   s.add_dependency("Shoulda", [">= 1.1.1"])
 end

data/lib/editable-image.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'mime/types'
+require 'multipart'
+require 'editable-image/exceptions'
+require 'picnik/picnik'

data/lib/editable-image/exceptions.rb

@@ -0,0 +1,6 @@
+module EditableImage
+  class EditableImageError < StandardError; end;
+  class InvalidParametersError < EditableImageError; end
+  class InvalidFileTypeError < EditableImageError; end
+  class InvalidFilenameError < EditableImageError; end
+end

data/lib/picnik/picnik.rb

@@ -0,0 +1,63 @@
+module EditableImage
+  class Picnik
+
+    PICNIK_API_PARAMETERS = %w(
+      apikey sig expires locale import returntype title export export_agent
+      export_field export_method export_title redirect imageid original_thumb
+      replace thumbs out_format out_quality out_maxsize out_maxwidth out_maxheight
+      exclude host_name default_in default_out page close_target expand_button
+    )
+
+    def self.url(full_filename, parameters)
+      raise EditableImage::InvalidParametersError unless api_key_in?(parameters)
+      url = ''
+      File.open(full_filename) do |file|
+        raise EditableImage::InvalidFileTypeError unless image?(full_filename)
+        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 = response.body
+        end
+      end
+      url
+    rescue EditableImage::InvalidFileTypeError => e
+      raise e, "File must be an image."
+    rescue EditableImage::InvalidParametersError => e
+      raise e, "Parameters must include the apikey."
+    rescue Errno::ENOENT => e
+      raise EditableImage::InvalidFilenameError.new, e.message
+    end
+
+    private
+
+    def self.request_parameters(file, parameters)
+      required_parameters = { :import => 'image_data', :image_data => file, :returntype => 'text' }
+      scrub_parameters(required_parameters.merge(parameters))
+    end
+
+    def self.scrub_parameters(parameters)
+      scrubbed_parameters = {}
+      parameters.each do |key, value|
+        scrubbed_parameters[parameter_key(key)] = value
+      end
+      scrubbed_parameters
+    end
+
+    def self.parameter_key(key)
+      key = key.to_s
+      PICNIK_API_PARAMETERS.include?(key) ? '_' + key : key
+    end
+
+    def self.image?(filename)
+      MIME::Types.of(filename).first.media_type == 'image'
+    end
+
+    # NOTE: Generalize, DRY up if needed. For now YAGNI.
+    def self.api_key_in?(parameters)
+      scrub_parameters(parameters).has_key?('_apikey')
+    end
+
+  end
+end

data/test/picnik_test.rb

@@ -1,32 +1,30 @@
-require File.dirname(__FILE__) + '/../lib/picnik'
+require File.dirname(__FILE__) + '/../lib/editable-image'
 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)
+      EditableImage::Picnik.class_eval do
+        def self.public_request_parameters(*args)
+          request_parameters(*args)
+        end
       end
       @file = File.open("files/logo.gif")
-      parameters = {:apikey => 'this_is_a_test_picnik_apikey'}
-      @request_parameters = Picnik.public_request_parameters(@file, parameters)
+      parameters = {:apikey => 'test_picnik_apikey'}
+      @request_parameters = EditableImage::Picnik.public_request_parameters(@file, parameters)
     end
     
     teardown do
       @file.close
     end
     
-    should "include _import with correct value" do
+    should "include _import" do
       assert @request_parameters.keys.include?('_import')
     end
-    
+  
     should "have correct value for _import" do
       assert_equal 'image_data', @request_parameters['_import']
     end
@@ -37,35 +35,106 @@ class PicnikTest < Test::Unit::TestCase
     
     should "not have nil image_data" do
       assert_not_nil @request_parameters['image_data']
-    end    
+    end
+    
+    should "include _returntype" do
+      assert @request_parameters.keys.include?('_returntype')
+    end
+    
+    should "have returntype of text" do
+      assert_equal 'text', @request_parameters['_returntype']
+    end
+    
   end
   
   context "Parameter key" do
     setup do
-      def Picnik.public_parameter_key(*args)
-        parameter_key(*args)
+      EditableImage::Picnik.class_eval do
+        def self.public_parameter_key(*args)
+          parameter_key(*args)
+        end
       end
     end
-    
+  
     should "be stringified" do
-      assert_equal 'foo', Picnik.public_parameter_key(:foo)
+      assert_equal 'foo', EditableImage::Picnik.public_parameter_key(:foo)
     end
-    
+  
     should "add underscore for Picnik API parameter" do
-      assert_equal '_apikey', Picnik.public_parameter_key(:apikey)
+      assert_equal '_apikey', EditableImage::Picnik.public_parameter_key(:apikey)
     end
-    
+  
     should "not add underscore for non-Picnik API parameter" do
-      assert_equal 'foo', Picnik.public_parameter_key('foo')
+      assert_equal 'foo', EditableImage::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')
+      assert_equal '_apikey', EditableImage::Picnik.public_parameter_key('_apikey')
     end
-    
+  
     should "keep underscore for non Picnik API parameter" do
-      assert_equal '_method', Picnik.public_parameter_key('_method')
+      assert_equal '_method', EditableImage::Picnik.public_parameter_key('_method')
+    end
+  end
+  
+  context "A bad filename" do
+    setup do 
+      @filename = 'bad_filename'
+      @parameters = {:apikey => 'test'}
+    end
+    
+    should "raise EditableImage::InvalidFilenameError exception" do
+      assert_raise(EditableImage::InvalidFilenameError) do 
+        EditableImage::Picnik.url(@filename, @parameters)
+      end
+    end
+    
+    should "have exception message containing 'no such file'" do
+      begin
+        EditableImage::Picnik.url(@filename, @parameters)
+      rescue EditableImage::InvalidFilenameError => e
+        assert_match /no such file/i, e.message
+      end
     end
   end
   
+  context "A non-image file" do
+    setup do
+      @non_image_filename = File.expand_path("files/test.txt")
+      @parameters = {:apikey => 'test'}
+    end
+    
+    should "raise EditableImage::InvalidFileTypeError exception" do
+      assert_raise(EditableImage::InvalidFileTypeError)  do
+        EditableImage::Picnik.url(@non_image_filename, @parameters)
+      end
+    end
+    
+    should "have exception message containing 'foo'" do
+      begin
+        EditableImage::Picnik.url(@non_image_filename, @parameters)
+      rescue EditableImage::InvalidFileTypeError => e
+        assert_match /must be an image/i, e.message
+      end
+    end
+  end
+  
+  context "A request for url without apikey in parameters" do
+    
+    should "raise EditableImage::InvalidParametersError" do
+      assert_raise(EditableImage::InvalidParametersError) do
+        EditableImage::Picnik.url('some_filename', {})
+      end
+    end
+    
+    should "raise EditableImage::InvalidParametersError exception with message containing 'must include the apikey'" do
+      begin
+        EditableImage::Picnik.url('some_filename', {})
+      rescue EditableImage::InvalidParametersError => e
+        assert_match /must include the apikey/i, e.message
+      end
+    end
+    
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: editable-image
 version: !ruby/object:Gem::Version 
-  version: "0.23"
+  version: "0.25"
 platform: ruby
 authors: 
 - TJ Stankus
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-01 00:00:00 -04:00
+date: 2008-09-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,12 +41,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
 - editable-image.gemspec
+- README
 - lib/multipart.rb
-- lib/picnik.rb
+- lib/editable-image.rb
+- lib/editable-image/exceptions.rb
+- lib/picnik/picnik.rb
 has_rdoc: false
-homepage: http://github.com/haikuwebdev/editable-image/
+homepage: ""
 post_install_message: 
 rdoc_options: []
 
@@ -74,3 +76,4 @@ summary: Simplified interface to web-based image editors.
 test_files: 
 - test/picnik_test.rb
 - test/files/logo.gif
+- test/files/test.txt

data/lib/picnik.rb

@@ -1,55 +0,0 @@
-require 'rubygems'
-require 'multipart'
-
-class Picnik
-  
-  PICNIK_API_PARAMETERS = %w(
-    apikey sig expires locale import returntype title export export_agent 
-    export_field export_method export_title redirect imageid original_thumb 
-    replace thumbs out_format out_quality out_maxsize out_maxwidth out_maxheight
-    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)
-      required_parameters = { :import => 'image_data', :image_data => file, :returntype => 'text' }
-      scrub_parameters(required_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)
-      response.body
-    end
-    
-  end
-  
-end