rectory 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eeb044a2397315d50b450cf868ee22f490667817
+  data.tar.gz: 033316b7d880efc48a0bce2e409ea0772eef38b9
+SHA512:
+  metadata.gz: ed757b2604cfea37bf92b8d83927725f3d4f6af55d0e4a9ffa5f3c6809b956e906a5bc20381ed6c140c1fcc1678da1eb1789d20e6dc6c39f2cd5b4bba53158bc
+  data.tar.gz: 9b99ea1f52bc566024dd99278047137f7bdc0c6d49ba912e9f8ab38a4a612deeb90a75a72654a0f0329795dba8864427b8ea3495fb8358481d46e411d0305738

data/bin/rectory

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require 'rectory'
+require 'csv'
+require 'yaml'
+require 'optparse'
+
+Celluloid.logger = nil
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Rectory"
+  opt.separator  ""
+  opt.separator  "rectory new [OPTIONS]             --- Build a template CSV for testing redirects"
+  opt.separator  "rectory test [CSV FILE] [OPTIONS] --- Test redirects from a CSV spreadsheet"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-o","--output OUTPUT","where do you want the results/scaffold to be written?") do |o|
+    options[:output] = o
+  end
+
+  opt.on("-h","--help","help")
+end
+
+opt_parser.parse!
+
+case ARGV[0]
+
+when "new"
+  output = "new_rectory_redirects.csv"
+  output = options[:output] unless options[:output].nil?
+  puts "\nGenerating new redirects spreadsheet..."
+  CSV.open(output, "wb") do |csv|
+    csv << ["url","location","code"]
+    csv << ["http://google.com","http://www.google.com",301]
+    csv << ["http://www.google.com",nil,200]
+  end
+  puts "\nFinished: #{output}\n"
+
+when "test"
+  output       = "results_#{ARGV[1]}"
+  output       = options[:output] unless options[:output].nil?
+  expectations = []
+  CSV.foreach(ARGV[1]) do |row|
+    expectations << Rectory::Expectation.new(row[0], :location => row[1], :code => row[2].to_i)
+  end
+  expectations.shift
+  puts "\nTesting #{expectations.count.to_s} expectations in #{ARGV[1]}..."
+  results = Rectory.perform expectations
+  Rectory::CsvOutputter.write results, output
+  puts "\nFinished! Report written to #{output}\n"
+
+when "help", nil
+  puts opt_parser
+
+end
+

data/lib/rectory.rb

@@ -0,0 +1,27 @@
+require 'rectory/version'
+require 'rectory/request'
+require 'rectory/csv_outputter'
+require 'rectory/expectation'
+
+Celluloid.logger = nil
+
+module Rectory
+
+  DEFAULT_CELLULOID_OPTIONS = {
+    :pool => 10
+  }
+
+  # Test the expectated results of an some HTTP requests
+  #
+  # Utilizes celluloid pooling futures for speed.
+  #
+  # @param expectations [Array] a `Rectory::Expectation` set you're testing
+  # @param options [Hash] Celluloid `pool()` options
+  # @return [Array] the same set of expectations with result attibutes updated
+  def self.perform(expectations, options = {})
+    options = DEFAULT_CELLULOID_OPTIONS.merge options
+    pool    = Rectory::Request.pool(options)
+    futures = expectations.map { |e| pool.future(:perform, e) }
+    results = futures.map(&:value)
+  end
+end

data/lib/rectory/csv_outputter.rb

@@ -0,0 +1,23 @@
+require 'csv'
+
+module Rectory
+  # Write the results of a test to a simple CSV file
+  class CsvOutputter
+    # @param results [Array] Rectory::Expectation set (with Rectory::Results)
+    # @param output [String] path to the desired output CSV
+    # @param options [Hash] options for CSV.open()
+    # @return [nil]
+    def self.write(results, output, options = {})
+
+      CSV.open(output, "wb", options) do |csv|
+        csv << ["url","location","code","result_location","result_code","pass"]
+
+        results.each do |r|
+          csv << [r.url, r.location, r.code, r.result[:location], r.result[:code], r.pass?]
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/rectory/expectation.rb

@@ -0,0 +1,54 @@
+module Rectory
+
+  # The expectations for an HTTP request.
+  #
+  # @attr code The expected HTTP status code. (200, 302, 304, 404, 400, etc)
+  # @attr location The expected HTTP `Location` header, or the end location of a redirect. Should be `nil` if the expectation is not a redirect (200, 304, 404, etc)
+  # @attr url The URL to test
+  # @attr result A Rectory::Result instance which contains HTTP repsonse details
+  class Expectation
+
+    attr_accessor :url, :location, :code, :result
+
+    # @param url [String] The URL against which to test an HTTP reponse
+    # @param args [Hash] A hash of HTTP response expectations (`:code`, `:location`)
+    def initialize(url, args = {})
+      raise ArgumentError, "You must provide a URL to test!" if url.nil?
+
+      defaults = {
+        :code   => 200,
+        :result => {}
+      }
+
+      args          = defaults.merge args
+      self.url      = url
+      self.code     = args[:code].to_i
+      self.result   = args[:result]
+      self.location = args[:location]
+    end
+
+    # Determines whether the HTTP result satifies the expectations
+    #
+    # Verifies that both status code and location match
+    #
+    # @return [Boolean]
+    def pass?
+      perform if result.empty?
+      truths = []
+      truths << (result[:location].to_s.gsub(/\/$/, "") == location.to_s.gsub(/\/$/, ""))
+      truths << (result[:code] == code.to_i) unless code.nil?
+      truths.all?
+    end
+
+    private
+
+    # Run self through Rectory::Verfier#perform
+    #
+    # Updates the `result` attribute
+    def perform
+      v = Rectory::Request.new
+      r = v.perform self
+      nil
+    end
+  end
+end

data/lib/rectory/request.rb

@@ -0,0 +1,29 @@
+require 'open-uri'
+require 'net/http'
+require 'celluloid'
+
+module Rectory
+
+  # Test the expectated results of an HTTP request
+  class Request
+    include Celluloid
+
+    # Test the expectated results of an HTTP request
+    #
+    # @param expectation [Rectory::Expectation] the expectation you're testing
+    # @return [Rectory::Expectation] the same expectation with result attributes updated
+    def perform(expectation)
+      uri = URI expectation.url
+      req = Net::HTTP::Get.new uri.request_uri
+
+      res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request req
+      end
+
+      expectation.result[:location] = res['location']
+      expectation.result[:code]     = res.code.to_i
+
+      return expectation
+    end
+  end
+end

data/lib/rectory/version.rb

@@ -0,0 +1,3 @@
+module Rectory
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: rectory
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kyle Truscott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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: Quickly test HTTP redirects and status codes.
+email:
+- keighl@keighl.com
+executables:
+- rectory
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rectory.rb
+- lib/rectory/request.rb
+- lib/rectory/csv_outputter.rb
+- lib/rectory/expectation.rb
+- lib/rectory/version.rb
+- bin/rectory
+homepage: https://github.com/keighl/rectory
+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.0.2
+signing_key: 
+specification_version: 4
+summary: 'HHave a ton of HTTP redirects, and need to verify they''re working? Use
+  this. Give rectory a list of live HTTP expectations, and it''ll tell you what happens:
+  status code, location, and whether it behaved as expected (i.e pass/fail).'
+test_files: []
+has_rdoc: