akamai_api 0.0.1

data/spec/lib/akamai_api/eccu_request_spec.rb

@@ -0,0 +1,216 @@
+require 'spec_helper'
+
+module AkamaiApi
+  describe EccuRequest do
+    include SavonTester
+
+    before { stub_savon_model EccuRequest }
+
+    describe '::all_ids' do
+      before { savon.expects('getIds').returns(:success) }
+
+      it 'returns the id list of all available requests' do
+        EccuRequest.all_ids.should =~ ['42994282', '43000154']
+      end
+    end
+
+    describe '::find' do
+      before { savon.expects('getInfo').returns(:success) }
+
+      context 'when calling the ECCU service' do
+        it 'sets the specified code' do
+          SoapBody.any_instance.should_receive(:integer).with :fileId, 1234567
+          EccuRequest.find('1234567')
+        end
+
+        it 'sets to not return file content by default' do
+          SoapBody.any_instance.should_receive(:boolean).with :retrieveContents, false
+          EccuRequest.find('1234567')
+        end
+
+        it 'sets to return file content if verbose is specified' do
+          SoapBody.any_instance.should_receive(:boolean).with :retrieveContents, true
+          EccuRequest.find('1234567', :verbose => true)
+        end
+      end
+
+      it 'correctly assign the exact match' do
+        r = EccuRequest.find('1234567')
+        r.property[:exact_match].should be_true
+      end
+    end
+
+    describe '::last' do
+      it 'find the most recent entry' do
+        EccuRequest.stub! :all_ids => %w(a b)
+        EccuRequest.should_receive(:find).with('b', anything()).and_return :a
+        EccuRequest.last.should == :a
+      end
+    end
+
+    describe '::first' do
+      it 'find the oldest entry' do
+        EccuRequest.stub! :all_ids => %w(a b)
+        EccuRequest.should_receive(:find).with('a', anything()).and_return :a
+        EccuRequest.first.should == :a
+      end
+    end
+
+    describe '::all' do
+      it 'returns the detail for each enlisted id' do
+        EccuRequest.stub! :all_ids => %w(a b)
+        EccuRequest.should_receive(:find).with('a', anything()).and_return(:a)
+        EccuRequest.should_receive(:find).with('b', anything()).and_return(:b)
+        EccuRequest.all.should =~ [:a, :b]
+      end
+    end
+
+    describe 'publishing' do
+      let(:xml_request) { File.expand_path "../../../fixtures/eccu_request.xml", __FILE__ }
+      let(:xml_request_content) { File.read xml_request }
+
+      describe '::publish_file' do
+        it 'calls publish with the content of the specified file' do
+          args = {}
+          EccuRequest.should_receive(:publish).with('foo', xml_request_content, args)
+          EccuRequest.publish_file('foo', xml_request, args)
+        end
+      end
+
+      describe '::publish' do
+        context 'when there is an error' do
+          before { savon.expects('upload').returns(:fault) }
+
+          it 'raises an error' do
+            expect { EccuRequest.publish '', xml_request_content }
+          end
+        end
+
+        context 'when there are no errors' do
+          before { savon.expects('upload').returns(:success) }
+
+          it 'returns an EccuRequest instance' do
+            EccuRequest.publish('', xml_request_content).should be_a Fixnum
+          end
+
+          it 'assigns the fields correctly' do
+            soap_body = SoapBody.any_instance
+            soap_body.should_receive(:string).with :filename, 'eccu_request.xml'
+            soap_body.should_receive(:text).with   :contents, xml_request_content
+            soap_body.should_receive(:string).with :notes,    'sample notes'
+            soap_body.should_receive(:string).with :versionString, 'v2'
+            soap_body.should_receive(:string).with :statusChangeEmail, 'foo@foo.com bar@bar.com'
+            soap_body.should_receive(:string).with :propertyName, 'foo.com'
+            soap_body.should_receive(:string).with :propertyType, 'prop'
+            soap_body.should_receive(:boolean).with :propertyNameExactMatch, false
+            EccuRequest.publish('foo.com', xml_request_content, {
+              :file_name => 'eccu_request.xml',
+              :notes     => 'sample notes',
+              :version   => 'v2',
+              :emails    => %w(foo@foo.com bar@bar.com),
+              :property_type => 'prop',
+              :property_exact_match => false
+            })
+          end
+
+          it 'assigns a default notes field if no notes are specified' do
+            SoapBody.any_instance.stub :string => nil
+            SoapBody.any_instance.should_receive(:string).with(:notes, kind_of(String))
+            EccuRequest.publish '', xml_request_content
+          end
+
+          it 'assigns emails field if specified' do
+            SoapBody.any_instance.should_not_receive(:string).with(:statusChangeEmail, anything())
+            EccuRequest.publish '', xml_request_content
+          end
+
+          it 'assigns the property type to hostheader by default' do
+            SoapBody.any_instance.stub :string => nil
+            SoapBody.any_instance.should_receive(:string).with(:propertyType, 'hostheader')
+            EccuRequest.publish '', xml_request_content
+          end
+
+          it 'assigns the property exact match to true by default' do
+            SoapBody.any_instance.stub :boolean => nil
+            SoapBody.any_instance.should_receive(:boolean).with(:propertyNameExactMatch, true)
+            EccuRequest.publish '', xml_request_content
+          end
+        end
+      end
+    end
+
+    describe 'instance' do
+      describe 'constructor' do
+        it 'assigns the attributes hash to the accessors' do
+          req = EccuRequest.new :status => 'foo', :notes => 'bar'
+          req.status.should == 'foo'
+          req.notes.should == 'bar'
+        end
+      end
+
+      describe '#update_notes!' do
+        before { savon.expects('setNotes').returns(:success) }
+
+        it 'updates the notes field' do
+          req = EccuRequest.new :code => '1234'
+          expect {
+            req.update_notes! 'foo'
+          }.to change(req, :notes).to 'foo'
+        end
+
+        it 'calls the ECCU service using code and notes' do
+          req = EccuRequest.new :code => '1234'
+          soap_body = SoapBody.any_instance
+          soap_body.should_receive(:integer).with :fileId, 1234
+          soap_body.should_receive(:string).with  :notes, 'foo'
+          req.update_notes! 'foo'
+        end
+
+        it 'calls the ECCU service and return the service boolean response' do
+          req = EccuRequest.new :code => '1234'
+          req.update_notes!('foo').should == true
+        end
+      end
+
+      describe '#update_email' do
+        before { savon.expects('setStatusChangeEmail').returns(:success) }
+
+        it 'updates the email field' do
+          req = EccuRequest.new :code => '1234'
+          expect {
+            req.update_email! 'foo'
+          }.to change(req, :email).to 'foo'
+        end
+
+        it 'calls the ECCU service using code and email' do
+          req = EccuRequest.new :code => '1234'
+          soap_body = SoapBody.any_instance
+          soap_body.should_receive(:integer).with :fileId, 1234
+          soap_body.should_receive(:string).with  :statusChangeEmail, 'foo'
+          req.update_email! 'foo'
+        end
+
+        it 'calls the ECCU service and return the service boolean response' do
+          req = EccuRequest.new :code => '1234'
+          req.update_email!('foo').should == true
+        end
+      end
+
+      describe '#destroy' do
+        before { savon.expects('delete').returns(:success) }
+
+        it 'calls the ECCU service using code' do
+          req = EccuRequest.new :code => '1234'
+          soap_body = SoapBody.any_instance
+          soap_body.should_receive(:integer).with :fileId, 1234
+          req.destroy
+        end
+
+        it 'calls the ECCU service and return the service boolean response' do
+          req = EccuRequest.new :code => '1234'
+          req.destroy.should == true
+        end
+      end
+    end
+  end
+end

