akamai_api 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6db87fa3be02df005df62f70c5b518244defda40
-  data.tar.gz: 718930e9c32466a64ca039667aff84024537ded4
+  metadata.gz: 05749989fb5d5d5044e107dcb316294da2527c5d
+  data.tar.gz: 8f92d043cacc95919066b09dcf8c04f04c7b3983
 SHA512:
-  metadata.gz: 912099d1f5670f672d2d70303a80992a44079d4a942d2bcaacb87c028ae68adf26e9061f4f22cf1e3f2f652c42eca557fb0013aebc7bb775450daff6e8fa322c
-  data.tar.gz: 40c41f89eb6d8d90f6fe692da75e870cab47fa8b63b92fad1b620113310fe09b3dd9cc21ac8e972bca18681121f80dcdc45b2da6a1f4d6d2061a97de59912149
+  metadata.gz: 288616d2301a49c4b7a0aa2c2efc3c3d3169403d1d86df57486ea3f2d39741bc11ec854a4ec653e1bb0a61f0b69083e566b5dcc88da8dc049b03cec7ada6f971
+  data.tar.gz: 1255972a4a6a76673fa630736783c4ba5f1d5706afe61c3f7e087ca9cdccf158e7944c194049a470bafeec34e76799c8197d61ddb8a1f289d3edefa948d9c41f

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -2,6 +2,8 @@
 
 AkamaiApi is a ruby library and command line utility to interact with Akamai CCU (Content Control Utility) and ECCU (Enhanced Content Control Utility) services.
 
