roper 1.0.0.rc2 → 1.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f55471893a985333ae259a60a6673d9d1e14f4d3
-  data.tar.gz: 5b53c810c583a03697dbda89ce40a913bcf4a9ed
+  metadata.gz: b0ad48f2f248b7939ebed67f5d97141368b0049d
+  data.tar.gz: 92bd374b91ae055b5afe465bcdfffca13d6adcd0
 SHA512:
-  metadata.gz: 8491d4579ccc48941a5bc57188a3736f9185eeaea4964a33f0e28fcfc3b1f4ddf8b1ef8f1ac790378f9f0088fcea1bc7bcafb54ff75a185f40a6b67755bb701c
-  data.tar.gz: 4e36caead27d603da5816e507f1261ca3770052aff9be44161686948a321eb239115a2cf322663efb583ac1d93210ba68fe9b66c46ebdcdf903b8f3e05098c98
+  metadata.gz: 93896c718206ff2452f2cc456b12d1f2593b6004ee2c3c0301d2a14cee96c2d7bf8c29796712d43a1df690d274b3f015dbfea74e882eb8f664b0c668d9b19608
+  data.tar.gz: c179484f12d93694a343f337a98589633caa4d92bc3c7c86caae49ceaa7955c17b56e31140fdebd222512ba3d9d2ad08897e1dcccd4ba025fbf03eeabdba0296

data/README.md

@@ -47,9 +47,9 @@ Or install it yourself as:
 
 ## Usage
 
-`roper lasso "--repo=<REPO_OWNER>/<REPO_NAME>" [--branch=<BRANCH_NAME>] [--status-url=<STATUS_URL>]`
+`roper lasso --repo=<user>/<repo> [--branch=<branch>] [--status_url=<url>]`
 
-`roper release "--repo=<REPO_OWNER>/<REPO_NAME>" [--branch=<BRANCH_NAME>]`
+`roper release --repo=<user>/<repo>`
 
 OR:
 

data/README.rdoc

@@ -0,0 +1,89 @@
+= Roper {<img src="https://travis-ci.org/tulibraries/roper.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/tulibraries/roper]
+
+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.
+
+At this point 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].

data/exe/roper

@@ -61,12 +61,10 @@ command :release do |c|
 end
 
 pre do |global, command, options, args|
-  if args.count > 0
-    raise "Unexpected arguments, this command does not take any arguments."
-  end
 
   if command.name == :lasso
-    raise "Protocol must be either 'http' or 'https'" unless ["http", "https"].include?(options[:protocol])
+    help_now! "--repo is required" unless !options[:repo].nil?
+    help_now! "Protocol must be either 'http' or 'https'" unless ["http", "https"].include?(options[:protocol])
   end
 
   # Pre logic here

data/lib/roper/cli.rb

@@ -49,13 +49,13 @@ module Roper
 
       def status_url
         status_url = @options[:status_url]
-        status_url ? { status_url: status_url } : {}
+        status_url ? { target_url: status_url } : {}
       end
 
       def success_url
         protocol = @options[:protocol] || "https"
         domain = @options[:domain] || ENV["DOMAIN"]
-        {  status_url: "#{protocol}://#{@branch}.#{domain}" }
+        {  target_url: "#{protocol}://#{@branch}.#{domain}" }
       end
 
       def status_pending

data/lib/roper/driver.rb

@@ -8,17 +8,15 @@ module Roper
       @repo = Octokit::Repository.new(repo)
       @branch = branch
       @mount_path = Roper::mount_path(repo, branch)
-      @compose = Docker::Compose.new
+      @compose = Docker::Compose::Session.new(dir: @mount_path)
     end
 
     def up
-      Dir.chdir(@mount_path)
       set_env_variables
-      @compose.up
+      @compose.up(detached: true)
     end
 
     def down
-      Dir.chdir(@mount_path)
       @compose.down
     end
 

data/lib/roper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roper
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0.rc3
 platform: ruby
 authors:
 - David Kinzer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-13 00:00:00.000000000 Z
+date: 2018-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-compose
@@ -267,6 +267,7 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
+- README.rdoc
 - Rakefile
 - bin/console
 - bin/setup