gravaty 9.0.0

data/test/gravaty/parsers/test_type.rb

@@ -0,0 +1,44 @@
+#--
+# 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')]
+    end
+
+    subject {Gravaty::Parsers::Type.new}
+
+    Gravaty::AVATAR_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
+  end
+end

data/test/gravaty/test_application.rb

@@ -0,0 +1,126 @@
+#--
+# 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 created with a valid email address' do
+
+    subject {Gravaty::Gravaty.new(Gravaty::TEST_MY_ADDRESS,
+                                  Gravaty::parser)}
+
+    it 'shall return the email content on demand' do
+      subject.email.must_equal Gravaty::TEST_MY_ADDRESS.downcase
+    end
+
+    it 'shall return the digest content on demand' do
+      subject.digest.must_equal Gravaty::TEST_MY_MD5
+    end
+
+    it 'shall return a valid string' do
+      subject.to_s.wont_be_nil
+    end
+
+    it 'shall return a valid JSON' do
+      subject.to_json.wont_be_nil
+      JSON.parse(subject.to_json).wont_be_nil
+    end
+
+    [:avatar, :profile].each do |method|
+      describe "when asked for '#{method}'" do
+        describe 'when no parameters are provided' do
+          it 'shall provide an URI' do
+            subject.send(method)
+                .must_match Gravaty::TEST_SIMPLE_URI_REGEXP
+          end
+
+          it "shall provide a '#{method}' URI" do
+            subject.send(method)
+                .must_include Gravaty::TEST_STRING[method]
+          end
+
+          it "shall provide a '#{method}' with a secure URI" do
+            subject.send(method)
+                .must_match Gravaty::TEST_SECURE_URI_REGEXP
+            subject.send(method)
+                .wont_match Gravaty::TEST_UNSECURE_URI_REGEXP
+          end
+        end
+
+        describe 'when nil is provided' do
+          it 'shall provide an URI' do
+            subject.send(method, nil)
+                .must_match Gravaty::TEST_SIMPLE_URI_REGEXP
+          end
+
+          it "shall provide a '#{method}' URI" do
+            subject.send(method, nil)
+                .must_include Gravaty::TEST_STRING[method]
+          end
+
+          it "shall provide a '#{method}' with a secure URI" do
+            subject.send(method, nil)
+                .must_match Gravaty::TEST_SECURE_URI_REGEXP
+            subject.send(method, nil)
+                .wont_match Gravaty::TEST_UNSECURE_URI_REGEXP
+          end
+
+        end
+
+        describe 'when secure:false is provided' do
+          it "shall provide a '#{method}' with an unsecure URI" do
+            subject.send(method, secure: false)
+                .wont_match Gravaty::TEST_SECURE_URI_REGEXP
+            subject.send(method, secure: false)
+                .must_match Gravaty::TEST_UNSECURE_URI_REGEXP
+          end
+        end
+      end
+    end
+
+    it 'shall provide the XML-RPC API interface' do
+      subject.must_respond_to :xmlrpc
+    end
+
+    describe 'when asked for nil method' do
+      it 'must raise an ArgumentError' do
+        assert_raises ArgumentError do
+          subject.xmlrpc(nil)
+        end
+      end
+    end
+
+    describe 'when asked for an unsupported method' do
+      it 'must raise an ArgumentError' do
+        assert_raises ArgumentError do
+          subject.xmlrpc('my_method', 'my_password')
+        end
+      end
+    end
+
+    describe 'when asked for a valid method with a nil password' do
+      it 'must raise an ArgumentError' do
+        assert_raises ArgumentError do
+          subject.xmlrpc('my_method')
+        end
+      end
+    end
+  end
+end

data/test/gravaty/test_avatar.rb

