mail_autoconfig_revived 0.0.3

data/mail_autoconfig_revived.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mail_autoconfig/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mail_autoconfig_revived"
+  spec.version = MailAutoconfig::VERSION
+  spec.authors = ["Bijan Rahnema, Dan Wentworth"]
+  spec.email = ["bijan@screenisland.com"]
+  spec.summary = "Determine configuration details for a mailbox using Mozilla's ISPDB"
+  spec.homepage = "https://github.com/gobijan/mail-autoconfig-revived"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(/\.gem$/) }
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.15"
+  spec.add_dependency "faraday", "~> 2.7"
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "rake", "~> 13.1"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "redcarpet", "~> 3.6"
+  spec.add_development_dependency "standard", "~> 1.32"
+end

data/test/client_config_test.rb

@@ -0,0 +1,45 @@
+require "minitest/autorun"
+require "mail_autoconfig"
+
+class ClientConfigTest < Minitest::Test
+  def setup
+    @client_config = MailAutoconfig::ClientConfig.from_file(File.expand_path(File.join(__FILE__, "../", "examples", "client_config_yahoo.xml")))
+  end
+
+  def test_reads_service_name
+    assert_equal "Yahoo! Mail", @client_config.name
+  end
+
+  def test_reads_short_name
+    assert_equal "Yahoo", @client_config.short_name
+  end
+
+  def test_reads_provider_id
+    assert_equal "yahoo.com", @client_config.provider_id
+  end
+
+  def test_reads_domain_aliases
+    assert_includes @client_config.domains, "yahoo.com"
+    assert_includes @client_config.domains, "yahoo.co.uk"
+  end
+
+  def test_matches_valid_domains
+    assert @client_config.valid_for_domain?("yahoo.it")
+  end
+
+  def test_does_not_match_invalid_domains
+    refute @client_config.valid_for_domain?("googlemail.com")
+  end
+
+  def test_auto_detects_domains_from_local_files
+    assert_kind_of MailAutoconfig::ClientConfig, MailAutoconfig::ClientConfig.search_local_files("googlemail.com")
+  end
+
+  def test_auto_detects_domains_from_local_files_with_alias
+    assert_kind_of MailAutoconfig::ClientConfig, MailAutoconfig::ClientConfig.search_local_files("gmail.com")
+  end
+
+  def test_auto_detects_domains_from_autoconfig_domain
+    assert_kind_of MailAutoconfig::ClientConfig, MailAutoconfig::ClientConfig.search_autoconfig_domain("swcp.com")
+  end
+end

data/test/email_address_test.rb

@@ -0,0 +1,49 @@
+require "minitest/autorun"
+require "mail_autoconfig"
+
+class EmailAddressTest < Minitest::Test
+  def test_gmail_domain
+    address = MailAutoconfig::EmailAddress.new("example@gmail.com")
+    assert_equal "gmail.com", address.domain
+  end
+
+  def test_gmail_local_part
+    address = MailAutoconfig::EmailAddress.new("example@gmail.com")
+    assert_equal "example", address.local_part
+  end
+
+  def test_gmail_mx_domains
+    address = MailAutoconfig::EmailAddress.new("example@gmail.com")
+    assert_equal "google.com", address.primary_mx_domain
+  end
+
+  def test_gmail_client_config
+    address = MailAutoconfig::EmailAddress.new("example@gmail.com")
+    assert_kind_of MailAutoconfig::ClientConfig, address.client_config
+  end
+
+  def test_gmail_client_config_provider_short_name
+    address = MailAutoconfig::EmailAddress.new("example@gmail.com")
+    assert_equal "GMail", address.client_config.short_name
+  end
+
+  def test_atechmedia_no_config
+    address = MailAutoconfig::EmailAddress.new("example@atechmedia.com")
+    refute address.client_config
+  end
+
+  def test_swcp_autoconf_config
+    address = MailAutoconfig::EmailAddress.new("example@swcp.com")
+    assert_kind_of MailAutoconfig::ClientConfig, address.client_config
+  end
+
+  def test_unlikely_domain_no_config
+    address = MailAutoconfig::EmailAddress.new("example@veryunlikelydomain4567763332.com")
+    refute address.client_config
+  end
+
+  def test_unlikely_domain_no_primary_mx
+    address = MailAutoconfig::EmailAddress.new("example@veryunlikelydomain4567763332.com")
+    assert_nil address.primary_mx_domain
+  end
+end

data/test/examples/client_config_yahoo.xml

@@ -0,0 +1,40 @@
+<clientConfig version="1.1">
+  <emailProvider id="yahoo.com">
+    <domain>yahoo.com</domain>
+    <domain>yahoo.de</domain>
+    <domain>yahoo.it</domain>
+    <domain>yahoo.fr</domain>
+    <domain>yahoo.es</domain>
+    <domain>yahoo.co.uk</domain>
+    <domain>yahoo.co.nz</domain>
+    <domain>yahoo.com.au</domain>
+    <domain>yahoo.com.ar</domain>
+    <domain>yahoo.com.br</domain>
+    <domain>yahoo.com.mx</domain>
+    <domain>ymail.com</domain>
+    <domain>rocketmail.com</domain>
+    <displayName>Yahoo! Mail</displayName>
+    <displayShortName>Yahoo</displayShortName>
+    <incomingServer type="pop3">
+      <hostname>pop.mail.yahoo.com</hostname>
+      <port>995</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <incomingServer type="imap">
+      <hostname>imap.mail.yahoo.com</hostname>
+      <port>993</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </incomingServer>
+    <outgoingServer type="smtp">
+      <hostname>smtp.mail.yahoo.com</hostname>
+      <port>465</port>
+      <socketType>SSL</socketType>
+      <username>%EMAILADDRESS%</username>
+      <authentication>password-cleartext</authentication>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

data/test/server_test.rb

@@ -0,0 +1,89 @@
+require "minitest/autorun"
+require "mail_autoconfig"
+
+class ServerTest < Minitest::Test
+  def setup
+    @client_config = MailAutoconfig::ClientConfig.from_file(File.expand_path(File.join(__FILE__, "../", "examples", "client_config_yahoo.xml")))
+    @client_config.email_address = MailAutoconfig::EmailAddress.new("example@gmail.com")
+  end
+
+  def test_incoming_server
+    server = @client_config.incoming_servers.first
+    assert_kind_of MailAutoconfig::IncomingServer, server
+  end
+
+  def test_incoming_server_is_pop3
+    server = @client_config.incoming_servers.first
+    assert_equal "pop3", server.protocol
+  end
+
+  def test_incoming_server_has_hostname
+    server = @client_config.incoming_servers.first
+    assert_equal "pop.mail.yahoo.com", server.hostname
+  end
+
+  def test_incoming_server_has_port
+    server = @client_config.incoming_servers.first
+    assert_equal 995, server.port
+  end
+
+  def test_incoming_server_has_socket_type
+    server = @client_config.incoming_servers.first
+    assert_equal "SSL", server.socket_type
+  end
+
+  def test_incoming_server_has_username_format
+    server = @client_config.incoming_servers.first
+    assert_equal "%EMAILADDRESS%", server.username_format
+  end
+
+  def test_incoming_server_processes_username
+    server = @client_config.incoming_servers.first
+    assert_equal "example@gmail.com", server.username
+  end
+
+  def test_incoming_server_has_authentication_method
+    server = @client_config.incoming_servers.first
+    assert_equal "password-cleartext", server.authentication
+  end
+
+  def test_outgoing_server
+    server = @client_config.outgoing_servers.first
+    assert_kind_of MailAutoconfig::OutgoingServer, server
+  end
+
+  def test_outgoing_server_is_smtp
+    server = @client_config.outgoing_servers.first
+    assert_equal "smtp", server.protocol
+  end
+
+  def test_outgoing_server_has_hostname
+    server = @client_config.outgoing_servers.first
+    assert_equal "smtp.mail.yahoo.com", server.hostname
+  end
+
+  def test_outgoing_server_has_port
+    server = @client_config.outgoing_servers.first
+    assert_equal 465, server.port
+  end
+
+  def test_outgoing_server_has_socket_type
+    server = @client_config.outgoing_servers.first
+    assert_equal "SSL", server.socket_type
+  end
+
+  def test_outgoing_server_has_username_format
+    server = @client_config.outgoing_servers.first
+    assert_equal "%EMAILADDRESS%", server.username_format
+  end
+
+  def test_outgoing_server_processes_username
+    server = @client_config.outgoing_servers.first
+    assert_equal "example@gmail.com", server.username
+  end
+
+  def test_outgoing_server_has_authentication_method
+    server = @client_config.outgoing_servers.first
+    assert_equal "password-cleartext", server.authentication
+  end
+end

metadata

@@ -0,0 +1,336 @@
+--- !ruby/object:Gem::Specification
+name: mail_autoconfig_revived
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Bijan Rahnema, Dan Wentworth
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
+description:
+email:
+- bijan@screenisland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".standard.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/MailAutoconfig.html
+- doc/MailAutoconfig/ClientConfig.html
+- doc/MailAutoconfig/EmailAddress.html
+- doc/MailAutoconfig/IncomingServer.html
+- doc/MailAutoconfig/OutgoingServer.html
+- doc/MailAutoconfig/Server.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- ispdb_data/126.com.xml
+- ispdb_data/163.com.xml
+- ispdb_data/1und1.de.xml
+- ispdb_data/a1.net.xml
+- ispdb_data/active24.com.xml
+- ispdb_data/alice.it.xml
+- ispdb_data/aol.com.xml
+- ispdb_data/arcor.de.xml
+- ispdb_data/arubapec.it.xml
+- ispdb_data/att.net.xml
+- ispdb_data/bay.wind.ne.jp.xml
+- ispdb_data/bb-niigata.jp.xml
+- ispdb_data/bell.net.xml
+- ispdb_data/biglobe.ne.jp.xml
+- ispdb_data/bigpond.com.xml
+- ispdb_data/bluewin.ch.xml
+- ispdb_data/blueyonder.co.uk.xml
+- ispdb_data/bol.com.br.xml
+- ispdb_data/broba.cc.xml
+- ispdb_data/btinternet.com.xml
+- ispdb_data/cc9.ne.jp.xml
+- ispdb_data/cek.ne.jp.xml
+- ispdb_data/centurylink.net.xml
+- ispdb_data/centurytel.net.xml
+- ispdb_data/cgl.ucsf.edu.xml
+- ispdb_data/charter.net.xml
+- ispdb_data/clio.ne.jp.xml
+- ispdb_data/clustermail.de.xml
+- ispdb_data/co1.wind.ne.jp.xml
+- ispdb_data/co2.wind.ne.jp.xml
+- ispdb_data/co3.wind.ne.jp.xml
+- ispdb_data/comcast.net.xml
+- ispdb_data/cox.net.xml
+- ispdb_data/cty-net.ne.jp.xml
+- ispdb_data/dan.wind.ne.jp.xml
+- ispdb_data/dd.iij4u.or.jp.xml
+- ispdb_data/df.eu.xml
+- ispdb_data/dondominio.com.xml
+- ispdb_data/earthlink.net.xml
+- ispdb_data/educa.madrid.org.xml
+- ispdb_data/elpasotel.net.xml
+- ispdb_data/email.it.xml
+- ispdb_data/emailsrvr.com.xml
+- ispdb_data/fastwebnet.it.xml
+- ispdb_data/francetelecom.fr.xml
+- ispdb_data/free.fr.xml
+- ispdb_data/freenet.de.xml
+- ispdb_data/gandi.net.xml
+- ispdb_data/gigahost.dk.xml
+- ispdb_data/gmx.com.xml
+- ispdb_data/gmx.net.xml
+- ispdb_data/go.tvm.ne.jp.xml
+- ispdb_data/goneo.de.xml
+- ispdb_data/goo.jp.xml
+- ispdb_data/googlemail.com.xml
+- ispdb_data/gransy.com.xml
+- ispdb_data/hal.ne.jp.xml
+- ispdb_data/hana.or.jp.xml
+- ispdb_data/hotmail.com.xml
+- ispdb_data/i.softbank.jp.xml
+- ispdb_data/ic-net.or.jp.xml
+- ispdb_data/iijmio-mail.jp.xml
+- ispdb_data/iiyama-catv.ne.jp.xml
+- ispdb_data/inbox.lv.xml
+- ispdb_data/inet-shibata.or.jp.xml
+- ispdb_data/internode.on.net.xml
+- ispdb_data/ipax.at.xml
+- ispdb_data/iwafune.ne.jp.xml
+- ispdb_data/janis.or.jp.xml
+- ispdb_data/jet.ne.jp.xml
+- ispdb_data/ji.jet.ne.jp.xml
+- ispdb_data/kabelmail.de.xml
+- ispdb_data/kelcom.net.xml
+- ispdb_data/kl.wind.ne.jp.xml
+- ispdb_data/kokuyou.ne.jp.xml
+- ispdb_data/kpnmail.nl.xml
+- ispdb_data/laposte.net.xml
+- ispdb_data/libero.it.xml
+- ispdb_data/mahoroba.ne.jp.xml
+- ispdb_data/mail.com.xml
+- ispdb_data/mail.dk.xml
+- ispdb_data/mail.ee.xml
+- ispdb_data/mail.iwafune.ne.jp.xml
+- ispdb_data/mail.ru.xml
+- ispdb_data/mail.telenor.dk.xml
+- ispdb_data/mail.wind.ne.jp.xml
+- ispdb_data/me.com.xml
+- ispdb_data/messagingengine.com.xml
+- ispdb_data/ml.murakami.ne.jp.xml
+- ispdb_data/mnet.ne.jp.xml
+- ispdb_data/mopera.net.xml
+- ispdb_data/mx1.tiki.ne.jp.xml
+- ispdb_data/nifty.com.xml
+- ispdb_data/nsat.jp.xml
+- ispdb_data/ntlworld.com.xml
+- ispdb_data/o2.pl.xml
+- ispdb_data/ocn.ne.jp.xml
+- ispdb_data/office365.com.xml
+- ispdb_data/one.com.xml
+- ispdb_data/one.cz.xml
+- ispdb_data/onet.pl.xml
+- ispdb_data/outlook.com.xml
+- ispdb_data/ovh.net.xml
+- ispdb_data/pal.kijimadaira.jp.xml
+- ispdb_data/parabox.or.jp.xml
+- ispdb_data/pdx.edu.xml
+- ispdb_data/peoplepc.com.xml
+- ispdb_data/po.dcn.ne.jp.xml
+- ispdb_data/po.wind.ne.jp.xml
+- ispdb_data/pobox.com.xml
+- ispdb_data/pop.shibata.ne.jp.xml
+- ispdb_data/posteo.de.xml
+- ispdb_data/ptd.net.xml
+- ispdb_data/q.com.xml
+- ispdb_data/qq.com.xml
+- ispdb_data/rambler.ru.xml
+- ispdb_data/rr.com.xml
+- ispdb_data/runestone.net.xml
+- ispdb_data/sakunet.ne.jp.xml
+- ispdb_data/sapo.pt.xml
+- ispdb_data/schwaz.net.xml
+- ispdb_data/seznam.cz.xml
+- ispdb_data/sfr.fr.xml
+- ispdb_data/sky.com.xml
+- ispdb_data/skynet.be.xml
+- ispdb_data/so.wind.ne.jp.xml
+- ispdb_data/strato.de.xml
+- ispdb_data/studenti.univr.it.xml
+- ispdb_data/t-online.de.xml
+- ispdb_data/terra.es.xml
+- ispdb_data/thinline.cz.xml
+- ispdb_data/tiki.ne.jp.xml
+- ispdb_data/tiscali.cz.xml
+- ispdb_data/tiscali.it.xml
+- ispdb_data/umich.edu.xml
+- ispdb_data/uol.com.br.xml
+- ispdb_data/verizon.net.xml
+- ispdb_data/versatel.de.xml
+- ispdb_data/virgin.net.xml
+- ispdb_data/virginmedia.com.xml
+- ispdb_data/vm.aikis.or.jp.xml
+- ispdb_data/vp.tiki.ne.jp.xml
+- ispdb_data/web.de.xml
+- ispdb_data/webhuset.no.xml
+- ispdb_data/websupport.sk.xml
+- ispdb_data/wildwestdomains.com.xml
+- ispdb_data/wp.pl.xml
+- ispdb_data/xp.wind.jp.xml
+- ispdb_data/xtra.co.nz.xml
+- ispdb_data/yahoo.co.jp.xml
+- ispdb_data/yahoo.com.xml
+- ispdb_data/yandex.ru.xml
+- ispdb_data/ybb.ne.jp.xml
+- ispdb_data/yeah.net.xml
+- ispdb_data/zeelandnet.nl.xml
+- ispdb_data/ziggo.nl.xml
+- ispdb_data/zoho.com.xml
+- lib/mail_autoconfig.rb
+- lib/mail_autoconfig/client_config.rb
+- lib/mail_autoconfig/email_address.rb
+- lib/mail_autoconfig/server.rb
+- lib/mail_autoconfig/version.rb
+- mail_autoconfig_revived.gemspec
+- test/client_config_test.rb
+- test/email_address_test.rb
+- test/examples/client_config_yahoo.xml
+- test/server_test.rb
+homepage: https://github.com/gobijan/mail-autoconfig-revived
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Determine configuration details for a mailbox using Mozilla's ISPDB
+test_files: []