reportir 0.2.0

data/lib/reportir.rb

@@ -0,0 +1,109 @@
+require "reportir/version"
+require 's3_uploader'
+require 'aws-sdk'
+
+module Reportir
+  @@static_site_template_path = Gem.find_files('reportir')[1] +'/static_site_template'
+  @@template_subdirectory_for_test_artifacts = 'test_run'
+  @@step = 0
+
+  def upload_result_to_s3_as_static_site
+    check_for_env_vars
+    clone_template
+    reset_orig_template # TODO: clone before screenshots are possible
+    save_final_markup_in_clone
+    write_ractive_models_in_clone(screenshots: screenshot_paths, nav: nav_links)
+    upload_clone_to_s3
+    delete_local_clone
+  end
+  
+  private
+
+  def check_for_env_vars
+    raise Reportir::Error.new 'Missing ENV AWS_DEFAULT_BUCKET' unless ENV['AWS_DEFAULT_BUCKET']
+    raise Reportir::Error.new 'Missing ENV AWS_SECRET_ACCESS_KEY' unless ENV['AWS_SECRET_ACCESS_KEY']
+    raise Reportir::Error.new 'Missing ENV AWS_ACCESS_KEY_ID' unless ENV['AWS_ACCESS_KEY_ID']
+    raise Reportir::Error.new 'Missing ENV AWS_DEFAULT_REGION' unless ENV['AWS_DEFAULT_REGION']
+  end
+
+  def clone_template
+    FileUtils.cp_r "#{@@static_site_template_path}/.", clone_dir_path
+  end
+
+  def reset_orig_template
+    FileUtils.rm_rf "#{@@static_site_template_path}/#{@@template_subdirectory_for_test_artifacts}"
+  end
+
+  def save_final_markup_in_clone
+    s3_screenshot('final')
+    File.open("#{deletable_data_path}/final.html", 'w') {|f| f.write @browser.html }
+  end
+
+  def write_ractive_models_in_clone(data)
+    data.each do |k,v|
+      model = {el: "##{k}_container", template: "##{k}_template", data: {k => v}}
+      File.open("#{clone_dir_path}/js/main.js", "a") { |f| f.write("var #{k} = new Ractive(#{model.to_json});\n") }
+    end
+  end
+
+  def upload_clone_to_s3
+    puts '====== STARTING S3 UPLOAD ========='
+    puts ''
+    ::Aws::S3::Bucket.new(ENV['AWS_DEFAULT_BUCKET']).clear!
+    ::S3Uploader.upload_directory(clone_dir_path, ENV['AWS_DEFAULT_BUCKET'], { 
+      :destination_dir => test_name, 
+      :threads => 5, 
+      s3_key: ENV['AWS_ACCESS_KEY_ID'], 
+      s3_secret: ENV['AWS_SECRET_ACCESS_KEY'], 
+      region: ENV['AWS_DEFAULT_REGION'] })   
+    puts ''
+    puts '====== S3 UPLOAD COMPLETE ========='
+    puts 'URL: ' + static_site_url
+    puts '==================================='
+  end
+
+  def delete_local_clone
+    FileUtils.rm_rf clone_dir_path
+  end
+
+  def test_name
+    RSpec.current_example.metadata[:full_description].gsub(/[^\w\s]/,'').gsub(/\s/,'_')
+  end
+
+  def clone_dir_path
+    "./tmp/#{test_name}"
+  end
+
+  def static_site_url
+    "http://#{ENV['AWS_DEFAULT_BUCKET']}.s3-website-#{ENV['AWS_DEFAULT_REGION']}.amazonaws.com/#{test_name}"
+  end
+
+  def s3_screenshot(method)
+    @@step = @@step+=1
+    image_name = "#{@@step}-#{method}" 
+    FileUtils.mkdir_p(deletable_data_path) unless Dir.exists?(deletable_data_path)
+    @browser.screenshot.save("#{deletable_data_path}/#{image_name}.png")
+  end
+
+  def deletable_data_path
+    "#{clone_dir_path}/#{@@template_subdirectory_for_test_artifacts}"
+  end
+
+  def nav_links
+    {'Last Page as Markup' => "#{@@template_subdirectory_for_test_artifacts}/final.html"}
+  end
+
+  def screenshot_paths
+    images = []
+    Dir["#{deletable_data_path}/**/*.png"].sort_by { |x| x[/\d+/].to_i }.each do |src|
+      images << "#{@@template_subdirectory_for_test_artifacts}/#{Pathname.new(src).basename}"
+    end
+    images
+  end
+
+  def clear_out_any_old_results
+    puts "> Cleaning out old #{deletable_data_path} directory"
+    FileUtils.rm_rf "#{deletable_data_path}/*"
+  end
+  class Error < ::StandardError; end
+end

data/reportir.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reportir/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reportir"
+  spec.version       = Reportir::VERSION
+  spec.authors       = ["Dean Shelton"]
+  spec.email         = ["deanshelton913@gmail.com"]
+
+  spec.summary       = %q{Send screenshots to s3 as a reviewable website}
+  spec.description   = %q{Take screenshots with capybara/watir/whatever, and upload them automatically to an AWS S3 bucket as a static website. Requires static site configuration in S3.}
+  spec.homepage      = "http://github.com/reportir"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency 's3_uploader'
+  spec.add_runtime_dependency 'aws-sdk'
+  spec.add_runtime_dependency 'fileutils'
+  spec.add_runtime_dependency 'json'
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: reportir
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Dean Shelton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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: s3_uploader
+  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: aws-sdk
+  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: fileutils
+  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: json
+  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'
+description: Take screenshots with capybara/watir/whatever, and upload them automatically
+  to an AWS S3 bucket as a static website. Requires static site configuration in S3.
+email:
+- deanshelton913@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reportir.rb
+- lib/reportir/static_site_template/.editorconfig
+- lib/reportir/static_site_template/.gitattributes
+- lib/reportir/static_site_template/.gitignore
+- lib/reportir/static_site_template/.htaccess
+- lib/reportir/static_site_template/404.html
+- lib/reportir/static_site_template/LICENSE.txt
+- lib/reportir/static_site_template/apple-touch-icon.png
+- lib/reportir/static_site_template/browserconfig.xml
+- lib/reportir/static_site_template/crossdomain.xml
+- lib/reportir/static_site_template/css/font/FontAwesome.otf
+- lib/reportir/static_site_template/css/font/fontawesome-webfont.eot
+- lib/reportir/static_site_template/css/font/fontawesome-webfont.svg
+- lib/reportir/static_site_template/css/font/fontawesome-webfont.ttf
+- lib/reportir/static_site_template/css/font/fontawesome-webfont.woff
+- lib/reportir/static_site_template/css/main.css
+- lib/reportir/static_site_template/css/normalize.css
+- lib/reportir/static_site_template/css/vendor/bootstrap.min.css
+- lib/reportir/static_site_template/css/vendor/font-awesome.min.css
+- lib/reportir/static_site_template/doc/TOC.md
+- lib/reportir/static_site_template/doc/css.md
+- lib/reportir/static_site_template/doc/extend.md
+- lib/reportir/static_site_template/doc/faq.md
+- lib/reportir/static_site_template/doc/html.md
+- lib/reportir/static_site_template/doc/js.md
+- lib/reportir/static_site_template/doc/misc.md
+- lib/reportir/static_site_template/doc/usage.md
+- lib/reportir/static_site_template/favicon.ico
+- lib/reportir/static_site_template/humans.txt
+- lib/reportir/static_site_template/img/.gitignore
+- lib/reportir/static_site_template/img/pagination.png
+- lib/reportir/static_site_template/index.html
+- lib/reportir/static_site_template/js/main.js
+- lib/reportir/static_site_template/js/plugins.js
+- lib/reportir/static_site_template/js/vendor/bootstrap.min.js
+- lib/reportir/static_site_template/js/vendor/jquery-1.11.3.min.js
+- lib/reportir/static_site_template/js/vendor/jquery.slides.min.js
+- lib/reportir/static_site_template/js/vendor/modernizr-2.8.3.min.js
+- lib/reportir/static_site_template/robots.txt
+- lib/reportir/static_site_template/tile-wide.png
+- lib/reportir/static_site_template/tile.png
+- lib/reportir/version.rb
+- reportir.gemspec
+homepage: http://github.com/reportir
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Send screenshots to s3 as a reviewable website
+test_files: []