gravtastic 1.5.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Chris Lloyd
+
+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.textile

@@ -0,0 +1,90 @@
+Easily add "Gravatars":http://gravatar.com to your Ruby objects.
+
+
+h2. Install
+
+  sudo gem install chrislloyd-gravtastic --source=http://gems.github.com
+
+
+h2. Usage
+
+Somewhere in your application you need to @require 'gravtastic'@. In Rails >= 2.1 you can forego this and just add a dependency gem dependency for Gravtastic.
+
+    config.gem 'gravtastic', :source => 'http://gems.github.com/'
+
+The next step is to give your model a Gravatar:
+
+  class User
+    has_gravatar
+  end
+
+If you are using a standard Ruby class or Datamapper resource you have to add the line @include Gravtastic::Model@ before @has_gravatar@.
+  
+This defaults to looking for the gravatar ID on the @email@ method. So, if your @User@ has an @email@ then it will send that to Gravatar to get their picture. You can change the default gravatar source like this:
+
+  has_gravatar :on => :author_email
+
+Now, you can access your object's gravatar with the @gravatar_url@ method:
+
+  current_user.gravatar_url
+  => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
+
+Note that it defaults to a PG rating. You can specify extra options with a hash:
+
+  current_user.gravatar_url(:rating => 'R18', :size => 512)
+  => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG&s=512"
+  
+  current_user.gravatar_url(:secure => true)
+  => "https://secure.gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
+
+PS.  Bonus points for anybody who can tell me what that users email is!
+PPS. Shame on Automattic for still using MD5!
+
+
+h2. The Future
+
+* "Datamapper":http://datamaper.org support
+
+
+h2. Authors
+
+* "Chris Lloyd":http://chrislloyd.com.au
+* You
+
+
+h2. Contribute
+
+You can checkout the source or fork it yourself from Github.
+
+  git clone git://github.com/chrislloyd/gravtastic.git
+
+If you submit a successful patch then you'll be given full commit rights to the project.
+
+
+h2. Thanks
+
+* "Xavier Shay":http://rhnh.net and others for "Enki":http://enkiblog.com (the reason this was written)
+
+
+h2. License
+
+Copyright (c) 2008 Chris Lloyd.
+
+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/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'spec/rake/spectask'
+require 'date'
+
+GEM = "gravtastic"
+GEM_VERSION = "1.5.2"
+AUTHOR = "Chris Lloyd"
+EMAIL = "christopher.lloyd@gmail.com"
+HOMEPAGE = "http://github.com/chrislloyd/gravtastic"
+SUMMARY = "Easily add Gravatars to your Ruby objects."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.rubyforge_project = GEM
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.textile', 'LICENSE']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  
+  # Uncomment this to add a dependency
+  # s.add_dependency "foo"
+  
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.textile Rakefile) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :default => :spec
+task :specs => :spec
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ['--options','spec/spec.opts']
+  t.spec_files = FileList['spec/**/*.rb']
+  t.rcov = true
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+task :bugs do
+  sh %{ditz html ; open html/index.html}
+end

data/lib/gravtastic.rb

