scene7-wrapper 0.1.0

data/spec/fixtures/get_company_info/company.xml

@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+  <soapenv:Body>
+    <getCompanyInfoReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
+      <companyInfo>
+        <companyHandle>111</companyHandle>
+        <name>Example.com</name>
+        <rootPath>Example.com/</rootPath>
+        <expires>2100-12-31T23:00:00.000-06:00</expires>
+      </companyInfo>
+    </getCompanyInfoReturn>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/get_company_info/test_request.xml

@@ -0,0 +1 @@
+<myxml />

data/spec/fixtures/get_folders/folders.xml

@@ -0,0 +1,26 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+	<soapenv:Body>
+		<getFoldersReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
+			<folderArray>
+				
+				<items>
+					<folderHandle>handle-1</folderHandle>
+					<path>folder-path-1</path>
+					<lastModified>20080726T08:36:19.19305:00</lastModified>
+					<childLastModified>20110308T18:43:20.92706:00</childLastModified>
+					<hasSubfolders>true</hasSubfolders>
+				</items>
+				
+				<items>
+					<folderHandle>handle-2</folderHandle>
+					<path>folder-path-2</path>
+					<lastModified>20110225T13:45:53.55306:00</lastModified>
+					<childLastModified>20110309T21:49:58.21606:00</childLastModified>
+					<hasSubfolders>false</hasSubfolders>
+				</items>
+				
+			</folderArray>
+		</getFoldersReturn>
+	</soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/rename_asset/failure.xml

@@ -0,0 +1 @@
+<?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><soapenv:Fault><faultcode>soapenv:Server</faultcode><faultstring>ipsApiFault</faultstring><detail><tns:ipsApiFault xmlns:tns="http://www.scene7.com/IpsApi/xsd"><tns:code>30000</tns:code><tns:reason>Asset ID 'katlynf' is already in use.</tns:reason></tns:ipsApiFault></detail></soapenv:Fault></soapenv:Body></soapenv:Envelope>

data/spec/fixtures/rename_asset/success.xml

@@ -0,0 +1 @@
+<?xml version='1.0' encoding='UTF-8'?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><renameAssetReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31" /></soapenv:Body></soapenv:Envelope>

data/spec/fixtures/submit_job/upload_urls_job_response.xml

@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+  <soapenv:Body><submitJobReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
+      <jobHandle>j|110|katlyn||</jobHandle>
+    </submitJobReturn>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/scene7/asset_spec.rb

@@ -0,0 +1,195 @@
+require 'spec_helper'
+
+describe Scene7::Asset do
+  subject { Scene7::Asset }
+  let(:valid_config) { {:subdomain => 'test-instance', :user => 'test@example.com', :password => 'password', :app_name => 'MyAppName', :app_version => '1.2' } }
+
+  describe "class methods" do
+    before do
+      Scene7::Client.configure(valid_config)
+      Scene7::Client.stubs(:company_handle).returns('111')
+      Scene7::Client.stubs(:header).returns({
+        :auth_header => {
+        :user => 'test@example.com',
+        :password => 'password',
+        :app_name => 'Example.com',
+        :app_version => '1.0'
+      },
+        :attributes! => { :auth_header => { :xmlns => "http://www.scene7.com/IpsApi/xsd" } }
+      })
+    end
+
+    describe ".find_by_name" do
+      context 'when xml contains one asset' do
+        before do
+          savon.expects(:get_assets_by_name).with(:company_handle => '111', :name_array => {:items => 'Jacket'}, :order! => [:company_handle, :name_array]).returns(:jacket_asset)
+        end
+
+        it "finds an asset" do
+          asset = subject.find_by_name('Jacket')
+          asset.should be_a(Scene7::Asset)
+          asset.name.should == "Jacket"
+        end
+      end
+
+      context 'when xml contains more than one asset' do
+        before do
+          savon.expects(:get_assets_by_name).with(:company_handle => '111', :name_array => {:items => 'Hat'}, :order! => [:company_handle, :name_array]).returns(:hat_asset)
+        end
+
+        it "finds an asset" do
+          asset = subject.find_by_name('Hat')
+          asset.should be_a(Scene7::Asset)
+          asset.handle.should == "a|1234"
+        end
+      end
+    end
+
+    describe ".find_all_by_name" do
+      context 'when xml contains zero assets' do
+        before do
+          savon.expects(:get_assets_by_name).with(:company_handle => '111', :name_array => {:items => 'Does not exist'}, :order! => [:company_handle, :name_array]).returns(:zero_found)
+        end
+
+        it "finds a collection containing that asset" do
+          collection = subject.find_all_by_name('Does not exist')
+          collection.length.should == 0
+        end
+      end
+
+      context 'when xml contains one asset' do
+        before do
+          savon.expects(:get_assets_by_name).with(:company_handle => '111', :name_array => {:items => 'Jacket'}, :order! => [:company_handle, :name_array]).returns(:jacket_asset)
+        end
+
+        it "finds a collection containing that asset" do
+          collection = subject.find_all_by_name('Jacket')
+          collection.length.should == 1
+          collection.first.name.should == "Jacket"
+        end
+      end
+
+      context 'when xml contains more than one asset' do
+        before do
+          savon.expects(:get_assets_by_name).with(:company_handle => '111', :name_array => {:items => 'Hat'}, :order! => [:company_handle, :name_array]).returns(:hat_asset)
+        end
+
+        it "finds a collection containing the assets" do
+          collection = subject.find_all_by_name('Hat')
+          collection.length.should == 2
+          collection.first.handle.should == "a|1234"
+          collection.second.handle.should == "a|1235"
+        end
+      end
+    end
+
+    describe '.create' do
+      before do
+        subject.stubs(:job_name).returns("12345678901234567890")
+
+        savon.expects(:submit_job).with({
+          :company_handle   => '111',
+          :job_name         => '12345678901234567890',
+          :upload_urls_job  => {
+          :url_array => {
+          :items => {
+          :source_url            => "http://example.com/image.jpg",
+          :dest_path             => "SomeRoot/SomeDirectory/image.jpg",
+          :order!                => [:source_url, :dest_path]
+        }
+        },
+          :overwrite          => false,
+          :ready_for_publish  => false,
+          :create_mask        => false,
+          :email_setting      => "None",
+          :order!           => [:url_array, :overwrite, :ready_for_publish, :create_mask, :email_setting]
+        }, 
+          :order!           => [:company_handle, :job_name, :upload_urls_job] 
+        }).returns(:upload_urls_job_response)
+      end
+
+      it "returns once the image object exists" do
+        asset_mock = mock()
+        Scene7::Asset.stubs(:find_by_name).with("image").returns(nil, asset_mock)
+        asset = subject.create(:source_url => "http://example.com/image.jpg", :dest_path => "SomeRoot/SomeDirectory/image.jpg")
+        asset.should == asset_mock
+      end
+
+      it "gives up and assumes an error after 20 seconds" do
+        asset_mock = mock()
+        Scene7::Asset.stubs(:find_by_name).with("image").returns(nil)
+
+        expect { subject.create(:source_url => "http://example.com/image.jpg", :dest_path => "SomeRoot/SomeDirectory/image.jpg") }.to raise_error("Could not create asset")
+      end
+    end
+
+    describe ".job_name" do
+      it "returns a 20-char hash of the name and current time" do
+        Timecop.freeze do
+          require 'digest/sha1'
+          name = Digest::SHA1.hexdigest("test#{Time.now.usec}")[0..20]
+
+          subject.job_name("test").should == name
+        end
+      end
+    end
+  end
+
+  describe "initialization" do
+    let(:attributes) { {:a => 7, :b => 11, :name => "MY_hero", :asset_handle => "...asset handle..." } }
+    subject { Scene7::Asset.new(attributes) }
+
+    its(:attributes) { should == attributes }
+    its(:name) { should == "MY_hero" }
+    its(:handle) { should == "...asset handle..." }
+  end
+
+  describe "#rename" do
+    let(:attributes) { {:a => 7, :b => 11, :name => "MY_hero", :asset_handle => "222" } }
+    subject { Scene7::Asset.new(attributes) }
+
+    before do
+      Scene7::Client.configure(valid_config)
+      Scene7::Client.stubs(:company_handle).returns('111')
+    end
+
+    it "renames the object" do
+      savon.expects(:rename_asset).with({
+        :company_handle => "111",
+        :asset_handle => "222",
+        :new_name => "new name",
+        :validate_name => true,
+        :rename_files => true,
+        :order! => [:company_handle, :asset_handle, :new_name, :validate_name, :rename_files]
+      }).returns(:success)
+
+      subject.rename("new name").should be_true
+      subject.name.should == "new name"
+    end
+
+    it "does not rename the asset if there is a conflict" do
+      savon.expects(:rename_asset).with({
+        :company_handle => "111",
+        :asset_handle => "222",
+        :new_name => "new name",
+        :validate_name => true,
+        :rename_files => true,
+        :order! => [:company_handle, :asset_handle, :new_name, :validate_name, :rename_files]
+      }).returns(:failure)
+
+      expect { subject.rename("new name") }.to raise_error("Could not rename the file -- name already taken.")
+    end
+  end
+
+  describe "#destroy" do
+    before { Scene7::Client.configure(valid_config) }
+    let(:attributes) { {:a => 7, :b => 11, :name => "MY_hero", :asset_handle => "222" } }
+    subject { Scene7::Asset.new(attributes) }
+
+    it "deletes the asset" do
+      Scene7::Client.expects(:company_handle).returns("111")
+      savon.expects(:delete_asset).with(:company_handle => "111", :asset_handle => "222", :order! => [:company_handle, :asset_handle]).returns(:success)
+      subject.destroy.should be_true
+    end
+  end
+end

data/spec/scene7/client_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Scene7::Client do
+  subject { Scene7::Client }
+  let(:valid_config_params) { ['test-instance', 'test@example.com', 'password', 'MyAppName', '1.2'] }
+  let(:valid_config_hash) { {:subdomain => 'test-instance', :user => 'test@example.com', :password => 'password', :app_name => 'MyAppName', :app_version => '1.2' } }
+
+  describe ".configure" do
+    it "sets the configuration" do
+      Scene7::Config.expects(:new).with(*valid_config_params).returns('my config')
+      subject.configure(valid_config_hash)
+
+      subject.configuration.should == 'my config'
+    end
+
+    it "returns the Scene7::Client class" do
+      subject.configure(valid_config_hash).should == Scene7::Client
+    end
+  end
+
+  describe '.reset_configuration' do
+    it "resets the configuration by setting it to nil" do
+      Scene7::Config.expects(:new).with(*valid_config_params).returns('my config')
+      subject.configure(valid_config_hash)
+
+      subject.reset_configuration
+
+      subject.configuration.should be_nil
+    end
+  end
+
+  describe '.header' do
+    it "delegates to the configuration" do
+      subject.configure(valid_config_hash)
+      subject.configuration.expects(:header).returns('the header')
+      subject.header.should == 'the header'
+    end
+
+    it 'blows up if there is no configuration' do
+      expect { subject.header }.to raise_error('Call Scene7::Client.configure with your configuration first.')
+    end
+  end
+
+  describe '.perform_request' do
+    before { subject.configure(valid_config_hash) }
+    it 'performs a SOAP call through the Savon client' do
+      savon.expects(:get_company_info).with(:company_name => 'test').returns(:test_request)
+
+      subject.perform_request(:get_company_info, :company_name => 'test').to_xml.chomp.should == "<myxml />"
+    end
+  end
+
+  describe ".client" do
+    let(:scene7_client) { Scene7::Client.configure(valid_config_hash) }
+    subject { scene7_client.client }
+
+    it "is a Savon::Client object" do
+      subject.should be_a(Savon::Client)
+    end
+
+    it "has the appropriate namespace" do
+      subject.wsdl.namespace.should == "http://www.scene7.com/IpsApi/xsd/2010-01-31"
+    end
+
+    it "has the appropriate endpoint" do
+      subject.wsdl.endpoint.should == "https://test-instance.scene7.com/scene7/services/IpsApiService"
+    end
+  end
+
+  describe '.input_for_action' do
+    subject { Scene7::Client }
+
+    it "camel-cases and appends 'Param' to the action name" do
+      subject.input_for_action(:get_foo).should == 'getFooParam'
+    end
+  end
+  
+  describe '.company_handle' do
+    subject { Scene7::Client }
+
+    before do
+      Scene7::Client.configure(valid_config_hash)
+    end
+
+    it "retrieves the company and returns its handle" do
+      Scene7::Company.expects(:find_by_name).with(valid_config_hash[:app_name]).returns(mock(:handle => 'c|11'))
+      subject.company_handle.should == 'c|11'
+    end
+  end
+
+end

data/spec/scene7/company_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Scene7::Company do
+  describe "initialization" do
+    it "stores attributes" do
+      attributes = {:a => 7, :b => 11} 
+
+      Scene7::Company.new(attributes).attributes == attributes
+    end
+  end
+
+  describe "#name" do
+    it "pulls its data from stored attributes" do
+      attributes = {:name => "Example.com"} 
+
+      Scene7::Company.new(attributes).name.should == "Example.com"
+    end
+  end
+
+  describe "#handle" do
+    it "pulls its data from stored attributes" do
+      attributes = {:company_handle => "...company handle..."} 
+
+      Scene7::Company.new(attributes).handle.should == "...company handle..."
+    end
+  end
+
+  describe "#root_path" do
+    it "pulls its data from stored attributes" do
+      attributes = {:root_path => "Example.com/"} 
+
+      Scene7::Company.new(attributes).root_path.should == "Example.com/"
+    end
+  end
+
+  describe ".find_by_name" do
+    subject { Scene7::Company }
+  let(:valid_config) { {:subdomain => 'test-instance', :user => 'test@example.com', :password => 'password', :app_name => 'MyAppName', :app_version => '1.2' } }
+
+    before do
+      Scene7::Client.configure(valid_config)
+      Scene7::Client.stubs(:header).returns({
+        :auth_header => {
+          :user => 'test@example.com',
+          :password => 'password',
+          :app_name => 'Example.com',
+          :app_version => '1.0'
+        },
+        :attributes! => { :auth_header => { :xmlns => "http://www.scene7.com/IpsApi/xsd" } }
+      })
+
+      savon.expects(:get_company_info).with(:company_name => "Example.com").returns(:company)
+    end
+
+    it "finds a company" do
+      subject.find_by_name('Example.com').should be_a(Scene7::Company)
+    end
+
+    it "has the right handle" do
+      subject.find_by_name('Example.com').handle.should == "111"
+    end
+  end
+end

data/spec/scene7/config_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Scene7::Config do
+  subject { Scene7::Config }
+  let(:valid_options) { ['test-instance', 'test@example.com', 'password', 'MyAppName', '1.2'] }
+
+  describe ".new" do
+    it "configures a subdomain" do
+      config = subject.new(*valid_options)
+      config.subdomain.should == 'test-instance'
+    end
+
+    it "configures a user" do
+      config = subject.new(*valid_options)
+      config.user.should == "test@example.com"
+    end
+
+    it "configures a password" do
+      config = subject.new(*valid_options)
+      config.password.should == "password"
+    end
+
+    it "configures an app name" do
+      config = subject.new(*valid_options)
+      config.app_name.should == "MyAppName"
+    end
+
+    it "configures an app_version" do
+      config = subject.new(*valid_options)
+      config.app_version.should == "1.2"
+    end
+
+    describe 'app_version' do
+      it "is cast to a string" do
+        config = subject.new(*valid_options)
+        config.app_version.should == "1.2"
+      end
+    end
+  end
+
+  describe '#endpoint' do
+    subject { Scene7::Config.new(*valid_options) }
+
+    it 'returns the endpoint containing the subdomain' do
+      subject.endpoint.should == 'https://test-instance.scene7.com/scene7/services/IpsApiService'
+    end
+  end
+
+  describe 'AUTH_NAMESPACE' do
+    Scene7::Config::AUTH_NAMESPACE.should == "http://www.scene7.com/IpsApi/xsd"
+  end
+
+  describe '#header' do
+    subject { Scene7::Config.new(*valid_options) }
+
+    it "returns a hash containing the auth info" do
+      subject.expects(:user).returns('test@example.com')
+      subject.expects(:password).returns('mypassword')
+      subject.expects(:app_name).returns('Example.com')
+      subject.expects(:app_version).returns('1.0')
+
+      header = subject.header
+
+      header[:auth_header].should == {
+        :user => 'test@example.com',
+        :password => 'mypassword',
+        :app_name => 'Example.com',
+        :app_version => '1.0'
+      }
+
+      header[:attributes!].should == {
+        :auth_header => { :xmlns => "http://www.scene7.com/IpsApi/xsd" }
+      }
+
+    end
+  end
+end

data/spec/scene7/crop_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Scene7::Crop do
+  subject { Scene7::Crop }
+
+  describe '.format_url_params' do
+    let(:params) { {
+      :scale_factor => 0.5,
+      :x => 50.0,
+      :y => 100.1,
+      :height => 149.8,
+      :width => 250.2
+    } }
+
+    it 'includes the scale and scale factor' do
+      subject.format_url_params(params).should == "scl=0.5&crop=50,100,250,150"
+    end
+  end
+
+  describe "conversion methods" do
+    let(:params) { {
+      :scale_factor => '2.0',
+      :x => '100',
+      :y => '250',
+      :height => '300',
+      :width => '450'
+    } }
+
+    describe ".convert_from_scale_first_and_format" do
+      it "converts, then formats" do
+        subject.convert_from_scale_first_and_format(params).should == "scl=0.5&crop=50,125,225,150"
+      end
+    end
+
+    describe '.convert_params_from_scale_first' do
+      before do
+        @result = subject.convert_params_from_scale_first(params)
+      end
+
+      it "converts the scale factor from the scale-first style" do
+        @result[:scale_factor].should == 0.5
+      end
+
+      it "converts the height from the scale-first style" do
+        @result[:height].should == 150
+      end
+
+      it "converts the width from the scale-first style" do
+        @result[:width].should == 225
+      end
+
+      it "converts the left coordinate from the scale-first style" do
+
+        @result[:x].should == 50
+      end
+
+      it "converts the top coordinate from the scale-first style" do
+        @result[:y].should == 125
+      end
+    end
+  end
+end

data/spec/scene7/folder_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Scene7::Folder do
+  subject { Scene7::Folder }
+  let(:valid_config) { {:subdomain => 'test-instance', :user => 'test@example.com', :password => 'password', :app_name => 'MyAppName', :app_version => '1.2' } }
+
+  describe "public API" do
+    before do
+      Scene7::Client.configure(valid_config)
+      Scene7::Client.stubs(:company_handle).returns('111')
+      Scene7::Client.stubs(:header).returns({
+        :auth_header => {
+        :user => 'test@example.com',
+        :password => 'password',
+        :app_name => 'Example.com',
+        :app_version => '1.0'
+      },
+        :attributes! => { :auth_header => { :xmlns => "http://www.scene7.com/IpsApi/xsd" } }
+      })
+    end
+
+    describe ".all" do
+      it "retrieves all folders" do
+        savon.expects(:get_folders).with(:company_handle => "111").returns(:folders)
+
+        subject.all
+      end
+
+      it "retrives a collection of Folders" do
+        savon.stubs(:get_folders).with(:company_handle => "111").returns(:folders)
+
+        folders = subject.all
+
+        folders.all? { |f| f.is_a?(subject) }.should be_true
+      end
+
+      it "returns folders that are properly initialized" do
+        savon.stubs(:get_folders).with(:company_handle => "111").returns(:folders)
+
+        folders = subject.all
+
+        folder = folders.first
+
+        folder.handle.should          == "handle-1"
+        folder.path.should            == "folder-path-1"
+        folder.last_modified.should   == "20080726T08:36:19.19305:00"
+        folder.has_subfolders.should  == true
+      end
+    end
+
+    describe ".find_by_file_handle" do
+      it "should return a single folder instance" do
+        savon.stubs(:get_folders).with(:company_handle => "111").returns(:folders)
+       
+        folder = Scene7::Folder.find_by_handle("handle-2")
+
+        folder.handle.should == "handle-2"
+        folder.path.should   == "folder-path-2"
+      end
+
+      it "should return nil if the file does not exist" do
+        savon.stubs(:get_folders).with(:company_handle => "111").returns(:folders)
+       
+        Scene7::Folder.find_by_handle("non-existant-handle").should be_nil
+      end
+    end
+
+    describe ".create" do
+      pending "it handles errors"
+        # already exists
+        # bad path
+
+      it "creates a folder" do
+        savon.expects(:create_folder).with(:company_handle => "111", :folder_path => "SomeRoot/SomeFolder", :order! => [:company_handle, :folder_path]).returns(:folder)
+
+        subject.create(:folder_path => "SomeRoot/SomeFolder")
+      end
+
+      it "should return a folder that knows its handle" do
+        savon.stubs(:create_folder).with(:company_handle => "111", :folder_path => "SomeRoot/SomeFolder").returns(:folder)
+
+        response = subject.create(:folder_path => "SomeRoot/SomeFolder")
+
+        response.handle.should == "exampleFolderHandle"
+      end
+
+      it "should raise an error if folder path is not set" do
+        savon.stubs(:create_folder)
+
+        expect { subject.create(:bogus_param => "bogus!") }.should raise_error(RuntimeError, ":folder_path is required to create a folder")
+      end
+    end
+
+    describe "#destroy" do
+      it "should destroy a folder" do
+        folder = Scene7::Folder.new(:folder_handle => "folder-handle-1")
+
+        savon.expects(:delete_folder).with(:company_handle => "111", :folder_handle => "folder-handle-1", :order! => [:company_handle, :folder_handle]).returns(:empty_response)
+
+        folder.destroy
+      end
+
+      it "should return true if the deletion is successful" do
+        folder = Scene7::Folder.new(:folder_handle => "folder-handle-1")
+
+        savon.stubs(:delete_folder).with(:company_handle => "111", :folder_handle => "folder-handle-1").returns(:empty_response)
+
+        folder.destroy.should be_true
+      end
+
+      pending "error handling"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'scene7-wrapper'
+require 'savon_spec'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.include Savon::Spec::Macros
+
+  config.before(:each) do
+    Scene7::Client.reset_configuration
+  end
+end
+
+Savon::Spec::Fixture.path = File.join(File.dirname(__FILE__), 'fixtures')
+Savon.configure do |config|
+  config.log = false
+end