turbot 0.1.36 → 0.2.3

data/lib/turbot/helpers/api_helper.rb

@@ -0,0 +1,41 @@
+module Turbot
+  module Helpers
+    extend self
+
+    # Returns a Turbot API client.
+    #
+    # @param [String] api_key an API key
+    # @return [Turbot::API] a Turbot API client
+    def api(api_key = nil)
+      # For whatever reason, unless we provide a truthy API key, Turbot::API's
+      # initializer immediately attempts to `#get_api_key_for_credentials`.
+      api_key ||= email_address_and_api_key[1] || ''
+      turbot_api.new(turbot_api_parameters.merge(:api_key => api_key))
+    end
+
+    # Returns the parameters for the Turbot API, based on the base URL of the
+    # Turbot server.
+    #
+    # @return [Hash] the parameters for the Turbot API
+    def turbot_api_parameters
+      uri = URI.parse(host)
+
+      {
+        :host => uri.host,
+        :port => uri.port,
+        :scheme => uri.scheme,
+      }
+    end
+
+    # The `turbot_api` gem is slow to load, so we defer its loading.
+    #
+    # @return [Class] the Turbot::API class
+    def turbot_api
+      @turbot_api ||= begin
+        require 'turbot_api'
+
+        Turbot::API
+      end
+    end
+  end
+end

data/lib/turbot/helpers/netrc_helper.rb

@@ -0,0 +1,66 @@
+module Turbot
+  module Helpers
+    extend self
+
+    # Reads the user's email address and API key from either the `TURBOT_API_KEY`
+    # environment variable or from a `.netrc` file.
+    #
+    # @return [Array<String>] the user's email address and API key
+    def email_address_and_api_key
+      if ENV['TURBOT_API_KEY']
+        ['', ENV['TURBOT_API_KEY']]
+      elsif netrc_exists?
+        open_netrc["api.#{host}"] || []
+      else
+        []
+      end
+    end
+
+    # Returns the path to the `.netrc` file containing the Turbot host's entry
+    # with the user's email address and API key.
+    #
+    # @return [String] the path to the `.netrc` file
+    def netrc_path
+      unencrypted = Netrc.default_path
+      encrypted = unencrypted + '.gpg'
+      if File.exists?(encrypted)
+        encrypted
+      else
+        unencrypted
+      end
+    end
+
+    # Returns whether a `.netrc` file exists.
+    #
+    # @return [Boolean] whether a `.netrc` file exists
+    def netrc_exists?
+      File.exist?(netrc_path)
+    end
+
+    # Reads a `.netrc` file.
+    #
+    # @return [Netrc] the `.netrc` file
+    def open_netrc
+      begin
+        Netrc.read(netrc_path)
+      rescue Netrc::Error => e
+        error e.message
+      end
+    end
+
+    # Deletes the Turbot host's entry from the `.netrc` file.
+    def delete_netrc_entry
+      netrc = open_netrc
+      netrc.delete("api.#{host}")
+      netrc.save
+    end
+
+    # Saves the user's email address and AP key to the Turbot host's entry in the
+    # `.netrc` file.
+    def save_netrc_entry(email_address, api_key)
+      netrc = open_netrc
+      netrc["api.#{host}"] = [email_address, api_key]
+      netrc.save
+    end
+  end
+end

data/lib/turbot/helpers/shell_helper.rb

@@ -0,0 +1,36 @@
+module Turbot
+  module Helpers
+    extend self
+
+    def ask
+      STDIN.gets.to_s.strip
+    end
+
+    def ask_for_password_on_windows
+      require 'Win32API'
+
+      password = ''
+
+      while char = Win32API.new('crtdll', '_getch', [], 'L').Call do
+        if char == 10 || char == 13 # received carriage return or newline
+          break
+        end
+        if char == 127 || char == 8 # backspace and delete
+          password.slice!(-1, 1)
+        else
+          # windows might throw a -1 at us so make sure to handle RangeError
+          (password << char.chr) rescue RangeError
+        end
+      end
+
+      password
+    end
+
+    def ask_for_password
+      system 'stty -echo'
+      password = ask
+      system 'stty echo'
+      password
+    end
+  end
+end

data/lib/turbot/version.rb

@@ -1,3 +1,3 @@
 module Turbot
-  VERSION = "0.1.36"
+  VERSION = '0.2.3'
 end

data/spec/fixtures/netrc

@@ -0,0 +1,6 @@
+machine api.http://turbot.opencorporates.com
+  login email@example.com
+  password apikey01
+machine api.http://turbot.example.com
+  login example@email.com
+  password apikey02

data/spec/spec_helper.rb

@@ -1,227 +1,25 @@
-$stdin = File.new("/dev/null")
+require 'rubygems'
 
-require "rubygems"
-
-require "simplecov"
-require "coveralls"
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-SimpleCov.start do
-  add_filter "spec"
-end
-
-require "excon"
-Excon.defaults[:mock] = true
-
-# ensure these are around for errors
-# as their require is generally deferred
-#require "turbot-api"
-require "rest_client"
-
-require "turbot/cli"
-require "rspec"
-require "rr"
-require "fakefs/safe"
-require 'tmpdir'
-require "webmock/rspec"
-
-include WebMock::API
-
-WebMock::HttpLibAdapters::ExconAdapter.disable!
-
-def api
-  Turbot::API.new(:api_key => "pass", :mock => true)
-end
-
-def org_api
-  Turbot::Client::Organizations.api(:mock => true)
-end
-
-def stub_api_request(method, path)
-  stub_request(method, "http://turbot.opencorporates.com#{path}")
-end
-
-def prepare_command(klass)
-  command = klass.new
-  command.stub!(:bot).and_return("example")
-  command.stub!(:ask).and_return("")
-  command.stub!(:display)
-  command.stub!(:hputs)
-  command.stub!(:hprint)
-  command.stub!(:turbot).and_return(mock('turbot client', :host => 'turbot.com'))
-  command
-end
-
-def execute(command_line)
-  extend RR::Adapters::RRMethods
-
-  args = command_line.split(" ")
-  command = args.shift
-
-  Turbot::Command.load
-  object, method = Turbot::Command.prepare_run(command, args)
-
-  any_instance_of(Turbot::Command::Base) do |base|
-    stub(base).bot.returns("example")
-  end
-
-  stub(Turbot::Auth).get_credentials.returns(['email@example.com', 'apikey01'])
-  stub(Turbot::Auth).api_key.returns('apikey01')
-
-  original_stdin, original_stderr, original_stdout = $stdin, $stderr, $stdout
-
-  $stdin  = captured_stdin  = StringIO.new
-  $stderr = captured_stderr = StringIO.new
-  $stdout = captured_stdout = StringIO.new
-  class << captured_stdout
-    def tty?
-      true
-    end
-  end
-
-  begin
-    object.send(method)
-  rescue SystemExit
-  ensure
-    $stdin, $stderr, $stdout = original_stdin, original_stderr, original_stdout
-    Turbot::Command.current_command = nil
-  end
-
-  [captured_stderr.string, captured_stdout.string]
-end
-
-def any_instance_of(klass, &block)
-  extend RR::Adapters::RRMethods
-  any_instance_of(klass, &block)
-end
-
-def run(command_line)
-  capture_stdout do
-    begin
-      Turbot::CLI.start(*command_line.split(" "))
-    rescue SystemExit
-    end
-  end
-end
-
-alias turbot run
-
-def capture_stderr(&block)
-  original_stderr = $stderr
-  $stderr = captured_stderr = StringIO.new
-  begin
-    yield
-  ensure
-    $stderr = original_stderr
+unless RUBY_PLATFORM =~ /mswin32|mingw32/
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start do
+    add_filter 'spec'
   end
-  captured_stderr.string
 end
 
-def capture_stdout(&block)
-  original_stdout = $stdout
-  $stdout = captured_stdout = StringIO.new
-  begin
-    yield
-  ensure
-    $stdout = original_stdout
-  end
-  captured_stdout.string
-end
+require 'rspec'
+require 'webmock/rspec'
 
-def fail_command(message)
-  raise_error(Turbot::Command::CommandFailed, message)
-end
-
-def stub_core
-  @stubbed_core ||= begin
-    stubbed_core = nil
-    any_instance_of(Turbot::Client) do |core|
-      stubbed_core = stub(core)
-    end
-    stub(Turbot::Auth).user.returns("email@example.com")
-    stub(Turbot::Auth).password.returns("pass")
-    stub(Turbot::Client).auth.returns("apikey01")
-    stubbed_core
-  end
-end
-
-def stub_pg
-  @stubbed_pg ||= begin
-    stubbed_pg = nil
-    any_instance_of(Turbot::Client::TurbotPostgresql) do |pg|
-      stubbed_pg = stub(pg)
-    end
-    stubbed_pg
-  end
-end
-
-def stub_pgbackups
-  @stubbed_pgbackups ||= begin
-    stubbed_pgbackups = nil
-    any_instance_of(Turbot::Client::Pgbackups) do |pgbackups|
-      stubbed_pgbackups = stub(pgbackups)
-    end
-    stubbed_pgbackups
-  end
-end
-
-def stub_rendezvous
-  @stubbed_rendezvous ||= begin
-    stubbed_rendezvous = nil
-    any_instance_of(Turbot::Client::Rendezvous) do |rendezvous|
-      stubbed_rendezvous = stub(rendezvous)
-    end
-    stubbed_rendezvous
-  end
-end
-
-def stub_cisaurus
-  @stub_cisaurus ||= begin
-    stub_cisaurus = nil
-    any_instance_of(Turbot::Client::Cisaurus) do |cisaurus|
-      stub_cisaurus = stub(cisaurus)
-    end
-    stub_cisaurus
-  end
-end
-
-def with_blank_git_repository(&block)
-  sandbox = File.join(Dir.tmpdir, "turbot", Process.pid.to_s)
-  FileUtils.mkdir_p(sandbox)
-
-  old_dir = Dir.pwd
-  Dir.chdir(sandbox)
-
-  `git init`
-  block.call
-
-  FileUtils.rm_rf(sandbox)
-ensure
-  Dir.chdir(old_dir)
-end
-
-module SandboxHelper
-  def bash(cmd)
-    `#{cmd}`
-  end
-end
-
-require "turbot/helpers"
-module Turbot::Helpers
-  @home_directory = Dir.mktmpdir
-  undef_method :home_directory
-  def home_directory
-    @home_directory
-  end
-end
+include WebMock::API
 
-require "support/display_message_matcher"
-require "support/organizations_mock_helper"
-require "support/dummy_api"
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f}
+require File.dirname(__FILE__) + '/../lib/turbot'
 
-RSpec.configure do |config|
-  config.color_enabled = true
-  config.include DisplayMessageMatcher
-  config.order = 'rand'
-  config.before { Turbot::Helpers.error_with_failure = false }
-  config.after { RR.reset }
+RSpec.configure do |c|
+  c.include(BotHelper)
+  c.include(CommandHelper)
+  c.include(FixtureHelper)
+  c.include(NetrcHelper)
 end

data/spec/support/bot_helper.rb

@@ -0,0 +1,102 @@
+module BotHelper
+  def valid_manifest
+    {
+      'bot_id' => 'example',
+      'data_type' => 'dummy',
+      'files' => ['scraper.rb'],
+      'identifying_fields' => ['name'],
+      'language' => 'ruby',
+      'publisher' => {},
+    }
+  end
+
+  # API
+
+  def stub_bot_info(bot = 'example')
+    stub_request(:get, "http://turbot.opencorporates.com/api/bots/#{bot}?api_key=apikey01").to_return({
+      :status => 200,
+      :body => JSON.dump({
+        'data' => {
+          'bot_id' => 'dummy_bot',
+          'created_at' => '2010-01-01T00:00:00.000Z',
+          'updated_at' => '2010-01-02T00:00:00.000Z',
+          'state' => 'scheduled',
+        }
+      }),
+    })
+  end
+
+  def stub_bot_info_error(bot = 'example')
+    stub_request(:get, "http://turbot.opencorporates.com/api/bots/#{bot}?api_key=apikey01").to_return({
+      :status => 402,
+      :body => JSON.dump({
+        'error_code' => 'bot-not-found',
+        'message' => "No bot registered for bot_id example\nIf you have renamed your bot, ...",
+      }),
+    })
+  end
+
+  def stub_preview
+    stub_request(:put, 'http://turbot.opencorporates.com/api/bots/example').to_return(:status => 200, :body => '{}')
+    stub_request(:delete, 'http://turbot.opencorporates.com/api/bots/example/draft_data?api_key=apikey01').to_return(:status => 200, :body => '{}')
+    stub_request(:post, 'http://turbot.opencorporates.com/api/bots/example/draft_data').to_return({
+      :status => 200,
+      :body => JSON.dump({
+        'data' => {
+          'url' => 'http://example.com/',
+        },
+      }),
+    })
+  end
+
+  # Filesystem
+
+  def create_bot_directory(working_directory = nil)
+    bot_directory = File.join(working_directory || Dir.mktmpdir, 'example')
+    Dir.mkdir(bot_directory)
+    bot_directory
+  end
+
+  def create_manifest_file(bot_directory, data = nil)
+    data ||= JSON.dump(valid_manifest)
+
+    File.open(File.join(bot_directory, 'manifest.json'), 'w') do |f|
+      f.write(data)
+    end
+  end
+
+  def create_scraper_file(bot_directory, records = [{'name' => 'foo'}])
+    File.open(File.join(bot_directory, 'scraper.rb'), 'w') do |f|
+      f.write("require 'json'\n")
+      records.each do |record|
+        f.write("puts JSON.dump(#{record.inspect})\n")
+      end
+    end
+  end
+
+  def create_broken_scraper_file(bot_directory)
+    File.open(File.join(bot_directory, 'scraper.rb'), 'w') do |f|
+      f.write("class ThisErrorIsExpected < StandardError; end\n")
+      f.write("raise ThisErrorIsExpected\n")
+    end
+  end
+
+  # TurbotRunner
+
+  def set_turbot_runner_schemas
+    TurbotRunner::SCHEMAS_PATH.replace(File.expand_path(File.join('..', '..', 'schemas'), __FILE__))
+  end
+
+  # Testing
+
+  def execute_in_directory(command, directory)
+    allow_any_instance_of(Turbot::Command::Base).to receive(:working_directory).and_return(directory)
+    stderr, stdout = execute(command)
+    restore_working_directory_method
+    [stderr, stdout]
+  end
+
+  def restore_working_directory_method
+    allow_any_instance_of(Turbot::Command::Base).to receive(:working_directory).and_return(Dir.pwd)
+  end
+end