roper 1.0.0 → 1.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a628e70f159f29b754176917e3071233772702f
-  data.tar.gz: 4e4a8ff08f03abccb8dea2fc7d7f7b3f9a38e75f
+  metadata.gz: 6ea211c5f6b2b1316f62193201dc8b10ade9ce06
+  data.tar.gz: 2a09346a0ee0f965d5f9ff255080205adc7a2f7c
 SHA512:
-  metadata.gz: 05fc8dba415f490a5e1e8a16aeb42a3121728022c2a1a2aebed8600f27a56109d5c6c646175d7dec6e1e2e6e36ecd845aa49111331623c0507c840bc90ba189d
-  data.tar.gz: 6e5b414317d3c50242d486fbcb77482312fd9696a8fda9a75d61150637ae973cf489fd5520e8f23811a1bb906cd80c69c58e3c3117111a10e30f68f8cdc9351d
+  metadata.gz: 9fb4bd06eff6100304952e3777e1d6f05e3b4980101332d1ad63edb187b33bfd66f61831312bad854f8ff96cf7382e5c9dcfb2e594d73d63e0fa863aa71935af
+  data.tar.gz: e5a4b47edf23667b2fe318800a8df836caaef93aa4ff745d2b38e50842eaca02cc564d46e53242b539ba06d625c92c890ec3be6c10f8199ed5ae4537d282bb70

data/.travis.yml

@@ -2,7 +2,10 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.3
-before_install: gem install bundler -v 1.15.4
+  - 2.5.0
+
+before_install: gem install bundler -v 1.16.1
+
 script:
   - bundle exec rake
   - bundle exec rubocop

data/README.md

@@ -2,13 +2,15 @@
 
 <p align="center"><img src="Figure-eight_knot.svg"></p>
 
-Roper is a cli tool used to help stage a dockerized web app.  There are some
-assumptions made about the environment that roper runs in.  The main one is
-that traefik has been configured to run via the docker backend and that the
-dockerized web application uses a docker-compose.yml file that knows how to
-communicate with traefik.
+Roper is a CLI tool used to help stage a Dockerized web app.  It's name is
+a play on it's two main commands (`lasso` and `release`).
 
-Another assuption made is that the repository for the web applications roper is
+There are some assumptions made about the environment that roper runs in.  The
+main one is that Traefik has been configured to run via the docker back-end and
+that the Dockerized web application uses a `docker-compose.ym` file that knows
+how to communicate with Traefik.
+
+Another assumption made is that the repository for the web applications roper is
 concerned with lives at GitHub: At this point I have no intention of supporting
 another git repository service.
 
@@ -22,30 +24,45 @@ Once Roper is configured it knows how to:
   status.
 * When a PR is merged or closed the resources can be released/recovered.
 
-Currently, Roper only defines a cli interface so there is no way for GitHub
-to communicate with it direclty via a webhook or whatnot. It's assumed that it
-will be used in conjuction with a service like jenkins ci to handle the webook
-part of the communication and trigger a roper staging on a desired Github event
+Roper also defines the following environment variables which are made available
+during the `docker-compose up` phase and can therefore be referenced in your
+`docker-compose.yml` file
+
+| variable | description |
+| -------- | ------------|
+| ROPER_REPO_OWNER | The GitHub repository owner |
+| ROPER_REPO_NAME | The GitHub repository name |
+| ROPER_REPO_BRANCH | The GitHub repository branch |
+
+Currently, Roper only defines a CLI interface so there is no way for GitHub
+to communicate with it directly via a web-hook or whatnot. It's assumed that it
+will be used in conjunction with a service like Jenkins CI to handle the web-hook
+part of the communication and trigger a roper staging on a desired GitHub event
 (PR creation, update to PR, merge of PR).
 
 Eventually it would be nice for Roper to include a web service interface that
