akamai_api 0.1.1 → 0.2.0

data/lib/akamai_api/ccu.rb

@@ -1,4 +1,9 @@
+require 'httparty'
 require 'active_support/core_ext'
+require 'akamai_api/ccu/response'
+require 'akamai_api/ccu/purge'
+require 'akamai_api/ccu/status'
+require 'akamai_api/ccu/purge_status'
 
 module AkamaiApi
   module Ccu
@@ -23,61 +28,20 @@ module AkamaiApi
     end
 
     def purge action, type, items, args = {}
-      validate_action action
-      validate_type type
-      options = ["action=#{action}", "type=#{type}"]
-      add_domain args[:domain], options
-      add_email args[:email], options
-      body = SoapBody.new do
-        string :name,    AkamaiApi.config[:auth].first
-        string :pwd,     AkamaiApi.config[:auth].last
-        string :network, ''
-        array  :opt,     options
-        array  :uri,     Array.wrap(items)
-      end
-      response = client.call :purge_request, :message => body.to_s
-      CcuResponse.new response, items
-    end
-
-    private
-
-    def validate_action action
-      unless %w[invalidate remove].include? action.to_s
-        raise UnrecognizedOption, "Unknown type '#{action}' (only 'remove' and 'invalidate' are allowed)"
-      end
-    end
-
-    def validate_type type
-      unless %w[cpcode arl].include? type.to_s
-        raise UnrecognizedOption, "Unknown type '#{type}' (only 'cpcode' and 'arl' are allowed)"
-      end
-    end
-
-    def add_domain domain, options
-      if domain.present?
-        unless %w[production staging].include? domain.to_s
-          raise "Unknown domain type '#{domain}' (only :production and :staging are allowed)"
-        end
-        options << "domain=#{domain}"
-      end
+      request = Purge::Request.new action, type, domain: args[:domain]
+      request.execute items
     end
 
-    def add_email email, options
-      if email.present?
-        emails = Array.wrap(email).join ','
-        options << "email-notification=#{emails}"
+    def status progress_uri = nil
+      if progress_uri.present?
+        PurgeStatus::Request.new.execute progress_uri
+      else
+        Status::Request.new.execute
       end
     end
 
-    def client
-      savon_args = {
-        :wsdl => File.expand_path('../../../wsdls/ccuapi.wsdl', __FILE__),
-        :namespaces => {
-          'xmlns:soapenc' => 'http://schemas.xmlsoap.org/soap/encoding/'
-        },
-        :log => AkamaiApi.config[:log]
-      }
-      Savon.client savon_args
+    def self.auth
+      { username: AkamaiApi.config[:auth].first, password: AkamaiApi.config[:auth].last }
     end
   end
 end

data/lib/akamai_api/cli/app.rb

@@ -2,7 +2,7 @@ module AkamaiApi
   module Cli
     class App < Thor
       desc 'ccu', 'CCU Interface'
-      subcommand 'ccu', AkamaiApi::Cli::Ccu
+      subcommand 'ccu', AkamaiApi::Cli::Ccu::Base
 
       desc 'eccu', 'ECCU Interface'
       subcommand 'eccu', AkamaiApi::Cli::Eccu
@@ -15,4 +15,4 @@ module AkamaiApi
       end
     end
   end
-end
+end

data/lib/akamai_api/cli/ccu/arl.rb

@@ -0,0 +1,36 @@
+module AkamaiApi::Cli::Ccu
+  class Arl < AkamaiApi::Cli::Command
+    namespace 'ccu arl'
+
+    desc 'remove http://john.com/a.txt http://www.smith.com/b.txt ...', 'Purge ARL(s) removing them from the cache'
+    method_option :domain,   :type => :string, :aliases => '-d',
+                  :banner => 'production|staging',
+                  :desc => 'Optional argument used to specify the environment. Usually you will not need this option'
+    method_option :banner => "foo@foo.com bar@bar.com",
+                  :desc => 'Email(s) used to send notification when the purge has been completed'
+    def remove(*arls)
+      purge_action :remove, arls
+    end
+
+    desc 'invalidate http://john.com/a.txt http://www.smith.com/b.txt ...', 'Purge ARL(s) marking their cache as expired'
+    method_option :domain,   :type => :string, :aliases => '-d',
+                  :banner => 'production|staging',
+                  :desc => 'Optional argument used to specify the environment. Usually you will not need this option'
+    method_option :banner => "foo@foo.com bar@bar.com",
+                  :desc => 'Email(s) used to send notification when the purge has been completed'
+    def invalidate(*arls)
+      purge_action :invalidate, arls
+    end
+
+    no_tasks do
+      def purge_action type, arls
+        raise 'You should provide at least one valid URL' if arls.blank?
+        load_config
+        res = AkamaiApi::Ccu.purge type, :arl, arls, :domain => options[:domain]
+        puts ::AkamaiApi::Cli::Ccu::PurgeRenderer.new(res).render
+      rescue AkamaiApi::Unauthorized
+        puts 'Your login credentials are invalid.'
+      end
+    end
+  end
+end

