sfc-custom 0.3 → 0.6

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.6. Changes from VPS, some unit tests, start of Ruby 1.9 compatibility
+
+v0.5. CDATA
+
+v0.4. Thumbnail option
+
 v0.3. Rename custom.rb to sfc-custom.rb
 
 v0.2. Fix ext/ dependency

data/Manifest

@@ -1,5 +1,10 @@
-README
-Manifest
-LICENSE
-lib/sfc-custom.rb
 CHANGELOG
+lib/sfc-custom.rb
+LICENSE
+Manifest
+Rakefile
+README
+test/fixtures/expected_output_for_test_personalized_vps_order_with_logo.xml
+test/fixtures/expected_output_for_test_personalized_vps_order_with_text.xml
+test/fixtures/expected_output_for_test_standard_vps_order.xml
+test/test_sfc-custom.rb

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'echoe'
+
+Echoe.new('sfc-custom') do |p|
+  p.author = "SFC Limited, Inc."
+  p.summary = "Library for accessing SFCcustom, a web service for generating dynamic content for print"
+  p.dependencies = ["xml-simple"]
+  p.project = "sfc"
+  p.clean_pattern = ["pkg", "doc", 'build/*', '**/*.o', '**/*.so', '**/*.a', '**/*.log', "{ext,lib}/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/Makefile", "{ext,lib}/**/*.{bundle,so,obj,pdb,lib,def,exp}", "ext/**/Makefile", "pkg", "*.gem", ".config"]
+end

data/lib/sfc-custom.rb

@@ -1,5 +1,5 @@
 # = SFCcustom
-# Ruby interface for SFC's Custom templating engine
+# Ruby interface for SFCcustom, a web service for generating dynamic content for print
 #
 #  == Requirements
 #  * xmlsimple (gem install xml-simple)
@@ -14,9 +14,9 @@
 #  sign.generate!                 # => #<SFCcustom::Template:0x604654 @name="Sign">
 
 require 'rubygems'
+require 'xmlsimple' unless defined?(XmlSimple)
 require 'cgi'
 require 'net/http'
-require 'xmlsimple' unless defined?(XmlSimple)
 require 'digest/md5'
 require 'base64'
 require 'builder'
@@ -38,9 +38,12 @@ class SFCcustom
     []
   end
 
-  # Upload a new template to SFCcustom, +data+ can either be a Base64-encoded
-  # string or a Tempfile or File object. In either case it must be a PDF file
-  # with PDFlib blocks. Returns a hash with :status and :blocks
+  # Upload a new template to SFCcustom, by passing a +URL+ of a PDF file with
+  # PDFlib blocks. +digest+ (optional) is the MD5 digest of the file, compared
+  # after the file has been processed to ensure it has been transferred
+  # properly.
+  #
+  # Returns a hash with :status and :blocks
   def upload(name, url, digest = nil)
     
     r = request('UploadTemplate', { :name => name, :url => url, :digest => digest})
@@ -58,16 +61,20 @@ class SFCcustom
     return result
   end
   
-  # Delete an existing template, return true or false on success or failure
+  # Delete an existing template.
+  #
+  # Return +true+ or +false+ on success or failure, respectively
   def delete(name)
     r = request('DeleteTemplate', { :name => name })
     return r['status'] == ' ok '    
   end
   
-  def generate(name, params, resize = nil, cache = true, copy = nil)
-    request('GenerateCustom', { :name => name, :data => params, :resize => resize, :cache => cache, :copy => copy})
+  # Generate custom output based on +name+ template and +params+
+  def generate(name, params, resize = nil, cache = true, copy = nil, thumbnail = true)
+    request('GenerateCustom', { :name => name, :data => params, :resize => resize, :cache => cache, :copy => copy, :thumbnail => thumbnail})
   end
   
+  # List the fonts available
   def fonts
     request('ListFonts')
   end
@@ -117,7 +124,7 @@ class SFCcustom
     attr_accessor :name, :type
   end 
   
-  def request(type, params = nil)
+  def build_request(type, params = nil)
     builder = Builder::XmlMarkup.new(:indent => 2)
     builder.instruct!(:xml, :version => "1.0", :encoding => "UTF-8")
 
@@ -126,29 +133,29 @@ class SFCcustom
         a.key(api_key)
       end
       case type
-        when 'UploadTemplate':
+        when 'UploadTemplate'
           b.template do |t|
             t.name(params[:name])
             t.url(params[:url])
             t.digest(params[:digest])
           end
 
-        when 'UploadAsset':
+        when 'UploadAsset'
           b.asset do |t|
             t.filename(params[:filename])
             t.data(params[:data])
           end
 
-        when 'DeleteTemplate':
+        when 'DeleteTemplate'
           b.template do |t|
             t.name(params[:name])
           end
         
-        when 'ListTemplates':
+        when 'ListTemplates'
         
-        when 'ListFonts':
+        when 'ListFonts'
         
-        when 'GenerateCustom':
+        when 'GenerateCustom'
           b.template do |t|
             t.name(params[:name])
           end
@@ -160,7 +167,9 @@ class SFCcustom
           b.output do |t|
             t.resize(params[:resize]) if params[:resize]
             t.copy(params[:copy]) if params[:copy]
+            t.thumbnail(params[:thumbnail].to_s)
           end
+          
           b.blocks do |bl|
             params[:data].each do |k, v|
               
@@ -182,6 +191,32 @@ class SFCcustom
                     else
                       blo.asset(v)
                     end                    
+                  elsif v.is_a?(Hash)
+                    blo.template do
+                      blo.name v['template']
+                    end
+                    blo.blocks do
+                      v.each do |kk, vv|
+                        if kk == 'template'
+                        else
+                          if kk =~ /^PDF/
+                            blo.pdf do
+                              blo.name kk
+                              if vv.match(/http/i)
+                                blo.url vv
+                              else
+                                blo.asset vv
+                              end
+                            end
+                          else
+                            blo.text do
+                              blo.name kk
+                              blo.value {|x| x.cdata!(vv) }
+                            end
+                          end
+                        end
+                      end
+                    end
                   else
                     blo.url(v['url'])
                   end
@@ -189,8 +224,8 @@ class SFCcustom
                   blo.rotate(v['rotate']) if v['rotate']
                   blo.position(v['position']) if v['position']
                 else
-                  if v.is_a?(String)
-                    blo.value(v)
+                  if v.is_a?(String) || v.nil?
+                    blo.value {|x| x.cdata!(v.to_s) }
                   else
                     blo.value(v['value'])
                     blo.font(v['font']) if v['font']
@@ -204,6 +239,12 @@ class SFCcustom
       end
     end
     
+    return xml   
+  end
+  
+  def request(type, params = nil)
+    xml = build_request(type, params)
+    
     puts xml
     
     http = Net::HTTP.new(host, 80)
@@ -225,7 +266,7 @@ class SFCcustom
     rescue
       raise SFCcustomResultException
     end
-    
+    puts result.inspect
     return result
   end
 end

data/sfc-custom.gemspec

@@ -1,31 +1,36 @@
-
-# Gem::Specification for Sfc-custom-0.3
-# Originally generated by Echoe
-
 Gem::Specification.new do |s|
   s.name = %q{sfc-custom}
-  s.version = "0.3"
-  s.date = %q{2007-09-21}
-  s.summary = %q{Library for accessing SFCcustom, a web service for generating dynamic content for print}
+  s.version = "0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["SFC Limited, Inc."]
+  s.date = %q{2008-11-17}
+  s.description = %q{Library for accessing SFCcustom, a web service for generating dynamic content for print}
   s.email = %q{}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/sfc-custom.rb", "LICENSE", "README"]
+  s.files = ["CHANGELOG", "lib/sfc-custom.rb", "LICENSE", "Manifest", "Rakefile", "README", "test/fixtures/expected_output_for_test_personalized_vps_order_with_logo.xml", "test/fixtures/expected_output_for_test_personalized_vps_order_with_text.xml", "test/fixtures/expected_output_for_test_standard_vps_order.xml", "test/test_sfc-custom.rb", "sfc-custom.gemspec"]
+  s.has_rdoc = true
   s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sfc-custom", "--main", "README"]
+  s.require_paths = ["lib"]
   s.rubyforge_project = %q{sfc}
-  s.description = %q{Library for accessing SFCcustom, a web service for generating dynamic content for print}
-  s.has_rdoc = true
-  s.authors = ["SFC Limited, Inc."]
-  s.files = ["README", "Manifest", "LICENSE", "lib/sfc-custom.rb", "CHANGELOG", "sfc-custom.gemspec"]
-  s.add_dependency(%q<xml-simple>, ["> 0.0.0"])
-end
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Library for accessing SFCcustom, a web service for generating dynamic content for print}
+  s.test_files = ["test/test_sfc-custom.rb"]
 
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
 
-# # Original Rakefile source (requires the Echoe gem):
-# 
-# require 'rubygems'
-# require 'echoe'
-# 
-# Echoe.new('sfc-custom') do |p|
-#   p.author = "SFC Limited, Inc."
-#   p.summary = "Library for accessing SFCcustom, a web service for generating dynamic content for print"
-#   p.dependencies = ["xml-simple"]
-#   p.project = "sfc"
-# end
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/test/fixtures/expected_output_for_test_personalized_vps_order_with_logo.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GenerateCustom>
+  <authentication>
+    <key>92be4756d943439c73f20ec165bacca9</key>
+  </authentication>
+  <template>
+    <name>LMSERIESNW_back</name>
+  </template>
+  <output>
+    <thumbnail>false</thumbnail>
+  </output>
+  <blocks>
+    <text>
+      <name>TEXT_SKU</name>
+      <value>
+        <![CDATA[09PRESBI-001]]>
+      </value>
+    </text>
+    <pdf>
+      <name>PDF_CONTRACTOR_TYPE</name>
+      <template>
+        <name>Logo_Only</name>
+      </template>
+      <blocks>
+        <pdf>
+          <name>PDF_CONTRACTOR_LOGO</name>
+          <url>http://ctsamples.com/logos/0000/0389/7bc10cce32aaa4287d4fc0c1ded49627.pdf</url>
+        </pdf>
+        <text>
+          <name>TEXT_ADDITIONAL_INFORMATION</name>
+          <value>
+            <![CDATA[]]>
+          </value>
+        </text>
+      </blocks>
+    </pdf>
+    <text>
+      <name>TEXT_BARCODE</name>
+      <value>
+        <![CDATA[*CT-04191-1-1*]]>
+      </value>
+    </text>
+  </blocks>
+</GenerateCustom>

data/test/fixtures/expected_output_for_test_personalized_vps_order_with_text.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GenerateCustom>
+  <authentication>
+    <key>92be4756d943439c73f20ec165bacca9</key>
+  </authentication>
+  <template>
+    <name>LMSERIESNW_back</name>
+  </template>
+  <output>
+    <thumbnail>false</thumbnail>
+  </output>
+  <blocks>
+    <text>
+      <name>TEXT_SKU</name>
+      <value>
+        <![CDATA[LMSERIESNW-002]]>
+      </value>
+    </text>
+    <pdf>
+      <name>PDF_CONTRACTOR_TYPE</name>
+      <template>
+        <name>SMC</name>
+      </template>
+      <blocks>
+        <text>
+          <name>TEXT_CONTRACTOR_NAME</name>
+          <value>
+            <![CDATA[www.customquality.net]]>
+          </value>
+        </text>
+        <text>
+          <name>TEXT_ADDITIONAL_INFORMATION</name>
+          <value>
+            <![CDATA[<avoidbreak=true>472-2282<avoidbreak=false>
+<avoidbreak=true>Custom Quality <avoidbreak=false>
+<avoidbreak=true>Construction Inc<avoidbreak=false>]]>
+          </value>
+        </text>
+      </blocks>
+    </pdf>
+    <text>
+      <name>TEXT_BARCODE</name>
+      <value>
+        <![CDATA[*CT-03037-1-1*]]>
+      </value>
+    </text>
+  </blocks>
+</GenerateCustom>

data/test/fixtures/expected_output_for_test_standard_vps_order.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GenerateCustom>
+  <authentication>
+    <key>92be4756d943439c73f20ec165bacca9</key>
+  </authentication>
+  <template>
+    <name>LMSERIESNW_back</name>
+  </template>
+  <output>
+    <thumbnail>false</thumbnail>
+  </output>
+  <blocks>
+    <text>
+      <name>TEXT_SKU</name>
+      <value>
+        <![CDATA[09LMPREMAV-004]]>
+      </value>
+    </text>
+    <text>
+      <name>TEXT_BARCODE</name>
+      <value>
+        <![CDATA[*CT-XXXXX-1-1*]]>
+      </value>
+    </text>
+  </blocks>
+</GenerateCustom>

data/test/test_sfc-custom.rb

