aggravatar 0.1.0 → 1.0.0

data/.gitignore

@@ -1,5 +1,17 @@
-*.sw?
-.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
 coverage
-rdoc
+doc/
+lib/bundler/man
 pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aggravatar.gemspec
+gemspec

data/{LICENSE → LICENSE.txt}

@@ -1,5 +1,7 @@
 Copyright (c) 2009 Adam Tanner
 
+MIT License
+
 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

data/README.md

@@ -0,0 +1,37 @@
+# Aggravatar
+
+You give it an email, it gives you a Gravatar URL. What more do you want?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aggravatar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aggravatar
+
+## Usage
+
+```ruby
+require "aggravatar"
+
+Aggravatar.gravatar_url "adam@adamtanner.org", size: 200, rating: "g", force_default: true
+# => "http://www.gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88?size=200&rating=g&forcedefault=y
+
+Aggravatar.secure_gravatar_url "adam@adamtanner.org", default: "http://example.com/images/avatar.jpg"
+# => "https://secure.gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88?default=http%3A%2F%2Fexample.com%2Fimages%2Favatar.jpg"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,44 +1,6 @@
-require 'rubygems'
-require 'rake'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "aggravatar"
-    gem.summary = %Q{TODO: one-line summary of your gem}
-    gem.description = %Q{TODO: longer description of your gem}
-    gem.email = "adam@adamtanner.org"
-    gem.homepage = "http://github.com/cxvii/aggravatar"
-    gem.authors = ["Adam Tanner"]
-    gem.add_development_dependency "rspec"
-    gem.add_development_dependency "yard"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
 end

data/aggravatar.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aggravatar/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "aggravatar"
+  gem.version       = Aggravatar::VERSION
+  gem.authors       = ["Adam Tanner"]
+  gem.email         = ["adam@adamtanner.org"]
+  gem.description   = %q{ You give it an email, it gives you a Gravatar URL. What more do you want? }
+  gem.summary       = %q{ You give it an email, it gives you a Gravatar URL. What more do you want? }
+  gem.homepage      = "http://github.com/adamtanner/aggravatar"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/aggravatar.rb

@@ -1,51 +1,12 @@
-module Aggravatar
-  def self.included(base)
-    base.send(:include, InstanceMethods)
-  end
-
-  def self.host
-    "gravatar.com"
-  end
+require "aggravatar/version"
+require "aggravatar/gravatar"
 
-  def self.path(email_hash)
-    "/avatar/#{email_hash}"
+module Aggravatar
+  def self.gravatar_url(email, params = {})
+    Aggravatar::Gravatar.new(email, params).url
   end
-  
-  module InstanceMethods
-    require 'MD5'
-    require 'URI'
-
-    def gravatar_for(email, options={})
-       build_image_tag(hash(email), options)
-    end
-
-  private
-    def hash(email)
-      MD5.md5(email.strip)
-    end
-
-    def build_image_tag(email_hash, options={})
-      "<img src=\"#{build_url(email_hash, options)}\" #{build_tag_attributes(options[:html_attributes])}/>" 
-    end
 
-    def build_tag_attributes(attributes)
-    return nil if attributes.nil?
-    attributes.inject([]){|array, attribute| array << "#{attribute[0].to_s}=\"#{attribute[1]}\""}.join(" ")
-    end
-    
-    def build_query(query_options)
-      query_options = query_options.reject{|key, value| key == :html_attributes}
-      return nil if query_options.empty?
-      query_options[:default] = URI.escape(query_options[:default], ":/")
-      query_options.inject([]){|array, option| array << "#{option[0].to_s[0].chr}=#{option[1]}"}.join("&")
-    end 
-    
-    def build_url(email_hash, query)
-      uri = URI::HTTP.build(
-        :host   =>  Aggravatar.host,
-        :path   =>  Aggravatar.path(email_hash),
-        :query  =>  build_query(query)
-      )
-    end 
+  def self.secure_gravatar_url(email, params = {})
+    Aggravatar::Gravatar.new(email, params).secure_url
   end
 end

data/lib/aggravatar/gravatar.rb

@@ -0,0 +1,55 @@
+require "digest/md5"
+
+class Aggravatar::Gravatar
+  attr_reader :email
+
+  def initialize(email, params = {})
+    @email  = email
+    @params = params
+  end
+
+  def email_hash
+    Digest::MD5.hexdigest email
+  end
+
+  def url
+    uri = URI::HTTP.build(
+      host: "www.gravatar.com",
+      path: avatar_path
+    )
+
+    uri.query = build_query unless @params.empty?
+
+    uri.to_s
+  end
+
+  def secure_url
+    uri = URI::HTTPS.build(
+      host: "secure.gravatar.com",
+      path: avatar_path
+    )
+
+    uri.query = build_query unless @params.empty?
+
+    uri.to_s
+  end
+
+  private
+  def avatar_path
+    "/avatar/#{email_hash}"
+  end
+
+  def build_query
+    URI.encode_www_form normalized_params
+  end
+
+  def normalized_params
+    params = @params.dup
+
+    if params.delete(:force_default)
+      params[:forcedefault] = "y"
+    end
+
+    params
+  end
+end

data/lib/aggravatar/version.rb

@@ -0,0 +1,3 @@
+module Aggravatar
+  VERSION = "1.0.0"
+end

data/spec/aggravatar_spec.rb

@@ -1,29 +1,17 @@
-require File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib", "aggravatar.rb")
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "minitest/spec"
+require "minitest/autorun"
+require "aggravatar"
 
-describe "Aggravatar" do
-  before(:all) do
-    class Helper
-      include Aggravatar
-    end
-    @helper = Helper.new
-  end
+describe Aggravatar do
+  it "provides a Gravatar URL" do
+    url = Aggravatar.gravatar_url "adam@adamtanner.org"
 
-  it "should make an image tag for a vanilla Gravatar" do
-    valid_image_tag = "<img src=\"http://gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88\" />"
-    image_tag = @helper.gravatar_for("adam@adamtanner.org")
-    image_tag.should == valid_image_tag
+    url.must_equal "http://www.gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88"
   end
 
-  it "should make an image tag for a Gravatar using parameters" do
-    valid_image_tag = "<img src=\"http://gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88?d=http%3A%2F%2Fexample.com%2Fimages%2Fdefault.jpg&r=g&s=50\" />"
-    image_tag = @helper.gravatar_for("adam@adamtanner.org", :rating => "g", :default => "http://example.com/images/default.jpg", :size => 50)
-    image_tag.should == valid_image_tag
-  end
+  it "provides a secure Gravatar URL" do
+    url = Aggravatar.secure_gravatar_url "adam@adamtanner.org"
 
-  it "should make an image tag for a Gravatar using custom HTML attributes" do
-    valid_image_tag = "<img src=\"http://gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88\" class=\"gravatar\" id=\"my_gravatar\"/>" 
-    image_tag = @helper.gravatar_for("adam@adamtanner.org", :html_attributes => {:class => "gravatar", :id => "my_gravatar"})
-    image_tag.should == valid_image_tag
+    url.must_equal "https://secure.gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88"
   end
 end

data/spec/gravatar_spec.rb

@@ -0,0 +1,79 @@
+require "minitest/spec"
+require "minitest/autorun"
+require "aggravatar"
+
+describe Aggravatar::Gravatar do
+  it "has an email" do
+    email    = "adam@adamtanner.org"
+    gravatar = Aggravatar::Gravatar.new(email)
+
+    gravatar.email.must_equal email
+  end
+
+  it "has a hash of the email" do
+    email    = "adam@adamtanner.org"
+    hash     = "11591979f29ab9c2bb58868232d07b88"
+    gravatar = Aggravatar::Gravatar.new(email)
+
+    gravatar.email_hash.must_equal hash
+  end
+
+  it "builds a Gravatar URL" do
+    email    = "adam@adamtanner.org"
+    gravatar = Aggravatar::Gravatar.new(email)
+
+    gravatar.url.must_equal "http://www.gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88"
+  end
+
+  it "builds a secure Gravatar URL" do
+    email    = "adam@adamtanner.org"
+    gravatar = Aggravatar::Gravatar.new(email)
+
+    gravatar.secure_url.must_equal "https://secure.gravatar.com/avatar/11591979f29ab9c2bb58868232d07b88"
+  end
+
+  it "supports the size option" do
+    email = "adam@adamtanner.org"
+
+    gravatar = Aggravatar::Gravatar.new(email, size: 200)
+
+    gravatar.url.must_match        "?size=200"
+    gravatar.secure_url.must_match "?size=200"
+  end
+
+  it "supports the rating option" do
+    email = "adam@adamtanner.org"
+
+    gravatar = Aggravatar::Gravatar.new(email, rating: "g")
+
+    gravatar.url.must_match        "?rating=g"
+    gravatar.secure_url.must_match "?rating=g"
+  end
+
+  it "supports the default option" do
+    email = "adam@adamtanner.org"
+
+    gravatar = Aggravatar::Gravatar.new(email, default: "404")
+
+    gravatar.url.must_match        "?default=404"
+    gravatar.secure_url.must_match "?default=404"
+  end
+
+  it "supports the default option with URL" do
+    email = "adam@adamtanner.org"
+
+    gravatar = Aggravatar::Gravatar.new(email, default: "http://example.com/me.jpg")
+
+    gravatar.url.must_match        "?default=http%3A%2F%2Fexample.com%2Fme.jpg"
+    gravatar.secure_url.must_match "?default=http%3A%2F%2Fexample.com%2Fme.jpg"
+  end
+
+  it "supports the force default option" do
+    email = "adam@adamtanner.org"
+
+    gravatar = Aggravatar::Gravatar.new(email, force_default: true)
+
+    gravatar.url.must_match        "?forcedefault=y"
+    gravatar.secure_url.must_match "?forcedefault=y"
+  end
+end

metadata

@@ -1,84 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: aggravatar
-version: !ruby/object:Gem::Version 
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Adam Tanner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-09-23 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: You give it an email. It gives you a Gravatar. What more do you want?
-email: adam@adamtanner.org
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies: []
+description: ! ' You give it an email, it gives you a Gravatar URL. What more do you
+  want? '
+email:
+- adam@adamtanner.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .document
 - .gitignore
-- LICENSE
-- README.rdoc
+- Gemfile
+- LICENSE.txt
+- README.md
 - Rakefile
-- VERSION
+- aggravatar.gemspec
 - lib/aggravatar.rb
+- lib/aggravatar/gravatar.rb
+- lib/aggravatar/version.rb
 - spec/aggravatar_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/cxvii/aggravatar
+- spec/gravatar_spec.rb
+homepage: http://github.com/adamtanner/aggravatar
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2729454159932039267
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2729454159932039267
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 2
-summary: Helper method for generating Gravatars.
-test_files: 
+specification_version: 3
+summary: You give it an email, it gives you a Gravatar URL. What more do you want?
+test_files:
 - spec/aggravatar_spec.rb
-- spec/spec_helper.rb
+- spec/gravatar_spec.rb

data/README.rdoc

@@ -1,39 +0,0 @@
-
-= Aggravatar
-
-You give it an email, it gives you a Gravatar. What more do you want?
-
-== How to Use It
-Step 1: First you install it. (Assuming you already have Github sources added.)
-    gem install adamtanner-aggravatar
-
-Step 2: Then you include Aggravatar in your class.
-    require 'aggravatar'
-    include Aggravatar
-
-== How to Use It From Rails
-Step 1: First you install it as a plugin.
-    script/plugin install git://github.com/adamtanner/aggravatar.git
-
-Step 2: Skip to Step 3.
-
-----------------------------
-
-Step 3: Then you ask it for a Gravatar.
-    gravatar_for("email@example.com")
-
-Aggravatar even supports the wide array of options Gravatar gives you!
-    gravatar_for("email@example.com", :size => 80, :default => "/my_default_gravatar.png", :rating => 'g')
-
-I know what you're thinking, and I've already got you covered.
-You're saying, "Hey, what if I need to add a class/title/id/etc to my Gravatar?!"
-
-Well here you go:
-    gravatar_for("email@example.com", :html_attributes => {:class => "gravatar", :id => "my_gravatar", :title => "My Gravatar"}")
-
-You're not limited to just class, title, and id either! You can use any attribute you want! (even ones you make up!)
-
-== Copyright
-
-Copyright (c) 2009 Adam Tanner. See LICENSE for details.
-

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'aggravatar'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end