gravaty 10.0.0 → 11.0.1

data/lib/gravaty/parsers/avatar.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,20 +20,24 @@
 #
 # 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
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # checks for avater or profile URI. The only needed parameter is a
     # boolean, with +true+ for avatar.
     #
     # 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 Avatar
-
       # The parsable duck type interface to every parser usage.
       def parse(value = true)
         value ? 'avatar/' : ''

data/lib/gravaty/parsers/callback.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,23 +20,28 @@
 #
 # 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
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # provides the callback name. The only needed parameter is a valid
     # callback +String+ name.
     #
     # 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 Callback
-
       # The parsable duck type interface to every parser usage.
       def parse(value = nil)
-        return "callback=#{value}" unless value.nil? or value.empty?
+        return "callback=#{value}" unless value.nil? || value.empty?
+
         ''
       end
     end

data/lib/gravaty/parsers/default.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 'cgi'
@@ -24,26 +32,26 @@ require_relative '../constants'
 
 module Gravaty
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # checks the default option. The only needed parameter is a valid
     # default option.
     #
     # 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 Default
-
       # The parsable duck type interface to every parser usage.
       def parse(value = nil)
-        unless value.nil? or value.empty?
+        unless value.nil? || value.empty?
           unless DEFAULT_OPTIONS.include? value
-            valid = %w(http https).index { |scheme| valid?(value, scheme) }
+            valid = %w[http https].index { |scheme| valid?(value, scheme) }
 
             raise ArgumentError, I18n.t('error.uri', value: value) if valid.nil?
           end
 
-          return 'd=' + CGI::escape(value).to_s
+          return "d=#{CGI.escape(value)}"
         end
         ''
       end
@@ -65,23 +73,23 @@ module Gravaty
         begin
           an_uri = parser.parse an_uri[0]
 
-          #See URI validation rules at
+          # See URI validation rules at
           # http://en.gravatar.com/site/implement/images/#default-image
 
-          #rule 2
-          return false if (an_uri.scheme == 'http') and
-              (an_uri.port != Net::HTTP.http_default_port)
-          return false if (an_uri.scheme == 'https') and
-              (an_uri.port != Net::HTTP.https_default_port)
+          # rule 2
+          return false if (an_uri.scheme == 'http') &&
+                          (an_uri.port != Net::HTTP.http_default_port)
+          return false if (an_uri.scheme == 'https') &&
+                          (an_uri.port != Net::HTTP.https_default_port)
 
-          #rule 3
+          # rule 3
           allowed = IMAGES_FORMATS
-                        .index { |format| an_uri.path.end_with? format }
+                    .index { |format| an_uri.path.end_with? format }
           return false if allowed.nil?
 
-          #rule 4
+          # rule 4
           return false unless an_uri.query.nil?
-        rescue
+        rescue StandardError
           return false
         end
         true

data/lib/gravaty/parsers/force.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,22 +20,28 @@
 #
 # 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
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # checks forces the default value. The only needed parameter is a
     # boolean, with +true+ for forced.
     #
     # 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 Force
       # The parsable duck type interface to every parser usage.
       def parse(value = false)
         return 'f=y' if value
+
         ''
       end
     end

data/lib/gravaty/parsers/format.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_relative '../constants'
@@ -23,13 +31,14 @@ require_relative '../utils/raisers'
 
 module Gravaty
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # checks the profile type. The only needed parameter is a valid
     # profile format.
     #
     # 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 Format
       include Utils::Raisers

data/lib/gravaty/parsers/pixelsize.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_relative '../constants'
@@ -23,13 +31,14 @@ require_relative '../utils/raisers'
 
 module Gravaty
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # checks the image size. The only needed parameter is a valid image
     # size.
     #
     # 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 Pixelsize
       include Utils::Raisers
@@ -37,7 +46,7 @@ module Gravaty
       # The parsable duck type interface to every parser usage.
       def parse(value = nil)
         raiser_to_i('error.value', value, ALLOWED_SIZES)
-        value.nil? ? '' : "s=#{value.to_s}"
+        value.nil? ? '' : "s=#{value}"
       end
     end
   end

data/lib/gravaty/parsers/rating.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_relative '../constants'
@@ -23,13 +31,14 @@ require_relative '../utils/raisers'
 
 module Gravaty
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # checks the rating type. The only needed parameter is a valid
     # rating 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
     class Rating
       include Utils::Raisers
@@ -37,7 +46,7 @@ module Gravaty
       # the parsable duck type interface to every parser usage.
       def parse(value = nil)
         raiser_downcase('error.value', value, RATING_OPTIONS)
-        value.nil? ? '' : "rating=#{value.downcase.to_s}"
+        value.nil? ? '' : "rating=#{value.downcase}"
       end
     end
   end

data/lib/gravaty/parsers/secure.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,17 +20,22 @@
 #
 # 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
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # provides the secure or unsecure URI. The only needed parameter is
     # a boolean, with +true+ for secure.
     #
     # 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 Secure
       # The parsable duck type interface to every parser usage.

data/lib/gravaty/parsers/type.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_relative '../constants'
@@ -23,13 +31,14 @@ require_relative '../utils/raisers'
 
 module Gravaty
   module Parsers
-
     # This class is an implementation of the Parsable duck type that
     # checks the avatar type. The only needed parameter is a valid
     # avatar format.
     #
     # 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 Type
       include Utils::Raisers

data/lib/gravaty/utils/downloader.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
+# © 2012 Jon Maken
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of gravaty.
 #
@@ -16,11 +20,14 @@
 #
 # 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: 2012 Jon Maken
+#
+# SPDX-License-Identifier: BSD-3-Clause
 #++
 
 module Gravaty
   module Utils
-
     # This module is a simple wrapper container for Peter R. Marreck's
     # gist.
     #
@@ -28,14 +35,13 @@ module Gravaty
     # License:: 3-clause BSD
     # Revision:: 2012-03-25 23:01:19 -0600
     module Downloader
-
       require 'net/http'
       require 'net/ftp'
       require 'openssl'
       require 'fileutils'
       require 'tempfile'
 
-      #!/usr/bin/env ruby
+      # !/usr/bin/env ruby
       #
       # An HTTP/HTTPS/FTP file downloader library/CLI based upon
       # MiniPortile's HTTP implementation.
@@ -44,113 +50,109 @@ module Gravaty
       # License:: 3-clause BSD
       # Revision:: 2012-03-25 23:01:19 -0600
       class Downloader
-
         VERSION = '0.1.0'
 
         class << self
           attr_accessor :logger, :max_ca_verify_depth, :ftp_data_chunk_size
         end
 
-        @logger = STDOUT.binmode
+        @logger = $stdout.binmode
         @max_ca_verify_depth = 5
         @ftp_data_chunk_size = 8192
 
-
         def self.download_file(url, full_path, count = 3)
-          raise RuntimeError, I18n.t('error.nil') if url.nil?
+          raise I18n.t('error.nil') if url.nil?
           return if File.exist?(full_path)
 
           http_download(url, full_path, count)
         end
 
-        private
-
-        def self.message(text)
-          @logger.print text
-          @logger.flush
-        end
-
-        def self.output(text = '')
-          @logger.puts text
-          @logger.flush
-        end
-
-        def self.http_download(url, full_path, count)
-          uri = URI.parse(url)
-
-          begin
-            filename = File.basename(uri.path)
-
-            if ENV['HTTP_PROXY']
-              #protocol,
-              userinfo, proxy_host, proxy_port = URI::split(ENV['HTTP_PROXY'])
-              proxy_user, proxy_pass = userinfo.split(/:/) if userinfo
-              http = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_pass)
-            else
-              http = Net::HTTP.new(uri.host, uri.port)
-            end
-
-            if uri.scheme.downcase == 'https'
-              http.use_ssl = true
-              if ENV['SSL_CERT_FILE']
-                cert_file = ENV['SSL_CERT_FILE'].dup
-                cert_file.gsub!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
-              end
-              if cert_file && File.exist?(cert_file)
-                http.ca_file = cert_file
-                http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-                http.verify_depth = @max_ca_verify_depth
-              else
-                raise <<-EOT
-To download using HTTPS you must first set the SSL_CERT_FILE
-environment variable to the path of a valid CA certificate file.
-A file of bundled public CA certs may be downloaded from:
-
-   http://curl.haxx.se/ca/cacert.pem
-
-                EOT
-              end
-            end
-
-            http.request_get(uri) do |response|
-              case response
-              when Net::HTTPNotFound
-                output '404 - Not Found'
-                return false
-
-              when Net::HTTPClientError
-                output "Error: Client Error: #{response.inspect}"
-                return false
-
-              when Net::HTTPRedirection
-                raise 'Too many redirections, halting.' if count <= 0
-                url = response['location']
-                return http_download(url, full_path, count - 1)
-
-              when Net::HTTPOK
-                temp_file = Tempfile
-                                .new("download-#{filename}")
-                temp_file.binmode
-                temp_file << response.body
-
-                output
-
-                temp_file.close
-                File.unlink full_path if File.exist?(full_path)
-                FileUtils.mkdir_p File.dirname(full_path)
-                FileUtils.mv temp_file.path, full_path, force: true
-              else
-                puts response
-              end
-            end
-
-          rescue Exception => e
-            File.unlink full_path if File.exists(full_path)
-            output "ERROR: #{e.message}"
-            raise 'Failed to download file'
-          end
-        end
-      end # Downloader
+        private_class_method def self.message(text)
+                               @logger.print text
+                               @logger.flush
+                             end
+
+        private_class_method def self.output(text = '')
+                               @logger.puts text
+                               @logger.flush
+                             end
+
+        private_class_method def self.http_download(url, full_path, count)
+                               uri = URI.parse(url)
+
+                               begin
+                                 filename = File.basename(uri.path)
+
+                                 if ENV['HTTP_PROXY']
+                                   # protocol,
+                                   userinfo, proxy_host, proxy_port = URI.split(ENV['HTTP_PROXY'])
+                                   proxy_user, proxy_pass = userinfo.split(/:/) if userinfo
+                                   http = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_pass)
+                                 else
+                                   http = Net::HTTP.new(uri.host, uri.port)
+                                 end
+
+                                 if uri.scheme.downcase == 'https'
+                                   http.use_ssl = true
+                                   if ENV['SSL_CERT_FILE']
+                                     cert_file = ENV['SSL_CERT_FILE'].dup
+                                     cert_file.gsub!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
+                                   end
+                                   if cert_file && File.exist?(cert_file)
+                                     http.ca_file = cert_file
+                                     http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+                                     http.verify_depth = @max_ca_verify_depth
+                                   else
+                                     raise <<~HOWTO_MESSAGE
+                                                         To download using HTTPS you must first set the SSL_CERT_FILE
+                                                         environment variable to the path of a valid CA certificate file.
+                                                         A file of bundled public CA certs may be downloaded from:
+                                       #{'                  '}
+                                                            http://curl.haxx.se/ca/cacert.pem
+                                       #{'                  '}
+                                     HOWTO_MESSAGE
+                                   end
+                                 end
+
+                                 http.request_get(uri) do |response|
+                                   case response
+                                   when Net::HTTPNotFound
+                                     output '404 - Not Found'
+                                     return false
+
+                                   when Net::HTTPClientError
+                                     output "Error: Client Error: #{response.inspect}"
+                                     return false
+
+                                   when Net::HTTPRedirection
+                                     raise 'Too many redirections, halting.' if count <= 0
+
+                                     url = response['location']
+                                     return http_download(url, full_path, count - 1)
+
+                                   when Net::HTTPOK
+                                     temp_file = Tempfile
+                                                   .new("download-#{filename}")
+                                     temp_file.binmode
+                                     temp_file << response.body
+
+                                     output
+
+                                     temp_file.close
+                                     File.unlink full_path if File.exist?(full_path)
+                                     FileUtils.mkdir_p File.dirname(full_path)
+                                     FileUtils.mv temp_file.path, full_path, force: true
+                                   else
+                                     puts response
+                                   end
+                                 end
+                               rescue StandardError => e
+                                 File.unlink full_path if File.exist?(full_path)
+                                 output "ERROR: #{e.message}"
+                                 raise "Failed to download file: #{e.message}"
+                               end
+                             end
+      end
     end
   end
 end