gravatar-ultimate 1.0.2 → 1.0.3

data/gravatar-ultimate.gemspec

@@ -1,13 +1,11 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gravatar/version"
 
 Gem::Specification.new do |s|
   s.name = %q{gravatar-ultimate}
-  s.version = "1.0.2"
+  s.version = Gravatar::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Colin MacKenzie IV"]
   s.date = %q{2010-08-30}
   s.description = %q{The Ultimate Gravatar Gem!
@@ -20,58 +18,20 @@ rather than just a URL to that data. This saves you the extra step of having to
     "LICENSE",
      "README.rdoc"
   ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "gravatar-ultimate.gemspec",
-     "lib/gravatar-ultimate.rb",
-     "lib/gravatar.rb",
-     "lib/gravatar/cache.rb",
-     "lib/gravatar/dependencies.rb",
-     "lib/gravatar_ultimate.rb",
-     "spec/credentials.yml.example",
-     "spec/fixtures/image.jpg",
-     "spec/lib/gravatar/cache_and_logger_spec.rb",
-     "spec/lib/gravatar/cache_setup_spec.rb",
-     "spec/lib/gravatar/dependencies_spec.rb",
-     "spec/lib/gravatar_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
+  s.files = `git ls-files`.split("\n")
   s.homepage = %q{http://www.thoughtsincomputation.com/}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A gem for interfacing with the entire Gravatar API: not just images, but the XML-RPC API too!}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/lib/gravatar_spec.rb",
-     "spec/lib/gravatar/dependencies_spec.rb",
-     "spec/lib/gravatar/cache_and_logger_spec.rb",
-     "spec/lib/gravatar/cache_setup_spec.rb"
-  ]
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n")
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<sc-core-ext>, [">= 1.2.0"])
-      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
-      s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
-    else
-      s.add_dependency(%q<sc-core-ext>, [">= 1.2.0"])
-      s.add_dependency(%q<rspec>, [">= 1.3.0"])
-      s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
-    end
-  else
-    s.add_dependency(%q<sc-core-ext>, [">= 1.2.0"])
-    s.add_dependency(%q<rspec>, [">= 1.3.0"])
-    s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
-  end
+  # s.add_runtime_dependency('sc-core-ext', ">= 1.2.0")
+  s.add_development_dependency('rspec', ">= 1.3.0")
+  s.add_development_dependency('fakeweb', ">= 1.2.8")
+  s.add_development_dependency('activesupport', '>= 2.3.14')
+  s.add_development_dependency('i18n', '~> 0.6.0')
+  s.add_development_dependency('rake', '~> 0.9.2.2')
+  s.add_development_dependency('rdoc', '~> 3.11')
 end
-

data/lib/gravatar.rb

@@ -1,3 +1,5 @@
+require 'active_support'
+require 'active_support/core_ext'
 require File.expand_path('../gravatar/dependencies', __FILE__)
 require File.expand_path("../gravatar/cache", __FILE__)
 
@@ -14,7 +16,15 @@ require File.expand_path("../gravatar/cache", __FILE__)
 #     -100  Misc error (see text)
 #
 class Gravatar
-  attr_reader :email
+  API_METHODS = [
+    :exists?, :addresses, :user_images, :save_data!, :save_image!, :save_url!, :use_image!, :use_user_image!,
+    :remove_image!, :delete_user_image!, :test, :image_url, :image_data
+  ]
+  autoload :TestCase, File.expand_path('gravatar/test_case', File.dirname(__FILE__))
+  
+  attr_reader :email, :api
+  
+  delegate :rescue_errors, :rescue_errors=, :to => :cache
 
   # Creates a new instance of Gravatar. Valid options include:
   #   :password                   => the password for this account, to be used instead of :api_key (don't supply both)
@@ -29,24 +39,35 @@ class Gravatar
     raise ArgumentError, "Expected :email" unless email
     @options = options || {}
     @email = email
-
+    
     pw_or_key = auth.keys.first || :none
     @cache = Gravatar::Cache.new(self.class.cache, options[:duration] || self.class.duration,
                                  "gravatar-#{email_hash}-#{pw_or_key}", options[:logger] || self.class.logger)
+    self.rescue_errors = options[:rescue_errors]
 
-    if !auth.empty?
-      @api = XMLRPC::Client.new("secure.gravatar.com", "/xmlrpc?user=#{email_hash}", 443, nil, nil, nil, nil, true)
-    end
+    self.auth_with auth unless auth.empty?
+  end
+  
+  def host
+    "secure.gravatar.com"
+  end
+  
+  def url
+    File.join("https://#{host}", path)
+  end
+  
+  def path
+    "/xmlrpc?user=#{email_hash}"
   end
 
   # The duration of the cache for this instance of Gravatar, independent of any other instance
   def cache_duration
-    @cache.duration
+    cache.duration
   end
 
   # Sets the duration of the cache for this instance of Gravatar, independent of any other instance
   def cache_duration=(time)
-    @cache.duration = time
+    cache.duration = time
   end
 
   # Check whether one or more email addresses have corresponding avatars. If no email addresses are
@@ -85,7 +106,7 @@ class Gravatar
       end
     end
   end
-
+  
   # Returns a hash of user images for this account in the following format:
   #   { user_img_hash => [rating, url] }
   #
@@ -120,12 +141,11 @@ class Gravatar
   # This method is not cached.
   #
   # This method will clear out the cache, since it may have an effect on what the API methods respond with.
-  def use_user_image!(image_hash, *email_addresses)
-    hashed_email_addresses = normalize_email_addresses(email_addresses)
-    hash = call('grav.useUserimage', :userimage => image_hash, :addresses => hashed_email_addresses)
-    dehashify_emails(hash, email_addresses) { |value| boolean(value) }.tap do
-      expire_cache!
-    end
+  def use_user_image!(image_hash, emails)
+    emails = [emails] unless emails.is_a?(Array)
+    hash = call('grav.useUserimage', :userimage => image_hash, :addresses => emails)
+    expire_cache!
+    return hash
   end
   alias use_image! use_user_image!
 
@@ -136,12 +156,11 @@ class Gravatar
   # This method is not cached.
   #
   # This method will clear out the cache, since it may have an effect on what the API methods respond with.
-  def remove_image!(*emails)
-    hashed_email_addresses = normalize_email_addresses(emails)
-    hash = call('grav.removeImage', :addresses => hashed_email_addresses)
-    dehashify_emails(hash, emails) { |value| boolean(value) }.tap do
-      expire_cache!
-    end
+  def remove_image!(emails)
+    emails = [emails] unless emails.is_a?(Array)
+    hash = call('grav.removeImage', :addresses => emails)
+    expire_cache!
+    return hash
   end
 
   # Remove a userimage from the account and any email addresses with which it is associated. Returns
@@ -175,7 +194,9 @@ class Gravatar
   #   :default or :d         a default URL for this image to display if the specified user has no image;
   #                          or this can be one of [ :identicon, :monsterid, :wavatar, 404 ]. By default a generic
   #                          Gravatar image URL will be returned.
-  #   :filetype              an extension such as :jpg or :png. Default is omitted.
+  #   :filetype or :ext      an extension such as :jpg or :png. Default is omitted.
+  #   :forcedefault or :f    force a default image and ignore the user's specified image. Can be one of
+  #                          [ :identicon, :monsterid, :wavatar, 404 ].
   #
   # See http://en.gravatar.com/site/implement/url for much more detailed information.
   def image_url(options = {})
@@ -195,17 +216,18 @@ class Gravatar
     cache(url) { OpenURI.open_uri(URI.parse(url)).read }
   end
 
-  def self.version
-    @version ||= File.read(File.join(File.dirname(__FILE__), "../VERSION")).chomp
-  end
-
-  private
+  # If no arguments are given, the cache object for this instance is returned. Otherwise, the arguments
+  # are passed into Gravatar::Cache#cache.
   def cache(*key, &block)
-    @cache.call(*key, &block)
+    if key.empty? and not block_given?
+      @cache
+    else
+      @cache.call(*key, &block)
+    end
   end
 
   def expire_cache!
-    @cache.clear!
+    cache.clear!
   end
 
   def dehashify_emails(response, emails)
@@ -226,10 +248,12 @@ class Gravatar
 
   def rating(i)
     case i
+      when -1, '-1' then :unknown
       when 0, '0' then :g
       when 1, '1' then :pg
       when 2, '2' then :r
       when 3, '3' then :x
+      when :unknown then -1
       when :g  then 0
       when :pg then 1
       when :r  then 2
@@ -244,10 +268,23 @@ class Gravatar
   end
 
   def call(name, args_hash = {})
+    raise "No authentication data given" unless @api
     r = @api.call(name, auth.merge(args_hash))
     r = r.with_indifferent_access if r.kind_of?(Hash)
     r
   end
+  
+  # Authenticates with the given API key or password, returning self.
+  def auth_with(options)
+    @options.delete(:apikey)
+    @options.delete(:api_key)
+    @options.delete(:key)
+    @options.merge! options
+    if !auth.empty?
+      @api = XMLRPC::Client.new(host, path, 443, nil, nil, nil, nil, true)
+    end
+    self
+  end
 
   def auth
     api_key ? {:apikey => api_key} : (password ? {:password => password} : {})
@@ -267,7 +304,7 @@ class Gravatar
 
   def query_for_image(options)
     query = ''
-    [:rating, :size, :default, :r, :s, :d].each do |key|
+    [:rating, :size, :default, :forcedefault, :r, :s, :d, :f].each do |key|
       if options.key?(key)
         query.blank? ? query.concat("?") : query.concat("&")
         query.concat("#{key}=#{CGI::escape options[key].to_s}")
@@ -277,6 +314,7 @@ class Gravatar
   end
 
   def extension_for_image(options)
-    options.key?(:filetype) ? "." + (options[:filetype] || "jpg").to_s : ""
+    options.key?(:filetype) || options.key?(:ext) ? "." + (options[:filetype] || options[:ext] || "jpg").to_s : ""
   end
 end
+

data/lib/gravatar/cache.rb

@@ -3,12 +3,18 @@ class Gravatar
   class Cache
     attr_reader :real_cache, :namespace
     attr_accessor :duration, :logger
+    
+    # If true, any errors encountered while communicating with the server will be rescued
+    # and the error message will be written to #logger, then the cached copy of the result
+    # (if any) will be returned. If false, the error will be raised.
+    attr_accessor :rescue_errors
 
     def initialize(real_cache, duration, namespace = nil, logger = Gravatar.logger)
       @duration = duration
       @real_cache = real_cache
       @namespace = namespace
       @logger = logger
+      @rescue_errors = true
     end
 
     # Provide a series of arguments to be used as a cache key, and a block to be executed when the cache
@@ -20,17 +26,19 @@ class Gravatar
     #
     def call(*key, &block)
       cached_copy = read_cache(*key)
+      cached_copy &&= cached_copy[:object]
+      
       if expired?(*key) && block_given?
         begin
-          returning(yield) do |object|
+          yield.tap do |object|
             write_cache(object, *key)
           end
         rescue
-          log_error($!)
-          cached_copy.nil? ? nil : cached_copy[:object]
+          log_error $!
+          cached_copy
         end
       else
-        cached_copy.nil? ? nil : cached_copy[:object]
+        cached_copy
       end
     end
 
@@ -57,6 +65,11 @@ class Gravatar
     def read_cache(*key)
       @real_cache.read(cache_key(*key))
     end
+    
+    def cached(*key)
+      copy = read_cache(*key)
+      copy &&= copy[:object]
+    end
 
     # Writes an object to the cache based on th cache key constructed from *key.
     def write_cache(object, *key)
@@ -67,36 +80,29 @@ class Gravatar
     def cache_key(*args)
       ActiveSupport::Cache.expand_cache_key(args, @namespace)
     end
-
+    
     # Logs an error message, as long as self.logger responds to :error or :write.
     # Otherwise, re-raises the error.
     def log_error(error)
+      raise error unless rescue_errors
       if logger.respond_to?(:error)
         logger.error error.message
         error.backtrace.each { |line| logger.error "  #{line}" }
       elsif logger.respond_to?(:write)
-        logger.write(([error.message]+error.backtrace).join("\n  "))
-        logger.write("\n")
-      else raise error
+        logger.write(([error.message] + error.backtrace).join("\n  ") + "\n")
+      else
+        raise error
       end
     end
   end
 
   class << self
     def default_cache_instance
-      if defined?(Rails)
-        Rails.cache
-      else
-        ActiveSupport::Cache::FileStore.new("tmp/cache")
-      end
+      defined?(Rails) ? Rails.cache : ActiveSupport::Cache::FileStore.new("tmp/cache")
     end
-
+    
     def default_logger_instance
-      if defined?(Rails)
-        Rails.logger
-      else
-        $stdout
-      end
+      defined?(Rails) ? Rails.logger : $stderr
     end
 
     def cache
