akamai_ccu 1.3.7 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34081b860a9117fcb8b29d71142e7fc3b9a35f21
-  data.tar.gz: c050cdf93d6438e15e7117e6408f70b7b6f7ae76
+  metadata.gz: b391acf5cc630f905fe9ec0b2b9b8a41bfa050ca
+  data.tar.gz: a68c5fb3a6643330809dc6aaf427633779dd7567
 SHA512:
-  metadata.gz: 7529688f00dda88a6f27d515b8e87efb59a5a59448fb8a0b5f1e942c6bbf4cb9b5d32444e627c8e6b89e957f390cdf27ae73f7629f1d071d1774ab646603df40
-  data.tar.gz: 384ab0c12360473d0b4751a13d8888c4eebd66c83934e595ea4a896dec633a89d232b107d06ba889f64f1a22c328e5c72382d134f73139f5e3a7ea126aca0fe5
+  metadata.gz: af084a3c29b82a20a92bf651b89e84edeef63e55b4478b766c03d484abcfcbc8e04ea3efe91f832719b755d3a4198515b76b1394d2d3336ca34fe1ef9c14e5f4
+  data.tar.gz: 271ce8ede89bb27f105a46aceb0808959b0e9b7ffcfd7e62d9a39f946afa8ff28a5d3b1882d431e3575080d659e30a48568220830188ace72e5df81a11ab724d

data/README.md

@@ -10,6 +10,7 @@
 * [Usage](#usage)
   * [As library](#as-library)
     * [Secret](#secret)
+    * [Edge network](#edge-network)
     * [Invalidating](#invalidating)
     * [Deleting](#deleting)
   * [CLI](#cli)
@@ -20,10 +21,13 @@
     * [Redirecting output](#redirecting-output)
     * [Overwriting options](#overwriting-options)
   * [Possible issues](#possible-issues)
+    * [Invalid timestamp](#invalid-timestamp)
+    * [No wildcard](#no-wildcard)
+    * [Mixed bulk](#mixed-bulk)
 
 ## Scope
 This gem is a minimal wrapper of the [Akamai Content Control Utility](https://developer.akamai.com/api/purge/ccu/overview.html) APIs used to purge Edge content by request.  
-The library is compliant with [CCU API V3](https://developer.akamai.com/api/purge/ccu/resources.html), based on the *Fast Purge* utility.
+The library is compliant with [CCU API V3](https://developer.akamai.com/api/purge/ccu/resources.html), based on the *Fast Purge Utility*.
 
 ## Motivation
 The gem has two main responsibilities:
@@ -55,13 +59,13 @@ gem install akamai_ccu
 ```
 
 ### Configuration
-This gem requires you have a valid Akamai Luna Control Center account, enabled to use the CCU APIs.  
-Akamai relies on a credentials file with three secret keys and a dedicated host for API authorization.  
-Detailing how to get this file is out of the scope of this readme, check Akamai's [official documentation](https://developer.akamai.com/introduction/Conf_Client.html) for that.  
-Suffice to say you have two main options:
+This gem requires you have a valid Akamai Luna Control Center account, enabled to add APIs clients.  
+Upon APIs client creation, you'll get the `client token` to be used to generate new APIs credentials data: these consist of a secret key, two token (client and access) and a dedicated host for API authorization.  
+Check Akamai's [official documentation](https://developer.akamai.com/introduction/Conf_Client.html) for more details.  
+Suffice to say you have two main options to import credentials data:
 
 #### edgerc
-You can generate (by facility script or by hand) a specific file named `.edgerc`:
+You can generate (using a script or by hand) an INI file named `.edgerc`:
 ```
 [default]
 client_secret = xxx=
@@ -72,7 +76,7 @@ max-body = 131072
 ```
 
 #### txt
-You can download a plain text file directly from Luna Control Center `Manage APIs` page:
+You can download a plain text file upon credentials data creation:
 ```
 client_secret = xxx=
 
@@ -99,19 +103,23 @@ secret = AkamaiCCU::Secret.by_edgerc(".edgerc")
 # by txt file
 secret = AkamaiCCU::Secret.by_txt("tokens.txt")
 
-# by specifying arguments
+# by using initializer
 secret = AkamaiCCU::Secret.new(client_secret: "xxx=", host: "akaa-baseurl-xxx-xxx.luna.akamaiapis.net/", access_token: "akab-access-token-xxx-xxx", client_token: "akab-client-token-xxx-xxx", max_body: 131072)
 ```
 
-The next step is setting the `Wrapper` class with the secret object (Net client and secret will be shared by successive calls):
+The next step is setting the `Wrapper` class with the secret object, the secret and Net::HTTP client instances are shared between calls:
 ```ruby
 AkamaiCCU::Wrapper.setup(secret)
 ```
 
+#### Edge network
+Purging actions runs on the `staging` network by default.  
+Switch to production by just appending a shebang `!` on the method name.
+
 #### Invalidating
-The CCU V3 APIs allow for invalidating contents by URL or content provider (CP) code:
+The CCU V3 APIs allow for invalidating contents by URLs or content provider (CP) codes: currently only the former relies on the Fast Purge Utility.  
 ```ruby
-# invalidating resources on staging by url
+# invalidating resources on staging by URLs
 AkamaiCCU::Wrapper.invalidate_by_url(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/index.html])
 
 # invalidating resources on production (mind the "!") by CP code
@@ -119,12 +127,12 @@ AkamaiCCU::Wrapper.invalidate_by_cpcode!([12345, 98765])
 ```
 
 #### Deleting
-You can also delete contents by URL or CP code (just be aware of what you're doing):
+You can delete contents by URLs or CP codes as well, just be aware of what you're doing:
 ```ruby
-# deleting resources on staging by CP code
+# deleting resources on staging by CP codes
 AkamaiCCU::Wrapper.delete_by_cpcode([12345, 98765])
 
-# deleting resources on production (mind the "!") by url
+# deleting resources on production (mind the "!") by URLs
 AkamaiCCU::Wrapper.delete_by_url!(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js])
 ```
 
@@ -155,7 +163,7 @@ Usage: invalidate --edgerc=./.edgerc --production --cp="12345, 98765"
 ```
 
 #### ccu_invalidate
-You can request for contents invalidation by calling:
+Do request for contents invalidation by:
 ```shell
 ccu_invalidate --edgerc=~/.edgerc \ 
                --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js \
@@ -163,7 +171,7 @@ ccu_invalidate --edgerc=~/.edgerc \
 ```
 
 #### ccu_delete
-You can request for contents deletion by calling:
+Do request for contents deletion by:
 ```shell
 ccu_delete --txt=~/tokens.txt \ 
            --cp=12345,98765 \
@@ -174,7 +182,7 @@ ccu_delete --txt=~/tokens.txt \
 In case you have multiple contents to work with, it could be impractical to write several entries on the CLI.  
 Just specify them on a separate file and use the bulk option:
 
-`urls.txt` file with each url/CP code specified on one line:
+`urls.txt` file with URL entries specified on a new line:
 ```txt
 https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css
 https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js
@@ -186,9 +194,6 @@ Specify the bulk option by using the file path:
 ccu_invalidate --edgerc=~/.edgerc --bulk=urls.txt
 ```
 
-##### Do not mix content types
-You cannot specify both CP codes and URLs on the same bulk file, mind being consistent!
-
 #### Redirecting output
 In case you're calling the CLI from another program (like your Jenkins script), just redirect the output to your log file:
 ```shell
@@ -196,22 +201,22 @@ ccu_invalidate --edgerc=~/.edgerc --cp=12345,98765 > mylog.log
 ```
 
 #### Overwriting options
-The CLI does allow only one option to specify the secret file and the content objects.  
-If multiple options for the same scope are provided, the program runs by giving precedence to:
+The CLI allows different options for the same scope on secret and contents specification. If multiple options for the same scope are provided, the program runs by assigning specific precedence rules:
 
-##### Secret file
+##### Secret
 The `edgerc` option has always precedence over the `txt` one:
+
+This command will load secret from ~/.edgerc:
 ```shell
-# will load secret from ~/.edgerc
 ccu_invalidate --txt=~/tokens.txt \
                --edgerc=~/.edgerc \
                --cp=12345,98765
 ```
 
-##### Content objects
-The `bulk` option has always precedence over the `cp` one, that has precedence over the `url`:
+##### Contents
+The `bulk` option has always precedence over the `cp` one, that has precedence over  `url`:
 
-This command will invalidate by urls:
+This command will invalidate by URLs:
 ```shell
 ccu_invalidate --txt=~/tokens.txt \
                --cp=12345,98765
@@ -226,7 +231,9 @@ ccu_delete --txt=~/tokens.txt \
 ```
 
 ### Possible Issues
-It happens you can get a `bad request` response by Akamai like this:
+
+#### Invalid timestamp
+You could get a `bad request` response like this:
 ```shell
 status=400; title=Bad request; detail=Invalid timestamp; request_id=2ce206fd; method=POST; requested_at=2017-06-21T12:33:10Z
 ```
@@ -235,3 +242,10 @@ This happens since Akamai APIs only tolerate a clock skew of at most 30 seconds
 In order to fix this annoying issue please do synchronize you server clock by:
 * `NTP` if you are on a UX server
 * `manually` versus an atomic clock site (check Internet) by using your workstation GUI
+
+#### No wildcard
+Do keep in mind CCU V3 APIs doesn't support contents specification by wildcard.
+
+#### Mixed bulk
+When specifying contents by bulk on the CLI, you cannot include both CP codes and URLs resources on the same file.  
+The library tries to detect which mode to use basing on entries kind: mixing them will generate unexpected behaviour.

data/lib/akamai_ccu/cli.rb

@@ -4,6 +4,8 @@ require "akamai_ccu/wrapper"
 
 module AkamaiCCU
   class CLI
+    SCHEME = "http"
+
     attr_reader :network, :action
 
     def initialize(args:, action:, io: STDOUT, wrapper_klass: Wrapper, secret_klass: Secret, endpoint_klass: Endpoint)
@@ -43,10 +45,9 @@ module AkamaiCCU
 
     private def bulk_objects(file)
       return unless File.exist?(file)
-      File.readlines(file).map(&:strip).reject(&:empty?).map do |entry|
-        entry = entry.to_i unless entry.start_with?("http")
-        entry
-      end
+      data = File.readlines(file).map(&:strip).reject(&:empty?)
+      return data if data.all? { |entry| entry.downcase.start_with?(SCHEME) }
+      data.map(&:to_i).reject(&:zero?)
     end
 
     private def parser

data/lib/akamai_ccu/version.rb

@@ -1,3 +1,3 @@
 module AkamaiCCU
-  VERSION = "1.3.7"
+  VERSION = "1.3.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akamai_ccu
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.3.8
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler