jamescook-ruby-imagebam 0.2.0

data/README

@@ -0,0 +1,37 @@
+-- ruby-imagebam
+
+ruby-imagebam provides a module to easily upload your images to ImageBam via their API.
+
+You need both a user and developer key from http://www.imagebam.com/nav/API after you have created an account.
+
+-- Usage
+
+# Uploading a single file
+ib = ImageBam::Upload::Image.new(:file_path => '/path/to/my/picture.jpg', 
+                          :content_type => 0, # 0 = safe for work, 1 = not safe for work
+                          :api_key_dev => 'your-dev-key',
+                          :api_key_user => 'your-user-key',
+                          :api_user_secret => 'your-user-secret',
+                          :api_dev_secret => 'your-dev-secret')
+
+response = ib.upload!                          
+puts response[:url]
+
+
+
+# Uploading multiple files
+ib = ImageBam::Upload::Image.new(:file_path => ['/path/to/my/picture.jpg', '/path/to/my/picture2.jpg'], 
+                          :content_type => 0, # 0 = safe for work, 1 = not safe for work
+                          :api_key_dev => 'your-dev-key',
+                          :api_key_user => 'your-user-key',
+                          :api_user_secret => 'your-user-secret',
+                          :api_dev_secret => 'your-dev-secret')
+
+responses = ib.upload!                          
+responses.each do |response|
+ puts response[:url]
+end
+                          
+-- Notes
+ The response is a hash. See lib/response.rb for the keys you have access to.
+ You can upload multiple files at once (using threads) if you set allow_concurrent_uploads to true

data/demo.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__),"image_bam.rb")
+
+ib = ImageBam::Image.new(:file_path => '/Users/jimmy/pics/awesome_screenshot.jpg', 
+                          :content_type => 0,
+                          :api_key_dev => 'your-dev-key',
+                          :api_key_user => 'your-user-key',
+                          :api_user_secret => 'your-user-secret',
+                          :api_dev_secret => 'your-dev-secret')
+                          
+response = ib.upload!                          
+puts response[:status]
+

data/image_bam.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/image_bam.rb'

data/lib/errors.rb

@@ -0,0 +1,19 @@
+module ImageBam
+  module Errors
+    # 1: No image uploaded / zero filesize / general upload error (UPLOAD)
+    # 2: Developer API-Key has not been found (GENERAL)
+    # 3: User API-Key has not been found (GENERAL)
+    # 4: Content type has not been set (UPLOAD)
+    # 5: Invalid gallery ID (UPLOAD)
+    # 6: Secret is invalid (UPLOAD)
+    # 7: Image has been banned from Imagebam (UPLOAD)
+    # 8: File-extention is not allowed (UPLOAD)
+    # 9: File exceeded maximum allowed size (UPLOAD)
+    # 666: Developer API Key has been disabled by ImageBAM (GENERAL)    
+    class InvalidPath < RuntimeError; end    
+    class InvalidContentType < RuntimeError; end
+    class InvalidSalt < RuntimeError; end
+    class InvalidFilePattern < RuntimeError; end
+    class ResponseError < RuntimeError; end
+  end
+end

data/lib/gallery.rb

@@ -0,0 +1,23 @@
+module ImageBam
+  class Gallery
+    def initialize(args)
+        @api_key_dev      = args[:api_key_dev] 
+        @api_key_user     = args[:api_key_user]
+        @api_dev_secret   = args[:api_dev_secret] 
+        @api_user_secret  = args[:api_user_secret]
+        @salt             = args[:salt] || Digest::MD5.hexdigest(Time.now.to_i.to_s + 'splahdow!')
+    end
+    
+    def generate_secret
+      @secret ||= Digest::MD5.hexdigest(@api_dev_secret + @api_user_secret + @salt)
+    end
+    
+    def generate!
+      query = "API_key_dev=#{@api_key_dev}&API_key_user=#{@api_key_user}&salt=#{@salt}&secret=#{generate_secret}"
+      response = Net::HTTP.start(ImageBam::GALLERY_URL.host).post2(ImageBam::GALLERY_URL.path, query, "Content-type" => "application/x-www-form-urlencoded;")      
+      return ImageBam::Response.new( response.body, 'gallery' ).response          
+    end
+    
+  end
+end
+

data/lib/image.rb

