zazu 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 122bb6333e70968f87c722ed46057098565a07f0a93cb1ea5c09d82217477e7e
-  data.tar.gz: a0b0493d24f96653457e9853a2fc87108efbd1c958963684451fa55f7878c571
+  metadata.gz: c368efff2b6adff8716c4b69d860b482b95a36b3d055124fdb3eac1218fc15db
+  data.tar.gz: 4ea392972f1b5590571e252454e5e137ac9d502e25800c24fe5385920c2d1dde
 SHA512:
-  metadata.gz: 56e99ec2ef45f43e69cdf274c04af0bfb2f1bdee65e5101b8bf1e3976677eb13b85bc48fc842546d3a191f3fff15c35d2a1fddf19358f547610c65dca674326c
-  data.tar.gz: 8b0346c3e0d00771a5a764fe5f90958af5318b07daf69e75d1f06431c663c7de6c2d521385a9042c19cd464fbd8ec5cb4487cc497696dfd48098d979376ff772
+  metadata.gz: 04cdb1d755be034d09991859f44ff335ce110ac7f59746299b2631aad46abd5fc84cfb105c2499af186b5b81522bfb550cd03c6fe476cfa3e53bd5c03644bb4d
+  data.tar.gz: c1d9acf87bf13b41f8417395ea41a1b37602afa3eb9479e55d41bbb9895102a66937e9fbfb5543f0320430111de0bba6f6914695489f934b9ae2f3a9b8ccd5bc

data/README.md

@@ -1,2 +1,22 @@
+[![Gem Version](https://badge.fury.io/rb/zazu.svg)](http://badge.fury.io/rb/zazu)
+
 # zazu
 Fetch tools and run them
+
+Example:
+```ruby
+zazu = Zazu.new 'my-script'
+zazu.fetch url: 'https://example.com/my_script.sh'
+zazu.run ['--environment', 'prod']
+```
+
+To fetch os-dependent tools:
+```ruby
+zazu = Zazu.new 'my-script'
+zazu.fetch do |os, arch|
+  # os will be :linux, :mac, :windows
+  # arch will be 32 or 64
+  "https://example.com/my_script-#{os}_#{arch}-bit"
+end
+```
+

data/lib/zazu.rb

@@ -8,8 +8,16 @@ require 'thread'
 require 'tmpdir'
 require 'uri'
 
+# Fetch tools and run them
+#
+# Example:
+# 
+#   zazu = Zazu.new 'my-script'
+#   zazu.fetch url: 'https://example.com/my_script.sh'
+#   zazu.run ['--environment', 'prod']
+#
 class Zazu
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
   class Error < Exception; end
   class DownloadError < Error; end
@@ -17,6 +25,11 @@ class Zazu
 
   attr_reader :name, :path
 
+  # Creates the Zazu instance. Create as many as you like.
+  #
+  # * +:name:+ - The name of the command
+  # * +:logger:+ - Default to STDERR, can be replaced with another, e.g. IO::NIL
+  # * +:level:+ - Log level for the logger
   def initialize(name, logger: Logger.new(STDERR), level: Logger::INFO)
     @name = name
     @path = File.join Dir.tmpdir, name + '-download'
@@ -24,6 +37,10 @@ class Zazu
     @logger.level = level
   end
 
+  # Download the tool, to the temp directory
+  # * +:url:+ - The URL to the tool--Optional, can specity the block instead
+  # * +:age:+ - Seconds old the downloaded copy can be before downloading again--Default is 3600
+  # * +:block:+ - Receives the OS (:linux, :mac, :windows) and the machine arch (32 or 64)--Should return the URL
   def fetch(url: nil, age: 60*60, &block)
     return false if File.exists?(path) && Time.now - File.stat(path).mtime < age
 
@@ -33,6 +50,11 @@ class Zazu
     download_file url
   end
 
+  # Run the downloaded tool with arguments
+  # * +:args:+ - An array of args for the command
+  # * +:show:+ - A regexp of output (STDOUT and STDERR) to include
+  # * +:hide:+ - A regexp of output (STDOUT and STDERR) to exclude
+  # * +:block:+ - If given, receies each output line, otherwise output is logged
   def run(args = [], show: //, hide: /^$/, &block) 
     command = [path] + args
     @logger.debug "Running command #{command}".yellow
@@ -100,7 +122,7 @@ class Zazu
     when /darwin/i
       :mac
     when /windows/i
-      :win
+      :windows
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zazu
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Calhoun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -57,5 +57,5 @@ requirements: []
 rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
-summary: Download tools and run them
+summary: Fetch tools and run them
 test_files: []