gravylicious 1.0.1 → 1.0.2

data/lib/gravylicious.rb

@@ -1,34 +1,45 @@
+# A ruby library for generating Gravatar urls.
+# Author:: Utsav Gupta
+# Copyright:: Copyright (c) 2011 Utsav Gupta
+# License::   MIT License
 require 'digest/md5'
 require 'uri'
 
 class Gravylicious
   attr_accessor :email, :params, :param_filters, :use_https
   
-  # A hash to store commonly used filters  
+  # A hash to store commonly used filters
+  # like sanitize_url for escaping urls.
   @@common_filters = {'sanitize_url' => proc{|link| URI.escape(link, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))},
                      }
   
+  # The constructor takes the email address and an optional boolean 
+  # parameter which specifies whether or not to use https requests,
+  # by deafault it's set to fasle. It stores the email address in @email
+  # and sets up a collection of default filters in @param_filters.
   def initialize(email, use_https = false)
     @email = email.strip
     @use_https = use_https
     
     @params = Hash.new
     
-    # Define the default filters
     @param_filters = {'d' => @@common_filters['sanitize_url'],
                       's' => proc{|s| raise("Invalid avatar size: The requested size is #{s}, valid range 1 to 512") if (s < 1 || s > 512); s},
                       'r' => proc{|r| raise("Invalid avatar rating: Select from g, pg, r and x") unless r =~ /^(p?)g$|^r$|^x$/; r}
                      }
   end
   
+  # Class function that returns the common_filters hash.
   def self.common_filters
     @@common_filters
   end
   
+  # Returns the MD5 hash of the email address.
   def email_hash
     Digest::MD5.hexdigest(@email.downcase)
   end
   
+  # Returns the link to the desired Gravatar.
   def avatar_url
     g_url = "http#{'s' if @use_https}://#{'secure.' if @use_https}gravatar.com/avatar/#{email_hash}"
     
@@ -50,36 +61,47 @@ class Gravylicious
     g_url
   end
   
+  # Used for loading the fallback(default) avatar by defaut.
   def avatar_force_load
     @params['f'] = 'y'
     self
   end
   
+  # Unsets the force_load options.  
   def avatar_unforce_load
     @params.delete('f') if @params.has_key?('f')
     self
   end
   
+  # Returns the avatar rating.
   def avatar_rating
     @params['r']
   end
   
+  # Returns the link to the default avatar.
   def avatar_default
     @params['d']
   end
   
+  # Returns the size of the avatar.
   def avatar_size
     @params['s']
   end
   
+  # Sets the rating of the avatar.
+  # Example gravatar.avatar_rating = 'pg' # Choose from g, pg, r and x.
   def avatar_rating=(r)
     @params['r'] = r
   end
   
+  # Sets the default avatar.
+  # Example gravatar.avatar_default = "http://example.com/yourpic.jpg"
   def avatar_default=(d)
     @params['d'] = d
   end
   
+  # Sets the size of the avatar in px.
+  # Example gravatar.avatar_size = 128 # Should not exceed 512
   def avatar_size=(s)
     @params['s'] = s
   end

data/lib/gravylicious.rb~

@@ -1,36 +1,45 @@
-#!/usr/bin/env ruby
-
+# A ruby library for generating Gravatar urls.
+# Author:: Utsav Gupta
+# Copyright:: Copyright (c) 2011 Utsav Gupta
+# License::   MIT License
 require 'digest/md5'
 require 'uri'
 
 class Gravylicious
   attr_accessor :email, :params, :param_filters, :use_https
   
-  # A hash to store commonly used filters  
+  # A hash to store commonly used filters
+  # like sanitize_url for escaping urls.
   @@common_filters = {'sanitize_url' => proc{|link| URI.escape(link, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))},
                      }
   
+  # The constructor takes the email address and an optional boolean 
+  # parameter which specifies whether or not to use https requests,
+  # by deafault it's set to fasle. It stores the email address in @email
+  # and sets up a collection of default filters in @param_filters.
   def initialize(email, use_https = false)
     @email = email.strip
     @use_https = use_https
     
     @params = Hash.new
     
-    # Define the default filters
     @param_filters = {'d' => @@common_filters['sanitize_url'],
                       's' => proc{|s| raise("Invalid avatar size: The requested size is #{s}, valid range 1 to 512") if (s < 1 || s > 512); s},
                       'r' => proc{|r| raise("Invalid avatar rating: Select from g, pg, r and x") unless r =~ /^(p?)g$|^r$|^x$/; r}
                      }
   end
   
+  # Class function that returns the common_filters hash.
   def self.common_filters
     @@common_filters
   end
   
+  # Returns the MD5 hash of the email address.
   def email_hash
     Digest::MD5.hexdigest(@email.downcase)
   end
   
+  # Returns the link to the desired Gravatar.
   def avatar_url
     g_url = "http#{'s' if @use_https}://#{'secure.' if @use_https}gravatar.com/avatar/#{email_hash}"
     
@@ -52,36 +61,47 @@ class Gravylicious
     g_url
   end
   
+  # Used for loading the fallback(default) avatar by defaut.
   def avatar_force_load
     @params['f'] = 'y'
     self
   end
   
+  # Unsets the force_load options.  
   def avatar_unforce_load
     @params.delete('f') if @params.has_key?('f')
     self
   end
   
+  # Returns the avatar rating.
   def avatar_rating
     @params['r']
   end
   
+  # Returns the link to the default avatar.
   def avatar_default
     @params['d']
   end
   
+  # Returns the size of the avatar.
   def avatar_size
     @params['s']
   end
   
+  # Sets the rating of the avatar.
+  # Example gravatar.avatar_rating = 'pg' # Choose from g, pg, r and x.
   def avatar_rating=(r)
     @params['r'] = r
   end
   
+  # Sets the default avatar.
+  # Example gravatar.avatar_default = "http://example.com/yourpic.jpg"
   def avatar_default=(d)
     @params['d'] = d
   end
   
+  # Sets the size of the avatar in px.
+  # Example gravatar.avatar_size = 128 # Should not exceed 512
   def avatar_size=(s)
     @params['s'] = s
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gravylicious
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Utsav Gupta
@@ -15,7 +15,7 @@ autorequire: gravylicious
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 Z
+date: 2011-07-19 00:00:00 Z
 dependencies: []
 
 description: 
@@ -30,7 +30,7 @@ files:
 - lib/gravylicious.rb
 - lib/gravylicious.rb~
 - tests/tc_gravylicious.rb
-homepage: https://github.com/utsavgupta
+homepage: https://github.com/utsavgupta/gravylicious
 licenses: []
 
 post_install_message: 
@@ -65,4 +65,4 @@ specification_version: 3
 summary: A library for generating Gravatar urls.
 test_files: 
 - tests/tc_gravylicious.rb
-has_rdoc: 
+has_rdoc: true