brandmaker 0.1.0

data/lib/brandmaker/job_config.rb

@@ -0,0 +1,18 @@
+module Brandmaker
+  class JobConfig
+    attr_accessor :technical_name
+    attr_accessor :variables
+
+    def initialize technical_name, variables = []
+      @technical_name = technical_name
+      @variables = variables
+    end
+
+    def add_variables *vars
+      vars.each_with_index do |var, index|
+        hash = var.is_a?(Hash) ? var : { :name => var }
+        variables << VariableConfig.new(hash)
+      end
+    end
+  end
+end

data/lib/brandmaker/media_variable.rb

@@ -0,0 +1,7 @@
+module Brandmaker
+  class MediaVariable < Variable
+    def value
+      super.split(",").join("\n")
+    end
+  end
+end

data/lib/brandmaker/variable.rb

@@ -0,0 +1,37 @@
+require 'active_support/inflector'
+
+module Brandmaker
+  class Variable
+    attr_accessor :config
+
+    def initialize data, config = VariableConfig.new
+      @data = data
+      @config = config
+    end
+
+    def data
+      @data
+    end
+
+    def technical_name
+      @data[:technical_name]
+    end
+
+    def value
+      @data[:value]
+    end
+
+    def purpose
+      # purpose is actually not provided by the api
+      @data[:purpose] || config.purpose
+    end
+
+    def label
+      config.label || technical_name.humanize
+    end
+
+    def type_id
+      @data[:variable_type_id]
+    end
+  end
+end

data/lib/brandmaker/variable_collection.rb

@@ -0,0 +1,26 @@
+module Brandmaker
+  class VariableCollection < Array
+
+    def initialize variables, create = true
+      if create
+        super variables.map { |var| Brandmaker::Variable.new(var) }
+      else
+        super variables
+      end
+    end
+
+    def find_by_technical_name(technical_name)
+      find { |variable| variable.technical_name == technical_name }
+    end
+
+    def find_by_purpose(purpose)
+      find do |variable|
+        variable.purpose == purpose 
+      end || raise("#{purpose} is not configured for this job")
+    end
+
+    def unpurposed
+      VariableCollection.new self.select { |var| var.purpose.blank? }, false
+    end
+  end
+end

data/lib/brandmaker/variable_config.rb

@@ -0,0 +1,39 @@
+require 'brandmaker/variable'
+require 'brandmaker/media_variable'
+require 'brandmaker/grid_variable'
+
+module Brandmaker
+  class VariableConfig
+    attr_accessor :name
+
+    attr_accessor :label
+    attr_accessor :content_type
+    attr_accessor :purpose
+
+    VARIABLE_TYPES = {
+      :""             => Variable,
+      :media          => MediaVariable,
+      :external_media => ExternalMediaVariable,
+      :grid           => GridVariable
+    }
+
+    def initialize(*h)
+      if h.length == 1 && h.first.kind_of?(Hash)
+        h.first.each { |k,v| send("#{k}=",v) }
+      end
+    end
+
+    def to_typed_instance(data)
+      type = content_type
+      klass = VARIABLE_TYPES[content_type.to_s.downcase.to_sym]
+      unless klass.nil?
+        instance = klass.new(data)
+        instance.config = self
+        instance
+      else
+        raise "Unknown variable type #{type}"
+      end
+    end
+  end
+
+end

data/lib/brandmaker/variable_purpose.rb

@@ -0,0 +1,7 @@
+module Brandmaker
+  class VariablePurpose
+    EMAIL_RECIPIENT = 'email_recipient'
+    EMAIL_SUBJECT = 'email_subject'
+    EMAIL_MESSAGE = 'email_message'
+  end
+end

data/lib/brandmaker/version.rb

@@ -0,0 +1,3 @@
+module Brandmaker
+  VERSION = "0.1.0"
+end

data/spec/brandmaker/configuration_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module Brandmaker
+  describe Configuration do
+
+    describe 'default configuration' do
+      it 'initializes a default configuration' do
+        Brandmaker.configuration.should be_a(Configuration)
+      end
+
+      it 'initializes an empty job_configs hash' do
+        Brandmaker.configuration.job_configs.should == {}
+      end
+
+      it 'initializes a default dse_client' do
+        Brandmaker.configuration.dse_client.should be_a(Savon::Client)
+      end
+
+      it 'initializes a default media_pool_client' do
+        Brandmaker.configuration.media_pool_client.should be_a(Savon::Client)
+      end
+    end
+
+    describe '#configure' do
+      context 'when calling configure' do
+        before :each do
+          Brandmaker.configure do |c|
+            c.user = 'user'
+            c.password = 'user'
+            c.dse_service = 'dse_service_url'
+            c.media_pool_service = 'media_pool_url'
+          end
+        end
+
+        it 'creates a dse_client with the given configuration' do
+          Brandmaker.configuration.dse_client.wsdl.document.should == 'dse_service_url'
+          Brandmaker.configuration.dse_client.wsdl.endpoint.should == 'dse_service_url'
+        end
+
+        it 'creates a media_pool_client with the given configuration' do
+          Brandmaker.configuration.media_pool_client.wsdl.document.should == 'media_pool_url'
+          Brandmaker.configuration.media_pool_client.wsdl.endpoint.should == 'media_pool_url'
+        end
+      end
+    end
+  end
+end

data/spec/brandmaker/custom_structure_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Brandmaker::CustomStructure do
+
+  describe 'class methods' do
+    before do
+      Brandmaker::CustomStructure.stub!(:find_all_custom_structures)
+      .and_return(mock(Object, :body => custom_structure_all_data))
+    end
+
+    describe '.all' do
+      it 'returns an array of Brandmaker::CustomStructure instances' do
+        Brandmaker::CustomStructure.all.should be_all { |cs| cs.should be_a(Brandmaker::CustomStructure) }
+      end
+    end
+
+    describe '.find_by_technical_name' do
+      context 'when the technical name successfully matches a mapping' do
+        it 'returns an instance of Brandmaker::CustomStructure' do
+          Brandmaker::CustomStructure.find_by_technical_name('anbieter_hinzufgen').should be_a(Brandmaker::CustomStructure)
+        end
+
+        it 'accesses the custom structure collection' do
+          Brandmaker::CustomStructure.should_receive(:all).and_return []
+          Brandmaker::CustomStructure.find_by_technical_name('anbieter_hinzufgen')
+        end
+      end
+
+      context 'when the technical name does not match a mapping' do
+        it 'returns nil' do
+          Brandmaker::CustomStructure.find_by_technical_name('anything').should be_nil
+        end
+
+        it 'does not access the collection' do
+          Brandmaker::CustomStructure.should_not_receive(:all)
+          Brandmaker::CustomStructure.find_by_technical_name('anything')
+        end
+      end
+    end
+
+    describe '.custom_structure_name_for_mapped_technical_name' do
+      it 'maps a technical name of variable to a custom structure name' do
+        mapped_value = 'PM_ExterneSuppliers_Druckereien'
+        Brandmaker::CustomStructure.custom_structure_name_for_mapped_technical_name('anbieter_hinzufgen').should == mapped_value
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    let :custom_structure do
+      Brandmaker::CustomStructure.new custom_structure_external_suppliers_data
+    end
+
+    describe '#name' do
+      it 'returns the name' do
+        custom_structure.name.should == 'PM_ExterneSuppliers_Druckereien'
+      end
+    end
+
+    describe '#label' do
+      it 'returns the label' do
+        custom_structure.label.should == 'PM_ExterneSuppliers_Druckereien'
+      end
+    end
+
+    describe '#objects' do
+      it 'returns an array of hashes' do
+        custom_structure.objects.should be_all { |h| h.should be_a(Hash) }
+      end
+    end
+  end
+end
+

data/spec/brandmaker/external_media_variable_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'json'
+
+module Brandmaker
+  describe ExternalMediaVariable do
+
+    describe '#value' do
+      context 'when no value is available' do
+        it 'returns nil' do
+          var = ExternalMediaVariable.new({ :value => nil })
+          var.value.should be_nil
+        end
+      end
+
+      context 'when a single value is available' do
+        it 'returns that value' do
+          var = ExternalMediaVariable.new({ :value => "one" })
+          var.value.should == 'one'
+        end
+      end
+
+      context 'when multiple values are available' do
+        it 'returns the last value' do
+          var = ExternalMediaVariable.new({ :value => "one,two" })
+          var.value.should == 'two'
+        end
+      end
+    end
+
+    describe '#reload' do
+      before :each do
+        Brandmaker.configuration.external_media_service = 'URL'
+        Brandmaker.configuration.external_media_service_secret = 'SECRET'
+      end
+
+      let :var do
+        ExternalMediaVariable.new({ :value => "130" })
+      end
+
+      context 'with valid mediaID' do
+        before :each do
+          RestClient.should_receive(:get).with(
+            'URL', {:params => {:mediaID => "130", :secret => 'SECRET'}}
+          ).and_return({
+            :downloadUrl => "download url",
+            :fileOriginalName => "original name"
+          }.to_json)
+        end
+
+        it 'fetches media variable attributes from the API' do
+          var.reload
+          var.fileOriginalName.should == 'original name'
+          var.downloadUrl.should == 'download url'
+        end
+
+        it 'returns self' do
+          var.reload.should be(var)
+        end
+      end
+
+      context 'with invalid mediaID' do
+        it 'fetches media variable attributes from the API' do
+          RestClient.should_receive(:get).and_return({
+            :ERROR => "Requested media not found!"
+          }.to_json)
+          expect { var.reload }.to raise_error(/Requested media not found/)
+        end
+      end
+    end
+
+  end
+end

