gravaty 9.0.0

data/lib/gravaty/utils/rpc_connector.rb

@@ -0,0 +1,86 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'i18n'
+
+require_relative 'raisers'
+
+module Gravaty
+  module Utils
+
+    # This module contains the XML-RPC connector class.
+    #
+    # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
+    # Copyright:: Copyright © 2013, 2014, 2015, 2016, 2017, 2018,
+    # 2019  Marco Bresciani
+    # License:: GNU General Public License version 3
+    module RpcConnector
+
+      # Creates a +RpcConnector+ described by the user's email +digest+
+      # and a +password+. Throws a +ArgumentError+ if the supplied
+      # +digest+ or the +password+ are not valid.
+      #
+      # Usage::
+      #   - <tt>rpc_connector = RpcConnector.new digest, passowrd</tt>
+      # Params::
+      #   - +digest+, the user's email address MD5 digest.
+      #   - +password+, the user's Gravatar account password.
+      # Returns:: a +RcpConnector+ object for the specified email
+      # +digest+.
+      # Raises:: +ArgumentError+, if any of the supplied parameters are
+      # not valid.
+      class RpcConnector
+        include Gravaty::Utils::Raisers
+
+        def initialize(digest, password = nil)
+          I18n.load_path =
+              Dir[File.join(File.dirname(__FILE__),
+                            '/../locales/', '*.yml')]
+
+          raise ArgumentError, I18n.t('error.nil') if digest.nil? or
+              digest.empty?
+          raise ArgumentError, I18n.t('error.nil') if password.nil? or
+              password.empty?
+
+          @digest = digest
+          @connector = XMLRPC::Client.new(RPC_URI, build_rpc_path, 443,
+                                          nil, nil, nil, nil, true)
+
+          @params = Hash.new
+          @params[:password] = password
+        end
+
+        def call(a_method = RPC_TEST_METHOD, params = {})
+          raiser_downcase 'error.value', a_method, RPC_METHODS
+
+          @connector.call a_method, @params.merge(params)
+        end
+
+# ------------------------------ here starts the list of private methods
+
+        private
+
+        def build_rpc_path
+          "/xmlrpc?user=#{@digest}"
+        end
+      end
+    end
+  end
+end

data/lib/gravaty/version.rb

@@ -0,0 +1,24 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+module Gravaty
+  # Current version number for Gravaty gem.
+  VERSION = '9.0.0'
+end

data/lib/gravaty.rb

@@ -0,0 +1,75 @@
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+
+require 'digest/md5'
+require 'i18n'
+require 'uri'
+
+require_relative 'gravaty/application'
+require_relative 'gravaty/parser'
+require_relative 'gravaty/parsers/avatar'
+require_relative 'gravaty/parsers/callback'
+require_relative 'gravaty/parsers/default'
+require_relative 'gravaty/parsers/force'
+require_relative 'gravaty/parsers/format'
+require_relative 'gravaty/parsers/pixelsize'
+require_relative 'gravaty/parsers/rating'
+require_relative 'gravaty/parsers/secure'
+require_relative 'gravaty/parsers/type'
+
+# Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
+# Copyright:: Copyright © 2013, 2014, 2015, 2016, 2017, 2018,
+# 2019  Marco Bresciani
+# 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.
+  #
+  # Usage::
+  #   - <tt>new_gravaty = Gravaty::gravatize email</tt>
+  #   - <tt>new_gravaty = Gravaty::gravatize(email)</tt>
+  # Params:: +email_address+, the user's email address (a syntactically
+  # valid one).
+  # Returns:: a +Gravaty+ object for the specified +email+ address.
+  # Raises:: +ArgumentError+, if the supplied +email+ address is +nil+
+  # or not valid according to RFC 5322.
+  def self.gravatize(email_address)
+    Gravaty.new email_address, parser
+  end
+
+# ------------------------------ here starts the list of private methods
+
+  private
+
+# 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}
+
+    Parser.new parsers
+  end
+end

