akamai_ccu 1.5.4 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 590edfc04540966643fb8dcb26d61b1bc1fd472d
-  data.tar.gz: 786b909ccd366835593fd460dc590d6d2d2b6edd
+  metadata.gz: 21b678bb15fc4484478ffd8eafd454a73d64ebf2
+  data.tar.gz: aea48ed0449fa22043a6c76dc0d04f8a4a26bde8
 SHA512:
-  metadata.gz: 7e08562da9ceb7f72beb90ed9bd38fdae72b23088f28f3c7c47ce964f1dbc5940b85f61d9a805e4632c365fe5529cd202c8e154b3648e5bbe76f04ce7b21543d
-  data.tar.gz: 27796fd0c26becf2f80a1bfdeba91b5d3b5b8586da1248576e24c3854e9462150234029683a5e66c86ce36faae9e26598612fcd96c512aec20d8d10f90b45e83
+  metadata.gz: 7e84ce88cb3bff7b228c5989e9addf4696415dd3c14909203c6a2393a962c2530754905b4f80c8774fecb52dc21b93bf4c6b509f0e0898ec448d094790f2f89c
+  data.tar.gz: 44aa80033178853ddbf3234a9e2d6d26581637a18e85449736a0d0ad35108a067559141c1ec7bc2851ea455af4e9477bcf837043d149373e65e8ebeb9c5abfe5

data/README.md

@@ -18,7 +18,6 @@
     * [ccu_invalidate](#ccu_invalidate)
     * [ccu_delete](#ccu_delete)
     * [Bulk operation](#bulk-operation)
-    * [Redirecting output](#redirecting-output)
     * [Overwriting options](#overwriting-options)
   * [Logging](#logging)
     * [Library logger](#library-logger)
@@ -123,14 +122,14 @@ The CCU V3 APIs allow for invalidating contents by URLs or content provider (CP)
 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
-AkamaiCCU::Wrapper.invalidate_by_cpcode!([12345, 98765])
+AkamaiCCU::Wrapper.invalidate_by_cpcode!([12345,98765])
 ```
 
 #### Deleting
 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 codes
-AkamaiCCU::Wrapper.delete_by_cpcode([12345, 98765])
+AkamaiCCU::Wrapper.delete_by_cpcode([12345,98765])
 
 # deleting resources on production (mind the "!") by URLs
 AkamaiCCU::Wrapper.delete_by_url!(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js])
@@ -139,9 +138,9 @@ AkamaiCCU::Wrapper.delete_by_url!(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapi
 #### Response
 The Net::HTTP response is wrapped by an utility struct:
 ```ruby
-res = AkamaiCCU::Wrapper.invalidate_by_cpcode([12345, 98765])
+res = AkamaiCCU::Wrapper.invalidate_by_cpcode([12345,98765])
 puts res 
-# status=201; detail=Request accepted; purge_id=e535071c-26b2-11e7-94d7-276f2f54d938; support_id=17PY1492793544958045-219026624; copletion_at=20170620T11:19:16+0000
+# status=201; detail=Request accepted; support_id=17PY1498402073417329-261436608; purge_id=44ac266e-59b5-11e7-84ca-75d9dd540c3b; copletion_at=2017-06-20 12:19:16 +0100
 ```
 
 ### CLI
@@ -151,12 +150,12 @@ You can use the CLI by:
 Calling the help for the specific action:
 ```shell
 ccu_invalidate -h
-Usage: ccu_invalidate --secret=~/.edgerc --production --cp=12345,98765
-    -s, --secret=SECRET              Load secret data by file
+Usage: ccu_invalidate --secret=~/tokens.txt --production --cp=12345,98765
+    -s, --secret=SECRET              Load secret by file (default to ~/.edgerc)
     -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
-        --headers=HEADERS            Specify HTTP headers to sign
+        --headers=HEADERS            Specify any HTTP headers to sign
     -p, --production                 Purge on production network
     -h, --help                       Prints this help
 ```
@@ -164,16 +163,15 @@ Usage: ccu_invalidate --secret=~/.edgerc --production --cp=12345,98765
 #### ccu_invalidate
 Do request for contents invalidation by:
 ```shell
-ccu_invalidate --secret=~/.edgerc \ 
+ccu_invalidate --secret=~/tokens.txt \ 
                --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js \
                --production
 ```
 
 #### ccu_delete
-Do request for contents deletion by:
+Do request for contents deletion by (load secret from ~/.edgerc implicitly):
 ```shell
-ccu_delete --secret=~/tokens.txt \ 
-           --cp=12345,98765 \
+ccu_delete --cp=12345,98765 \
            --headers=Accept,Content-Length
 ```
 
@@ -190,13 +188,7 @@ https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/static/index.html
 
 Specify the bulk option by using the file path:
 ```shell
-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 --secret=~/.edgerc --cp=12345,98765 >> mylog.log
+ccu_invalidate --bulk=urls.txt
 ```
 
 #### Overwriting options
@@ -233,7 +225,13 @@ 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 --secret=~/.edgerc --cp=12345,98765
+LOG_LEVEL=DEBUG ccu_invalidate --cp=12345,98765
+```
+
+##### 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 --cp=12345,98765 >> mylog.log
 ```
 
 ### Possible Issues
@@ -241,7 +239,7 @@ LOG_LEVEL=DEBUG ccu_invalidate --secret=~/.edgerc --cp=12345,98765
 #### 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
+status=400; title=Bad request; detail=Invalid timestamp; support_id=5079982a; described_by=https://problems.purge.akamaiapis.net/-/pep-authn/request-error
 ```
 
 This happens since Akamai APIs only tolerate a clock skew of at most 30 seconds to defend against certain network attacks (described [here](https://community.akamai.com/docs/DOC-1336)).  

data/lib/akamai_ccu.rb

@@ -1,31 +1,5 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
-require "base64"
-require "json"
-require "openssl"
 require "akamai_ccu/version"
 require "akamai_ccu/wrapper"
 require "akamai_ccu/cli"
-
-module AkamaiCCU
-  extend self
-
-  GET = :Get
-  POST = :Post
-  SSL = "https"
-  JSON_HEADER = { "Content-Type" => "application/json" }
-
-  def format_utc(time)
-    time.utc.strftime("%Y%m%dT%H:%M:%S+0000")
-  end
-
-  def sign(data)
-    digest = OpenSSL::Digest::SHA256.new.digest(data)
-    Base64.encode64(digest).strip
-  end
-
-  def sign_HMAC(key:, data:)
-    digest = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, key, data)
-    Base64.encode64(digest).strip
-  end
-end

data/lib/akamai_ccu/cli.rb

@@ -49,7 +49,7 @@ module AkamaiCCU
 
     private def parser
       OptionParser.new do |opts|
-        opts.banner = "Usage: ccu_#{@action} --secret=~/.edgerc --production --cp=12345,98765"
+        opts.banner = "Usage: ccu_#{@action} --secret=~/tokens.txt --production --cp=12345,98765"
 
         opts.on("-sSECRET", "--secret=SECRET", "Load secret by file (default to ~/.edgerc)") do |secret|
           @secret = File.expand_path(secret)

data/lib/akamai_ccu/client.rb

@@ -3,6 +3,11 @@ require "openssl"
 
 module AkamaiCCU
   class Client
+    GET = :Get
+    POST = :Post
+    SSL = "https"
+    JSON_HEADER = { "Content-Type" => "application/json" }
+
     attr_reader :net_klass, :host
 
     def initialize(host:, net_klass: Net::HTTP)

data/lib/akamai_ccu/response.rb

@@ -4,83 +4,38 @@ module AkamaiCCU
   class Response
     BAD_STATUS = 400
 
-    def self.factory(body)
-      response = new(body)
-      case response
-      when ->(res) { res.successful? }
-        Ack.new(body)
-      else
-        Error.new(body)
-      end
-    end
-
-    attr_reader :body, :status, :detail
+    attr_reader :body, :title, :status, :detail, :support_id, :purge_id, :decribed_by, :completion_at
 
-    def initialize(body = {})
+    def initialize(body = {}, time = Time.now)
       @body = parse(body)
+      @title = @body["title"]
       @status = @body.fetch("httpStatus") { @body.fetch("status", BAD_STATUS) }
       @detail = @body["detail"]
+      @support_id = @body.fetch("supportId") { @body["requestId"] }
+      @purge_id = @body["purgeId"]
+      @described_by = @body.fetch("describedBy") { @body["type"] }
+      @estimated_secs = @body["estimatedSeconds"]
+      @completion_at = time + @estimated_secs.to_i if @estimated_secs
     end
 
     def successful?
       (@status.to_i / 100) == 2
     end
 
-    private def parse(body)
-      return body if body.is_a? Hash
-      JSON.parse(body)
-    end
-  end
-
-  class Error < Response
-    attr_reader :type, :title, :request_id, :instance, :method, :server_ip, :client_ip
-
-    def initialize(body)
-      super(body)
-      @type = @body["type"]
-      @title = @body["title"]
-      @request_id = @body["requestId"]
-      @instance = @body["instance"]
-      @method = @body["method"]
-      @serverIp = @body["serverIp"]
-      @clientIp = @body["clientIp"]
-      @requested_at = @body["requestTime"]
-    end
-
-    def requested_at
-      return nil unless @requested_at
-      Time.parse(@requested_at)
-    end
-
     def to_s
       %W[status=#{@status}].tap do |a|
         a << "title=#{@title}" if @title
         a << "detail=#{@detail}" if @detail
-        a << "request_id=#{@request_id}" if @request_id
-        a << "method=#{@method}" if @method
-        a << "requested_at=#{@requested_at}" if @requested_at
+        a << "support_id=#{@support_id}" if @support_id
+        a << "purge_id=#{@purge_id}" if @purge_id
+        a << "described_by=#{@described_by}" if @described_by
+        a << "copletion_at=#{@completion_at}" if @completion_at
       end.join("; ")
     end
-  end
 
-  class Ack < Response
-    attr_reader :purge_id, :estimated_secs, :support_id, :completion_at
-
-    def initialize(body, time = Time.now)
-      super(body)
-      @purge_id = @body["purgeId"]
-      @estimated_secs = @body["estimatedSeconds"]
-      @support_id = @body["supportId"]
-      @completion_at = time + @estimated_secs.to_i
-    end
-
-    def to_s
-      %W[status=#{@status}].tap do |a|
-        a << "detail=#{@detail}" if @detail
-        a << "purge_id=#{@purge_id}" if @purge_id
-        a << "support_id=#{@support_id}" if @support_id
-        a << "copletion_at=#{AkamaiCCU.format_utc(@completion_at)}" if @completion_at
-      end.join("; ")
+    private def parse(body)
+      return body if body.is_a? Hash
+      JSON.parse(body)
     end
   end
 end

data/lib/akamai_ccu/secret.rb

@@ -1,5 +1,7 @@
-require "uri"
+require "base64"
+require "openssl"
 require "securerandom"
+require "uri"
 
 module AkamaiCCU
   class Secret
@@ -9,6 +11,20 @@ module AkamaiCCU
 
     class FileContentError < ArgumentError; end
 
+    def self.format_utc(time)
+      time.utc.strftime("%Y%m%dT%H:%M:%S+0000")
+    end
+
+    def self.sign(data)
+      digest = OpenSSL::Digest::SHA256.new.digest(data)
+      Base64.encode64(digest).strip
+    end
+
+    def self.sign_HMAC(key, data)
+      digest = OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, key, data)
+      Base64.encode64(digest).strip
+    end
+
     def self.by_file(name = "~/.edgerc", time = Time.now)
       path = File.expand_path(name)
       return unless File.exist?(path)
@@ -32,17 +48,17 @@ module AkamaiCCU
       @client_token = client_token
       @max_body = max_body.to_i
       @nonce = nonce
-      @timestamp = AkamaiCCU.format_utc(time) 
+      @timestamp = self.class.format_utc(time) 
     end
 
     def touch
       @nonce = SecureRandom.uuid
-      @timestamp = AkamaiCCU.format_utc(Time.now)
+      @timestamp = self.class.format_utc(Time.now)
       self
     end
 
     def signed_key
-      AkamaiCCU.sign_HMAC(key: @client_secret, data: @timestamp)
+      self.class.sign_HMAC(@client_secret, @timestamp)
     end
 
     def auth_header

data/lib/akamai_ccu/signer.rb

@@ -1,5 +1,4 @@
 require "forwardable"
-require "uri"
 require "akamai_ccu/secret"
 
 module AkamaiCCU
@@ -42,7 +41,7 @@ module AkamaiCCU
     private def signed_body
       return "" unless body?
       truncated = body[0...max_body]
-      AkamaiCCU.sign(truncated)
+      @secret.class.sign(truncated)
     end
 
     private def signature_data
@@ -58,7 +57,7 @@ module AkamaiCCU
     end
 
     private def signature
-      AkamaiCCU.sign_HMAC(key: signed_key, data: signature_data.join(TAB))
+      @secret.class.sign_HMAC(signed_key, signature_data.join(TAB))
     end
 
     def signed_header

data/lib/akamai_ccu/version.rb

@@ -1,3 +1,3 @@
 module AkamaiCCU
-  VERSION = "1.5.4"
+  VERSION = "1.5.5"
 end

data/lib/akamai_ccu/wrapper.rb

@@ -1,3 +1,4 @@
+require "json"
 require "akamai_ccu/client"
 require "akamai_ccu/endpoint"
 require "akamai_ccu/signer"
@@ -45,7 +46,7 @@ module AkamaiCCU
         self.class.logger.debug { "request: uri=#{request.path}; body=#{request.body}; authorization=#{request["Authorization"]}" }
       end
       self.class.logger.debug { "response: inspect=#{response.inspect}; body=#{response.body}" }
-      response_klass.factory(response.body)
+      response_klass.new(response.body)
     end
   end
 end

metadata

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