coruro-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e972d5e9538e44b78c6c54d0d394bdea0cb13c3438606d46161e738f7280815
+  data.tar.gz: 0c757e7cd8cd4d66e63ba5a3d3c80bc3d395ed448f3755528c519995a6ba7b4e
+SHA512:
+  metadata.gz: ee53e053db2fa3eee837b455ccf16a987cacb642b619b19f7e8aee1a7e5de991fdc7dd20d8b2a4c7a10c0865b5e1f80e6f8d2c43a100aed696d2a9863a86db75
+  data.tar.gz: 4c8c8567364f9c3fff19efbd22e97c46cf01778cffb1bc16852be7e277e34bde945d3a97637576ad73450796825dfac79e63fbd38e615cc501b5343e0a2291b6

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in coruro-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    coruro-ruby (0.1.0)
+      mail (~> 2.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    minitest (5.11.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coruro-ruby!
+  minitest (~> 5.0)
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,65 @@
+# Coruro Ruby
+
+The Ruby version of [Coruro](../README.md). This README provides details for the ruby-specific Coruro implementation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coruro-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coruro-ruby
+
+## Usage
+
+
+```ruby
+# Instantiate a Coruro instance. This also ensures Mailcatcher is running
+coruro = Coruro.new(adapter: :mailcatcher)
+
+# Load the emails mailcatcher caught to "your-fave@example.com"
+messages_to_my_fave = coruro.where(to: /your-fave@example.com/)
+# Since these are instances of a Mail object at the moment, which means they probably play nice with [EmailSpec::Matchers](https://github.com/email-spec/email-spec#rspec-matchers)
+include EmailSpec::Matchers
+messages_to_my_fave.each do
+  assert_must deliver_to("your-fave@example.com")
+end
+```
+
+### Tearing Down Mailcatcher
+Because Coruro manages a local mailcatcher process, you may want to clean up *after* your test suite runs. Otherwise you may wind up with an orphaned Mailcatcher process. This isn't the end of the world, since Mailcatcher will refuse to start a second process if one is running already, but if you don't want it to stick around you can perform a post-suite cleanup. This is done by calling `#stop` on an instance of Coruro. See the following example for Minitest:
+
+```ruby
+Minitest.after_run do
+  Coruro.new(adapter: :mailcatcher).stop
+end
+```
+For those using Rspec, you will want to use the appropriate [`after` hook](https://relishapp.com/rspec/rspec-core/v/3-7/docs/hooks/before-and-after-hooks).
+
+For Cucumber users, you will want want to use the [`at_exit` global hook](https://github.com/cucumber/cucumber/wiki/Hooks#global-hooks)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bin/rake install`. To release a new version, update the version number in `version.rb`, and then run `bin/rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wecohere/coruro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](../CODE_OF_CONDUCT.md). See [Our Contributing Guide](../CONTRIBUTING.md) for more details.
+
+## 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 coruro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](../CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mailcatcher/client/ruby"
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+gem install mailcatcher

data/coruro-ruby.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "coruro/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "coruro-ruby"
+  spec.version       = Coruro::VERSION
+  spec.authors       = ["Zee Spencer"]
+  spec.email         = ["zee@wecohere.com"]
+
+  spec.summary       = %q{Capybara-inspired testing library for emails and notifications}
+  spec.description   = %q{Capybara-inspired testing library for emails and notifications. Query sent emails and make assertions against he and make assertions against them}
+  spec.homepage      = "https://github.com/wecohere/coruro"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_dependency "mail", "~> 2.7.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

data/lib/coruro/mailcatcher_adapter.rb

@@ -0,0 +1,86 @@
+require 'net/http'
+require 'json'
+require 'open3'
+require 'singleton'
+
+class Coruro
+  # Translates between Curoro and Mailcatcher's API
+  class MailcatcherAdapter
+    attr_accessor :runner, :timeout
+    def initialize(timeout:)
+      self.timeout = timeout
+    end
+
+    def all
+      messages
+    end
+
+    def where(to: nil, from: nil, subject: nil)
+      result = []; start_time = Time.now.to_f
+      while (result.empty? || (Time.now.to_f - start_time) <=  timeout)
+        result = messages.select do |message|
+          match?(to, message[:recipients]) ||
+          match?(from, message[:sender]) ||
+          match?(subject, message[:subject])
+        end.map(&method(:find_by))
+      end
+      result
+    end
+
+    def match?(query, value)
+      return false if query.nil?
+      return query.match?(value) if query.respond_to?(:match?) && !value.respond_to?(:any?)
+      return value.any? { |child| match?(query, child) } if value.respond_to?(:any?)
+      raise ArgumentError, "Query #{query} must respond to `match?` or Value #{value} must respond to `any?`"
+    end
+
+    extend Forwardable
+    def_delegators :runner, :up?, :start, :stop
+
+    def runner
+      @_runner ||= Runner.instance
+    end
+
+    private def messages
+      JSON.parse(Net::HTTP.get(URI("http://127.0.0.1:1080/messages")), symbolize_names: true)
+    end
+
+    private def raw_message(message_id)
+      Net::HTTP.get(URI("http://127.0.0.1:1080/messages/#{message_id}.eml"))
+    end
+
+
+    private def find_by(attributes)
+      message = Message.new(Mail.new(raw_message(attributes[:id])))
+      message.id = attributes[:id]
+      message
+    end
+
+    # Allows for launching and terminating mailcatcher programmaticaly
+    class Runner
+      include Singleton
+      attr_accessor :stdin, :stdout, :stderr, :thread
+
+      def start
+        return if up?
+        self.stdin, self.stdout, self.stderr, self.thread =
+          Open3.popen3({ "PATH" => ENV['PATH'] }, 'mailcatcher -f', { unsetenv_others:true })
+      end
+
+      def up?
+        response = Net::HTTP.get_response(URI('http://127.0.0.1:1080'))
+        response.is_a?(Net::HTTPSuccess)
+      rescue Errno::ECONNREFUSED, Errno::EADDRNOTAVAIL => _
+        false
+      end
+
+      def stop
+        return unless self.thread
+        self.stdin.close
+        self.stdout.close
+        self.stderr.close
+        `kill -9 #{ thread[:pid] }`
+      end
+    end
+  end
+end

data/lib/coruro/message.rb

@@ -0,0 +1,5 @@
+class Coruro
+  class Message < SimpleDelegator
+    attr_accessor :id
+  end
+end

data/lib/coruro/version.rb

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

data/lib/coruro.rb

@@ -0,0 +1,36 @@
+require 'mail'
+
+require_relative 'coruro/version'
+
+require_relative 'coruro/message'
+
+require_relative 'coruro/mailcatcher_adapter'
+
+class Coruro
+  attr_accessor :adapter
+  extend Forwardable
+  def_delegators :adapter, :all, :where, :stop
+
+  def initialize(adapter:, on_wait_tick: -> (count) { }, timeout: 0.1)
+    case adapter
+    when :mailcatcher
+      self.adapter = MailcatcherAdapter.new(timeout: timeout)
+      self.adapter.start
+    else
+      raise UnrecognizedAdapterError, adapter
+    end
+
+    wait_until_up(on_wait_tick)
+  end
+
+  def wait_until_up(on_tick)
+    count = 0
+    until adapter.up? || count > 5
+      on_tick.call(count)
+      sleep(1)
+    end
+  end
+
+  class UnrecognizedAdapterError < StandardError; end
+end
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: coruro-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zee Spencer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capybara-inspired testing library for emails and notifications. Query
+  sent emails and make assertions against he and make assertions against them
+email:
+- zee@wecohere.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- coruro-ruby.gemspec
+- lib/coruro.rb
+- lib/coruro/mailcatcher_adapter.rb
+- lib/coruro/message.rb
+- lib/coruro/version.rb
+homepage: https://github.com/wecohere/coruro
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Capybara-inspired testing library for emails and notifications
+test_files: []