img_gravatar 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Till Salzer
+
+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/Manifest

@@ -0,0 +1,12 @@
+img_gravatar.gemspec
+init.rb
+install.rb
+lib/img_gravatar.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README.rdoc
+tasks/img_gravatar_tasks.rake
+test/img_gravatar_test.rb
+test/module_gravatar_test.rb
+uninstall.rb

data/README.rdoc

@@ -0,0 +1,75 @@
+= Image Gravatar
+
+A simple plugin adding the +img_gravatar+ image link helper to ActionViews.
+
+== Install
+
+  gem install tsalzer-img_gravatar --source http://gems.github.com
+
+
+== What is a Gravatar?
+
+A gravatar is a globally recognized avatar. It is an image hosted on the site
+http://site.gravatar.com, uploaded by the user and referred to on base of
+an eMail address. News on gravatar can be found at http://blog.gravatar.com.
+
+Each gravatar image can be rated with respect to its content being suiteable to
+audience.
+
+== Usage
+
+To use a gravatar on your system, your view needs the eMail address of the
+individual to be displayed. The most simple case is like this:
+
+  <p>
+    <%= img_gravatar('me@email.com') %> That's me.
+  </p>
+
+This will render the image of the person known under the eMail me@email.com
+in your browser. If there is no person known with this name, it will render
+the Gravatar logo.
+
+A more complex szenario would include a size definition, and an alt image tag:
+
+  <p>
+    <%= img_gravetar('me@email.com', { :size => 40, :alt => "That's me." }) %>
+  </p>
+
+This would render a downsized image of 40x40 with the alt-tag "That's me.".
+
+For a complete description of available parameters see
+Gravatar::InstanceMethods#gravatar in the Gravatar::InstanceMethods.
+
+=== Configuration Options
+
+You can modify the following aspects of the displayed gravatar image:
+ * :alt          - the alternative text for this image
+ * :default_url  - the default URL for this gravatar
+ * :size         - the requested gravatar size
+ * :rating       - the requested maximum rating
+
+== Building a new Gem
+
+To create a new gem, you need to install the echoe gem (see
+http://blog.evanweaver.com/files/doc/fauna/echoe/files/README.html).
+Next, edit the Rakefile to reflect your changes, then run:
+
+  rake clobber        # remove generated stuff for a clean manifest
+  rake manifest       # only needed if you changed the file set
+  rake build_gemspec  # update the gemspec
+
+Now, you can either publish the gem, or build a gem package. See rake -T for
+available targets.
+
+== License
+
+The img_gravatar gem comes to you under the MIT License. You should find the
+license text in the file MIT-LICENSE in the gem folder.
+
+The img_gravatar gem is not affiliated with the Gravatar service. Usage terms
+of the Gravatar service should be looked up at http://gravatar.com.
+
+Please note that changes to the Gravatar API or their terms of service or the
+cease of Gravatar service may result in breaking the img_gravatar gem
+functionality. This is considered out of the responsibility of the author of
+the img_gravatar gem.

data/Rakefile

@@ -0,0 +1,16 @@
+# Rakefile for img_gravatar
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('img_gravatar', '0.1.1') do |p|
+  p.description = "Add a img_gravatar helper to ActiveView."
+  p.url = "http://github.com/tsalzer/img_gravatar"
+  p.author = "Till Salzer"
+  p.email = "till.salzer@googlemail.com"
+  p.ignore_pattern = ["tmp/*", "script/*", "rdoc/*", "pkg/*", "gravatar.tmproj"]
+  p.development_dependencies = []
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^README.rdoc|^CHANGELOG|^TODO|^MIT-LICENSE|^COPYING$/
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/img_gravatar.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{img_gravatar}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Till Salzer"]
+  s.date = %q{2009-02-18}
+  s.description = %q{Add a img_gravatar helper to ActiveView.}
+  s.email = %q{till.salzer@googlemail.com}
+  s.extra_rdoc_files = ["lib/img_gravatar.rb", "MIT-LICENSE", "README.rdoc", "tasks/img_gravatar_tasks.rake"]
+  s.files = ["img_gravatar.gemspec", "init.rb", "install.rb", "lib/img_gravatar.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.rdoc", "tasks/img_gravatar_tasks.rake", "test/img_gravatar_test.rb", "test/module_gravatar_test.rb", "uninstall.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/tsalzer/img_gravatar}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Img_gravatar", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{img_gravatar}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Add a img_gravatar helper to ActiveView.}
+  s.test_files = ["test/img_gravatar_test.rb", "test/module_gravatar_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+
+require 'gravatar'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/img_gravatar.rb

@@ -0,0 +1,126 @@
+require 'md5'
+require 'uri'
+require 'action_view'
+
+# = Gravatar
+# 
+# Adds the +gravatar+ method to ActionViews.
+#
+# $Id$
+module ImgGravatar #:nodoc:
+  mattr_reader :gravatar_host
+  @@gravatar_host = 'www.gravatar.com'
+  # gravatar.com base URL.
+  # This is +http://www.gravatar.com/avatar/+.
+  mattr_reader :gravatar_base_url
+  @@gravatar_base_url = "http://#{@@gravatar_host}/avatar"
+  
+  # default image URL. Default is +/img/no_gravatar.png+.
+  mattr_accessor :default_img_url
+  @@default_img_url = '/img/no_gravatar.png'
+  
+  mattr_reader :minimum_size
+  @@minimum_size = 1
+  mattr_reader :maximum_size
+  @@maximum_size = 512
+  
+  # Default size of the image in pixel. Default is +80+.
+  mattr_accessor :default_size
+  @@default_size = 80
+  
+  # default rating.
+  # Valid values are +g+, +r+, +x+, default is +g+.
+  mattr_accessor :default_rating
+  @@default_rating = 'g'
+  
+  ############################################################################
+  # get the Gravatar image.
+  # options:
+  #   :alt          - the alternative text for this image
+  #   :default_url  - the default URL for this gravatar
+  #   :size         - the requested gravatar size
+  #   :rating       - the requested maximum rating
+  def self.link_gravatar(email, opts={})
+    # the defaults
+    alt = nil
+    alt = opts[:alt] if opts[:alt]
+    
+    if alt then
+      "<img src=\"%s\" alt=\"%s\" />" % [image_url(email, opts), alt]
+    else
+      "<img src=\"%s\" />" % image_url(email, opts)
+    end
+  end
+  
+  ############################################################################
+  # get the default Gravatar image.
+  # options:
+  #   :default_url  - the default URL for this gravatar
+  #   :size         - the requested gravatar size
+  #   :rating       - the requested maximum rating
+  def self.image_url(email, opts={})
+    appender = '?'
+    
+    # now, load infos from options
+    default_img_url = check_default_opt(opts[:default_url])
+    size = check_size_opt(opts[:size] )
+    rating = check_rating_opt(opts[:rating])
+    
+    query = nil
+    query = "s=%s" % size if size
+    query = query ? "%s&r=%s" % [query, rating] : "r=%s" % rating if rating
+    query = query ? "%s&d=%s" % [query, default_img_url] : "d=%s" % default_img_url if default_img_url
+    
+    query = URI.escape(query) if query
+    
+    #uri = URI::HTTP.new(Gravatar.gravatar_base_url)
+    uri = URI::HTTP.build(:host => ImgGravatar.gravatar_host,
+      :path => "/avatar/%s" % MD5.md5(email.downcase.strip),
+      :query => query)
+  end
+  
+  # Methods injected in all ActionView classes.
+  module Base #:nodoc:
+    def self.included(mod) #:nodoc:
+      mod.extend(ClassMethods)
+    end
+  end
+  
+  # Methods injected in all ActionView classes.
+  module ClassMethods #:nodoc:
+    def self.extended(mod) #:nodoc#
+      class_eval do
+        include Gravatar::InstanceMethods
+      end
+    end
+  end
+  
+  module InstanceMethods
+    ############################################################################
+    # get the Gravatar image.
+    # See ImgGravatar.link_gravatar for options.
+    def img_gravatar(email, opts={})
+      return ::ImgGravatar.link_gravatar(email, opts)
+    end
+  end
+
+  private
+  
+  def self.check_size_opt(size)
+    return size if size and size >= ImgGravatar.minimum_size and size <= ImgGravatar.maximum_size
+  end
+  
+  def self.check_rating_opt(rating)
+    return rating if rating and ['g', 'r', 'x'].include?(rating)
+  end
+  
+  def self.check_default_opt(dflt)
+    return dflt if dflt
+  end
+
+end
+
+# inject into ActionView.
+ActionView::Base.send :include, ImgGravatar::InstanceMethods
+
+

data/tasks/img_gravatar_tasks.rake

@@ -0,0 +1,29 @@
+# desc "Explaining what the task does"
+# task :gravatar do
+#   # Task goes here
+# end
+
+=begin
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the gravatar plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the gravatar plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Image Gravatar'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+=end

data/test/img_gravatar_test.rb

@@ -0,0 +1,88 @@
+# Unit tests for ImgGravatar
+require 'test/unit'
+require 'img_gravatar'
+
+class TestView < ActionView::Base
+end
+
+class ImgGravatarTest < Test::Unit::TestCase
+  @@gravatar_host = "www.gravatar.com"
+  @@base_url = "http://#{@@gravatar_host}/avatar"
+  @@ref_mail = "iHaveAn@email.com"
+  @@ref_hash = "3b3be63a4c2a439b013787725dfce802"
+  
+    
+  def test_actionview_integration
+    myview = TestView.new
+    assert myview.respond_to?('img_gravatar'), "integration into ActionView failed"
+  end
+  
+  def test_reference_data
+    myview = TestView.new
+    # the reference data from http://en.gravatar.com/site/implement/url
+    link_url = myview.img_gravatar(@@ref_mail)
+    assert_match(/^<img src="#{@@base_url}\/#{@@ref_hash}\" \/>/, link_url)
+    #assert_match(/^<img src="http:\/\/www\.gravatar\.com\/avatar\/#{ref_hash}\" \/>/, link_url)
+  end
+  
+  def test_actionview_url
+    myview = TestView.new
+    link_url = myview.img_gravatar(@@ref_mail)
+    assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
+  end
+  
+  def test_defaults
+    myview = TestView.new
+    link_url = myview.img_gravatar(@@ref_mail)
+    assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
+  end
+  
+  def test_actionview_ratings
+    myview = TestView.new
+    ['g', 'r', 'x'].each do |rating|
+      link_url = myview.img_gravatar(@@ref_mail, {:rating => rating})
+      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?r=#{rating}\" \/>/, link_url)
+    end
+  end
+  
+  def test_actionview_size
+    myview = TestView.new
+    (1..512).each do |size|
+      link_url = myview.img_gravatar(@@ref_mail, {:size => size})
+      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?s=#{size}\" \/>/, link_url)
+    end
+  end
+  
+  def test_illegal_small_sizes
+    myview = TestView.new
+    (-10..0).each do |size|
+      link_url = myview.img_gravatar(@@ref_mail, {:size => size})
+      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
+    end
+  end
+  
+  def test_illegal_large_sizes
+    myview = TestView.new
+    (513..10000).each do |size|
+      link_url = myview.img_gravatar(@@ref_mail, {:size => size})
+      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\" \/>/, link_url)
+    end
+  end
+  
+  def test_default_image_encoding
+    myview = TestView.new
+    unencoded = "http://example.com/images/example.jpg"
+    encoded = 'http%3A%2F%2Fexample.com%2Fimages%2Fexample.jpg'
+    link_url = myview.img_gravatar(@@ref_mail, {:default_url => unencoded})
+    assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?d=#{encoded}\" \/>/, link_url)
+  end
+  
+  def test_default_image_specials
+    myview = TestView.new
+    ['identicon', 'monsterid', 'wavatar'].each do |dflt|
+      link_url = myview.img_gravatar(@@ref_mail, {:default_url => dflt})
+      assert_match(/^<img src="#{@@base_url}\/[a-z0-9]{32}\?d=#{dflt}\" \/>/, link_url)
+    end
+  end
+  
+end

data/test/module_gravatar_test.rb

@@ -0,0 +1,22 @@
+# Unit tests for ImgGravatar
+require 'test/unit'
+require 'img_gravatar'
+
+class ModuleGravatarTest < Test::Unit::TestCase
+  @@gravatar_host = "www.gravatar.com"
+  @@base_url = "http://#{@@gravatar_host}/avatar"
+  @@ref_mail = "iHaveAn@email.com"
+  @@ref_hash = "3b3be63a4c2a439b013787725dfce802"
+  
+  def test_module_functions
+    assert(ImgGravatar.respond_to?('image_url'), 'Module ImgGravatar does not respond to image_url')
+    assert(ImgGravatar.respond_to?('link_gravatar'), 'Module ImgGravatar does not respond to link_grevatar')
+  end
+  
+  def test_reference_data
+    # the reference data from http://en.gravatar.com/site/implement/url
+    link_url = ImgGravatar.link_gravatar(@@ref_mail)
+    assert_match(/^<img src="#{@@base_url}\/#{@@ref_hash}\" \/>/, link_url)
+    #assert_match(/^<img src="http:\/\/www\.gravatar\.com\/avatar\/#{ref_hash}\" \/>/, link_url)
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: img_gravatar
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Till Salzer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-18 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Add a img_gravatar helper to ActiveView.
+email: till.salzer@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/img_gravatar.rb
+- MIT-LICENSE
+- README.rdoc
+- tasks/img_gravatar_tasks.rake
+files: 
+- img_gravatar.gemspec
+- init.rb
+- install.rb
+- lib/img_gravatar.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- tasks/img_gravatar_tasks.rake
+- test/img_gravatar_test.rb
+- test/module_gravatar_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/tsalzer/img_gravatar
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Img_gravatar
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: img_gravatar
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 2
+summary: Add a img_gravatar helper to ActiveView.
+test_files: 
+- test/img_gravatar_test.rb
+- test/module_gravatar_test.rb