vishnu 1.2.2 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3c3ac27d6595188485f30fd8e19b94f4366efa9
-  data.tar.gz: 6a8e3d5cc7217a1f6e7fbea35941af2ae925f99e
+SHA256:
+  metadata.gz: 39c384bc0a95bcbf579da3f0b6b67c0c2373f7ab22131e11c22411201eff6e97
+  data.tar.gz: 48582e1db8a8fce83385ad8df1dedd84857dbc6003d4d4ca8de056fbe5503209
 SHA512:
-  metadata.gz: 90d6bcf8cae62e3037b0920826ec39184b6cdbaa64bfb5b5e1bb7f8ae24a2a55356170ba45d1060757d50d050706902e5defc57fb2e7df218f7427e539266c12
-  data.tar.gz: 9fa0491431764f3fe25aadb020c9d66b0b9a0229b319f33a8f6e09670869c43c40cb16875dd5d9a1044e06810ab8ef8c4fd023abc98420c6bebb3d83b42db49a
+  metadata.gz: 75b4cc8561a2cb4b11f8c1d33c20fba40cb987bb9424d2bb9146005a175306bb4f9d6cb212c6659137e388b67228f1dcee8945be05afb6096f8224a5fe459624
+  data.tar.gz: f3ac061ca1e38ab6013b87db04f2c7f09d18cc0ecd9210e998b7aaf46634fe4e52ec83b96797cc04f6bc732925fc9f6e7fc4715191423db6e3daa5956646a3a8

data/lib/libravatar.rb

@@ -1,3 +1,6 @@
+# enable compatibility between Vishnu and Libravatar
+# and allow require 'libravatar' to work
+
 require 'vishnu'
 
-class Libravatar < Vishnu; end
+Libravatar = Vishnu

data/lib/vishnu/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Vishnu
+  VERSION = '2.0.1'
+end

data/lib/vishnu.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
 #
-# The Libravatar class generates the avatar URL provided by the libravatar
-# web service at http://www.libravatar.org
+# The Vishnu class generates the avatar URL provided by the libravatar
+# web service at https://www.libravatar.org
 #
 # Users may associate their avatar images with multiple OpenIDs and Emails.
-#  
-# Author:: Kang-min Liu (http://gugod.org)
+#
+# Original Author:: Kang-min Liu (http://gugod.org/)
+# Fork Author:: Anton Smirnov (https://sandfox.me/)
 # Copyright:: Copyright (c) 2011 Kang-min Liu
 # License:: MIT
-# Contributors:: https://github.com/gugod/libravatar/contributors
+# Contributors:: https://github.com/sandfoxme/vishnu/graphs/contributors
 #
 
+require 'vishnu/version'
+
 require 'digest/md5'
 require 'digest/sha2'
 require 'uri'
@@ -20,7 +24,7 @@ class Vishnu
 
   # The options should contain :email or :openid values.  If both are
   # given, email will be used. The value of openid and email will be
-  # normalized by the rule described in http://www.libravatar.org/api
+  # normalized by the rule described in https://wiki.libravatar.org/api/
   #
   # List of option keys:
   #
@@ -28,101 +32,131 @@ class Vishnu
   # - :openid
   # - :size An integer ranged 1 - 512, default is 80.
   # - :https Set to true to serve avatars over SSL
-  # - :default URL to redirect missing avatars to, or one of these specials: "404", "mm", "identicon", "monsterid", "wavatar", "retro"
+  # - :default URL to redirect missing avatars to, or one of these specials:
+  #   "404", "mm", "identicon", "monsterid", "wavatar", "retro"
   #
-  def initialize(options = {})
-    @email   = options[:email]
-    @openid  = options[:openid]
-    @size    = options[:size]
-    @default = options[:default]
-    @https   = options[:https]
+  def initialize(email: nil, openid: nil, size: nil, default: nil, https: nil)
+    @email   = email
+    @openid  = openid
+    @size    = size
+    @default = default
+    @https   = https
   end
 
