brandmaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 465a9280f15999620616b433538f1160675be864
+  data.tar.gz: ac65d3c9d3eecec276af7c1e12306b7e07bb922f
+SHA512:
+  metadata.gz: 6a7607738ef57fbb3bf703eb026a1fc670f7b5e9e8904b224da915a61396a9704c51d4bd2f311d40d92812a384f801e6595694f52027d1f5cf2bf3f2054f4b26
+  data.tar.gz: 88868a715738c2399386f86dbe14c5c72cf26004807d67bcbad060014718748900c4042cc756d346e985309b35d4b877c1fc4ec5875ebc6d96df60dd0ff224ac

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# CHANGELOG
+
+## 2013-05-06 - v0.1.0
+
+* Additional `fileType` in ExternalMediaVariable
+* Disable Savon stdout logging
+* Support comma separated values (last element is picked)
+
+## 2013-04-08 - v0.0.1
+
+* Extract common BrandMaker code
+* Update and fix specs
+* Remove Rails code
+* Make configuration Rails independent

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in brandmaker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sebastian de Castelberg
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Brandmaker
+
+BrandMaker Client written in ruby. Implements Access to the
+following BrandMaker APIs:
+
+* JobManager (DSE)
+
+Access to the Media Pool API is planned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'brandmaker',
+      :git => "git@github.com:screenconcept/brandmaker.git",
+      :tag => 'v0.x.y'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Configuration
+
+Enter the BrandMaker SOAP API information in a new initializer file
+
+    # file: config/initializers/brandmaker.rb
+    Brandmaker.configure do |conf|
+      conf.user = 'username'
+      conf.password = 'password'
+      conf.dse_service = 'https://<url>/webservices/dse/?wsdl'
+      conf.media_pool_service = 'https://<url>/webservices/MediaPool/?wsdl'
+
+      config = Brandmaker::JobConfig.new('job_type_technical_name').tap do |c|
+        c.add_variables(
+          { :name => :JobName, :label => 'Job name' },
+          # ...
+        )
+      end
+
+      conf.job_configs = {
+        :job_type_technical_name => job_type_technical_name
+      }
+    end
+
+Make sure to add a valid JobConfiguration for the corresponding job type.
+See [here](https://github.com/screenconcept/job_manager/blob/config/initializers/brandmaker.rb) for a sample initializer file.
+
+#### Variable Configuration
+
+Simple variable
+
+    c.add_variables 'Variable A', 'Variable B'
+
+Custom variable
+
+    c.add_variables { :name => :JobName, :label => 'Job name' },
+
+Available Variable configuration options
+
+    {
+      name: 'Variable Name',
+      label: 'Human readable label',
+      purpose: Brandmaker::VariablePurpose.EMAIL_RECIPIENT,
+      content_type: :media | :grid
+    }
+
+### Job fetching
+
+Fetch a specific Job calling the find method on the `Job` class
+
+    job = Job.find 1000
+    # Access the variables
+    job.variables
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/brandmaker.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brandmaker/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "brandmaker"
+  gem.version       = Brandmaker::VERSION
+  gem.authors       = ["Immanuel Häussermann", "Sebastian de Castelberg"]
+  gem.email         = ["developers@screenconcept.ch"]
+  gem.description   = %q{Allows access to BrandMaker JobManager (DSE) and MediaPool APIs}
+  gem.summary       = %q{Ruby based BrandMaker API}
+  gem.homepage      = "https://github.com/screenconcept/brandmaker"
+
+  gem.files         = `git ls-files`.split($/)
+  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.add_dependency 'savon', '~> 1.2.0'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'rest-client'
+  gem.add_dependency 'json'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+end

data/lib/brandmaker.rb

@@ -0,0 +1,17 @@
+require "brandmaker/version"
+require "brandmaker/configuration"
+require "brandmaker/job_config"
+require "brandmaker/variable_purpose"
+require "brandmaker/custom_structure"
+require "brandmaker/grid_variable"
+require "brandmaker/job"
+require "brandmaker/media_variable"
+require "brandmaker/external_media_variable"
+require "brandmaker/variable_config"
+require "brandmaker/variable"
+require "brandmaker/variable_collection"
+
+Savon.configure do |config|
+  config.log = false
+  config.log_level = :info
+end

data/lib/brandmaker/configuration.rb

@@ -0,0 +1,46 @@
+module Brandmaker
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+
+    configuration.dse_client = Savon.client do |wsdl, http, wsse|
+      wsdl.document = configuration.dse_service
+      wsdl.endpoint = configuration.dse_service
+      http.auth.basic(configuration.user, configuration.password)
+    end
+
+    configuration.media_pool_client = Savon.client do |wsdl, http, wsse|
+      wsdl.document = configuration.media_pool_service
+      wsdl.endpoint = configuration.media_pool_service
+      http.auth.basic(configuration.user, configuration.password)
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :user
+    attr_accessor :password
+    attr_accessor :dse_service
+    attr_accessor :media_pool_service
+    attr_accessor :external_media_service
+    attr_accessor :external_media_service_secret
+    attr_accessor :job_configs
+
+    attr_accessor :dse_client
+    attr_accessor :media_pool_client
+
+    def initialize
+      @job_configs = {}
+      @media_pool_client = Savon.client
+      @dse_client = Savon.client
+    end
+  end
+
+end

data/lib/brandmaker/custom_structure.rb

@@ -0,0 +1,54 @@
+require 'brandmaker/configuration'
+
+require 'savon'
+
+module Brandmaker
+  class CustomStructure
+    extend Savon::Model
+
+    actions :find_all_custom_structures
+
+    def self.client
+      Brandmaker.configuration.dse_client
+    end
+
+    class << self
+      def find_by_technical_name technical_name
+        name = custom_structure_name_for_mapped_technical_name(technical_name)
+        unless name.nil?
+          all.find { |cs| cs.name == name }
+        else
+          nil
+        end
+      end
+
+      def all
+        find_all_custom_structures.body[:find_all_custom_structures_response][:return][:custom_structures].collect do |data|
+          CustomStructure.new data
+        end
+      end
+
+      def custom_structure_name_for_mapped_technical_name technical_name
+        {
+          'anbieter_hinzufgen' => 'PM_ExterneSuppliers_Druckereien'
+        }[technical_name]
+      end
+    end
+
+    def initialize data
+      @data = data
+    end
+
+    def name
+      @data[:name]
+    end
+
+    def label
+      @data[:name]
+    end
+
+    def objects
+      @data[:objects]
+    end
+  end
+end

data/lib/brandmaker/external_media_variable.rb

@@ -0,0 +1,37 @@
+require 'rest_client'
+require 'json'
+
+module Brandmaker
+  class ExternalMediaVariable < Variable
+    attr_accessor :downloadUrl
+    attr_accessor :fileOriginalName
+    attr_accessor :fileType
+
+    def value
+      super.split(",").last rescue nil
+    end
+
+    def reload
+      if value.present?
+        res = RestClient.get(
+          Brandmaker.configuration.external_media_service,
+          {
+            :params => {
+              :mediaID => value,
+              :secret => Brandmaker.configuration.external_media_service_secret
+            }
+          }
+        )
+        hash = JSON.parse(res)
+        error = hash['ERROR'].presence
+        if error
+          raise error
+        end
+        self.fileOriginalName = hash['fileOriginalName']
+        self.downloadUrl = hash['downloadUrl']
+        self.fileType = hash['fileType']
+        self
+      end
+    end
+  end
+end

data/lib/brandmaker/grid_variable.rb

@@ -0,0 +1,55 @@
+require 'active_support/core_ext'
+
+require 'brandmaker/variable'
+
+module Brandmaker
+  class GridVariable < Variable
+    def value
+      begin
+        if custom_structure.present?
+          values = custom_structure_values
+        else
+          values = actual_values
+        end
+
+        if purpose == VariablePurpose::EMAIL_RECIPIENT
+          values.map { |val| extract_email val }.compact
+        else
+          values
+        end
+      rescue
+        super
+      end
+    end
+
+    def actual_values
+      rows.map do |row|
+        row.try(:[], :variable).try(:[], :value).presence
+      end.compact
+    end
+
+    def custom_structure_values
+      actual_values.collect do |val|
+        obj = custom_structure.objects.find do |object|
+          object[:name] == val
+        end
+        obj[:label]
+      end
+    end
+
+    def rows
+      values = @data[:grid][:row]
+      values = [values] if values.is_a? Hash
+      values
+    end
+
+    def extract_email val
+      val.match(/\(([^)]+)\)/).try(:[], 1)
+    end
+
+    def custom_structure
+      @custom_structure ||= Brandmaker::CustomStructure.find_by_technical_name(self.technical_name)
+      @custom_structure
+    end
+  end
+end

data/lib/brandmaker/job.rb

@@ -0,0 +1,57 @@
+require 'brandmaker/configuration'
+
+require 'savon'
+
+module Brandmaker
+  class Job
+    extend Savon::Model
+
+    actions :find_by_id
+
+    def self.client
+      Brandmaker.configuration.dse_client
+    end
+
+    # ”desriptions" is a brandmaker typo in API
+
+    def self.find id
+      Job.new find_by_id({:id => id}).body[:find_by_id_response][:return]
+    end
+
+    def initialize data
+      @data = data
+      @plain_variables ||= Brandmaker::VariableCollection.new @data[:desriptions][:variable]
+    end
+
+    def id
+      @data[:desriptions][:id]
+    end
+
+    def technical_name
+      @data[:desriptions][:type_name]
+    end
+
+    def config
+      Brandmaker.configuration.job_configs[self.technical_name.to_sym] or raise "Job #{self.id} is not configured, no config for #{self.technical_name}"
+    end
+
+    def variables
+      available_variable_names = @plain_variables.map(&:technical_name)
+      @variables ||= Brandmaker::VariableCollection.new(
+        config.variables.select do |variable_config|
+          available_variable_names.include? variable_config.name.to_s
+        end.collect do |variable_config|
+          variable = @plain_variables.find_by_technical_name(variable_config.name.to_s)
+          configured_variable = variable_config.to_typed_instance(variable.data)
+          configured_variable.config = variable_config
+          configured_variable
+        end, false)
+    end
+
+    def recipients
+      val = variables.find_by_purpose(VariablePurpose::EMAIL_RECIPIENT).value
+      val = [val] unless val.is_a? Array
+      val
+    end
+  end
+end