capybara_screenshot_idobata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ffbea02730032ee25006c4626420bbeb1b8f910
+  data.tar.gz: 8ec63be74af7e36f22fbea187589a664c54c0a9a
+SHA512:
+  metadata.gz: b9156fa590db6cb4b9bcb92246c0c6fd0394b77708d82f07d112d89f2770ab0ec5e5201a97a83a6e80aab9cd3c6c5d3d67aa4834e1570af3c399098d14a07ac4
+  data.tar.gz: 21f21349bc722ab7bc7f6a83dab235916d6eb240d64e5eb173bc44ab6081d4feb4df5aff967b9f5c47259ed808960b7812d54e7e8ecd843c72bbfb7ac90e255a

data.tar.gz.sig

@@ -0,0 +1,2 @@
+D,��i�
+3�b< %�S̯x�C�;U�?�&;�p/13(r�D����;~
+s1�0� ^.�=Ka#��5<���P�\�y����`��K!�B��֫�@:���(������	��B,”7QxM�7r5o��~�ɇ��/j�����T91jb����y8k�����0���>E"�i�

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.1.0"
+  - "2.1.1"
+script: bundle exec rake
+notifications:
+  webhooks:
+    - https://idobata.io/hook/6a98db40-ac68-45ec-a1b4-d8dd5851c2e3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capybara_screenshot_idobata.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Idobata team
+
+MIT License
+
+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/README.md

@@ -0,0 +1,99 @@
+# Capybara Screenshot Idobata
+
+[![Build Status](https://travis-ci.org/idobata/capybara_screenshot_idobata.png)](https://travis-ci.org/idobata/capybara_screenshot_idobata)
+
+Save screenshot using [Capybara](https://github.com/jnicklas/capybara) and post to [Idobata](https://idobata.io).
+
+For all users who met the failing tests only CI.
+
+## Usage
+
+You can use `save_screenshot_and_post_to_idobata` in your feature spec:
+
+``` ruby
+save_screenshot_and_post_to_idobata
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'capybara_screenshot_idobata', group: :test
+```
+
+And then execute:
+
+``` sh
+$ bundle
+```
+
+Or install it yourself as:
+
+``` sh
+$ gem install capybara_screenshot_idobata
+```
+
+## Using with Cucumber
+
+First, you need to setup Capybara: https://github.com/jnicklas/capybara#using-capybara-with-cucumber
+
+Load the `capybara_screenshot_idobata/cucumber` module in your `features/support/env.rb` and configure your `hook_url`:
+
+``` ruby
+require 'capybara_screenshot_idobata/cucumber'
+
+CapybaraScreenshotIdobata.configure do |config|
+  config.hook_url = '<PUT YOUR GENERIC HOOK URL HERE>'
+end
+```
+
+## Using with RSpec
+
+First, you need to setup Capybara: https://github.com/jnicklas/capybara#using-capybara-with-rspec
+
+Load the `capybara_screenshot_idobata/rspec` module in your `spec/spec_helper.rb` and configure your `hook_url`:
+
+``` ruby
+require 'capybara_screenshot_idobata/rspec'
+
+CapybaraScreenshotIdobata.configure do |config|
+  config.hook_url = '<PUT YOUR GENERIC HOOK URL HERE>'
+end
+```
+
+## Configuration
+
+You can configure the following options:
+
+* `hook_url` (**required**)
+* `message_format` (optional) - default: `:html`
+  * `:html` or `:text`
+* `message_formatter` (optional)
+  * You can customize message format.
+
+Example:
+
+``` ruby
+CapybaraScreenshotIdobata.configure do |config|
+  config.hook_url          = '<PUT YOUR GENERIC HOOK URL HERE>'
+  config.message_format    = :text
+  config.message_formatter = proc {|filepath, line, context|
+    "hi: #{filepath}"
+  }
+end
+```
+
+## Test
+
+``` sh
+$ bundle exec rake
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/idobata/capybara_screenshot_idobata/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new :features do |t|
+  t.cucumber_opts = 'features --format pretty'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new :spec
+
+task :default => [:spec, :features]

data/capybara_screenshot_idobata.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'capybara_screenshot_idobata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capybara_screenshot_idobata'
+  spec.version       = CapybaraScreenshotIdobata::VERSION
+  spec.authors       = ['Ryunosuke SATO']
+  spec.email         = ['tricknotes@idobata.io']
+  spec.summary       = %q{Post screenshot to Idobata}
+  spec.description   = %q{Post screenshot to Idobata}
+  spec.homepage      = 'https://github.com/idobata/capybara_screenshot_idobata'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capybara', '~> 2.0'
+  spec.add_dependency 'rest_client'
+
+  spec.add_development_dependency 'bundler',  '~> 1.5'
+  spec.add_development_dependency 'cucumber', '~> 1.3.0'
+  spec.add_development_dependency 'multipart-parser'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec',    '~> 2.0'
+  spec.add_development_dependency 'webmock'
+end

data/features/idobata.feature

@@ -0,0 +1,5 @@
+Feature: Work capybara_screenshot_idobata
+  Scenario: Post screenshot to Idobata
+  When  Visit to "https://idobata.io/"
+  And  Call `save_screenshot_and_post_to_idobata`
+  Then Post screenshot to Idobata

data/features/step_definitions/steps.rb

@@ -0,0 +1,19 @@
+When /^Visit to "(.*?)"$/ do |_url|
+  # noop
+end
+
+When /^Call `save_screenshot_and_post_to_idobata`$/ do
+  stub_request(:post, 'idobata.io/hook/TOKEN').to_return(body: 'OK')
+
+  save_screenshot_and_post_to_idobata
+end
+
+Then /^Post screenshot to Idobata$/ do
+  expect(WebMock).to have_requested(:post, 'idobata.io/hook/TOKEN').with {|req|
+    params = parse_multipart(req)
+
+    expect(params['image'][:part].filename).to match(/^screenshot-\d+\.png$/)
+    expect(params['source'][:data]).to match('Screenshot from: ')
+    expect(params['format'][:data]).to eq('html')
+  }
+end

data/features/support/env.rb

@@ -0,0 +1,27 @@
+require 'capybara/cucumber'
+require 'rspec'
+require 'cucumber/rspec/doubles'
+require 'webmock/cucumber'
+
+require_relative '../../spec/support/multipart_helper'
+require 'capybara_screenshot_idobata/cucumber'
+
+CapybaraScreenshotIdobata.configure do |config|
+  config.hook_url = 'http://idobata.io/hook/TOKEN'
+end
+
+Capybara.app = lambda {|env| [200, {}, ['hi']] }
+
+Before do
+  allow(page.driver).to receive(:save_screenshot).and_return {|filepath|
+    File.write(filepath, "\x89PNG")
+  }
+end
+
+After do
+  Dir['screenshot-*.png'].each do |path|
+    File.unlink path
+  end
+end
+
+World MultipartHelper

data/lib/capybara_screenshot_idobata.rb

@@ -0,0 +1,20 @@
+module CapybaraScreenshotIdobata
+  autoload :DSL,     'capybara_screenshot_idobata/dsl'
+  autoload :VERSION, 'capybara_screenshot_idobata/version'
+
+  class << self
+    attr_accessor :hook_url, :message_format, :message_formatter
+
+    def configure
+      yield self
+    end
+  end
+
+  configure do |config|
+    config.message_format    = :html
+    config.message_formatter = proc {|filepath, line, _context|
+      "Screenshot from: <code>#{filepath}:#{line}</code>"
+    }
+  end
+end
+

data/lib/capybara_screenshot_idobata/cucumber.rb

@@ -0,0 +1,4 @@
+require 'capybara_screenshot_idobata'
+require 'capybara_screenshot_idobata/dsl'
+
+World CapybaraScreenshotIdobata::DSL

data/lib/capybara_screenshot_idobata/dsl.rb

@@ -0,0 +1,42 @@
+require 'pathname'
+require 'rest_client'
+
+module CapybaraScreenshotIdobata
+  module DSL
+    def save_screenshot_and_post_to_idobata(filename = "screenshot-#{Time.now.to_i}.png", options = {})
+      raise 'missing config `CapybaraScreenshotIdobata.hook_url`' unless CapybaraScreenshotIdobata.hook_url
+
+      options = detect_default_option(Capybara.current_driver).merge(options)
+
+      save_screenshot filename, options
+
+      absolute_filepath, line = caller[0].split(':')
+
+      filepath = Pathname(absolute_filepath).relative_path_from(Pathname(Dir.pwd))
+
+      source = CapybaraScreenshotIdobata.message_formatter.call(filepath, line, self)
+
+      File.open(filename, 'rb') do |file|
+        RestClient.post(CapybaraScreenshotIdobata.hook_url,
+          {
+            source: source,
+            format: CapybaraScreenshotIdobata.message_format,
+            image:  file
+          },
+          {
+            'User-Agent' => "CapybaraScreenshotIdobata/v#{CapybaraScreenshotIdobata::VERSION}"
+          }
+        )
+      end
+    end
+
+    def detect_default_option(driver)
+      case driver
+      when :poltergeist
+        {full: true}
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/capybara_screenshot_idobata/rspec.rb

@@ -0,0 +1,20 @@
+require 'erb'
+
+require 'capybara_screenshot_idobata'
+require 'capybara_screenshot_idobata/dsl'
+
+RSpec.configure do |config|
+  config.include CapybaraScreenshotIdobata::DSL, type: :feature
+end
+
+CapybaraScreenshotIdobata.configure do |config|
+  config.message_formatter = proc {|file, line, context|
+    example = context.respond_to?(:example) ? context.example : RSpec.current_example # For RSpec 2/3 conpatiblity
+
+<<-MESSAGE
+Screenshot from: <code>#{ERB::Util.h(file)}:#{line}</code>
+<br>
+<b>#{ERB::Util.h(example.full_description)}</b>
+MESSAGE
+  }
+end

data/lib/capybara_screenshot_idobata/version.rb

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

data/spec/post_screenshot_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'The request to Idobata', type: :feature do
+  before do
+    allow(page.driver).to receive(:save_screenshot).and_return {|filepath|
+      File.write(filepath, "\x89PNG")
+    }
+  end
+
+  after do
+    Dir['screenshot-*.png'].each do |path|
+      File.unlink path
+    end
+  end
+
+  before do
+    stub_request(:post, 'idobata.io/hook/TOKEN').to_return(body: 'OK')
+
+    save_screenshot_and_post_to_idobata
+  end
+
+  it 'should have "User-Agent" that including gem version' do
+    expect(WebMock).to have_requested(:post, 'idobata.io/hook/TOKEN').with {|req|
+      req.headers['User-Agent'] == "CapybaraScreenshotIdobata/v#{CapybaraScreenshotIdobata::VERSION}"
+    }
+  end
+
+  it 'should have body contained screenshot file with message' do
+    expect(WebMock).to have_requested(:post, 'idobata.io/hook/TOKEN').with {|req|
+      params = parse_multipart(req)
+
+      expect(params['image'][:part].filename).to match(/^screenshot-\d+\.png$/)
+      expect(params['source'][:data]).to match('Screenshot from: ')
+      expect(params['format'][:data]).to eq('html')
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'capybara/rspec'
+require 'capybara_screenshot_idobata/rspec'
+
+require 'webmock/rspec'
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.include MultipartHelper, type: :feature
+end
+
+CapybaraScreenshotIdobata.configure do |config|
+  config.hook_url = 'http://idobata.io/hook/TOKEN'
+end
+
+Capybara.app = lambda {|env| [200, {}, ['hi']] }

data/spec/support/multipart_helper.rb

@@ -0,0 +1,20 @@
+require 'multipart_parser/reader'
+
+module MultipartHelper
+  def parse_multipart(req)
+    content_type = req.headers['Content-Type']
+    boundary     = MultipartParser::Reader.extract_boundary_value(content_type)
+    params       = {}
+
+    reader = MultipartParser::Reader.new(boundary)
+    reader.on_part do |part|
+      params[part.name] = {part: part, data: ''}
+      part.on_data do |data|
+        params[part.name][:data] << data
+      end
+    end
+    reader.write req.body
+
+    params
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: capybara_screenshot_idobata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryunosuke SATO
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDLDCCAhSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA8MQwwCgYDVQQDDANnZWQx
+  FzAVBgoJkiaJk/IsZAEZFgdfYWVyaWVfMRMwEQYKCZImiZPyLGQBGRYDb3JnMB4X
+  DTEzMDgxMjA3MTIwNVoXDTE0MDgxMjA3MTIwNVowPDEMMAoGA1UEAwwDZ2VkMRcw
+  FQYKCZImiZPyLGQBGRYHX2FlcmllXzETMBEGCgmSJomT8ixkARkWA29yZzCCASIw
+  DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM7Sou14r78CbjbzZ6amfIebM2C4
+  zcyMj/isZvhCyzyeNrvMgHRDvQkpxThvXEPVImIJOv0Ajw/jwrrDwFcmxcCJS5mT
+  e1zHgOirFxbH1zXDEV3zylZw1Qc7hj48ITGjKNqHsf5mo4WcwrZ/ueySqU1cx6Bv
+  DEEEAOpKGq1El5/NgdjazX7nMNxgwe5jWKXf3GiCZBBCfKUL94bobBHbaLAHto7u
+  HvJHPP80XR92ClAaw9nW3eh4vxUVa2mukzFU8Ly8hnZJq6XJ35YCQYGS5YRQriCb
+  gVE113aLIcEZuLlg507tvjyRYleENjnDbZxfZ5mj9TpzqopLQldbQvY03WkCAwEA
+  AaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFIS69Szc4Ei8
+  B2ebB48qReRKMnM0MA0GCSqGSIb3DQEBBQUAA4IBAQDDD4F1tMGydcf25g8Regbi
+  FV6iO9W7c7ggV2zEN929hNvsvNlLBtM9qgdxreLjU8tCnIZuNrYNGlOvy9pukVFl
+  CgtLzLWIMniWZdynf3v7qKw8JYv6mrM5NMFSYbBX/Blp5LJuXPxncUlh7pcaIpC9
+  PnjRRAR5zwSRp7+WGEHddwQylVKivrp5+Ee+2Q9dwXq6FeZyEks25Uw+Ygk2wEtw
+  XCQCcbiypGTMBlf09ttUTOPHd8Rip20lnRBquHou3X2PzpsEXeXIIVZubZRS8HJH
+  73gf2r/DN19jcbwtGBurcOmFpSjV+2PCN7rHR0Mn3mgCpHQlGqeekIT11tx2UA6T
+  -----END CERTIFICATE-----
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: multipart-parser
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+description: Post screenshot to Idobata
+email:
+- tricknotes@idobata.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capybara_screenshot_idobata.gemspec
+- features/idobata.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- lib/capybara_screenshot_idobata.rb
+- lib/capybara_screenshot_idobata/cucumber.rb
+- lib/capybara_screenshot_idobata/dsl.rb
+- lib/capybara_screenshot_idobata/rspec.rb
+- lib/capybara_screenshot_idobata/version.rb
+- spec/post_screenshot_spec.rb
+- spec/spec_helper.rb
+- spec/support/multipart_helper.rb
+homepage: https://github.com/idobata/capybara_screenshot_idobata
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Post screenshot to Idobata
+test_files:
+- features/idobata.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- spec/post_screenshot_spec.rb
+- spec/spec_helper.rb
+- spec/support/multipart_helper.rb