data/spec/brandmaker/grid_variable_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+module Brandmaker
+  describe GridVariable do
+    describe '#value' do
+
+      context 'without a matching custom structure' do
+        context 'when the purpose is not present' do
+          let :grid_var do
+            g = Brandmaker::GridVariable.new grid_variable_data
+            g.stub!(:custom_structure).and_return(nil)
+            g
+          end
+
+          it 'returns an array of values' do
+            grid_var.value.should == grid_var.actual_values
+          end
+
+          it 'returns the actual values' do
+            grid_var.should_receive(:actual_values).once
+            grid_var.should_not_receive(:custom_structure_values)
+            grid_var.value
+          end
+        end
+
+        context 'when the purpose is the email recipient' do
+          let :grid_var do
+            g = Brandmaker::GridVariable.new grid_variable_email_data
+            g.stub!(:custom_structure).and_return(nil)
+            g.stub(:purpose).and_return(VariablePurpose::EMAIL_RECIPIENT)
+            g
+          end
+
+          it 'returns an array of email addresses' do
+            grid_var.value.should == %w(immanuel.haeussermann@screenconcept.ch michael.friedli@gateb.com)
+          end
+
+          it 'parses the values' do
+            grid_var.should_receive(:extract_email).twice
+            grid_var.value
+          end
+        end
+      end
+
+      context 'with a matching custom structure' do
+        it 'returns the custom structure values' do
+          grid_var = Brandmaker::GridVariable.new grid_variable_data
+          grid_var.stub(:custom_structure).and_return Brandmaker::CustomStructure.new({})
+          grid_var.should_receive(:custom_structure_values).once.and_return %w(A B)
+          grid_var.value.should == %w(A B)
+        end
+      end
+    end
+
+    describe '#actual_values' do
+      let :grid_var do
+        Brandmaker::GridVariable.new grid_variable_data
+      end
+
+      it 'does not fail' do
+        grid_var.stub(:rows).and_return [{:worthless => nil}]
+        expect { grid_var.actual_values }.to_not raise_error
+      end
+
+      it 'returns an array of values' do
+        grid_var.value.should == %w(Immanuel Michi)
+      end
+    end
+
+    describe '#custom_structure_values' do
+      let :custom_structure do
+        Brandmaker::CustomStructure.new :objects => [
+          {:name => 'Immanuel', :label => 'Immanuel X'},
+          {:name => 'Michi', :label => 'Michi X'}
+        ]
+      end
+
+      let :grid_var do
+        g = Brandmaker::GridVariable.new(grid_variable_data)
+        g.stub(:custom_structure).and_return custom_structure
+        g
+      end
+
+      it 'returns the mapped custom structure values' do
+        grid_var.custom_structure_values.should == ['Immanuel X', 'Michi X']
+      end
+    end
+
+    describe '#extract_email' do
+      it 'parses the email address from the value' do
+        grid_var = Brandmaker::GridVariable.new({})
+        grid_var.stub!(:custom_structure).and_return(nil)
+        address = grid_var.extract_email('Immanuel (immanuel.haeussermann@screenconcept.ch)')
+        address.should == 'immanuel.haeussermann@screenconcept.ch'
+      end
+    end
+
+    describe '#rows' do
+      context 'when there is only a single row returned as hash from the API' do
+        let :grid_var do
+          Brandmaker::GridVariable.new grid_variable_single_row_data
+        end
+
+        it 'returns an array' do
+          grid_var.rows.should be_a(Array)
+        end
+
+        it 'does not fail' do
+          expect { grid_var.rows }.to_not raise_error
+        end
+      end
+
+      context 'when there are multiple rows returns as array from the API' do
+        let :grid_var do
+          Brandmaker::GridVariable.new grid_variable_data
+        end
+
+        it 'returns an array' do
+          grid_var.rows.should be_a(Array)
+        end
+
+        it 'does not fail' do
+          expect { grid_var.rows }.to_not raise_error
+        end
+      end
+    end
+
+    describe '#custom_structure' do
+      context 'when the technical name is mapped' do
+        before do
+          Brandmaker::CustomStructure.should_receive(:find_all_custom_structures)
+          .and_return(mock(Object, :body => custom_structure_all_data))
+        end
+
+        it 'returns a custom structure' do
+          grid_var = Brandmaker::GridVariable.new({:technical_name => 'anbieter_hinzufgen'})
+          grid_var.custom_structure.should be_a(Brandmaker::CustomStructure)
+        end
+      end
+
+      context 'when the technical name is not mapped' do
+        before do
+          Brandmaker::CustomStructure.should_not_receive(:find_all_custom_structures)
+        end
+
+        it 'returns nil' do
+          grid_var = Brandmaker::GridVariable.new({:technical_name => 'anything'})
+          grid_var.custom_structure.should be_nil
+        end
+      end
+    end
+  end
+end