orchestrator_client 0.3.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 544692bcfb8a25aa745a2b8b6d04bb3dfc5d9aea
-  data.tar.gz: 3d478262f860e470b6a759fb898b1f049bb268c8
+SHA256:
+  metadata.gz: b485d794a3db932e0582b9fdfd1f39af599f47d49d1cbcb931804a245771859b
+  data.tar.gz: 5a43d5c16087089270575d5dae0bce64cd46e96040b7607c2b94afe1274dc7d9
 SHA512:
-  metadata.gz: 0b9ebba6fd6d909f0c85e7ee3b18b74a32cf338f3fc493732024accc045c56d21cc0aac648ad51adaf14d3de7ee0023d851525cff4f42da9ef5a333a871f848b
-  data.tar.gz: 2b2e156ad03c89a559c34df15be723bb0e0d69021ed0721737fbfce857524d3ddc6ce22d2d0f29a616adcee85614d5416bc0ea86b6b87aa8e7bbde2498ce7060
+  metadata.gz: 3e33456162bfbf5dfde8c2e26f79cd4ffb2955bd6e9b55b7a5b98eaf5324c573499148e4bd82903d807cc0f79ba638b42427a1123e9b27514870e37f90121593
+  data.tar.gz: 8951b80de1cf8febf203fea0272e25db095ba1844e59e6e5b904cbecb28ab6942a8e5291988eff8f2ac3b5c7297cd7c7f524c7cafede419905180dc3da3ac06f

data/.github/workflows/spec.yaml

@@ -0,0 +1,23 @@
+name: Spec tests
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+
+  spec:
+    name: Spec test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7 
+          bundler-cache: true
+      - name: Update gems
+        run: bundle update
+      - name: Run tests
+        run: bundle exec rspec

data/CODEOWNERS

@@ -0,0 +1,2 @@
+# Default to Bolt team
+* @puppetlabs/bolt

data/Gemfile

@@ -9,4 +9,6 @@ end
 
 group :development do
   gem 'pry'
+  gem 'pry-stack_explorer'
+  gem 'pry-byebug'
 end

data/README.md

@@ -5,7 +5,8 @@ A simple client for interacting with the Orchestration Services API in Puppet En
 
 ## Compatibility
 
-Currently, this client supports the "V1" endpoints shipped as part of Puppet Enterprise 2016.2.
+Currently, this client supports the "V1" endpoints shipped as part of Puppet Enterprise 2016.2 -
+2019.8.4.
 
 ## Installation
 
@@ -26,6 +27,9 @@ expected to be at `~/.puppetlabs/token` which is the default location used by
 * `token-file`- Path to a file with the RBAC token in it (defaults to `~/.puppetlabs/token`)
 * `token` - Pass directly the RBAC token, if specified the token will be used instead of a token from file.
 * `User-Agent`- Set `User-Agent` header for HTTP requests. Defaults to `OrchestratorRubyClient/[VERSION]`
+* `job-poll-interval`- Set the default amount of time to sleep when polling in Orchestrator::Job#wait and #each\_event
+* `job-poll-timeout`- Set the default maximum amount of time to wait in Orchestrator::Job#wait
+* `read-timeout` - The time to wait before raising a Timeout exception when making HTTP requests.
 
 ### Example
 
@@ -67,9 +71,13 @@ issues](https://github.com/puppetlabs/orchestrator_api-ruby/issues).
 If you are interested in contributing to this project, please see the
 [Contribution Guidelines](CONTRIBUTING.md)
 
-## Authors
+## Releasing
 
-Tom Linkin <tom@puppet.com>
+Use the
+https://cinext-jenkinsmaster-sre-prod-1.delivery.puppetlabs.net/job/qe_orchestrator-client-ruby_init-multijob_master/
+job to release. This pipeline will update the [version file](lib/orchestrator_client/version.rb),
+create the tag you specify, and push release [to
+rubygems](https://rubygems.org/gems/orchestrator_client).
 
 ## License
 

data/lib/orchestrator_client.rb

@@ -2,6 +2,7 @@ require 'net/https'
 require 'uri'
 require 'json'
 require 'openssl'
+require 'faraday'
 
 class OrchestratorClient
   require 'orchestrator_client/error'
@@ -11,35 +12,37 @@ class OrchestratorClient
   require 'orchestrator_client/config'
 
   attr_accessor :config
+  attr_reader :http
 
   def initialize(overrides, load_files=false)
     @config = Config.new(overrides, load_files)
     @config.validate
+    @http = create_http(config.root_url)
   end
 
-  def make_uri(path)
-    URI.parse("#{config.root_url}#{path}")
-  end
-
-  def create_http(uri)
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true
-    http.ssl_version = :TLSv1_2
-    http.ca_file = config['cacert']
-    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-    http
+  def create_http(root_url)
+    Faraday.new(url: root_url) do |f|
+      f.headers['Content-Type'] = 'application/json'
+      f.headers['X-Authentication'] = config.token
+      f.headers['User-Agent'] = config['User-Agent']
+      f.ssl['ca_file'] = config['cacert']
+      f.ssl['version'] = :TLSv1_2
+      # Do not use net-http-persistent on windows
+      if !!File::ALT_SEPARATOR
+        f.adapter :net_http
+      else
+        f.adapter :net_http_persistent, pool_size: 5 do |http|
+          http.idle_timeout = 30
+          http.read_timeout = config['read-timeout'] if config['read-timeout']
+        end
+      end
+    end
   end
 
   def get(location)
-    uri = make_uri(location)
-    https = create_http(uri)
-    req = Net::HTTP::Get.new(uri)
-    req['Content-Type'] = "application/json"
-    req['User-Agent'] = @config['User-Agent']
-    req.add_field('X-Authentication', @config.token)
-    res = https.request(req)
+    res = http.get(location)
 
-    if res.code != "200"
+    if res.status != 200
       raise OrchestratorClient::ApiError.make_error_from_response(res)
     end
 
@@ -47,17 +50,9 @@ class OrchestratorClient
   end
 
   def post(location, body)
-    uri = make_uri(location)
-    https = create_http(uri)
-
-    req = Net::HTTP::Post.new(uri)
-    req['Content-Type'] = "application/json"
-    req['User-Agent'] = @config['User-Agent']
-    req.add_field('X-Authentication', @config.token)
-    req.body = body.to_json
-    res = https.request(req)
+    res = http.post(location, body.to_json)
 
-    unless Set.new(["202", "200"]).include? res.code
+    unless Set.new([202, 200]).include? res.status
       raise OrchestratorClient::ApiError.make_error_from_response(res)
     end
 

data/lib/orchestrator_client/config.rb

@@ -35,7 +35,9 @@ class OrchestratorClient::Config
   def defaults
     { 'cacert' => cacert,
       'token-file' => File.join(user_root, 'token'),
-      'User-Agent' => "OrchestratorRubyClient/#{OrchestratorClient::VERSION}"
+      'User-Agent' => "OrchestratorRubyClient/#{OrchestratorClient::VERSION}",
+      'job-poll-interval' => 1,
+      'job-poll-timeout' => 1000,
     }
   end
 
@@ -53,7 +55,12 @@ class OrchestratorClient::Config
       end
     end
 
-    config.merge(@overrides)
+    config.merge!(@overrides)
+
+    %w[token-file cacert].each do |f|
+      config[f] = File.expand_path(config[f]) if config[f]
+    end
+    config
   end
 
   def validate
@@ -61,9 +68,20 @@ class OrchestratorClient::Config
       raise OrchestratorClient::ConfigError.new("'service-url' is required in config")
     end
 
+    begin
+      service_url = URI.parse(config['service-url'])
+      unless service_url.kind_of?(URI::HTTP) || service_url.kind_of?(URI::HTTPS)
+        raise OrchestratorClient::ConfigError.new("'#{config['service-url']}' is an invalid service-url")
+      end
+    rescue URI::InvalidURIError
+      raise OrchestratorClient::ConfigError.new("'#{config['service-url']}' is an invalid service-url")
+    end
+
     if config['cacert'].nil?
       raise  OrchestratorClient::ConfigError.new("'cacert' is required in config")
     end
+
+    validate_file('cacert', config['cacert'])
   end
 
   def config
@@ -75,7 +93,18 @@ class OrchestratorClient::Config
   end
 
   def load_token
-    @config['token'] || File.open(config['token-file']) { |f| f.read.strip }
+    if @config['token']
+      @config['token']
+    else
+      validate_file('token-file', config['token-file'])
+      token = File.open(config['token-file']) { |f| f.read.strip }
+      # If the token file contains illegal characters
+      if token =~ URI::UNSAFE
+        raise OrchestratorClient::ConfigError.new("token-file '#{config['token-file']}' contains illegal characters")
+      end
+      @config['token'] = token
+      @config['token']
+    end
   end
 
   def token
@@ -95,4 +124,15 @@ class OrchestratorClient::Config
   def [](key)
     @config[key]
   end
+
+  def validate_file(type, path)
+    stat = File.stat(path)
+    if !stat.readable?
+      OrchestratorClient::ConfigError.new("#{type} '#{path}' is unreadable")
+    elsif !stat.file?
+      OrchestratorClient::ConfigError.new("#{type} '#{path}' is not a file")
+    end
+  rescue Errno::ENOENT
+    raise OrchestratorClient::ConfigError.new("#{type} '#{path}' does not exist")
+  end
 end

data/lib/orchestrator_client/error.rb

@@ -17,7 +17,7 @@ class OrchestratorClient::ApiError < RuntimeError
     rescue
       return OrchestratorClient::BadResponse.new("Response body was not valid JSON: #{res.body}")
     end
-    code = res.code
+    code = res.status
 
     case data['kind']
     when 'puppetlabs.validators/validation-error'

data/lib/orchestrator_client/job.rb

@@ -16,6 +16,8 @@ class OrchestratorClient::Job
 
   def initialize(client, options = {}, type=:deploy)
     @client = client
+    @poll_interval = options.delete(:_poll_interval) || client.config['job-poll-interval']
+    @poll_timeout = options.delete(:_poll_timeout) || client.config['job-poll-timeout']
     @options = options
     @type = type
   end
@@ -71,7 +73,7 @@ class OrchestratorClient::Job
       events = @client.jobs.events(@job_name)
       start = events['next-events']['event']
       if events['items'].empty?
-        sleep 1
+        sleep @poll_interval
       else
         events['items'].each do |event|
           finished = true if DONE_EVENTS.include?(event['type'])
@@ -81,15 +83,15 @@ class OrchestratorClient::Job
     end
   end
 
-  def wait(timeout=1000)
+  def wait(timeout=@poll_timeout)
     counter = 0
     while counter < timeout
       get_details
       if DONE_STATES.include?(details['state'])
         return report
       end
-      sleep 1
-      counter += 1
+      sleep @poll_interval
+      counter += @poll_interval
     end
   end
 end

data/lib/orchestrator_client/version.rb

@@ -1,3 +1,3 @@
 class OrchestratorClient
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.5.2'.freeze
 end

data/orchestrator_client.gemspec

@@ -14,4 +14,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/puppetlabs/orchestrator_client-ruby'
   s.license       = "Apache-2.0"
   s.require_paths = ["lib"]
+
+  s.add_dependency 'faraday'
+  s.add_dependency 'net-http-persistent'
 end

metadata

@@ -1,22 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: orchestrator_client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
-dependencies: []
+date: 2021-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: info@puppetlabs.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/spec.yaml"
 - ".gitignore"
+- CODEOWNERS
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -48,8 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Simple Ruby client library for PE Orchestration Services