-GitHub can post direclty to. But then again, that might just be scope creep
-considering there are already good options for handling the webhook concern
-(i.e. jenkins)
+GitHub can post directly to. But then again, that might just be scope creep
+considering there are already good options for handling the web-hook concern
+(i.e. Jenkins)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby gem 'roper' ```
+```
+ruby gem 'roper'
+```
 
 And then execute:
 
-    $ bundle
-
+```
+bundle
+```
 Or install it yourself as:
 
-    $ gem install roper
+```
+gem install roper
+```
 
 ## Usage
 
@@ -57,8 +74,30 @@ OR:
 
 You can use the individual components of the library as you wish.
 
+## Configuration
+`roper` is configure ready. Use `roper initconfig`. This command will create
+a `.roper.rc` configuration file in your home directory.  The file is in yaml
+format and you can provide default arguments for any roper command.
+
+The following `roper.rc` configuration file example provides a default value
+for the repository:
+
+```
+---
+:version: false
+:help: false
+commands:
+  :lasso:
+    :r: "tulibraries/tul_cob"
+  :release:
+    :r: "tulibraries/tul_cob"
+```
+
+
 ## Github Authentication
-Currenlty Roper uses netrc for github authentication.  I'm hoping to slap an interface to create this at setup but for now you will need to add a ~/.netrc file with an entry for `api.github.com` manually.
+Currenlty Roper uses netrc for github authentication.  I'm hoping to slap an
+interface to create this at setup but for now you will need to add a ~/.netrc
+file with an entry for `api.github.com` manually.
 
 ## Development
 
@@ -72,6 +111,7 @@ release a new version, update the version number in `version.rb`, and then run
 git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/exe/roper

@@ -5,10 +5,14 @@ require "roper"
 
 include GLI::App
 
+config_file ".roper.rc"
+
 program_desc "Roper is a CLI tool used to help stage a dockerized web app."
 
 version Roper::VERSION
 
+flag [:nh, "no-hub", "disable-hub"], desc: "Do not interact with GitHub", default_value: false
+
 subcommand_option_handling :normal
 arguments :strict
 sort_help :manually
@@ -19,8 +23,8 @@ command :lasso do |c|
   c.flag :r, :repo
 
   c.desc "The branch name"
-  c.flag :b, :branch
   c.default_value "master"
+  c.flag :b, :branch
 
   c.desc "The sha reference that we will post to"
   c.flag :s, :sha
@@ -38,7 +42,7 @@ command :lasso do |c|
   c.action do |global_options, options, args|
     repo = options[:repo]
     branch = options[:branch]
-    Roper::CLI.lasso(repo, branch, options)
+    Roper::CLI.lasso(repo, branch, global_options.merge(options))
     puts "lasso command ran"
   end
 end
@@ -49,13 +53,13 @@ command :release do |c|
   c.flag :r, :repo
 
   c.desc "The branch name"
-  c.flag :b, :branch
   c.default_value "master"
+  c.flag :b, :branch
 
   c.action do |global_options, options, args|
     repo = options[:repo]
     branch = options[:branch]
-    Roper::CLI.release(repo, branch, options)
+    Roper::CLI.release(repo, branch, global_options.merge(options))
     puts "release command ran"
   end
 end

data/front-image-attribution.md

@@ -0,0 +1,2 @@
+[Figure-eight knot.svg](https://commons.wikimedia.org/wiki/File:Figure-eight_knot.svg) by [Lucasbosch](https://commons.wikimedia.org/wiki/User:Lucasbosch) is licensed under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/deed.en)
+

data/lib/roper/cli.rb

@@ -10,15 +10,15 @@ module Roper
   # library.  It composes Hub, Repo and Driver to define the main entry
   # methods, lasso and release.
   class CLI
-    # @param [String] repo A GitHub reposiory in the form <user>/<name>
-    # @param [String] branch the name of a branch in the reposiory
-    # @param [Hash] options A customizable set of options
+    # @param [String] repo A GitHub repository in the form <user>/<name>
+    # @param [String] branch The name of a branch in the repository
     #
-    # @option :context [String] A context to differentiate this status from others (default: "roper")
-    # @option :status_url [String] A link to more details about this status
-    # @option :sha [String] ref The sha for a commit
-    # @option :protocol [String] https or http
-    # @option :domain [String] domain for traefik server
+    # @param [Hash] options A customizable set of options
+    # @option options [String] :context A context to differentiate this status from others (default: "roper")
+    # @option options [String] :status_url A link to more details about this status
+    # @option options [String] :sha ref The sha for a commit
+    # @option options [String] :protocol https or http
+    # @option options [String] :domain Domain for Traefik server
     def initialize(repo, branch, options = {})
       @repo = repo
       @branch = branch
@@ -46,7 +46,7 @@ module Roper
     # Update the GitHub PR with a pending status, then pull in the repository
     # and build it by running docker-compose up on it
     def lasso
-      @hub ||= Roper::Hub.new(@repo, ref)
+      @hub ||= Roper::Hub.create(@repo, ref, @options)
       @hub.create_status("pending", status_pending.merge(status_url))
       begin
         @git.mount || @git.update

data/lib/roper/hub.rb

@@ -22,15 +22,25 @@ module Roper
     # @see https://octokit.github.io/octokit.rb/Octokit/Client/Statuses.html
     #
     # @param state [String] The state: pending, success, failure
-    # @param options [Hash] A customizable set of options
-    #
-    # @option :context [String] A context to differentiate this status from others (default: "roper")
-    # @option :target_url [String] A link to more details about this status
-    # @option :description [String] A short human-readable description of this status
     #
-    # @return [Sawyer::Resource] A short human-readable description of this status
+    # @param options [Hash] A customizable set of options
+    # @option options [String] :target_url A link to the built site
+    # @option options [String] :description A short human-readable description of this status
     def create_status(state, options = {})
       @client.create_status(@repo, @ref, state, options.merge(context: "roper"))
     end
+
+    def self.create(repo, ref, options = {})
+      if options["disable-hub"]
+        DumbHub.new(repo, ref)
+      else
+        self.new(repo, ref)
+      end
+    end
+  end
+
+  class DumbHub < Hub
+    def create_status(state, options = {})
+    end
   end
 end

data/lib/roper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Roper
-  VERSION = "1.0.0"
+  VERSION = "1.1.0.rc1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.rc1
 platform: ruby
 authors:
 - David Kinzer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-compose
@@ -283,11 +283,11 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
-- README.rdoc
 - Rakefile
 - bin/console
 - bin/setup
 - exe/roper
+- front-image-attribution.md
 - lib/roper.rb
 - lib/roper/cli.rb
 - lib/roper/driver.rb
@@ -310,9 +310,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14

data/README.rdoc

@@ -1,91 +0,0 @@
-= Roper {<img src="https://travis-ci.org/tulibraries/roper.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/tulibraries/roper] {<img src="https://coveralls.io/repos/github/tulibraries/roper/badge.svg?branch=master" alt="Coverage Status" />}[https://coveralls.io/github/tulibraries/roper?branch=master] {<img src="https://img.shields.io/badge/docs-rubydoc-blue.svg" alt="Docs" />}[http://www.rubydoc.info/github/tulibraries/roper/master]
-
-rdoc-image:Figure-eight_knot.svg
-
-Roper is a cli tool used to help stage a dockerized web app.  There are some
-assumptions made about the environment that roper runs in.  The main one is
-that traefik has been configured to run via the docker backend and that the
-dockerized web application uses a docker-compose.yml file that knows how to
-communicate with traefik.
-
-Another assuption made is that the repository for the web applications roper is
-concerned with lives at GitHub: At this point I have no intention of supporting
-another git repository service.
-
-Once Roper is configured it knows how to:
-* Post to a GitHub branch PR with an in progress status for the
-  stage site setup.
-* Pull in a repo locally.
-* Checkout a specific branch.
-* Start docker-compose session
-* Post back to GitHub branch PR with link for QA site or failure
-  status.
-* When a PR is merged or closed the resources can be released/recovered.
-
-Currently, Roper only defines a cli interface so there is no way for GitHub to
-communicate with it direclty via a webhook or whatnot. It's assumed that it
-will be used in conjuction with a service like jenkins ci to handle the webook
-part of the communication and trigger a roper staging on a desired Github event
-(PR creation, update to PR, merge of PR).
-
-Eventually it would be nice for Roper to include a web service interface that
-GitHub can post direclty to. But then again, that might just be scope creep
-considering there are already good options for handling the webhook concern
-(i.e. jenkins)
-
-== Installation
-
-Add this line to your application's Gemfile:
-
-    ruby gem 'roper'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install roper
-
-== Usage
-
-    roper lasso --repo=<user>/<repo> [--branch=<branch>] [--status_url=<url>]
-
-    roper release --repo=<user>/<repo>
-
-OR:
-
-You can use the individual components of the library as you wish.
-
-== Github Authentication
-Currenlty Roper uses netrc for github authentication.  I'm hoping to slap an interface to create this at setup but for now you will need to add a ~/.netrc file with an entry for <tt>api.github.com</tt> manually.
-
-== Development
-
-After checking out the repo, run <tt>bin/setup</tt> to install dependencies. Then, run
-<tt>rake spec</tt> to run the tests. You can also run <tt>bin/console</tt> for an interactive
-prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run <tt>bundle exec rake install</tt>. To
-release a new version, update the version number in <tt>version.rb</tt>, and then run
-<tt>bundle exec rake release</tt>, which will create a git tag for the version, push
-git commits and tags, and push the <tt>.gem</tt> file to
-{rubygems.org}[https://rubygems.org].
-
-== Contributing
-
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/tulibraries/roper. This project is intended to be a safe,
-welcoming space for collaboration, and contributors are expected to adhere to
-the {Contributor Covenant}[http://contributor-covenant.org] code of conduct.
-
-== License
-
-The gem is available as open source under the terms of the {MIT
-License}[http://opensource.org/licenses/MIT].
-
-== Code of Conduct
-
-Everyone interacting in the Roper project’s codebases, issue trackers, chat
-rooms and mailing lists is expected to follow the {code of
-conduct}[https://github.com/tulibraries/roper/blob/master/CODE_OF_CONDUCT.md].