leif 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fde83f5fbfd332f246ef59ca53fb8c7ba9d1027
-  data.tar.gz: 49965583dbd38fa276145668ece11702fe5c676f
+  metadata.gz: 9ea567a178df95bf78d96ecd8785fdc0efe759bc
+  data.tar.gz: a28cad7fb674260307e5e582f8b13a245cb0d814
 SHA512:
-  metadata.gz: 846ac3499f51b81c6f39da25559e29878f57697e2c28a4135afe27e1a47b6c505e42ffdeff0ddd42d285c911d00e870fddc884b5f51bf45e6fcc7f7a5906e2e0
-  data.tar.gz: 112adf4af67199102be748649edddfc9f835b329d427ed1f169c68f183b9ebc2fe9c5cdf5e7024dbb5685413f9b396c18eafe54d35c1e061af560cc23a5010ee
+  metadata.gz: 1bb6da4ca06176c47e46c2a8647efac6d8af5eff9e4b44aa799d94a16e6b958966a490adc33ae1072b7a03a6d1b0e5a5eba0f3c139ec232dfcb607be6ec3df48
+  data.tar.gz: ca287bcfc08378281846e479c30e2cb07a5430de571bfcfd50fcd4d55d85550009dc33ebf477b96c9be5761ed849a9e337f5d2e6da3c4b863fa8ff7e65d07aa6

data/README.md

@@ -2,6 +2,25 @@
 
 A hypermedia browser for the CloudApp Collection+JSON API.
 
+## Requirements
+
+`leif` requires Ruby 1.9.3 or greater. Windows is not yet supported. If you're
+willing to lend a hand, we'd love to officially support it.
+
+## Installation
+
+``` bash
+$ gem install leif
+$ leif
+```
+
+`leif` includes a man page. To read it:
+
+``` bash
+$ gem install gem-man
+$ gem man leif
+```
+
 ## Interactive Commands
 
   - `root`:
@@ -17,6 +36,9 @@ A hypermedia browser for the CloudApp Collection+JSON API.
   - `token` <u>token</u>:
     Authenticate using the given token and reload the current resource.
 
+  - `help`:
+    Print interactive command help.
+
 ## Example
 
 The UI is weak at this point and not very intuitive. To get started, here's a

data/bin/leif

@@ -1,325 +1,17 @@
 #!/usr/bin/env ruby
+require 'leif/cli'
+require 'leif/collection_json'
+require 'leif/section'
 
-class CollectionJsonResponse < SimpleDelegator
-  extend Forwardable
-
-  def_delegators :collection, :href, :links, :link, :items,
-                 :template, :fill_template_field, :fill_template, :submit_template
-
-  def collection
-    @collection ||= Collection.new(body)
-  end
-
-  class Collection < SimpleDelegator
-    def initialize(body)
-      super body.fetch('collection')
-    end
-
-    def href
-      fetch('href')
-    end
-
-    def links
-      return [] unless has_key?('links')
-      fetch('links').map {|link| Link.new(link) }
-    end
-
-    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
-    attr_accessor :relation, :href
-
-    def initialize(link)
-      @relation = link.fetch('rel')
-      @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
-  end
-end
-
-def logger
-  @logger ||= Logger.new(debug_output)
-end
-
-def debug_output
-  @debug_output ||= StringIO.new
-end
-
-def reset_debug_output
-  debug_output.rewind
-  debug_output.truncate 0
-end
-
-def make_request(uri, data = {}, method = :unset)
-  method = data.empty? ? :get : :post if method == :unset
-  reset_debug_output
-  @response = CollectionJsonResponse.new(conn.send(method, uri, data))
-end
-
-def get_root
-  make_request '/'
-end
-
-def retry_request
-  make_request @response.env[:url].request_uri
-end
-
-def section(banner)
+trap('INT') do
   puts
-  puts "-- #{banner} --"
-  output = Output.new(1)
-  yield output
-  output.print '[empty]' if output.empty?
+  exit
 end
 
