leif 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ea567a178df95bf78d96ecd8785fdc0efe759bc
-  data.tar.gz: a28cad7fb674260307e5e582f8b13a245cb0d814
+  metadata.gz: 3610c76b9d9f405c0e4bdb4e0a32e9762cd51cb4
+  data.tar.gz: ef233fb2ad75558607817a0c0497263ea4a6d681
 SHA512:
-  metadata.gz: 1bb6da4ca06176c47e46c2a8647efac6d8af5eff9e4b44aa799d94a16e6b958966a490adc33ae1072b7a03a6d1b0e5a5eba0f3c139ec232dfcb607be6ec3df48
-  data.tar.gz: ca287bcfc08378281846e479c30e2cb07a5430de571bfcfd50fcd4d55d85550009dc33ebf477b96c9be5761ed849a9e337f5d2e6da3c4b863fa8ff7e65d07aa6
+  metadata.gz: 1fe9d60703d464079f71339e5aeaf3ec2a7d8fc9adc89f809bca82deb98e21f8da1665c5711496aa1ff279fa517dcd42865a9240c08bf03f0c159db0a04cb55c
+  data.tar.gz: 1b5a54e33254a55c1d06e63ff73c889631ed7253d0dcb034d3687bf164be395d61ba60eb499d606f63bf306a20158c065eb6de316545784aa922778f82a54cce

data/bin/leif

@@ -3,15 +3,10 @@ require 'leif/cli'
 require 'leif/collection_json'
 require 'leif/section'
 
-trap('INT') do
-  puts
-  exit
-end
-
 Leif::Cli.new.tap do |cli|
   cli.get_root
   loop do
-    cli.print_response
+    cli.print_overview
     cli.get_next_action
   end
 end

data/lib/leif/cli.rb

@@ -52,29 +52,15 @@ module Leif
       make_request @response.env[:url].request_uri
     end
 
-    def print_response
-      banner 'Request' do |out|
-        out.print "#{@response.env[:method].upcase} #{@response.env[:url]}"
-        out.print @response.env[:request_headers].map {|header, value|
-          "#{header}: #{value}"
-        }
-      end
-
-      banner 'Response' do |out|
-        out.print @response.headers.map {|header, value|
-          "#{header}: #{value}"
-        }
-      end
+    def print_overview
+      print_request
+      print_response
 
       banner 'Body' do |out|
         out.print JSON.pretty_generate(@response.body).lines
       end
 
-      banner 'Links' do |out|
-        unless collection.link_relations.empty?
-          out.print collection.link_relations.join(', ')
-        end
-      end
+      print_links collection
     end
 
     def request_basic_authentication(username = :ask, password = :ask)
@@ -89,24 +75,21 @@ module Leif
       retry_request
     end
 
-    def follow_link(relation = :ask)
+    def follow_link(subject, relation = :ask)
       relation = ask('Relation: ') if relation == :ask
-      make_request collection.link_href(relation)
+      make_request subject.link_href(relation)
     end
 
     def create_item
       template = collection.template
 
       loop do
-        banner 'Create Item' do |out|
-          out.print JSON.pretty_generate(template).lines
-        end
-
+        print_template template, 'Create Item'
         puts
         puts 'Fill the template to create a new item.'
         name = ask('Name (empty to submit): ')
         break if name.empty?
-        value = ask('Value: ')
+        value = ask_for_primitive('Value: ')
 
         template = template.fill_field name, value
       end
@@ -114,33 +97,16 @@ module Leif
       make_request template.href, template.convert_to_json, template.method
     end
 
-    def update_item
-      item = collection.items.find do |item|
-        banner 'Item' do |out|
-          out.print JSON.pretty_generate(item).lines
-        end
-
-        puts
-        response = ask('Select this item to update [y,n]? ') do |q|
-          q.character = true
-          q.validate  = /\A[yn]\Z/
-        end
-
-        response == 'y'
-      end
-
+    def update(item)
       template = collection.item_template item
 
       loop do
-        banner 'Update Item' do |out|
-          out.print JSON.pretty_generate(template).lines
-        end
-
+        print_template template, 'Update Item'
         puts
         puts 'Fill the template to update the item.'
         name = ask('Name (empty to submit): ')
         break if name.empty?
-        value = ask('Value: ')
+        value = ask_for_primitive('Value: ')
 
         template = template.fill_field name, value
       end
@@ -148,6 +114,64 @@ module Leif
       make_request template.href, template.convert_to_json, template.method
     end
 
+    def print_request
+      banner 'Request' do |out|
+        out.print "#{@response.env[:method].upcase} #{@response.env[:url]}"
+        out.print @response.env[:request_headers].map {|header, value|
+          "#{header}: #{value}"
+        }
+      end
+    end
+
+    def print_response
+      banner 'Response' do |out|
+        out.print @response.headers.map {|header, value|
+          "#{header}: #{value}"
+        }
+      end
+    end
+
+    def print_links(subject)
+      banner 'Links' do |out|
+        unless subject.link_relations.empty?
+          out.print subject.link_relations.join(', ')
+        end
+      end
+    end
+
+    def print_template(template = collection.template, label = 'Template')
+      banner label do |out|
+        out.print JSON.pretty_generate(template).lines
+      end
+    end
+
+    def print_items
+      item = select_item
+      print_links item
+      get_next_item_action item
+    rescue Interrupt
+      print '^C'
+    end
+
+    def print_item(item)
+      banner 'Item' do |out|
+        out.print JSON.pretty_generate(item).lines
+      end
+    end
+
+    def select_item
+      collection.items.find do |item|
+        print_item item
+        puts
+        response = ask('Select this item [y,n]? ') do |q|
+          q.character = true
+          q.validate  = /\A[yn]\Z/
+        end
+
+        response == 'y'
+      end
+    end
+
     def print_debug
       banner 'Debug' do |out|
         debug_output.rewind
@@ -156,42 +180,109 @@ module Leif
     end
 
     def print_help
-      puts <<EOS
-    root:
-      Go back to the root
+      banner 'Help' do |out|
+        out.print <<EOS.lines
+root:
+  Go back to the root.
 
-    follow <rel>:
-      Follow link with the given relation.
+follow <rel>:
+  Follow link with the relation <rel> on the collection.
 
-    template [<name>=<value>...]:
-      Fill the template with the given name/value pairs and submit.
+create:
+  Begin editing the template to create a new item.
 
-    basic [<username> [<password>]]:
-      Authenticate with HTTP Basic and reload the current resource. Will be
-      prompted for username and password if omitted.
+request:
+  Reprint the details of the last request.
 
-    token <token>:
-      Authenticate using the given token and reload the current resource.
+response:
+  Reprint the details of the last response.
 
-    debug:
-      Print debug output from the previous HTTP request and response.
+template:
+  Print the template from the last response.
+
+items:
+  Print each item from the last response one at a time in order to update,
+  delete, or follow an item's link.
+
+basic [<username> [<password>]]:
+  Authenticate with HTTP Basic and reload the current resource. Will be
+  prompted for username and password if omitted.
+
+token <token>:
+  Authenticate using the given token and reload the current resource.
+
+debug:
+  Print debug output from the previous HTTP request and response.
+
+quit:
+  Exit leif.
 EOS
+      end
+    end
+
+    def print_item_help
+      banner 'Help' do |out|
+        out.print <<EOS.lines
+item:
+  Print the selected item.
+
+cancel:
+  Cancel item selection and go back to the collection.
+
+follow <rel>:
+  Follow link with the relation <rel> on the selected item.
+
+update:
+  Begin editing the template to update the selected item.
+
+quit:
+  Exit leif.
+EOS
+      end
+    end
+
+    def get_next_item_action(item)
+      command, args = ask_for_action
+      case command
+      when 'item'        then print_item(item); get_next_item_action(item)
+      when 'update'      then update(item)
+      when 'f', 'follow' then follow_link(item, *args)
+      when 'cancel'
+      when 'q', 'quit'   then exit
+      when '?', 'help'   then print_item_help; get_next_item_action(item)
+      else puts 'Try again.'; get_next_item_action(item)
+      end
+    rescue Interrupt
+      print '^C'
     end
 
     def get_next_action
       command, args = ask_for_action
       case command
       when 'r', 'root'   then get_root
-      when 'f', 'follow' then follow_link(*args)
+      when 'f', 'follow' then follow_link(collection, *args)
       when      'create' then create_item
       when      'update' then update_item
+
+      when 'request'     then print_request;  get_next_action
+      when 'response'    then print_response; get_next_action
+      when 'template'    then print_template; get_next_action
+      when 'items'       then print_items
+
       when 'b', 'basic'  then request_basic_authentication(*args)
       when 't', 'token'  then request_token_authentication(*args)
+
       when 'd', 'debug'  then print_debug; get_next_action
       when '?', 'help'   then print_help; get_next_action
       when 'q', 'quit'   then exit
       else puts 'Try again.'; get_next_action
       end
+    rescue Interrupt
+      print '^C'
+      get_next_action
+    rescue EOFError
+      puts
+      exit
     end
 
     def ask_for_action
@@ -199,5 +290,24 @@ EOS
       input = ask('> ') {|q| q.readline = true }.split(/\s/)
       [ input.first, input[1..-1] ]
     end
+
+    def ask_for_primitive(message)
+      value = ask(message)
+      case value
+      when 'null', 'nil' then nil
+      when '"null"'      then 'null'
+      when '"nil"'       then 'nil'
+
+      when 'true'    then true
+      when 'false'   then false
+      when '"true"'  then 'true'
+      when '"false"' then 'false'
+
+      when /\A\d+\Z/   then Integer(value)
+      when /\A"\d+"\Z/ then value[1..-2]
+
+      else value
+      end
+    end
   end
 end

data/lib/leif/collection_json.rb

@@ -3,14 +3,7 @@ require 'forwardable'
 
 module Leif
   module CollectionJson
-    class Collection
-      extend Forwardable
-      def_delegators :@data, :fetch, :has_key?
-
-      def initialize(body)
-        @data = body.fetch('collection')
-      end
-
+    module Linked
       def link_href(relation)
         links.find {|link| link.fetch('rel') == relation }.fetch('href')
       end
@@ -23,10 +16,34 @@ module Leif
         return [] unless has_key?('links')
         fetch('links')
       end
+    end
+
+    class Collection
+      extend  Forwardable
+      include Linked
+
+      def_delegators :@data, :fetch, :has_key?
+
+      def initialize(body)
+        @data = body.fetch('collection')
+      end
+
+      # def link_href(relation)
+      #   links.find {|link| link.fetch('rel') == relation }.fetch('href')
+      # end
+
+      # def link_relations
+      #   links.map {|link| link.fetch('rel') }
+      # end
+
+      # def links
+      #   return [] unless has_key?('links')
+      #   fetch('links')
+      # end
 
       def items
         return [] unless has_key?('items')
-        fetch('items')
+        fetch('items').map {|item| Item.new(item) }
       end
 
       def template(href = fetch('href'), method = :post)
@@ -40,6 +57,10 @@ module Leif
         }
       end
 
+      class Item < SimpleDelegator
+        include Linked
+      end
+
       class Template < SimpleDelegator
         attr_accessor :href, :method
 

data/lib/leif/version.rb

@@ -1,3 +1,3 @@
 module Leif
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/man/leif.1

@@ -16,15 +16,39 @@
 .
 .TP
 \fBroot\fR
-Go back to the root
+Go back to the root\.
 .
 .TP
 \fBfollow\fR \fIrel\fR
-Follow link with the given relation\.
+Follow link with the relation \fIrel\fR on the collection or selected item\.
 .
 .TP
-\fBtemplate\fR [\fIname\fR=\fIvalue\fR\.\.\.]
-Fill the template with the given name/value pairs and submit\.
+\fBcreate\fR
+Begin editing the template to create a new item\.
+.
+.TP
+\fBupdate\fR
+Begin editing the template to update the item selected with \fBitems\fR\.
+.
+.TP
+\fBrequest\fR
+Reprint the details of the last request\.
+.
+.TP
+\fBresponse\fR
+Reprint the details of the last response\.
+.
+.TP
+\fBtemplate\fR
+Print the template from the last response\.
+.
+.TP
+\fBitems\fR
+Print each item from the last response one at a time in order to update, delete, or follow an item\'s link\.
+.
+.TP
+\fBitem\fR
+Print the selected item\.
 .
 .TP
 \fBbasic\fR [\fIusername\fR [\fIpassword\fR]]
@@ -38,6 +62,14 @@ Authenticate using the given token and reload the current resource\.
 \fBdebug\fR
 Print debug output from the previous HTTP request and response\.
 .
+.TP
+\fBhelp\fR
+Print available commands\.
+.
+.TP
+\fBquit\fR
+Exit \fBleif\fR\.
+.
 .SH "EXAMPLES"
 Follow a rel=account link:
 .
@@ -119,4 +151,23 @@ Name (empty to submit):
 .fi
 .
 .IP "" 0
+.
+.P
+JSON primitives (null, integers, and booleans) are interpreted as such\. Use quotes for literal strings\.
+.
+.IP "" 4
+.
+.nf
+
+> create
+
+Name (empty to submit): private
+Value: true
+
+Name (empty to submit): name
+Value: "true"
+.
+.fi
+.
+.IP "" 0
 

data/man/leif.1.html

@@ -90,13 +90,22 @@ 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>template</code> [<var>name</var>=<var>value</var>...]</dt><dd><p>Fill the template with the given name/value pairs and submit.</p></dd>
+<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 relation <var>rel</var> on the collection or selected item.</p></dd>
+<dt class="flush"><code>create</code></dt><dd><p>Begin editing the template to create a new item.</p></dd>
+<dt class="flush"><code>update</code></dt><dd><p>Begin editing the template to update the item selected with <code>items</code>.</p></dd>
+<dt class="flush"><code>request</code></dt><dd><p>Reprint the details of the last request.</p></dd>
+<dt><code>response</code></dt><dd><p>Reprint the details of the last response.</p></dd>
+<dt><code>template</code></dt><dd><p>Print the template from the last response.</p></dd>
+<dt class="flush"><code>items</code></dt><dd><p>Print each item from the last response one at a time in order to update,
+delete, or follow an item's link.</p></dd>
+<dt class="flush"><code>item</code></dt><dd><p>Print the selected item.</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 username and password if 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>
 <dt class="flush"><code>debug</code></dt><dd><p>Print debug output from the previous HTTP request and response.</p></dd>
+<dt class="flush"><code>help</code></dt><dd><p>Print available commands.</p></dd>
+<dt class="flush"><code>quit</code></dt><dd><p>Exit <code>leif</code>.</p></dd>
 </dl>
 
 
@@ -144,6 +153,18 @@ Value: towel
 Name (empty to submit):
 </code></pre>
 
+<p>JSON primitives (null, integers, and booleans) are interpreted as such. Use
+quotes for literal strings.</p>
+
+<pre><code>&gt; create
+
+Name (empty to submit): private
+Value: true
+
+Name (empty to submit): name
+Value: "true"
+</code></pre>
+
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>

data/man/leif.1.ronn

@@ -13,13 +13,32 @@ programs.
 ## INTERACTIVE COMMANDS
 
   - `root`:
-    Go back to the root
+    Go back to the root.
 
   - `follow` <rel>:
-    Follow link with the given relation.
+    Follow link with the relation <rel> on the collection or selected item.
 
-  - `template` [<name>=<value>...]:
-    Fill the template with the given name/value pairs and submit.
+  - `create`:
+    Begin editing the template to create a new item.
+
+  - `update`:
+    Begin editing the template to update the item selected with `items`.
+
+  - `request`:
+    Reprint the details of the last request.
+
+  - `response`:
+    Reprint the details of the last response.
+
+  - `template`:
+    Print the template from the last response.
+
+  - `items`:
+    Print each item from the last response one at a time in order to update,
+    delete, or follow an item's link.
+
+  - `item`:
+    Print the selected item.
 
   - `basic` [<username> [<password>]]:
     Authenticate with HTTP Basic and reload the current resource. Will be
@@ -31,6 +50,12 @@ programs.
   - `debug`:
     Print debug output from the previous HTTP request and response.
 
+  - `help`:
+    Print available commands.
+
+  - `quit`:
+    Exit `leif`.
+
 ## EXAMPLES
 
 Follow a rel=account link:
@@ -69,3 +94,14 @@ Update an item filling the `password` field:
     Value: towel
 
     Name (empty to submit):
+
+JSON primitives (null, integers, and booleans) are interpreted as such. Use
+quotes for literal strings.
+
+    > create
+
+    Name (empty to submit): private
+    Value: true
+
+    Name (empty to submit): name
+    Value: "true"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leif
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Larry Marburger