roper 1.0.0.rc5 → 1.0.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca28a6ef7fed6b97a0b0f6507d28a7f625c6fef
-  data.tar.gz: c3a1db67fc4e028a64aea23bd00de3804e7bc9f1
+  metadata.gz: ae2dd0a9db8c1fc093de8d10d0a8e159d6bfd944
+  data.tar.gz: 4d7f4611065d473c3cf344ae822ba0820f002617
 SHA512:
-  metadata.gz: 0566216e9aa4cee529ae7cf500ff1ffdcecdab30337a7d3cd8586b801ee142a0eb17166c9e9c29152f1d6639eef0c62c140c5c41079366adfcbb1b5181b59a1b
-  data.tar.gz: '03963a3a7e6a02c0d3ee0f8f2c6f819975cafa5de86d09b22b06f2e7d2c33a3adcedfab13994031c4a27387d1866b624e011a7f8b05ca224057a4f32eb8a9143'
+  metadata.gz: 1a06ee8fb77587bbad566ae10859fd95145989f29b3ab725f5334ce072d120ba7732cd324199c755eb529a464c44c1395d25338b6ad9abf90c8d4ce7f0702241
+  data.tar.gz: be17270fc88ed8a459c7142be393c14b1ec86b85337f76079246af3f1d357d951789ffb8080b8c8bb41659862450333c893e42ab36ed05a438a7f7bcb08fea50

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/README.md

@@ -1,4 +1,4 @@
-# Roper [![Build Status](https://travis-ci.org/tulibraries/roper.svg?branch=master)](https://travis-ci.org/tulibraries/roper)
+# Roper [![Build Status](https://travis-ci.org/tulibraries/roper.svg?branch=master)](https://travis-ci.org/tulibraries/roper) [![Coverage Status](https://coveralls.io/repos/github/tulibraries/roper/badge.svg?branch=master)](https://coveralls.io/github/tulibraries/roper?branch=master) [![Docs](https://img.shields.io/badge/docs-rubydoc-blue.svg)](http://www.rubydoc.info/github/tulibraries/roper/master)
 
 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
@@ -20,7 +20,7 @@ Once Roper is configured it knows how to:
   status. (TODO: make optinal)
 * 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
+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

data/README.rdoc

@@ -1,4 +1,4 @@
-= Roper {<img src="https://travis-ci.org/tulibraries/roper.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/tulibraries/roper]
+= 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]
 
 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
@@ -20,8 +20,8 @@ Once Roper is configured it knows how to:
   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
+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).

data/lib/roper/cli.rb

@@ -6,24 +6,47 @@ require "roper/hub"
 require "roper/driver"
 
 module Roper
+  # This is a controller, and the main entry point into the rest of the
+  # 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 [branch] the name of a branch in the reposiory
+    # @param options [Hash] A customizable set of options
+    #
+    # @options :context [String] A context to differentiate this status from others (default: "roper")
+    # @options :status_url [String] A link to more details about this status
+    # @options :sha [String] ref The sha for a commit
+    # @options :protocol [String] https or http
+    # @options :domain [String] domain for traefik server
     def initialize(repo, branch, options = {})
+      @repo = repo
       @branch = branch
       @options = options
       @git = Roper::Repo.new(repo, branch)
       @driver = Roper::Driver.new(repo, branch)
-      @hub = Roper::Hub.new(repo, ref)
     end
 
+    # Creates an instance of CLI and runs release
+    #
+    # @see initialize
+    # @see release
     def self.lasso(repo, branch, options = {})
       self.new(repo, branch, options).lasso
     end
 
+    # Creates an instance of CLI and runs lasso
+    #
+    # @see initialize
+    # @see lasso
     def self.release(repo, branch, options = {})
       self.new(repo, branch, options).release
     end
 
+    # 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.create_status("pending", status_pending.merge(status_url))
       begin
         @git.mount || @git.update
@@ -34,6 +57,7 @@ module Roper
       end
     end
 
+    # Run docker-compose down on the project and delete the assets
     def release
       @driver.down
       @git.unmount
@@ -62,10 +86,6 @@ module Roper
         { description: "The build process is in progress." }
       end
 
-      def status_error
-        { description: "The build process had irrecoverrable error." }
-      end
-
       def status_failure
         { description: "The PR branch failed to build." }
       end

data/lib/roper/driver.rb

@@ -3,7 +3,10 @@
 require "docker/compose"
 
 module Roper
+  # This class is concerned with docker-compose process
   class Driver
+    # @param [String] repo A GitHub reposiory in the form <user>/<name>
+    # @param [branch] the name of a branch in the reposiory
     def initialize(repo, branch)
       @repo = Octokit::Repository.new(repo)
       @branch = branch
@@ -11,11 +14,13 @@ module Roper
       @compose = Docker::Compose::Session.new(dir: @mount_path)
     end
 
+    # Runs docker-compose up in detached mode with a forced rebuild
     def up
       set_env_variables
       @compose.up(detached: true, build: true)
     end
 
+    # Runs docker-compose down
     def down
       @compose.down
     end

data/lib/roper/hub.rb

@@ -5,13 +5,30 @@ require "netrc"
 require "json"
 
 module Roper
+  # This class is concerned with GitHub API communications.
   class Hub
+    # Create and instance of the Hub class
+    #
+    # @param [String] repo A GitHub reposiory in the form <user>/<name>
+    # @param [String] ref The sha for a commit
     def initialize(repo, ref)
       @repo = repo
       @ref = ref
       @client = Octokit::Client.new(netrc: true)
     end
 
+    # Changes the status on a GitHub PR
+    #
+    # @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
+    #
+    # @options :context [String] A context to differentiate this status from others (default: "roper")
+    # @options :target_url [String] A link to more details about this status
+    # @options :description [String] A short human-readable description of this status
+    #
+    # @return [Sawyer::Resource] A short human-readable description of this status
     def create_status(state, options = {})
       @client.create_status(@repo, @ref, state, options.merge(context: "roper"))
     end

data/lib/roper/repo.rb

@@ -5,27 +5,34 @@ require "octokit"
 require "fileutils"
 
 module Roper
+  # This class is concerned with the repository resource itself
   class Repo
+    # @param [String] repo A GitHub reposiory in the form <user>/<name>
+    # @param [branch] the name of a branch in the reposiory
     def initialize(repo, branch)
       @branch = branch
       @repo = Octokit::Repository.new(repo)
       @mount_path = Roper::mount_path(repo, branch)
     end
 
+    # Pulls in the initialized repository and checkout the initialized branch
     def mount
       Git.clone(@repo.url, @mount_path)
         .checkout(@branch) rescue nil
     end
 
+    # Pulls the latest commit to branch from origin
     def update
       Git.open(@mount_path)
         .pull("origin", @branch)
     end
 
+    # Deletes the local copy of the reposiory
     def unmount
       FileUtils.rm_r(@mount_path)
     end
 
+    # Helper function to get HEAD commit sha for the initialized branch
     def ref
       Git.open(@mount_path).object("HEAD").sha
     end

data/lib/roper/version.rb

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

data/roper.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "binding_of_caller"
   spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "multi_json"
@@ -42,4 +43,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roper
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc5
+  version: 1.0.0.rc6
 platform: ruby
 authors:
 - David Kinzer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-16 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-compose
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -257,6 +271,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"