-  def get_target_domain
-    return @email.split('@')[1] if @email
-    return URI.parse(@openid).host
+  # All the values which are different between HTTP and HTTPS methods.
+  PROFILES = {
+    http: {
+      scheme: 'http://',
+      host:   'cdn.libravatar.org',
+      srv:    '_avatars._tcp.',
+      port:   80,
+    }.freeze,
+    https: {
+      scheme: 'https://',
+      host:   'seccdn.libravatar.org',
+      srv:    '_avatars-sec._tcp.',
+      port:   443,
+    }.freeze
+  }.freeze
+
+  # Generate the libravatar URL
+  def url
+    id =
+      if @email
+        Digest::MD5.hexdigest(normalize_email(@email))
+      else
+        Digest::SHA2.hexdigest(normalize_openid(@openid))
+      end
+
+    size    = "s=#{@size}"    if @size
+    default = "d=#{@default}" if @default
+
+    # noinspection RubyScope
+    # ok for them to be nil
+    query = [size, default].reject(&:!).join('&')
+    query = "?#{query}" unless query == ''
+
+    base_url = get_base_url + '/avatar/'
+
+    base_url + id + query
   end
 
-  # All the values which are different between HTTP and HTTPS methods.
-  @@profiles = [
-    { :scheme => 'http://',
-      :host => 'cdn.libravatar.org',
-      :srv => '_avatars._tcp.',
-      :port => 80 },
-    { :scheme => 'https://',
-      :host => 'seccdn.libravatar.org',
-      :srv => '_avatars-sec._tcp.',
-      :port => 443 }
-    ]
+  alias_method :to_s, :url
+
+  private
+
+  def profile
+    PROFILES[@https ? :https : :http]
+  end
+
+  def get_target_domain
+    if @email
+      @email.split('@')[1]
+    else
+      URI.parse(@openid).host
+    end
+  end
 
   # Grab the DNS SRV records associated with the target domain,
   # and choose one according to RFC2782.
   def srv_lookup
-    profile = @@profiles[ @https ? 1 : 0 ]
-    Resolv::DNS::open do |dns|
-      rrs = dns.getresources(profile[:srv] + get_target_domain(),
-        Resolv::DNS::Resource::IN::SRV).to_a
-      return [nil, nil] unless rrs.any?
+    Resolv::DNS.open do |dns|
+      resources = dns.getresources(
+        profile[:srv] + get_target_domain,
+        Resolv::DNS::Resource::IN::SRV
+      ).to_a
 
+      return [nil, nil] unless resources.any?
 
-      min_priority = rrs.map{ |r| r.priority }.min
-      rrs.delete_if{ |r| r.priority != min_priority }
+      min_priority = resources.map(&:priority).min
+      resources.delete_if { |r| r.priority != min_priority }
 
-      weight_sum = rrs.inject(0) { |a,r| a+r.weight }.to_f
+      weight_sum = resources.inject(0) { |sum, r| sum + r.weight }.to_f
 
-      r = rrs.max_by { |r| r.weight == 0 ? 0 : rand ** (weight_sum / r.weight) }
+      resource = resources.max_by do |r|
+        if r.weight == 0
+          0
+        else
+          rand**(weight_sum / r.weight)
+        end
+      end
 
-      return [r.target, r.port]
+      return sanitize_srv_lookup(resource.target.to_s, resource.port)
     end
   end
 
   def get_base_url
-    profile = @@profiles[ @https ? 1 : 0 ]
     target, port = srv_lookup
 
-    if (target && port) 
+    if target && port
       port_fragment = port != profile[:port] ? ':' + port.to_s : ''
-      return profile[:scheme] + target.to_s + port_fragment
-    else
-      return profile[:scheme] + profile[:host]
-    end
-  end
-
-  # Generate the libravatar URL
-  def to_s
-    if @email
-      @email.downcase!
-      id = Digest::MD5.hexdigest(@email)
+      profile[:scheme] + target.to_s + port_fragment
     else
-      id = Digest::SHA2.hexdigest(normalize_openid(@openid))
+      profile[:scheme] + profile[:host]
     end
-    s  = @size ? "s=#{@size}" : nil
-    d  = @default ? "d=#{@default}" : nil
-
-    query = [s,d].reject{|x|!x}.join("&")
-    query = "?#{query}" unless query == ""
-    baseurl = get_base_url() + '/avatar/'
-    return baseurl + id + query
   end
 
-  private
-
   def sanitize_srv_lookup(hostname, port)
-    unless hostname.match(/^[0-9a-zA-Z\-.]+$/) && 1 <= port && port <= 65535
+    unless hostname.match(/^[0-9a-zA-Z\-.]+$/) && 1 <= port && port <= 65_535
       return [nil, nil]
     end
 
-    return [hostname, port]
+    [hostname, port]
+  end
+
+  def normalize_email(email)
+    email.downcase
   end
 
   # Normalize an openid URL following the description on libravatar.org
-  def normalize_openid(s)
-    x = URI.parse(s)
-    x.host.downcase!
-    x.scheme = x.scheme.downcase
-    if (x.path == "" && x.fragment == nil)
-      x.path = "/"
+  def normalize_openid(url)
+    parsed_url = URI.parse(url)
+    parsed_url.host   = parsed_url.host.downcase
+    parsed_url.scheme = parsed_url.scheme.downcase
+    if parsed_url.path == '' && parsed_url.fragment.nil?
+      parsed_url.path = '/'
     end
-    return x.to_s
+
+    parsed_url.to_s
   end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: vishnu
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.1
 platform: ruby
 authors:
 - Anton Smirnov
 - Kang-min Liu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2023-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,35 +26,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 1.2.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 1.2.3
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.7.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.7.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,33 +53,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: libravatar.org provides avatar image hosting (like gravatar.com). Their
-  users may associate avatar images with email or openid. This rubygem can be used
-  to generate libravatar avatar image URL
-email: sandfox@sandfox.me
+description: |
+  Libravatar provides avatar image hosting (like gravatar.com).
+  Their users may associate avatar images with email or openid.
+  This rubygem can be used to generate Libravatar image URL
+email: sandfox+gem@sandfox.me
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
 files:
-- ".document"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
-- README.rdoc
-- Rakefile
-- VERSION
 - lib/libravatar.rb
 - lib/vishnu.rb
-- test/helper.rb
-- test/test_libravatar.rb
-- vishnu.gemspec
-homepage: http://github.com/sandfoxme/vishnu
+- lib/vishnu/version.rb
+homepage: https://sandfox.dev/ruby/vishnu.html
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,16 +77,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: Avatar URL Generation wih libravatar.org
+summary: Avatar URL Generation with libravatar.org
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.2.0

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-group :development do
-  gem 'jeweler'
-  gem 'shoulda', '> 1.2.3'
-  gem 'minitest', '4.7.5'
-  gem 'test-unit'
-end
-

data/LICENSE.txt

@@ -1,22 +0,0 @@
-The MIT License
-
-Copyright (c) 2011 Kang-min Liu
-
-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 without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-

data/README.rdoc

@@ -1,20 +0,0 @@
-= libravatar
-
-http://libravatar.org is an avatar service to let their users associate avatar images
-with their emails or openids. This rubygem generates their avatar URL.
-
-== Contributing to libravatar
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* 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
-
-Copyright (c) 2011 Kang-min Liu. See LICENSE.txt for
-further details.
-

data/Rakefile

