snapit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f764224d1ae326746f906ac0362563a455bf546b
+  data.tar.gz: b62d948004fd7d7d6dd7a99f65bb9a3054a030cc
+SHA512:
+  metadata.gz: 13e85af68008bff1c3b98d2d15fe84a5e7076946d2714c06fe173eae3a04ae7c735af76c8374f35ae60a6d39c47b82f432c4256d79b14848d5397fb40b33c606
+  data.tar.gz: a37e90086c05e1d400be422666596bf1b0c08e87d3dcf5031ed70e43265106c03d9f5ef92e5721752290e17cdf2b409fb4950d8612f8283ad97d9b26853252ec

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+# snapit
+
+Need a quick way to automatically take screenshots? Well then this tool is for you. This early version will allow you to take screenshots named in a particular fashion so you can upload them tools like [InVision](http://www.invisionapp.com/).
+
+## usage
+
+```bash
+gem install snapit
+```
+
+This tool used `*.yml` files to automatically load up and take screenshots for you. So let's assume you have the following script:
+
+```example_script.yml
+name: 'My Personal Site'
+urls:
+  - homepage: "http://markhay.es/"
+  - about: "http://markhay.es/about"
+```
+
+You can then run it like so:
+
+```bash
+snapit capture example_script.yml
+```
+
+And you'll get a series of screenshots like so:
+
+```bash
+.
+├── example_script.yml
+└── snapit_captures
+    └── My_Personal_Site
+        ├── about.png
+        └── homepage.png
+```
+
+## todo
+
+  - [ ] Integrate with tools like InVision
+  - [ ] Take screenshots at certain time intervals
+
+## license
+
+snapit is released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snapit"
+
+# 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/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

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

data/exe/snapit

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snapit"
+require "thor"
+
+class SnapitCLI < Thor
+  desc "hello", "hello name"
+  def hello
+    puts "hello mark"
+  end
+
+  desc "capture", "capture SCRIPT_PATH"
+  def capture(script_path)
+    root_path = Pathname.new(File.absolute_path("."))
+    asset_path = Pathname.new(File.absolute_path(script_path))
+    storage    = Snapit::Storage.new(root_path)
+    Snapit.run!(asset_path, storage)
+    say_status "DONE", "Results added to #{storage.output_path.to_s}"
+  end
+end
+
+SnapitCLI.start(ARGV)

data/lib/snapit.rb

@@ -0,0 +1,21 @@
+require "snapit/version"
+require "snapit/storage"
+require "snapit/script"
+require "snapit/engine"
+
+module Snapit
+  def self.run!(path, storage)
+    res = []
+    script = Snapit::Script.new(path, storage)
+    Snapit::Engine.run(script.storage) do |driver|
+      script.urls.each do |obj|
+        obj.keys.each do |key|
+          name = key
+          url  = obj[key]
+          res << {path: driver.capture!(url, name)}
+        end
+      end
+    end
+    res
+  end
+end

data/lib/snapit/engine.rb

@@ -0,0 +1,44 @@
+require "selenium-webdriver"
+
+module Snapit
+  class Engine
+    attr_reader :storage
+    attr_reader :width
+
+    def initialize(storage, width)
+      @storage = storage
+      @width = width
+    end
+
+    def self.run(storage, width = 1280)
+      begin
+        engine = new(storage, width)
+        yield engine
+      ensure
+        engine.stop!
+      end
+    end
+
+    def output_path
+      
+    end
+
+    def capture!(url, name_or_idx)
+      driver.get(url)
+      driver.save_screenshot("#{storage.output_path.join(name_or_idx)}.png")
+    end
+
+    def stop!
+      driver.quit
+    end
+
+  private
+
+    def driver
+      return @driver if @driver
+      @driver = Selenium::WebDriver.for :firefox
+      @driver.manage.window.resize_to(width, 3000)
+      @driver
+    end
+  end
+end

data/lib/snapit/script.rb

@@ -0,0 +1,22 @@
+require "yaml"
+
+module Snapit
+  class Script
+    attr_reader :script
+    attr_reader :storage
+
+    def initialize(path, storage)
+      @script = YAML.load_file(path)
+      storage.set_script_name!(self.name)
+      @storage = storage
+    end
+
+    def name
+      @script["name"]
+    end
+
+    def urls
+      @script["urls"]
+    end
+  end
+end

data/lib/snapit/storage.rb

@@ -0,0 +1,28 @@
+require "pathname"
+require "fileutils"
+
+module Snapit
+  class Storage
+    attr_reader :path
+
+    def initialize(root_path)
+      @path = root_path.join("snapit_captures")
+      FileUtils.mkdir_p(path) unless Dir.exists?(path)
+    end
+
+    def set_script_name!(name)
+      @script_name = name
+      @script_name = @script_name.gsub(/[^0-9a-z ]/i, '').gsub(/ /i, '_')
+    end
+
+    def script_name
+      @script_name || "default"
+    end
+
+    def output_path
+      p = path.join(script_name)
+      FileUtils.mkdir_p(p) unless Dir.exists?(p)
+      p
+    end
+  end
+end

data/lib/snapit/version.rb

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

data/snapit.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snapit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snapit"
+  spec.version       = Snapit::VERSION
+  spec.authors       = ["Mark Hayes"]
+  spec.email         = ["me@markhay.es"]
+
+  spec.summary       = %q{Automate your screen captures}
+  spec.description   = %q{A simple way to take screenshots over and over again}
+  spec.licenses    = ['MIT']
+  spec.homepage      = "https://github.com/mhayes/snapit"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_dependency "selenium-webdriver", "~> 2.46.2"
+  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: snapit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Hayes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.46.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.46.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: A simple way to take screenshots over and over again
+email:
+- me@markhay.es
+executables:
+- snapit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- exe/snapit
+- lib/snapit.rb
+- lib/snapit/engine.rb
+- lib/snapit/script.rb
+- lib/snapit/storage.rb
+- lib/snapit/version.rb
+- snapit.gemspec
+homepage: https://github.com/mhayes/snapit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5
+signing_key: 
+specification_version: 4
+summary: Automate your screen captures
+test_files: []