mediaplug2-ruby 0.0.2

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 2007-07-23
+
+* Initial checkin, API is fully functional

data/MIT-LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Intridea, Inc (http://www.intridea.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.rdoc

@@ -0,0 +1,11 @@
+= MediaPlug-Ruby
+
+MediaPlug-Ruby is a Ruby wrapper for the MediaPlug (http://gomediaplug.com) 
+REST API. It provides a simple, chainable API syntax for the construction 
+of MediaPlug URLs.
+
+== Example
+
+  mp = MediaPlug.new("mp.yourserver.com")
+  mp.image('http://some.url', :jpg).resize('>100x>100').crop('100x100').to_s
+  # => http://mp.yourserver.com/mp/get?mpsrc=http%3A%2F%2Fsome.url&mpaction=resize%20width%3D%3E100%20height%3D%3E100%20format%3Djpg%3Bcrop%20location%3Dcenter%20width%3D100%20height%3D100%20format%3Djpg

data/lib/mediaplug/mediaplug.rb

@@ -0,0 +1,24 @@
+class MediaPlug
+  class InvalidAction < StandardError; end
+  attr_accessor :server
+  
+  # Server is the domain of the MediaPlug server, e.g. "mp.yourdomain.com"
+  def initialize(server)
+    self.server = server
+  end
+  
+  # Generates an image-formatted MediaPlugURL from the specified URL
+  def image(url, format='jpg')
+    MediaPlugURL.new(server,:image,url,format)
+  end
+
+  # Generates a video-formatted MediaPlugURL from the specified URL  
+  def video(url, format='flv')
+    MediaPlugURL.new(server,:video,url,format)
+  end
+  
+  # Generates an audio-formatted MediaPlugURL from the specified URL  
+  def audio(url, format='mp3')
+    MediaPlugURL.new(server,:audio,url,format)
+  end
+end

data/lib/mediaplug/mediaplug_url.rb

@@ -0,0 +1,372 @@
+# The MediaPlugURL is a class that allows you to chain
+# together MediaPlug actions and then get the resulting URL
+# by using its to_s method. It should be instantiated through
+# the MediaPlug class, not by itself:
+class MediaPlugURL
+  def initialize(server, media_type, url, format)
+    @server = server
+    @media_type = media_type
+    @url = url
+    @format = format
+    @actions = []
+  end
+  
+  # <b>Image Only:</b> Resize an image to the dimensions specified. The
+  # dimensions may be specified as a string, a Hash, or an Array.
+  #
+  # Example:
+  #
+  #   image = mp.image('http://some.url/', :png)
+  #   image.resize('100x100')
+  #   image.resize(:width => 100, :height => 100)
+  #   image.resize([100,100])
+  #   # resize width to 128, height proportionally
+  #   image.resize(:width => 128)
+  #   
+  #   # halve the image size
+  #   image.resize(["50%","50%"])
+  def resize(string_or_hash_or_array)
+    argument = string_or_hash_or_array
+    raise MediaPlug::InvalidAction, "Only images may be resized." unless image?
+    action = "resize "
+    
+    case argument
+    when String, Array
+      argument = argument.split("x") if argument.is_a?(String)
+      action << "width=#{argument[0]} height=#{argument[1]}"
+    when Hash
+      argument.keys.each{ |k| argument[k.to_s] = argument[k] }
+      action << "#{"width=#{argument["width"]}" if argument["width"]}#{" height=#{argument["height"]}" if argument["height"]}"
+    end
+    
+    action << " format=#{@format}"
+    
+    @actions << action
+    self
+  end
+  
+  # <b>Image Only:</b> Crop an image based on the input provided. Since
+  # MediaPlug can crop according to gravity setting, default is center.
+  # the arguments you
+  # provide will determine which kind of cropping is employed.
+  #
+  # Cropping:
+  #
+  #   image = mp.image('http://some.url/', :png)
+  #   image.crop('100x100')
+  #   image.crop(:width => 100, :height => 100)
+  #   image.crop([100,100])
+
+  # Options:
+  #
+  # - <tt>:gravity</tt>: The position of crop. May be any of NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast. Default is center.
+  # - <tt>:x-offset</tt>: x coordinate offset of the top-left corner related to center position set by the gravity parameter. 
+  # - <tt>:y-offset</tt>: y coordinate offset of the top-left corner related to center position set by the gravity parameter. 
+  #  
+  #
+  def crop(string_or_hash_or_array)
+    argument = string_or_hash_or_array
+    raise MediaPlug::InvalidAction, "Only images may be cropped." unless image?
+    action = "crop "
+    
+    case argument
+    when String, Array
+      argument = argument.split("x") if argument.is_a?(String)
+      action << "gravity=center width=#{argument[0]} height=#{argument[1]}"
+    when Hash
+      argument.keys.each{|k| argument[k.to_s] = argument.delete(k)}
+      action << "gravity=#{argument['gravity']} " if argument['gravity']
+      action << "x-offset=#{argument['x-offset']} " if argument['x-offset']
+      action << "y-offset=#{argument['y-offset']} " if argument['y-offset']
+      if argument["width"] && argument["height"]
+        action << " width=#{argument["width"]} height=#{argument["height"]}"
+      else
+        raise MediaPlug::InvalidAction, "Could not understand the options given to the crop command."
+      end
+    end
+    
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end
+  
+  # <b>Image Only:</b> Rotate the image by the given number of degrees.
+  #
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.rotate(90)
+  def rotate(degree)
+    raise MediaPlug::InvalidAction, "Only images may be rotated." unless image?
+    argument = degree
+    action = "rotate "
+    
+    case argument
+    when String, Integer
+      action << "degree=#{argument}"
+    when Hash
+      action << action_hash_to_string(argument)
+    end
+    
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end
+  
+  FLIP_MAP = {"vertical" => "v",
+   "horizontal" => "h",
+   "both" => "b"}
+  
+  # <b>Image Only:</b> Flip the image in the given direction.
+  # 
+  # Valid Directions:
+  # 
+  # - +:horizontal+ or +:h+
+  # - +:vertical+ or +:v+
+  # - +:both+ or +:b+
+  #
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.flip(:both)
+  def flip(direction)
+    raise MediaPlug::InvalidAction, "Only images may be flipped." unless image?
+    argument = direction
+    argument = FLIP_MAP[argument.to_s] if FLIP_MAP.key?(argument.to_s)
+    "flip #{argument} format=#{@format}"
+  end
+  # <b>Image Only:</b> Create SWIRLING effect on the image by the given number of amplitude and wavelength.
+  #
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.swirl(180) #create a swirling effect with degree = 180
+  def swirl(degree)
+    raise MediaPlug::InvalidAction, "Only images may be swirled." unless image?
+    action = "swirl "    
+    action << "degree=#{degree}"
+    
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end   
+  # <b>Image Only:</b> Create Polaroid Frame for the image.
+  #
+  # Options:
+  #
+  # - <tt>:angle</tt>: The tilting angle of the Polaroid Frame . 
+  # - <tt>:caption</tt>: Text annontation that to be added at the bottom of the Polaroid Frame.  
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.polaroid(:angle => '15', :caption => "Group Picture 3/15/2011")
+  def polaroid(options={})
+    raise MediaPlug::InvalidAction, "Only images may be swirled." unless image?
+    action = "polaroid "    
+
+    action << "angle=#{options[:angle]} " if options[:angle]
+    action << "caption=#{options[:caption]} " if options[:caption]
+    
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end     
+  # <b>Image Only:</b> Create Water Reflection Effect for the image.
+  
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.water_reflection()
+  def water_reflection
+    raise MediaPlug::InvalidAction, "Only images may be swirled." unless image?
+    action = "water_reflection "    
+
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end   
+  # <b>Image Only:</b> Apply Art-Like Filter to the image.
+  # Valid Filter Type:
+  #  Vignette, OilPainting, Charcoal, Sketch, Emboss
+  # Options:
+  #
+  # - <tt>:level</tt>: The filter mask size, maybe low, medium, high. 
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.filter('vignette')
+  def filter(filter_type, options={})
+    raise MediaPlug::InvalidAction, "Only images may be swirled." unless image?
+    action = "filter "  
+    action << "filter_type=#{filter_type} "      
+    action << "level=#{options[:level]} " if options[:level]
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end     
+  # <b>Image Only:</b> Create WAVE effect on the image by the given number of amplitude and wavelength.
+  #
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.wave(50,200) #create a wave effect with amplitude = 50 and wavelength = 200
+  def wave(amp, wl)
+    raise MediaPlug::InvalidAction, "Only images may be waved." unless image?
+    action = "wave "    
+    action << "amplitude=#{amp} wavelength=#{wl}"
+    
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end 
+  # <b>Image Only:</b> Create IMPLODE or EXPLODE effect on the image by the given number of factor.
+  #
+  # Valid impode factor: [-1..1]
+  # nagtive value: expolode effect, positive value: implode effect
+  # Example:
+  #
+  #   image = mp.image('http://some.url/')
+  #   image.implode(1) 
+  def implode(factor)
+    raise MediaPlug::InvalidAction, "Only images may be imploded." unless image?
+    action = "implode "    
+    action << "factor=#{factor}"
+    
+    action << " format=#{@format}"
+    @actions << action
+    self
+  end 
+  # <b>Image Only:</b> Watermark an image with text or with another image.
+  # The +watermark_type+ may be +:image+ or +:text+.
+  # 
+  # Options:
+  #
+  # - <tt>:gravity</tt>: The position of the watermark. May be any of NorthWest, North, NorthEast, West, Center, East, SouthWest, South, SouthEast. Default is center.
+  # - <tt>:alpha</tt>: value from 0.0 to 1.0 indicating the opacity of the watermark. Default is 0.6.
+  # 
+  # Text-Only Options
+  #
+  # - <tt>:weight</tt>: the weight of the text font, maybe All,Bold,Bolder,Lighter,Normal. Default is Normal.
+  # - <tt>:style</tt>: The style of the text font, maybe Any, Italic, Normal, Oblique
+  # - <tt>:font_size</tt>: Integer, pixel size of the font to use on the watermark.
+  def watermark(watermark_type, text_or_url, options = {})
+    raise MediaPlug::InvalidAction, "Only images may be watermarked." unless image?
+    action = "watermark "
+    
+    case watermark_type
+    when :image
+      action << "url=#{text_or_url} "
+    when :text
+      action << "text=#{text_or_url.gsub(' ',"\\ ")} "
+      action << "style=#{options[:style]} " if options[:style]
+      action << "weight=#{options[:weight]} " if options[:weight]
+      action << "text-font-size=#{options[:font_size]} " if options[:font_size]
+    else
+      raise MediaPlug::InvalidAction, "The watermark_type must be :image or :text"
+    end
+    
+    action << "gravity=#{options[:gravity]} " if options[:gravity]
+    action << "alpha=#{options[:alpha]} " if options[:alpha]
+    action << "format=#{@format}"
+    
+    @actions << action
+    self
+  end
+  
+  # Converts the source into the specified format, with the options provided
+  # (options vary based on media type).
+  #
+  # Allowable Formats:
+  #
+  # - <b>Video:</b> flv, ipod, psp, 3gpp
+  # - <b>Audio:</b> mp3
+  # - <b>Image:</b> jpg, png, gif
+  #
+  # Video Conversion Options:
+  #
+  # - <tt>:bitrate</tt>: The bitrate in which to encode (e.g. "200k")
+  # - <tt>:width</tt>: The width of encoded video
+  # - <tt>:height</tt>: The height of encoded video
+  #
+  # Audio Conversion Options:
+  #
+  # - <tt>:bitrate</tt>: The bitrate in which to encode (e.g. "64k")
+  # - <tt>:samplerate</tt>: The sample rate with which to encode (e.g. 128)
+  def convert(new_format, options = {})
+  	if image?
+  		action = "rotate 0 format=#{new_format}"
+  	elsif audio?
+	    action = "audio_convert format=#{new_format}"
+	    action << " bitrate=#{options[:bitrate]}" if options[:bitrate]
+	    action << " samplerate=#{options[:samplerate]}" if options[:samplerate]
+  	elsif video?
+	    action = "video_convert format=#{new_format}"
+	    action << " bitrate=#{options[:bitrate]}" if options[:bitrate]
+	    action << " width=#{options[:width]}" if options[:width]
+	    action << " height=#{options[:height]}" if options[:height]
+  	end
+    @actions << action
+    self
+  end
+  
+  # <b>Video Only:</b> Generates a thumbnail of a video at the specified frame.
+  # Video Thumbnail Options:
+  #
+  # - <tt>:width</tt>: The width of thumbnail image
+  # - <tt>:height</tt>: The height of thumbnail image
+  def thumbnail(seek, options={})
+    raise MediaPlug::InvalidAction, "Only videos may be thumbnailed." unless video?
+    action = "thumbnail seek=#{seek}"
+    action << " width=#{options[:width]}" if options[:width]
+    action << " height=#{options[:height]}" if options[:height]
+    @media_type = :image
+    @actions << action
+    self
+  end
+
+  # <b>Video Only:</b> Generates an animated GIF image for video preview.
+  # Video Preview Options:
+  #
+  # Framestep is duration in seconds of per frame capture 
+  # - <tt>:width</tt>: The width of thumbnail image
+  # - <tt>:height</tt>: The height of thumbnail image
+  def preview(framestep, options={})
+    raise MediaPlug::InvalidAction, "Only videos may be previewed." unless video?
+    action = "preview framestep=#{framestep}"
+    action << " width=#{options[:width]}" if options[:width]
+    action << " height=#{options[:height]}" if options[:height]
+    @media_type = :image
+    @actions << action
+    self
+  end  
+  # Causes the resultant URL to be recached. Should not be called
+  # each time.
+  def recache!
+    @actions.unshift("recache")
+    self
+  end
+  
+  # Generate a URL to retrieve the metadata about a file instead of the
+  # file itself.
+  def metadata!
+    @metadata = true
+    self
+  end
+  
+  # Outputs the final URL taking into account all of the actions that
+  # have been chained onto this MediaPlugURL
+  def to_s
+    url = "http://#{@server}/mp/get?mpsrc=#{URI.escape(@url, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}#{"&mpaction=#{URI.escape(@actions.join(","), Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}" if @actions.any?}"
+    if @metadata
+      "http://#{@server}/mp/metadata?mpsrc=#{url}"
+    else
+      url
+    end
+  end
+  
+  protected
+  
+  def image?; @media_type == :image end
+  def video?; @media_type == :video end
+  def audio?; @media_type == :audio end
+end

data/lib/mediaplug-ruby.rb

@@ -0,0 +1,2 @@
+require 'mediaplug/mediaplug_url'
+require 'mediaplug/mediaplug'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: mediaplug2-ruby
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael Bleigh
+- Ping Yu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-23 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A wrapper for the MediaPlug 2 API to give a simple syntax for MediaPlug URL generation.
+email: ping@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- MIT-LICENSE.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- MIT-LICENSE.rdoc
+- README.rdoc
+- lib/mediaplug/mediaplug.rb
+- lib/mediaplug/mediaplug_url.rb
+- lib/mediaplug-ruby.rb
+has_rdoc: true
+homepage: http://github.com/intridea/mediaplug2-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A wrapper for the MediaPlug 2 API to give a simple syntax for MediaPlug URL generation.
+test_files: []
+