+__Note__: If you need ruby 1.8 compatibility or if you have any problem with the current release, try to use the [savon1](https://github.com/nicolaracco/akamai_api/tree/savon1) branch (or [version 0.0.7](https://github.com/nicolaracco/akamai_api/tree/v0.0.7))... and open a pull request, of course :-)
+
 # Using the CLI
 
 After gem installation you will have a CLI utility to execute operations on Akamai. Each method requires authentication. You can provide auth info using one of the following methods:
@@ -14,6 +16,7 @@ After gem installation you will have a CLI utility to execute operations on Akam
     auth:
       - user
       - pass
+    log: true # optional for enabling logging. false by default
 ```
 
 ## Tasks

data/akamai_api.gemspec

@@ -16,12 +16,13 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+  gem.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
 
-  gem.add_dependency 'activesupport',  '>= 2.3.9', '< 4.0'
+  gem.add_dependency 'activesupport',  '>= 2.3.9',  '< 4.0'
   gem.add_dependency 'thor',           '>= 0.14.0', '< 2.0'
-  gem.add_dependency 'savon',          '~> 1.2.0'
+  gem.add_dependency 'savon',          '~> 2.2.0'
   gem.add_dependency 'builder',        '~> 3.0'
 
   gem.add_development_dependency 'rspec', '~> 2.11'
-  gem.add_development_dependency 'savon_spec', '~> 1.3'
+  gem.add_development_dependency 'guard-rspec', '~> 3.0.2'
 end

data/lib/akamai_api/ccu.rb

@@ -1,75 +1,83 @@
 require 'active_support/core_ext'
 
 module AkamaiApi
-  class Ccu
-    extend Savon::Model
+  module Ccu
+    extend self
 
-    document File.expand_path('../../../wsdls/ccuapi.wsdl', __FILE__)
+    class UnrecognizedOption < StandardError; end
 
-    class << self
-      [:invalidate, :remove].each do |action|
-        send :define_method, action do |*params|
-          raise ArgumentError, "wrong number of arguments (#{params.length} for 2..3)" if params.length < 2
-          type, items, opts = params
+    [:invalidate, :remove].each do |action|
+      send :define_method, action do |*params|
+        raise ArgumentError, "wrong number of arguments (#{params.length} for 2..3)" if params.length < 2
+        type, items, opts = params
+        purge action, type, items, (opts || {})
+      end
+      [:arl, :cpcode].each do |type|
+        method_name = "#{action}_#{type}".to_sym
+        send :define_method, method_name do |*params|
+          raise ArgumentError, "wrong number of arguments (#{params.length} for 1..2)" if params.length < 1
+          items, opts = params
           purge action, type, items, (opts || {})
         end
-        [:arl, :cpcode].each do |type|
-          method_name = "#{action}_#{type}".to_sym
-          send :define_method, method_name do |*params|
-            raise ArgumentError, "wrong number of arguments (#{params.length} for 1..2)" if params.length < 1
-            items, opts = params
-            purge action, type, items, (opts || {})
-          end
-        end
       end
+    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
-        response = client.request 'wsdl:purgeRequest' do
-          SoapBody.new(soap) do
-            string :name,    AkamaiApi.config[:auth].first
-            string :pwd,     AkamaiApi.config[:auth].last
-            string :network, ''
-            array  :opt,     options
-            array  :uri,     items
-          end
-        end
-        CcuResponse.new response, items
+    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
+    private
 
-      def validate_action action
-        unless %w[invalidate remove].include? action.to_s
-          raise "Unknown type '#{action}' (only 'remove' and 'invalidate' are allowed)"
-        end
+    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 "Unknown type '#{type}' (only 'cpcode' and 'arl' are allowed)"
-        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}"
+    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
+    end
 
-      def add_email email, options
-        if email.present?
-          emails = Array.wrap(email).join ','
-          options << "email-notification=#{emails}"
-        end
+    def add_email email, options
+      if email.present?
+        emails = Array.wrap(email).join ','
+        options << "email-notification=#{emails}"
       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
+    end
   end
 end

data/lib/akamai_api/cp_code.rb

@@ -1,9 +1,5 @@
 module AkamaiApi
   class CpCode
-    extend Savon::Model
-
-    document 'https://control.akamai.com/nmrws/services/SiteAcceleratorReportService?wsdl'
-
     attr_accessor :code, :description, :service
 
     def initialize attributes
@@ -13,9 +9,7 @@ module AkamaiApi
     end
 
     def self.all
-      basic_auth *AkamaiApi.config[:auth]
-      response = client.request('getCPCodes').body[:multi_ref]
-
+      response = client.call(:get_cp_codes).body[:multi_ref]
       Array.wrap(response).map do |hash|
         new({
           :code        => hash[:cpcode],
@@ -24,5 +18,16 @@ module AkamaiApi
         })
       end
     end
+
+    private
+
+    def self.client
+      savon_args = {
+        :wsdl       => File.expand_path('../../../wsdls/cpcode.wsdl', __FILE__),
+        :basic_auth => AkamaiApi.config[:auth],
+        :log        => AkamaiApi.config[:log]
+      }
+      Savon.client savon_args
+    end
   end
 end

data/lib/akamai_api/eccu_request.rb

@@ -1,9 +1,5 @@
 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 = {}
@@ -14,42 +10,39 @@ module AkamaiApi
 
     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
+      body = SoapBody.new do
+        integer :fileId, code
+        string  :notes,  notes
       end
+      resp = client.call :set_notes, :message => body.to_s
       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
+      body = SoapBody.new do
+        integer :fileId, code
+        string  :statusChangeEmail, email
       end
-      self.email = email
-      resp.body[:set_status_change_email_response][:success]
+      response = client.call :set_status_change_email, :message => body.to_s
+      successful = response.body[:set_status_change_email_response][:success]
+      self.email = email if successful
+      successful
     end
 
     def destroy
       code = self.code.to_i
-      resp = client.request 'delete' do |soap|
-        SoapBody.new(soap) do
-          integer :fileId, code
-        end
+      body = SoapBody.new do
+        integer :fileId, code
       end
-      resp.body[:delete_response][:success]
+      response = client.call :delete, :message => body.to_s
+      response.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]
+        client.call(:get_ids).body[:get_ids_response][:file_ids][:file_ids]
       end
 
       def all args = {}
@@ -65,38 +58,36 @@ module AkamaiApi
       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
+        body = SoapBody.new do
+          integer :fileId, code.to_i
+          boolean :retrieveContents, args[:verbose] == true
         end
-        resp = resp[:get_info_response][:eccu_info]
+        response = client.call(:get_info, :message => body.to_s)
+        response_body = response.body[: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)
+            :content    => Base64.decode64(get_if_kind(response_body[:contents], String) || ''),
+            :file_size  => response_body[:file_size].to_i,
+            :file_name  => get_if_kind(response_body[:filename], String),
+            :md5_digest => get_if_kind(response_body[: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)
+            :extended    => get_if_kind(response_body[:extended_status_message], String),
+            :code        => response_body[:status_code].to_i,
+            :message     => get_if_kind(response_body[:status_message], String),
+            :update_date => get_if_kind(response_body[:status_update_date], String)
           },
-          :code  => resp[:file_id],
-          :notes => get_if_kind(resp[:notes], String),
+          :code  => response_body[:file_id],
+          :notes => get_if_kind(response_body[: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)
+            :name => get_if_kind(response_body[:property_name], String),
+            :exact_match => (response_body[:property_name_exact_match] == true),
+            :type => get_if_kind(response_body[: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)
+          :email => get_if_kind(response_body[:status_change_email], String),
+          :upload_date => get_if_kind(response_body[:upload_date], String),
+          :uploaded_by => get_if_kind(response_body[:uploaded_by], String),
+          :version_string => get_if_kind(response_body[:version_string], String)
         })
       end
 
@@ -106,32 +97,49 @@ module AkamaiApi
       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
+        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
       end
 
       private
 
+      def build_publish_soap_body property, content, args
+        SoapBody.new 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
+
       # 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
+
+      def client
+        savon_args = {
+          :wsdl       => File.expand_path('../../../wsdls/eccu.wsdl', __FILE__),
+          :basic_auth => AkamaiApi.config[:auth],
+          :log        => AkamaiApi.config[:log]
+        }
+        Savon.client savon_args
+      end
+    end
+
+    private
+
+    def client
+      self.class.send(:client)
     end
   end
 end

data/lib/akamai_api/soap_body.rb

@@ -1,52 +1,40 @@
 module AkamaiApi
   class SoapBody
-    attr_accessor :soap
+    attr_reader :builder
 
-    def initialize soap, &block
-      self.soap = soap
-      self.soap.namespaces['xmlns:soapenc'] = 'http://schemas.xmlsoap.org/soap/encoding/'
+    def initialize &block
+      @builder = Builder::XmlMarkup.new
       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' }
+      builder.tag! name, Base64.encode64(value), 'xsi:type' => 'xsd:base64Binary'
     end
 
     def boolean name, value
-      name = name.to_sym
-      body[name] = value
-      body_attributes[name] = { 'xsi:type' => 'xsd:boolean' }
+      builder.tag! name, value, 'xsi:type' => 'xsd:boolean'
     end
 
     def integer name, value
-      name = name.to_sym
-      body[name] = value
-      body_attributes[name] = { 'xsi:type' => 'xsd:int' }
+      builder.tag! name, value, 'xsi:type' => 'xsd:int'
     end
 
     def string name, value
-      name = name.to_sym
-      body[name] = value
-      body_attributes[name] = { 'xsi:type' => 'xsd:string' }
+      builder.tag! name, value, 'xsi:type' => 'xsd:string'
     end
 
     def array name, values
-      name = name.to_sym
-      body[name] = { 'item' => values }
-      body_attributes[name] = {
+      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
+    end
+
+    def to_s
+      builder.target!
     end
   end
 end

data/lib/akamai_api/version.rb

@@ -1,3 +1,3 @@
 module AkamaiApi
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/akamai_api.rb

@@ -5,5 +5,5 @@ require 'savon'
 end
 
 module AkamaiApi
-  def self.config; @config ||= { :auth => ['', ''] }; end
+  def self.config; @config ||= { :auth => ['', ''], :log => false }; end
 end

data/spec/fixtures/eccu/set_status_change_email/fault.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">false</success>
+    </setStatusChangeEmailResponse>
+  </soapenv:Body>
+</soapenv:Envelope>