sniper_links 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e1ee9e32fff28607ae53550191cd7ec5b75096da6f6d384113de1c07a97a0fe
+  data.tar.gz: 117295b332c0ae0a330d7cbb4c0a68117790ea66081431ad771b04c6a192bf3d
+SHA512:
+  metadata.gz: 243adbe12828aca4bb640e2cbc8d6c383384095ad04d642eadb358425ebd7eea73b4b6c10a0ff0b1f0cbbfb780c7de672d96eab9b5dbc3ab513080a94f59b5e8
+  data.tar.gz: 0d275292b1aeee14aa00dd80b6242371395fd4d6892aa8937963a136bee4a527823ea92d2a669db5329d371c7166423c37db70ac799058d04f96e2e9770796b9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.1.0 - 2025-05-23
+
+### Added
+
+* Support for GMail (browser link only)
+* Support for Outlook (browser link only)
+* Support for Yahoo (browser link only)
+* Support for ProtonMail (browser link only)
+* Support for iCloud (browser link only)
+
+### Fixed
+
+* n/a
+
+### Changed
+
+* n/a
+
+### Breaking Changes
+
+* n/a

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gabriel@zero-one.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sniper_links.gemspec
+gemspec
+
+gem "rake",  "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rspec-its"
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    sniper_links (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.6.2)
+    method_source (1.1.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-its (1.3.1)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-its
+  sniper_links!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Gabriel Fortuna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# SniperLinks
+
+This gem helps with creating sniper links for various email platforms.
+
+Sniper links are links that can be supplied to your users, to help them find emails from you more easily.
+
+You can read more about [Sniper Links in this post](https://growth.design/sniper-link).
+
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Using a strategy directly](#using-a-strategy-directly)
+* [Supported Platforms](#supported-platforms)
+  * [Sniper link strategy functionality](#sniper-link-strategy-functionality)
+* [Development](#development)
+* [Contributing](#contributing)
+  * [Feature wishlist](#feature-wishlist)
+* [License](#license)
+* [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sniper_links'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sniper_links
+
+## Usage
+
+```ruby
+email = "marlon.rando@gmail.com"
+from  = "us@our.domain"
+
+snipe = SniperLinks.new(email) # => SniperLinks
+snipe.sniper_link_strategy     # => SniperLinks::Strategies::GMail
+snipe.sniper_link(from)        # => URI
+
+puts snipe.sniper_link.to_s
+# => https://mail.google.com/mail/u/0/#search/from%3A%28us%40our.domain%29%2Bin%3Aanywhere%2Bnewer_than%3A1h
+```
+
+### Using a strategy directly
+
+If you want to use a strategy directly, you can do so like so:
+
+```ruby
+email = "rando.calrissian@foo.com"
+from  = "us@our.domain"
+
+snipe = SniperLinks.new(email) # This will raise an error
+# Traceback (most recent call last):
+# ....
+# SniperLinks::Error (Unsupported email domain)
+
+snipe = SniperLinks::Strategies::GMail.new(email) # => SniperLinks::Strategies::GMail
+snipe.sniper_link(from)                           # => URI
+```
+
+## Supported Platforms
+
+We support the following email service provider platforms:
+
+* Gmail - `*@gmail.com`
+* Outlook - `*@outlook.com`
+* Yahoo - `*@yahoo.*` or `*@myyahoo.*`
+* ProtonMail - `*@protonmail.com`, `*@proton.me`, `*@protonmail.ch`, or `*@pm.me`
+* iCloud - `*@icloud.com`, `*@me.com`, or `*@mac.com`
+
+### Sniper link strategy functionality
+
+Each email service provider has its own sniper link strategy. The following table shows how much functionality is supported by each provider.
+
+|              | Gmail | Outlook | Yahoo | Protonmail | iCloud |
+|--------------|-------|---------|-------|------------|--------|
+| Link         |  ✔️   |  ✔️     |  ✔️  |     ✔️     |   ✔️   |
+| Account      |  ✔️   |  ✔️     |  ✖️  |     ✖️️     |   ✖️   |
+| From filter  |  ✔️   |  ✖️️️️     |  ✔️  |     ✔️     |   ✖️   |
+| Spam piercer |  ✔️   |  ✖️️️️     |  ✔️  |     ✔️     |   ✖️   |
+| Time filter  |  ✔️   |  ✖️️️️     |  ✔️  |     ✔️     |   ✖️   |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zero-one-software/sniper-links. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/zero-one-software/sniper-links/blob/master/CODE_OF_CONDUCT.md).
+
+### Feature wishlist
+
+* Add support for more email service providers, like Hey.com, Fastmail, etc.
+* Add support for selecting a strategy based on the email address domain's MX records.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SniperLinks project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zero-one-software/sniper-links/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sniper_links"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sniper_links/strategies/apple.rb

@@ -0,0 +1,19 @@
+class SniperLinks
+  module Strategies
+    class Apple
+      def initialize(email)
+        @email = email
+      end
+
+      def sniper_link(_from = nil)
+        URI("https://www.icloud.com/mail/")
+      end
+
+      attr_reader :email
+    end
+  end
+end
+
+__END__
+
+https://www.icloud.com/mail/

data/lib/sniper_links/strategies/gmail.rb

@@ -0,0 +1,34 @@
+class SniperLinks
+  module Strategies
+    class GMail
+      def initialize(email)
+        @email = email
+      end
+
+      def sniper_link(from)
+        @from = from
+
+        sniper_filter = encode(filter)
+
+        URI("https://mail.google.com/mail/u/0/#search/#{sniper_filter}")
+      end
+
+      private
+
+      def filter
+        "from:(#{from}) in:anywhere newer_than:1h"
+      end
+
+      def encode(str)
+        URI.encode_www_form_component(str)
+      end
+
+
+      attr_reader :email, :from
+    end
+  end
+end
+
+__END__
+
+https://mail.google.com/mail/u/0/#search/from%3A(user%40some.domain)+in%3Aanywhere+newer_than%3A1h

data/lib/sniper_links/strategies/outlook.rb

@@ -0,0 +1,27 @@
+class SniperLinks
+  module Strategies
+    class Outlook
+      def initialize(email)
+        @email = email
+      end
+
+      def sniper_link(from)
+        @from = from
+
+        URI("https://outlook.live.com/mail/?login_hint=#{encode(from)}")
+      end
+
+      private
+
+      def encode(str)
+        URI.encode_www_form_component(str)
+      end
+
+      attr_reader :email, :from
+    end
+  end
+end
+
+__END__
+
+https://outlook.live.com/mail/?login_hint=encoded_email}

data/lib/sniper_links/strategies/proton.rb

@@ -0,0 +1,28 @@
+class SniperLinks
+  module Strategies
+    class Proton
+      def initialize(email)
+        @email = email
+      end
+
+      def sniper_link(from)
+        @from  = from
+        filter = encode(from)
+
+        URI("https://mail.proton.me/u/0/all-mail#from=#{filter}")
+      end
+
+      private
+
+      def encode(str)
+        URI.encode_www_form_component(str)
+      end
+
+      attr_reader :email, :from
+    end
+  end
+end
+
+__END__
+
+https://mail.proton.me/u/0/all-mail#from=user%40some.domain

data/lib/sniper_links/strategies/yahoo.rb

@@ -0,0 +1,28 @@
+class SniperLinks
+  module Strategies
+    class Yahoo
+      def initialize(email)
+        @email = email
+      end
+
+      def sniper_link(from)
+        @from  = from
+        filter = encode(from)
+
+        URI("https://mail.yahoo.com/d/search/keyword=from%253A#{filter}")
+      end
+
+      private
+
+      def encode(str)
+        URI.encode_www_form_component(str)
+      end
+
+      attr_reader :email, :from
+    end
+  end
+end
+
+__END__
+
+https://mail.yahoo.com/d/search/keyword=from%253Auser%40some.domain

data/lib/sniper_links/version.rb

@@ -0,0 +1,3 @@
+class SniperLinks
+  VERSION = "0.1.0"
+end

data/lib/sniper_links.rb

@@ -0,0 +1,54 @@
+require "sniper_links/version"
+
+require "uri"
+
+require "sniper_links/strategies/apple"
+require "sniper_links/strategies/gmail"
+require "sniper_links/strategies/outlook"
+require "sniper_links/strategies/proton"
+require "sniper_links/strategies/yahoo"
+
+class SniperLinks
+  class Error < StandardError; end
+
+  def initialize(email)
+    @email = email
+
+    extract_domain
+    sniper_link_strategy
+
+    self
+  end
+
+  def sniper_link(from)
+    sniper_link_strategy.sniper_link(from)
+  end
+
+  def extract_domain
+    @domain = email.split("@").last
+  end
+
+  def sniper_link_strategy
+
+    @_sniper_link_strategy ||= case domain
+                               when /gmail\.com\z/
+                                 SniperLinks::Strategies::GMail.new(email)
+                               when /outlook\.com\z/
+                                 SniperLinks::Strategies::Outlook.new(email)
+                               when /(my)?yahoo\./
+                                 SniperLinks::Strategies::Yahoo.new(email)
+                               when /protonmail\.(com|ch)\z/
+                                 SniperLinks::Strategies::Proton.new(email)
+                               when /(proton|pm).me\z/
+                                 SniperLinks::Strategies::Proton.new(email)
+                               when /(me|mac|icloud)\.com\z/
+                                 SniperLinks::Strategies::Apple.new(email)
+                               else
+                                 raise Error, "Unsupported email domain"
+                               end
+  end
+
+  private
+
+  attr_reader :email, :domain
+end

data/sniper_links.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/sniper_links/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = "sniper_links"
+  spec.version = SniperLinks::VERSION
+  spec.authors = ["Gabriel Fortuna"]
+  spec.email   = ["gabriel@zero-one.io"]
+
+  spec.summary               = "Generate sniper links for various email platforms"
+  spec.description           = "Increase your email open rates with sniper links. This gem generates sniper links for various email platforms, increasing the chance that an email will be acted on."
+  spec.homepage              = "https://www.zero-one.io"
+  spec.license               = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  # spec.metadata["source_code_uri"]   = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"]     = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: sniper_links
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gabriel Fortuna
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-23 00:00:00.000000000 Z
+dependencies: []
+description: Increase your email open rates with sniper links. This gem generates
+  sniper links for various email platforms, increasing the chance that an email will
+  be acted on.
+email:
+- gabriel@zero-one.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sniper_links.rb
+- lib/sniper_links/strategies/apple.rb
+- lib/sniper_links/strategies/gmail.rb
+- lib/sniper_links/strategies/outlook.rb
+- lib/sniper_links/strategies/proton.rb
+- lib/sniper_links/strategies/yahoo.rb
+- lib/sniper_links/version.rb
+- sniper_links.gemspec
+homepage: https://www.zero-one.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.zero-one.io
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Generate sniper links for various email platforms
+test_files: []