rh_entitlement 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14e53ca7699c91fe0c9d2597071a5c091442659c
-  data.tar.gz: 3258bcdb783328e39fe18947c9b076eb2d55274a
+  metadata.gz: 4b4626c081a3b41b31db30460f3ab389cc489bd6
+  data.tar.gz: ee952e2170e9ec2fc6abd75a5d16cafea63e6131
 SHA512:
-  metadata.gz: 05193a53f441ed108f52c9a173764c0ead3dbbe4c20cdf7a77fda2a8516779b662fee423e3ded4af4b2bf4af50975ae9f58cfb25289fde76a135069f4db48236
-  data.tar.gz: c4091180aa56c139a7ab97fbb3b7696d0bacc673e7efd9ee3ada5bf6ba51607faacded042d62e0cc67055177e0e82749bee016599d7ca54543a913af3c28f7aa
+  metadata.gz: f2e0371685f5faeae6f3049ecc1e1c3931dd2550cf8185611b14cade8562b2a02d3b64ab4badca8c32a48d4e23747cec17bd44ce8e7958b9c8f78a58ccb767b0
+  data.tar.gz: c8482998f6ea3c160b146e59532599d390f2e061e6154ba762e3efc7f98a0f707b12a7008091f6bcab5c0f04d3c3388695cd40512a7638114b094f4f6e94823a

data/README.md

@@ -5,18 +5,100 @@ your RedHat entitlement certificates. This is helpful when dealing with multiple
 RH subscriptions and the requirement to figure out which certificate / which ID
 to use for what repository.
 
+It can be used as a library and ships a related CLI command.
+
 ## Installation
 
-Add to your Gemfile and run the `bundle` command to install it.
+    gem install rh_entitlement
+
+**Requires Ruby 1.9.3 or later.**
+
+## Usage
+
+### CLI command
 
-```ruby
-gem "rh_entitlement"
 ```
+usage: rh-entitlement <command> [<args>]
 
-**Requires Ruby 1.9.3 or later.**
+commands:
 
+  urls  List all repository URLs in the given certificate
+  find  Find the best certificate for a given repository URL
 
-## Usage
+urls
+----
+usage: rh-entitlement urls <cert-file>
+
+cert-file:
+  Absolute paths to an entitlement certificate file, like
+  /etc/pki/entitlement/9999999999.pem
+
+find
+----
+usage: rh-entitlement find <repo-url> [<cert-file>[ ...]]
+
+repo-url:
+  Relative repository URL, like
+  /content/beta/rhel/server/5/$releasever/$basearch/highavailability/os
+
+cert-file:
+  One or more absolute paths to entitlement certificate files. All <numeric>.pem
+  files in /etc/pki/entitlement will be used if no <cert-file> has been given
+```
+
+#### Examples
+
+##### List repository URLs
+
+Get all URLs from a specific entitlement certificate:
+
+    rh-entitlement urls /etc/pki/entitlement/9999999999.pem
+
+Sample output:
+
+```
+Type: Basic
+/content/beta/rhel/server/5/$releasever/$basearch/highavailability/debug
+/content/beta/rhel/server/5/$releasever/$basearch/highavailability/os
+/content/beta/rhel/server/5/$releasever/$basearch/highavailability/source/SRPMS
+/content/beta/rhel/server/6/$releasever/$basearch/highavailability/debug
+/content/beta/rhel/server/6/$releasever/$basearch/highavailability/os
+/content/beta/rhel/server/6/$releasever/$basearch/highavailability/source/SRPMS
+/content/beta/rhel/server/7/$basearch/highavailability/debug
+/content/beta/rhel/server/7/$basearch/highavailability/os
+/content/beta/rhel/server/7/$basearch/highavailability/source/SRPMS
+...
+```
+
+##### Certificate lookup
+
+Find the correct certificate for a specific repository URL:
+
+```sh
+rh-entitlement find-cert \
+  '/content/beta/rhel/server/6/$releasever/$basearch/highavailability/os' \
+  /etc/pki/entitlement/*.pem
+```
+
+When a matching certificate has been found, the script exits with code 0 and
+outputs the certificate path on a single line:
+
+    /etc/pki/entitlement/9999999999.pem
+
+In case there was no matching certificate, an error message is shown, exit code
+is 1:
+
+    ERROR: no certificate has been found for /content/beta/rhel/...
+
+### As a library
+
+Add `rh_entitlement` to your Gemfile and run the `bundle` command to install it:
+
+```ruby
+gem "rh_entitlement"
+```
+
+#### Sample code
 
 ```ruby
 require 'rh_entitlement'

data/bin/rh-entitlement

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+
+require 'rh_entitlement'
+
+def help_generic
+  <<-END
+usage: #{File.basename($0)} <command> [<args>]
+
+commands:
+
+  urls  List all repository URLs in the given certificate
+  find  Find the best certificate for a given repository URL
+
+urls
+----
+usage: #{File.basename($0)} urls <cert-file>
+
+cert-file:
+  Absolute paths to an entitlement certificate file, like
+  /etc/pki/entitlement/9999999999.pem
+
+find
+----
+usage: #{File.basename($0)} find <repo-url> [<cert-file>[ ...]]
+
+repo-url:
+  Relative repository URL, like
+  /content/beta/rhel/server/5/$releasever/$basearch/highavailability/os
+
+cert-file:
+  One or more absolute paths to entitlement certificate files. All <numeric>.pem
+  files in /etc/pki/entitlement will be used if no <cert-file> has been given
+  END
+end
+
+def usage_error(msg)
+  puts "ERROR: #{msg}"
+  puts
+  puts help_generic
+  exit 64
+end
+
+opts = ARGV.clone
+usage_error '<command> is required' unless opts.length > 0
+command = opts.shift
+
+case command
+when 'urls'
+  cert = RhEntitlement::Certificate.new(File.read(opts[0]))
+  puts "Type: #{cert.type}"
+  puts cert.urls.list.join("\n")
+when 'find'
+  usage_error '<repo_url> is required' unless opts.length > 0
+  repo_url = opts.shift
+  usage_error 'Invalid <repo_url>' unless repo_url.match(/^\/content\//)
+
+  if opts.length == 0
+    cert_files = Dir.glob('/etc/pki/entitlement/*.pem').grep(/\/\d+\.pem$/)
+  else
+    cert_files = opts
+  end
+
+  cert_files.each do |file|
+    cert = RhEntitlement::Certificate.new(File.read(file))
+    if cert.urls.has? repo_url
+      puts file
+      exit 0
+    end
+  end
+
+  puts "ERROR: no certificate has been found for #{repo_url}"
+  exit 1
+else
+  usage_error 'Invalid <command>'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rh_entitlement
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Thomas Gelf
@@ -13,13 +13,13 @@ dependencies: []
 description: Helper library allowing one to deal with RH entitlement certs
 email: thomas@gelf.net
 executables:
-- rh-entitlement-urls
+- rh-entitlement
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- bin/rh-entitlement-urls
+- bin/rh-entitlement
 - lib/rh_entitlement.rb
 - lib/rh_entitlement/certificate.rb
 - lib/rh_entitlement/certificate_urls.rb

data/bin/rh-entitlement-urls

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rh_entitlement'
-
-raise "USAGE: #{File.basename($0)} /path/to/certificate.pem" unless ARGV.length > 0
-cert = RhEntitlement::Certificate.new(File.read(ARGV[0]))
-puts "Type: #{cert.type}"
-puts "URLs:\n#{cert.urls.list.join("\n")}"