data/lib/akamai_api/cli/ccu/base.rb

@@ -0,0 +1,18 @@
+module AkamaiApi::Cli::Ccu
+  class Base < AkamaiApi::Cli::Command
+    desc 'cpcode', 'CP Code CCU actions'
+    subcommand 'cpcode', CpCode
+
+    desc 'arl', 'ARL CCU actions'
+    subcommand 'arl', Arl
+
+    desc 'status [progress_uri]', 'Show the CCU queue status if no progress_uri is given, or show a CCU Purge request status if a progress uri is given'
+    def status progress_uri = nil
+      load_config
+      response = AkamaiApi::Ccu.status progress_uri
+      puts StatusRenderer.new(response).render
+    rescue AkamaiApi::Unauthorized
+      puts 'Your login credentials are invalid.'
+    end
+  end
+end

data/lib/akamai_api/cli/ccu/cp_code.rb

@@ -0,0 +1,39 @@
+module AkamaiApi::Cli::Ccu
+  class CpCode < AkamaiApi::Cli::Command
+    namespace 'ccu cpcode'
+
+    desc 'remove CPCODE1 CPCODE2 ...', 'Purge CP Code(s) removing them from the cache'
+    method_option :domain,   :type => :string, :aliases => '-d',
+                  :banner => 'production|staging',
+                  :desc => 'Optional argument used to specify the environment. Usually you will not need this option'
+    method_option :banner => "foo@foo.com bar@bar.com",
+                  :desc => 'Email(s) used to send notification when the purge has been completed'
+    def remove(*cpcodes)
+      purge_action :remove, cpcodes
+    end
+
+    desc 'invalidate CPCODE1 CPCODE2 ...', 'Purge CP Code(s) marking their cache as expired'
+    method_option :domain,   :type => :string, :aliases => '-d',
+                  :banner => 'production|staging',
+                  :desc => 'Optional argument used to specify the environment. Usually you will not need this option'
+    method_option :banner => "foo@foo.com bar@bar.com",
+                  :desc => 'Email(s) used to send notification when the purge has been completed'
+    def invalidate(*cpcodes)
+      purge_action :invalidate, cpcodes
+    end
+
+    no_tasks do
+      def purge_action type, cpcodes
+        if cpcodes.blank?
+          puts 'You should provide at least one valid CP Code'
+          return
+        end
+        load_config
+        res = AkamaiApi::Ccu.purge type, :cpcode, cpcodes, :domain => options[:domain]
+        puts ::AkamaiApi::Cli::Ccu::PurgeRenderer.new(res).render
+      rescue AkamaiApi::Unauthorized
+        puts "Your login credentials are invalid."
+      end
+    end
+  end
+end

data/lib/akamai_api/cli/ccu/purge_renderer.rb

@@ -0,0 +1,49 @@
+module AkamaiApi::Cli::Ccu
+  class PurgeRenderer
+    attr_reader :response
+
+    def initialize response
+      @response = response
+    end
+
+    def render
+      [
+        "----------",
+        render_response,
+        "----------"
+      ].join "\n"
+    end
+
+    def render_response
+      if response.code == 201
+        render_successful_response
+      else
+        render_error_response
+      end
+    end
+
+    def render_error_response
+      [
+        "There was an error processing your request:",
+        "\t* Result: #{response.code} - #{response.title} (#{response.message})",
+        "\t* Described by: #{response.described_by}"
+      ]
+    end
+
+    def render_successful_response
+      result = [
+        "Purge request successfully submitted:",
+        "\t* Result: #{response.code} - #{response.message}",
+        "\t* Purge ID: #{response.purge_id} | Support ID: #{response.support_id}"
+      ]
+      if response.time_to_wait
+        result.concat [
+          "\t* Estimated time: #{response.estimated_time} secs.",
+          "\t* Progress URI: #{response.uri}",
+          "\t* Time to wait before check: #{response.time_to_wait} secs.",
+        ]
+      end
+      result
+    end
+  end
+end

data/lib/akamai_api/cli/ccu/status_renderer.rb

@@ -0,0 +1,69 @@
+module AkamaiApi::Cli::Ccu
+  class StatusRenderer
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def render
+      res = response.is_a?(AkamaiApi::Ccu::Status::Response) ? render_status : render_purge_status
+      [
+        '----------',
+        res,
+        '----------'
+      ].join "\n"
+    end
+
+    def render_status
+      [
+        "Akamai CCU Queue Status",
+        "\t* Result: #{response.code} - #{response.message}",
+        "\t* Support ID: #{response.support_id}",
+        "\t* Queue Length: #{response.queue_length}"
+      ].join "\n"
+    end
+
+    def render_purge_status
+      if response.is_a? AkamaiApi::Ccu::PurgeStatus::SuccessfulResponse
+        render_successful_purge_status
+      else
+        render_not_found_purge_status
+      end
+    end
+
+    def render_successful_purge_status
+      output = [
+        successful_purge_status_description,
+        "\t* Result: #{response.code} - #{response.status}",
+        "\t* Purge ID: #{response.purge_id} | Support ID: #{response.support_id}",
+        "\t* Submitted by: #{response.submitted_by} on #{response.submitted_at}"
+      ]
+      if response.completed_at
+        output << "\t* Completed on: #{response.completed_at}"
+      else
+        output << "\t* Estimated time: #{response.estimated_time} secs."
+        output << "\t* Queue length: #{response.queue_length}"
+        output << "\t* Time to wait before next check: #{response.time_to_wait} secs."
+      end
+      output.join "\n"
+    end
+
+    def successful_purge_status_description
+      if response.completed_at
+        "Purge request has been successfully completed:"
+      else
+        "Purge request is currently enqueued:"
+      end
+    end
+
+    def render_not_found_purge_status
+      [
+        "No purge request found using #{response.progress_uri}:",
+        "\t* Result: #{response.code} - #{response.message}",
+        "\t* Purge ID: #{response.purge_id} | Support ID: #{response.support_id}",
+        "\t* Time to wait before next check: #{response.time_to_wait} secs."
+      ].join "\n"
+    end
+  end
+end

data/lib/akamai_api/cli/ccu.rb

@@ -1,11 +1,6 @@
-module AkamaiApi
-  module Cli
-    class Ccu < Command
-      desc 'cpcode', 'CP Code CCU actions'
-      subcommand 'cpcode', CcuCpCode
+%w(cp_code arl status_renderer purge_renderer base).each do |file|
+  require File.expand_path "../ccu/#{file}", __FILE__
+end
 
-      desc 'arl', 'ARL CCU actions'
-      subcommand 'arl', CcuArl
-    end
-  end
-end
+module AkamaiApi::Cli::Ccu
+end

data/lib/akamai_api/cli/eccu/entry_renderer.rb

@@ -0,0 +1,63 @@
+class AkamaiApi::Cli::Eccu
+  class EntryRenderer
+
+    def self.render entries
+      output = ["----------"]
+      entries.each do |e|
+        output.concat new(e).render_entry
+        output << "----------"
+      end
+      output.join "\n"
+    end
+
+    attr_reader :entry
+
+    def initialize entry
+      @entry = entry
+    end
+
+    def render
+      [
+        "----------",
+        render_entry,
+        "----------"
+      ].join "\n"
+    end
+
+    def render_entry
+      output = [
+        "* Code    : #{entry.code}",
+        entry_status,
+        "            #{entry.status[:update_date]}",
+        entry_property
+      ]
+      output << "* Notes   : #{entry.notes}" if entry.notes.present?
+      output << "* Email   : #{entry.email}" if entry.email
+      output << "* Uploaded by #{entry.uploaded_by} on #{entry.upload_date}"
+      output << "* Content:\n#{entry.file[:content]}" if entry.file[:content].present?
+      output
+    end
+
+    private
+
+    def entry_property
+      base = "* Property: #{entry.property[:name]} (#{entry.property[:type]})"
+      if entry.property[:exact_match]
+        [
+          base,
+          "            with exact match"
+        ].join "\n"
+      else
+        base
+      end
+    end
+
+    def entry_status
+      if entry.status[:extended].present?
+        "* Status  : #{entry.status[:code]} - #{entry.status[:extended]}"
+      else
+        "* Status  : #{entry.status[:code]}"
+      end
+    end
+  end
+end

data/lib/akamai_api/cli/eccu.rb

@@ -7,11 +7,9 @@ module AkamaiApi
       def requests
         load_config
         requests = AkamaiApi::EccuRequest.all :verbose => options[:content]
-        requests.each do |request|
-          puts '------------'
-          puts AkamaiApi::Cli::Template.eccu_request request
-        end
-        puts '------------'
+        puts EntryRenderer.render requests
+      rescue ::AkamaiApi::Unauthorized
+        puts "Your login credentials are invalid."
       end
 
       desc 'last_request', 'Print the last request made to ECCU'
@@ -19,10 +17,10 @@ module AkamaiApi
                     :desc => 'Print request content too'
       def last_request
         load_config
-        request = AkamaiApi::EccuRequest.last :verbose => options[:content]
-        puts '------------'
-        puts AkamaiApi::Cli::Template.eccu_request request
-        puts '------------'
+        request = AkamaiApi::EccuRequest.last verbose: options[:content]
+        puts EntryRenderer.new(request).render
+      rescue ::AkamaiApi::Unauthorized
+        puts "Your login credentials are invalid."
       end
 
       desc 'publish_xml path/to/request.xml john.com', 'Publish a request made in XML for the specified Digital Property (usually the Host Header)'
@@ -46,11 +44,15 @@ module AkamaiApi
           :emails => options[:emails]
         }
         id = AkamaiApi::EccuRequest.publish_file property, source, args
-        puts 'Request correctly published. Details:'
-        puts '------------'
-        puts AkamaiApi::Cli::Template.eccu_request AkamaiApi::EccuRequest.find id, :verbose => true
-        puts '------------'
+        puts "Request correctly published:"
+        puts EntryRenderer.new(AkamaiApi::EccuRequest.find(id, :verbose => true)).render
+      rescue ::AkamaiApi::Unauthorized
+        puts "Your login credentials are invalid."
+      rescue Savon::SOAPFault
+        puts $!.message
       end
     end
   end
-end
+end
+
+require File.expand_path '../eccu/entry_renderer', __FILE__

data/lib/akamai_api/cli.rb

@@ -1,3 +1,8 @@
-%w(template command ccu_cp_code ccu_arl ccu eccu app).each do |file|
+require 'thor'
+
+%w(command ccu eccu app).each do |file|
   require File.expand_path "../cli/#{file}", __FILE__
-end
+end
+
+module AkamaiApi::Cli
+end

data/lib/akamai_api/eccu_request.rb

@@ -17,6 +17,9 @@ module AkamaiApi
       resp = client.call :set_notes, :message => body.to_s
       self.notes = notes
       resp.body[:set_notes_response][:success]
+    rescue Savon::HTTPError => e
+      raise ::AkamaiApi::Unauthorized if e.http.code == 401
+      raise
     end
 
     def update_email! email
@@ -29,6 +32,9 @@ module AkamaiApi
       successful = response.body[:set_status_change_email_response][:success]
       self.email = email if successful
       successful
+    rescue Savon::HTTPError => e
+      raise ::AkamaiApi::Unauthorized if e.http.code == 401
+      raise
     end
 
     def destroy
@@ -38,11 +44,17 @@ module AkamaiApi
       end
       response = client.call :delete, :message => body.to_s
       response.body[:delete_response][:success]
+    rescue Savon::HTTPError => e
+      raise ::AkamaiApi::Unauthorized if e.http.code == 401
+      raise
     end
 
     class << self
       def all_ids
         client.call(:get_ids).body[:get_ids_response][:file_ids][:file_ids]
+      rescue Savon::HTTPError => e
+        raise ::AkamaiApi::Unauthorized if e.http.code == 401
+        raise
       end
 
       def all args = {}
@@ -89,6 +101,9 @@ module AkamaiApi
           :uploaded_by => get_if_kind(response_body[:uploaded_by], String),
           :version_string => get_if_kind(response_body[:version_string], String)
         })
+      rescue Savon::HTTPError => e
+        raise ::AkamaiApi::Unauthorized if e.http.code == 401
+        raise
       end
 
       def publish_file property, file_name, args = {}
@@ -100,6 +115,9 @@ module AkamaiApi
         body = build_publish_soap_body property, content, args
         resp = client.call :upload, :message_tag => 'upload', :message => body.to_s
         resp.body[:upload_response][:file_id].to_i
+      rescue Savon::HTTPError => e
+        raise ::AkamaiApi::Unauthorized if e.http.code == 401
+        raise
       end
 
       private
@@ -142,4 +160,4 @@ module AkamaiApi
       self.class.send(:client)
     end
   end
-end
+end

data/lib/akamai_api/version.rb

@@ -1,3 +1,3 @@
 module AkamaiApi
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/akamai_api.rb

@@ -1,9 +1,11 @@
 require 'savon'
 
-%w(version cp_code soap_body ccu_response ccu eccu_request).each do |file|
+%w(version soap_body ccu eccu_request).each do |file|
   require "akamai_api/#{file}"
 end
 
 module AkamaiApi
+  class Unauthorized < StandardError; end
+
   def self.config; @config ||= { :auth => ['', ''], :log => false }; end
 end

data/spec/features/ccu/purge_request_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe 'Given I request to purge an asset' do
+  subject { AkamaiApi::Ccu }
+
+  shared_examples 'purge helper' do
+    let(:method) { "#{action}_#{type}" }
+
+    it 'responds with a PurgeResponse object' do
+      VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/single_item" do
+        subject.send(method, items).should be_a AkamaiApi::Ccu::Purge::Response
+      end
+    end
+
+    it 'raises error when user is not authorized' do
+      VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/invalid_credentials" do
+        AkamaiApi::Ccu.stub auth: { username: 'foo', password: 'bar' }
+        expect { subject.send(method, items) }.to raise_error AkamaiApi::Unauthorized
+      end
+    end
+
+    it 'returns a different response when data are invalid' do
+      VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/invalid_item" do
+        response = subject.send(method, items)
+        expect(response).to be_a AkamaiApi::Ccu::Purge::Response
+        expect(response.code).to eq 403
+      end
+    end
+
+    describe 'when data are correct' do
+      it 'returns the expected response code' do
+        VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/single_item" do
+          subject.send(method, items).code.should == 201
+        end
+      end
+
+      it 'returns a successful message' do
+        VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/single_item" do
+          subject.send(method, items).message.should == 'Request accepted.'
+        end
+      end
+
+      it 'returns a unique purge id' do
+        VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/single_item" do
+          subject.send(method, items).purge_id.should == '12345678-1234-1234-1234-123456789012'
+        end
+      end
+
+      it 'returns a unique support id' do
+        VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/single_item" do
+          subject.send(method, items).support_id.should == '12345678901234567890-123456789'
+        end
+      end
+
+      it 'returns the estimated time in seconds' do
+        VCR.use_cassette "akamai_api_ccu_#{type}_#{action}/single_item" do
+          subject.send(method, items).estimated_time.should == 420
+        end
+      end
+    end
+  end
+
+  context 'when this asset is an ARL and I want to invalidate it' do
+    let(:action) { 'invalidate' }
+    let(:type) { 'arl' }
+    let(:items) { ['http://www.foo.bar/t.txt'] }
+
+    it_should_behave_like 'purge helper'
+  end
+
+  context 'when this asset is a CPCode and I want to invalidate it' do
+    let(:action) { 'invalidate' }
+    let(:type) { 'cpcode' }
+    let(:items) { ['12345'] }
+
+    it_should_behave_like 'purge helper'
+  end
+
+  context 'when this asset is an ARL and I want to remove it' do
+    let(:action) { 'remove' }
+    let(:type) { 'arl' }
+    let(:items) { ['http://www.foo.bar/t.txt'] }
+
+    it_should_behave_like 'purge helper'
+  end
+
+  context 'when this asset is a CPCode and I want to remove it' do
+    let(:action) { 'remove' }
+    let(:type) { 'cpcode' }
+    let(:items) { ['12345'] }
+
+    it_should_behave_like 'purge helper'
+  end
+end

data/spec/features/ccu/purge_status_request_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe "Given I request a purge status" do
+  subject { AkamaiApi::Ccu }
+
+  context "when login credentials are ok and progress uri is valid", vcr: { cassette_name: "akamai_api_ccu_purge_status/completed_request" } do
+    let(:progress_uri) { '/ccu/v2/purges/12345678-1234-5678-1234-123456789012' }
+
+    it "responds with a PurgeStatusResponse object" do
+      expect(subject.status progress_uri).to be_a AkamaiApi::Ccu::PurgeStatus::SuccessfulResponse
+    end
+  end
+
+  context "when login credentials are invalid", vcr: { cassette_name: "akamai_api_ccu_purge_status/invalid_credentials" } do
+    let(:progress_uri) { '/ccu/v2/purges/12345678-1234-5678-1234-123456789012' }
+
+    before do
+      AkamaiApi::Ccu.stub auth: { username: 'foo', password: 'bar' }
+    end
+
+    it "raises an error" do
+      expect { subject.status progress_uri }.to raise_error AkamaiApi::Unauthorized
+    end
+  end
+
+  context "when the given progress uri is invalid", vcr: { cassette_name: "akamai_api_ccu_purge_status/not_found_request" } do
+    it "returns a correct response" do
+      expect(subject.status 'foobarbaz').to be_a AkamaiApi::Ccu::PurgeStatus::NotFoundResponse
+    end
+  end
+end