pe-razor-client 0.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56d3c2b6b7151fc0b1e41bc7b6761b9e7bc46b04
+  data.tar.gz: 28c812344e73fefc6a6634c9688e302afefaa716
+SHA512:
+  metadata.gz: 8261b52410c1685770bb406d68698d541c1e986c6b249b21d9cbda8255763a130de0808f21e021228388978482cf9b3c1da6fdf6c226edaf5ce2b4697e49ab34
+  data.tar.gz: 37f1d1535ddcb8d12a405548912dbfcec7a1cdea73b39d39e1df0310ee181ef706e4b08420f4159c1d5f7fa516514d54514c92bc753b7c2d72fd1aff2558b20c

data/.gitignore

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

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile

@@ -0,0 +1,35 @@
+source 'https://rubygems.org'
+
+# mime-types is a dependency of rest-client. We need to explicitly depend
+# on it and pin its version to make sure this works with Ruby 1.8.7
+gem 'mime-types', '< 2.0'
+gem 'rest-client'
+gem 'terminal-table'
+
+group :doc do
+  gem 'yard'
+  gem 'kramdown'
+end
+
+# This group will be excluded by default in `torquebox archive`
+group :test do
+  gem 'rack-test'
+  gem 'rspec', '~> 2.13.0'
+  gem 'rspec-core', '~> 2.13.1'
+  gem 'rspec-expectations', '~> 2.13.0'
+  gem 'rspec-mocks', '~> 2.13.1'
+  gem 'simplecov'
+  gem 'webmock'
+  gem 'vcr'
+end
+
+group :development do
+  gem 'rake'
+end
+
+# This allows you to create `Gemfile.local` and have it loaded automatically;
+# the purpose of this is to allow you to put additional development gems
+# somewhere convenient without having to constantly mess with this file.
+#
+# Gemfile.local is in the .gitignore file; do not check one in!
+eval(File.read(File.dirname(__FILE__) + '/Gemfile.local'), binding) rescue nil

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.3)
+    crack (0.3.2)
+    diff-lcs (1.2.4)
+    kramdown (1.1.0)
+    mime-types (1.24)
+    multi_json (1.7.9)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    terminal-table (1.4.5)
+    vcr (2.5.0)
+    webmock (1.9.3)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    yard (0.8.7)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  kramdown
+  mime-types (< 2.0)
+  rack-test
+  rake
+  rest-client
+  rspec (~> 2.13.0)
+  rspec-core (~> 2.13.1)
+  rspec-expectations (~> 2.13.0)
+  rspec-mocks (~> 2.13.1)
+  simplecov
+  terminal-table
+  vcr
+  webmock
+  yard

data/LICENSE