@@ -1,39 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "vishnu"
-  gem.homepage = "http://github.com/sandfoxme/vishnu"
-  gem.license = "MIT"
-  gem.summary = %Q{Avatar URL Generation wih libravatar.org}
-  gem.description = %Q{libravatar.org provides avatar image hosting (like gravatar.com). Their users may associate avatar images with email or openid. This rubygem can be used to generate libravatar avatar image URL}
-  gem.email = "sandfox@sandfox.me"
-  gem.authors = ['Anton Smirnov', "Kang-min Liu"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  # gem.add_runtime_dependency 'digest/sha2', '> 0.1'
-  # gem.add_runtime_dependency 'uri', '> 0.1'
-  # gem.add_development_dependency 'shoulda', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "vishnu #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-1.2.2

data/test/helper.rb

@@ -1,11 +0,0 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'libravatar'
-
-class Test::Unit::TestCase
-end

data/test/test_libravatar.rb

@@ -1,50 +0,0 @@
-require 'helper'
-
-class TestLibravatar < Test::Unit::TestCase
-  should "Generate url from email" do
-    # echo -n "user@example.com"|md5sum
-    # => b58996c504c5638798eb6b511e6f49af
-    avatar = Libravatar.new(:email => "user@example.com")
-
-    re = /http:\/\/.+\/avatar\/b58996c504c5638798eb6b511e6f49af$/
-    assert avatar.to_s.match(re)
-    assert Libravatar.new(:email => "USER@ExAmPlE.CoM").to_s.match(re)
-
-    assert_equal Libravatar.new(:email => "user@example.com", :https => true).to_s[0,8], "https://"
-    assert_equal Libravatar.new(:email => "user@example.com", :https => false).to_s[0,7], "http://"
-
-    assert Libravatar.new(:email => "USER@ExAmPlE.CoM", :default => "http://example.com/avatar.png").to_s.match(/http:\/\/.+\/avatar\/b58996c504c5638798eb6b511e6f49af\?d=http:\/\/example\.com\/avatar\.png/)
-
-    assert_equal Libravatar.new(:email => "USER@ExAmPlE.CoM", :size => 512, :default => "mm").to_s[-43,43], "b58996c504c5638798eb6b511e6f49af?s=512&d=mm"
-  end
-
-  should "Generate url from openid" do
-    # echo -n "http://example.com/id/Bob"|shasum -a 256
-    # => 80cd0679bb52beac4d5d388c163016dbc5d3f30c262a4f539564236ca9d49ccd
-    avatar = Libravatar.new(:openid => "http://example.com/id/Bob")
-    assert_equal avatar.to_s, "http://cdn.libravatar.org/avatar/80cd0679bb52beac4d5d388c163016dbc5d3f30c262a4f539564236ca9d49ccd"
-
-    avatar = Libravatar.new(:openid => "hTTp://EXAMPLE.COM/id/Bob")
-    assert_equal avatar.to_s, "http://cdn.libravatar.org/avatar/80cd0679bb52beac4d5d388c163016dbc5d3f30c262a4f539564236ca9d49ccd"
-
-    avatar = Libravatar.new(:openid => "hTTp://EXAMPLE.COM/id/Bob", :size => 512)
-    assert_equal avatar.to_s, "http://cdn.libravatar.org/avatar/80cd0679bb52beac4d5d388c163016dbc5d3f30c262a4f539564236ca9d49ccd?s=512"
-  end
-
-  should "Normalize OpenID" do
-    x = Libravatar.new
-    assert_equal x.send(:normalize_openid, "HTTP://EXAMPLE.COM/id/Bob"), "http://example.com/id/Bob"
-    assert_equal x.send(:normalize_openid, "HTTP://EXAMPLE.COM"), "http://example.com/"
-  end
-
-  should "Return the federated URI" do
-    avatar = Libravatar.new(:email => 'invalid@catalyst.net.nz')
-    assert avatar.to_s.match(/http:\/\/.+\/avatar\/f924d1e9f2c10ee9efa7acdd16484c2f$/)
-  end
-
-  should "Sanitize the SRV lookup result" do
-    avatar = Libravatar.new
-    assert_equal ["hosntame.abcde.fghi.com", 12345], avatar.send(:sanitize_srv_lookup, "hosntame.abcde.fghi.com", 12345)
-    assert_equal [nil, nil], avatar.send(:sanitize_srv_lookup, "FNORD IMPUNTK *#(*$#&", 65348283)
-  end
-end

data/vishnu.gemspec

@@ -1,61 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: vishnu 1.2.2 ruby lib
-
-Gem::Specification.new do |s|
-  s.name = "vishnu"
-  s.version = "1.2.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Anton Smirnov", "Kang-min Liu"]
-  s.date = "2016-06-20"
-  s.description = "libravatar.org provides avatar image hosting (like gravatar.com). Their users may associate avatar images with email or openid. This rubygem can be used to generate libravatar avatar image URL"
-  s.email = "sandfox@sandfox.me"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    ".travis.yml",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/libravatar.rb",
-    "lib/vishnu.rb",
-    "test/helper.rb",
-    "test/test_libravatar.rb",
-    "vishnu.gemspec"
-  ]
-  s.homepage = "http://github.com/sandfoxme/vishnu"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "Avatar URL Generation wih libravatar.org"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, ["> 1.2.3"])
-      s.add_development_dependency(%q<minitest>, ["= 4.7.5"])
-      s.add_development_dependency(%q<test-unit>, [">= 0"])
-    else
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<shoulda>, ["> 1.2.3"])
-      s.add_dependency(%q<minitest>, ["= 4.7.5"])
-      s.add_dependency(%q<test-unit>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<shoulda>, ["> 1.2.3"])
-    s.add_dependency(%q<minitest>, ["= 4.7.5"])
-    s.add_dependency(%q<test-unit>, [">= 0"])
-  end
-end
-