akamai_api 0.2.0 → 0.3.0

data/lib/akamai_api/cli.rb

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

data/lib/akamai_api/eccu/base_edit_request.rb

@@ -0,0 +1,51 @@
+require "akamai_api/eccu/base_request"
+require "akamai_api/eccu/not_found"
+require "akamai_api/eccu/soap_body"
+
+module AkamaiApi::ECCU
+  # @abstract
+  #
+  # This class is intended as a generic superclass for all requests that operate on an existing
+  # purge request submitted through the Akamai ECCU interface.
+  class BaseEditRequest < BaseRequest
+    # ECCU Request code
+    # @return [String] request code
+    attr_reader :code
+
+    # @param code ECCU request code
+    def initialize code
+      @code = code.to_i
+    end
+
+    protected
+
+    # Creates the request body filling it with all necessary arguments
+    #
+    # The base implementation fills only the request code. If the request needs additional
+    # arguments you'll want to overwrite it like the following:
+    #   class MyCustomRequest < AkamaiApi::ECCU::BaseEditRequest
+    #     def request_body code, name, surname
+    #       super code do |block|
+    #         block.string(:name, name).string(:surname, surname)
+    #       end
+    #     end
+    #   end
+    # @return [SoapBody]
+    def request_body *args, &block
+      SoapBody.new.tap do |block|
+        block.integer :fileId, code
+        yield block if block_given?
+      end
+    end
+
+    # Wrapper method that you can use inside your custom ECCU request to handle common errors
+    # @raise [AkamaiApi::Unauthorized] when login credentials are invalid
+    # @raise [AkamaiApi::ECCU::NotFound] when no request can be found with the given code
+    def with_soap_error_handling &block
+      super
+    rescue Savon::SOAPFault => e
+      e = ::AkamaiApi::ECCU::NotFound if e.to_hash[:fault][:faultstring] =~ /fileId .* does not exist/
+      raise e
+    end
+  end
+end

data/lib/akamai_api/eccu/base_request.rb

@@ -0,0 +1,32 @@
+require "akamai_api/unauthorized"
+
+module AkamaiApi::ECCU
+  # @abstract
+  #
+  # This class is intended as a generic superclass for all the specific requests that can be used
+  # with the Akamai ECCU interface
+  class BaseRequest
+    protected
+
+    # Wrapper method that you can use inside your custom ECCU request to handle common errors
+    # @raise [AkamaiApi::Unauthorized] when login credentials are invalid
+    def with_soap_error_handling &block
+      yield
+    rescue Savon::HTTPError => e
+      e = ::AkamaiApi::Unauthorized if e.http.code == 401
+      raise e
+    end
+
+    # Executes a method via Savon and returns the response
+    # @param [String] method method name to call
+    # @param args additional arguments to pass to savon when calling the method
+    # @return [Object] the object containing the received response
+    def client_call method, *args
+      client.call(method, *args).body["#{method}_response".to_sym]
+    end
+
+    def client
+      AkamaiApi::ECCU.client
+    end
+  end
+end

data/lib/akamai_api/eccu/destroy_request.rb

@@ -0,0 +1,30 @@
+require "akamai_api/eccu/base_edit_request"
+
+module AkamaiApi::ECCU
+  # The {DestroyRequest} class is used to delete an ECCU request.
+  #
+  # @example
+  #   AkamaiApi::ECCU::DestroyRequest.execute(12345)
+  class DestroyRequest < BaseEditRequest
+    # Deletes an ECCU request
+    # @param [Fixnum] code request code
+    # @return [true] when the request has been deleted
+    # @return [false] when the request cannot be deleted
+    # @raise [AkamaiApi::Unauthorized] when login credentials are invalid
+    # @raise [AkamaiApi::ECCU::NotFound] when no request can be found with the given code
+    def self.execute code
+      new(code).execute
+    end
+
+    # Deletes an ECCU request
+    # @return [true] when the request has been deleted
+    # @return [false] when the request cannot be deleted
+    # @raise [AkamaiApi::Unauthorized] when login credentials are invalid
+    # @raise [AkamaiApi::ECCU::NotFound] when no request can be found with the given code
+    def execute
+      with_soap_error_handling do
+        client_call(:delete, message: request_body.to_s)[:success]
+      end
+    end
+  end
+end

data/lib/akamai_api/eccu/find_request.rb

@@ -0,0 +1,45 @@
+require "akamai_api/eccu/base_edit_request"
+require "akamai_api/eccu/find_response"
+
+module AkamaiApi::ECCU
+  # The {FindRequest} class is used to get the details of an ECCU request.
+  #
+  # @example
+  #   begin
+  #     res = AkamaiApi::ECCU::FindRequest.execute 12345, false
+  #     puts "Request found, in status #{res.status[:message]}"
+  #   rescue AkamaiApi::Unauthorized
+  #     puts "Invalid credentials"
+  #   rescue AkamaiApi::NotFound
+  #     puts "No request found with the given code"
+  #   end
+  class FindRequest < BaseEditRequest
+    # Returns the details of an ECCU request
+    # @param [Fixnum] code request code
+    # @param [true,false] retrieve_content set to true if you want to retrieve request content too
+    # @return [FindResponse]
+    def self.execute code, retrieve_content = false
+      new(code).execute(retrieve_content)
+    end
+
+    # Returns the details of an ECCU request
+    # @param [true,false] retrieve_content set to true if you want to retrieve request content too
+    # @return [FindResponse]
+    def execute retrieve_content = false
+      with_soap_error_handling do
+        response = client_call :get_info, message: request_body(retrieve_content).to_s
+        FindResponse.new response[:eccu_info]
+      end
+    end
+
+    protected
+
+    # Creates the request body filling it with all necessary arguments
+    # @return [SoapBody]
+    def request_body retrieve_content
+      super do |block|
+        block.boolean :retrieveContents, retrieve_content == true
+      end
+    end
+  end
+end

data/lib/akamai_api/eccu/find_response.rb

@@ -0,0 +1,110 @@
+require 'base64'
+
+module AkamaiApi::ECCU
+  # {FindResponse} exposes the response received when requesting the details of an Akamai ECCU request
+  class FindResponse
+    # Raw response object
+    # @return [Hash] raw response object
+    attr_reader :raw
+
+    # @param [Hash] raw raw response object
+    def initialize raw
+      @raw = raw
+    end
+
+    # Request code
+    # @return [Fixnum] request code
+    def code
+      raw[:file_id]
+    end
+
+    # @!method notes
+    #   Notes of the request
+    #   @return [String] notes of the request
+    # @!method email
+    #   Email to be notified when the request becomes completed
+    #   @return [String] email to be notified when the request becomes completed
+    # @!method updated_at
+    #   Last time the request was updated
+    #   @return [String] last time the request was updated
+    # @!method uploaded_by
+    #   User that submitted the request
+    #   @return [String] user name
+    # @!method uploaded_at
+    #   Time the request was uploaded
+    #   @return [String] time the request was uploaded
+    # @!method version
+    #   version of the request
+    #   @return [String] version of the request
+    {
+      :notes       => :notes,
+      :email       => :status_change_email,
+      :updated_at  => :update_date,
+      :uploaded_at => :upload_date,
+      :uploaded_by => :uploaded_by,
+      :version     => :version_string
+    }.each do |local_field, soap_field|
+      define_method local_field do
+        get_if_string(raw[soap_field])
+      end
+    end
+
+    alias_method :status_change_email, :email
+    alias_method :update_date,         :updated_at
+    alias_method :upload_date,         :uploaded_at
+    alias_method :version_string,      :version
+
+    # Uploaded file details
+    # @return [Hash] file details
+    #   - :content [String] file content
+    #   - :size [Fixnum] file size
+    #   - :name [String] file name
+    #   - :md5 [String] MD5 digest of the file content
+    def file
+      content64 = get_if_string(raw[:contents])
+      {
+        :content => content64 ? Base64.decode64(content64) : nil,
+        :size    => raw[:file_size].to_i,
+        :name    => get_if_string(raw[:filename]),
+        :md5     => get_if_string(raw[:md5_digest])
+      }.reject { |k, v| v.nil? }
+    end
+
+    # Request status
+    # @return [Hash] request status
+    #   - :extended [String] extended status message
+    #   - :code [Fixnum] status code
+    #   - :message [String] status message
+    #   - :updated_at [String] last time the status has been updated
+    def status
+      {
+        :extended   => get_if_string(raw[:extended_status_message]),
+        :code       => raw[:status_code].to_i,
+        :message    => get_if_string(raw[:status_message]),
+        :updated_at => get_if_string(raw[:status_update_date])
+      }.reject { |k, v| v.nil? }
+    end
+
+    # Digital property details
+    # @return [Hash] property details
+    #   - :name [String]
+    #   - :exact_match [true,false]
+    #   - :type [String]
+    def property
+      {
+        :name        => get_if_string(raw[:property_name]),
+        :exact_match => (raw[:property_name_exact_match] == true),
+        :type        => get_if_string(raw[:property_type])
+      }.reject { |k, v| v.nil? }
+    end
+
+    private
+
+    # This method is used because, for nil values, savon will respond with an hash containing all other attributes.
+    # If we check that the expected type is matched, we can
+    # prevent to retrieve wrong values
+    def get_if_string value
+      value.kind_of?(String) && value || nil
+    end
+  end
+end

data/lib/akamai_api/eccu/invalid_domain.rb

@@ -0,0 +1,7 @@
+require "akamai_api/error"
+
+module AkamaiApi::ECCU
+  # A simple subclass of {AkamaiApi::Error} representing a domain the user is not allowed to operate on
+  class InvalidDomain < AkamaiApi::Error
+  end
+end

data/lib/akamai_api/eccu/list_request.rb

@@ -0,0 +1,21 @@
+require "akamai_api/eccu/soap_body"
+require "akamai_api/eccu/base_request"
+
+module AkamaiApi::ECCU
+  # Use the {ListRequest} class to get the list of the last submitted ECCU requests
+  class ListRequest < BaseRequest
+    # Returns the list of the last submitted ECCU requests
+    # @return [Array<Fixnum>] list of request codes
+    def self.execute
+      new.execute
+    end
+
+    # Returns the list of the last submitted ECCU requests
+    # @return [Array<Fixnum>] list of request codes
+    def execute
+      with_soap_error_handling do
+        Array.wrap client_call(:get_ids)[:file_ids][:file_ids]
+      end
+    end
+  end
+end

data/lib/akamai_api/eccu/not_found.rb

@@ -0,0 +1,6 @@
+require "akamai_api/error"
+
+module AkamaiApi::ECCU
+  # A simple subclass of {AkamaiApi::Error} indicating that the requested ECCU resource cannot be found
+  class NotFound < AkamaiApi::Error; end
+end

data/lib/akamai_api/eccu/publish_request.rb

@@ -0,0 +1,75 @@
+require 'akamai_api/eccu/invalid_domain'
+require 'akamai_api/eccu/soap_body'
+require "akamai_api/eccu/base_request"
+
+module AkamaiApi::ECCU
+  # {PublishRequest} is responsible of publishing a new ECCU request.
+  #
+  # @example
+  #   content = File.read './publish.xml'
+  #   begin
+  #     req = AkamaiApi::ECCU::PublishRequest.new 'http://foo.bar/t.txt'
+  #     code = req.execute content, file_name: 'publish.xml', emails: 'author@mikamai.com'
+  #     puts "Request enqueued with code #{code}"
+  #   rescue AkamaiApi::Unauthorized
+  #     puts "Invalid login credentials"
+  #   end
+  class PublishRequest < BaseRequest
+    # @return [String] Digital property name
+    attr_reader :property_name
+    # @return [String] Digital property type
+    attr_reader :property_type
+    # @return [true,false] Digital property match type (true if exact)
+    attr_reader :property_exact_match
+
+    # @param [String] property_name Digital property name
+    # @param [Hash<Symbol, String>] args Additional arguments
+    # @option args [String] :type ('hostheader') Digital property type
+    # @option args [true,false] :exact_match (true) Digital property match type
+    def initialize property_name, args = {}
+      @property_name = property_name
+      @property_type = args.fetch(:type, 'hostheader')
+      @property_exact_match = args.fetch(:exact_match, true) == true
+    end
+
+    # Publishes a new ECCU request
+    # @param [String] content content of the ECCU request
+    # @param [Hash<Symbol, String>] args Additional arguments
+    # @option args [String] :file_name ('') file name to set in the request
+    # @option args [String] :notes ('ECCU Request using AkamaiApi <VERSION>') notes of the ECCU request
+    # @option args [String] :version ('') request version number
+    # @option args [String,Array<String>] :emails emails to notify when the request has been completed
+    def execute content, args = {}
+      with_soap_error_handling do
+        response = client_call :upload, message_tag: 'upload', message: request_body(content, args).to_s
+        response[:file_id].to_i
+      end
+    end
+
+    protected
+
+    # Creates the request body filling it with all necessary arguments
+    # @return [SoapBody]
+    def request_body content, args
+      SoapBody.new.tap do |body|
+        body.string :filename,               args.fetch(:file_name, '')
+        body.text   :contents,               content
+        body.string :notes,                  args.fetch(:notes, "ECCU Request using AkamaiApi #{AkamaiApi::VERSION}")
+        body.string :versionString,          args.fetch(:version, '')
+        if args[:emails]
+          body.string :statusChangeEmail,    Array.wrap(args[:emails]).join(',')
+        end
+        body.string      :propertyName,           property_name
+        body.string      :propertyType,           property_type
+        body.boolean     :propertyNameExactMatch, property_exact_match
+      end
+    end
+
+    def with_soap_error_handling &block
+      super
+    rescue Savon::SOAPFault => e
+      e = AkamaiApi::ECCU::InvalidDomain if e.to_hash[:fault][:faultstring].include? 'You are not authorized to specify this digital property'
+      raise e
+    end
+  end
+end

data/lib/akamai_api/eccu/soap_body.rb

@@ -0,0 +1,99 @@
+require "builder"
+
+module AkamaiApi::ECCU
+  # Utility class used by the ECCU request classes to fill the request payload with the arguments
+  # requested by a SOAP method.
+  #
+  # @note Theoretically this class shouldn't exist because Savon should be able to understand
+  #   the provided wsdl correctly and the request payload should be filled using its helpers.
+  #   In practice, at least with Savon v2.2, it wasn't able to do it, and this class tries to
+  #   simplify the creation of the xml payload that encapsulate method arguments.
+  #
+  # The payload of each request is an xml describing the arguments of the method. E.g.
+  #   <filename xsi:type="xsd:string">./publish.xml</filename>
+  #   <contents xsi:type="xsd:base64Binary">aGVsbG8gd29ybGQ=</contents>
+  #   <notes xsi:type="xsd:string">ECCU Request using AkamaiApi</notes>
+  #   <versionString xsi:type="xsd:string"></versionString>
+  #   <propertyName xsi:type="xsd:string">foo.com</propertyName>
+  #   <propertyType xsi:type="xsd:string">hostheader</propertyType>
+  #   <propertyNameExactMatch xsi:type="xsd:boolean">true</propertyNameExactMatch>
+  #
+  # Using this class you can create the above payload with the following code:
+  #
+  #   block = SoapBody.new
+  #   block.string  :filename,           './publish.xml'
+  #   block.text    :contents,           'hello world'
+  #   block.string  :notes,              'ECCU request using AkamaiApi'
+  #   block.string  :versionString,      ''
+  #   block.string  :propertyName,       'foo.com'
+  #   block.string  :propertyType,       'hostheader'
+  #   block.boolean :propertyExactMatch, true
+  #   block.to_s
+  class SoapBody
+    TAG_TYPES = {
+      :boolean => 'xsd:boolean',
+      :integer => 'xsd:int',
+      :string  => 'xsd:string'
+    }
+    private_constant :TAG_TYPES
+
+    attr_reader :builder
+    private :builder
+
+    def initialize
+      @builder = Builder::XmlMarkup.new
+    end
+
+    # Appends an argument of type text, encoding the given value in base64
+    # @param [String] name argument name
+    # @param [String] value
+    # @return [SoapBody]
+    def text name, value
+      builder.tag! name, Base64.encode64(value), 'xsi:type' => 'xsd:base64Binary'
+      self
+    end
+
+    # @!method boolean(name, value)
+    #   Appends an argument of type boolean
+    #   @param [String] name argument name
+    #   @param [true,false] value
+    #   @return [SoapBody]
+    # @!method integer(name, value)
+    #   Appends an argument of type integer
+    #   @param [String] name argument name
+    #   @param [Fixnum] value
+    #   @return [SoapBody]
+    # @!method string(name, value)
+    #   Appends an argument of type string
+    #   @param [String] name argument name
+    #   @param [String] value
+    #   @return [SoapBody]
+    TAG_TYPES.each do |type, type_code|
+      define_method type do |name, value|
+        builder.tag! name, value, 'xsi:type' => type_code
+        self
+      end
+    end
+
+    # Appends an argument of type array
+    # @param [String] name argument name
+    # @param [Array] values
+    # @return [SoapBody]
+    def array name, values
+      array_attrs = {
+        'soapenc:arrayType' => "xsd:string[#{values.length}]",
+        'xsi:type'          => 'wsdl:ArrayOfString'
+      }
+      builder.tag! name, array_attrs do |tag|
+        values.each { |value| tag.item value }
+      end
+      self
+    end
+
+    # Returns the XML to use to set SOAP method arguments
+    # @return [String] the XML to use to set SOAP method arguments
+    def to_s
+      builder.target!
+    end
+  end
+end

data/lib/akamai_api/eccu/update_attribute_request.rb

@@ -0,0 +1,62 @@
+require "akamai_api/eccu/base_edit_request"
+
+module AkamaiApi::ECCU
+  # {UpdateAttributeRequest} is a generic request class that can be used to update an attribute of an ECCU request.
+  #
+  # This class is used to update the {AkamaiApi::ECCURequest#notes} or the {AkamaiApi::ECCURequest#email} attributes
+  #
+  # @example
+  #   begin
+  #     res = AkamaiApi::ECCU::UpdateAttributeRequest.execute 12345, 'notes', 'my new notes'
+  #     puts "Request completed: #{res}"
+  #   rescue AkamaiApi::ECCU::NotFound
+  #     puts "No request can be found with the given code"
+  #   rescue AkamaiApi::Unauthorized
+  #     puts "Invalid login credentials"
+  #   end
+  class UpdateAttributeRequest < BaseEditRequest
+    # @return [String] attribute to update
+    attr_reader :attribute
+
+    # Updates an attribute of an ECCU request
+    # @param [Fixnum] code request code
+    # @param [String] attribute name
+    # @param [String] value new value to set
+    # @return [true,false] whether the request was successful or not
+    def self.execute code, attribute, value
+      new(code, attribute).execute(value)
+    end
+
+    # @param [Fixnum] code request code
+    # @param [String] attribute name
+    def initialize code, attribute
+      super code
+      @attribute = attribute
+    end
+
+    # Updates an attribute of an ECCU request
+    # @param [String] value new value to set
+    # @return [true,false] whether the request was successful or not
+    def execute value
+      with_soap_error_handling do
+        client_call(:"set_#{attribute}", message: request_body(value).to_s)[:success]
+      end
+    end
+
+    protected
+
+    # Creates the request body filling it with all necessary arguments
+    # @return [SoapBody]
+    def request_body notes
+      super do |block|
+        block.string  attribute_for_soap,  notes
+      end
+    end
+
+    private
+
+    def attribute_for_soap
+      attribute.to_s.camelize(:lower).to_sym
+    end
+  end
+end

data/lib/akamai_api/eccu.rb

@@ -0,0 +1,19 @@
+module AkamaiApi::ECCU
+  def self.client
+    build_client
+  end
+
+  private
+
+  def self.build_client
+    Savon.client client_args
+  end
+
+  def self.client_args
+    {
+      :wsdl       => File.expand_path('../../../wsdls/eccu.wsdl', __FILE__),
+      :basic_auth => AkamaiApi.config[:auth],
+      :log        => AkamaiApi.config[:log]
+    }
+  end
+end