leif 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dcc95800bc2d5d1ae86cd703bfbe9cc45fada5c
-  data.tar.gz: 0f19f4caffd24aa042d345ebcc6c92a240201b9a
+  metadata.gz: 5fde83f5fbfd332f246ef59ca53fb8c7ba9d1027
+  data.tar.gz: 49965583dbd38fa276145668ece11702fe5c676f
 SHA512:
-  metadata.gz: c9ca62217fa3b5b7032fcb21ddbb351dc59e0d4fd2e725e5883b59ebc7c76fce2bd39877f4dc3c7035d27af54fec50039d24df791ef7b49b2ee7db36d381032f
-  data.tar.gz: 1bc16991a37bf09fe812e7003e998cdd215d56babf3455d119f3ab63dee1321d0747bf147dd08a941971c19402474c9f8f22eaf266451bf9723ccd7b9339ffb1
+  metadata.gz: 846ac3499f51b81c6f39da25559e29878f57697e2c28a4135afe27e1a47b6c505e42ffdeff0ddd42d285c911d00e870fddc884b5f51bf45e6fcc7f7a5906e2e0
+  data.tar.gz: 112adf4af67199102be748649edddfc9f835b329d427ed1f169c68f183b9ebc2fe9c5cdf5e7024dbb5685413f9b396c18eafe54d35c1e061af560cc23a5010ee

data/README.md

@@ -16,3 +16,38 @@ A hypermedia browser for the CloudApp Collection+JSON API.
 
   - `token` <u>token</u>:
     Authenticate using the given token and reload the current resource.
+
+## Example
+
+The UI is weak at this point and not very intuitive. To get started, here's a
+sample workflow. It should give you a general overview of what's possible.
+
+    > follow authorization
+
+    > basic arthur@dent.com
+    Password: *****
+
+    > token <token copied from response body>
+
+    > follow drops
+    > follow next
+    > follow first
+
+    > create
+
+    Name (empty to submit): name
+    Value: CloudApp
+
+    Name (empty to submit): bookmark_url
+    Value: http://getcloudapp.com
+
+    Name (empty to submit):
+
+    > root
+    > follow drops
+    > update
+
+    Name (empty to submit): name
+    Value: The Guide
+
+    Name (empty to submit):

data/bin/leif

@@ -3,10 +3,11 @@
 class CollectionJsonResponse < SimpleDelegator
   extend Forwardable
 
-  def_delegators :collection, :links, :link
+  def_delegators :collection, :href, :links, :link, :items,
+                 :template, :fill_template_field, :fill_template, :submit_template
 
   def collection
-    Collection.new body
+    @collection ||= Collection.new(body)
   end
 
   class Collection < SimpleDelegator
@@ -14,6 +15,10 @@ class CollectionJsonResponse < SimpleDelegator
       super body.fetch('collection')
     end
 
+    def href
+      fetch('href')
+    end
+
     def links
       return [] unless has_key?('links')
       fetch('links').map {|link| Link.new(link) }
@@ -22,6 +27,26 @@ class CollectionJsonResponse < SimpleDelegator
     def link(relation)
       links.find {|link| link.relation == relation }
     end
+
+    def template
+      @template ||= Item.new(fetch('template'))
+    end
+
+    def fill_template_field(name, value)
+      template[name] = value
+    end
+
+    def fill_template(item)
+      item.to_hash.each do |name, value|
+        p [name, value]
+        fill_template_field name, value
+      end
+    end
+
+    def items
+      return [] unless has_key?('items')
+      fetch('items').map {|item| Item.new(item) }
+    end
   end
 
   class Link
@@ -32,10 +57,39 @@ class CollectionJsonResponse < SimpleDelegator
       @href     = link.fetch('href')
     end
   end
+
+  class Item
+    attr_accessor :item
+
+    def initialize(item)
+      @item = item
+    end
+
+    def href
+      @item.fetch('href')
+    end
+
+    def data
+      @item.fetch('data')
+    end
+
+    def []=(name, value)
+      datum = data.find {|datum| datum['name'] == name }
+      return unless datum
+      datum['value'] = value
+    end
+
+    def to_hash
+      data.each_with_object({}) do |datum, data|
+        data[datum['name']] = datum['value']
+      end
+    end
+  end
 end
 
 def conn
   @conn ||= Faraday.new(url: 'https://api.getcloudapp.com') do |config|
+    config.request  :url_encoded
     config.response :logger, logger
     config.response :json, :content_type => /\bjson$/
     config.adapter  Faraday.default_adapter
@@ -55,9 +109,10 @@ def reset_debug_output
   debug_output.truncate 0
 end
 
-def make_request(uri)
+def make_request(uri, data = {}, method = :unset)
+  method = data.empty? ? :get : :post if method == :unset
   reset_debug_output
-  @response = CollectionJsonResponse.new(conn.get(uri))
+  @response = CollectionJsonResponse.new(conn.send(method, uri, data))
 end
 
 def get_root
@@ -69,11 +124,11 @@ def retry_request
 end
 
 def section(banner)
+  puts
   puts "-- #{banner} --"
   output = Output.new(1)
   yield output
   output.print '[empty]' if output.empty?
-  output.print
 end
 
 class Output
@@ -129,7 +184,8 @@ def link_relations
   @response.links.map(&:relation).join(', ')
 end
 
-def request_basic_authentication(username, password = :ask)
+def request_basic_authentication(username = :ask, password = :ask)
+  username = ask('Username: ')                     if username == :ask
   password = ask('Password: ') {|q| q.echo = '*' } if password == :ask
   conn.basic_auth username, password
   retry_request
@@ -145,6 +201,58 @@ def follow_link(relation = :ask)
   make_request @response.link(relation).href
 end
 