@@ -0,0 +1,122 @@
+#--
+# 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 created with a valid email address ' do
+
+    subject {Gravaty::Gravaty.new(Gravaty::TEST_MY_ADDRESS,
+                                  Gravaty::parser)}
+
+    Gravaty::AVATAR_FORMATS.each do |avatar|
+      describe "when asked for '#{avatar}' image" do
+        it "shall provide an URI with specified '#{avatar}' image" do
+          subject.avatar(type: avatar).must_include(".#{avatar}")
+        end
+      end
+    end
+
+    describe 'when asked for unknown image' do
+      it 'must raise an ArgumentError' do
+        assert_raises ArgumentError do
+          subject.avatar type: 'unknown'
+        end
+      end
+    end
+
+    Gravaty::ALLOWED_SIZES.each do |size|
+      describe "when asked for a size of '#{size}' pixels" do
+        it "shall provide an URI with specified '#{size}' image" do
+          subject.avatar(pixelsize: size)
+              .must_match(/#{Gravaty::TEST_SIZE_REGEXP}$/)
+        end
+      end
+    end
+
+    [-1, 0, Gravaty::ALLOWED_SIZES.max + 1].each do |size|
+      describe "when asked for an invalid size of '#{size}' pixels" do
+        it 'must raise an argument error' do
+          assert_raises ArgumentError do
+            subject.avatar(pixelsize: size)
+          end
+        end
+      end
+    end
+
+    Gravaty::RATING_OPTIONS.each do |rating|
+      describe "when asked for a specific image rating '#{rating}'" do
+        it "shall provide an URI with specified '#{rating}'" do
+          subject.avatar(rating: rating)
+              .must_include("rating=#{rating}")
+        end
+      end
+    end
+
+    describe 'when asked for unknown rating' do
+      it 'must raise an ArgumentError' do
+        assert_raises ArgumentError do
+          subject.avatar rating: 'unknown'
+        end
+      end
+    end
+
+    describe 'when asked for forcing default image' do
+      it 'shall provide a forced URI' do
+        subject.avatar(force: true).must_include Gravaty::TEST_FORCED
+      end
+    end
+
+    Gravaty::DEFAULT_OPTIONS.each do |options|
+      describe "when asked for a specific image options '#{options}'" do
+        it "shall provide an URI with option '#{options}'" do
+          subject.avatar(default: options).must_include("d=#{options}")
+        end
+      end
+    end
+
+    describe 'when provided with a own default image' do
+      it 'shall provide a HTTP(S) URI' do
+        ['', 's'].each do |type|
+          an_uri = "http#{type}://www.example.com/example.jpg"
+          subject.avatar(default: an_uri).must_include CGI::escape(an_uri)
+        end
+      end
+
+      it 'must raise an ArgumentError when URI is not HTTP(S)' do
+        assert_raises ArgumentError do
+          subject.avatar default: 'ftp://www.example.com/example.jpg'
+        end
+      end
+
+      it 'must raise an ArgumentError when image format is not supported' do
+        assert_raises ArgumentError do
+          subject.avatar default: 'http://www.example.com/example.svg'
+        end
+      end
+
+      it 'must raise an ArgumentError when URI contains a query string' do
+        assert_raises ArgumentError do
+          subject.avatar default: 'http://www.example.com?image=example.jpg'
+        end
+      end
+    end
+  end
+end

data/test/gravaty/test_parser.rb

@@ -0,0 +1,59 @@
+#--
+# 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
+
+    subject {Gravaty::parser}
+
+    it 'shall provide a list of parsers' do
+      subject.parsers.wont_be_empty
+    end
+
+    it 'shall provide all needed parsers' do
+      subject.parsers.length.must_equal Gravaty::ALLOWED_PARAMS.length
+      subject.parsers.keys.must_equal Gravaty::ALLOWED_PARAMS
+    end
+
+    it 'shall use the parsable duck type' do
+      parsable_mocks = {}
+
+      Gravaty::ALLOWED_PARAMS.each do |param|
+        parsable_mocks[param] = MiniTest::Mock.new
+        parsable_mocks[param].expect(:parse, false, [nil])
+        parsable_mocks[param].expect(:nil?, false)
+      end
+
+      my_parser = Gravaty::Parser.new(parsable_mocks)
+
+      Gravaty::ALLOWED_PARAMS.each do |param|
+        my_parser.parse(param, nil)
+        parsable_mocks[param].verify
+      end
+    end
+
+    it 'shall die gracefully whether parameters are not valid' do
+      a_parser = Gravaty::Parser.new(nil)
+      a_parser.parse
+    end
+  end
+end

data/test/gravaty/test_profile.rb

@@ -0,0 +1,70 @@
+#--
+# 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 created with a valid email address ' do
+    subject {Gravaty::Gravaty.new(Gravaty::TEST_MY_ADDRESS,
+                                  Gravaty::parser)}
+
+    Gravaty::PROFILE_FORMATS.each do |format|
+      describe "when asked for '#{format}' profile" do
+        it "shall provide an URI with required '#{format}' format" do
+          subject.profile(format: format).must_include(".#{format}")
+        end
+      end
+    end
+
+    describe 'when asked for unknown profile format ' do
+      it 'must raise an ArgumentError' do
+        assert_raises ArgumentError do
+          subject.profile format: 'unknown'
+        end
+      end
+    end
+
+    describe 'when asked for JSON format ' do
+      it 'shall provide an URI in JSON format' do
+        subject.json.must_match Gravaty::TEST_JSON_REGEXP
+      end
+
+      it 'shall provide a JSON URI when callback is provided' do
+        subject.json.must_match Gravaty::TEST_JSON_REGEXP
+        subject.json(callback: Gravaty::TEST_CALLBACK)
+            .must_match(/#{Gravaty::TEST_CALLBACK}$/)
+      end
+    end
+
+    describe 'when asked for QR code format ' do
+      it 'shall provide an URI in QR code format' do
+        subject.qrcode.must_match Gravaty::TEST_QR_REGEXP
+      end
+
+      Gravaty::ALLOWED_SIZES.each do |size|
+        it "shall provide a '#{size}' pixels URI, when size '#{size}'" do
+          subject.qrcode.must_match Gravaty::TEST_QR_REGEXP
+          subject.qrcode(pixelsize: size)
+              .must_match(/#{Gravaty::TEST_SIZE_REGEXP}$/)
+        end
+      end
+    end
+  end
+end

data/test/gravaty/utils/test_downloader.rb

@@ -0,0 +1,51 @@
+#--
+# 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::Utils::Downloader do
+  describe 'when passed a nil uri' do
+    it 'must raise a RuntimeError' do
+      assert_raises RuntimeError do
+        Gravaty::Utils::Downloader::Downloader
+            .download_file nil, 'filename'
+      end
+    end
+  end
+
+  describe 'when passed an invalid uri' do
+    it 'must raise a InvalidURIError' do
+      assert_raises URI::InvalidURIError do
+        Gravaty::Utils::Downloader::Downloader
+            .download_file 'http://example.com/%uABCD',
+                           'filename'
+      end
+    end
+  end
+
+  describe 'when passed a nil filename' do
+    it 'must raise a TypeError' do
+      assert_raises TypeError do
+        Gravaty::Utils::Downloader::Downloader
+            .download_file 'http://www.example.com', nil
+      end
+    end
+  end
+end

data/test/gravaty/utils/test_raisers.rb

@@ -0,0 +1,62 @@
+#--
+# 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::Utils::Raisers do
+  include Gravaty::Utils::Raisers
+
+  before do
+    I18n.load_path = Dir[File.join(File.dirname(__FILE__),
+                                   '/../../../lib/gravaty/locales/',
+                                   '*.yml')]
+    I18n.locale = 'it'
+  end
+
+  describe 'when running any raiser method' do
+    it 'do not raise an ArgumentError when value is nil or in array' do
+      all_methods = Hash.new
+      all_methods[:raiser_downcase] = [[nil, nil], ['value', ['value']]]
+      all_methods[:raiser_to_i] = [[nil, nil], ['42', [42]]]
+
+      all_methods.each_key do |method_name|
+        a_method = self.method method_name
+        all_methods[method_name.to_sym].each do |params|
+          a_method.call 'error.value', params[0], params[1]
+        end
+      end
+    end
+
+    it 'raises ArgumentError when value is not nil and not in array' do
+      all_methods = Hash.new
+      all_methods[:raiser_downcase] = ['value', ['no value']]
+      all_methods[:raiser_to_i] = ['42', [47]]
+
+      all_methods.each_key do |method_name|
+        a_method = self.method method_name
+        assert_raises ArgumentError do
+          a_method.call 'error.value',
+                        all_methods[method_name.to_sym][0],
+                        all_methods[method_name.to_sym][1]
+        end
+      end
+    end
+  end
+end

data/test/gravaty/utils/test_rfc5322.rb

@@ -0,0 +1,82 @@
+#--
+# 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::Utils::Rfc5322 do
+  describe 'when passed a nil email address' do
+    it 'must return nil' do
+      Gravaty::Utils::Rfc5322::EMAIL.match(nil).must_be_nil
+    end
+  end
+
+  describe 'when passed an invalid email address, according to RF5322' do
+
+    # This test does not pass with 'Joe Q. Public
+    # <john.q.public@example.com>' email: see
+    # <https://tools.ietf.org/html/rfc5322#appendix-A.1.2> that is: it
+    # matches the address even if it has no double-quotes as specified
+    # in RFC 5322.
+    #
+    # Note that the display names for Joe Q. Public and Giant; "Big" Box
+    # needed to be enclosed in double-quotes because the former contains
+    # the period and the latter contains both semicolon and double-quote
+    # characters (the double-quote characters appearing as quoted-pair
+    # constructs).
+    ['-.', 'Joe Q. Public <john.q.public@example.com>']
+        .each do |invalid_address|
+      it "must return nil for '#{invalid_address}' invalid address" do
+        assert_nil Gravaty::Utils::Rfc5322::EMAIL.match invalid_address
+      end
+    end
+  end
+
+  describe 'when passed a valid email address, according to RF5322' do
+
+    # This test shall pass... see
+    # <https://tools.ietf.org/html/rfc5322#appendix-A.5>
+    #
+    # The above example is aesthetically displeasing, but perfectly
+    # legal. Note particularly (1) the comments in the "From:" field
+    # (including one that has a ")" character appearing as part of a
+    # quoted-pair); (2) the white space absent after the ":" in the
+    # "To:" field as well as the comment and folding white space after
+    # the group name, the special character (".") in the comment in
+    # Chris Jones's address, and the folding white space before and
+    # after "joe@example.org,"; (3) the multiple and nested comments in
+    # the "Cc:" field as well as the comment immediately following the
+    # ":" after "Cc"; (4) the folding white space (but no comments
+    # except at the end) and the missing seconds in the time of the date
+    # field; and (5) the white space before (but not within) the
+    # identifier in the "Message-ID:" field.
+    ['John Doe <jdoe@machine.example>', 'Mary Smith <mary@example.net>',
+     'Mary Smith <mary@example.net>',
+     "A Group(Some people)\n    :Chris Jones <c@(Chris's host.)public.example>,\n            joe@example.org,\n     John <jdoe@one.test> (my dear friend);",
+     'Who? <one@y.test>', '"Joe Q. Public" <john.q.public@example.com>',
+     '"Giant; \"Big\" Box" <sysservices@example.net>',
+     'A Group:Ed Jones <c@a.test>,joe@where.test,John <jdoe@one.test>;',
+     'Pete(A nice \) chap) <pete(his account)@silly.test(his host)>']
+        .each do |address|
+      it "must match the valid '#{address}' email address" do
+        refute_nil Gravaty::Utils::Rfc5322::EMAIL.match address
+      end
+    end
+  end
+end