turbot 0.1.36 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 600a90ef755d445465dc39413bb127d8aef1e61d
-  data.tar.gz: 94c59e97d4fb228f4fbc9801eaa49888e7264790
+  metadata.gz: 1821884d9b229f7fb87b4348a3166c3c3aefdfa1
+  data.tar.gz: e136315de66bc9cfe90d4d7c1aa53fd5c56bdfc6
 SHA512:
-  metadata.gz: 416a5437e004a0fe9359bd7683627a746b78a7cc812fe65da65d88ec86d3406cfd99ed5356ae801c3473dbf6aaea75b82accc6dc4d82cbf6cc36040227945f86
-  data.tar.gz: 86982d3095fae7977793d857b696f0b44d563715eb5f6c08027758b8db2e5c1c465697ab81656543a5a7117f75561c45a9df7eaf0dd2302752aae72a4a1973cc
+  metadata.gz: d6125ddc0bbe53ab79ad88b373f04ca25320641f03dec4897c61c8b81aa5be4e9802e197f30db4252bd4ee7ff05c8ab51ab197fa8346e825942864c5c7420c20
+  data.tar.gz: 97674b5292e3ab0b945b63a8da59d66fe9aedd4cc5e8ef31b2d53653ad6011bcb6b5a8cbace43c7ca358ae9b990d22de98fff3513303a4e5f814f831f7735a8f

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.yardoc
+coverage
+Gemfile.lock
+doc/*
+pkg/*
+spec/fixtures/writable

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order random

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+before_script:
+  - git config --global user.email "bot@turbot.com"
+  - git config --global user.name "Turbot Bot (Travis CI)"
+notifications:
+  email: false
+  webhooks:
+    on_success: always
+    on_failure: always
+    urls:
+      - http://dx-helper.turbotapp.com/travis

data/.yardopts

@@ -0,0 +1,3 @@
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright © Turbot 2008 - 2012
+
+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

@@ -1,46 +1,65 @@
-Turbot CLI
-==========
+# Turbot CLI
 
 [![Gem Version](https://badge.fury.io/rb/turbot.svg)](https://badge.fury.io/rb/turbot)
 [![Build Status](https://secure.travis-ci.org/openc/turbot-client.png)](https://travis-ci.org/openc/turbot-client)
+[![Build Status](https://ci.appveyor.com/api/projects/status/sdq0ifdye4rgx8i1?svg=true)](https://ci.appveyor.com/project/jpmckinney/turbot-client)
 [![Dependency Status](https://gemnasium.com/openc/turbot-client.png)](https://gemnasium.com/openc/turbot-client)
 [![Coverage Status](https://coveralls.io/repos/openc/turbot-client/badge.png)](https://coveralls.io/r/openc/turbot-client)
 [![Code Climate](https://codeclimate.com/github/openc/turbot-client.png)](https://codeclimate.com/github/openc/turbot-client)
 
-The Turbot CLI is used to manage Turbot apps from the command line.
+The Turbot CLI is used to manage Turbot bots from the command line.
 
-Setup
------
+## Getting Started
 
-(Platform-specific installers to follow)
+    gem install turbot
 
-Once installed, you'll have access to the `turbot` command from your command shell.  Log in using the email address and password you used when creating your Turbot account:
+You now have access to the `turbot` command.  Log in using your Turbot account's email and password:
 
     $ turbot login
-    Enter your Turbot credentials.
-    Email: adam@example.com
-    Password:
-    Could not find an existing public key.
-    Would you like to generate one? [Yn]
-    Generating new SSH public key.
-    Uploading SSH public key /Users/adam/.ssh/id_rsa.pub
+    Enter your Turbot email and password.
+    Email: email@example.com
+    Password (typing will be hidden):
 
-Press enter at the prompt to upload your existing `SSH` key or create a new one, used for pushing code later on.
+You can then generate a bot:
 
-Development
------------
+    turbot bots:generate --bot my_amazing_bot
+    cd my_amazing_bot
 
-If you're working on the CLI and you can smoke-test your changes:
+Register the bot with Turbot:
 
-    $ bundle exec turbot
+    turbot bots:register
 
-If you need to do this from a different folder, try:
+Run your bot locally:
 
-    alias tb="RBENV_GEMSETS=.gems TURBOT_HOST=http://localhost:3000 RBENV_VERSION=[version] BUNDLE_GEMFILE=/path/to/turbot-client/Gemfile bundle exec turbot"
+    turbot bots:dump
 
-Meta
-----
+Ensure your bot is valid:
 
-Released under the MIT license; see the file License.
+    turbot bots:validate
 
-Based on the Heroku client created by [Adam Wiggins and others](https://github.com/turbot/turbot/contributors)
+And push your code to Turbot when ready:
+
+    turbot bots:push
+
+To read about Turbot's other commands:
+
+    turbot help
+
+## Environment variables
+
+* `TURBOT_API_KEY`: Overrides the API key in the `.netrc` file. Allows you to skip authentication.
+
+* `TURBOT_BOT`: Overrides the bot in the current directory, but not the bot set with the `--bot` option.
+
+* `TURBOT_HOST`: Overrides the base URL of the Turbot server, which is `http://turbot.opencorporates.com` by default.
+
+## Releasing a new version
+
+Bump the version in `lib/turbot/version.rb` according to the [Semantic Versioning](http://semver.org/) convention, then:
+
+    git commit lib/turbot/version.rb -m 'Release new version'
+    rake release # requires Rubygems credentials
+
+Based on the [Heroku CLI](https://github.com/heroku/heroku).
+
+Copyright (c) 2015 Chrinon Ltd, released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/appveyor.yml

@@ -0,0 +1,35 @@
+# @see https://mattbrictson.com/how-to-test-ruby-windows
+# @see https://github.com/apiaryio/apiary-client/blob/master/appveyor.yml
+version: '{build}'
+skip_tags: true
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - gem install bundler --no-ri --no-rdoc
+  - bundler --version
+build_script:
+  - bundle install --jobs=3 --retry=3
+test_script:
+  - bundle exec rspec -b < Nul
+artifacts:
+  - path: pkg\*.gem
+environment:
+  matrix:
+    - ruby_version: "193"
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+# @see https://www.appveyor.com/docs/build-cache
+cache:
+  - C:\Ruby193\bin                 -> appveyor.yml
+  - C:\Ruby193\lib\ruby\gems\1.9.1 -> appveyor.yml
+  - C:\Ruby200\bin                 -> appveyor.yml
+  - C:\Ruby200\lib\ruby\gems\2.0.0 -> appveyor.yml
+  - C:\Ruby21\bin                  -> appveyor.yml
+  - C:\Ruby21\lib\ruby\gems\2.1.0  -> appveyor.yml
+  - C:\Ruby22\bin                  -> appveyor.yml
+  - C:\Ruby22\lib\ruby\gems\2.2.0  -> appveyor.yml

data/bin/turbot

@@ -1,17 +1,3 @@
-#!/usr/local/turbot/ruby/bin/ruby
-# encoding: UTF-8
-
-# resolve bin path, ignoring symlinks
-require "pathname"
-bin_file = Pathname.new(__FILE__).realpath
-
-# add self to libpath
-$:.unshift File.expand_path("../../lib", bin_file)
-
-require "turbot/updater"
-Turbot::Updater.disable("`turbot update` is only available from Turbot Toolbelt.\nDownload and install from https://toolbelt.turbot.com")
-
-# start up the CLI
-require "turbot/cli"
-Turbot.user_agent = "turbot-gem/#{Turbot::VERSION} (#{RUBY_PLATFORM}) ruby/#{RUBY_VERSION}"
+#!/usr/bin/env ruby
+require 'turbot'
 Turbot::CLI.start(*ARGV)

data/data/schema.json

@@ -0,0 +1,134 @@
+{
+  "type": "object",
+  "properties": {
+    "bot_id": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9._-]+$"
+    },
+    "title": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "language": {
+      "type": "string",
+      "enum": [
+        "python",
+        "ruby"
+      ]
+    },
+    "data_type": {
+      "type": "string"
+    },
+    "identifying_fields": {
+      "$ref": "#/definitions/string_array"
+    },
+    "files": {
+      "$ref": "#/definitions/string_array",
+      "minItems": 1
+    },
+    "frequency": {
+      "type": "string",
+      "enum": [
+        "once",
+        "daily",
+        "weekly",
+        "monthly",
+        "yearly",
+        "never"
+      ]
+    },
+    "publisher": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri"
+        },
+        "terms": {
+          "type": "string"
+        },
+        "terms_url": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "additionalProperties": false
+    },
+    "tags": {
+      "$ref": "#/definitions/string_array"
+    },
+    "manually_end_run": {
+      "$ref": "#/definitions/string_boolean"
+    },
+    "transformers": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "file": {
+            "type": "string"
+          },
+          "data_type": {
+            "type": "string"
+          },
+          "identifying_fields": {
+            "$ref": "#/definitions/string_array"
+          }
+        },
+        "required": [
+          "file",
+          "data_type",
+          "identifying_fields"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "public_repo_url": {
+      "type": "string",
+      "format": "uri"
+    },
+    "duplicates_allowed": {
+      "$ref": "#/definitions/string_boolean"
+    },
+    "allow_duplicates": {
+      "$ref": "#/definitions/string_boolean"
+    },
+    "incremental": {
+      "$ref": "#/definitions/string_boolean"
+    },
+    "author": {},
+    "company_fields": {},
+    "dataset_id": {},
+    "domain": {},
+    "public_repository": {},
+    "source_date": {},
+    "source_url": {},
+    "stateful": {}
+  },
+  "required": [
+    "bot_id",
+    "data_type",
+    "identifying_fields",
+    "files",
+    "language",
+    "publisher"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "string_boolean": {
+      "type": ["boolean", "string"],
+      "enum": [true, false, "true", "false"]
+    },
+    "string_array": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  }
+}

data/dist/deb.rake

@@ -0,0 +1,32 @@
+file pkg("/apt-#{version}/turbot-#{version}.deb") => distribution_files("deb") do |t|
+  mkchdir(File.dirname(t.name)) do
+    mkchdir("usr/local/turbot") do
+      assemble_distribution
+      assemble_gems
+      assemble resource("deb/turbot"), "bin/turbot", 0755
+    end
+
+    assemble resource("deb/control"), "control"
+    assemble resource("deb/postinst"), "postinst"
+
+    sh "tar czvf data.tar.gz usr/local/turbot --owner=root --group=root"
+    sh "tar czvf control.tar.gz control postinst --owner=root --group=root --preserve-permissions"
+
+    File.open("debian-binary", "w") do |f|
+      f.puts "2.0"
+    end
+
+    deb = File.basename(t.name)
+
+    sh "ar -r #{t.name} debian-binary control.tar.gz data.tar.gz"
+  end
+end
+
+desc "Build a .deb package"
+task "deb:build" => pkg("/apt-#{version}/turbot-#{version}.deb")
+
+desc "Remove build artifacts for .deb"
+task "deb:clean" do
+  clean pkg("turbot-#{version}.deb")
+  FileUtils.rm_rf("pkg/apt-#{version}") if Dir.exists?("pkg/apt-#{version}")
+end

data/dist/gem.rake

@@ -0,0 +1,16 @@
+file pkg("turbot-#{version}.gem") => distribution_files("gem") do |t|
+  sh "gem build turbot.gemspec"
+  sh "mv turbot-#{version}.gem #{t.name}"
+end
+
+task "gem:build" => pkg("turbot-#{version}.gem")
+
+task "gem:clean" do
+  clean pkg("turbot-#{version}.gem")
+end
+
+task "gem:release" => "gem:build" do |t|
+ sh "gem push #{pkg("turbot-#{version}.gem")}"
+ sh "git tag v#{version}"
+ sh "git push origin master --tags"
+end

data/dist/manifest.rake

@@ -0,0 +1,9 @@
+task "manifest:update" do
+  tempdir do |dir|
+    File.open("VERSION", "w") do |file|
+      file.puts version
+    end
+    puts "Current version: #{version}"
+    store "#{dir}/VERSION", "turbot-client/VERSION"
+  end
+end