data/spec/lib/akamai_api/soap_body_spec.rb

@@ -0,0 +1,51 @@
+module AkamaiApi
+  describe SoapBody do
+    let(:config) { double :env_namespace => '', :soap_version => '2' }
+    subject { SoapBody.new Savon::SOAP::XML.new config}
+
+    it 'adds the soapenc ns' do
+      Savon::SOAP::XML.new(config).namespaces.should_not include 'xmlns:soapenc'
+      subject.soap.namespaces.should include 'xmlns:soapenc'
+    end
+
+    describe '#string' do
+      before { subject.string 'foo', 'sample' }
+
+      it 'adds a string field' do
+        subject.body[:foo].should == 'sample'
+      end
+
+      it 'sets the correct type attribute' do
+        subject.body_attributes[:foo]['xsi:type'].should == 'xsd:string'
+      end
+    end
+
+    describe '#array' do
+      before { subject.array 'foo', ['a', 'b'] }
+
+      it 'adds an array field' do
+        subject.body[:foo].should == { 'item' => ['a', 'b'] }
+      end
+
+      it 'sets the correct type attribute' do
+        subject.body_attributes[:foo]['xsi:type'].should == 'wsdl:ArrayOfString'
+      end
+
+      it 'sets the correct arrayType attribute' do
+        subject.body_attributes[:foo]['soapenc:arrayType'].should == 'xsd:string[2]'
+      end
+    end
+
+    describe '#text' do
+      before { subject.text 'foo', 'foo' }
+
+      it 'adds a base64 encoded string field' do
+        Base64.decode64(subject.body[:foo]).should == 'foo'
+      end
+
+      it 'sets the correct type attribute' do
+        subject.body_attributes[:foo]['xsi:type'].should == 'xsd:base64Binary'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require File.expand_path '../../lib/akamai_api', __FILE__
+require File.expand_path '../auth.rb', __FILE__
+
+require 'savon_spec'
+
+Savon::Spec::Fixture.path = File.expand_path '../fixtures', __FILE__
+Dir[File.expand_path '../support/**/*.rb', __FILE__].each do |f|
+  require f
+end
+
+RSpec.configure do |config|
+  config.include Savon::Spec::Macros
+end

data/spec/support/savon_tester.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+
+module SavonTester
+  extend ActiveSupport::Concern
+
+  included do
+    let(:client) do
+      Savon::Client.new do
+        wsdl.endpoint = "http://example.com"
+        wsdl.namespace = "http://users.example.com"
+      end
+    end
+  end
+
+  def stub_savon_model model
+    model.stub :client => client, :basic_auth => nil
+  end
+end

data/wsdls/ccuapi.wsdl

@@ -0,0 +1,82 @@
+<?xml version="1.0" standalone="no"?>
+<definitions name="PurgeRequest"
+    targetNamespace="http://www.akamai.com/purge"
+    xmlns:tns="http://www.akamai.com/purge"
+    xmlns:purgedt="http://www.akamai.com/purge"
+    xmlns:xsd="http://www.w3.org/2000/10/XMLSchema"
+    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+    xmlns="http://schemas.xmlsoap.org/wsdl/">
+
+    <types>
+        <schema targetNamespace="http://www.akamai.com/purge"
+          xmlns:purgedt="http://www.akamai.com/purge"
+                xmlns="http://www.w3.org/2000/10/XMLSchema" >
+
+
+            <complexType name="ListOfString" base="soap:Array">
+                <sequence>
+                    <element name="string" type="xsd:string"
+                        minOccurs="0" maxOccurs="unbounded" />
+                </sequence>
+            </complexType>
+
+            <complexType name="PurgeResult">
+                <sequence>
+                    <element name="resultCode" type="xsd:int"/>
+                    <element name="resultMsg" type="xsd:string"/>
+                    <element name="sessionID" type="xsd:string"/>
+                    <element name="estTime" type="xsd:int"/>
+                    <element name="uriIndex" type="xsd:int"/>
+                    <element name="modifiers" nullable="true" type="tns:ListOfString"/>
+                </sequence>
+            </complexType>
+
+        </schema>
+    </types>
+
+    <message name="purgeRequest" >
+        <part name="name" type="xsd:string"/>
+        <part name="pwd" type="xsd:string"/>
+        <part name="network" type="xsd:string"/>
+        <part name="opt" nullable="true" type="tns:ListOfString"/>
+        <part name="uri" type="tns:ListOfString"/>
+    </message>
+    <message name="purgeRequestResponse" >
+        <part name="return" type="tns:PurgeResult" />
+    </message>
+
+    <portType name="PurgeApi">
+        <operation name="purgeRequest" paramOrder="name pwd network opt uri">
+            <input  message="tns:purgeRequest"
+                    name="purgeRequest"/>
+            <output message="tns:purgeRequestResponse"/>
+        </operation>
+    </portType>
+
+    <binding name="PurgeApiSOAPBinding" type="tns:PurgeApi">
+        <soap:binding style="rpc"
+                      transport="http://schemas.xmlsoap.org/soap/http"/>
+        <operation name="purgeRequest">
+            <soap:operation soapAction="" style="rpc"/>
+            <input>
+                <soap:body
+                    use="encoded"
+                    namespace="http://www.akamai.com/purge"
+                    encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
+            </input>
+            <output>
+                <soap:body
+                    use="encoded"
+                    namespace="http://www.akamai.com/purge"
+                    encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="JavaClasses">
+        <documentation>Provides programmatic purge access </documentation>
+        <port name="PurgeApi" binding="tns:PurgeApiSOAPBinding">
+            <soap:address
+                location="https://ccuapi.akamai.com:443/soap/servlet/soap/purge"/>
+        </port>
+    </service>
+</definitions>

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: akamai_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nicola Racco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: savon_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Ruby toolkit to work with Akamai Content Control Utility API
+email:
+- nicola@nicolaracco.com
+executables:
+- akamai_api
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Thorfile
+- akamai_api.gemspec
+- bin/akamai_api
+- lib/akamai_api.rb
+- lib/akamai_api/ccu.rb
+- lib/akamai_api/ccu_response.rb
+- lib/akamai_api/cli.rb
+- lib/akamai_api/cli/ccu.rb
+- lib/akamai_api/cli/ccu_arl.rb
+- lib/akamai_api/cli/ccu_cp_code.rb
+- lib/akamai_api/cli/command.rb
+- lib/akamai_api/cli/eccu.rb
+- lib/akamai_api/cli/template.rb
+- lib/akamai_api/cp_code.rb
+- lib/akamai_api/eccu_request.rb
+- lib/akamai_api/soap_body.rb
+- lib/akamai_api/version.rb
+- spec/fixtures/delete/success.xml
+- spec/fixtures/eccu_request.xml
+- spec/fixtures/get_cp_codes/sample.xml
+- spec/fixtures/get_ids/success.xml
+- spec/fixtures/get_info/success.xml
+- spec/fixtures/set_notes/success.xml
+- spec/fixtures/set_status_change_email/success.xml
+- spec/fixtures/upload/fault.xml
+- spec/fixtures/upload/success.xml
+- spec/fixtures/wsdl:purge_request/success.xml
+- spec/lib/akamai_api/ccu_spec.rb
+- spec/lib/akamai_api/cp_code_spec.rb
+- spec/lib/akamai_api/eccu_request_spec.rb
+- spec/lib/akamai_api/soap_body_spec.rb
+- spec/spec_helper.rb
+- spec/support/savon_tester.rb
+- wsdls/ccuapi.wsdl
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby toolkit to work with Akamai Content Control Utility API
+test_files:
+- spec/fixtures/delete/success.xml
+- spec/fixtures/eccu_request.xml
+- spec/fixtures/get_cp_codes/sample.xml
+- spec/fixtures/get_ids/success.xml
+- spec/fixtures/get_info/success.xml
+- spec/fixtures/set_notes/success.xml
+- spec/fixtures/set_status_change_email/success.xml
+- spec/fixtures/upload/fault.xml
+- spec/fixtures/upload/success.xml
+- spec/fixtures/wsdl:purge_request/success.xml
+- spec/lib/akamai_api/ccu_spec.rb
+- spec/lib/akamai_api/cp_code_spec.rb
+- spec/lib/akamai_api/eccu_request_spec.rb
+- spec/lib/akamai_api/soap_body_spec.rb
+- spec/spec_helper.rb
+- spec/support/savon_tester.rb