drobot 0.0.1

data/README.md

@@ -0,0 +1,12 @@
+# Drobots
+[![Build Status](https://travis-ci.org/yakshed/drobots.svg?branch=master)](https://travis-ci.org/yakshed/drobots)
+
+Helpful little Drobots.
+
+## Contributing
+
+1. Fork it ( https://github.com/yakshed/drobots/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,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/drobot.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "drobot"
+  spec.version       = Drobot::VERSION
+  spec.authors       = ["Sebastian Schulze", "Lucas Dohmen"]
+  spec.email         = ["rubygems.org@bascht.com", "lucas@moonbeamlabs.com"]
+  spec.summary       = "Clever little Robot that downloads your Documents"
+  spec.description   = "Clever little Robot that downloads your Documents and can't be bothered to write a description."
+  spec.homepage      = "http://www.yakshed.org"
+  spec.license       = "GPL-3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "poltergeist", "~> 1.9"
+  spec.add_dependency "json-schema", "~> 2.5.0"
+  spec.add_dependency "erubis", "~> 2.7.0"
+  spec.add_dependency "json", "~> 1.8.3"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "awesome_print", "~> 1.6"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+  spec.add_development_dependency "xdg", "~> 2.1"
+end

data/lib/credentials/passwordstore_provider.rb

@@ -0,0 +1,35 @@
+require 'mkmf'
+
+module Credentials
+  class PasswordstoreProvider
+    
+    def initialize(pass_command: nil, pass_name:)
+      default_command = '/usr/bin/pass'
+      @pass_command = pass_command || default_command
+      @pass_name = pass_name
+    end
+    
+    def username
+      credentials[:username]
+    end
+    
+    def password
+      credentials[:password]
+    end
+
+    private
+    ##
+    # Parse pass output formed like
+    # 
+    # soopa_secret
+    # Username: my_user
+    def credentials
+      return @credentials if @credentials
+      output = %x"#{@pass_command} #{@pass_name}".lines
+
+      password = output.shift
+      username = output.find { |line| line.start_with? 'Username:' }.split(":").pop.strip
+      @credentials = {:username => username, :password => password}
+    end
+  end
+end

data/lib/drobot.rb

@@ -0,0 +1,40 @@
+require 'open-uri'
+require 'capybara'
+require 'version'
+require 'drobots'
+
+class Drobot
+  include Capybara::DSL
+
+  # Optimized for Programmer Happyness
+  BASEDIR = Pathname.new(__dir__).parent
+  
+  def initialize(credential_provider, target = "/tmp/foo")
+    @credential_provider = credential_provider
+    @target = target
+  end
+  
+  def download(url)
+    open("#{@target}/#{title}.pdf", 'wb') do |file|
+      # puts "Downloading #{url}"
+      file << open(url).read
+    end
+  end
+
+  def title
+    drobot_name = self.class.name.split("::").pop
+    prefix + drobot_name.downcase
+  end
+  
+  def prefix
+    Date.today.strftime("%Y-%m-")
+  end
+
+  def username
+    @credential_provider.username
+  end
+
+  def password
+    @credential_provider.password
+  end
+end

data/lib/drobots.rb

@@ -0,0 +1,2 @@
+module Drobots
+end

data/lib/runner.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+require 'json-schema'
+require 'credentials/passwordstore_provider'
+
+class Runner
+  SCHEMA = YAML.load_file(Drobot::BASEDIR.join('lib/runner_config_schema.yaml'))
+
+  def initialize(config_file: nil)
+    default_file = File.join(Dir.home, '.drobots.yaml')
+    @config_file = config_file || default_file
+    @config = YAML.load_file(@config_file)
+
+    JSON::Validator.validate!(SCHEMA, @config)
+  end
+
+  def drobots
+    @drobots ||= @config['drobots'].map do |name, config|
+      credential_provider = Credentials::PasswordstoreProvider.new(pass_name: config['passwordstore']['name'])
+      determine_drobot(name).new(credential_provider)
+    end
+  end
+
+  def run
+    drobots.each(&:run)
+  end
+
+  private
+
+  def determine_drobot(name)
+    drobot = Object.const_get("Drobots::#{name}")
+  rescue NameError
+    raise "unknown Drobot #{name}"
+  end
+end

data/lib/runner_config_schema.yaml

@@ -0,0 +1,16 @@
+---
+type: object
+required:
+- drobots
+properties:
+  drobots:
+    type: object
+    patternProperties:
+      ".+":
+        type: object
+        properties:
+          passwordstore:
+            type: object
+            properties:
+              name:
+                type: string

data/lib/version.rb

@@ -0,0 +1,3 @@
+class Drobot
+  VERSION = "0.0.1"
+end

data/spec/drobot_spec.rb

@@ -0,0 +1,72 @@
+require 'fileutils'
+require 'pp'
+require 'drobot'
+require 'runner'
+require 'credentials/passwordstore_provider'
+
+require_relative 'fixtures/simple_app'
+require_relative 'fixtures/sample_robot'
+require_relative 'fixtures/drobots/firstsample'
+require_relative 'fixtures/drobots/secondsample'
+
+describe "Drobot", :type => :app do
+  let(:fixture_dir) { Drobot::BASEDIR.join("spec/fixtures") }
+  let(:output_dir) { Drobot::BASEDIR.join("tmp") }
+
+  describe "runner" do
+    context "with valid configuration" do
+      subject { Runner.new(config_file: File.join(fixture_dir, 'test_config.yaml')) }
+
+      it "iterates over multiple drobots" do
+        drobots = subject.drobots
+        expect(drobots.count).to eq 2
+        expect(drobots.first).to be_a(Drobots::Firstsample)
+        expect(drobots.last).to be_a(Drobots::Secondsample)
+      end
+
+      it "runs Drobots" do
+        subject.run
+        
+        expect(subject.drobots.first.ran?).to be true
+        expect(subject.drobots.last.ran?).to be true
+      end
+    end
+    context "with broken configurations" do
+      it "gives a proper warning" do
+        expect {
+          Runner.new(config_file: File.join(fixture_dir, 'broken_config.yaml'))
+        }.to raise_exception(JSON::Schema::ValidationError)
+      end
+
+      it "detects non-existing Drobots" do
+        expect {
+          Runner.new(config_file: File.join(fixture_dir, 'missing_config.yaml')).run
+        }.to raise_exception(RuntimeError, /unknown Drobot NonExistingDrobot/)
+      end
+    end
+  end
+
+  describe "automated download", :type => :feature do
+
+    let(:runner) { Runner.new }
+    let(:credential_provider) { Credentials::PasswordstoreProvider.new(pass_command: "#{fixture_dir}/mock_pass",  pass_name: 'sample/app') }
+    subject { Drobots::Sample.new(credential_provider, output_dir) }
+
+    before do
+      Capybara.app = SimpleApp.new
+      FileUtils.mkdir_p(output_dir)
+    end
+    
+    it "sorts files into the correct folder." do
+      files = proc { Dir["#{output_dir}/**"] }
+      FileUtils.rm(files.call)
+      
+      expect(files.call).to eq []
+      
+      subject.run
+
+      filename = Date.today.strftime("%Y-%m-sample.pdf")
+      expect(files.call).to eq [ File.join(output_dir, filename) ]
+    end
+  end
+end

data/spec/fixtures/.gitignore

@@ -0,0 +1 @@
+ output/*

data/spec/fixtures/broken_config.yaml

@@ -0,0 +1,6 @@
+---
+drobots:
+  Firstsample:
+  Secondsample:
+    passwordstore:
+      name: 'second/sample'

data/spec/fixtures/config.ru

@@ -0,0 +1,3 @@
+require_relative 'simple_app'
+
+run SimpleApp.new

data/spec/fixtures/drobots/firstsample.rb

@@ -0,0 +1,12 @@
+require 'drobot'
+
+module Drobots
+  class Firstsample < Drobot
+    def run
+      @ran = true
+    end
+    def ran?
+      @ran
+    end
+  end
+end

data/spec/fixtures/drobots/secondsample.rb

@@ -0,0 +1,12 @@
+require 'drobot'
+
+module Drobots
+  class Secondsample < Drobot
+    def run
+      @ran = true
+    end
+    def ran?
+      @ran
+    end
+  end
+end

data/spec/fixtures/missing_config.yaml

@@ -0,0 +1,8 @@
+---
+drobots:
+  NonExistingDrobot:
+    passwordstore:
+      name: 'nonexisting/sample'
+  Secondsample:
+    passwordstore:
+      name: 'second/sample'

data/spec/fixtures/mock_pass

@@ -0,0 +1,3 @@
+#!/bin/sh
+echo "soopa_secret"
+echo "Username: my_user"

data/spec/fixtures/sample_robot.rb

@@ -0,0 +1,15 @@
+class Drobots::Sample < Drobot
+  def run
+    visit "/"
+    click_link 'login'
+
+    within('#myform') do
+      fill_in 'username', :with => username
+      fill_in 'password', :with => password
+      click_button 'Yo'
+    end
+    
+    l = find_link 'Mega Secure Download'
+    download(l[:href])
+  end
+end

data/spec/fixtures/simple_app.rb

@@ -0,0 +1,22 @@
+require 'sinatra'
+require 'tilt/erubis'
+
+class SimpleApp < Sinatra::Base
+  get '/' do
+    erb :simple_index
+  end
+
+  get '/login' do
+    erb :simple_login
+  end
+  
+  post '/login' do
+    @authenticated = (@params[:username] == 'my_user' && @params[:password] == 'soopa_secret')
+    erb :simple_login
+  end
+  
+  get '/other' do
+    erb :simple_other
+  end
+end
+

data/spec/fixtures/test_config.yaml

@@ -0,0 +1,8 @@
+---
+drobots:
+  Firstsample:
+    passwordstore:
+      name: 'first/sample'
+  Secondsample:
+    passwordstore:
+      name: 'second/sample'

data/spec/fixtures/views/simple_index.erb

@@ -0,0 +1,5 @@
+<h1>Welcome!</h1>
+<a href="/other">other</a>
+<a href="/login">login</a>
+<a href="/download.pdf">download</a>
+

data/spec/fixtures/views/simple_login.erb

@@ -0,0 +1,11 @@
+<% if @authenticated -%>
+<a href="/sample.pdf">Mega Secure Download</a>
+<% else %>
+<h1>Go away</h1>
+<% end %>
+<hr/>
+<form id="myform" action="/login" method="post">
+<input name="username" type="text" value=""/>
+<input name="password" type="text" value=""/>
+<input name="submit" type="submit" value="Yo" />
+</form>

data/spec/fixtures/views/simple_other.erb

@@ -0,0 +1 @@
+<h1>Hurrah!</h1>

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+require 'capybara/rspec'
+require 'capybara/poltergeist'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+Capybara.default_driver = :poltergeist