@@ -0,0 +1,78 @@
+require 'test/unit'
+
+module Kernel
+  def __method__
+    caller[0][/`([^']*)'/, 1]
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+require 'sfc-custom'
+
+$rakefile = nil # Avoids a warning in rdoctask.rb
+
+class TestSFCcustom < Test::Unit::TestCase
+  def setup
+    
+  end
+
+  def test_basics
+    sfc = SFCcustom.new('44a568611beab6e76daef41a81f38ebe')
+    assert sfc
+    assert_kind_of(SFCcustom, sfc)
+  end
+  
+  def test_personalized_vps_order_with_logo
+    custom = SFCcustom.new('92be4756d943439c73f20ec165bacca9')
+    blocks = {
+      "TEXT_BARCODE" => "*CT-04191-1-1*",
+      "TEXT_SKU"     => "09PRESBI-001",
+      "PDF_CONTRACTOR_TYPE" => {
+        "template"                    => "Logo_Only",
+        "PDF_CONTRACTOR_LOGO"         => "http://ctsamples.com/logos/0000/0389/7bc10cce32aaa4287d4fc0c1ded49627.pdf",
+        "TEXT_ADDITIONAL_INFORMATION" => ""
+      }
+    }
+
+    output = custom.build_request("GenerateCustom", { :name => "LMSERIESNW_back", :data => blocks, :resize => nil, :cache => false, :copy => nil, :thumbnail => false})
+    
+    expected = File.open(File.join(File.dirname(__FILE__), 'fixtures', "expected_output_for_#{__method__}.xml")).read
+  
+    assert_equal expected, output
+  end
+  
+  def test_personalized_vps_order_with_text
+    custom = SFCcustom.new('92be4756d943439c73f20ec165bacca9')
+    blocks = {
+      "TEXT_BARCODE"  => "*CT-03037-1-1*",
+      "TEXT_SKU"      => "LMSERIESNW-002",
+      "PDF_CONTRACTOR_TYPE" => {
+        "template"                    => "SMC",
+        "TEXT_CONTRACTOR_NAME"        => "www.customquality.net",
+        "TEXT_ADDITIONAL_INFORMATION" => %Q(<avoidbreak=true>472-2282<avoidbreak=false>
+<avoidbreak=true>Custom Quality <avoidbreak=false>
+<avoidbreak=true>Construction Inc<avoidbreak=false>)
+      }
+    }
+    output = custom.build_request("GenerateCustom", { :name => "LMSERIESNW_back", :data => blocks, :resize => nil, :cache => false, :copy => nil, :thumbnail => false})
+    
+    expected = File.open(File.join(File.dirname(__FILE__), 'fixtures', "expected_output_for_#{__method__}.xml")).read
+  
+    assert_equal expected, output
+  end
+  
+  def test_standard_vps_order
+    # This is not abstracted from a real order
+    custom = SFCcustom.new('92be4756d943439c73f20ec165bacca9')
+    blocks = {
+      "TEXT_BARCODE" => "*CT-XXXXX-1-1*",
+      "TEXT_SKU"     => "09LMPREMAV-004",
+    }
+    output = custom.build_request("GenerateCustom", { :name => "LMSERIESNW_back", :data => blocks, :resize => nil, :cache => false, :copy => nil, :thumbnail => false})
+    
+    expected = File.open(File.join(File.dirname(__FILE__), 'fixtures', "expected_output_for_#{__method__}.xml")).read
+  
+    assert_equal expected, output
+  end
+  
+end

metadata

@@ -1,59 +1,90 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: sfc-custom
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2007-09-21 00:00:00 -04:00
-summary: Library for accessing SFCcustom, a web service for generating dynamic content for print
-require_paths: 
-- lib
-email: ""
-homepage: ""
-rubyforge_project: sfc
-description: Library for accessing SFCcustom, a web service for generating dynamic content for print
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: "0.6"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - SFC Limited, Inc.
-files: 
-- README
-- Manifest
-- LICENSE
-- lib/sfc-custom.rb
-- CHANGELOG
-- sfc-custom.gemspec
-test_files: []
-
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2008-11-17 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: xml-simple
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Library for accessing SFCcustom, a web service for generating dynamic content for print
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/sfc-custom.rb
+- LICENSE
+- README
+files: 
+- CHANGELOG
+- lib/sfc-custom.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README
+- test/fixtures/expected_output_for_test_personalized_vps_order_with_logo.xml
+- test/fixtures/expected_output_for_test_personalized_vps_order_with_text.xml
+- test/fixtures/expected_output_for_test_standard_vps_order.xml
+- test/test_sfc-custom.rb
+- sfc-custom.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sfc-custom
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: sfc
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Library for accessing SFCcustom, a web service for generating dynamic content for print
+test_files: 
+- test/test_sfc-custom.rb