razor-client 1.9.1 → 1.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f4aba07bc09d83bcbce351964a713117efb1bca2
-  data.tar.gz: 1db80933d091c04c2048cbb8a543e919f9ced02c
+SHA256:
+  metadata.gz: 7240c2a4e68fab8d04ae7084b400d7a7bd472858c2190b3dca337577e5aa5cf7
+  data.tar.gz: 3f3b980e70b2d2de30f8fb49f4b8a34ad6ac67daf4e76b2d944250b1dd09894c
 SHA512:
-  metadata.gz: 5b9225d18b7414792a628ec7017bb62c9ef417369d92293b00627913a41a3760019ec4378dfeb2642fd45058733e9881a6d21db0736373929eb84bb0b51dd4d9
-  data.tar.gz: 710838e176dd8b9d8e58159e505df289071ce792d5e8bb64c311be3cb26d3ed1041a0ee15ecd1cb7700039f6415fec6d10055119702670c98b952efc4774dec4
+  metadata.gz: cf8b0cf692487781a22c34b2df625ad729a39fc283fb3cc3b6abd0beefec6d8392b1d10a33eeae05d94f21677ea5cf36f9755fc6365d1ca38862fbadad7b7a9c
+  data.tar.gz: 5c56d03d1161b3c9d74c66b9ddb82123e072e24cebd7e42f703d579cc13d1e696f40d259670b673773ffb1b234fb76a38876528bdb7a6642199a61331a6a013e

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Gem release
+
+on:
+  push:
+    branches:
+      - refs/tags/*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Build gem
+        uses: scarhand/actions-ruby@master
+        with:
+          args: build *.gemspec
+      - name: Publish gem
+        uses: scarhand/actions-ruby@master
+        env:
+          RUBYGEMS_AUTH_TOKEN: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}
+        with:
+          args: push *.gem
+

data/.gitignore

@@ -0,0 +1,9 @@
+log/*
+pkg/
+/config.yaml
+/.yardoc
+/Gemfile.local*
+/coverage
+/.project
+/ext/packaging/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script: "bundle exec rspec spec"
+notifications:
+  email: false

data/.yardopts

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

data/CODEOWNERS

@@ -0,0 +1 @@
+* @puppetlabs/razor-maintainers

data/Gemfile

@@ -0,0 +1,42 @@
+source 'https://rubygems.org'
+
+gemspec
+
+def location_for(place, fake_version = nil)
+  if place =~ /^(git[:@][^#]*)#(.*)/
+    [fake_version, { :git => $1, :branch => $2, :require => false }].compact
+  elsif place =~ /^file:\/\/(.*)/
+    ['>= 0', { :path => File.expand_path($1), :require => false }]
+  else
+    [place, { :require => false }]
+  end
+end
+
+group :packaging do
+  gem 'packaging', *location_for(ENV['PACKAGING_LOCATION'] || '~> 0.99')
+end
+
+group :doc do
+  gem 'yard'
+  gem 'kramdown'
+end
+
+# This group will be excluded by default in `torquebox archive`
+group :test do
+  gem 'public_suffix', '~> 1.4.6'
+  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', '~> 3.3.0'
+  gem 'vcr', '~> 4.0.0'
+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/NEWS.md

@@ -1,5 +1,29 @@
 # Razor Client Release Notes
 
+## 1.9.4 - 2019-08-26
+
+* IMPROVEMENT: Moved from `rest-client` to `faraday` due to increasing
+  dependency issues with `rest-client`. 
+
+## 1.9.3 - 2019-08-19 (yanked)
+
+* BUGFIX: The `unf` gem dependency referenced a prerelease version of a gem.
+  Rather than force the use of `--pre` when installing the gem, we will pin
+  back to the released version, which requires GCC to build native extensions.
+
+## 1.9.2 - 2019-08-14 (yanked)
+
+* BUGFIX: Fixed error output when number or null datatypes are invalid.
+* IMPROVEMENT: Now exits with status code 1 if login credentials are missing.
+* IMPROVEMENT: Updated gem dependencies.
+* IMPROVEMENT: Better error handling for REST exceptions returned from the
+  Razor server.
+* IMPROVEMENT: Removed Gemfile.lock from repository. This broadens the spectrum
+  of which gems can be used as dependencies for this gem. This is especially
+  useful for gem dependencies that become outdated or obsolete.
+* BUGFIX: Pinned a version of the `gettext-setup` gem which caused an error if
+  the version was too old.
+
 ## 1.9.1 - 2018-06-07
 
 * NEW: Use the server's `depth` parameter if it is supported. This will

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rake'
+require 'yaml'
+
+# 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
+
+if defined?(RSpec::Core::RakeTask)
+  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
+end
+
+desc "Erase all VCR recordings"
+task :"vcr:erase" do
+  erase_vcr_library
+end
+
+##############################################################################
+# Support for our internal packaging toolchain.  Most people outside of Puppet
+# Labs will never actually need to deal with these.
+begin
+  require 'packaging'
+  Pkg::Util::RakeUtils.load_packaging_tasks
+rescue LoadError => e
+  puts "Error loading packaging rake tasks: #{e}"
+end
+
+# Kept for backwards compatibility
+namespace :package do
+  desc "Bootstrap packaging automation, e.g. clone into packaging repo"
+  task :bootstrap do
+    puts 'Bootstrap is no longer needed, using packaging-as-a-gem'
+  end
+
+  desc "Remove all cloned packaging automation"
+  task :implode do
+    puts 'Implode is no longer needed, using packaging-as-a-gem'
+  end
+end
+
+begin
+  spec = Gem::Specification.find_by_name 'gettext-setup'
+  load "#{spec.gem_dir}/lib/tasks/gettext.rake"
+  GettextSetup.initialize(File.absolute_path('locales', File.dirname(__FILE__)))
+rescue LoadError
+end

data/bin/razor

@@ -32,8 +32,6 @@ end
 begin
   parse = Razor::CLI::Parse.new(ARGV)
 
-  navigate = parse.navigate
-
   if parse.show_version?
     version, exit_code = parse.version
     puts version
@@ -46,34 +44,33 @@ begin
     exit exitcode
   end
 
+  navigate = parse.navigate
+
   document = navigate.get_document
   url = parse.navigate.last_url
   result = format_document document, parse
   # TRANSLATORS: This is a template for all results that the client outputs.
   puts _("From %{url}:\n\n%{result}\n\n") % {url: url, result: result}
-rescue Razor::CLI::InvalidURIError => e
-  die e.message
-rescue RestClient::Unauthorized
-  puts _(<<-UNAUTH) % {url: url}
-Error: Credentials are required to connect to the server at %{url}"
-  UNAUTH
+rescue Razor::CLI::InvalidURIError, Razor::CLI::UnauthorizedError => e
+  puts e.message
+  die
 rescue OptionParser::InvalidOption => e
   # TRANSLATORS: This occurs when invalid flags are passed in the navigation.
   die _("%{error}\nTry 'razor --help' for more information") %
       {error: e.message}
-rescue SocketError, Errno::ECONNREFUSED => e
+rescue SocketError, Faraday::ConnectionFailed => e
   puts _("Error: Could not connect to the server at %{url}\n" +
          "       %{error}") % {url: parse.api_url, error: e}
   die
-rescue RestClient::SSLCertificateNotVerified
+rescue Faraday::SSLError
   puts _("Error: SSL certificate could not be verified against known CA " +
          "certificates.\n       To turn off verification, use the -k or --insecure option.")
   die
-rescue RestClient::Exception => e
+rescue Faraday::Error => e
   r = e.response
   unexpected_error(e) if r.nil?
-  request_type = r.args[:method].to_s.upcase
-  url = r.args[:url]
+  request_type = r.request.method.to_s.upcase
+  url = r.request.url
   puts _("Error from doing %{request_type} %{url}") % {request_type: request_type, url: url}
   puts e.message
   begin

data/ext/build_defaults.yaml

@@ -0,0 +1,20 @@
+---
+packaging_url: 'git://github.com/puppetlabs/packaging.git --branch=1.0.x'
+packaging_repo: 'packaging'
+default_cow: ''
+cows: ''
+pbuild_conf: '/etc/pbuilderrc'
+packager: 'puppet'
+gpg_name: 'release@puppet.com'
+gpg_key: '7F438280EF8D349F'
+sign_tar: FALSE
+# a space separated list of mock configs
+final_mocks: ''
+yum_host: 'yum.puppetlabs.com'
+build_gem: TRUE
+build_dmg: FALSE
+build_ips: FALSE
+build_pe:  FALSE
+apt_host: 'apt.puppetlabs.com'
+apt_repo_url: 'http://apt.puppetlabs.com'
+tar_host: 'downloads.puppetlabs.com'

data/ext/project_data.yaml

@@ -0,0 +1,38 @@
+---
+project: 'razor-client'
+author: 'Puppet Labs'
+email: 'info@puppetlabs.com'
+homepage: 'http://puppetlabs.com/puppet/puppet-enterprise'
+summary: 'Razor is an advanced provisioning application'
+description: |
+  Razor is an advanced provisioning application which can deploy both bare-metal
+  and virtual systems. It's aimed at solving the problem of how to bring new
+  metal into a state where your existing DevOps/configuration management
+  workflows can take it over.
+
+  This provides the client application gem, used to provide CLI access and control
+  to users of razor-server.
+# automatically burn our version into the generated source
+version_file: 'lib/razor/cli/version.rb'
+update_version_file: true
+# files and gem_files are space separated lists (or arrays)
+files:
+  - 'Gemfile*'
+  - razor-client.gemspec
+  - bin
+  - lib
+  - '*.md'
+  - LICENSE
+  - locales
+gem_files: '{bin,lib,locales}/**/* *.md LICENSE'
+gem_require_path: 'lib'
+gem_test_files: 'spec/**/*'
+gem_executables: 'razor'
+gem_default_executables: 'razor'
+gem_required_ruby_version: '>= 1.9.3'
+gem_runtime_dependencies:
+  mime-types: '< 2.0'
+  multi_json:
+  faraday: '>= 0.15'
+  command_line_reporter: '> 3.0'
+  gettext-setup:

data/lib/razor/cli.rb

@@ -38,6 +38,12 @@ module Razor
       end
     end
 
+    class UnauthorizedError < Error
+      def initialize(url)
+        super _("Credentials are required to connect to the server at %{url}") % {url: url}
+      end
+    end
+
   end
 end
 

data/lib/razor/cli/command.rb

@@ -35,7 +35,7 @@ class Razor::CLI::Command
         # `--arg=value`/`--arg value`
         # `-a=value`/`-a value`
         arg_name, value = [$1, $3]
-        value = @segments.shift if value.nil? && @segments[0] !~ /^-/
+        value = @segments.shift if value.nil? && @segments[0] !~ /^-[a-z]/
         arg_name = self.class.resolve_alias(arg_name, @cmd_schema)
         body[arg_name] = self.class.convert_arg(arg_name, value, body[arg_name], @cmd_schema)
       elsif argument =~ /\A-([a-z][a-z_-]+)(=(.+))?\Z/ and
@@ -132,10 +132,10 @@ class Razor::CLI::Command
         begin
           Integer(value)
         rescue ArgumentError
-          raise ArgumentError, _("Invalid integer for argument '%{arg_name}': %{value}") % {argument_name: arg_name, value: value}
+          raise ArgumentError, _("Invalid integer for argument '%{argument_name}': %{value}") % {argument_name: arg_name, value: value}
         end
       when "null"
-        raise ArgumentError, _("Expected nothing for argument '%{arg_name}', but was: '%{value}'") %
+        raise ArgumentError, _("Expected nothing for argument '%{argument_name}', but was: '%{value}'") %
             {argument_name: arg_name, value: value} unless value.nil?
         nil
       when "string", nil # `nil` for 'might be an alias, send as-is'

data/lib/razor/cli/navigate.rb

@@ -1,4 +1,4 @@
-require 'rest-client'
+require 'faraday'
 require 'multi_json'
 require 'yaml'
 require 'forwardable'
@@ -14,8 +14,7 @@ module Razor::CLI
       @segments = segments||[]
       set_api_url!(parse)
       @doc = entrypoint
-      @doc_resource = create_resource parse.api_url, {:accept => :json,
-                                               :accept_language => accept_language}
+      @doc_resource = create_resource parse.api_url, default_headers
     end
 
     # This returns an array of two elements:
@@ -51,7 +50,7 @@ module Razor::CLI
     attr_accessor :doc_resource
 
     def last_url
-      @doc_resource
+      @doc_resource.build_url
     end
 
     def entrypoint
@@ -100,7 +99,7 @@ module Razor::CLI
         command = json_get(cmd_url)
         Razor::CLI::Command.new(@parse, self, command, @segments, cmd_url).run
       else
-        raise NavigationError.new(@doc_resource, @segments, @doc)
+        raise NavigationError.new(@doc_resource.build_url, @segments, @doc)
       end
     end
 
@@ -114,7 +113,7 @@ module Razor::CLI
         obj = @doc[key]
       end
 
-      raise NavigationError.new(@doc_resource, key, @doc) if obj.nil?
+      raise NavigationError.new(@doc_resource.build_url, key, @doc) if obj.nil?
 
       if obj.is_a?(Hash) && obj["id"]
         url = URI.parse(obj["id"])
@@ -145,6 +144,11 @@ module Razor::CLI
       @accept_language ||= GettextSetup.candidate_locales
     end
 
+    def default_headers
+      {'accept' => 'application/json',
+       'accept_language' => accept_language}
+    end
+
     def head(url, headers={})
       resource = create_resource(url, headers)
       response = resource.head
@@ -166,10 +170,12 @@ module Razor::CLI
       @username ||= url.user
       @password ||= url.password
 
-      response = get(url,headers.merge(:accept => :json,
-                                       :accept_language => accept_language))
+      response = get(url, headers.merge(default_headers))
+      if response.status == 401
+        raise UnauthorizedError.new(url)
+      end
       unless response.headers[:content_type] =~ /application\/json/
-        raise _("Received content type %{content_type}") % {content_type: response.headers[:content_type]}
+        raise _('Received content type %{content_type}') % {content_type: response.headers[:content_type]}
       end
       MultiJson.load(response.body)
     end
@@ -178,11 +184,14 @@ module Razor::CLI
       @username ||= url.user
       @password ||= url.password
 
-      headers = { :accept=>:json, "Content-Type" => :json,
-                  :accept_language => accept_language}
+      headers = {'Content-Type' => 'application/json'}.merge(default_headers)
       begin
         resource = create_resource(url, headers)
-        response = resource.post MultiJson::dump(body)
+        # `nil` here because the URL above is absolute, not relative.
+        response = resource.post nil, MultiJson::dump(body)
+        if response.status == 401
+          raise UnauthorizedError.new(url)
+        end
       ensure
         if @parse.dump_response?
           print "POST #{url.to_s}\n#{body}\n-->\n"
@@ -200,7 +209,7 @@ module Razor::CLI
       begin
         url = RAZOR_HTTPS_API
         head(URI.parse(url))
-      rescue Errno::ENOENT, Errno::ECONNREFUSED
+      rescue Errno::ENOENT, Faraday::ConnectionFailed
         false
       ensure
         print "HEAD #{url.to_s}\n\n" if @parse.dump_response?
@@ -209,13 +218,13 @@ module Razor::CLI
     end
 
     def create_resource(url, headers)
-      @doc_resource = RestClient::Resource.new(url.to_s,
+      @doc_resource = Faraday.new(url,
           :headers => headers,
-          :verify_ssl => @parse.verify_ssl?,
-          :ssl_ca_file => @parse.ssl_ca_file,
-          # Add these in case the URL above doesn't include authentication.
-          :user => @username || url.user,
-          :password => @password || url.password)
+          :ssl => {verify: @parse.verify_ssl?,
+                   ca_file: @parse.ssl_ca_file}).tap do |req|
+            # Add these in case the URL above doesn't include authentication.
+            req.basic_auth(@username || url.user, @password || url.password)
+      end
     end
   end
 end