digicert-cli 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6218618683610f36cf7531ff3058254e8789f0db
-  data.tar.gz: 03a9eb004ebd1bbecaaeaad188a742fe67ea11c6
+  metadata.gz: 1fa2d7e5026e875023b032636e24d21a72feb173
+  data.tar.gz: ad33ef4c2e362670145debc01dff0a5e49ea1b57
 SHA512:
-  metadata.gz: d098aa0acb966e249756e911712e223af6c1da7cf0c5f5b7bb9860122dcd3fc6a7a6d68ad978188007e1b20d7a6c84e9ea50237a89d086e0cbbe302ada8367de
-  data.tar.gz: 249b3d913be8932c0b4179da676163f92e184e937c303872efb8bf107c0d26e2c947f3bf686aaded6ed37e79ce517b0b540049aa08cd833541b43186b4f7025d
+  metadata.gz: 19b637e487da602a4263d63a958638bc68f84e627096f1e33f023b06d4caba76c107bc6c52ffcb5a0d3724bc65c8b8c3b812a4927999477321f05f28adc6f435
+  data.tar.gz: b845b66a2bf1748bc457de4bc37f99be770f94cefdfc6f7656cf73b5920a0f78a19bc9e1fc94cc733d5324040ebd47378d236d22ec0bde339de9f43603ef28d4

data/README.md

@@ -12,12 +12,12 @@ certificates and etc using [Digicert Ruby Client].
 
 ## Configure
 
-We need to setup our API key before we want to use the CLI. For simplicity we
-have add an easier interface to setup the Digicert API KEY. To setup your key
-please use the following interface.
+The `CLI` commands are heavily dependent on the Digicert API. Please
+[follow the instruction here] to request an API Key from Digicert, Once you have
+your API key then you can configure it using the `config` command.
 
 ```sh
-digicert config DIGICERT_API_KEY
+$ digicert config api-key YOUR_API_KEY
 ```
 
 ## Usages
@@ -28,9 +28,9 @@ We have been trying to simplify the `CLI` with proper `help` documentation. Each
 of the `command` and `subcommand` should provide you the basic usages guide with
 the list of supported options.
 
-Normally the parent command should fire up the `help` documentation, but if it
-does not then you can explicitly call the `help` command or pass `-h` flags with
-any of the action and that should fire up the documentation. For example
+The parent command should fire up the `help` documentation, but if it does not
+then you can explicitly call the `help` command or pass `-h` flags with any of
+the command and that should fire up the documentation. For example
 
 ```sh
 $ digicert help
@@ -39,15 +39,15 @@ $ digicert help
 ```sh
 Commands:
   digicert certificate     # Manage Digicert Certificates
-  digicert config API_KEY  # Configure The CLI Client
+  digicert config          # Configure The CLI Client
   digicert csr             # Fetch/generate Certificate CSR
   digicert help [COMMAND]  # Describe available / One specific command
   digicert order           # Manage Digicert Orders
 ```
 
-The above command lists the available commands with a basic description and as
-you might have notice, it also ships with a `help` command which can be used to
-up the usages documentation for it's nested command.
+The above command lists the available commands with a basic description. As you
+might have noticed, it also ships with a `help` command which can be used to
+fire up the usages guide and options for it's nested command.
 
 ```sh
 # digicert order -h
@@ -62,16 +62,16 @@ Commands:
   digicert order reissue ORDER_ID  # Reissue digicert order
 ```
 
-Hopefully you get the idea, we will try our best to keep this guide up to date
+Hopefully you get the idea, we are trying our best to keep this guide up to date
 but whenever you need some more information please add the `-h` flags with any
-commands or subcommands and you should see what you need.
+commands or subcommands and you should see more accurate help documentation.
 
 ### Orders
 
 #### Listing Orders
 
-Listing orders is pretty simple with the CLI, once we have our API key
-configured then we can list all of our orders using the `list` interface
+The `CLI` made listing Digicert orders pretty simple, once we have our API key
+configured then we can list all of our orders using the `order list` command.
 
 ```sh
 $ digicert order list
@@ -87,31 +87,30 @@ $ digicert order list
 +---------------+---------------+------------------+-------------+-------------+
 ```
 
-The above interface without any option will list out all of the orders we have
-with Digicert, but sometime we might need to filter those listings, and that's
-where can can use the filter options. This interface supports filter options
-through the `--filter` option and expect the value to be in `key:value` format.
+The above command without any option will list out all of our Digicert orders,
+but if we need to filter those orders then we can do that by passing `--filter`
+option and the expected values as in `key:value` pair.
 
-For example, if we want to retrieve all of the orders that has product type of
-`ssl_wildcard` then we can use
+For example, to list all of the orders that has product type of `ssl_wildcard`
+we can use the following and it will list only the filtered orders.
 
 ```sh
 $ digicert order list --filter 'product_name_id:ssl_wildcard'
 ```
 
-It will only list the orders with the `ssl_wildcard` product type, Currently the
-supported filters options are `date_created`, `valid_till`, `status`, `search`,
-`common_name` and `product_name_id`. Please [check the wiki] for more up to date
-supported filtering options.
+Supported filters options are `date_created`, `valid_till`, `status`, `search`,
+`common_name` and `product_name_id`. Please [check the wiki] for more uptodate
+filter options list.
 
 #### Find an order
 
-We can use the `find` interface to retrieve a single order, by default it will
-print the details in the console. This interface also supports filter options.
+To find an order we can use `order find` command, by default it will print the
+order details in the console but this command also supports the normal filter
+options as described on the listing order section.
 
 One important thing to remember, it will only retrieve one single entry, so if
 you have multiple orders in your specified terms then it will only retrieve the
-most recent one form that list.
+most recent one from that list.
 
 ```sh
 $ digicert order find --filter 'common_name:ribosetest.com' 'product_name_id:ssl_plus'
@@ -122,27 +121,26 @@ $ digicert order find --filter 'common_name:ribosetest.com' 'product_name_id:ssl
 ..........................id=xxxx08 price=xxxx, product_name_id="ssl_plus">
 ```
 
-But if you don't care about that much of data and only need the `ID` then you
-can pass the `--quiet` flags to reduce the noises and retrieve only the id.
+Lots of information? Well, if you don't need that much details and only need the
+`ID` then you can pass the `--quiet` flags and it will only print the order id.
 
 #### Reissue an order
 
-To reissue a non-expired order we can use the `reissue` interface and pass the
-order id to it. By default it will reissue the order using the existing details
-but if we want to update the `CSR` then we can pass the certificate file as
-`--crt`.
+To reissue a non-expired order we can use the `order reissue` command and pass
+the order id. By default it will reissue the order using the existing details
+but we can update that by passing the certificate CSR as`--csr`
 
 ```sh
-$ digicert order reissue 12345 --crt path_to_the_new_csr.csr
+$ digicert order reissue 12345 --csr path_to_the_new_csr.csr
 ```
 
 ```sh
 Reissue request xxxxx8 created for order - 123456
 ```
 
-Pretty cool right? The above interface also support some other option that we
-can use to download the recently reissued order. To download, all we need to do
-is just provide a valid path and it will automatically download the certificates
+Pretty cool right? The above command also support `--output` option that we
+can use to download the reissued certificates. To download we need to provide a
+valid path and it will automatically download the certificates to it
 
 ```sh
 $ digicert order reissue 123456 --output /path/to/downloads
@@ -163,9 +161,10 @@ Downloaded certificate to:
 
 #### Fetch a certificate
 
-The `fetch` interface will retrieve the certificate for any specific orders, by
-default it will print out the detail in the console but if we only want the `ID`
-then we can pass the `--quiet` flags with it.
+The `certificate fetch` command retrieves the certificate for any specific order,
+by default it will print out the certificate detail in the console but if we can
+change it by passing additional option to it. Like the `--quiet` flags will only
+return the certificate id instead of all the details
 
 ```sh
 $ digicert certificate fetch 123456789 --quiet
@@ -173,19 +172,17 @@ $ digicert certificate fetch 123456789 --quiet
 
 #### Download a certificate
 
-To download a certificate we can use the same `fetch` interface but with the
-`--output` option. Based on the `--output` option `fetch` interface will fetch
-the certificates and download the `root`, `intermediate` and `certificate` to
-the output path, to download a certificate we can do
+To download a certificate we can use the same `certificate fetch` command but
+with the `--output` option. Based on the `--output` option this command will
+fetch and download the certificates to the provided path.
 
 ```sh
 $ digicert certificate fetch 123456 --output /path/to/downloads
 ```
 
-The above interface supports downloading a certificate and it expects us to
-provide the `order-id`, but if we only care about download then we can also use
-the `download` interface. It acts pretty much similar but it let's us specify
-the `order-id` or `certificate-id`.
+The `fetch` command only works with the `order_id` but what if we have the
+certificate id? Well, we have another command `certificate download` which
+supports both the `--order-id` and the `certificate-id`.
 
 ```sh
 $ digicert certificate download --order-id 654321 --output /downloads
@@ -195,8 +192,8 @@ $ digicert certificate download --certificate-id 123456 --output /downloads
 #### List duplicate certificates
 
 Digicert allows us to duplicate a certificate and if we want to list all of the
-duplicates then we can use the `duplicates` interface. This interface expects us
-to provide the `order-id` to list the duplicates
+duplicates then we can use the `certificate duplicates` command. It expects us
+to provide the `order-id` to list all the duplicates
 
 ```sh
 $ digicert certificate duplicates 123456
@@ -216,8 +213,8 @@ $ digicert certificate duplicates 123456
 #### Fetch an order's CSR
 
 Retrieving a `CSR` is pretty easy, if we have an order id and we want retrieve
-it's `CSR` then we can use the `fetch` interface from `csr` command. And once we
-passed it to the interface then it will retrieve and print it to the console.
+it's `CSR` then we can use the `csr fetch` command and it will print out the
+details in the console.
 
 ```sh
 $ digicert csr fetch 123456
@@ -225,18 +222,18 @@ $ digicert csr fetch 123456
 
 #### Generate a new CSR
 
-Digicert gem usages a third party library to generate a CSR, and we have also
-included that in the CLI to make the `CSR` generation process simpler, so if we
-need to generate a new `CSR` then we can use the `generate` interface and pass
-the order id with the key file to generate the CSR
+Digicert gem usages a third party library to generate a CSR, and this CLI
+included that to simply the `CSR` generation, so if we need to generate a new
+`CSR` then we can use the `csr generate` command and pass the order id with a
+key file and it will generate a new CSR.
 
 ```sh
 $ digicert csr generate --oreder-id 12345 --key /path/to/the/key-file.key
 ```
 
-This interface also support custom details like `common-name` and `san`. We can
-pass those as `--common-name` and `--san` and it will automatically use it to
-generate the new `CSR`
+This command also supports custom details like `common-name` and `san`. We can
+pass those as `--common-name` and the `--san` and it will use those to generate
+the `CSR`
 
 ```sh
 $ digicert csr generate --common-name ribosetest.com --order-id 1234 \
@@ -299,3 +296,4 @@ This gem is developed, maintained and funded by [Ribose Inc.][riboseinc]
 [Digicert CLI]: https://github.com/riboseinc/digicert-cli
 [Digicert Ruby Client]: https://github.com/riboseinc/digicert
 [check the wiki]: https://github.com/riboseinc/digicert-cli/wiki
+[follow the instruction here]: https://www.digicert.com/rest-api

data/digicert-cli.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = "digicert"
 
   spec.add_dependency "thor", "~> 0.19.4"
-  spec.add_dependency "digicert", "~> 0.1.2"
+  spec.add_dependency "digicert", "~> 0.2.0"
   spec.add_dependency "openssl", ">= 2.0.3"
   spec.add_dependency "terminal-table"
 

data/lib/digicert/cli/command.rb

@@ -1,6 +1,6 @@
-require "digicert/cli/rcfile"
 require "digicert/cli/commands/csr"
 require "digicert/cli/commands/order"
+require "digicert/cli/commands/config"
 require "digicert/cli/commands/certificate"
 
 module Digicert
@@ -15,10 +15,8 @@ module Digicert
       desc "certificate", "Manage Digicert Certificates"
       subcommand :certificate, Digicert::CLI::Commands::Certificate
 
-      desc "config API_KEY", "Configure The CLI Client"
-      def config(api_key)
-        Digicert::CLI::RCFile.set_key(api_key)
-      end
+      desc "config", "Configure The CLI Client"
+      subcommand :config, Digicert::CLI::Commands::Config
     end
   end
 end

data/lib/digicert/cli/commands/certificate.rb

@@ -15,10 +15,18 @@ module Digicert
         desc "download [RSOURCE_OPTION]", "Download a certificate"
         option :order_id, aliases: "-i", desc: "Digicert order ID"
         option :certificate_id, aliases: "-c", desc: "The certificate ID"
-        option :output, aliases: "-o", desc: "Path to download the certificate"
+
+        option(
+          :output,
+          aliases: "-o",
+          default: Dir.pwd,
+          desc: "Path to download the certificate",
+        )
 
         def download
-          say(certificate_instance.download)
+          required_option_exists? || say(certificate_instance.download)
+        rescue Digicert::Errors::RequestError
+          say("Invalid Resource ID")
         end
 
         desc "duplicates ORDER_ID", "List duplicate certificates"
@@ -31,6 +39,12 @@ module Digicert
         def certificate_instance(id_attribute = {})
           Digicert::CLI::Certificate.new(options.merge(id_attribute))
         end
+
+        def required_option_exists?
+          unless options[:order_id] || options[:certificate_id]
+            say("You must provide either `--order_id` or `--certificate_id`.")
+          end
+        end
       end
     end
   end

data/lib/digicert/cli/commands/config.rb

@@ -0,0 +1,14 @@
+require "digicert/cli/rcfile"
+
+module Digicert
+  module CLI
+    module Commands
+      class Config < Thor
+        desc "api-key API_KEY", "Configure Your Digicert API Key"
+        def api_key(api_key)
+          Digicert::CLI::RCFile.set_key(api_key)
+        end
+      end
+    end
+  end
+end

data/lib/digicert/cli/commands/order.rb

@@ -21,7 +21,7 @@ module Digicert
         end
 
         desc "reissue ORDER_ID", "Reissue digicert order"
-        option :crt, desc: "The CSR content from a file"
+        option :csr, desc: "The CSR content from a file"
         option :output, aliases: "-o", desc: "Path to download certificates"
 
         def reissue(order_id)

data/lib/digicert/cli/order_reissuer.rb

@@ -19,7 +19,7 @@ module Digicert
       attr_reader :csr_file, :output_path
 
       def extract_local_attributes(options)
-        @csr_file = options.fetch(:crt, nil)
+        @csr_file = options.fetch(:csr, nil)
         @output_path = options.fetch(:output, "/tmp")
       end
 
@@ -32,7 +32,7 @@ module Digicert
           order_params[:order_id] = order_id
 
           if csr_file && File.exists?(csr_file)
-            order_params[:certificate] = { csr: File.read(csr_file) }
+            order_params[:csr] = File.read(csr_file)
           end
         end
       end

data/lib/digicert/cli/version.rb

@@ -22,6 +22,6 @@
 
 module Digicert
   module CLI
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end
 end

data/lib/digicert/cli.rb

@@ -37,7 +37,7 @@ module Digicert
       Thor::Shell::Basic.new.say(
         "Invalid: Missing API KEY\n\n" \
         "A valid Digicert API key is required for any of the CLI operation\n" \
-        "You can set your API Key using `digicert config DIGICERT_API_KEY`",
+        "You can set your API Key using `digicert config api-key YOUR_API_KEY`",
       )
     end
   end

data/spec/acceptance/config_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 RSpec.describe "Config" do
   describe "configuring key" do
     it "stores the provided api key" do
-      command = %w(config DIGICERT_SECRET_KEY)
+      command = %w(config api-key DIGICERT_SECRET_KEY)
       allow(Digicert::CLI::RCFile).to receive(:set_key)
 
       Digicert::CLI.start(command)

data/spec/acceptance/reissuing_order_spec.rb

@@ -5,12 +5,12 @@ RSpec.describe "Order reissuing" do
     context "reissue with new csr" do
       it "reissues an order with the provided csr" do
         mock_digicert_order_reissuer_create_message_chain
-        command = %w(order reissue 123456 --crt ./spec/fixtures/rsa4096.csr)
+        command = %w(order reissue 123456 --csr ./spec/fixtures/rsa4096.csr)
 
         Digicert::CLI.start(command)
 
         expect(Digicert::CLI::OrderReissuer).to have_received(:new).
-          with(order_id: "123456", crt: "./spec/fixtures/rsa4096.csr")
+          with(order_id: "123456", csr: "./spec/fixtures/rsa4096.csr")
       end
     end
 

data/spec/digicert/cli/order_reissuer_spec.rb

@@ -22,11 +22,11 @@ RSpec.describe Digicert::CLI::OrderReissuer do
         allow(Digicert::OrderReissuer).to receive(:create)
 
         Digicert::CLI::OrderReissuer.new(
-          order_id: order_id, crt: csr_file,
+          order_id: order_id, csr: csr_file,
         ).create
 
         expect(Digicert::OrderReissuer).to have_received(:create).with(
-          order_id: order_id, certificate: { csr: File.read(csr_file) },
+          order_id: order_id, csr: File.read(csr_file),
         )
       end
     end
@@ -62,13 +62,11 @@ RSpec.describe Digicert::CLI::OrderReissuer do
 
   def order_attributes(order)
     {
-      certificate: {
-        common_name: order.certificate.common_name,
-        dns_names: order.certificate.dns_names,
-        csr: order.certificate.csr,
-        signature_hash: order.certificate.signature_hash,
-        server_platform: { id: 45 },
-      },
+      common_name: order.certificate.common_name,
+      dns_names: order.certificate.dns_names,
+      csr: order.certificate.csr,
+      signature_hash: order.certificate.signature_hash,
+      server_platform: { id: 45 },
     }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digicert-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-06 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +149,7 @@ files:
 - lib/digicert/cli/certificate_downloader.rb
 - lib/digicert/cli/command.rb
 - lib/digicert/cli/commands/certificate.rb
+- lib/digicert/cli/commands/config.rb
 - lib/digicert/cli/commands/csr.rb
 - lib/digicert/cli/commands/order.rb
 - lib/digicert/cli/csr.rb