@@ -0,0 +1,155 @@
+module ImageBam
+    class Image
+      include MIME
+      attr_accessor :file_path, :content_type, :api_key_dev, :api_key_user, :api_user_secret, :api_dev_secret, :salt, :allow_concurrent_uploads, :file_pattern
+      
+      def initialize(args)
+        @api_key_dev      = args[:api_key_dev] 
+        @api_key_user     = args[:api_key_user]
+        @api_dev_secret   = args[:api_dev_secret] 
+        @api_user_secret  = args[:api_user_secret]
+        @salt             = args[:salt] || Digest::MD5.hexdigest(Time.now.to_i.to_s + 'splahdow!')
+        @content_type     = args[:content_type] || 0
+        @allow_concurrent_uploads = false
+        @file_pattern     = args[:file_pattern] || /.*/
+        @gallery       = args[:gallery] || nil
+        
+        # Handle a directory of images
+        if(!args[:file_path].is_a?(Array) && File.directory?(args[:file_path]))
+          @file_path = filter_images_in_dir(args[:file_path], @file_pattern)
+        else
+          @file_path = args[:file_path]
+        end        
+        
+        validate_args
+      end
+    
+      def upload!
+        boundary  = '42424242424242424242424242424242424242424242424242424242'
+        if(@file_path.is_a? Array)
+          return upload_many(@file_path)
+        else
+          query     = content_headers.map {|p| '--' + boundary + "\r\n" + p}.join('') + "--" + boundary + "--\r\n"    
+          puts query
+          response  = Net::HTTP.start(ImageBam::POST_URL.host).post2(ImageBam::POST_URL.path, query, "Content-type" => "multipart/form-data; boundary=" + boundary)
+          return ImageBam::Response.new( response.body, 'image' ).response          
+        end  
+      end
+    
+    
+      def gallery_url
+        if(@gallery)
+          "http://www.imagebam.com/gallery/#{@gallery}"
+        end
+      end
+      
+      private 
+    
+      def upload_many(files)
+        if(@allow_concurrent_uploads == true)
+          semaphore = Mutex.new
+          semaphore.synchronize {
+            responses = []
+            @threads = []
+            files.each do |file|
+              @file_path = file
+              
+              # Only launch 5 threads at at a time, max
+              if(@threads.length < 5)
+                @threads.push( Thread.new { responses.push(upload!) } )
+                files.delete(file)
+              end
+              sleep(1)                
+              purge_sleeping_threads
+              
+              # Restart the process if there are more files, or all threads busy
+              if(files.any?)
+                upload_many(files)
+              end
+            end            
+            return responses            
+          }
+        else
+          responses = []
+          files.each do |file|
+            @file_path = file
+            responses.push upload!
+          end          
+          return responses          
+        end
+      end
+      
+      # An array of all required parameters that will be POSTed
+      # Mostly ripped from http://www.realityforge.org/articles/2006/03/02/upload-a-file-via-post-with-net-http
+      def content_headers
+        params = [param_for('API_key_dev', @api_key_dev),
+          param_for('API_key_user', @api_key_user),
+          param_for('secret', generate_secret),
+          param_for('salt', @salt),
+          param_for('gallery', @gallery),
+          param_for('content_type', @content_type),
+          "Content-Disposition: form-data; name=photo; filename=\"#{File.basename(@file_path)}\"\r\n" +
+           "Content-Transfer-Encoding: binary\r\n" +
+           "Content-Type: #{MIME::Types.type_for(@file_path)}\r\n" + 
+           "\r\n" + 
+           "#{File.read(@file_path)}\r\n"]
+      end
+      
+      # Wrap the text-only data in the appropriate header
+      def param_for(key,value)
+        "Content-Disposition: form-data; name=\"#{::CGI::escape(key)}\"\r\n" + 
+         "\r\n" + 
+         "#{value}\r\n"        
+      end
+      
+      # From API docs..
+      # 32 character secret by building the md5-checksum of the string consisting of your API-Secret, 
+      # the user's API-Secret and the 32-character salt. 
+      def generate_secret
+        @secret ||= Digest::MD5.hexdigest(@api_dev_secret + @api_user_secret + @salt)
+      end
+      
+      def validate_args
+        
+        raise ImageBam::Errors::InvalidFilePattern unless @file_pattern.is_a?(Regexp)
+        
+        if(@file_path.is_a? Array)
+          errors = []
+          @file_path.each do |file|
+            errors.push("#{file} is invalid.") unless File.exists?(file)
+          end
+          raise ImageBam::Errors::InvalidPath, errors.join("\n") unless errors.empty?
+        else
+          unless(File.exists?(@file_path) || File.directory?(@file_path))
+            raise ImageBam::Errors::InvalidPath, "An invalid file path was specified"
+          end
+        end
+      
+        unless(@content_type == 0 || @content_type == 1)
+          raise ImageBam::Errors::InvalidContentType, "Either 0 (SFW) or 1 (NSFW) must be specified as a content type. You said #{@content_type}"
+        end
+        
+        unless(@salt =~ /^[a-zA-Z0-9]+$/)  
+          raise ImageBam::Errors::InvalidSalt, "Salt is invalid. You must only use alpha-numeric characters (0-9 & A-Z). You provided #{@salt}"
+        end
+      end   
+      
+      # Only find images, and then filter them out by regex
+      def filter_images_in_dir(path, regexp)
+        old_dir = Dir.pwd
+        Dir.chdir(path)
+        images = Dir.glob("*.{jpg,jpeg,png,gif,bmp}").map{|f| f="#{File.join(path, f)}"}   
+        filtered_images = images.reject{|img| !(File.basename(img) =~ regexp)}
+        puts filtered_images.join(", ")
+        Dir.chdir(old_dir)
+        return filtered_images
+      end
+      
+      def purge_sleeping_threads
+        @threads.each do |thread|
+          # TODO should I call thread.join here? does it matter?
+          @threads.delete(thread) unless thread.alive?
+        end
+      end
+    end
+end

data/lib/image_bam.rb

@@ -0,0 +1,15 @@
+require 'digest/md5'
+require "net/http"
+require 'mime/types'
+require 'cgi'
+require 'thread'
+
+require File.join(File.dirname(__FILE__), 'errors.rb')
+require File.join(File.dirname(__FILE__), 'image.rb')
+require File.join(File.dirname(__FILE__), 'response.rb')
+require File.join(File.dirname(__FILE__), 'gallery.rb')
+
+module ImageBam
+  POST_URL    = URI.parse('http://www.imagebam.com/services/upload/')
+  GALLERY_URL = URI.parse('http://www.imagebam.com/services/generate_GID/')
+end

data/lib/response.rb

@@ -0,0 +1,55 @@
+require 'rexml/document'
+
+module ImageBam
+  class Response
+    include REXML
+    attr_accessor :response
+    # What the response XML may look like for uploading images..
+
+    # <?xml version="1.0" encoding="utf-8" ?>
+    # <rsp stat="fail">
+    #   <err code="3" msg="API_key_user has an invalid format." />
+    # </rsp>
+
+    # <?xml version="1.0" encoding="utf-8" ?>
+    # <rsp stat="ok">
+    #         <ID>12404256</ID>
+    #         <URL>http://www.imagebam.com/image/b932b912404256</URL>
+    #         <thumbnail>http://thumbnails6.imagebam.com/1241/b932b912404256.gif</thumbnail>
+    #         <delcode>http://www.imagebam.com/remove/12404256/981f4bc82a730a7005319e8952c17a36</delcode>
+    # </rsp>      
+    
+    # For generating a gallery ID ..
+
+    # <?xml version="1.0" encoding="utf-8" ?>
+    # <rsp stat="ok">
+    #   <GID>5ee0886642b07d5ac912bc131e038532</GID>
+    #   <URL>http://www.imagebam.com/gallery/5ee0886642b07d5ac912bc131e038532/</URL>
+    # </rsp>    
+    
+    
+    def initialize(xml,type)
+      @doc = Document.new(xml)
+      @response = {}
+      @response[:status] = @doc.root.attributes['stat']
+      if( @response[:status] == 'fail')
+        
+        @response[:error] = {:code => @doc.root.get_elements('err').first.attributes['code'], 
+          :message => @doc.root.get_elements('err').first.attributes['msg']}
+          
+        raise ImageBam::Errors::ResponseError, @response[:error][:message]
+      else        
+        case type
+          when 'image':
+            @response[:id]      = @doc.root.get_elements('ID').first.get_text
+            @response[:url]     = @doc.root.get_elements('URL').first.get_text
+            @response[:thumbnail] = @doc.root.get_elements('thumbnail').first.get_text
+            @response[:delcode] = @doc.root.get_elements('delcode').first.get_text          
+          when 'gallery':
+            @response[:gid]      = @doc.root.get_elements('GID').first.get_text
+            @response[:url]     = @doc.root.get_elements('URL').first.get_text
+        end
+      end      
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: jamescook-ruby-imagebam
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- James Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-03 00:00:00 -07: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: 0.0.0
+    version: 
+description: ruby-imagebam interfaces with the ImageBam API to easily upload your images to ImageBam's image hosting service.
+email: none@google.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- demo.rb
+- image_bam.rb
+- lib/errors.rb
+- lib/image_bam.rb
+- lib/response.rb
+- lib/image.rb
+- lib/gallery.rb
+has_rdoc: false
+homepage: http://github.com/jamescook/ruby-imagebam/tree/master
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Simple interface to the ImageBam API
+test_files: 
+- test/test.rb