@@ -0,0 +1,137 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'digest/md5'
+require 'cgi'
+
+# = Gravtastic - Easily add Gravatars to your Ruby objects.
+# 
+# Copyright (C) 2008 mailto:christopher.lloyd@gmail.com
+# 
+# == Example
+# 
+# Somewhere in your application you need to <tt>require 'gravtastic'</tt>. In Rails >= 2.1 you can forego this and just add a dependency gem dependency for Gravtastic.
+# 
+#     config.gem 'gravtastic', :source => 'http://gems.github.com/'
+# 
+# The next step is to give your model a Gravatar:
+# 
+#   class User
+#     has_gravatar
+#   end
+# 
+# If you are using a standard Ruby class or Datamapper resource you have to add the line <tt>include Gravtastic::Model</tt> before <tt>has_gravatar</tt>.
+# 
+# This defaults to looking for the gravatar ID on the <tt>email</tt> method. So, if your <tt>User</tt> has an <tt>email</tt> then it will send that to Gravatar to get their picture. You can change the default gravatar source like this:
+# 
+#   has_gravatar :on => :author_email
+# 
+# Now, you can access your object's gravatar with the <tt>gravatar_url</tt> method:
+# 
+#   current_user.gravatar_url
+#   => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
+# 
+# Note that it defaults to a PG rating. You can specify extra options with a hash:
+# 
+#   current_user.gravatar_url(:rating => 'R18', :size => 512)
+#   => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG&s=512"
+# 
+#   current_user.gravatar_url(:secure => true)
+#   => "https://secure.gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
+# 
+module Gravtastic
+  module Model
+
+    def self.included(base) # :nodoc:
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      
+      # 
+      # Sets the gravatar_source. Basically starts this whole shindig.
+      # 
+      # Examples:
+      # 
+      #   has_gravatar
+      # 
+      #   has_gravatar :on => :author_email
+      # 
+      def has_gravatar(options={:on => :email})
+        @gravatar_source = options[:on]
+      end
+
+      # 
+      # Returns a symbol of the instance method where the Gravatar is pulled from.
+      # 
+      # For example, if your users email is returned by the method <tt>#gobagaldy_gook</tt> then it
+      # will return the symbol <tt>:'gobagaldy_gook'</tt>.
+      # 
+      def gravatar_source
+        @gravatar_source
+      end
+
+      # 
+      # Returns <tt>true</tt> if the gravatar_source is set. <tt>false</tt> if not. Easy!
+      # 
+      def has_gravatar?
+        !!gravatar_source
+      end
+
+    end
+
+    # 
+    # The raw MD5 hash used by Gravatar, generated from the ClassMethods#gravatar_source.
+    # 
+    def gravatar_id
+      if self.class.gravatar_source && value = send(self.class.gravatar_source).downcase
+        @gravatar_id = Digest::MD5.hexdigest(value.to_s)
+      end
+    end
+
+    # 
+    # Returns a string with the URL for the instance's Gravatar.
+    # 
+    # It defaults to <tt>:rating => 'PG'</tt>
+    # 
+    # Examples:
+    # 
+    #   current_user.gravatar_url
+    #   => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
+    # 
+    #   current_user.gravatar_url(:rating => 'R18', :size => 512, :default => 'http://example.com/images/example.jpg')
+    #   => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?d=http%3A%2F%2Fexample.com%2Fimages%2Fexample.jpg&r=R18&s=512"
+    # 
+    #   current_user.gravatar_url(:secure => true)
+    #   => "https://secure.gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
+    # 
+    def gravatar_url(options={})
+      options[:rating] ||= 'PG'
+      options[:secure] ||= false
+      if gravatar_id
+        @gravatar_url = 'http' + (options[:secure] ? 's://secure.' : '://') + 'gravatar.com/avatar/' + gravatar_id + '.png' + parse_url_options_hash(options)
+      end
+    end
+
+    private
+    
+    GRAVTASTIC_VALID_PARAMS = [:size, :rating, :default]
+    
+    def parse_url_options_hash(options)
+      
+      options.delete_if { |key,_| ![:size,:rating,:default].include?(key) }
+      
+      unless options.empty?
+        '?' + options.map do |pair|
+          pair[0] = pair[0].to_s[0,1] # Get the first character of the option
+          pair.map{|item| item = CGI::escape(item.to_s) }.join('=') # Join key & value together
+        end.sort.join('&') # Join options together
+      else
+        ''
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:include, Gravtastic::Model) if defined?(ActiveRecord) # :nodoc:

data/spec/gravtastic_spec.rb

@@ -0,0 +1,158 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Gravtastic::Model" do
+
+  before(:each) do
+    @user = mock('User')
+    @user.class.send(:include, Gravtastic::Model)
+    @klass = @user.class
+  end
+  
+  describe ".gravatar_source" do
+    
+    it "is nil if unset" do
+      @klass.gravatar_source.should be_nil
+    end
+  
+  end
+  
+  describe ".has_gravatar" do
+    
+    it "sets .gravatar_source to email by default" do
+      @klass.has_gravatar
+      @klass.gravatar_source.should == :email
+    end
+    
+    it "changes .gravatar_source" do
+      lambda {
+        @klass.has_gravatar :on => :other_method
+      }.should change(@klass, :gravatar_source)
+    end
+    
+    it "sets .gravatar_source to the value of :on" do
+      @klass.has_gravatar :on => :other_method
+      @klass.gravatar_source.should == :other_method
+    end
+    
+  end
+
+  describe ".has_gravatar?" do
+    
+    it "is true when .gravatar_source is not nil" do
+      @user.class.stub!(:gravatar_source).and_return(:email)
+      @user.class.should have_gravatar
+    end
+    
+    it "is false when .gravatar_soruce is not is nil" do
+      @user.class.stub!(:gravatar_source).and_return(nil)
+      @user.class.should_not have_gravatar
+    end
+    
+  end
+
+  describe "#gravatar_id" do
+
+    before(:each) do
+      @user.stub!(:email).and_return('joe@example.com')
+      @user.stub!(:name).and_return('Joe Bloggs')
+      @user.class.stub!(:gravatar_source).and_return(:email)
+    end
+    
+    it "is not nil when .gravatar_source is not nil" do
+      @user.gravatar_id.should_not be_nil
+    end
+    
+    it "is nil when .gravatar_source is nil" do
+      @user.class.stub!(:gravatar_source).and_return(nil)
+      @user.gravatar_id.should be_nil
+    end
+
+    it "changes when .gravatar_source is changed" do
+      lambda {
+        @user.class.stub!(:gravatar_source).and_return(:name)
+      }.should change(@user, :gravatar_id)
+    end
+
+    it "is a MD5 hash" do
+      @user.gravatar_id.should == 'f5b8fb60c6116331da07c65b96a8a1d1'
+    end
+    
+    it "downcases any imput" do
+      @user.stub!(:email).and_return('JOE@EXAMPLE.COM')
+      @user.gravatar_id.should == 'f5b8fb60c6116331da07c65b96a8a1d1'
+    end
+    
+  end
+  
+  describe "#gravatar_url" do
+    
+    before(:each) do
+      @user.stub!(:email).and_return('joe@example.com')
+      @user.stub!(:name).and_return('Joe Bloggs')
+      @user.class.stub!(:gravatar_source).and_return(:email)
+    end
+    
+    it "is not nil when .gravatar_source is not nil" do
+      @user.gravatar_url.should_not be_nil
+    end
+    
+    it "is nil when .gravatar_source is nil" do
+      @user.class.stub!(:gravatar_source).and_return(nil)
+      @user.gravatar_url.should be_nil
+    end
+    
+    it "always specifies a png resource type" do
+      @user.gravatar_url.should match(/.png/)
+    end
+    
+    it "returns a valid gravatar URL" do
+      @user.gravatar_url.should == valid_gravatar_url + '?r=PG'
+    end
+    
+    it "returns a valid SSL gravatar URL" do
+      @user.gravatar_url(:secure => true).should == 'https://secure.gravatar.com/avatar/f5b8fb60c6116331da07c65b96a8a1d1.png?r=PG'
+    end
+    
+    it "returns a url without the 'www'" do
+      @user.gravatar_url.should_not match(/www/)
+    end
+    
+    it "returns a valid gravatar URL even when invalid option is passed" do
+      @user.gravatar_url(:foo => :bar).should == valid_gravatar_url + '?r=PG'
+    end
+    
+    it "parses a size" do 
+      @user.gravatar_url(:size => 512).should == valid_gravatar_url + '?r=PG&s=512'
+    end
+    
+    it "parses a rating" do 
+      @user.gravatar_url(:rating => 'MA').should == valid_gravatar_url + '?r=MA'
+    end
+    
+    it "returns a valid gravatar URL when the rating option is unescaped" do
+      @user.gravatar_url(:rating => 'Unescaped String').should == valid_gravatar_url + '?r=Unescaped+String'
+    end
+    
+    it "parses a default image type" do 
+      @user.gravatar_url(:default => :identicon).should == valid_gravatar_url + '?d=identicon&r=PG'
+    end
+    
+    it "parses a default image URL" do 
+      @user.gravatar_url(:default => 'http://example.com/images/example.jpg').should == valid_gravatar_url + '?d=http%3A%2F%2Fexample.com%2Fimages%2Fexample.jpg&r=PG'
+    end
+    
+    it "parses multiple options" do
+      @user.gravatar_url(:size => 20, :rating => 'R18', :default => :monsterid).should == valid_gravatar_url + '?d=monsterid&r=R18&s=20'
+    end
+    
+    it "defaults to a 'PG' rating" do
+      @user.gravatar_url(:rating => 'PG').should == @user.gravatar_url
+    end
+    
+    def valid_gravatar_url # :nodoc:
+      'http://gravatar.com/avatar/f5b8fb60c6116331da07c65b96a8a1d1.png'
+    end
+    
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'gravtastic'

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: gravtastic
+version: !ruby/object:Gem::Version 
+  version: 1.5.2
+platform: ruby
+authors: 
+- Chris Lloyd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-15 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Easily add Gravatars to your Ruby objects.
+email: christopher.lloyd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- lib/gravtastic.rb
+- spec/gravtastic_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/chrislloyd/gravtastic
+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: gravtastic
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Easily add Gravatars to your Ruby objects.
+test_files: []
+