tsalzer-img_gravatar 0.0.1 → 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/README.rdoc

@@ -47,3 +47,29 @@ You can modify the following aspects of the displayed gravatar 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

@@ -3,13 +3,14 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('img_gravatar', '0.0.1') do |p|
+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

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{img_gravatar}
-  s.version = "0.0.1"
+  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-01-20}
+  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", "README.rdoc", "tasks/img_gravatar_tasks.rake"]
-  s.files = ["img_gravatar.gemspec", "init.rb", "install.rb", "lib/img_gravatar.rb", "Manifest", "Rakefile", "README.rdoc", "tasks/img_gravatar_tasks.rake", "test/img_gravatar_test.rb", "uninstall.rb"]
+  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"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   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"]
+  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

data/lib/img_gravatar.rb

@@ -33,6 +33,52 @@ module ImgGravatar #:nodoc:
   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:
@@ -51,70 +97,30 @@ module ImgGravatar #:nodoc:
   
   module InstanceMethods
     ############################################################################
-    # get the default 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
+    # get the Gravatar image.
+    # See ImgGravatar.link_gravatar for options.
     def img_gravatar(email, opts={})
-      # the defaults
-      alt = nil
-      appender = '?'
-      
-      # now, load infos from options
-      alt = opts[:alt] if opts[:alt]
-      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)
-
-      if alt then
-        "<img src=\"%s\" alt=\"%s\" />" % [uri, alt]
-      else
-        "<img src=\"%s\" />" % uri
-      end
-      
+      return ::ImgGravatar.link_gravatar(email, opts)
     end
+  end
 
-    
-    private
-    
-    def check_size_opt(size)
-      if size and size >= ImgGravatar.minimum_size and size <= ImgGravatar.maximum_size
-        return size
-      end
-    end
-    
-    def check_rating_opt(rating)
-      if rating and ['g', 'r', 'x'].include?(rating)
-        return rating
-      end
-    end
-    
-    def check_default_opt(dflt)
-      if dflt
-        return dflt
-      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.class_eval do
-#  include Gravatar::Base
-#end
 ActionView::Base.send :include, ImgGravatar::InstanceMethods
 
 

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tsalzer-img_gravatar
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Till Salzer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-20 00:00:00 -08:00
+date: 2009-02-18 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -21,6 +21,7 @@ extensions: []
 
 extra_rdoc_files: 
 - lib/img_gravatar.rb
+- MIT-LICENSE
 - README.rdoc
 - tasks/img_gravatar_tasks.rake
 files: 
@@ -29,10 +30,12 @@ files:
 - 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
@@ -67,3 +70,4 @@ specification_version: 2
 summary: Add a img_gravatar helper to ActiveView.
 test_files: 
 - test/img_gravatar_test.rb
+- test/module_gravatar_test.rb