leif 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d9a2a1fcb5a84d41c34a61fa2270c7750e06b4c
-  data.tar.gz: 2911bca79cac2758ade4ea92af8ae419d2e504be
+  metadata.gz: 1797138f211bfbb414f907b9b2ec4b03341e14a0
+  data.tar.gz: 596ebf85889c706e6681435e2311f4aa6a04f0bc
 SHA512:
-  metadata.gz: 12f5e0499fef091a3cda5a860c811197e48ff2293a86b1e2de68d4b08b749b5d6309846adca61928a5f2a52e109bc056115b30bc04cd7cb32f275a46e4058b86
-  data.tar.gz: 69e6e8c05f7cc51354a294b5b017562579a32a7a31aeeee2569b1c2239d323354841a8d126ff40f4e893cb71e846925f4fa560b2577f495b95335db71effc40b
+  metadata.gz: 371586765c6584c61486ccdfaeeca69268c6738acac464fef4197aac8c7ad9a0bb8704a897f8b171ac8c4f1d405675100ea8b37c6c119f45164f6bb8486ff373
+  data.tar.gz: 09852a6c60e78b330e16632b18c8207c58d01a19d9e43822ece83e12c7d307d54fb202774ff0d3bc5678dfe6aef889231d7ff0a7922a2f56f49f3e2db667c931

data/README.md

@@ -2,23 +2,17 @@
 
 A hypermedia browser for the CloudApp Collection+JSON API.
 
-## Commands
+## Interactive Commands
 
-```
-  r
-  root
+  - `root`:
     Go back to the root
 
-  f <rel>
-  follow <rel>
+  - `follow` <u>rel</u>:
     Follow link with the given relation.
 
-  b <username> [<password>]
-  basic <username> [<password>]
+  - `basic` <u>username</u> [<u>password</u>]:
     Authenticate with HTTP Basic and reload the current resource. Will be
     prompted for password if it is omitted.
 
-  t <token>
-  token <token>
+  - `token` <u>token</u>:
     Authenticate using the given token and reload the current resource.
-```

data/bin/leif

@@ -106,12 +106,8 @@ def print_response
     out.print_lines JSON.pretty_generate(@response.body).lines
   end
 
-  section 'Options' do |out|
-    if @response.headers['www-authenticate']
-      out.print 'Re-request using HTTP Basic Auth'
-    end
-    out.print "Links: #{link_relations}" unless link_relations.empty?
-    out.print 'Go to root'
+  section 'Links' do |out|
+    out.print link_relations unless link_relations.empty?
   end
 end
 
@@ -136,7 +132,20 @@ def follow_link(relation = :ask)
 end
 
 def print_help
-  puts 'Help goes here'
+  puts <<EOS
+    root:
+      Go back to the root
+
+    follow <rel>:
+      Follow link with the given relation.
+
+    basic <username> [<password>]:
+      Authenticate with HTTP Basic and reload the current resource. Will be
+      prompted for password if it is omitted.
+
+    token <token>:
+      Authenticate using the given token and reload the current resource.
+EOS
 end
 
 def get_next_action

data/leif.gemspec

@@ -15,13 +15,15 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday',            '~> 0.8.8'
   spec.add_dependency 'faraday_middleware', '~> 0.9.0'
   spec.add_dependency 'highline',           '~> 1.6.19'
+  spec.add_development_dependency 'ronn'
 
   spec.bindir      = 'bin'
   spec.executables = ['leif']
 
   spec.files =  %w(LICENSE README.md leif.gemspec)
-  spec.files += Dir.glob('lib/**/*.rb')
   spec.files += Dir.glob('bin/*')
+  spec.files += Dir.glob('lib/**/*.rb')
+  spec.files += Dir.glob('man/*')
 
   spec.required_rubygems_version = '>= 1.3.6'
 end

data/lib/leif/version.rb

@@ -1,3 +1,3 @@
 module Leif
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/man/leif.1

@@ -0,0 +1,32 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "LEIF" "1" "August 2013" "" ""
+.
+.SH "NAME"
+\fBleif\fR \- A hypermedia browser for the CloudApp Collection+JSON API\.
+.
+.SH "SYNOPSIS"
+\fBleif\fR
+.
+.SH "DESCRIPTION"
+\fBleif\fR is a program to explore the CloudApp hypermedia API\. It was built so developers could feel how the API flows to help them consume it in their programs\.
+.
+.SH "INTERACTIVE COMMANDS"
+.
+.TP
+\fBroot\fR
+Go back to the root
+.
+.TP
+\fBfollow\fR \fIrel\fR
+Follow link with the given relation\.
+.
+.TP
+\fBbasic\fR \fIusername\fR [\fIpassword\fR]
+Authenticate with HTTP Basic and reload the current resource\. Will be prompted for password if it is omitted\.
+.
+.TP
+\fBtoken\fR \fItoken\fR
+Authenticate using the given token and reload the current resource\.
+

data/man/leif.1.html

@@ -0,0 +1,109 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>leif(1) - A hypermedia browser for the CloudApp Collection+JSON API.</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+  <style type='text/css' media='all'>
+  /* style: toc */
+  .man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
+  .man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
+  .man-navigation a:hover {color:#111;text-decoration:underline}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#INTERACTIVE-COMMANDS">INTERACTIVE COMMANDS</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>leif(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>leif(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>leif</code> - <span class="man-whatis">A hypermedia browser for the CloudApp Collection+JSON API.</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>leif</code></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><code>leif</code> is a program to explore the CloudApp hypermedia API. It was built so
+developers could feel how the API flows to help them consume it in their
+programs.</p>
+
+<h2 id="INTERACTIVE-COMMANDS">INTERACTIVE COMMANDS</h2>
+
+<dl>
+<dt class="flush"><code>root</code></dt><dd><p>Go back to the root</p></dd>
+<dt><code>follow</code> <var>rel</var></dt><dd><p>Follow link with the given relation.</p></dd>
+<dt><code>basic</code> <var>username</var> [<var>password</var>]</dt><dd><p>Authenticate with HTTP Basic and reload the current resource. Will be
+prompted for password if it is omitted.</p></dd>
+<dt><code>token</code> <var>token</var></dt><dd><p>Authenticate using the given token and reload the current resource.</p></dd>
+</dl>
+
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>August 2013</li>
+    <li class='tr'>leif(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/leif.1.ronn

@@ -0,0 +1,26 @@
+# leif(1) -- A hypermedia browser for the CloudApp Collection+JSON API.
+
+## SYNOPSIS
+
+`leif`
+
+## DESCRIPTION
+
+`leif` is a program to explore the CloudApp hypermedia API. It was built so
+developers could feel how the API flows to help them consume it in their
+programs.
+
+## INTERACTIVE COMMANDS
+
+  - `root`:
+    Go back to the root
+
+  - `follow` <rel>:
+    Follow link with the given relation.
+
+  - `basic` <username> [<password>]:
+    Authenticate with HTTP Basic and reload the current resource. Will be
+    prompted for password if it is omitted.
+
+  - `token` <token>:
+    Authenticate using the given token and reload the current resource.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leif
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Larry Marburger
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.19
+- !ruby/object:Gem::Dependency
+  name: ronn
+  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'
 description: A hypermedia browser for the CloudApp Collection+JSON API.
 email: larry@marburger.cc
 executables:
@@ -64,6 +78,9 @@ files:
 - leif.gemspec
 - bin/leif
 - lib/leif/version.rb
+- man/leif.1
+- man/leif.1.html
+- man/leif.1.ronn
 homepage: https://github.com/cloudapp/leif
 licenses:
 - MIT