akamai_ccu 1.3.9 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a24bee1480f3f5e009ab732d5a0af9b1994fea05
-  data.tar.gz: a03462df7c7a34d56e9589ecc193b1a76c310f1a
+  metadata.gz: 90eb919f024235aa67dcf1b4f028e9041179986f
+  data.tar.gz: b4f679753d318e95e1bf2ee9633c8d29c95063a1
 SHA512:
-  metadata.gz: bef943c60a6fe07f0cb5cb601f550a6f17b617392ba963afd32933f9a9efba331a9e469def5fb5318563ee015997b1f7139ec52ffea76548a41afebae8dbde0f
-  data.tar.gz: 9b0d155906efba022fe14127b091a0679473976f8948a14e74c4cb37f25c33329effd2aaa5d929ee3ecad9739ee7cec211cc17b92cf6c847de901c3432d9ab19
+  metadata.gz: c2c87599dcbd0968571ecb7d303244a2f4b4f799520e3a352b4f20a2053bca5648c38bdbe3fca44db011a9d98a87b7e23d1d999acd59219ccf0800125881d359
+  data.tar.gz: 7d905b042e620911b32817bc6841350cff1a518015e2c028bc9e9a56ddcafc1ab5e89bd6046b7b7f94cddd051d747fb0c7b6a4fe74105c757505bd2935843117

data/README.md

@@ -20,6 +20,9 @@
     * [Bulk operation](#bulk-operation)
     * [Redirecting output](#redirecting-output)
     * [Overwriting options](#overwriting-options)
+  * [Logging](#logging)
+    * [Library logger](#library-logger)
+    * [CLI logger](#cli-logger)
   * [Possible issues](#possible-issues)
     * [Invalid timestamp](#invalid-timestamp)
     * [No wildcard](#no-wildcard)
@@ -98,7 +101,7 @@ Once you've got APIs credentials, you can instantiate the secret object aimed to
 require "akamai_ccu"
 
 # by .edgerc
-secret = AkamaiCCU::Secret.by_edgerc(".edgerc")
+secret = AkamaiCCU::Secret.by_edgerc(".edgerc") # default to ~/.edgerc
 
 # by txt file
 secret = AkamaiCCU::Secret.by_txt("tokens.txt")
@@ -197,7 +200,7 @@ ccu_invalidate --edgerc=~/.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 --edgerc=~/.edgerc --cp=12345,98765 >> mylog.log
 ```
 
 #### Overwriting options
@@ -230,6 +233,22 @@ ccu_delete --txt=~/tokens.txt \
            --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js
 ```
 
+### Logging
+
+#### Library logger
+By default the `Wrapper` class accepts a logger pointing to `dev/null`. 
+In case you want to replace it with yours, just use the class attribute writer:
+```ruby
+AkamaiCCU::Wrapper.logger = Logger.new(STDOUT)
+```
+
+#### CLI logger
+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
+```
+
 ### Possible Issues
 
 #### Invalid timestamp

data/lib/akamai_ccu/cli.rb

@@ -5,6 +5,7 @@ require "akamai_ccu/wrapper"
 module AkamaiCCU
   class CLI
     SCHEME = "http"
+    LOG_LEVEL = Logger.const_get(ENV.fetch("LOG_LEVEL", "INFO"))
 
     attr_reader :network, :action
 
@@ -13,6 +14,7 @@ module AkamaiCCU
       @action = action
       @io = io
       @logger = Logger.new(io)
+      @logger.level = LOG_LEVEL
       @wrapper_klass = wrapper_klass
       @secret_klass = secret_klass
       @endpoint_klass = endpoint_klass
@@ -24,7 +26,7 @@ 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)
+      @wrapper_klass.setup(secret, Client, @logger)
       wrapper = @wrapper_klass.new(endpoint: endpoint, headers: Array(@headers))
       @logger.info wrapper.call(@objects).to_s
     end

data/lib/akamai_ccu/secret.rb

@@ -20,7 +20,7 @@ module AkamaiCCU
         factory(Hash[data], time)
       end
 
-      def by_edgerc(name, time = Time.now)
+      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/lib/akamai_ccu/version.rb

@@ -1,3 +1,3 @@
 module AkamaiCCU
-  VERSION = "1.3.9"
+  VERSION = "1.4.0"
 end

data/lib/akamai_ccu/wrapper.rb

@@ -7,10 +7,12 @@ module AkamaiCCU
   class Wrapper
     class << self
       attr_reader :secret, :client
+      attr_accessor :logger
 
-      def setup(secret, client_klass = Client)
+      def setup(secret, client_klass = Client, logger = Logger.new(nil))
         @secret ||= secret
         @client ||= client_klass.new(host: @secret.host)
+        @logger ||= logger
       end
 
       Endpoint::Network.constants.each do |network|
@@ -37,11 +39,13 @@ module AkamaiCCU
     end
 
     def call(objects)
-      res = self.class.client.call(path: @endpoint.path) do |request|
+      response = self.class.client.call(path: @endpoint.path) do |request|
         request.body = { objects: objects }.to_json
         @signer_klass.new(request, self.class.secret.touch, @headers).call!
+        self.class.logger.debug { "request: uri=#{request.path}; body=#{request.body}; authorization=#{request["Authorization"]}" }
       end
-      response_klass.factory(res.body)
+      self.class.logger.debug { "response: inspect=#{response.inspect}; body=#{response.body}" }
+      response_klass.factory(response.body)
     end
   end
 end

metadata

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