akamai_api 0.1.1 → 0.2.0

data/features/ccu_purge_status.feature

@@ -0,0 +1,83 @@
+Feature: akamai_api ccu purge status
+  In order to get the status of an Akamai CCU request
+  As a CLI user
+
+  @vcr
+  Scenario: invalid credentials
+    When I run `akamai_api ccu status 12345678-1234-5678-1234-123456789012 -u foo -p bar`
+    Then the output should contain:
+      """
+      Your login credentials are invalid.
+      """
+
+  @vcr
+  Scenario: completed request
+    When I run `akamai_api ccu status /ccu/v2/purges/12345678-1234-5678-1234-123456789012`
+    Then the output should contain:
+      """
+      Purge request has been successfully completed:
+      """
+    And the output should contain:
+      """
+      * Result: 200 - Done
+      """
+    And the output should contain:
+      """
+      * Purge ID: 12345678-1234-5678-1234-123456789012 | Support ID: 12345678901234567890-123456789
+      """
+    And the output should contain:
+      """
+      * Submitted by: test1 on 2014-05-20 08:19:21 UTC
+      """
+    And the output should contain:
+      """
+      * Completed on: 2014-05-20 08:22:20 UTC
+      """
+
+  @vcr
+  Scenario: enqueued request
+    When I run `akamai_api ccu status ccu/v2/purges/12345678-1234-5678-1234-123456789012`
+    Then the output should contain:
+      """
+      Purge request is currently enqueued:
+      """
+    And the output should contain:
+      """
+      Result: 200 - In-Progress
+      """
+    And the output should contain:
+      """
+      * Purge ID: 12345678-1234-5678-1234-123456789012 | Support ID: 12345678901234567890-123456789
+      """
+    And the output should contain:
+      """
+      * Submitted by: test1 on 2014-05-20 08:19:21 UTC
+      """
+    And the output should contain:
+      """
+      * Time to wait before next check: 60 secs.
+      """
+    And the output should not contain:
+      """
+      * Completed on
+      """
+
+  @vcr
+  Scenario: not found request
+    When I run `akamai_api ccu status foobarbaz`
+    Then the output should contain:
+      """
+      No purge request found using /ccu/v2/purges/foobarbaz:
+      """
+    And the output should contain:
+      """
+      Result: 200 - Please note that it can take up to a minute for the status of a recently submitted request to become visible.
+      """
+    And the output should contain:
+      """
+      * Purge ID: foobarbaz | Support ID: 12345678901234567890-123456789
+      """
+    And the output should contain:
+      """
+      * Time to wait before next check: 60 secs.
+      """

data/features/ccu_status.feature

@@ -0,0 +1,31 @@
+Feature: akamai_api ccu status
+  In order to get the Akamai CCU queue status
+  As a CLI user
+
+  @vcr
+  Scenario: invalid credentials
+    When I run `akamai_api ccu status -u foo -p bar`
+    Then the output should contain:
+      """
+      Your login credentials are invalid.
+      """
+
+  @vcr
+  Scenario: valid credentials
+    When I run `akamai_api ccu status`
+    Then the output should contain:
+      """
+      Akamai CCU Queue Status
+      """
+    And the output should contain:
+      """
+      * Result: 200 - The queue may take a minute to reflect new or removed requests.
+      """
+    And the output should contain:
+      """
+      * Support ID: 12345678901234567890-123456789
+      """
+    And the output should contain:
+      """
+      * Queue Length: 0
+      """

data/features/eccu_last_request.feature

@@ -0,0 +1,47 @@
+Feature: akamai_api eccu last_request
+  In order to get the last request made through ECCU
+  As a CLI user
+
+  @vcr
+  Scenario: invalid credentials
+    When I run `akamai_api eccu last_request -u foo -p bar`
+    Then the output should contain:
+      """
+      Your login credentials are invalid.
+      """
+
+  @vcr
+  Scenario: valid credentials
+    When I run `akamai_api eccu last_request`
+    Then the output should contain:
+      """
+      * Code    : 115942214\n
+      """
+    And the output should contain:
+      """
+      * Status  : 4000 - File successfully deployed to Akamai network (Succeeded)
+      """
+    And the output should contain:
+      """
+      2014-05-19T16:27:34.512Z
+      """
+    And the output should contain:
+      """
+      * Property: foo.com (hostheader)
+      """
+    And the output should contain:
+      """
+      with exact match
+      """
+    And the output should contain:
+      """
+      * Notes   : ECCU Request using EdgeControl
+      """
+    And the output should contain:
+      """
+      * Email   : guest@mikamai.com
+      """
+    And the output should contain:
+      """
+      * Uploaded by test1 on 2014-05-19T15:30:13.512Z
+      """

data/features/eccu_publish.feature

@@ -0,0 +1,98 @@
+Feature: akamai_api eccu publish
+  In order to publish a purge request via ECCU
+  As a CLI user
+
+  @vcr
+  Scenario: invalid credentials
+    Given a file named "publish.xml" with:
+      """
+      <?xml version="1.0"?>
+      <eccu>
+        <match:recursive-dirs value="foo" >
+          <match:recursive-dirs value="bar" >
+            <match:recursive-dirs value="baz.jpg" >
+              <revalidate>now</revalidate>
+            </match:recursive-dirs>
+          </match:recursive-dirs>
+        </match:recursive-dirs>
+      </eccu>
+      """
+    When I run `akamai_api eccu publish_xml ./publish.xml foo.com -u foo -p bar`
+    Then the output should contain:
+      """
+      Your login credentials are invalid.
+      """
+
+  @vcr
+  Scenario: invalid domain
+    Given a file named "publish.xml" with:
+      """
+      <?xml version="1.0"?>
+      <eccu>
+        <match:recursive-dirs value="foo" >
+          <match:recursive-dirs value="bar" >
+            <match:recursive-dirs value="baz.jpg" >
+              <revalidate>now</revalidate>
+            </match:recursive-dirs>
+          </match:recursive-dirs>
+        </match:recursive-dirs>
+      </eccu>
+      """
+    When I run `akamai_api eccu publish_xml ./publish.xml john.smith.com`
+    Then the output should contain:
+      """
+      ECCU validation failed: You are not authorized to specify this digital property
+      """
+
+  @vcr
+  Scenario: successful
+    Given a file named "publish.xml" with:
+      """
+      <?xml version="1.0"?>
+      <eccu>
+        <match:recursive-dirs value="foo" >
+          <match:recursive-dirs value="bar" >
+            <match:recursive-dirs value="baz.jpg" >
+              <revalidate>now</revalidate>
+            </match:recursive-dirs>
+          </match:recursive-dirs>
+        </match:recursive-dirs>
+      </eccu>
+      """
+    When I run `akamai_api eccu publish_xml ./publish.xml foo.com`
+    Then the output should contain:
+      """
+      Request correctly published
+      """
+    And the output should contain:
+      """
+      * Code    : 116073578
+      """
+    And the output should contain:
+      """
+      * Status  : 1000
+      """
+    And the output should contain:
+      """
+      2014-05-20T16:49:29.026Z
+      """
+    And the output should contain:
+      """
+      * Property: foo.com (hostheader)
+      """
+    And the output should contain:
+      """
+      with exact match
+      """
+    And the output should contain:
+      """
+      * Notes   : ECCU Request using AkamaiApi gem
+      """
+    And the output should contain:
+      """
+      * Uploaded by test1 on 2014-05-20T16:49:29.026Z
+      """
+    And the output should contain:
+      """
+      Content:
+      """

data/features/eccu_requests.feature

@@ -0,0 +1,43 @@
+Feature: akamai_api eccu requests
+  In order to get the list of the last requests made through ECCU
+  As a CLI user
+
+  @vcr
+  Scenario: invalid credentials
+    When I run `akamai_api eccu requests -u foo -p bar`
+    Then the output should contain:
+      """
+      Your login credentials are invalid.
+      """
+
+  @vcr
+  Scenario: valid credentials
+    When I run `akamai_api eccu requests`
+    Then the output should contain 4 times:
+      """
+      * Status
+      """
+    Then the output should contain:
+      """
+      * Code    : 112714868
+      """
+    And the output should contain 4 times:
+      """
+      * Status  : 4000 - File successfully deployed to Akamai network (Succeeded)
+      """
+    And the output should contain 3 times:
+      """
+      * Property: foo.com (hostheader)
+      """
+    And the output should contain 4 times:
+      """
+      with exact match
+      """
+    And the output should contain 4 times:
+      """
+      * Notes   : ECCU Request using EdgeControl
+      """
+    And the output should contain 4 times:
+      """
+      * Email   : guest@mikamai.com
+      """

data/features/step_definitions/contain_multiple_times_steps.rb

@@ -0,0 +1,3 @@
+Then /^the output should contain (\d+) times:$/ do |times, content|
+  expect(all_output.scan(content).count).to eq times.to_i
+end

data/features/support/env.rb

@@ -0,0 +1,58 @@
+require 'akamai_api'
+require 'akamai_api/cli'
+require 'aruba'
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'vcr'
+require 'webmock'
+
+require File.expand_path '../../../spec/auth', __FILE__
+ENV['AKAMAI_USERNAME'], ENV['AKAMAI_PASSWORD'] = AkamaiApi.config[:auth]
+
+VCR.cucumber_tags do |t|
+  t.tag '@vcr', use_scenario_name: true
+end
+
+VCR.configure do |c|
+  c.hook_into :webmock
+  c.cassette_library_dir = 'cassettes'
+  c.default_cassette_options = {
+    record: :once
+  }
+  c.after_http_request do |request|
+    request.uri.gsub! ENV['AKAMAI_USERNAME'], 'USERNAME'
+    request.uri.gsub! ENV['AKAMAI_PASSWORD'], 'PASSWORD'
+  end
+  c.before_playback do |i|
+    i.request.uri.gsub! 'USERNAME', ENV['AKAMAI_USERNAME']
+    i.request.uri.gsub! 'PASSWORD', ENV['AKAMAI_PASSWORD']
+  end
+end
+
+class VcrFriendlyCLI
+  def initialize(argv, stdin=STDIN, stdout=STDOUT, stderr=STDERR, kernel=Kernel)
+    @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+  end
+
+  def execute!
+    $stdin = @stdin
+    $stdout = @stdout
+    @kernel.exit AkamaiApi::Cli::App.start(@argv.dup)
+  end
+end
+
+Before do
+  @aruba_timeout_seconds = 30
+end
+
+Before('@vcr') do
+  Aruba::InProcess.main_class = VcrFriendlyCLI
+  Aruba.process = Aruba::InProcess
+end
+
+After('@vcr') do
+  Aruba.process = Aruba::SpawnProcess
+  VCR.eject_cassette
+  $stdin = STDIN
+  $stdout = STDOUT
+end

data/lib/akamai_api/ccu/purge/request.rb

@@ -0,0 +1,76 @@
+module AkamaiApi::Ccu::Purge
+  class Request
+    include HTTParty
+    format :json
+    base_uri 'https://api.ccu.akamai.com/ccu/v2/queues/default'
+    headers 'Content-Type' => 'application/json'
+
+    attr_reader :type, :action, :domain
+
+    def initialize action = 'remove', type = 'arl', args = {}
+      self.action = action
+      self.type   = type
+      self.domain = args[:domain] || 'production'
+    end
+
+    def action= value
+      raise_unrecognized_action(value) unless valid_action?(value)
+      @action = value
+    end
+
+    def type= value
+      raise_unrecognized_type(value) unless valid_type?(value)
+      @type = value
+    end
+
+    def domain= value
+      raise_unrecognized_domain(value) unless valid_domain?(value)
+      @domain = value
+    end
+
+    def execute *items
+      items = Array.wrap(items.first) if items.length == 1
+      response = self.class.post('/', basic_auth: auth, body: request_body(items))
+      parse_response response
+    end
+
+    def auth
+      AkamaiApi::Ccu.auth
+    end
+
+    def request_body items
+      { type: type, action: action, domain: domain, objects: items }.to_json
+    end
+
+    private
+
+    def parse_response response
+      raise ::AkamaiApi::Unauthorized if response.code == 401
+      Response.new response.parsed_response
+    end
+
+    def raise_unrecognized_action bad_action
+      raise ::AkamaiApi::Ccu::UnrecognizedOption, "Unknown action '#{bad_action}' (allowed values: invalidate, remove)"
+    end
+
+    def raise_unrecognized_type bad_type
+      raise ::AkamaiApi::Ccu::UnrecognizedOption, "Unknown type '#{bad_type}' (allowed values: arl, cpcode)"
+    end
+
+    def raise_unrecognized_domain bad_domain
+      raise ::AkamaiApi::Ccu::UnrecognizedOption, "Unknown domain '#{bad_domain}' (allowed_values: production, staging)"
+    end
+
+    def valid_action? action
+      %w(invalidate remove).include? action.to_s
+    end
+
+    def valid_type? type
+      %w(arl cpcode).include? type.to_s
+    end
+
+    def valid_domain? domain
+      %w(production staging).include? domain.to_s
+    end
+  end
+end

data/lib/akamai_api/ccu/purge/response.rb

@@ -0,0 +1,31 @@
+module AkamaiApi::Ccu::Purge
+  class Response < ::AkamaiApi::Ccu::Response
+    def described_by
+      raw['describedBy']
+    end
+
+    def title
+      raw['title']
+    end
+
+    def time_to_wait
+      raw['pingAfterSeconds']
+    end
+
+    def purge_id
+      raw['purgeId']
+    end
+
+    def message
+      raw['detail']
+    end
+
+    def estimated_time
+      raw['estimatedSeconds']
+    end
+
+    def uri
+      raw['progressUri']
+    end
+  end
+end

data/lib/akamai_api/ccu/purge.rb

@@ -0,0 +1,5 @@
+require File.expand_path '../purge/request', __FILE__
+require File.expand_path '../purge/response', __FILE__
+
+module AkamaiApi::Ccu::Purge
+end

data/lib/akamai_api/ccu/purge_status/not_found_response.rb

@@ -0,0 +1,9 @@
+require File.expand_path '../response', __FILE__
+
+module AkamaiApi::Ccu::PurgeStatus
+  class NotFoundResponse < Response
+    def message
+      raw['detail']
+    end
+  end
+end

data/lib/akamai_api/ccu/purge_status/request.rb

@@ -0,0 +1,32 @@
+module AkamaiApi::Ccu::PurgeStatus
+  class Request
+    include HTTParty
+    format :json
+    base_uri 'https://api.ccu.akamai.com'
+
+    def execute progress_uri
+      response = self.class.get normalize_progress_uri(progress_uri), basic_auth: auth
+      parse_response response
+    end
+
+    def auth
+      AkamaiApi::Ccu.auth
+    end
+
+    private
+
+    def parse_response response
+      raise AkamaiApi::Unauthorized if response.code == 401
+      AkamaiApi::Ccu::PurgeStatus.build_response response.parsed_response
+    end
+
+    def normalize_progress_uri progress_uri
+      progress_uri = "/#{progress_uri}" unless progress_uri =~ /^\//
+      if progress_uri =~ /\/ccu\/v2\/purges\//
+        progress_uri
+      else
+        "/ccu/v2/purges#{progress_uri}"
+      end
+    end
+  end
+end

data/lib/akamai_api/ccu/purge_status/response.rb

@@ -0,0 +1,19 @@
+module AkamaiApi::Ccu::PurgeStatus
+  class Response < ::AkamaiApi::Ccu::Response
+    def progress_uri
+      raw['progressUri']
+    end
+
+    def purge_id
+      raw['purgeId']
+    end
+
+    def status
+      raw['purgeStatus']
+    end
+
+    def time_to_wait
+      raw['pingAfterSeconds']
+    end
+  end
+end

data/lib/akamai_api/ccu/purge_status/successful_response.rb

@@ -0,0 +1,25 @@
+require File.expand_path '../response', __FILE__
+
+module AkamaiApi::Ccu::PurgeStatus
+  class SuccessfulResponse < Response
+    def estimated_time
+      raw['originalEstimatedSeconds']
+    end
+
+    def queue_length
+      raw['originalQueueLength']
+    end
+
+    def completed_at
+      raw['completionTime'] && Time.iso8601(raw['completionTime'])
+    end
+
+    def submitted_by
+      raw['submittedBy']
+    end
+
+    def submitted_at
+      raw['submissionTime'] && Time.iso8601(raw['submissionTime'])
+    end
+  end
+end

data/lib/akamai_api/ccu/purge_status.rb

@@ -0,0 +1,10 @@
+module AkamaiApi::Ccu::PurgeStatus
+  def self.build_response parsed_response
+    response_class = parsed_response['submittedBy'] ? SuccessfulResponse : NotFoundResponse
+    response_class.new parsed_response
+  end
+end
+
+require File.expand_path '../purge_status/request', __FILE__
+require File.expand_path '../purge_status/successful_response', __FILE__
+require File.expand_path '../purge_status/not_found_response', __FILE__

data/lib/akamai_api/ccu/response.rb

@@ -0,0 +1,18 @@
+module AkamaiApi::Ccu
+  class Response
+    attr_reader :raw
+
+    def initialize raw
+      @raw = raw
+    end
+
+    def support_id
+      raw['supportId']
+    end
+
+    def code
+      raw['httpStatus']
+    end
+    alias :http_status :code
+  end
+end

data/lib/akamai_api/ccu/status/request.rb

@@ -0,0 +1,23 @@
+module AkamaiApi::Ccu::Status
+  class Request
+    include HTTParty
+    format :json
+    base_uri 'https://api.ccu.akamai.com/ccu/v2/queues/default'
+
+    def execute
+      response = self.class.get('/', basic_auth: auth)
+      parse_response response
+    end
+
+    private
+
+    def auth
+      AkamaiApi::Ccu.auth
+    end
+
+    def parse_response response
+      raise AkamaiApi::Unauthorized if response.code == 401
+      AkamaiApi::Ccu::Status::Response.new response.parsed_response
+    end
+  end
+end

data/lib/akamai_api/ccu/status/response.rb

@@ -0,0 +1,11 @@
+module AkamaiApi::Ccu::Status
+  class Response < ::AkamaiApi::Ccu::Response
+    def queue_length
+      raw['queueLength']
+    end
+
+    def message
+      raw['detail']
+    end
+  end
+end

data/lib/akamai_api/ccu/status.rb

@@ -0,0 +1,2 @@
+require File.expand_path '../status/request', __FILE__
+require File.expand_path '../status/response', __FILE__