akamai_ccu 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3d0a61d0f9ebed4ee01089a94de93ce8eca3f70
-  data.tar.gz: 825989b16f621c573c37facbba7e31aacd3f8534
+  metadata.gz: b9fa4cc2e85f1f24463df9a860dc53e7cb9d10dc
+  data.tar.gz: e506e07a06b7fcbae8d48383ae8c6ccb0ba801e4
 SHA512:
-  metadata.gz: 1ccb47292f48276e4e0c5b17577aca576ab0f701db0c15067af30a6c25f1cc9a814187b287550a5b74df7e0c878b890f00a0efd2d483cd3ae64812f888340059
-  data.tar.gz: 2b81b1d97d34d5020e993896a00a6880f142b7a9aa2c94cf1d63420289d19f6b34303f7364b0c0200b25534f57895a614dbf8e194357b3f2c2cc1fa1cb96b240
+  metadata.gz: e03f6521b00e455d6f0a3ae3198793c8f8c05e4529087a78e603aa4ebfc1c6e4b331debde13a03d544bfca8ce7fbf8008d2b71f70ab35700588954fccd2794d0
+  data.tar.gz: 00647ebaec93f58dace7b572843a70516a879c8caa2b3de131272d87fe7d160b2086a01c2d6431d444e44ad3f1dd8d13fb78f17244d3c536d530fec2b575fe70

data/README.md

@@ -4,15 +4,14 @@
 * [Motivation](#motivation)
   * [akamai-edgerid](#akamai-edgerid)
 * [Installation](#installation)
-* [Usage](#usage)
   * [Configuration](#configuration)
     * [edgerc](#edgerc)
     * [txt](#txt)
-  * [Inside your script](#inside-your-script)
+* [Usage](#usage)
+  * [As library](#as-library)
     * [Secret](#secret)
     * [Invalidating](#invalidating)
     * [Deleting](#deleting)
-    * [Reuse client](#reuse-client)
   * [CLI](#cli)
     * [Help](#help)
     * [ccu_invalidate](#ccu_invalidate)
@@ -55,8 +54,6 @@ Or install it yourself as:
 gem install akamai_ccu
 ```
 
-## Usage
-
 ### 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.  
@@ -86,8 +83,10 @@ access_token = akab-access-token-xxx-xxx
 client_token = akab-client-token-xxx-xxx
 ```
 
-### Inside your script
-You can obviously use the gem directly inside your Ruby's script:
+## Usage
+
+### As library
+You can require the gem to use it as a library inside your scripts:
 
 #### Secret
 Once you've got APIs credentials, you can instantiate the secret object aimed to generate the authorization header:
@@ -104,8 +103,13 @@ secret = AkamaiCCU::Secret.by_txt("tokens.txt")
 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):
+```ruby
+AkamaiCCU::Wrapper.setup(secret)
+```
+
 #### Invalidating
-The CCU V3 APIs allow for invalidating the contents by URL or content provider (CP) code:
+The CCU V3 APIs allow for invalidating contents by URL or content provider (CP) code:
 ```ruby
 # invalidating resources on staging by url
 AkamaiCCU::Wrapper.invalidate_by_url(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/index.html], secret)
@@ -115,25 +119,13 @@ AkamaiCCU::Wrapper.invalidate_by_cpcode!([12345, 98765], secret)
 ```
 
 #### Deleting
-You can also delete the contents by URL or CP code, just be aware of the consequences:
+You can also delete contents by URL or CP code (just be aware of what you're doing):
 ```ruby
 # deleting resources on staging by CP code
 AkamaiCCU::Wrapper.delete_by_cpcode([12345, 98765], secret)
 
 # deleting resources on production (mind the "!") by url
-AkamaiCCU::Wrapper.delete_by_url!(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.js], secret)
-```
-
-#### Reuse client
-By default `Wrapper` class methods create a brand new Net::HTTP client on each call.  
-If this is an issue for you, you can use the `Wrapper#call` instance method and update the `endpoint` collaborator to switch API:
-```ruby
-wrapper = AkamaiCCU::Wrapper.new(secret: secret, endpoint: AkamaiCCU::Endpoint.by_name("invalidate_by_url"))
-wrapper.call(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.css])
-
-# switch to deleting on production
-wrapper.endpoint = AkamaiCCU::Endpoint.by_name("delete_by_cpcode!")
-wrapper.call([12345, 98765])
+AkamaiCCU::Wrapper.delete_by_url!(%w[https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js], secret)
 ```
 
 #### Response
@@ -166,7 +158,7 @@ Usage: invalidate --edgerc=./.edgerc --production --cp="12345, 98765"
 You can request for contents invalidation by calling:
 ```shell
 ccu_invalidate --edgerc=~/.edgerc \ 
-               --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.js \
+               --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js \
                --production
 ```
 
@@ -184,9 +176,9 @@ Just specify them on a separate file and use the bulk option:
 
 `urls.txt` file with each url/CP code specified on one line:
 ```txt
-https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.css
-https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.js
-https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/static/*.html
+https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css
+https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js
+https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/static/index.html
 ```
 
 Specify the bulk option by using the file path:
@@ -230,7 +222,7 @@ This command will delete by CP codes:
 ```shell
 ccu_delete --txt=~/tokens.txt \
            --cp=12345,98765
-           --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/*.js
+           --url=https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.css,https://akaa-baseurl-xxx-xxx.luna.akamaiapis.net/main.js
 ```
 
 ### Possible Issues

data/lib/akamai_ccu/cli.rb

@@ -22,7 +22,8 @@ module AkamaiCCU
       return @logger.warn("specify contents to purge by bulk, CP codes or urls") unless @objects
       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 = @wrapper_klass.new(secret: secret, endpoint: endpoint, headers: Array(@headers))
+      @wrapper_klass.setup(secret)
+      wrapper = @wrapper_klass.new(endpoint: endpoint, headers: Array(@headers))
       @logger.info wrapper.call(@objects).to_s
     end
 

data/lib/akamai_ccu/secret.rb

@@ -30,9 +30,10 @@ module AkamaiCCU
       end
     end
 
-    attr_reader :host, :max_body
+    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)
+    def initialize(client_secret:, host:, access_token:, client_token:, 
+                   max_body: 2048, nonce: SecureRandom.uuid, time: Time.now)
       @client_secret = client_secret
       @host = URI(host)
       @access_token = access_token
@@ -43,7 +44,9 @@ module AkamaiCCU
     end
 
     def touch
+      @nonce = SecureRandom.uuid
       @timestamp = AkamaiCCU.format_utc(Time.now)
+      self
     end
 
     def signed_key

data/lib/akamai_ccu/version.rb

@@ -1,3 +1,3 @@
 module AkamaiCCU
-  VERSION = "1.3.4"
+  VERSION = "1.3.5"
 end

data/lib/akamai_ccu/wrapper.rb

@@ -6,12 +6,19 @@ require "akamai_ccu/response"
 module AkamaiCCU
   class Wrapper
     class << self
+      attr_reader :secret, :client
+
+      def setup(secret, client_klass = Client)
+        @secret ||= secret
+        @client ||= client_klass.new(host: @secret.host)
+      end
+
       Endpoint::Network.constants.each do |network|
         Endpoint::Action.constants.each do |action|
           Endpoint::Mode.constants.each do |mode|
             endpoint = Endpoint.by_constants(network, action, mode)
-            define_method(endpoint.to_s) do |objects, secret, headers = [], &block|
-              wrapper = new(secret: secret, endpoint: endpoint, headers: headers)
+            define_method(endpoint.to_s) do |objects, headers = [], &block|
+              wrapper = new(endpoint: endpoint, headers: headers)
               block.call(wrapper) if block
               wrapper.call(objects)
             end
@@ -20,30 +27,21 @@ module AkamaiCCU
       end
     end
 
-    attr_accessor :endpoint, :client_klass, :signer_klass, :response_klass
+    attr_accessor :signer_klass, :response_klass
 
-    def initialize(secret:, endpoint:, headers: [],
-                   client_klass: Client, signer_klass: Signer, response_klass: Response)
-      @secret = secret
+    def initialize(endpoint:, headers: [], signer_klass: Signer, response_klass: Response)
       @endpoint = endpoint
-      @client_klass = client_klass
       @signer_klass = signer_klass
       @response_klass = response_klass
       @headers = headers
     end
 
-    def call(objects = [])
-      return if objects.empty?
-      res = client.call(path: @endpoint.path) do |request|
+    def call(objects)
+      res = self.class.client.call(path: @endpoint.path) do |request|
         request.body = { objects: objects }.to_json
-        @secret.touch
-        @signer_klass.new(request, @secret, @headers).call!
+        @signer_klass.new(request, self.class.secret.touch, @headers).call!
       end
       response_klass.factory(res.body)
     end
-
-    private def client
-      @client ||= @client_klass.new(host: @secret.host)
-    end
   end
 end

metadata

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