gravatarify 0.6.0 → 0.7.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Lukas Westermann, Zurich (CHE)
+Copyright (c) 2009 Lukas Westermann
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -8,9 +8,24 @@ Best of it? It works with Rails, probably Merb and even plain old Ruby :)
 
 ## Install
 
-TODO: need to gemify it...
+Just install the gem (ensure you have gemcutter in your sources!)
 
-## Using the view helpers
+    sudo gem install gravatarify
+   
+Ready to go! Using Rails? Either add (to `config/environment.rb`):
+
+    config.gem 'gravatarify', :source => 'http://gemcutter.org'
+    
+or install as Rails plugin:
+
+    ./script/plugin install git://github.com/lwe/gravatarify.git
+    
+If the gem is available, just require it (for your simple ruby apps):
+
+    require 'rubygems'
+    require 'gravatarify'
+
+## Using the view helpers (Rails only!)
 
 Probably one of the easiest ways to add support for gravatar images is with the included view helpers:
 
@@ -79,3 +94,109 @@ class:
 Tadaaa! Works exactly like the model helpers, so it's now possible to call `gravatar_url` on instances
 of `PoroUser`.
 
+## Back to the roots?
+
+No need for sophisticated stuff like view helpers and ActiveRecord integration, want to go back to the roots?
+Then feel free to use `Gravatarify::Base#build_gravatar_url` directly.
+
+For example, want to use `build_gravatar_url` in a Sinatra app?
+
+    helpers Gravatarify::Base
+    
+Yeah, that should work :). See {Gravatarify::Base#build_gravatar_url} for more informations and usage examples.
+
+## Need more control?
+
+<table>
+  <tr>
+    <th>Option</th>
+    <th>Type</th>
+    <th>Description</th>
+    <th>Default</th>
+  </tr>
+  <tr>
+    <td><tt>:default</tt></td>
+    <td>String, Proc</td>
+    <td>Fully qualified URL to an image, which is used if gravatar.com has no image for the supplied email.
+        <tt>Proc</tt>s can be used to return e.g. an image based on the request size (see Advanced stuff).
+        Furthermore gravatar.com provides several "special values" which generate icons, these are "wavatar",
+        "monsterid" and "identicon", finally if set to <tt>404</tt> gravatar.com returns the <tt>HTTP 404 Not Found</tt> error.
+        If nothing is specified gravatar.com returns it's gravatar icon.
+    </td>
+    <td>-</td>
+  </tr>
+  <tr>
+    <td><tt>:rating</tt></td>
+    <td>String, Symbol</td>
+    <td>Each avatar at gravatar.com has a rating associated (which is based on MPAAs rating system), valid values are:<br/>
+        <b>g</b> - general audiences, <b>pg</b> - parental guidance suggested, <b>r</b> - restricted and <b>x</b> - x-rated :).
+        Gravatar.com returns <b>g</b>-rated avatars, unless anything else is specified.
+    </td>
+    <td>-</td>
+  </tr>
+  <tr>
+    <td><tt>:size</tt></td>
+    <td>Integer</td>
+    <td>Avatars are square, so <tt>:size</tt> defines the length of the sides in pixel, if nothing is specified gravatar.com
+        returns 80x80px images.</td>
+    <td>-</td>
+  </tr>
+  <tr>
+    <td><tt>:secure</tt></td>
+    <td>Boolean, Proc</td>
+    <td>If set to <tt>true</tt> gravatars secure host (<i>https://secure.gravatar.com/</i>) is used to serve the avatars
+      from. Can be a Proc to inflect wheter or not to use the secure host based on request parameters.</td>
+    <td><tt>false</tt></td>
+  </tr>
+  <tr>
+    <td><tt>:filetype</tt></td>
+    <td>String, Symbol</td>
+    <td>Change image type, gravatar.com supports <tt>:gif</tt>, <tt>:png</tt> and <tt>:jpg</tt>.</td>
+    <td><tt>:jpg</tt></td>
+  </tr>
+</table>
+
+## Not yet enough?
+
+The `:default` option can be passed in a `Proc`, so this is certainly useful to for example
+to generate an image url, based on the request size:
+
+    # in an initializer
+    Gravatarify.options[:default] = Proc.new do |options, object|
+      "http://example.com/avatar-#{options[:size] || 80}.jpg"
+    end
+    
+    # now each time a gravatar url is generated, the Proc is evaluated:
+    @user.gravatar_url
+    # => "http://0.gravatar.com/...jpg?d=http%3A%2F%2Fexample.com%2Fgravatar-80.jpg"
+    @user.gravatar_url(:size => 16)
+    # => "http://0.gravatar.com/...jpg?d=http%3A%2F%2Fexample.com%2Fgravatar-16.jpg&s=16"
+    
+Into the block is passed the options hash and as second parameter the object itself, so in the example above
+`object` would be `@user`, might be useful!? Never used it, so I might remove the second argument...
+
+Not only the `:default` option accepts a Proc, but also `:secure`, can be useful to handle cases where
+it should evaluate against `request.ssl?` for example.
+
+## Licence
+
+Copyright (c) 2009 Lukas Westermann
+
+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/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :patch: 0
 :major: 0
-:minor: 6
+:minor: 7

data/lib/gravatarify/base.rb

@@ -10,7 +10,7 @@ module Gravatarify
   GRAVATAR_DEFAULT_SIZE = 80
   
   # Default filetype is JPG
-  GRAVATAR_DEFAULT_FILETYPE = 'jpg'
+  GRAVATAR_DEFAULT_FILETYPE = :jpg
 
   # List of known and valid gravatar options (includes shortened options).
   GRAVATAR_OPTIONS = [ :default, :d, :rating, :r, :size, :s, :secure, :filetype ]
@@ -69,7 +69,7 @@ module Gravatarify
   
     private
       def build_gravatar_host(str_hash, secure = false)
-        secure = secure.call(respond_to?(:request) ? request : nil) if secure.respond_to?(:call)
+        secure = secure.call(self) if secure.respond_to?(:call)
         secure ? "https://secure.gravatar.com" : "http://#{GRAVATAR_HOSTS[str_hash.hash % GRAVATAR_HOSTS.size] || 'www'}.gravatar.com"        
       end
     
@@ -77,7 +77,7 @@ module Gravatarify
         params = []
         url_options.each_pair do |key, value|
           key = GRAVATAR_ABBREV_OPTIONS[key] if GRAVATAR_ABBREV_OPTIONS.include?(key) # shorten key!
-          value = value.call(url_options) if key.to_s == 'd' and value.respond_to?(:call)
+          value = value.call(url_options, self) if key.to_s == 'd' and value.respond_to?(:call)
           params << "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" if value
         end
         "?#{params.sort * '&'}" unless params.empty?

data/test/gravatarify_base_test.rb

@@ -55,7 +55,7 @@ class GravatarifyBaseTest < Test::Unit::TestCase
     end
   
     should "handle Procs as :default, to easily generate default urls based on supplied :size" do
-      default = Proc.new { |o| "http://example.com/gravatar#{o[:size] ? '-' + o[:size].to_s : ''}.jpg" }
+      default = Proc.new { |*args| "http://example.com/gravatar#{args.first[:size] ? '-' + args.first[:size].to_s : ''}.jpg" }
       assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar.jpg",
                     build_gravatar_url('bella@gmail.com', :default => default)        
       assert_equal "http://0.gravatar.com/avatar/1cacf1bc403efca2e7a58bcfa9574e4d.jpg?d=http%3A%2F%2Fexample.com%2Fgravatar-25.jpg&s=25",
@@ -104,7 +104,7 @@ class GravatarifyBaseTest < Test::Unit::TestCase
     end
     
     should "allow Procs for :secure option, enables pretty cool stuff for stuff like request.ssl?" do
-      Gravatarify.options[:secure] = Proc.new { |request| request.respond_to?(:ssl?) ? request.ssl? : false }
+      Gravatarify.options[:secure] = Proc.new { |obj| obj.request.ssl? }
       
       mock_ssl = MockView.new
       mock(mock_ssl).request.stub!.ssl? { true }      

data/test/gravatarify_object_support_test.rb

@@ -88,7 +88,7 @@ class GravatarifyObjectSupportTest < Test::Unit::TestCase
     should "allow multiple sources to be defined, yet still handle options!" do
       poro = Class.new do
         include Gravatarify::ObjectSupport
-        gravatarify :email, :employee_email, :default => Proc.new { |o| "http://initech.com/avatar-#{o[:size] || 80}.jpg" }
+        gravatarify :email, :employee_email, :default => Proc.new { |*args| "http://initech.com/avatar-#{args.first[:size] || 80}.jpg" }
         def email; "info@initech.com" end
         def employee_email; "peter.gibbons@initech.com" end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gravatarify
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Lukas Westermann