+def create_item
+  loop do
+    section 'Create Item' do |out|
+      out.print_lines JSON.pretty_generate(@response.template.item).lines
+    end
+
+    puts
+    puts 'Fill the template to create a new item.'
+    name = ask('Name (empty to submit): ')
+    break if name.empty?
+    value = ask('Value: ')
+
+    @response.fill_template_field name, value
+  end
+
+  make_request @response.collection.href, @response.template.to_hash
+end
+
+def update_item
+  item = @response.collection.items.find do |item|
+    section 'Item' do |out|
+      out.print_lines JSON.pretty_generate(item.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
+
+  @response.fill_template item
+
+  loop do
+    section 'Update Item' do |out|
+      out.print_lines JSON.pretty_generate(@response.template.item).lines
+    end
+
+    puts
+    puts 'Fill the template to update the item.'
+    name = ask('Name (empty to submit): ')
+    break if name.empty?
+    value = ask('Value: ')
+
+    @response.fill_template_field name, value
+  end
+
+  make_request item.href, @response.template.to_hash, :put
+end
+
 def print_debug
   section 'Debug' do |out|
     debug_output.rewind
@@ -160,12 +268,18 @@ def print_help
     follow <rel>:
       Follow link with the given relation.
 
-    basic <username> [<password>]:
+    template [<name>=<value>...]:
+      Fill the template with the given name/value pairs and submit.
+
+    basic [<username> [<password>]]:
       Authenticate with HTTP Basic and reload the current resource. Will be
-      prompted for password if it is omitted.
+      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.
 EOS
 end
 
@@ -174,6 +288,8 @@ def get_next_action
   case command
   when 'r', 'root'   then get_root
   when 'f', 'follow' then follow_link(*args)
+  when      'create' then create_item
+  when      'update' then update_item
   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
@@ -184,6 +300,7 @@ def get_next_action
 end
 
 def ask_for_action
+  puts
   input = ask('> ') {|q| q.readline = true }.split(/\s/)
   [ input.first, input[1..-1] ]
 end

data/lib/leif/version.rb

@@ -1,3 +1,3 @@
 module Leif
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/man/leif.1

@@ -23,8 +23,12 @@ Go back to the root
 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\.
+\fBtemplate\fR [\fIname\fR=\fIvalue\fR\.\.\.]
+Fill the template with the given name/value pairs and submit\.
+.
+.TP
+\fBbasic\fR [\fIusername\fR [\fIpassword\fR]]
+Authenticate with HTTP Basic and reload the current resource\. Will be prompted for username and password if omitted\.
 .
 .TP
 \fBtoken\fR \fItoken\fR
@@ -33,4 +37,86 @@ Authenticate using the given token and reload the current resource\.
 .TP
 \fBdebug\fR
 Print debug output from the previous HTTP request and response\.
+.
+.SH "EXAMPLES"
+Follow a rel=account link:
+.
+.IP "" 4
+.
+.nf
+
+> follow account
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Use HTTP Basic authentication and reload the current resource:
+.
+.IP "" 4
+.
+.nf
+
+> basic
+Username: arthur@dent\.com
+Password: ********
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Set token authentication:
+.
+.IP "" 4
+.
+.nf
+
+> token abc123def456
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create a new item filling the \fBname\fR and \fBbookmark_url\fR fields:
+.
+.IP "" 4
+.
+.nf
+
+> create
+
+Name (empty to submit): name
+Value: CloudApp
+
+Name (empty to submit): bookmark_url
+Value: http://getcloudapp\.com
+
+Name (empty to submit):
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Update an item filling the \fBpassword\fR field:
+.
+.IP "" 4
+.
+.nf
+
+> update
+
+Select this item to update [y,n]? y
+
+Name (empty to submit): password
+Value: towel
+
+Name (empty to submit):
+.
+.fi
+.
+.IP "" 0
 

data/man/leif.1.html

@@ -63,6 +63,7 @@
     <a href="#SYNOPSIS">SYNOPSIS</a>
     <a href="#DESCRIPTION">DESCRIPTION</a>
     <a href="#INTERACTIVE-COMMANDS">INTERACTIVE COMMANDS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
   </div>
 
   <ol class='man-decor man-head man head'>
@@ -91,13 +92,58 @@ programs.</p>
 <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>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><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>
 </dl>
 
 
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Follow a rel=account link:</p>
+
+<pre><code>&gt; follow account
+</code></pre>
+
+<p>Use HTTP Basic authentication and reload the current resource:</p>
+
+<pre><code>&gt; basic
+Username: arthur@dent.com
+Password: ********
+</code></pre>
+
+<p>Set token authentication:</p>
+
+<pre><code>&gt; token abc123def456
+</code></pre>
+
+<p>Create a new item filling the <code>name</code> and <code>bookmark_url</code> fields:</p>
+
+<pre><code>&gt; create
+
+Name (empty to submit): name
+Value: CloudApp
+
+Name (empty to submit): bookmark_url
+Value: http://getcloudapp.com
+
+Name (empty to submit):
+</code></pre>
+
+<p>Update an item filling the <code>password</code> field:</p>
+
+<pre><code>&gt; update
+
+Select this item to update [y,n]? y
+
+Name (empty to submit): password
+Value: towel
+
+Name (empty to submit):
+</code></pre>
+
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>

data/man/leif.1.ronn

@@ -18,12 +18,54 @@ programs.
   - `follow` <rel>:
     Follow link with the given relation.
 
-  - `basic` <username> [<password>]:
+  - `template` [<name>=<value>...]:
+    Fill the template with the given name/value pairs and submit.
+
+  - `basic` [<username> [<password>]]:
     Authenticate with HTTP Basic and reload the current resource. Will be
-    prompted for password if it is omitted.
+    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.
+
+## EXAMPLES
+
+Follow a rel=account link:
+
+    > follow account
+
+Use HTTP Basic authentication and reload the current resource:
+
+    > basic
+    Username: arthur@dent.com
+    Password: ********
+
+Set token authentication:
+
+    > token abc123def456
+
+Create a new item filling the `name` and `bookmark_url` fields:
+
+    > create
+
+    Name (empty to submit): name
+    Value: CloudApp
+
+    Name (empty to submit): bookmark_url
+    Value: http://getcloudapp.com
+
+    Name (empty to submit):
+
+Update an item filling the `password` field:
+
+    > update
+
+    Select this item to update [y,n]? y
+
+    Name (empty to submit): password
+    Value: towel
+
+    Name (empty to submit):

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leif
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Larry Marburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-07 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday