integration-diff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a238c08a8c42c20475b99d034b2560c1d97fdf8
+  data.tar.gz: 5e49985f73ffc19895cb45de6088716e7917547b
+SHA512:
+  metadata.gz: 8f558f62dc340c5d0cc9b5d12b0aacac6a8733f9607c8040d27e11e77e3bff44c1ca59b127d701dc0f3f4059401dbc11db6ae82e7fa397b30eb180282d134142
+  data.tar.gz: 42f96558e1982174434c2a15dbee7af0cd00b082d2e69866f3091b404669581fe1026010d00e29bee2d571ed904455fb292c49370ef63b815dc526c0fe3c077a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Yuva
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IntegrationDiff'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/Readme.md

@@ -0,0 +1,75 @@
+# IntegrationDiff
+
+Currently this supports only RSpec.
+
+### Installation
+
+```rb
+gem "integration-diff-rails", git: "git@github.com:code-mancers/integration-diff-rails"
+```
+
+### Configuration
+
+Include `integration-diff-rails` in your rspec `spec_helper` and configure 6 variables
+which will be used while taking screenshots. Make sure that `enable_service` is set to
+to true if images need to be uploaded.
+
+**NOTE:** Make sure that that project exists in service with `project_name`. Also
+api key can be obtained by loggin into service and visiting `/api_key`.
+
+
+```rb
+IntegrationDiff.configure do |config|
+  # configure domain to which all images have to be uploaded.
+  config.base_uri = "http://idf.dev"
+
+  # configure project name to which images belong to.
+  config.project_name = "idf"
+
+  # configure api_key required to authorize api access
+  config.api_key = ENV["IDIFF_API_KEY"]
+
+  # configure js driver which is used for taking screenshots.
+  config.javascript_driver = "poltergeist"
+
+  # configure service to mock capturing and uploading screenshots
+  config.enable_service = !!ENV["IDIFF_ENABLE"]
+
+  # configure logger to log messages. optional.
+  config.logger = Rails.logger
+end
+```
+
+After configuration, include `IntegrationDiff::Dsl` in your `spec_helper` and
+configure before and after suite so that suite interacts with the service.
+
+
+```rb
+RSpec.configure do |config|
+  config.include IntegrationDiff::Dsl
+
+  config.before(:suite) do
+    IntegrationDiff.start_run
+  end
+
+  config.after(:suite) do
+    IntegrationDiff.wrap_run
+  end
+end
+```
+
+### Usage
+
+In your specs, simply use `idiff` helper. make sure that you pass unique identifier
+to screenshots that you take. unique identifier helps in differentiating this
+screenshot taken from other screenshots.
+
+
+```rb
+describe "Landing page" do
+  it "has a big banner" do
+    visit root_path
+    idiff.screenshot("unique-identifier")
+  end
+end
+```

data/lib/integration-diff.rb

@@ -0,0 +1 @@
+require 'integration_diff'

data/lib/integration_diff/dsl.rb

@@ -0,0 +1,22 @@
+module IntegrationDiff
+  module Dsl
+    def self.idiff
+      @idiff ||=
+        begin
+          klass =
+            if IntegrationDiff.enable_service
+              IntegrationDiff::Runner
+            else
+              IntegrationDiff::DummyRunner
+            end
+
+          IntegrationDiff.logger.info "Using runner #{klass}"
+          klass.instance
+        end
+    end
+
+    def idiff
+      IntegrationDiff::Dsl.idiff
+    end
+  end
+end

data/lib/integration_diff/dummy_runner.rb

@@ -0,0 +1,16 @@
+module IntegrationDiff
+  class DummyRunner
+    def self.instance
+      @runner ||= DummyRunner.new
+    end
+
+    def start_run
+    end
+
+    def wrap_run
+    end
+
+    def screenshot(_)
+    end
+  end
+end

data/lib/integration_diff/runner.rb

@@ -0,0 +1,91 @@
+require 'time'
+require 'json'
+
+module IntegrationDiff
+  class Runner
+    include Capybara::DSL
+
+    DIR = 'tmp/idff_images'
+
+    def self.instance
+      @runner ||= Runner.new(IntegrationDiff.base_uri,
+                             IntegrationDiff.project_name,
+                             IntegrationDiff.javascript_driver)
+    end
+
+    def initialize(base_uri, project_name, javascript_driver)
+      @base_uri = base_uri
+      @project_name = project_name
+      @javascript_driver = javascript_driver
+      Dir.mkdir(DIR) unless Dir.exist?(DIR)
+    end
+
+    # TODO: Improve error handling here for network timeouts
+    def start_run
+      @identifiers = []
+      draft_run
+    rescue StandardError => e
+      IntegrationDiff.logger.fatal e.message
+      raise e
+    end
+
+    # TODO: Improve error handling here for network timeouts
+    def wrap_run
+      @identifiers.each do |identifier|
+        upload_image(identifier)
+      end
+
+      finalize_run if @run_id
+    rescue StandardError => e
+      IntegrationDiff.logger.fatal e.message
+      raise e
+    end
+
+    def screenshot(identifier)
+      screenshot_name = image_file(identifier)
+      page.save_screenshot(screenshot_name, full: true)
+      @identifiers << identifier
+    end
+
+    private
+
+    def draft_run
+      run_name = @project_name + "-" + Time.now.iso8601
+
+      # will have to make it configurable. ie, read from env.
+      # https://github.com/code-mancers/integration-diff.rb/pull/4#discussion-diff-42290464
+      branch = `git rev-parse --abbrev-ref HEAD`.strip
+      author = `git config user.name`.strip
+      project = IntegrationDiff.project_name
+
+      response = connection.post('/api/v1/runs',
+                                 name: run_name, project: project, group: branch,
+                                 author: author, js_driver: @javascript_driver)
+
+      @run_id = JSON.parse(response.body)["id"]
+    end
+
+    def upload_image(identifier)
+      image_io = Faraday::UploadIO.new(image_file(identifier), 'image/png')
+      connection.post("/api/v1/runs/#{@run_id}/run_images",
+                      identifier: identifier, image: image_io)
+    end
+
+    def finalize_run
+      connection.put("/api/v1/runs/#{@run_id}/status", status: "finalized")
+    end
+
+    def image_file(identifier)
+      "#{DIR}/#{identifier}.png"
+    end
+
+    def connection
+      @conn ||= Faraday.new(@base_uri) do |f|
+        f.request :basic_auth, IntegrationDiff.api_key, 'X'
+        f.request :multipart
+        f.request :url_encoded
+        f.adapter :net_http
+      end
+    end
+  end
+end

data/lib/integration_diff/version.rb

@@ -0,0 +1,3 @@
+module IntegrationDiff
+  VERSION = "0.0.1"
+end

data/lib/integration_diff.rb

@@ -0,0 +1,77 @@
+require 'faraday'
+require 'integration_diff/dummy_runner'
+require 'integration_diff/runner'
+require 'integration_diff/dsl'
+require 'logger'
+
+module IntegrationDiff
+  # configure domain to which all images have to be uploaded.
+  @@base_uri = "http://diff.codemancers.com"
+  def self.base_uri=(uri)
+    @@base_uri = uri
+  end
+  def self.base_uri
+    @@base_uri
+  end
+
+  # configure project name to which images belong to.
+  @@project_name = "idf"
+  def self.project_name=(name)
+    @@project_name = name
+  end
+  def self.project_name
+    @@project_name
+  end
+
+  # configure api_key required to authorize api access
+  @@api_key = ''
+  def self.api_key=(key)
+    @@api_key = key
+  end
+  def self.api_key
+    @@api_key
+  end
+
+  # configure js driver which is used for taking screenshots.
+  @@javascript_driver = "poltergeist"
+  def self.javascript_driver=(driver)
+    @@javascript_driver = driver
+  end
+  def self.javascript_driver
+    @@javascript_driver
+  end
+
+  # configure service to be mocked so that no screenshots are
+  # taken, and uploaded to service.
+  @@enable_service = false
+  def self.enable_service=(enable)
+    @@enable_service = enable
+  end
+  def self.enable_service
+    @@enable_service
+  end
+
+  # configure logger, which will be used to log issues if any
+  @@logger = Logger.new(STDOUT)
+  def self.logger=(new_logger)
+    @@logger = new_logger
+  end
+  def self.logger
+    @@logger
+  end
+
+  # helper to configure above variables.
+  def self.configure
+    yield(self)
+  end
+
+  # helps in setting up the run
+  def self.start_run
+    IntegrationDiff::Dsl.idiff.start_run
+  end
+
+  # helps in wrapping up run by uploading images
+  def self.wrap_run
+    IntegrationDiff::Dsl.idiff.wrap_run
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: integration-diff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: Rails integration for integration diff service
+email:
+- yuva@codemancers.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- Readme.md
+- lib/integration-diff.rb
+- lib/integration_diff.rb
+- lib/integration_diff/dsl.rb
+- lib/integration_diff/dummy_runner.rb
+- lib/integration_diff/runner.rb
+- lib/integration_diff/version.rb
+homepage: http://diff.codemancers.com
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rails integration for integration diff service
+test_files: []