gravatar_for 0.0.2.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dbc8687ccdbec30614272a95d406db002a274cf
-  data.tar.gz: c27fc86d9b1f9d43a86eebd244489202a5c24cb7
+  metadata.gz: ffdc8512a1ff13176db89b4d32ec52abf3df3906
+  data.tar.gz: 53e58c70ce9bc9005750b2afa49ab487faf131d6
 SHA512:
-  metadata.gz: 3ff948066e5f6be8c6d969edcb79b3bc4beb37e9e7f7c4a06a3de11fa34f806735207cf695a85653b887940bfb24e2feae801e9e35777347d540e8c26522beac
-  data.tar.gz: 342bf6c1562089896fcfb9b763a32cd0798d3254a9802c84b4f5a6d9c12757fc34da3d548b928581028f2c9deaee925b9c9e2b5e1699be84d19fda96f9ae2da8
+  metadata.gz: cd74cc355f5e6005589ef3261414fcb807354d701fd6813b53918fecc16fe79094317aaae36427485d6ecbed31405ae1de8d99490285a7d6177b086d4ce54d6a
+  data.tar.gz: b01532d550544c0fe915aab02a3104304e3dd4d3446cbc1e1edf1105015fbd1551370ef130fdf3fb2a132fb14ed8eaef4949621628813a9e4ffea3b2cabdeaae

data/README.md

@@ -0,0 +1,17 @@
+## gravatar_for
+
+Simple Rails view helper for getting Gravatar images.
+
+Install
+
+```zsh
+gem install gravatar_for
+```
+
+Basic usage
+```erb
+<%= gravatar_for('user@example.com', class: 'gravatar') =>
+```
+
+Please check the documentation or read the source to what all can be applied
+with this call.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/gravatar_for.gemspec

@@ -1,12 +1,17 @@
+lib_directory = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib_directory) unless $LOAD_PATH.include?(lib_directory)
+require 'gravatar_for/version'
+
 Gem::Specification.new do |s|
-  s.name = 'gravatar_for'
-  s.version = '0.0.2.pre'
-  s.date    = '2014-04-09'
-  s.summary = 'A simple Gravatar view helper.'
-  s.description = 'gravatar_for is a simple, but capable Gravatar view helper.'
-  s.authors = 'Daniel Seitz'
-  s.email = 'daniel.e.seitz@gmail.com'
-  s.homepage = 'http://github.com/s3itz/gravatar_for'
-  s.files = `git ls-files`.split($/)
-  s.license = 'MIT'
+  s.name          = 'gravatar_for'
+  s.version       = GravatarFor::VERSION
+  s.summary       = 'A simple Gravatar view helper.'
+  s.description   = 'gravatar_for is a simple, but capable Gravatar view helper.'
+  s.authors       = 'Daniel Seitz'
+  s.email         = 'daniel.e.seitz@gmail.com'
+  s.homepage      = 'http://github.com/s3itz/gravatar_for'
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = `git ls-files ./test`.split
+  s.license       = 'MIT'
+  s.require_paths = ['lib']
 end

data/lib/gravatar_for/gravatar_for.rb

@@ -1,7 +1,58 @@
 module GravatarFor
+  GRAVATAR_BASE_URL = 'http://www.gravatar.com/avatar/'
+  GRAVATAR_SECURE_BASE_URL = GRAVATAR_BASE_URL.gsub('://www', 's://secure')
+
   module ViewHelpers
-    def test
-      'This confirms this is working'
+    # Returns an HTML5 image tag to the Gravatar image for +email+.
+    #
+    # #### Options
+    #
+    # You can add HTML attributes and modify Gravatar results using the
+    # +options+
+    #
+    # * <tt>:size</tt>    - If no size is given; Gravatar's default
+    #   of 80px by 80px is used.
+    # * <tt>:default</tt> - The default URL for an image to display if the
+    #   email has no Gravatar image. By default, Gravatar returns its logo if
+    #   there is no image to reference. To cover all basis, you can use the
+    #   following symbols to use some of Gravtar's other options:
+    #     * :mm        - Mystery Man
+    #     * :identicon - A geometric pattern based on an email has
+    #     * :monsterid - A generated monster
+    #     * :wavatar   - Computer generated faces
+    #     * :retro     - 8-bit generated arcade-styled face
+    #     * :blank     - A transparent PNG image
+    #     * 404        - HTTP 404 response (File Not Found)
+    # * <tt>:rating</tt> - Rating to request, either :g or 'g' (default);
+    #   :pg or 'pg'; :r or 'r'; :x or 'x'
+    # * <tt>:forcedefault</tt> - Force default image, default: false
+    # * <tt>:alt</tt> - Override the HTML alternate text attribute. By default
+    #   the email provided will be placed into this attribute.
+    # * <tt>:ssl</tt> - Use regular or secure URL, default +false+
+    # * Any additional +options+ will be passed to
+    #   ActionView::Helpers::TagHelper::tag
+    def gravatar_for(email, options = {})
+      raise ArgumentError, 'Email must be provided' unless email && !email.strip.empty?
+
+      base_url = options[:ssl]? GRAVATAR_SECURE_BASE_URL : GRAVATAR_BASE_URL
+      options.delete(:ssl) if options.has_key?(:ssh)
+
+      options[:alt] ||= email
+
+      query = ''
+      [:size, :default, :rating, :forcedefault].each do |key|
+        if options.has_key?(key)
+          query << query.empty? ? '?' : '&'
+          query << "#{key}=#{options.delete(key)}"
+        end
+      end
+
+      src = base_url + Digest::MD5.hexdigest(email)
+      src << query unless query.empty?
+
+      options[:src] = src
+
+      tag('img', options, true)
     end
   end
 end

data/lib/gravatar_for/version.rb

@@ -0,0 +1,8 @@
+module GravatarFor
+  module Version
+    MAJOR, MINOR, PATCH = 0, 1, 0
+    JOINED = [MAJOR, MINOR, PATCH].join('.')
+  end
+
+  VERSION = Version::JOINED
+end

data/test/test_gravatar_for.rb

@@ -0,0 +1,22 @@
+require 'minitest/autorun'
+require 'digest/md5'
+require 'gravatar_for'
+require 'action_view'
+
+include ActionView::Helpers::TagHelper
+include GravatarFor
+include ViewHelpers
+
+class GravatarForTest < MiniTest::Test
+  BASE_URL = GravatarFor::GRAVATAR_BASE_URL
+
+  def setup
+    @email = 'user@aol.com'
+    @email_hash = Digest::MD5.hexdigest(@email)
+    @response = "<img alt=\"#{@email}\" src=\"#{BASE_URL}#{@email_hash}\">"
+  end
+
+  def test_generate_image_tag
+    assert_equal gravatar_for(@email), @response
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gravatar_for
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Seitz
@@ -17,10 +17,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- README.md
+- Rakefile
 - gravatar_for.gemspec
 - lib/gravatar_for.rb
 - lib/gravatar_for/gravatar_for.rb
 - lib/gravatar_for/railtie.rb
+- lib/gravatar_for/version.rb
+- test/test_gravatar_for.rb
 homepage: http://github.com/s3itz/gravatar_for
 licenses:
 - MIT
@@ -36,13 +40,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple Gravatar view helper.
-test_files: []
+test_files:
+- test/test_gravatar_for.rb