flypbook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57d4985df996adb726bc3c03cf9b1e3afe30da52
+  data.tar.gz: 169b1df9ce265b55009f3c806d77c71c56bf05d3
+SHA512:
+  metadata.gz: 1b195174bd8695a7fd698f0dc0bbb7465843b4be20421ee1ab1b1458754f02f89c48991eb01c64da8e6b25bd2d817418246d2eb09eac1800a359f2234470f148
+  data.tar.gz: d74d148b61e933214771a3e7a293e7255ad8adf7eb4000813d481c2a519ac6d91160bb0b3cb7a48d16cdf45e3246f38b66c8ff3ff68ac4ef1d49ea3feffacdc7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cgunadi@pivotal.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pivotal Labs
+
+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,57 @@
+# Flypbook
+
+We’re working on a beach project where we create a library that will take screenshots of a journey test and put them in Google Drive every time we check in new code to GitHub that can help PMs and ADs and Sales show iterative delivery.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flypbook'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flypbook
+
+## Usage
+
+#### Geckodriver
+
+Download the geckodriver for Firefox [here](https://github.com/mozilla/geckodriver/releases/) and add the file to your PATH. Also, install Firefox.
+
+### Google Drive Integration
+
+In order to save screenshots to Google Drive, you need to set up credentials via the Google Developer Console. Please follow the [command line authorization instructions](https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md) steps 1 through 6. For step two, if using the pivotal.io domain, select an existing project called `labs-lmorley`.
+
+After you receive your client id and secret, you'll also need to get a refresh token.
+
+```
+$ export GOOGLE_CLIENT_ID=<your client ID here>
+$ export GOOGLE_CLIENT_SECRET=<your client secret here>
+```
+
+After that, run `retrieve_refresh_token` and set the refresh token:
+
+```
+$ export GOOGLE_REFRESH_TOKEN=<your refresh token here>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pivotal/flypbook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flypbook"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/retrieve_refresh_token

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'google_drive'
+
+credentials = Google::Auth::UserRefreshCredentials.new(
+  client_id: ENV['GOOGLE_CLIENT_ID'],
+  client_secret: ENV['GOOGLE_CLIENT_SECRET'],
+  scope: GoogleDrive::Session::DEFAULT_SCOPE,
+  redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
+
+puts("\n1. Open this page:\n#{credentials.authorization_uri}\n\n")
+puts('2. Enter the authorization code shown in the page:')
+credentials.code = $stdin.gets.chomp
+credentials.fetch_access_token!
+
+puts '\n\nExport the refresh token as follows:'
+puts
+puts "export GOOGLE_REFRESH_TOKEN=#{credentials.refresh_token}"

data/flypbook.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flypbook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flypbook"
+  spec.version       = Flypbook::VERSION
+  spec.authors       = ["Chris Gunadi", "Brian Watkins", "Tyson McNulty", "Liam Morley", "Mitchell Rosen"]
+  spec.email         = ["cgunadi@pivotal.io", "bwatkins@pivotal.io", "tmcnulty@pivotal.io", "lmorley@pivotal.io", "mrosen@pivotal.io"]
+
+  spec.summary       = "Automatic screenshot capture for Capybara"
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "http://pivotal.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "capybara", "~> 2.11"
+  spec.add_dependency "selenium-webdriver", "~> 3.0"
+  spec.add_dependency "google_drive", "~> 2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+end

data/lib/flypbook.rb

@@ -0,0 +1,42 @@
+require 'flypbook/version'
+require 'capybara'
+
+require 'flypbook/photo_store'
+require 'flypbook/google_drive'
+
+module Flypbook
+  module DriverExtensions
+    def visit(path)
+      PhotoStore.take_screenshot 'visit-before'
+      super(path)
+      PhotoStore.take_screenshot 'visit-after'
+    end
+  end
+
+  module CapybaraSeleniumNodeExtensions
+    def click
+      PhotoStore.take_screenshot 'click'
+      super
+    end
+  end
+
+  class Capybara::Selenium::Driver
+    prepend DriverExtensions
+  end
+
+  class Capybara::Selenium::Node
+    prepend CapybaraSeleniumNodeExtensions
+  end
+
+  RSpec.configure do |config|
+    config.after do
+      PhotoStore.take_screenshot 'after' unless ENV['FLYPBOOK_SPEC'] == 'testing'
+    end
+
+    config.after(:suite) do
+      unless ENV['FLYPBOOK_SPEC'] == 'testing'
+        GoogleDrive.new(ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'], ENV['GOOGLE_REFRESH_TOKEN']).upload
+      end
+    end
+  end
+end

data/lib/flypbook/google_drive.rb

@@ -0,0 +1,25 @@
+require 'google_drive'
+
+module Flypbook
+  class GoogleDrive
+    def initialize(client_id, client_secret, refresh_token)
+      credentials = ::Google::Auth::UserRefreshCredentials.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        scope: ::GoogleDrive::Session::DEFAULT_SCOPE,
+        redirect_uri: 'urn:ietf:wg:oauth:2.0:oob',
+        refresh_token: refresh_token
+      )
+      @session = ::GoogleDrive::Session.new(credentials)
+    end
+
+    def upload
+      root_collection = @session.root_collection
+      flypbook = root_collection.subcollection_by_title('Flypbook') || root_collection.create_subcollection('Flypbook')
+      current_run_collection = flypbook.create_subcollection "journey_#{DateTime.now}"
+      PhotoStore.screenshots.each do |screenshot|
+        current_run_collection.add @session.upload_from_file(screenshot, screenshot, convert: false)
+      end
+    end
+  end
+end

data/lib/flypbook/photo_store.rb

@@ -0,0 +1,14 @@
+module Flypbook
+  class PhotoStore
+    @screenshots = []
+    class << self
+      attr_reader :screenshots
+
+      def take_screenshot(identifier)
+        filename = "#{identifier}-#{@screenshots.length + 1}.png"
+        Capybara.current_session.save_screenshot filename
+        @screenshots << filename
+      end
+    end
+  end
+end

data/lib/flypbook/version.rb

@@ -0,0 +1,3 @@
+module Flypbook
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: flypbook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Gunadi
+- Brian Watkins
+- Tyson McNulty
+- Liam Morley
+- Mitchell Rosen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: google_drive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- cgunadi@pivotal.io
+- bwatkins@pivotal.io
+- tmcnulty@pivotal.io
+- lmorley@pivotal.io
+- mrosen@pivotal.io
+executables:
+- retrieve_refresh_token
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/retrieve_refresh_token
+- flypbook.gemspec
+- lib/flypbook.rb
+- lib/flypbook/google_drive.rb
+- lib/flypbook/photo_store.rb
+- lib/flypbook/version.rb
+homepage: http://pivotal.io
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Automatic screenshot capture for Capybara
+test_files: []