@@ -0,0 +1,15 @@
+Razor
+
+Copyright 2013, 2014 Puppet Labs Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,23 @@
+# Razor client
+
+This code is still in development mode; that means that we might make
+backwards incompatible changes, especially to the database schema which
+would force you to rebuild all the machines that Razor is managing. Razor
+will become stable RSN.
+
+This is the command line client for the [Razor
+server](https://github.com/puppetlabs/razor-server) Please have a look at
+the Wiki over there for details, in particular, the [Getting
+Started](https://github.com/puppetlabs/razor-server/wiki/Getting-started)
+page contains instructions about installation and setup of the client.
+
+## Getting in touch
+
+* bug/issue tracker: [RAZOR project in JIRA](https://tickets.puppetlabs.com/browse/RAZOR)
+* on IRC: `#puppet-razor` on [freenode](http://freenode.net/)
+* mailing list: [puppet-razor@googlegroups.com](http://groups.google.com/group/puppet-razor)
+
+## License
+
+Razor is distributed under the Apache 2.0 license.
+See [the LICENSE file](LICENSE) for full details.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require "bundler/gem_tasks"
+
+# Needed to make the client work on Ruby 1.8.7
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+require_relative 'spec/vcr_library'
+
+namespace :bundler do
+  task :setup do
+    require 'bundler/setup'
+  end
+end
+
+namespace :spec do
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+
+  desc <<EOS
+Run all specs. Set VCR_RECORD to 'all' to rerecord and to 'new_episodes'
+to record new tests. Tapes are in #{VCR_LIBRARY}
+EOS
+  RSpec::Core::RakeTask.new(:all => :"bundler:setup") do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+end
+
+desc "Erase all VCR recordings"
+task :"vcr:erase" do
+  erase_vcr_library
+end

data/bin/razor

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+# Needed to make the client work on Ruby 1.8.7
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+require 'rubygems'
+require_relative "../lib/razor/cli"
+
+include Razor::CLI::Format
+
+def die(message = nil)
+  puts "Error: #{message}" if message
+  exit 1
+end
+
+begin
+  parse = Razor::CLI::Parse.new(ARGV)
+rescue Razor::CLI::InvalidURIError => e
+  die e.message
+rescue OptionParser::InvalidOption => e
+  die e.message + "\nTry 'razor --help' for more information"
+end
+
+if parse.show_help?
+  puts parse.help
+  exit 0
+end
+
+begin
+  document = parse.navigate.get_document
+  url = parse.navigate.last_url
+  puts "From #{url}:\n\n#{format_document document}\n\n"
+rescue Razor::CLI::Error => e
+  die "#{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"
+  die
+rescue RestClient::Exception => e
+  r = e.response
+  puts "Error from doing #{r.args[:method].to_s.upcase} #{r.args[:url]}"
+  puts e.message
+  begin
+    body = MultiJson::load(r.body)
+    puts body.delete("details") if body["details"]
+    unless body.empty?
+      puts format_document(body)
+    end
+  rescue => e
+    # Ignore errors here; our best efforts at telling the user more about
+    # what happened has failed. Just dump the response
+    puts r.body
+  end
+  die
+end

data/lib/razor.rb

@@ -0,0 +1 @@
+require_relative 'razor/cli'

data/lib/razor/cli.rb

@@ -0,0 +1,34 @@
+module Razor
+  module CLI
+    class Error < RuntimeError; end
+
+    class NavigationError < Error
+      def initialize(url, key, doc)
+        @key = key; @doc = doc
+        if key.is_a?(Array)
+          super "Could not navigate to '#{key.join(" ")}' from #{url}"
+        else
+          super "Could not find entry '#{key}' in document at #{url}"
+        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
+
+require_relative 'cli/navigate'
+require_relative 'cli/parse'
+require_relative 'cli/format'

data/lib/razor/cli/format.rb

@@ -0,0 +1,76 @@
+require 'terminal-table'
+
+module Razor::CLI
+  module Format
+    PriorityKeys = %w[ id name ]
+    SpecNames = {
+      "/spec/object/policy" => "Policy",
+      "/spec/object/tag" => "Tag",
+      "/spec/object/reference" => "reference"
+    }
+
+    def self.spec_name(spec)
+      path = spec && URI.parse(spec).path
+      SpecNames[path] || path
+    rescue => e
+      spec
+    end
+
+    def format_document(doc)
+      case doc
+      when Array then format_objects(doc)
+      when Hash then format_object(doc)
+      else doc.to_s
+      end.chomp
+    end
+
+    # We assume that all collections are homogenous
+    def format_objects(objects, indent = 0)
+      objects.map do |obj|
+        obj.is_a?(Hash) ? format_object(obj, indent) : ' '*indent + obj.inspect
+      end.join "\n\n"
+    end
+
+    def format_reference_object(ref, indent = 0)
+      output = ' '* indent + "#{ref['name']} => #{ref['id'].to_s.ljust 4}"
+    end
+
+
+    def format_object(object, indent = 0)
+      if object.keys == ["id", "name"]
+        format_reference_object(object, indent)
+      else
+        format_default_object(object, indent)
+      end
+    end
+
+    def format_default_object(object, indent = 0 )
+      fields = (PriorityKeys & object.keys) + (object.keys - PriorityKeys)
+      key_indent = indent + fields.map {|f| f.length}.max
+      output = ""
+      fields.map do |f|
+        value = object[f]
+        output = "#{f.rjust key_indent + 2}: "
+        output << case value
+        when Hash
+          if value.empty?
+            "{}"
+          else
+            "\n" + format_object(value, key_indent + 4).rstrip
+          end
+        when Array
+           if value.all? { |v| v.is_a?(String) }
+             "[" + value.map(&:inspect).join(",") + "]"
+           else
+             "[\n" + format_objects(value, key_indent + 6) + ("\n"+' '*(key_indent+4)+"]")
+           end
+        else
+          case f
+          when "spec" then "\"#{Format.spec_name(value)}\""
+          else value.inspect
+          end
+        end
+      end.join "\n"
+    end
+  end
+end

data/lib/razor/cli/navigate.rb

@@ -0,0 +1,177 @@
+require 'rest-client'
+require 'multi_json'
+require 'yaml'
+
+module Razor::CLI
+  class Navigate
+
+    def initialize(parse, segments)
+      @parse = parse
+      @segments = segments||[]
+      @doc = entrypoint
+      @doc_url = parse.api_url
+    end
+
+    def last_url
+      @doc_url
+    end
+
+    def entrypoint
+      @entrypoint ||= json_get(@parse.api_url)
+    end
+
+    def collections
+      entrypoint["collections"]
+    end
+
+    def commands
+      entrypoint["commands"]
+    end
+
+    def query?
+      collections.any? { |coll| coll["name"] == @segments.first }
+    end
+
+    def command(name)
+      commands.find { |coll| coll["name"] == name }
+    end
+
+    def command?
+      !! command(@segments.first)
+    end
+
+    def get_document
+      if @segments.empty?
+        entrypoint
+      elsif query?
+        @doc = collections
+        while @segments.any?
+          move_to @segments.shift
+        end
+        @doc
+      elsif command?
+        # @todo lutter 2013-08-16: None of this has any tests, and error
+        # handling is heinous at best
+        cmd, body = extract_command
+        if body.empty?
+          raise Razor::CLI::Error,
+            "No arguments for command (did you forget --json ?)"
+        end
+        # Ensure that we copy authentication data from our previous URL.
+        url = cmd["id"]
+        if @doc_url
+          url          = URI.parse(url.to_s)
+          url.userinfo = @doc_url.userinfo
+        end
+
+        json_post(url, body)
+      else
+        raise NavigationError.new(@doc_url, @segments, @doc)
+      end
+    end
+
+    def extract_command
+      cmd = command(@segments.shift)
+      body = {}
+      until @segments.empty?
+        if @segments.shift =~ /\A--([a-z-]+)(=(\S+))?\Z/
+          arg, value = [$1, $3]
+          value = @segments.shift if value.nil? && @segments[0] !~ /^--/
+          body[arg] = convert_arg(cmd["name"], arg, value)
+        end
+      end
+
+      begin
+        body = MultiJson::load(File::read(body["json"])) if body["json"]
+      rescue MultiJson::LoadError
+        raise Razor::CLI::Error, "File #{body["json"]} is not valid JSON"
+      rescue Errno::ENOENT
+        raise Razor::CLI::Error, "File #{body["json"]} not found"
+      rescue Errno::EACCES
+        raise Razor::CLI::Error,
+          "Permission to read file #{body["json"]} denied"
+      end
+      [cmd, body]
+    end
+
+    def move_to(key)
+      key = key.to_i if key.to_i.to_s == key
+      if @doc.is_a? Array
+        obj = @doc.find {|x| x.is_a?(Hash) and x["name"] == key }
+      elsif @doc.is_a? Hash
+        obj = @doc[key]
+      end
+
+      raise NavigationError.new(@doc_url, key, @doc) unless obj
+
+      if obj.is_a?(Hash) && obj["id"]
+        url = obj["id"]
+        if @doc_url
+          url          = URI.parse(url.to_s)
+          url.userinfo = @doc_url.userinfo
+        end
+
+        @doc = json_get(url)
+        # strip the wrapper around collections
+        if @doc.is_a? Hash and @doc["items"].is_a? Array
+          @doc = @doc["items"]
+        end
+        @doc_url = url
+      elsif obj.is_a? Hash
+        @doc = obj
+      else
+        @doc = nil
+      end
+    end
+
+    def get(url, headers={})
+      response = RestClient.get url.to_s, headers
+      print "GET #{url.to_s}\n#{response.body}\n\n" if @parse.dump_response?
+      response
+    end
+
+    def json_get(url, headers = {})
+      response = get(url,headers.merge(:accept => :json))
+      unless response.headers[:content_type] =~ /application\/json/
+       raise "Received content type #{response.headers[:content_type]}"
+      end
+      MultiJson.load(response.body)
+    end
+
+    def json_post(url, body)
+      headers = {  :accept=>:json, "Content-Type" => :json }
+      begin
+        response = RestClient.post url.to_s, MultiJson::dump(body), headers
+      ensure
+        if @parse.dump_response?
+          print "POST #{url.to_s}\n#{body}\n-->\n"
+          puts (response ? response.body : "ERROR")
+        end
+      end
+      MultiJson::load(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)
+      value = nil if value == "null"
+      case self.class.arg_type(cmd_name, arg_name)
+        when "json"
+          MultiJson::load(value)
+        when "boolean"
+          ["true", nil].include?(value)
+        else
+          value
+      end
+    end
+  end
+end