-class Output
-  attr_reader :level, :io
-  def empty?() @empty end
-
-  def initialize(level, io = $stdout)
-    @level = level
-    @io    = io
-    @empty = true
-  end
-
-  def print(line = '')
-    print_lines Array(line)
-  end
-
-  def print_lines(lines)
-    @empty = false
-    lines.each do |line|
-      io.puts(indentation + line)
-    end
-  end
-
-  def indentation
-    '  ' * level
-  end
-end
-
-def print_response
-  section 'Request' do |out|
-    out.print "#{@response.env[:method].upcase} #{@response.env[:url]}"
-    out.print_lines @response.env[:request_headers].map {|header, value|
-      "#{header}: #{value}"
-    }
-  end
-
-  section 'Response' do |out|
-    out.print_lines @response.headers.map {|header, value|
-      "#{header}: #{value}"
-    }
-  end
-
-  section 'Body' do |out|
-    out.print_lines JSON.pretty_generate(@response.body).lines
-  end
-
-  section 'Links' do |out|
-    out.print link_relations unless link_relations.empty?
-  end
-end
-
-def link_relations
-  @response.links.map(&:relation).join(', ')
-end
-
-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
-end
-
-def request_token_authentication(token = '2x033S09401z300E')
-  conn.headers['Authorization'] = "Token token=#{token.inspect}"
-  retry_request
-end
-
-def follow_link(relation = :ask)
-  relation = ask('Relation: ') if 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
-
+Leif::Cli.new.tap do |cli|
+  cli.get_root
   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
+    cli.print_response
+    cli.get_next_action
   end
-
-  make_request item.href, @response.template.to_hash, :put
 end
-
-def print_debug
-  section 'Debug' do |out|
-    debug_output.rewind
-    out.print_lines debug_output.readlines
-  end
-end
-
-def print_help
-  puts <<EOS
-    root:
-      Go back to the root
-
-    follow <rel>:
-      Follow link with the given relation.
-
-    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 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
-
-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      '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
-  when '?', 'help'   then print_help; get_next_action
-  when 'q', 'quit'   then exit
-  else puts 'Try again.'; get_next_action
-  end
-end
-
-def ask_for_action
-  puts
-  input = ask('> ') {|q| q.readline = true }.split(/\s/)
-  [ input.first, input[1..-1] ]
-end
-
-trap('INT') { puts; exit }
-
-get_root
-loop do
-  print_response
-  get_next_action
-end
-
-BEGIN {
-  require 'delegate'
-  require 'forwardable'
-  require 'highline/import'
-  require 'json'
-  require 'faraday'
-  require 'faraday_middleware'
-  require 'logger'
-  require 'stringio'
-}

data/leif.gemspec

@@ -15,6 +15,7 @@ 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 'rspec'
   spec.add_development_dependency 'ronn'
 
   spec.bindir      = 'bin'

data/lib/leif/cli.rb

@@ -0,0 +1,203 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'highline/import'
+require 'json'
+require 'logger'
+require 'stringio'
+
+module Leif
+  class Cli
+    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
+      end
+    end
+
+    def logger
+      @logger ||= Logger.new(debug_output)
+    end
+
+    def debug_output
+      @debug_output ||= StringIO.new
+    end
+
+    def banner(banner, &message)
+      puts
+      Section.banner(banner, &message)
+    end
+
+    def reset_debug_output
+      debug_output.rewind
+      debug_output.truncate 0
+    end
+
+    def make_request(uri, data = {}, method = :unset)
+      method = data.empty? ? :get : :post if method == :unset
+      reset_debug_output
+      @response = conn.send(method, uri, data)
+    end
+
+    def collection
+      Leif::CollectionJson::Collection.new(@response.body)
+    end
+
+    def get_root
+      make_request '/'
+    end
+
+    def retry_request
+      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
+
+      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
+    end
+
+    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
+    end
+
+    def request_token_authentication(token = '2x033S09401z300E')
+      conn.headers['Authorization'] = "Token token=#{token.inspect}"
+      retry_request
+    end
+
+    def follow_link(relation = :ask)
+      relation = ask('Relation: ') if relation == :ask
+      make_request collection.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
+
+        puts
+        puts 'Fill the template to create a new item.'
+        name = ask('Name (empty to submit): ')
+        break if name.empty?
+        value = ask('Value: ')
+
+        template = template.fill_field name, value
+      end
+
+      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
+
+      template = collection.item_template item
+
+      loop do
+        banner 'Update Item' do |out|
+          out.print JSON.pretty_generate(template).lines
+        end
+
+        puts
+        puts 'Fill the template to update the item.'
+        name = ask('Name (empty to submit): ')
+        break if name.empty?
+        value = ask('Value: ')
+
+        template = template.fill_field name, value
+      end
+
+      make_request template.href, template.convert_to_json, template.method
+    end
+
+    def print_debug
+      banner 'Debug' do |out|
+        debug_output.rewind
+        out.print debug_output.readlines
+      end
+    end
+
+    def print_help
+      puts <<EOS
+    root:
+      Go back to the root
+
+    follow <rel>:
+      Follow link with the given relation.
+
+    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 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
+
+    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      '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
+      when '?', 'help'   then print_help; get_next_action
+      when 'q', 'quit'   then exit
+      else puts 'Try again.'; get_next_action
+      end
+    end
+
+    def ask_for_action
+      puts
+      input = ask('> ') {|q| q.readline = true }.split(/\s/)
+      [ input.first, input[1..-1] ]
+    end
+  end
+end

data/lib/leif/collection_json.rb

@@ -0,0 +1,70 @@
+require 'delegate'
+require 'forwardable'
+
+module Leif
+  module CollectionJson
+    class Collection
+      extend Forwardable
+      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')
+      end
+
+      def template(href = fetch('href'), method = :post)
+        Template.new(fetch('template'), href, method)
+      end
+
+      def item_template(item)
+        template = template(item.fetch('href'), :put)
+        item.fetch('data').inject(template) {|template, datum|
+          template.fill_field datum.fetch('name'), datum.fetch('value')
+        }
+      end
+
+      class Template < SimpleDelegator
+        attr_accessor :href, :method
+
+        def initialize(template, href, method)
+          @href   = href
+          @method = method
+          super template
+        end
+
+        def convert_to_json
+          fetch('data').each_with_object({}) do |datum, json|
+            json[datum['name']] = datum['value']
+          end
+        end
+
+        def fill_field(name, value)
+          new_data = fetch('data').map {|datum|
+            datum = datum.clone
+            datum['value'] = value if datum['name'] == name
+            datum
+          }
+          new_template = {'data' => new_data }
+          Template.new(new_template, href, method)
+        end
+      end
+    end
+  end
+end

data/lib/leif/section.rb

@@ -0,0 +1,26 @@
+class Section
+  attr_reader :io
+  def empty?() @empty end
+
+  def initialize(io)
+    @io    = io
+    @empty = true
+  end
+
+  def self.banner(banner, io = $stdout, &message)
+    new(io).banner(banner, &message)
+  end
+
+  def banner(banner, &message)
+    io.puts "-- #{banner} --"
+    yield self
+    print '[empty]' if empty?
+  end
+
+  def print(message)
+    @empty = false
+    Array(message).each do |line|
+      io.puts "  #{line}"
+    end
+  end
+end

data/lib/leif/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leif
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Larry Marburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-08 00:00:00.000000000 Z
+date: 2013-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.19
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: ronn
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +91,9 @@ files:
 - README.md
 - leif.gemspec
 - bin/leif
+- lib/leif/cli.rb
+- lib/leif/collection_json.rb
+- lib/leif/section.rb
 - lib/leif/version.rb
 - man/leif.1
 - man/leif.1.html