avataree 0.2.0 → 0.3.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 bagwanpankaj
+Copyright (c) 2010 [Bagwan Pankaj]
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -22,7 +22,7 @@ and you avataree will be up and running.
 
 h2. How to use It
 
-yeah.. that sound's a good question.
+yeah that sound's a good question.
 
 in your controller
 
@@ -56,6 +56,6 @@ h2. Contributing to avataree
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+h2. Copyright
 
 Copyright (c) 2010 [Bagwan Pankaj]. See LICENSE.txt for further details.

data/lib/avataree/helper.rb

@@ -23,12 +23,13 @@ require 'digest/md5'
 
 module Helper
   
+  #makes MD5 hash of given email
   def make_digest(email)
     Digest::MD5.hexdigest(email)
   end
   
   #fallback method if not defined(i.e if not used with rails)
-
+  #to_param for hash if hash does not respond to it
   Hash.class_eval do
     def to_param
       self.collect{|k,v| "#{k}=#{v}"}.join("&")

data/lib/avataree/image.rb

@@ -25,8 +25,28 @@ module Avataree
     
     include Helper
     
+    #image path for gravatar if not defined?
     IMAGES_PATH = "http://www.gravatar.com/avatar/" unless const_defined?("IMAGES_PATH")
     
+    #this method returns resulted path to be requested to gravatar. takes all argument as a hash
+    #options:
+    #<tt>s</tt> or <tt>size</tt> takes size in px (upto 512 px) :default => 80px x 80px
+    #<tt>d</tt> or <tt>default</tt> takes default image. Also takes a url other options are:
+    #   404: do not load any image if none is associated with the email hash, instead return an HTTP 404 (File Not Found) response
+    #   mm: (mystery-man) a simple, cartoon-style silhouetted outline of a person (does not vary by email hash)
+    #   identicon: a geometric pattern based on an email hash
+    #   monsterid: a generated 'monster' with different colors, faces, etc
+    #   wavatar: generated faces with differing features and backgrounds
+    #   retro: awesome generated, 8-bit arcade-style pixelated faces
+    #<tt>f</tt> or <tt>forcedefault</tt> takes y and n as argument :default => n
+    #<tt>r</tt> or <tt>rating</tt> takes below mentioned options as argument
+    #   g: suitable for display on all websites with any audience type.
+    #   pg: may contain rude gestures, provocatively dressed individuals, the lesser swear words, or mild violence.
+    #   r: may contain such things as harsh profanity, intense violence, nudity, or hard drug use.
+    #   x: may contain hardcore sexual imagery or extremely disturbing violence.
+    #in addition to these it also takes extension as options that lets you define the image type you want.
+    # <tt>extension</tt> default => jpg
+    
     def gravatar_image_path(email, options = {})
       email = make_digest(email)
       email<<".#{options[:extension]}" and options.delete(:extension) if options[:extension]

data/lib/avataree/profile.rb

@@ -26,8 +26,18 @@ module Avataree
   
   module Profile
     
+    #image path for gravatar if not defined?
     PROFILE_PATH = "http://www.gravatar.com/" unless const_defined?("PROFILE_PATH")
     
+    #this method returns hash full of information provided by Gravatar.
+    #This hash may contain
+    #Email address marked up with class=email (only available via JS/client-side parsing due to spam-protection measures)
+    # IM accounts (some values only available via JS/client-side parsing due to spam-protection measures)
+    # Phone numbers
+    # Verified accounts 
+    # Name 
+    # Personal Links
+    # Image (main Gravatar) 
     def gravatar_profile(email, options = {})
       email = make_digest(email)
       email << ".json"
@@ -37,7 +47,8 @@ module Avataree
       begin
         JSON.parse(open(path).read)
       rescue => e
-        puts "I am unable to parse this bad stuff. because\n#{e}"
+        {"error" => "unable to parse", "description" => "either no such user is found on gravatar using
+           provided email or some server side error. do check it out.", "errorTrace" => "#{e}"}
       end
     end
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: avataree
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Bagwan Pankaj (a.k.a modulo9)
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 +05:30
+date: 2010-12-17 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency