akamai_ccu 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54fe3c8b980c14e50ef78c4789eab9e376609733
-  data.tar.gz: c1603bc6a64a685d5ba73eed5c968b3d02888373
+  metadata.gz: 42d7a18832075e64a3b665f937ee63f160621d31
+  data.tar.gz: de91792521bce4ff10dbb5870bbd47794f48dc4f
 SHA512:
-  metadata.gz: 0b04c3c310a4db4c85e17dd638b78be47774b05caec0b4aeb4a3778a6df054aa387a97555b460d97ac128ddc97cc746a89158b766179ccfe24c6f6b2b0f2b103
-  data.tar.gz: e1517ac58e83c73cc563a7407da7e0e38824f58343ce370d2cf095a37638bbdec39fde099271de7c604cf2052a7a9affe2209d0c4cf2c08102138a7f44a96111
+  metadata.gz: f54ecccd6a50ccd8a44b1506a42ace24cebde3b6fe8e7e0db33f4e4612717067acae2bd9a26c1baeb52f95b62d325d585af92e529af994cab60f9e21cf17c1a6
+  data.tar.gz: d08aed26cf776579064aa76662ad1f765daeb0c8ad860786967500beba34a0725a8aa5a72f51ba1890746cc819e535f06a97f6eda88f0dc3f4c03f841f78ae1c

data/README.md

@@ -8,7 +8,7 @@
     * [edgerc](#edgerc)
     * [txt](#txt)
 * [Usage](#usage)
-  * [As library](#as-library)
+  * [Library](#library)
     * [Secret](#secret)
     * [Edge network](#edge-network)
     * [Invalidating](#invalidating)
@@ -92,7 +92,7 @@ client_token = akab-client-token-xxx-xxx
 
 ## Usage
 
-### As library
+### Library
 You can require the gem to use it as a library inside your scripts:
 
 #### Secret
@@ -100,11 +100,8 @@ Once you've got APIs credentials, you can instantiate the secret object aimed to
 ```ruby
 require "akamai_ccu"
 
-# by .edgerc
-secret = AkamaiCCU::Secret.by_edgerc(".edgerc") # default to ~/.edgerc
-
-# by txt file
-secret = AkamaiCCU::Secret.by_txt("tokens.txt")
+# by file, both .edgerc or .txt one
+secret = AkamaiCCU::Secret.by_file("~/tokens.txt") # default to ~/.edgerc
 
 # 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)
@@ -154,9 +151,8 @@ You can use the CLI by:
 Calling the help for the specific action:
 ```shell
 ccu_invalidate -h
-Usage: ccu_invalidate --edgerc=./.edgerc --production --cp="12345, 98765"
-    -e, --edgerc=EDGERC              Load secret by .edgerc file
-    -t, --txt=TXT                    Load secret by TXT file
+Usage: ccu_invalidate --secret=~/.edgerc --production --cp="12345, 98765"
+    -s, --secret=SECRET              Load secret data by file
     -c, --cp=CP                      Specify contents by provider (CP) codes
     -u, --url=URL                    Specify contents by URLs
     -b, --bulk=BULK                  Specify bulk contents in a file
@@ -168,7 +164,7 @@ Usage: ccu_invalidate --edgerc=./.edgerc --production --cp="12345, 98765"
 #### ccu_invalidate
 Do request for contents invalidation by:
 ```shell
-ccu_invalidate --edgerc=~/.edgerc \ 
+ccu_invalidate --secret=~/.edgerc \ 
                --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js \
                --production
 ```
@@ -176,7 +172,7 @@ ccu_invalidate --edgerc=~/.edgerc \
 #### ccu_delete
 Do request for contents deletion by:
 ```shell
-ccu_delete --txt=~/tokens.txt \ 
+ccu_delete --secret=~/tokens.txt \ 
            --cp=12345,98765 \
            --headers=Accept,Content-Length
 ```
@@ -194,41 +190,32 @@ https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/static/index.html
 
 Specify the bulk option by using the file path:
 ```shell
-ccu_invalidate --edgerc=~/.edgerc --bulk=urls.txt
+ccu_invalidate --secret=~/.edgerc --bulk=urls.txt
 ```
 
 #### 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
-ccu_invalidate --edgerc=~/.edgerc --cp=12345,98765 >> mylog.log
+ccu_invalidate --secret=~/.edgerc --cp=12345,98765 >> mylog.log
 ```
 
 #### Overwriting options
-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
-The `edgerc` option has always precedence over the `txt` one:
-
-This command will load secret from ~/.edgerc:
-```shell
-ccu_invalidate --txt=~/tokens.txt \
-               --edgerc=~/.edgerc \
-               --cp=12345,98765
-```
+The CLI allows different options to specify the contents to be purged.  
+If multiple options for contents are provided, the program runs by specific precedence rules:
 
-##### Contents
+##### Options precedence
 The `bulk` option has always precedence over the `cp` one, that has precedence over  `url`:
 
 This command will invalidate by URLs:
 ```shell
-ccu_invalidate --txt=~/tokens.txt \
+ccu_invalidate --secret=~/tokens.txt \
                --cp=12345,98765
                --bulk=urls.txt
 ```
 
 This command will delete by CP codes:
 ```shell
-ccu_delete --txt=~/tokens.txt \
+ccu_delete --secret=~/tokens.txt \
            --cp=12345,98765
            --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js
 ```
@@ -246,7 +233,7 @@ AkamaiCCU::Wrapper.logger = Logger.new(STDOUT)
 CLI uses a logger writing to `STDOUT` by default with an `INFO` level.  
 In case you want to control the log level, just pass an environment variable to the script:
 ```shell
-LOG_LEVEL=DEBUG ccu_invalidate --edgerc=~/.edgerc --cp=12345,98765
+LOG_LEVEL=DEBUG ccu_invalidate --secret=~/.edgerc --cp=12345,98765
 ```
 
 ### Possible Issues

data/lib/akamai_ccu/cli.rb

@@ -26,16 +26,11 @@ module AkamaiCCU
       return @logger.warn("specify contents to purge by bulk, CP codes or urls") if Array(@objects).empty?
       return @logger.warn("specify path to the secret file either by edgerc or by txt") unless @secret
       return @logger.warn("specified secret file does not exist") unless File.exist?(@secret)
-      @wrapper_klass.setup(secret, Client, @logger)
+      @wrapper_klass.setup(@secret_klass.by_file(@secret), Client, @logger)
       wrapper = @wrapper_klass.new(endpoint: endpoint, headers: Array(@headers))
       @logger.info wrapper.call(@objects).to_s
     end
 
-    private def secret
-      return @secret_klass.by_txt(@secret) if File.extname(@secret) == ".txt"
-      @secret_klass.by_edgerc(@secret)
-    end
-
     private def endpoint
       @endpoint_klass.new(network, action, mode) 
     end
@@ -54,13 +49,9 @@ module AkamaiCCU
 
     private def parser
       OptionParser.new do |opts|
-        opts.banner = %Q{Usage: ccu_#{@action} --edgerc=./.edgerc --production --cp="12345, 98765"}
-
-        opts.on("-eEDGERC", "--edgerc=EDGERC", "Load secret by .edgerc file") do |secret|
-          @secret = File.expand_path(secret)
-        end
+        opts.banner = %Q{Usage: ccu_#{@action} --secret=~/.edgerc --production --cp="12345, 98765"}
 
-        opts.on("-tTXT", "--txt=TXT", "Load secret by TXT file") do |secret|
+        opts.on("-sSECRET", "--secret=SECRET", "Load secret data by file") do |secret|
           @secret = File.expand_path(secret)
         end
 

data/lib/akamai_ccu/secret.rb

@@ -4,36 +4,34 @@ require "securerandom"
 module AkamaiCCU
   class Secret
     DIGEST = "EG1-HMAC-SHA256"
-    EQUALITY = " = "
+    ENTRY_REGEX = /(.+?)\s?=\s?(.+)/ 
+    BODY_SIZE = 131072
+
+    class FileContentError < ArgumentError; end
 
     class << self
       private def factory(opts, time)
-        new(client_secret: opts.fetch("client_secret"), host: opts.fetch("host"), access_token: opts.fetch("access_token"), client_token: opts.fetch("client_token"), max_body: opts.fetch("max-body", 2048), time: time)
+        new(client_secret: opts.fetch("client_secret"), host: opts.fetch("host"), access_token: opts.fetch("access_token"), client_token: opts.fetch("client_token"), max_body: opts.fetch("max-body", BODY_SIZE), time: time)
       end
 
-      def by_txt(name, time = Time.now)
+      def by_file(name = "~/.edgerc", time = Time.now)
         path = File.expand_path(name)
         return unless File.exist?(path)
-        data = File.readlines(path).map(&:strip).reject(&:empty?).map do |entry| 
-          entry.split(EQUALITY)
+        data = File.readlines(path).map(&:strip).reduce([]) do |acc, entry|
+          m = entry.match(ENTRY_REGEX)
+          acc << [m[1], m[2]] if m
+          acc
         end
         factory(Hash[data], time)
-      end
-
-      def by_edgerc(name = "~/.edgerc", time = Time.now)
-        path = File.expand_path(name)
-        return unless File.exist?(path)
-        data = File.readlines(path).map(&:strip)
-        data.shift
-        data.map! { |entry| entry.split(EQUALITY) }
-        factory(Hash[data], time)
+      rescue KeyError => e
+        raise FileContentError, "bad file content, #{e.message}", e.backtrace
       end
     end
 
     attr_reader :host, :max_body, :nonce, :timestamp
 
     def initialize(client_secret:, host:, access_token:, client_token:, 
-                   max_body: 2048, nonce: SecureRandom.uuid, time: Time.now)
+                   max_body: BODY_SIZE, nonce: SecureRandom.uuid, time: Time.now)
       @client_secret = client_secret
       @host = URI(host)
       @access_token = access_token

data/lib/akamai_ccu/version.rb

@@ -1,3 +1,3 @@
 module AkamaiCCU
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: akamai_ccu
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - costajob