razor-client 0.10.0 → 0.11.0

data/.gitignore

@@ -1,5 +1,7 @@
 config.yaml
 log/*
+pkg/
 /.yardoc
 /Gemfile.local*
 /coverage
+/.project

data/bin/razor

@@ -15,6 +15,9 @@ begin
   puts "From #{url}:\n\n#{format_document document}\n\n"
 rescue Razor::CLI::NavigationError => e
   puts "Error: #{e}\n#{parse.help}\n\n"
+rescue SocketError, Errno::ECONNREFUSED => e
+  puts "Error: Could not connect to the server at #{parse.api_url}"
+  puts "       #{e}\n"
 rescue RestClient::Exception => e
   r = e.response
   puts "Error from doing #{r.args[:method].to_s.upcase} #{r.args[:url]}"

data/lib/razor/cli/navigate.rb

@@ -1,5 +1,6 @@
 require 'rest-client'
 require 'json'
+require 'yaml'
 
 module Razor::CLI
   class Navigate
@@ -63,10 +64,10 @@ module Razor::CLI
       body = {}
       until @segments.empty?
         if @segments.shift =~ /\A--([a-z-]+)(=(\S+))?\Z/
-          body[$1] = ($3 || @segments.shift)
+          body[$1] = convert_arg(cmd["name"], $1, ($3 || @segments.shift))
         end
       end
-      # Special treatment for tag rules
+      # Parse JSON-valued arguments
       if cmd["name"] == "create-tag" && body["rule"]
         body["rule"] = JSON::parse(body["rule"])
       end
@@ -114,5 +115,20 @@ module Razor::CLI
       puts "POST #{url.to_s}\n#{body}\n-->\n#{response.body}" if @parse.dump_response?
       JSON::parse(response.body)
     end
+
+    private
+    def self.annotations
+      @@annotations ||=
+        YAML::load_file(File::join(File::dirname(__FILE__), "navigate.yaml"))
+    end
+
+    def self.arg_type(cmd_name, arg_name)
+      cmd = annotations["commands"][cmd_name]
+      cmd && cmd["args"][arg_name]
+    end
+
+    def convert_arg(cmd_name, arg_name, value)
+      self.class.arg_type(cmd_name, arg_name) == "json" ? JSON::parse(value) : value
+    end
   end
 end

data/lib/razor/cli/navigate.yaml

@@ -0,0 +1,14 @@
+---
+
+# This file helps Razor::CLI::Navigate with a few things by annotating the
+# API. Ultimately, this should be something the server provides. But until
+# we better understand what sort of annotation we need from the server,
+# we'll keep this with the client.
+
+commands:
+  create-tag:
+    args:
+      rule: json
+  update-tag-rule:
+    args:
+      rule: json

data/lib/razor/cli/parse.rb

@@ -4,6 +4,8 @@ require 'optparse'
 module Razor::CLI
 
   class Parse
+    DEFAULT_RAZOR_API = "http://localhost:8080/api"
+
     def get_optparse
       @optparse ||= OptionParser.new do |opts|
         opts.banner = "Usage: razor [FLAGS] NAVIGATION\n"
@@ -13,8 +15,11 @@ module Razor::CLI
           @dump = true
         end
 
-        opts.on "-U", "--url URL", "The full Razor API URL (default #{@api_url})" do |url|
-          @api_url = URI.parse(url)
+        opts.on "-U", "--url URL",
+          "The full Razor API URL, can also be set\n" + " "*37 +
+          "with the RAZOR_API environment variable\n" + " "*37 +
+          "(default #{DEFAULT_RAZOR_API})" do |url|
+          parse_and_set_api_url(url, :opts)
         end
 
         opts.on "-h", "--help", "Show this screen" do
@@ -33,8 +38,13 @@ module Razor::CLI
 
     def help
       output = get_optparse.to_s
-      output << list_things("collections", navigate.collections)
-      output << list_things("commands", navigate.commands)
+      begin
+        output << list_things("collections", navigate.collections)
+        output << list_things("commands", navigate.commands)
+      rescue
+        output << "\nCould not connect to the server at #{@api_url}. More help is available after "
+        output << "pointing\nthe client to a Razor server"
+      end
       output
     end
 
@@ -49,7 +59,7 @@ module Razor::CLI
     attr_reader :api_url
 
     def initialize(args)
-      @api_url = URI.parse("http://localhost:8080/api")
+      parse_and_set_api_url(ENV["RAZOR_API"] || DEFAULT_RAZOR_API, :env)
       @args = args.dup
       rest = get_optparse.order(args)
       if rest.any?
@@ -62,5 +72,14 @@ module Razor::CLI
     def navigate
       @navigate ||=Navigate.new(self, @navigation)
     end
+
+    private
+    def parse_and_set_api_url(url, source)
+      begin
+        @api_url = URI.parse(url)
+      rescue URI::InvalidURIError => e
+        raise Razor::CLI::InvalidURIError.new(url, source)
+      end
+    end
   end
 end

data/lib/razor/cli.rb

@@ -12,6 +12,20 @@ module Razor
         end
       end
     end
+
+    class InvalidURIError < Error
+      def initialize(url, type)
+        case type
+        when :env
+          super "URL '#{url}' in ENV variable RAZOR_API is not valid"
+        when :opts
+          super "URL '#{url}' provided by -U or --url is not valid"
+        else
+          super "URL '#{url}' is not valid"
+        end
+      end
+    end
+
   end
 end
 

data/razor-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "razor-client"
+  spec.version       = "0.11.0"
+  spec.authors       = ["Puppet Labs"]
+  spec.email         = ["info@puppetlabs.com"]
+  spec.description   = "The client for the Razor server"
+  spec.summary       = "The client for everybody's favorite provisioning tool"
+  spec.homepage      = "https://github.com/puppetlabs/razor-client"
+  spec.license       = "ASL2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.bindir        = "bin"
+  spec.executables   = ['razor']
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "terminal-table"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/cli/parse_spec.rb

@@ -1,3 +1,4 @@
+require "rspec/expectations"
 require_relative '../spec_helper'
 
 describe Razor::CLI::Parse do
@@ -24,6 +25,30 @@ describe Razor::CLI::Parse do
         url = 'http://razor.example.com:2150/path/to/api'
         parse('-U',url).api_url.to_s.should == url
       end
+
+      it "should terminate with an error if an invalid URL is provided" do
+        expect{parse('-U','not valid url')}.to raise_error(Razor::CLI::InvalidURIError)
+      end
+    end
+
+    context "with ENV RAZOR_API set" do
+      it "should use the given URL" do
+        url = 'http://razor.example.com:2150/env/path/to/api'
+        ENV["RAZOR_API"] = url
+        parse.api_url.to_s.should == url
+      end
+
+      it "should use -U before ENV" do
+        env_url = 'http://razor.example.com:2150/env/path/to/api'
+        url = 'http://razor.example.com:2150/path/to/api'
+        ENV["RAZOR_API"] = env_url
+        parse('-U',url).api_url.to_s.should == url
+      end
+
+      it "should terminate with an error if an invalid URL is provided" do
+        ENV["RAZOR_API"] = 'not valid url'
+        expect{parse}.to raise_error(Razor::CLI::InvalidURIError)
+      end
     end
 
     describe "#help", :vcr do

data/spec/spec_helper.rb

@@ -30,4 +30,7 @@ end
 # Record one cassette for each test
 RSpec.configure do |c|
   c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.before(:each) do
+    ENV::delete('RAZOR_API')
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: razor-client
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
-- David Lutterkort
+- Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
 description: The client for the Razor server
 email:
-- lutter@watzmann.net
+- info@puppetlabs.com
 executables:
 - razor
 extensions: []
@@ -95,7 +95,9 @@ files:
 - lib/razor/cli.rb
 - lib/razor/cli/format.rb
 - lib/razor/cli/navigate.rb
+- lib/razor/cli/navigate.yaml
 - lib/razor/cli/parse.rb
+- razor-client.gemspec
 - spec/cli/navigate_spec.rb
 - spec/cli/parse_spec.rb
 - spec/fixtures/vcr/Razor_CLI_Navigate/with_a_single_item_path/.yml
@@ -129,7 +131,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: The client for everyvody's favorite provisioning tool
+summary: The client for everybody's favorite provisioning tool
 test_files:
 - spec/cli/navigate_spec.rb
 - spec/cli/parse_spec.rb