trent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd76ca7ec62253cf51678cf861497c9b7e994d2e
+  data.tar.gz: 494bf1d60e7bed0be13746a83102359fe5e1aa0d
+SHA512:
+  metadata.gz: aedc27c0447919ba248ed0b883a2dc5d7f327422be206894dfdba9de9abdece1799e4096bd174cf1482bcb253725d5a4de06ffc26bdf9f2e763a4f89f48870c7
+  data.tar.gz: 618011c76aee3f36ae61019f7614de36145db8f1ce836d7bf1f30e1f4bf9dce772bbcf0577e5d3349f58969e56a0f0b4f09b63bee88514c89bf3f782c42f1f79

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### [0.1.0] 2018-08-07
+
+First release! 
+
+### Added
+- Ability to run local shell commands on Travis CI build. 
+- Ability to run remote ssh commands on Travis CI builds. 
+- Ability to send a comment on the GitHub pull request for the Travis CI build. 
+- Trent only works with Travis-CI at this time. 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Levi Bostian
+
+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,186 @@
+# Trent 
+
+Run and debug bash commands on Travis-CI much easier.
+
+...Yes, Trent is open to working with more then Travis-CI. At this time, Travis is what I use so it's what's supported. Make a pull request to add more. 
+
+## What is Trent?
+
+I have been using Travis-CI for a few years to build, test, and deploy my apps. Bash is great, but using a higher level language for interacting with Travis and the build machine would be very beneficial. 
+
+Trent is a convenient ruby gem that helps you execute system shell scripts with as little code *and pain* as possible. 
+
+## How can Trent help you?
+
+Have you encountered any of the following pains while working with Travis-CI? 
+
+1. If you run shell commands from a bash *file*, Travis does not echo each command before it executes in the bash file. 
+
+![](misc/example_3commands.png)
+
+This makes it difficult to debug when things go wrong. Knowing what commands were executed would be very helpful. 
+
+2. At times where I forget to set `set -e` in my bash script, commands that fail allow my Travis build to continue. Commands should fail by default to help keep Travis builds reliable. 
+
+3. Some commands are ok if they fail. Make it easy to flag these commands as ok to fail. 
+
+4. Bash is difficult to write and maintain if you do anything advanced. Parsing output from an executed command, for example, has always caused me trouble getting it to work. Using a high level language such as Python or Ruby is much easier. 
+
+5. Misc tasks such as commenting on a GitHub pull request should be 1 line of code: `comment("Tests successful!")`. 
+
+# Getting started 
+
+* Install the gem via Bundler. 
+
+```
+$> bundle add trent
+```
+
+* Create a new Ruby file for the scripts you want to run and create an instance of `Trent`. 
+
+```
+require 'trent'
+
+ci = Trent.new() 
+```
+
+* Tell Travis to run your scripts. In your `.travis.yml` file, add `ruby name-of-file.rb` for a job. 
+
+Done! Continue reading for what you can do with Trent. 
+
+# Run local shell commmands 
+
+```ruby
+require 'trent'
+
+ci = Trent.new()
+
+result = ci.sh("echo 'foo'")
+
+puts result 
+```
+
+When you run the script, you will see:
+
+```
+echo 'foo'  
+foo         
+{:output=>"foo\n", :result=>true} 
+```
+
+Let's break this down. 
+
+* `echo 'foo'`: Trent always prints to the console each command that is evaluated to help you debug. 
+* `foo`: The output of the command that is executed. This includes both STDOUT and STDERR. 
+* `{:output=>"foo\n", :result=>true} `: The result of `ci.sh()` returns a Hash with the output string you can parse if you wish and the result of the command. `true` for exit status code 0 and `false` otherwise. 
+
+### Advanced tips for running local shell commands:
+
+```ruby
+# Allow a command to fail and not fail the Travis build. 
+ci.sh("false", :fail_non_success => false) 
+```
+
+# Run remote SSH shell commmands
+
+```ruby
+require 'trent'
+
+ci = Trent.new()
+ci.config_ssh('username', '111.111.234.332')
+
+result = ci.ssh("echo 'foo'")
+
+puts result 
+```
+
+When you run the script, you will see:
+
+```
+echo 'foo'  
+foo         
+{:output=>"foo\n", :result=>true} 
+```
+
+Let's break this down. 
+
+* `echo 'foo'`: Trent always prints to the console each command that is evaluated to help you debug. 
+* `foo`: The output of the command that is executed. This includes both STDOUT and STDERR. 
+* `{:output=>"foo\n", :result=>true} `: The result of `ci.ssh()` returns a Hash with the output string you can parse if you wish and the result of the command. `true` for exit status code 0 and `false` otherwise. 
+
+### Advanced tips for running remote SSH shell commands
+
+```ruby
+# Allow a command to fail and not fail the Travis build. 
+ci.ssh("false", :fail_non_success => false) 
+```
+
+# GitHub 
+
+Trent comes with some handy commands that allow you to work with Travis easily. This would include interacting with GitHub. 
+
+### Comment on a pull request 
+
+```ruby
+require 'trent'
+
+ci = Trent.new()
+# Set GitHub private access key to authenticate user account. 
+# Here is a guide on how to create tokens:
+# https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token 
+# Tokens for OSS Projects
+# We recommend giving the token the smallest scope possible. This means just public_repo.
+# Tokens for Closed Source Projects
+# We recommend giving access to the whole repo scope, and its children.
+ci.config_github('wfoweifwoeifjweoijwefowefweoif')
+
+ci.github.comment("Tests pass!") # Send comment to pull request for the Travis build. The pull request information is automatically retrieved from the Travis virtual machine the build is running on. 
+```
+
+# Advanced Trent configuration 
+
+```ruby
+# Set the color Trent uses to print the command about to run to the console. 
+# Available colors are located here: https://github.com/fazibear/colorize/blob/master/lib/colorize/class_methods.rb#L61
+ci = Trent.new(:green)
+```
+
+## Author
+
+* Levi Bostian - [GitHub](https://github.com/levibostian), [Twitter](https://twitter.com/levibostian), [Website/blog](http://levibostian.com)
+
+![Levi Bostian image](https://gravatar.com/avatar/22355580305146b21508c74ff6b44bc5?s=250)
+
+## Contribute
+
+Trent is open for pull requests. Check out the [list of issues](https://github.com/levibostian/trent/issues) for tasks I am planning on working on. Check them out if you wish to contribute in that way.
+
+**Want to add features to Trent?** Before you decide to take a bunch of time and add functionality to the library, please, [create an issue](https://github.com/levibostian/trent/issues/new) stating what you wish to add. This might save you some time in case your purpose does not fit well in the use cases of Trent.
+
+### Building Trent 
+
+```
+$> gem build trent.gemspec
+$> gem install --dev ./trent-X.X.X.gem
+```
+
+This will install all dependencies including for development. You are ready to write some code. 
+
+While working on Trent, make sure to lint it:
+
+```
+$> rubocop  --auto-correct 
+```
+
+To test out Trent on your machine:
+
+```
+$> gem build trent.gemspec
+$> gem install ./trent-X.X.X.gem
+```
+
+Then, you can use it on your own machine using `require 'trent'` in your ruby scripts. 
+
+### Where did the name come from?
+
+I built this gem to work well with Travis-CI. I simply looked up similar names as "Travis". I liked how "Travis" and "Trent" share the same beginning couple of letters. 

data/lib/command/sh/sh.rb

@@ -0,0 +1,25 @@
+require 'open3'
+
+# Run bash commands locally on machine.
+class Sh
+  def initialize; end
+
+  # Run a bash command locally.
+  def run(command)
+    output = ''
+    exit_status = nil
+    Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+      stdin.close
+      stdout.each_line do |line|
+        puts line
+        output += line
+      end
+      stderr.each_line do |line|
+        puts line
+        output += line
+      end
+      exit_status = wait_thr.value
+      return { output: output, result: exit_status.success? }
+    end
+  end
+end

data/lib/command/ssh/ssh.rb

@@ -0,0 +1,37 @@
+require 'net/ssh'
+
+# Run SSH commands remotely on a server.
+class SSH
+  def initialize(username, host, password = nil)
+    @username = username
+    @host = host
+    @password = password
+  end
+
+  # Run the SSH command on the server
+  def run(command)
+    Net::SSH.start(@host, @username, password: @password) do |ssh|
+      output = ''
+      exit_code = nil
+      ssh.open_channel do |channel|
+        channel.exec(command) do |_ch, success|
+          abort "FAILED: Couldn't execute command #{command}" unless success
+
+          channel.on_data do |_ch, data|
+            puts data
+            output += data
+          end
+
+          channel.on_extended_data do |_ch, _type, data|
+            puts data
+            output += data
+          end
+
+          channel.on_request('exit-status') { |_ch, data| exit_code = data.read_long }
+        end
+      end
+      ssh.loop
+      return { output: output, result: exit_code <= 0 }
+    end
+  end
+end

data/lib/github/github.rb

@@ -0,0 +1,38 @@
+require 'net/http'
+require 'json'
+require_relative '../log'
+
+# Functions to run on GitHub
+class GitHub
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  # Comment on Pull Request
+  def comment(message)
+    result = comment_on_pull_request(message)
+
+    if !result[:successful]
+      puts "Status code: #{result[:status_code]}"
+      puts "Body: #{result[:body]}"
+      Log.fatal('Commenting on GitHub pull request failed.')
+    else
+      Log.success('Successfully commented on GitHub pull request.')
+    end
+  end
+
+  def comment_on_pull_request(message)
+    puts "Commenting on GitHub pull request: #{ENV['TRAVIS_REPO_SLUG']}/#{ENV['TRAVIS_PULL_REQUEST']}"
+    uri = URI("https://api.github.com/repos/#{ENV['TRAVIS_REPO_SLUG']}/issues/#{ENV['TRAVIS_PULL_REQUEST']}/comments")
+
+    req = Net::HTTP::Post.new(uri, 'Content-Type' => 'application/json')
+    req['Authorization'] = "token #{@api_key}"
+    req.body = { body: message }.to_json
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    res = http.request(req)
+    status_code = res.code.to_i
+    { status_code: status_code, body: res.body, successful: res.is_a?(Net::HTTPSuccess) && status_code < 400 }
+  end
+end

data/lib/log.rb

@@ -0,0 +1,18 @@
+require 'colorize'
+
+# Convenient class to log to console in certain ways
+class Log
+  # Fatal error. We should not move forward.
+  def self.fatal(message)
+    abort("FATAL: #{message}".colorize(:red))
+  end
+
+  # Warning we want to show to the user.
+  def self.warning(message)
+    puts "Warning: #{message}".colorize(:yellow)
+  end
+
+  def self.success(message)
+    puts "Success: #{message}".colorize(:green)
+  end
+end

data/lib/trent.rb

@@ -0,0 +1,60 @@
+require 'command/ssh/ssh'
+require 'github/github'
+require 'command/sh/sh'
+require 'colorize'
+require_relative './log'
+
+# Communicate with all of the Trent library with this class.
+class Trent
+  def initialize(color = :blue)
+    Log.fatal('Trent is designed to run on Travis-CI builds. Run it on Travis-CI.') unless ENV['HAS_JOSH_K_SEAL_OF_APPROVAL']
+
+    @color = color
+    @sh = Sh.new
+  end
+
+  # Configure how to run remote SSH commmands on server.
+  def config_ssh(username, host, password = nil)
+    @ssh = SSH.new(username, host, password: password)
+  end
+
+  # Configure how to communicate with GitHub
+  def config_github(api_key)
+    @github = GitHub.new(api_key)
+  end
+
+  ## Run ssh command
+  def ssh(command, fail_non_success = true)
+    Log.fatal('You did not configure SSH yet.') unless @ssh
+
+    puts command.colorize(@color)
+    result = @ssh.run(command)
+
+    Log.fatal('Command failed with a non 0 exit status.') if !result[:result] && fail_non_success
+
+    result
+  end
+
+  # Run local bash command
+  def sh(command, fail_non_success = true)
+    puts command.colorize(@color)
+
+    result = @sh.run(command)
+
+    unless result[:result]
+      if fail_non_success
+        Log.fatal('Command failed with a non 0 exit status.')
+      else
+        Log.warning('Command failed with a non 0 exit status.')
+      end
+    end
+
+    result
+  end
+
+  # Get instance of GitHub class to run commands against GitHub
+  def github
+    Log.fatal('You did not configure GitHub yet.') unless @github
+    @github
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: trent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Levi Bostian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+description: "I have been using Travis-CI for a few years to build, test, and deploy
+  my apps. Bash is great, but using a higher level language for interacting with Travis
+  and the build machine would be very beneficial. \n\n  Trent is a convenient ruby
+  gem that helps you execute system shell scripts with as little code *and pain* as
+  possible."
+email: levi.bostian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/command/sh/sh.rb
+- lib/command/ssh/ssh.rb
+- lib/github/github.rb
+- lib/log.rb
+- lib/trent.rb
+homepage: http://github.com/levibostian/trent
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Run and debug bash commands on Travis-CI much easier.
+test_files: []