akamai_api 0.0.1

data/lib/akamai_api/cp_code.rb

@@ -0,0 +1,26 @@
+module AkamaiApi
+  class CpCode
+    extend Savon::Model
+
+    document 'https://control.akamai.com/nmrws/services/SiteAcceleratorReportService?wsdl'
+
+    attr_accessor :code, :description, :service
+
+    def initialize attributes
+      attributes.each do |key, value|
+        send "#{key}=", value
+      end
+    end
+
+    def self.all
+      basic_auth *AkamaiApi.config[:auth]
+      client.request('getCPCodes').body[:multi_ref].map do |hash|
+        new({
+          :code        => hash[:cpcode],
+          :description => hash[:description],
+          :service     => hash[:service],
+        })
+      end
+    end
+  end
+end

data/lib/akamai_api/eccu_request.rb

@@ -0,0 +1,137 @@
+module AkamaiApi
+  class EccuRequest
+    extend Savon::Model
+
+    document 'https://control.akamai.com/webservices/services/PublishECCU?wsdl'
+
+    attr_accessor :file, :status, :code, :notes, :property, :email, :upload_date, :uploaded_by, :version_string
+
+    def initialize attributes = {}
+      attributes.each do |key, value|
+        send "#{key}=", value
+      end
+    end
+
+    def update_notes! notes
+      code = self.code.to_i
+      resp = client.request 'setNotes' do
+        SoapBody.new(soap) do
+          integer :fileId, code
+          string  :notes,  notes
+        end
+      end
+      self.notes = notes
+      resp.body[:set_notes_response][:success]
+    end
+
+    def update_email! email
+      code = self.code.to_i
+      resp = client.request 'setStatusChangeEmail' do
+        SoapBody.new(soap) do
+          integer :fileId, code
+          string  :statusChangeEmail, email
+        end
+      end
+      self.email = email
+      resp.body[:set_status_change_email_response][:success]
+    end
+
+    def destroy
+      code = self.code.to_i
+      resp = client.request 'delete' do |soap|
+        SoapBody.new(soap) do
+          integer :fileId, code
+        end
+      end
+      resp.body[:delete_response][:success]
+    end
+
+    class << self
+      def all_ids
+        basic_auth *AkamaiApi.config[:auth]
+        client.request('getIds').body[:get_ids_response][:file_ids][:file_ids]
+      end
+
+      def all args = {}
+        all_ids.map { |v| EccuRequest.find v, args }
+      end
+
+      def last args = {}
+        find all_ids.last, args
+      end
+
+      def first args = {}
+        find all_ids.first, args
+      end
+
+      def find code, args = {}
+        basic_auth *AkamaiApi.config[:auth]
+        resp = client.request 'getInfo' do
+          SoapBody.new(soap) do
+            integer :fileId, code.to_i
+            boolean :retrieveContents, args[:verbose] == true
+          end
+        end
+        resp = resp[:get_info_response][:eccu_info]
+        EccuRequest.new({
+          :file => {
+            :content    => Base64.decode64(get_if_kind(resp[:contents], String) || ''),
+            :file_size  => resp[:file_size].to_i,
+            :file_name  => get_if_kind(resp[:filename], String),
+            :md5_digest => get_if_kind(resp[:md5_digest], String)
+          },
+          :status => {
+            :extended    => get_if_kind(resp[:extended_status_message], String),
+            :code        => resp[:status_code].to_i,
+            :message     => get_if_kind(resp[:status_message], String),
+            :update_date => get_if_kind(resp[:status_update_date], String)
+          },
+          :code  => resp[:file_id],
+          :notes => get_if_kind(resp[:notes], String),
+          :property => {
+            :name => get_if_kind(resp[:property_name], String),
+            :exact_match => (resp[:property_name_exact_match] == true),
+            :type => get_if_kind(resp[:property_type], String)
+          },
+          :email => get_if_kind(resp[:status_change_email], String),
+          :upload_date => get_if_kind(resp[:upload_date], String),
+          :uploaded_by => get_if_kind(resp[:uploaded_by], String),
+          :version_string => get_if_kind(resp[:version_string], String)
+        })
+      end
+
+      def publish_file property, file_name, args = {}
+        args[:file_name] = file_name
+        publish property, File.read(file_name), args
+      end
+
+      def publish property, content, args = {}
+        basic_auth *AkamaiApi.config[:auth]
+        resp = client.request 'upload' do
+          SoapBody.new(soap) do
+            string :filename,                args[:file_name] || ''
+            text   :contents,                content
+            string :notes,                   args[:notes] || 'ECCU Request using AkamaiApi gem'
+            string :versionString,           args[:version] || ''
+            if args[:emails]
+              string :statusChangeEmail,     Array.wrap(args[:emails]).join(' ')
+            end
+            string :propertyName,            property
+            string :propertyType,            args[:property_type] || 'hostheader'
+            boolean :propertyNameExactMatch, args[:property_exact_match].nil? && true || args[:property_exact_match]
+          end
+        end
+        resp.body[:upload_response][:file_id].to_i
+      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_kind value, kind
+        value.kind_of?(kind) && value || nil
+      end
+    end
+  end
+end

data/lib/akamai_api/soap_body.rb

@@ -0,0 +1,52 @@
+module AkamaiApi
+  class SoapBody
+    attr_accessor :soap
+
+    def initialize soap, &block
+      self.soap = soap
+      self.soap.namespaces['xmlns:soapenc'] = 'http://schemas.xmlsoap.org/soap/encoding/'
+      instance_eval &block if block
+    end
+
+    def body
+      soap.body ||= {}
+    end
+
+    def body_attributes
+      body[:attributes!] ||= {}
+    end
+
+    def text name, value
+      name = name.to_sym
+      body[name] = Base64.encode64 value
+      body_attributes[name] = { 'xsi:type' => 'xsd:base64Binary' }
+    end
+
+    def boolean name, value
+      name = name.to_sym
+      body[name] = value
+      body_attributes[name] = { 'xsi:type' => 'xsd:boolean' }
+    end
+
+    def integer name, value
+      name = name.to_sym
+      body[name] = value
+      body_attributes[name] = { 'xsi:type' => 'xsd:int' }
+    end
+
+    def string name, value
+      name = name.to_sym
+      body[name] = value
+      body_attributes[name] = { 'xsi:type' => 'xsd:string' }
+    end
+
+    def array name, values
+      name = name.to_sym
+      body[name] = { 'item' => values }
+      body_attributes[name] = {
+        'soapenc:arrayType' => "xsd:string[#{values.length}]",
+        'xsi:type'          => 'wsdl:ArrayOfString'
+      }
+    end
+  end
+end

data/lib/akamai_api/version.rb

@@ -0,0 +1,3 @@
+module AkamaiApi
+  VERSION = "0.0.1"
+end

data/lib/akamai_api.rb

@@ -0,0 +1,9 @@
+require 'savon'
+
+%w(version cp_code soap_body ccu_response ccu eccu_request).each do |file|
+  require File.expand_path "../akamai_api/#{file}", __FILE__
+end
+
+module AkamaiApi
+  def self.config; @config ||= { :auth => ['', ''] }; end
+end

data/spec/fixtures/delete/success.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <deleteResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <success xsi:type="xsd:boolean">true</success>
+    </deleteResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/eccu_request.xml

@@ -0,0 +1,10 @@
+<?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>

data/spec/fixtures/get_cp_codes/sample.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <getCPCodesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <getCPCodesReturn soapenc:arrayType="ns1:CPCodeInfo[34]" xsi:type="soapenc:Array" xmlns:ns1="https://control.akamai.com/Data.xsd" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+        <getCPCodesReturn href="#id0"/>
+        <getCPCodesReturn href="#id1"/>
+      </getCPCodesReturn>
+    </getCPCodesResponse>
+    <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:CPCodeInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="https://control.akamai.com/Data.xsd">
+      <cpcode xsi:type="xsd:int">12345</cpcode>
+      <description xsi:type="xsd:string">Foo Site</description>
+      <service xsi:type="xsd:string">Site_Accel::Site_Accel</service>
+    </multiRef>
+    <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns3:CPCodeInfo" xmlns:ns3="https://control.akamai.com/Data.xsd" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+      <cpcode xsi:type="xsd:int">23456</cpcode>
+      <description xsi:type="xsd:string">Sample Site</description>
+      <service xsi:type="xsd:string">Site_Accel::Site_Accel</service>
+    </multiRef>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/get_ids/success.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <getIdsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <fileIds soapenc:arrayType="xsd:int[10]" xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+        <fileIds xsi:type="xsd:int">42994282</fileIds>
+        <fileIds xsi:type="xsd:int">43000154</fileIds>
+      </fileIds>
+    </getIdsResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/get_info/success.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <getInfoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <EccuInfo xsi:type="ns1:EccuInfo" xmlns:ns1="https://control.akamai.com/Publish.xsd">
+        <contents xsi:type="xsd:base64Binary">PGVjY3U+XG4gIDxyZXZhbGlkYXRlPm5vdzwvcmV2YWxpZGF0ZT5cbjwvZWNj\ndT5cbg==</contents>
+        <extendedStatusMessage xsi:type="xsd:string">File successfully deployed to Akamai network (Succeeded)</extendedStatusMessage>
+        <fileId xsi:type="xsd:int">1234567</fileId>
+        <fileSize xsi:type="xsd:int">127</fileSize>
+        <filename xsi:type="xsd:string" xsi:nil="true"/>
+        <notes xsi:type="xsd:string">ECCU Request using EdgeControl</notes>
+        <propertyName xsi:type="xsd:string">www.example.com</propertyName>
+        <propertyNameExactMatch xsi:type="xsd:boolean">true</propertyNameExactMatch>
+        <propertyType xsi:type="xsd:string">hostheader</propertyType>
+        <statusChangeEmail xsi:type="xsd:string">foo@example.com</statusChangeEmail>
+        <statusCode xsi:type="xsd:int">4000</statusCode>
+        <statusMessage xsi:type="xsd:string">File successfully deployed to Akamai's network</statusMessage>
+        <statusUpdateDate xsi:type="xsd:dateTime">2012-09-20T07:58:10.936Z</statusUpdateDate>
+        <uploadDate xsi:type="xsd:dateTime">2012-09-20T07:17:25.936Z</uploadDate>
+        <uploadedBy xsi:type="xsd:string">foo</uploadedBy>
+        <versionString xsi:type="xsd:string" xsi:nil="true"/>
+      </EccuInfo>
+    </getInfoResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/set_notes/success.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <setNotesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <success xsi:type="xsd:boolean">true</success>
+    </setNotesResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/set_status_change_email/success.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <setStatusChangeEmailResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <success xsi:type="xsd:boolean">true</success>
+    </setStatusChangeEmailResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/upload/fault.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <soapenv:Fault>
+      <faultcode>soapenv:Server.generalException</faultcode>
+      <faultstring>ECCU validation failed: You are not authorized to specify this digital property</faultstring>
+      <detail>
+        <ns1:exceptionName xmlns:ns1="http://xml.apache.org/axis/">com.akamai.aws.util.AWSFault</ns1:exceptionName>
+        <ns2:hostname xmlns:ns2="http://xml.apache.org/axis/">example.akamai.com</ns2:hostname>
+      </detail>
+    </soapenv:Fault>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/upload/success.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Body>
+    <uploadResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <fileId xsi:type="xsd:int">1234567</fileId>
+    </uploadResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/wsdl:purge_request/success.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+  <SOAP-ENV:Body SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsd1="http://www.w3.org/1999/XMLSchema" xmlns:xsd2="http://www.w3.org/2000/10/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi1="http://www.w3.org/1999/XMLSchema-instance" xmlns:xsi2="http://www.w3.org/2000/10/XMLSchema-instance">
+    <ns0:purgeRequestResponse xmlns:ns0="http://www.akamai.com/purge">
+      <return xsi1:type="ns0:PurgeResult" xsi2:type="ns0:PurgeResult" xsi:type="ns0:PurgeResult">
+        <resultCode xsi1:type="xsd1:int" xsi2:type="xsd1:int" xsi:type="xsd1:int">100</resultCode>
+        <resultMsg xsi1:type="xsd1:string" xsi2:type="xsd1:string" xsi:type="xsd1:string">Success.</resultMsg>
+        <sessionID xsi1:type="xsd1:string" xsi2:type="xsd1:string" xsi:type="xsd1:string">97870328-018c-11e2-aabc-489beabc489b</sessionID>
+        <estTime xsi1:type="xsd1:int" xsi2:type="xsd1:int" xsi:type="xsd1:int">420</estTime>
+        <uriIndex xsi1:type="xsd1:int" xsi2:type="xsd1:int" xsi:type="xsd1:int">-1</uriIndex>
+        <modifiers SOAP-ENC:arrayType="xsd1:string[0]" xsi1:null="true" xsi2:null="true" xsi:nil="true"/>
+      </return>
+    </ns0:purgeRequestResponse>
+  </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>

data/spec/lib/akamai_api/ccu_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+module AkamaiApi
+  describe Ccu do
+    include SavonTester
+
+    before do
+      savon.expects('wsdl:purgeRequest').returns(:success)
+      stub_savon_model Ccu
+    end
+
+    describe '#purge response' do
+      it 'is a CcuResponse object' do
+        Ccu.remove_cpcode('12345').should be_a CcuResponse
+      end
+
+      it 'returns code 100' do
+        Ccu.remove_cpcode('12345').code.should == 100
+      end
+
+      it 'returns a success message' do
+        Ccu.remove_cpcode('12345').message.should == 'Success.'
+      end
+
+      it 'returns a unique session id' do
+        Ccu.remove_cpcode('12345').session_id.should == '97870328-018c-11e2-aabc-489beabc489b'
+      end
+
+      it 'returns the estimated time in seconds' do
+        Ccu.remove_cpcode('12345').estimated_time.should == 420
+      end
+    end
+
+    describe '#purge raises an error when' do
+      it 'action is not allowed' do
+        %w(invalidate remove).each do |action|
+          expect {
+            Ccu.purge action, :cpcode, '1234'
+          }.to_not raise_error
+        end
+        expect { Ccu.purge :sss, :cpcode, '12345' }.to raise_error
+      end
+
+      it 'type is not allowed' do
+        %w(cpcode arl).each do |type|
+          expect {
+            Ccu.purge :remove, type, '12345'
+          }.to_not raise_error
+        end
+        expect { Ccu.purge :remove, :foo, '12345' }.to raise_error
+      end
+
+      it 'domain is specified and not allowed' do
+        %w(production staging).each do |domain|
+          expect { Ccu.purge :remove, :arl, 'foo', :domain => domain }.to_not raise_error
+        end
+        expect { Ccu.purge :remove, :arl, 'foo', :domain => :foo }.to raise_error
+      end
+    end
+
+    describe '#purge request arguments' do
+      it 'should include user and password' do
+        soap_body = SoapBody.any_instance
+        soap_body.stub :string => ''
+        soap_body.should_receive(:string).with :name, AkamaiApi.config[:auth].first
+        soap_body.should_receive(:string).with :pwd, AkamaiApi.config[:auth].last
+        Ccu.purge :remove, :arl, 'foo'
+      end
+
+      describe 'options' do
+        before { SoapBody.any_instance.stub :array => '' }
+
+        it 'include action and type' do
+          SoapBody.any_instance.should_receive(:array).with(:opt, kind_of(Array)) do |name, array|
+            array.should include 'type=arl'
+            array.should include 'action=remove'
+          end
+          Ccu.purge :remove, :arl, 'foo'
+        end
+
+        describe 'domain' do
+          it 'is not included by default' do
+            SoapBody.any_instance.should_receive(:array).with(:opt, kind_of(Array)) do |name, array|
+              array.detect { |s| s =~ /^domain/ }.should be_nil
+            end
+            Ccu.purge :remove, :arl, 'foo'
+          end
+
+          it 'is included if specified' do
+            SoapBody.any_instance.should_receive(:array).with(:opt, kind_of(Array)) do |name, array|
+              array.should include 'domain=production'
+            end
+            Ccu.purge :remove, :arl, 'foo', :domain => 'production'
+          end
+        end
+
+        describe 'email' do
+          it 'is not included by default' do
+            SoapBody.any_instance.should_receive(:array).with(:opt, kind_of(Array)) do |name, array|
+              array.detect { |s| s =~ /^email/ }.should be_nil
+            end
+            Ccu.purge :remove, :arl, 'foo'
+          end
+
+          it 'is included if specified' do
+            SoapBody.any_instance.should_receive(:array).with(:opt, kind_of(Array)) do |name, array|
+              array.should include 'email-notification=foo@foo.com,pip@pip.com'
+            end
+            Ccu.purge :remove, :arl, 'foo', :email => ['foo@foo.com', 'pip@pip.com']
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/akamai_api/cp_code_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module AkamaiApi
+  describe CpCode do
+    include SavonTester
+
+    describe '::all' do
+      before do
+        savon.expects('getCPCodes').returns(:sample)
+        stub_savon_model CpCode
+      end
+
+      it 'should return a collection of models' do
+        CpCode.all.each { |o| o.should be_a CpCode }
+      end
+
+      it 'should correctly fill each object' do
+        model = CpCode.all.first
+        model.code.should == '12345'
+        model.description.should == 'Foo Site'
+        model.service.should == 'Site_Accel::Site_Accel'
+      end
+    end
+  end
+end