gravaty 9.0.0

data/examples/profile.rb

@@ -0,0 +1,187 @@
+#--
+# 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 '../lib/gravaty'
+
+i = 0
+
+# Creates the Gravaty object with an (example) email
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Creates the Gravaty object with an (example) email."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty = Gravaty::gravatize 'user@example.com'"
+a_gravaty = Gravaty::gravatize 'user@example.com'
+puts
+i += 1
+
+# Prints the basic URL for profile retrieval, with no frills
+# (https://www.gravatar.com/b58996c504c5638798eb6b511e6f49af)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints the basic URL for profile retrieval, with no frills (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af)."
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.profile'
+puts a_gravaty.profile
+puts
+i += 1
+
+# Prints the basic URL for profile retrieval, with no frills, in json
+# format through json-specific method
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.json)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints the basic URL for profile retrieval, with no frills, in json format through json-specific method (http://www.gravatar.com/b58996c504c5638798eb6b511e6f49af.json)."
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.json'
+puts a_gravaty.json
+puts
+i += 1
+
+# Prints the basic URL for profile retrieval, in JSON format, with
+# callback string
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.json?callback=my_callback)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints the basic URL for profile retrieval, in JSON format, with callback string (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.json?callback=my_callback)."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty.json callback: 'my_callback'"
+puts a_gravaty.json callback: 'my_callback'
+puts
+i += 1
+
+# Prints the basic URL for profile retrieval, in PHP format
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.php)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints the basic URL for profile retrieval, in PHP format (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.php)."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty.profile format: 'php'"
+puts a_gravaty.profile format: 'php'
+puts
+i += 1
+
+# Prints the basic URL for profile retrieval, with no frills, in QR code
+# format through QR code-specific method
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints the basic URL for profile retrieval, with no frills, in QR code format through QR code-specific method (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)."
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.qrcode'
+puts a_gravaty.qrcode
+puts
+i += 1
+
+# Prints and saves the basic URL for profile retrieval, with no frills,
+# in QR code format
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints and saves the basic URL for profile retrieval, with no frills, in QR code format (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty.profile! format: 'qr'"
+puts a_gravaty.profile! format: 'qr'
+puts
+i += 1
+
+# Retrieves the latest saved operation (email address, if none saved)
+# (user@example.com)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Retrieves the latest saved operation (email address, if none saved) (user@example.com)."
+puts "------------------------------------------"
+puts 'irb(main):001:0> puts a_gravaty'
+puts a_gravaty
+puts
+i += 1
+
+# Prints and save the basic URL for profile and later retrieval, in QR
+# code format
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints and save the basic URL for profile and later retrieval, in QR code format (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty.profile! format: 'qr'"
+puts a_gravaty.profile! format: 'qr'
+puts
+
+# Downloads the previously saved gravaty configuration with the default
+# name of the file according to saved URI
+# (saves b58996c504c5638798eb6b511e6f49af.qr file via HTTPS)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Downloads the previously saved gravaty configuration with the default name of the file according to saved URI. (saves b58996c504c5638798eb6b511e6f49af.qr file via HTTPS)"
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.download'
+a_gravaty.download
+puts
+i += 1
+
+# Prints the basic URL for profile retrieval in QR code format
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)
+puts "------------------------------------------"
+puts "Profile: '#{i}'a. Prints the basic URL for profile retrieval in QR code format (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr)."
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.qrcode'
+puts a_gravaty.qrcode
+puts
+
+# Prints the unsecure URL for profile retrieval in QR code format with
+# specified image size (in pixels)
+# (http://www.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr?s=42)
+puts "------------------------------------------"
+puts "Profile: '#{i}'b. prints the unsecure URL for profile retrieval in QR code format with specified image size (in pixels) (http://www.gravatar.com/b58996c504c5638798eb6b511e6f49af.qr?s=42)."
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.qrcode pixelsize: 42, secure: false'
+puts a_gravaty.qrcode! pixelsize: 42, secure: false
+puts
+i += 1
+
+# Retrieves the latest saved operation (email address, if none saved)
+# (user@example.com)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Retrieves the latest saved operation (email address, if none saved) (user@example.com)."
+puts "------------------------------------------"
+puts 'irb(main):001:0> puts a_gravaty'
+puts a_gravaty
+puts
+i += 1
+
+# Prints and saves the unsecure URL for profile retrieval, in VFC/vCard
+# format (http://www.gravatar.com/b58996c504c5638798eb6b511e6f49af.vcf)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints and saves the unsecure URL for profile retrieval, in VFC/vCard format (http://www.gravatar.com/b58996c504c5638798eb6b511e6f49af.vcf)."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty.profile format: 'vcf', secure: false"
+puts a_gravaty.profile! format: 'vcf', secure: false
+puts
+i += 1
+
+# Downloads the previously saved gravaty configuration with the default
+# name of the file according to saved URI
+# (saves b58996c504c5638798eb6b511e6f49af.vcf file via HTTP)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Downloads the previously saved gravaty configuration with the default name of the file according to saved URI. (saves b58996c504c5638798eb6b511e6f49af.vcf file via HTTP)"
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.download'
+a_gravaty.download
+puts
+i += 1
+
+# Prints the basic URL for profile retrieval, in XML format
+# (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.xml)
+puts "------------------------------------------"
+puts "Profile: '#{i}'. Prints the basic URL for profile retrieval, in XML format (https://secure.gravatar.com/b58996c504c5638798eb6b511e6f49af.xml)."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty.profile format: 'xml'"
+puts a_gravaty.profile format: 'xml'
+puts

data/examples/xmlrpc.rb

@@ -0,0 +1,41 @@
+#
+# 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 '../lib/gravaty'
+
+i = 0
+
+# Creates the Gravaty object with an (example) email
+puts "------------------------------------------"
+puts "XML-RPC: '#{i}'. Creates the Gravaty object with an (example) email."
+puts "------------------------------------------"
+puts "irb(main):001:0> a_gravaty = Gravaty::gravatize 'user@example.com'"
+a_gravaty = Gravaty::gravatize 'user@example.com'
+puts
+i += 1
+
+# Calls the test method of the XML-RPC API
+puts "------------------------------------------"
+puts "XML-RPC: '#{i}'. Calls the test method of the XML-RPC API with password 'password'."
+puts "------------------------------------------"
+puts 'irb(main):001:0> a_gravaty.xmlrpc Gravaty::RPC_TEST_METHOD'
+a_gravaty.xmlrpc Gravaty::RPC_TEST_METHOD, 'password'
+puts
+i += 1

data/gravaty.gemspec

@@ -0,0 +1,78 @@
+# 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 'lib/gravaty/version'
+
+SUMMARY = 'This gem automagically prepares complete URIs for Gravatar,
+ for both avatars and profiles, with all currently supported options,
+ included the XML-RPC API, as of 2014-04-30, starting from a single
+ email address!'
+
+Gem::Specification.new do |a_gem|
+  a_gem.name = 'gravaty'
+  a_gem.version = Gravaty::VERSION
+  a_gem.license = 'GPL-3.0'
+  a_gem.licenses = %w(GPL-3.0 BSD-3-Clause)
+  a_gem.author = 'Marco Bresciani'
+  a_gem.authors = ['Marco Bresciani', '新部裕', 'Peter R. Marreck',
+                   'Jon Maken', 'Łukasz Niemier']
+  a_gem.email = 'marcobresciani_1974@libero.it'
+  a_gem.homepage = 'https://savannah.nongnu.org/projects/gravaty/'
+  a_gem.summary = SUMMARY
+  a_gem.description = "#{SUMMARY} It's my first 'real' Ruby gem, hoping
+ it will be useful for someone (let me know if you use it, please!).
+ GNU GPLv3 license; source code available through anonymous checkout:
+ hg clone http://hg.savannah.nongnu.org/hgweb/gravaty/ or write me and
+ I'll send it. You can even decide to contribute to this little free
+ software project by registering to Savannah and ask to be part of the
+ 'gravaty' project! With contributions from: 新部裕, Peter R. Marreck,
+ Jon Maken, Łukasz Niemier."
+
+  COMMON_FILES = %w(acknowledgements.md authors.md CHANGELOG COPYING.md
+ copyright.md Gemfile gravaty.gemspec gravaty.odp gravaty.pdf ISSUES.md
+ Rakefile README.md)
+
+  a_gem.files = Dir.glob('{examples,html,lib,test}/**/*') + COMMON_FILES
+  a_gem.test_files = Dir.glob('test/**/test_*.rb')
+  a_gem.require_path = 'lib'
+  a_gem.require_paths = %w(lib)
+  a_gem.extra_rdoc_files = COMMON_FILES
+
+  a_gem.required_ruby_version = '~> 2.6'
+  a_gem.rubygems_version = '~> 3.0'
+
+  a_gem.add_runtime_dependency 'i18n', '~>1.6'
+  a_gem.add_runtime_dependency 'json', '~>2.2'
+  a_gem.add_runtime_dependency 'xmlrpc', '~>0.3.0'
+
+  a_gem.add_development_dependency 'bundler', '~>2.0'
+  a_gem.add_development_dependency 'minitest', '~>5.11'
+  a_gem.add_development_dependency 'rake', '~>12.3'
+  a_gem.add_development_dependency 'rdoc', '~>6.1'
+  a_gem.add_development_dependency 'simplecov', '~>0.16'
+
+  a_gem.requirements = a_gem.required_ruby_version.to_s, a_gem.dependencies.to_s
+
+  begin
+    require 'changelog'
+  rescue LoadError
+    a_gem.post_install_message = "Thank you for using #{a_gem.name} version #{a_gem.version}."
+  else
+    a_gem.post_install_message = CHANGELOG.new.version_changes
+  end
+end