artichoke 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9c35daad5742135d314847c64df4ee0c44b1caf
+  data.tar.gz: 34cdaf8a43bcaa5b28fe374615fff4294e398725
+SHA512:
+  metadata.gz: 4b405cdf7b2781f4473e7db93bcd25a384e75a593eb42aa7fa9634a9f9c0632cd40a0c8c0a5746795f5e04d86b2aab65c2c5be286892122e0da2e6c63ec8bc6d
+  data.tar.gz: 3b7fe0e9c0d8f43cc54e177251fc6c05b4964e98964f3086384d9986cd950e48e3486324f168aa8c5626a501be4c191cdbe03d544f4a729fd943496c73a6e5cb

data/README.md

@@ -0,0 +1,71 @@
+# Artichoke
+
+Artichoke is a library for gmail integration within testing suites. Artichoke is best used in conjuction with integration test tools such as RSpec, Capybara, and/or Cucumber. Artichoke uses Mail objects for storing the emails. The emails will not be marked as read on Gmail.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'artichoke'
+
+Or install it yourself as:
+
+    $ gem install artichoke
+
+
+## Configuration
+
+Add this to intializer:
+
+    Artichoke::Connection.configure do |config|
+      config.username = 'ninja@gmail.com'
+      config.password = 'topsecret'
+    end
+
+## Setting Poller Start Time
+
+Artichoke uses a email polling system to find and evaluate email(s) information that can be later used for assertions or follow up actions. In order to set the start time for the polling system, you must create an instance of the poller for later use:
+
+    @poller = Artichoke::Poller.new
+
+This is best used prior to an action that should trigger the email you want to evaluate.
+
+
+### Find email by subject
+
+    #    You can pass in a defined timeout period for the poller to execute
+    #    and if not defined, it will default to 75 seconds.
+    email = @poller.find({message_subject: "Ninjas are coming!!", timeout: 30})
+    
+
+### Find email by subject and content(s)
+    
+    # Find email by subject and single content criteria
+    email = @poller.find({message_subject: "Shinobi Poetry", timeout: 30, content: ["Blackest day"]})
+
+    # Find email by subject and multiple content criteria
+    email = @poller.find({message_subject: "Shinobi Poetry", timeout: 30, content: ["Blackest day", "Katana night"]})
+
+### Find email by subject and/or content(s) and/or attachment filenames
+    
+    email = @poller.find({message_subject: "Shinobi Poetry", timeout: 30, content: ["Blackest day"], attachments: ["yohashi.pdf", "shuriken.png"]})
+
+    
+### Assert that no email was sent with given criteria
+
+    #    By default, the poller raises an error if no email was found
+    #    within the determined timeout. However, you can pass the skip_error parameter
+    #    in order to silence the error, so that you can assert no email was sent.
+    email = @poller.find({message_subject: "I wear Kimonos on weekends", timeout: 30, skip_error: false})
+    email.should be_nil
+
+### Evaluating and Manipulating the returned Message object
+
+    # You can now do evaluations on the email, such as reading the body
+    email.body.should have_content "I am forever in your debt master..."
+
+    #   You can also evaluate attachments by calling email.attachments
+    #   or return the first attachment's filename by using
+    email.attachment_name
+
+For more operations that can be performed on the Message object, please visit [Mail](http://rubygems.org/gems/mail) rubygem. See its [documentation here](http://github.com/mikel/mail).

data/artichoke.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$: << File.expand_path('../lib', __FILE__)
+require 'artichoke/version'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nathaniel Ritholtz"]
+  gem.email         = ["nritholtz@gmail.com"]
+  gem.description   = %q{A library for gmail integration within testing suites, best used in conjuction with integration test tools such as RSpec, Capybara, and/or Cucumber.}
+  gem.summary       = %q{A library for gmail integration within testing suites.}
+  gem.homepage      = "https://github.com/nritholtz/artichoke"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.name          = "artichoke"
+  gem.require_paths = ["lib"]
+  gem.version       = Artichoke::VERSION
+
+  gem.add_runtime_dependency 'ruby-gmail-nritholtz', '~> 0.3.3'
+  gem.add_runtime_dependency 'activesupport', '>= 3.1'
+end

data/lib/artichoke.rb

@@ -0,0 +1,7 @@
+require 'gmail'
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'artichoke/connection'
+require 'artichoke/message'
+require 'artichoke/poller'

data/lib/artichoke/connection.rb

@@ -0,0 +1,15 @@
+module Artichoke
+  class Connection
+    include ActiveSupport::Configurable
+
+    config_accessor :username, :password
+
+    def self.client_username
+      config.username || raise("Please configure a username")
+    end
+
+    def self.client_password
+      config.password || raise("Please configure a password")
+    end
+  end
+end

data/lib/artichoke/message.rb

@@ -0,0 +1,22 @@
+module Artichoke
+  class Message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def attachment_name
+      attachments.first.filename
+    end
+
+    private
+     # Delegate all other methods to the Gmail message
+    def method_missing(*args, &block)
+      if block_given?
+        @message.send(*args, &block)
+      else
+        @message.send(*args)
+      end
+    end
+  end
+end

data/lib/artichoke/poller.rb

@@ -0,0 +1,51 @@
+module Artichoke
+  class Poller
+
+    def initialize
+      @gmail_start_time = DateTime.now
+    end
+
+
+    def client
+      username = Artichoke::Connection.client_username
+      password = Artichoke::Connection.client_password
+      begin
+        @gmail = Gmail.new(username, password)
+        @gmail.peek = true
+        yield
+      rescue Net::IMAP::ByeResponseError
+        retry
+      ensure      
+        @gmail.disconnect
+      end
+    end
+
+
+    ### poller.find({message_subject: "Sample Email", timeout:75, content:["specific positioning", "footer"], attachments:["picture.jpg", "spreadsheet.csv"], skip_error: false})
+    def find(options={})
+      raise ArgumentError.new("Email Subject required") unless options[:message_subject]
+      begin
+        Timeout::timeout(options[:timeout]|| 75) do
+          while true do
+            client do
+              gm_string = "newer:#{@gmail_start_time.to_i} subject:"+options[:message_subject]
+              if options[:attachments]
+                options[:attachments].each{|attachment| gm_string += attachment+" "} 
+                gm_string+= " has:attachment"
+              end
+              @gmail.inbox.emails(:gm => gm_string).each do |email|
+                message = email.message
+                if message.date.to_i >= @gmail_start_time.to_i
+                  body = message.body.to_s.force_encoding('utf-8')
+                  return Message.new(message) if (options[:content]|| []).all?{|c| body =~ /#{c}/}
+                end
+              end
+            end
+          end
+        end
+      rescue Timeout::Error => e
+        raise "No email was found with subject: #{options[:message_subject]} >= #{@gmail_start_time}, content(s): #{options[:content]||'N/A'}, attachment(s) #{options[:attachments]||'N/A'}"  unless options[:skip_error]
+      end
+    end
+  end
+end

data/lib/artichoke/version.rb

@@ -0,0 +1,3 @@
+module Artichoke
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: artichoke
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathaniel Ritholtz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-gmail-nritholtz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A library for gmail integration within testing suites, best used in conjuction
+  with integration test tools such as RSpec, Capybara, and/or Cucumber.
+email:
+- nritholtz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- artichoke.gemspec
+- lib/artichoke.rb
+- lib/artichoke/connection.rb
+- lib/artichoke/message.rb
+- lib/artichoke/poller.rb
+- lib/artichoke/version.rb
+homepage: https://github.com/nritholtz/artichoke
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A library for gmail integration within testing suites.
+test_files: []