data/test/gravaty/locales/test_locales.rb

@@ -0,0 +1,69 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using I18N' do
+
+    RELATIVE_PATH = '/../../../lib/gravaty/locales/'
+
+    before do
+      I18n.load_path = Dir[File.join(File
+                                         .dirname(__FILE__),
+                                     RELATIVE_PATH, '*.yml')]
+    end
+
+    subject {I18n.available_locales}
+
+    it 'shall return at least one available locale' do
+      subject.wont_be_nil
+      subject.wont_be_empty
+    end
+
+    it 'shall contain at least English and Italiano' do
+      subject.must_include :en
+      subject.must_include :it
+    end
+
+    it 'shall contain a test.test signpost for each available locale' do
+      def load_yaml_file(locale)
+        filename = File::join(File::dirname(__FILE__),
+                              RELATIVE_PATH, "#{locale}" +
+                                  '.yml')
+        filename = File::expand_path filename
+        YAML::load(File::open "#{filename}")
+      end
+
+      subject.each do |locale|
+        I18n.locale = locale
+
+        translation = load_yaml_file(locale)
+        translation["#{locale}"]['test']['test'].wont_be_nil
+
+        a_string = I18n.t('test.test')
+        a_string.wont_be_nil
+        a_string.wont_be_empty
+        a_string.wont_include 'translation missing'
+        a_string.must_equal translation["#{locale}"]['test']['test']
+      end
+    end
+  end
+end

data/test/gravaty/parsers/test_avatar.rb

@@ -0,0 +1,39 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Avatar.new}
+
+    [['avatar/', true], ['', false]].each do |pair|
+      it "shall return '#{pair[0]}' when parameter is '#{pair[1]}'" do
+        subject.parse(pair[1]).must_equal pair[0]
+      end
+    end
+  end
+end

data/test/gravaty/parsers/test_callback.rb