@@ -106,11 +112,11 @@ class Gravatar
     def cache=(instance)
       @cache = instance
     end
-
+    
     def logger
       @logger ||= default_logger_instance
     end
-
+    
     def logger=(logger)
       @logger = logger
     end

data/lib/gravatar/dependencies.rb

@@ -1,22 +1,5 @@
-if defined?(Rails) and Rails::VERSION::STRING < '3.0.0'
-  Rails.configuration.gem "sc-core-ext", ">= 1.2.0"
-elsif !defined?(Gem)
-  require 'rubygems'
-  gem 'activesupport', '>= 2.3.5'
-  gem 'sc-core-ext', '>= 1.2.0'
-end
-
-unless defined?(Rails) # because Rails will load it later and we don't really need it quite yet.
-  unless defined?(ActiveSupport::Cache)
-    require 'active_support'
-  end
-
-  unless defined?(ScCoreExt)
-    require 'sc-core-ext'
-  end
-end
-
 # The rest of this is core Ruby stuff so it's safe to load immediately, even if Rails is running the show.
+require 'cgi'
 require 'open-uri'
 require "digest/md5"
 require 'xmlrpc/client'

data/lib/gravatar/test_case.rb

@@ -0,0 +1,105 @@
+require 'fakeweb'
+
+module Gravatar::TestCase
+  class << self
+    attr_accessor :fixtures_path
+  end
+  
+  Gravatar::API_METHODS.each do |method_name|
+    define_method method_name do |*args, &block|
+      allow_net_connect = FakeWeb.allow_net_connect?
+      begin
+        apply_current_mock!
+        grav.send(method_name, *args, &block).tap do
+          # mock only lasts 1 request -- this should prevent the wrong
+          # mock being used on other APIs
+          mock_response nil
+        end
+      ensure
+        FakeWeb.allow_net_connect = allow_net_connect
+      end
+    end
+  end
+  
+  delegate :auth_with, :email_hash, :to => :grav
+  delegate :fixtures_path, :to => "self.class"
+  
+  def self.included(base)
+    base.instance_eval do
+      # Sets or gets the default email address to create Gravs with
+      # default: "generic@example.com"
+      def default_email(new_one = nil)
+        !new_one ? @default_email ||= "generic@example.com" : @default_email = new_one
+      end
+      
+      def fixtures_path
+        @fixtures_path || Gravatar::TestCase.fixtures_path
+      end
+      
+      def fixtures_path=(a)
+        @fixtures_path = a
+      end
+    end
+  end
+  
+  # Sets the filename of the mock response to be used for the next request.
+  # Set to nil to disable mock responses entirely.
+  #
+  # If name is omitted, the contents of the current mock response, if any, are
+  # returned.
+  def mock_response(name = :__unassigned)
+    if name == :__unassigned
+      @mock_response
+    else
+      if name.nil?
+        FakeWeb::Registry.instance.uri_map.each do |uri, methods|
+          if uri.to_s == grav.url
+            methods.delete :post
+          end
+        end
+
+        @mock_response = nil
+      else
+        if fixtures_path.nil?
+          raise "fixtures_path is not set! Try setting that first."
+        end
+        @mock_response = File.read(File.join(fixtures_path, name))
+      end
+    end
+  end
+  
+  def apply_current_mock!
+    if mock_response
+      FakeWeb.allow_net_connect = false
+      FakeWeb.register_uri :post, grav.url, :response => mock_response
+    else
+      # don't set to true, instead leave it set to whatever
+      # the user has it set to. This way if the user manually
+      # sets it to false, they don't have a 4-hour-long WTF.
+      # FakeWeb.allow_net_connect = false
+    end
+  end
+  
+  # Set or get the Gravatar instance to test against.
+  #
+  # Examples:
+  #   grav        # return the default grav with bogus email
+  #   grav(email) # replace with a new grav with given email
+  #   grav        # return the current grav with above email
+  #
+  def grav(*args)
+    if args.empty?
+      @grav ||= Gravatar.new(self.class.default_email, :rescue_errors => false)
+    else
+      options = args.extract_options!
+      options.reverse_merge! :rescue_errors => false
+      @grav = Gravatar.new(*args + [options])
+    end
+  end
+  
+  def clear_account(g = grav)
+    g.user_images.each do |usrimg_hash, (rating, url)|
+      g.delete_user_image!(usrimg_hash)
+    end
+  end
+end