brandmaker 0.1.0

data/spec/brandmaker/job_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Brandmaker::Job do
+
+  let :job do
+    Brandmaker::Job.new main_job_data
+  end
+
+  let :job_config do
+    nil
+  end
+
+  describe '#id' do
+    it 'returns the id' do
+      job.id.should == '8193'
+    end
+  end
+
+  describe '#technical_name' do
+    it 'returns the technical_name' do
+      job.technical_name.should == 'screenconcept__hauptjob'
+    end
+  end
+
+  around :each do |example|
+    Brandmaker.configure do |config|
+      config.job_configs[:screenconcept__hauptjob] = job_config
+    end
+
+    example.run
+
+    Brandmaker.configure do |config|
+      config.job_configs.delete :screenconcept__hauptjob
+    end
+  end
+
+  describe '#config' do
+    context 'when a job config exists' do
+      let :job_config do
+        Brandmaker::JobConfig.new(job.technical_name)
+      end
+
+      it 'returns the job config' do
+        job.config.should == job_config
+      end
+    end
+
+    context 'when no job config exists' do
+      it 'raises an exception' do
+        expect { job.config }.to raise_error "Job #{job.id} is not configured, no config for #{job.technical_name}"
+      end
+    end
+  end
+
+  describe '#variables' do
+    let :job_config do
+      Brandmaker::JobConfig.new job.technical_name, [
+        Brandmaker::VariableConfig.new(:name => 'default_media'),
+        Brandmaker::VariableConfig.new(:name => 'some_email_recipient', :purpose => Brandmaker::VariablePurpose::EMAIL_RECIPIENT)
+      ]
+    end
+
+    before :each do
+      Brandmaker.configure do |config|
+        config.job_configs[:screenconcept__hauptjob] = job_config
+      end
+    end
+
+    it 'returns all variables which are configured in the job config' do
+      job.variables.count.should be(1)
+    end
+
+    it 'returns a list of Variables' do
+      job.variables.should be_all { |v| v.should be_a(Brandmaker::Variable) }
+    end
+  end
+
+  describe '#recipients' do
+    let :job_config do
+      Brandmaker::JobConfig.new job.technical_name, [
+        Brandmaker::VariableConfig.new(:name => 'email_field1', :purpose => Brandmaker::VariablePurpose::EMAIL_RECIPIENT)
+      ]
+    end
+
+    it 'returns an array' do
+      job.recipients.should == %w(test@test.com)
+    end
+  end
+end

data/spec/brandmaker/seed_data.rb

@@ -0,0 +1,206 @@
+# encoding: utf-8
+
+module Brandmaker
+  module SeedData
+
+    def main_job_data
+      {
+        :processing_time=>"0",
+        :success=>true,
+        :desriptions=> {
+          :creator=>"Screenconcept",
+          :id=>"8193",
+          :topic_name=>"Job",
+          :type_name=>"screenconcept__hauptjob",
+          :variable=> [
+            {
+              :technical_name=>"WorkflowOverdueDate",
+              :value=> '20.04.2015',
+              :variable_type_id=>"-115"
+            },
+            {
+              :technical_name=>"default_media",
+              :value=> 'Some Value',
+              :variable_type_id=>"-2008"
+            },
+            {
+              :technical_name=>"medienobjektauswahl",
+              :value=>"7961,7270",
+              :variable_type_id=>"11111"
+            },
+            {
+              :technical_name=>"email_field1",
+              :value=>"test@test.com",
+              :variable_type_id=>"11112"
+            },
+            {
+              :technical_name=>"email_field2",
+              :value=>"Email Subject",
+              :variable_type_id=>"11113"
+            },
+            {
+              :technical_name=>"email_field3",
+              :value=>"Email message",
+              :variable_type_id=>"11114"
+            },
+            {
+              :sub_jobs=> {
+                :sub_job=> {
+                  :creator=>"Screenconcept",
+                  :id=>"8194",
+                  :topic_name=>"Job",
+                  :type_name=>"screenconcept__subjob",
+                  :variable=> [
+                    {
+                      :technical_name=>"WorkflowOverdueDate",
+                      :value=>nil,
+                      :variable_type_id=>"-115"
+                    },
+                    {
+                      :technical_name=>"default_media",
+                      :value=>nil,
+                      :variable_type_id=>"-2008"
+                    },
+                  ],
+                :workflow_step_name=>"Start",
+                :workflow_type_name=>"Screenconcept - Testworkflow"
+                }
+              },
+            :technical_name=>"SubJobs",
+            :value=>nil,
+            :variable_type_id=>"-105"
+          },
+          grid_variable_data,
+          {
+            :technical_name=>"TaskManager",
+            :value=>nil,
+            :variable_type_id=>"11047"
+          },
+        ],
+        :workflow_step_name=>"Start",
+        :workflow_type_name=>"Screenconcept - Testworkflow"
+        }
+      }
+    end
+
+    def grid_variable_data
+      {
+        :grid=>
+          {
+            :row=>
+              [{
+                :id=>"7898",
+                :topic_name=>"Job",
+                :variable=>
+                {
+                  :technical_name=>"emailadresse",
+                  :value=>"Immanuel",
+                  :variable_type_id=>"11247"
+                }
+              },
+              {
+                :id=>"7899",
+                :topic_name=>"Job",
+                :variable=>
+                {
+                  :technical_name=>"emailadresse",
+                  :value=>"Michi",
+                  :variable_type_id=>"11247"
+                }
+              }
+            ]
+          },
+        :technical_name=>"email_selection",
+        :value=>nil,
+        :variable_type_id=>"11245"
+      }
+    end
+
+    def grid_variable_single_row_data
+      {
+        :grid=>
+          {
+            :row=>
+              {
+                :id=>"7898",
+                :topic_name=>"Job",
+                :variable=>
+                {
+                  :technical_name=>"emailadresse",
+                  :value=>"Immanuel",
+                  :variable_type_id=>"11247"
+                }
+              }
+          },
+        :technical_name=>"email_selection",
+        :value=>nil,
+        :variable_type_id=>"11245"
+      }
+    end
+
+    def grid_variable_email_data
+      {
+        :grid=>
+          {
+            :row=>
+              [{
+                :id=>"7898",
+                :topic_name=>"Job",
+                :variable=>
+                {
+                  :technical_name=>"emailadresse",
+                  :value=>"Immanuel (immanuel.haeussermann@screenconcept.ch)",
+                  :variable_type_id=>"11247"
+                }
+              },
+              {
+                :id=>"7899",
+                :topic_name=>"Job",
+                :variable=>
+                {
+                  :technical_name=>"emailadresse",
+                  :value=>"Michi (michael.friedli@gateb.com)",
+                  :variable_type_id=>"11247"
+                }
+              }
+            ]
+          },
+        :technical_name=>"email_selection",
+        :value=>nil,
+        :variable_type_id=>"11245"
+      }
+    end
+
+    def custom_structure_all_data
+      {:find_all_custom_structures_response=>
+      {:return=>
+        {:processing_time=>"0",
+         :success=>true,
+         :custom_structures=>
+          [
+            custom_structure_external_suppliers_data
+          ]}}}
+    end
+
+    def custom_structure_all_empty_data
+      {:find_all_custom_structures_response=>
+      {:return=>
+        {:processing_time=>"0",
+         :success=>true,
+         :custom_structures=>
+          []}}}
+    end
+
+    def custom_structure_external_suppliers_data
+      {:label=>"PM_ExterneSuppliers_Druckereien",
+            :name=>"PM_ExterneSuppliers_Druckereien",
+            :objects=>
+             [{:label=>"Demo Druck (immanuel.haeussermann@screenconcept.ch)",
+               :name=>"Demo Druck"},
+              {:label=>"Demo Druck 2 (michael.friedli@gateb.com)",
+               :name=>"Demo Druck 2"}
+              ]}
+    end
+
+  end
+end

data/spec/brandmaker/variable_collection_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Brandmaker::VariableCollection do
+
+  let :collection do
+    Brandmaker::VariableCollection.new([
+        { :technical_name => 'one' },
+        { :technical_name => 'two', :purpose => Brandmaker::VariablePurpose::EMAIL_RECIPIENT },
+        { :technical_name => 'three' }
+      ])
+  end
+
+  describe '#initialize' do
+    it 'collects JobVariables' do
+      collection.count.should be(3)
+    end
+  end
+
+  describe '#find_by_technical_name' do
+    context 'when the variable exists in the collection' do
+      it 'returns the variable' do
+        collection.find_by_technical_name('two').should be_a(Brandmaker::Variable)
+      end
+    end
+
+    context 'when the variable does not exist in the collection' do
+      it 'returns nil' do
+        collection.find_by_technical_name('five').should be_nil
+      end
+    end
+  end
+
+  describe '#find_by_purpose' do
+    context 'when the variable exists in the collection' do
+      it 'returns the variable' do
+        collection.find_by_purpose(Brandmaker::VariablePurpose::EMAIL_RECIPIENT).should be_a(Brandmaker::Variable)
+      end
+    end
+
+    context 'when the variable does not exist in the collection' do
+      it 'raises an exception' do
+        expect { collection.find_by_purpose(Brandmaker::VariablePurpose::EMAIL_MESSAGE) }.to raise_error "#{Brandmaker::VariablePurpose::EMAIL_MESSAGE} is not configured for this job"
+      end
+    end
+  end
+
+  describe '#unporposed' do
+    it 'returns all variables without purpose' do
+      collection.unpurposed.length.should be(2)
+    end
+
+    it 'returns a VariableCollection' do
+      collection.unpurposed.should be_a(Brandmaker::VariableCollection)
+    end
+  end
+end

data/spec/brandmaker/variable_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module Brandmaker
+  describe Variable do
+
+    describe '#purpose' do
+      let :purpose do
+        'purpose'
+      end
+
+      context 'when API provides purpose' do
+        let :variable do
+          Variable.new({ :purpose => purpose })
+        end
+
+        it 'returns purpose from API' do
+          variable.purpose.should == purpose
+        end
+      end
+
+      context 'when API provides no purpose' do
+        let :variable do
+          Variable.new({}).tap do |v|
+            v.config = VariableConfig.new({ :purpose => purpose })
+          end
+        end
+
+        it 'returns purpose from variable config' do
+          variable.purpose.should be(purpose)
+        end
+      end
+
+      context 'when neither API nor config provides purpose' do
+        let :variable do
+          Variable.new({})
+        end
+
+        it 'returns nil' do
+          variable.purpose.should be_nil
+        end
+      end
+    end
+
+    describe '#label' do
+      let :variable do
+        Variable.new({:technical_name => 'technical_name'})
+      end
+
+      context 'when label is configured' do
+        it 'returns configured label' do
+          variable.config = VariableConfig.new({ :label => 'label' })
+          variable.label.should == 'label'
+        end
+      end
+
+      context 'when label is not configured' do
+        it 'returns humanized technical_name' do
+          variable.label.should == 'Technical name'
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'brandmaker'
+require 'brandmaker/seed_data'
+
+require 'pry'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include Brandmaker::SeedData
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: brandmaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Immanuel Häussermann
+- Sebastian de Castelberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows access to BrandMaker JobManager (DSE) and MediaPool APIs
+email:
+- developers@screenconcept.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- brandmaker.gemspec
+- lib/brandmaker.rb
+- lib/brandmaker/configuration.rb
+- lib/brandmaker/custom_structure.rb
+- lib/brandmaker/external_media_variable.rb
+- lib/brandmaker/grid_variable.rb
+- lib/brandmaker/job.rb
+- lib/brandmaker/job_config.rb
+- lib/brandmaker/media_variable.rb
+- lib/brandmaker/variable.rb
+- lib/brandmaker/variable_collection.rb
+- lib/brandmaker/variable_config.rb
+- lib/brandmaker/variable_purpose.rb
+- lib/brandmaker/version.rb
+- spec/brandmaker/configuration_spec.rb
+- spec/brandmaker/custom_structure_spec.rb
+- spec/brandmaker/external_media_variable_spec.rb
+- spec/brandmaker/grid_variable_spec.rb
+- spec/brandmaker/job_spec.rb
+- spec/brandmaker/seed_data.rb
+- spec/brandmaker/variable_collection_spec.rb
+- spec/brandmaker/variable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/screenconcept/brandmaker
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby based BrandMaker API
+test_files:
+- spec/brandmaker/configuration_spec.rb
+- spec/brandmaker/custom_structure_spec.rb
+- spec/brandmaker/external_media_variable_spec.rb
+- spec/brandmaker/grid_variable_spec.rb
+- spec/brandmaker/job_spec.rb
+- spec/brandmaker/seed_data.rb
+- spec/brandmaker/variable_collection_spec.rb
+- spec/brandmaker/variable_spec.rb
+- spec/spec_helper.rb