@@ -0,0 +1,42 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Callback.new}
+
+    %w(test sample_callback).each do |value|
+      [[nil, ''], ['', ''], %W(#{value} callback=#{value})]
+          .each do |pair|
+        it "shall return '#{pair[1]}' when parameter is '#{pair[0]}'" do
+          subject.parse(pair[0]).must_equal pair[1]
+        end
+      end
+    end
+  end
+end

data/test/gravaty/parsers/test_default.rb

@@ -0,0 +1,79 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'cgi'
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      I18n.load_path = Dir[File.join(
+          File.dirname(__FILE__),
+          '/../../../lib/gravaty/locales/', '*.yml')]
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Default.new}
+
+    Gravaty::DEFAULT_OPTIONS.each do |value|
+      [[nil, ''], ['', ''], %W(#{value} d=#{value})].each do |pair|
+        it "shall return '#{pair[1]}' when parameter is '#{pair[0]}'" do
+          subject.parse(pair[0]).must_equal pair[1]
+        end
+      end
+    end
+
+    Gravaty::IMAGES_FORMATS.each do |extension|
+      value = "http://www.example.com/images/example.#{extension}"
+      escaped = "d=#{CGI::escape(value)}"
+
+      it "shall return '#{escaped}' when parameter is '#{value}'" do
+        subject.parse(value).must_equal escaped
+      end
+    end
+
+    describe 'with invalid default URI image URI' do
+      it 'shall raise exception' do
+        begin
+          subject.parse('http://www.example.com/images/example.svg')
+              .must_raise ArgumentError
+        rescue ArgumentError => aErr
+          aErr.wont_be_nil
+          aErr.message.wont_be_nil
+          aErr.message.wont_be_empty
+        end
+      end
+
+      it 'shall raise exception' do
+        begin
+          subject.parse('svg').must_raise ArgumentError
+        rescue ArgumentError => aErr
+          aErr.wont_be_nil
+          aErr.message.wont_be_nil
+          aErr.message.wont_be_empty
+        end
+      end
+    end
+
+  end
+end

data/test/gravaty/parsers/test_force.rb

@@ -0,0 +1,39 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Force.new}
+
+    [['f=y', true], ['', false]].each do |pair|
+      it "shall return '#{pair[0]}' when parameter is '#{pair[1]}'" do
+        subject.parse(pair[1]).must_equal pair[0]
+      end
+    end
+  end
+end

data/test/gravaty/parsers/test_format.rb

@@ -0,0 +1,54 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      I18n.load_path = Dir[File.join(
+          File.dirname(__FILE__),
+          '/../../../lib/gravaty/locales/', '*.yml')]
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Format.new}
+
+    Gravaty::PROFILE_FORMATS.each do |value|
+      [[nil, ''], %W(#{value} .#{value.downcase})].each do |pair|
+        it "shall return '#{pair[1]}' when parameter is '#{pair[0]}'" do
+          subject.parse(pair[0]).must_equal pair[1]
+        end
+      end
+    end
+
+    it 'shall raise exception with invalid default image extension' do
+      begin
+        subject.parse('svg').must_raise ArgumentError
+      rescue ArgumentError => aErr
+        aErr.wont_be_nil
+        aErr.message.wont_be_nil
+        aErr.message.wont_be_empty
+      end
+    end
+  end
+end

data/test/gravaty/parsers/test_pixelsize.rb

@@ -0,0 +1,56 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      I18n.load_path = Dir[File.join(
+          File.dirname(__FILE__),
+          '/../../../lib/gravaty/locales/', '*.yml')]
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Pixelsize.new}
+
+    it 'shall return nothing when parameter is nil' do
+      subject.parse(nil).must_be_empty
+    end
+
+    Gravaty::ALLOWED_SIZES.each do |value|
+      it "shall return s='#{value.to_s}' when parameter is '#{value}'" do
+        subject.parse(value).must_equal "s=#{value.to_s}"
+      end
+    end
+
+    it 'shall raise an exception when provided with invalid rating' do
+      begin
+        subject.parse(0).must_raise ArgumentError
+      rescue ArgumentError => aErr
+        aErr.wont_be_nil
+        aErr.message.wont_be_nil
+        aErr.message.wont_be_empty
+      end
+    end
+  end
+end

data/test/gravaty/parsers/test_rating.rb

@@ -0,0 +1,54 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      I18n.load_path = Dir[File.join(
+          File.dirname(__FILE__),
+          '/../../../lib/gravaty/locales/', '*.yml')]
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Rating.new}
+
+    Gravaty::RATING_OPTIONS.each do |value|
+      [[nil, ''], %W(#{value} rating=#{value.downcase})].each do |pair|
+        it "shall return '#{pair[1]}' when parameter is '#{pair[0]}'" do
+          subject.parse(pair[0]).must_equal pair[1]
+        end
+      end
+    end
+
+    it 'shall raise an exception when provided with invalid rating' do
+      begin
+        subject.parse('xxx').must_raise ArgumentError
+      rescue ArgumentError => aErr
+        aErr.wont_be_nil
+        aErr.message.wont_be_nil
+        aErr.message.wont_be_empty
+      end
+    end
+  end
+end

data/test/gravaty/parsers/test_secure.rb

@@ -0,0 +1,39 @@
+#--
+# gravaty
+# Copyright © 2013, 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+#
+# This file is part of gravaty.
+#
+# gravaty is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# gravaty is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+# for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with gravaty. If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require_relative '../../test_helper'
+
+describe Gravaty::Gravaty do
+  describe 'when using a parser' do
+    include Gravaty::ParsableDuckType
+
+    before do
+      @parser = subject
+    end
+
+    subject {Gravaty::Parsers::Secure.new}
+
+    [['https://secure', true], ['http://www', false]].each do |pair|
+      it "shall return '#{pair[0]}' when parameter is '#{pair[1]}'" do
+        subject.parse(pair[1]).must_equal pair[0]
+      end
+    end
+  end
+end