gravtastic 2.1.0 → 2.1.1

data/README.md

@@ -0,0 +1,118 @@
+# Gravtastic
+
+<small>The super fantastic way of getting Gravatars. By [Chris](http://chrislloyd.com.au).</small>
+
+In less than 5 minutes you can add Gravatars to your Ruby project. It works in Rails, Merb _and_ plain ol' Ruby.
+
+The best way to learn more about Gravtastic is to [look at the source](http://github.com/chrislloyd/gravtastic/blob/master/lib/gravtastic.rb). It's one file, about 80 LOC and really pretty simple. If that isn't for you, then follow the instructions below!
+
+## Install
+
+    sudo gem install gravtastic
+
+## Usage
+
+Add this to your `environment.rb`:
+
+    config.gem 'gravtastic', :version => '>= 2.1.0'
+
+Next, say that you want a Gravatar for your model:
+
+    class User < ActiveRecord::Base
+      is_gravtastic!
+    end
+
+And you are done! In your views you can now use the `#gravatar_url` method:
+
+    <%= image_tag @user.gravatar_url %>
+
+If you want to change the image, you can do this:
+
+    <%= image_tag @user.gravatar_url(:rating => 'R', :secure => true) %>
+
+That will show R rated Gravatars over a secure connection. If you find yourself repeating that all around your app, you can set the Gravatar defaults. In your model, just change the `is_gravtastic!` line to something like this:
+
+    is_gravtastic :author_email, :secure => true,
+                                 :filetype => :gif,
+                                 :size => 120
+
+Now all your Gravatars will come from a secure connection, be a GIF and be 120x120px. The email will also come from the `author_email` field, not the default `email` field. Don't worry, you arn't locked into these defaults (you can override them by passing options to `#gravatar_url` like before).
+
+_Note: You can use either `is_gravtastic!` or `is_gravtastic`, they both do the same thing._
+
+### Plain Ruby
+
+So you just have a regular ol' Ruby app? No Rails and ActiveRecord?
+
+    require 'gravtastic'
+    class BoringUser
+      include Gravtastic
+      is_gravtastic!
+    end
+
+And wallah! That works exactly the same as in Rails! Now all instances of the BoringUser class will have `#gravatar_url` methods.
+
+_Note: the `#gravatar_url` methods don't get included until you specify the class `is_gravtastic!`_
+
+### Complete List of Options
+
+<table>
+  <tr>
+    <th>Option</th>
+    <th>Description</th>
+    <th>Default</th>
+    <th>Values<th>
+  </tr>
+  <tr>
+    <td><b>secure</b></td>
+    <td>Gravatar transmitted with SSL</td>
+    <td>false</td>
+    <td>true/false</td>
+  </tr>
+  <tr>
+    <td><b>size</b></td>
+    <td>The size of the image</td>
+    <td>80</td>
+    <td>1..512</td>
+  </tr>
+  <tr>
+    <td><b>default</b></td>
+    <td>The default avatar image</td>
+    <td><i>none</i></td>
+    <td>Any URL, or "identicon", "monsterid", "wavatar"</td>
+  </tr>
+  <tr>
+    <td><b>rating</b></td>
+    <td>The lowest level of ratings you want to allow</td>
+    <td>G</td>
+    <td>G, PG, R or X</td>
+  </tr>
+  <tr>
+    <td><b>filetype</b></td>
+    <td>The filetype of the image</td>
+    <td>png</td>
+    <td>gif, jpg or png</td>
+  </tr>
+</table>
+
+## Making Changes Yourself
+
+Fork the project, submit a pull request and I'll get to it straight away. Or you can just view the source like:
+
+    git clone git://github.com/chrislloyd/gravtastic.git
+
+## Thanks
+
+* [Xavier Shay](http://rhnh.net) and others for [Enki](http://enkiblog.com) (the reason this was originally written)
+* [Matthew Moore](http://www.matthewpaulmoore.com/) for helpful suggestions and for submitting it to the official list of Gravatar implementations.
+* [Vincent Charles](http://vincentcharles.com/) For some documentation in a previous version.
+
+## License
+
+Copyright (c) 2009 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

@@ -1,76 +1,10 @@
 require 'mg'
+require 'spec/rake/spectask'
 
 MG.new('gravtastic.gemspec')
 
-# require 'rubygems'
-# require 'rake/gempackagetask'
-# require 'rake/rdoctask'
-# require 'rubygems/specification'
-# require 'spec/rake/spectask'
-# require 'date'
-#
-# GEM = "gravtastic"
-# GEM_VERSION = "2.0.0"
-# 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
-#
-# desc "Run Specs"
-# Rake::GemPackageTask.new(spec) do |pkg|
-#   pkg.gem_spec = spec
-# end
-#
-# desc "Generate Documentation"
-# Rake::RDocTask.new do |rdoc|
-#   rdoc.rdoc_dir = 'doc'
-#   rdoc.title = 'Gravtastic'
-#   rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'Gravtastic'
-#   rdoc.rdoc_files.include(FileList[ 'lib/**/*.rb', 'README.textile', 'LICENSE'])
-# 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
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ['--options','spec/spec.opts']
+  t.spec_files = FileList['spec/**/*.rb']
+  # t.rcov = true
+end

data/lib/gravtastic.rb

@@ -1,6 +1,3 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 require 'digest/md5'
 require 'cgi'
 require 'uri'
@@ -17,6 +14,11 @@ module Gravtastic
       extend ClassMethods
       include InstanceMethods
 
+      if source.is_a?(Hash)
+        options = source
+        source = :email
+      end
+
       @gravatar_defaults = {
         :rating => 'PG',
         :secure => false,
@@ -25,7 +27,8 @@ module Gravtastic
       @gravatar_source = source
     end
 
-    alias :has_gravatar :is_gravtastic
+    alias_method :has_gravatar, :is_gravtastic
+    alias_method :is_gravtastic!, :is_gravtastic
 
   end
 
@@ -41,6 +44,14 @@ module Gravtastic
       @gravatar_defaults
     end
 
+    def gravatar_options
+      {
+        :size => 's',
+        :default => 'd',
+        :rating => 'r'
+      }
+    end
+
   end
 
   module InstanceMethods
@@ -59,9 +70,8 @@ module Gravtastic
   private
 
     def url_params_from_hash(hash)
-      '?' + hash.map do |pair|
-        pair[0] = pair[0].to_s[0,1]
-        pair.map{|item| item = CGI::escape(item.to_s) }.join('=')
+      '?' + hash.map do |key, val|
+        [self.class.gravatar_options(key.to_sym) || key.to_s, CGI::escape(val.to_s) ].join('=')
       end.sort.join('&')
     end
 

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 $TESTING=true
 $:.push File.join(File.dirname(__FILE__), '..', 'lib')
 
+require 'rubygems'
+require 'spec'
+
 def reload_gravtastic!
   Object.class_eval { remove_const :Gravtastic } if defined? Gravtastic
   require File.join(File.dirname(__FILE__),'../lib/gravtastic')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gravtastic
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors: 
 - Chris Lloyd
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-30 00:00:00 +10:00
+date: 2008-09-15 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -19,12 +19,11 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.textile
-- LICENSE
+extra_rdoc_files: []
+
 files: 
 - LICENSE
-- README.textile
+- README.md
 - Rakefile
 - lib/gravtastic.rb
 - spec/gravtastic_integration_spec.rb
@@ -55,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gravtastic
-rubygems_version: 1.3.2
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 2
 summary: Easily add Gravatars to your Ruby objects.

data/README.textile

@@ -1,97 +0,0 @@
-Easily add "Gravatars":http://gravatar.com to your Ruby objects.
-
-
-h2. Install
-
-  sudo gem install gravtastic
-
-
-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'
-
-If you are using Merb & DataMapper you can add do the same by adding the following to your init.rb file:
-
-  dependency 'gravtastic'
-
-Make sure you add this after either the @use_orm :datamapper@ line or after a DataMapper extension. The next step is to give your model a Gravatar:
-
-  class User
-    is_gravtastic
-  end
-
-If you are using a standard Ruby class you have to add the line @include Gravtastic::Resource@ before @is_gravtastic@.
-  
-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:
-
-  is_gravtastic :with => :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 => 'R', :size => 512)
-  => "http://gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=R18&s=512"
-  
-  current_user.gravatar_url(:secure => true)
-  => "https://secure.gravatar.com/e9e719b44653a9300e1567f09f6b2e9e.png?r=PG"
-  
-However, to DRY things up you can specify defaults in the class declaration.
-
-  is_gravtastic :with => :author_email, :rating => 'R', :size => 20
-
-Nice, now all the calls to gravatar_url will have the defaults you have specified. Any options that you pass when you use @gravatar_url@ will over-ride these class-defaults.
-
-PS.  Bonus points for anybody who can tell me what that users email is!
-
-
-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)
-* "Matthew Moore":http://www.matthewpaulmoore.com/ for helpful suggestions and for submitting it to the official list of Gravatar implementations.
-* "Vincent Charles":http://vincentcharles.com/ For an updated README.
-
-
-
-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.