gravaty 10.0.0 → 11.0.1

data/lib/gravaty.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 #--
 # gravaty
-# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2013 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of gravaty.
 #
@@ -16,6 +20,10 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2013 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 require 'digest/md5'
@@ -35,10 +43,11 @@ require_relative 'gravaty/parsers/secure'
 require_relative 'gravaty/parsers/type'
 
 # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
+# rubocop:disable Style/AsciiComments
 # Copyright:: Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# rubocop:enable Style/AsciiComments
 # License:: GNU General Public License version 3
 module Gravaty
-
   # Creates a new Gravaty described by the user's +email+. Throws a
   # <code>ArgumentError</code> exception if the supplied +email+ address
   # is nil or not valid according to RFC5322.
@@ -55,21 +64,19 @@ module Gravaty
     Gravaty.new email_address, parser
   end
 
-# ------------------------------ here starts the list of private methods
-
-  private
+  # ------------------------------ here starts the list of private methods
 
-# Provides the parameters' parsers object.
+  # Provides the parameters' parsers object.
   def self.parser
-    parsers = {avatar: Parsers::Avatar.new,
-               callback: Parsers::Callback.new,
-               default: Parsers::Default.new,
-               force: Parsers::Force.new,
-               format: Parsers::Format.new,
-               pixelsize: Parsers::Pixelsize.new,
-               rating: Parsers::Rating.new,
-               secure: Parsers::Secure.new,
-               type: Parsers::Type.new}
+    parsers = { avatar: Parsers::Avatar.new,
+                callback: Parsers::Callback.new,
+                default: Parsers::Default.new,
+                force: Parsers::Force.new,
+                format: Parsers::Format.new,
+                pixelsize: Parsers::Pixelsize.new,
+                rating: Parsers::Rating.new,
+                secure: Parsers::Secure.new,
+                type: Parsers::Type.new }
 
     Parser.new parsers
   end

data/lib/gravaty/application.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 #--
 # gravaty
-# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2013 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of gravaty.
 #
@@ -16,6 +20,10 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2013 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 require 'digest'
@@ -29,13 +37,14 @@ require_relative 'utils/rfc5322'
 require_relative 'utils/rpc_connector'
 
 module Gravaty
-
   # This class is a simple API to retrieve an URL with specified options
   # from Gravatar site. It can be used to read data for avatars,
   # profiles or for XML-RPC APi calls. The only needed parameter to
   # create a Gravaty object is the reference +email+ address.
   # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
+  # rubocop:disable Style/AsciiComments
   # Copyright:: Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+  # rubocop:enable Style/AsciiComments
   # License:: GNU General Public License version 3
   class Gravaty
     include Comparable
@@ -66,7 +75,9 @@ module Gravaty
                                      '/locales/', '*.yml')]
 
       raise ArgumentError, I18n.t('error.nil') if email_address.nil?
-      raise ArgumentError, I18n.t('error.invalid', value: email_address) unless Utils::Rfc5322::EMAIL.match email_address # thanks Peter!
+      unless Utils::Rfc5322::EMAIL.match email_address
+        raise ArgumentError, I18n.t('error.invalid', value: email_address)
+      end
 
       @email = email_address.strip.downcase
       @digest = Digest::MD5.hexdigest email
@@ -124,13 +135,13 @@ module Gravaty
         type = args.fetch(:type, nil)
         secure = args.fetch(:secure, secure)
 
-        [:pixelsize, :force, :default, :rating].each do |param|
+        %i[pixelsize force default rating].each do |param|
           array << @parser.parse(param.to_s, args[param]) unless args[param].nil?
         end
       end
 
-      build_uri(secure, true) + digest +
-          @parser.parse('type', type) + build_query_string(array)
+      build_uri(secure: secure) + digest +
+        @parser.parse('type', type) + build_query_string(array)
     end
 
     # See avatar method. This banged version saves the resulting string
@@ -167,15 +178,15 @@ module Gravaty
         format = args[:format].downcase unless args[:format].nil?
         secure = args.fetch(:secure, secure)
 
-        unless (format.nil?) and (PROFILES.include? format)
+        unless format.nil? && (PROFILES.include? format)
           selected = (format == 'json' ? 'callback' : 'pixelsize')
 
           array << @parser.parse(selected, args[selected.to_sym]) unless args[selected.to_sym].nil?
         end
       end
 
-      build_uri(secure, false) + digest +
-          @parser.parse('format', format) + build_query_string(array)
+      build_uri(secure: secure, avatar: false) + digest +
+        @parser.parse(:format, format) + build_query_string(array)
     end
 
     # See profile method. This banged version saves the resulting string
@@ -193,10 +204,12 @@ module Gravaty
     # Params::
     #   - +filename+: [String] is the filename to be saved.
     def download(filename = nil)
-      filename = URI.parse(@gravaty).path.rpartition('/')
-                     .last if filename.nil?
+      if filename.nil?
+        filename = URI.parse(@gravaty).path.rpartition('/')
+                      .last
+      end
       Utils::Downloader::Downloader
-          .download_file @gravaty, filename # thanks Jon!
+        .download_file @gravaty, filename # thanks Jon!
     end
 
     # See profile method. Customized version for QRCode-specific
@@ -292,9 +305,11 @@ module Gravaty
       raise ArgumentError, I18n.t('error.nil') if password.nil?
       raise ArgumentError, I18n.t('error.invalid', value: a_method) unless RPC_METHODS.include? a_method
 
-      @rpc_connector = Utils::RpcConnector::RpcConnector
-                           .new(digest, password) if @rpc_connector.nil?
-      @rpc_connector.call a_method, args unless @rpc_connector.nil?
+      if @rpc_connector.nil?
+        @rpc_connector = Utils::RpcConnector::RpcConnector
+                         .new(digest, password)
+      end
+      @rpc_connector&.call a_method, args
     end
 
     # Returns a JSon object representing the Gravaty object.
@@ -304,8 +319,8 @@ module Gravaty
     #   - <tt>a_json = new_gravaty.to_json</tt>
     # Returns:: a +JSON+ containing the Gravaty object representation
     # with currently saved options and configuration parameters.
-    def to_json
-      result = Hash.new
+    def to_json(*_args)
+      result = {}
       result[email] = digest
 
       result.to_json
@@ -322,8 +337,8 @@ module Gravaty
       @gravaty.to_s
     end
 
-    def <=>(other_gravaty)
-      @email <=> other_gravaty.email
+    def <=>(other)
+      @email <=> other.email
     end
 
     # -------------------------- here starts the list of private methods
@@ -336,18 +351,18 @@ module Gravaty
 
       unless params_array.nil?
         parameters = params_array.reject { |p| p.nil? or p.empty? }
-                         .join('&')
+                                 .join('&')
       end
 
-      return ('?' + parameters) unless parameters.nil? or parameters
-                                                              .empty?
+      return "?#{parameters}" unless parameters.nil? || parameters
+                                     .empty?
+
       ''
     end
 
     # Return the basic URI structure according to type and security.
-    def build_uri(secure = false, avatar = true)
-      @parser.parse('secure', secure) + '.gravatar.com/' +
-          @parser.parse('avatar', avatar)
+    def build_uri(secure: false, avatar: true)
+      "#{@parser.parse('secure', secure)}.gravatar.com/#{@parser.parse('avatar', avatar)}"
     end
   end
 end

data/lib/gravaty/constants.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 #--
 # gravaty
-# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2013 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of gravaty.
 #
@@ -16,6 +20,10 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2013 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 module Gravaty
@@ -25,37 +33,38 @@ module Gravaty
 
   # Allowed parameters names. Currently: avatar, callback, default,
   # force, format, pixelsize, rating, secure and type.
-  ALLOWED_PARAMS = [:avatar, :callback, :default, :force, :format,
-                    :pixelsize, :rating, :secure, :type]
+  ALLOWED_PARAMS = %i[avatar callback default force format
+                      pixelsize rating secure type].freeze
 
   # Allowed formats (extensions) for avatar requests. Currently:
   # jp(e)g, png and gif.
-  AVATAR_FORMATS = %w(jpg jpeg png gif)
+  AVATAR_FORMATS = %w[jpg jpeg png gif].freeze
 
   # Currently allowed default builtin options. Currently: 404, mp,
   # identicon, monsterid,wavatar, retro, robohash and blank.
-  DEFAULT_OPTIONS = %w(404 mp identicon monsterid wavatar retro robohash blank)
+  DEFAULT_OPTIONS = %w[404 mp identicon monsterid wavatar retro robohash blank].freeze
 
   # Allowed formats (extensions) for default own images. Currently:
   # jp(e)g, png and gif.
-  IMAGES_FORMATS = %w(jpg jpeg png gif)
+  IMAGES_FORMATS = %w[jpg jpeg png gif].freeze
 
   # Allowed formats (extensions) for profile requests. Currently: json,
   # xml, php, vcf and qr.
-  PROFILE_FORMATS = %w(json xml php vcf qr)
+  PROFILE_FORMATS = %w[json xml php vcf qr].freeze
 
   # Formats allowing supplemental options for profile requests.
   # Currently json and qr.
-  PROFILES = %w(json qr)
+  PROFILES = %w[json qr].freeze
 
   # Allowed rating options. Currently: g, pg, r and x.
-  RATING_OPTIONS = %w(g pg r x)
+  RATING_OPTIONS = %w[g pg r x].freeze
 
   # Possible XML-RPC API errors.
-  RPC_ERRORS = [-7, -8, -9, -10, -11, -100]
+  RPC_ERRORS = [-7, -8, -9, -10, -11, -100].freeze
 
   # Allowed XML-RPC API methods.
-  RPC_METHODS = %w(grav.exists grav.addresses grav.userimages grav.saveData grav.saveUrl grav.useUserimage grav.removeImage grav.deleteUserimage grav.test)
+  RPC_METHODS = %w[grav.exists grav.addresses grav.userimages grav.saveData grav.saveUrl grav.useUserimage
+                   grav.removeImage grav.deleteUserimage grav.test].freeze
 
   # Default test method for XML-RPC API.
   RPC_TEST_METHOD = 'grav.test'

data/lib/gravaty/locales/en.yml

@@ -1,5 +1,8 @@
+#--
 # gravaty
-# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2013 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of gravaty.
 #
@@ -15,6 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2013 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 en:
   error:
@@ -26,8 +34,6 @@ en:
     value: "Value '%{value}' is not in allowed range."
   warn:
     deprecated: This method has been deprecated.
-  test:
-    test: test data
   gravatar:
     errors:
       -7: Use secure.gravatar.com

data/lib/gravaty/locales/it.yml

@@ -1,5 +1,8 @@
+#--
 # gravaty
-# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2013 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of gravaty.
 #
@@ -15,6 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2013 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 it:
   error:
@@ -26,8 +34,6 @@ it:
     value: "Il valore '%{value}' non è nell'intervallo previsto."
   warn:
     deprecated: Questo metodo è obsoleto.
-  test:
-    test: dato di prova
   gravatar:
     errors:
       -7: Utilizzare secure.gravatar.com

data/lib/gravaty/locales/ja.yml

@@ -1,6 +1,6 @@
+#--
 # gravaty
-# Copyright © 2013  新部裕
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019, 2020  新部裕, Marco Bresciani
+# © 2013 新部裕, Marco Bresciani
 #
 # This file is part of gravaty.
 #
@@ -16,6 +16,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2013 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 ja:
   error:
@@ -27,8 +32,6 @@ ja:
     value: "値 '%{value}' が範囲外です。"
   warn:
     deprecated: このメソッドはすでに廃止され、推奨されていません。
-  test:
-    test: 試験データ
   gravatar:
     errors:
       -7: secure.gravatar.com を使用

data/lib/gravaty/parser.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 #--
 # gravaty
-# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2013 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of gravaty.
 #
@@ -16,34 +20,36 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2013 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 require_relative 'constants'
 
 module Gravaty
-
   # This class is a simple utility that is used to parse and filter
   # parameters for gravaty.
   #
   # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
+  # rubocop:disable Style/AsciiComments
   # Copyright:: Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020  Marco Bresciani
+  # rubocop:enable Style/AsciiComments
   # License:: GNU General Public License version 3
   class Parser
     attr_reader :parsers
 
     def initialize(args = {})
-      @parsers = Hash.new
-      ALLOWED_PARAMS.each do |param|
-        parsers[param] = args[param]
-      end unless args.nil?
+      @parsers = {}
+      ALLOWED_PARAMS.each { |param| parsers[param] = args[param] } unless args.nil?
     end
 
     # Provides the duck type for a generic parsing object.
-    def parse(method = nil, value = nil)
+    def parse(method = nil, params = nil)
       a_parser = nil
-      a_parser = parsers[method.to_sym] unless method.nil? or
-          parsers.nil?
-      a_parser.parse value unless a_parser.nil?
+      a_parser = parsers[method.to_sym] unless method.nil? || parsers.nil?
+      a_parser&.parse params
     end
   end
 end