postalmethods 1.1.3 → 1.1.4

data/lib/postalmethods/send_postcard.rb

@@ -0,0 +1,95 @@
+module PostalMethods
+  
+  module SendPostcard
+    
+    def send_postcard_and_address_advanced(opts)
+      raise PostalMethods::NoPreparationException unless self.prepared 
+      #Add in any default settings
+      opts = get_settings().merge(opts)
+      rv = @rpc_driver.sendPostcardAndAddress(opts)
+      
+      #Handle the return value
+      status_code = rv.sendPostcardAndAddressResult.to_i
+      if status_code > 0
+        return status_code
+      elsif API_STATUS_CODES.has_key?(status_code)
+        instance_eval("raise APIStatusCode#{status_code.to_s.gsub(/( |\-)/,'')}Exception")
+      end
+    end
+
+    def send_postcard_and_address(image_side_filename, address_side_filename, address, description="Sent at #{Time.now()}", work_mode = "Default")
+      raise PostalMethods::NoPreparationException unless self.prepared 
+
+      if( image_side_filename.index("MyFile:") )
+        is_name = image_side_filename
+      else
+        is_name = upload_file(image_side_filename)
+      end
+      if(address_side_filename.index("MyFile:") )
+        as_name = address_side_filename
+      else
+        as_name = upload_file(address_side_filename)
+      end
+
+      ## push a postcard over the api
+      opts = {
+        :MyDescription => description,
+        :ImageSideFileType => is_name,
+        :AddressSideFileType => as_name
+      }
+
+      opts.merge!(address)
+      return send_postcard_and_address_advanced(opts)
+    end
+
+    def get_settings
+      return {
+        :APIKey=> self.api_key,
+        :WorkMode => self.work_mode,
+        :ImageSideScaling => self.imageSideScaling,
+        :PrintColor=>self.printColor,
+        :PostcardSize=>self.postcardSize,
+        :MailingPriority=>self.mailingPriority
+      }
+    end
+    
+    def upload_file(doc, description="", overwrite=true, work_mode="") 
+      if doc.class == String
+        opts = upload_file_options_with_strings(doc, description, overwrite, work_mode)
+      else
+        opts = upload_file_options_with_hash(doc)
+      end
+
+      status_code = self.rpc_driver.uploadFile(opts).uploadFileResult
+
+      if status_code == "-3000"
+        return "MyFile:#{opts[:MyFileName]}"
+      elsif API_STATUS_CODES.has_key?(status_code)
+        instance_eval("raise APIStatusCode#{status_code.to_s.gsub(/( |\-)/,'')}Exception")
+      end
+    end
+
+    def upload_file_options_with_strings(doc_name, description="", overwrite=true, work_mode="") 
+      file_name=File.basename(doc_name)
+      file_data = open(doc_name, "rb") {|io| io.read } 
+      opts = {
+         :APIKey => self.api_key,
+	       :MyFileName => file_name,
+	       :FileBinaryData => file_data,
+	       :Permissions => self.permissions,
+	       :MyDescription => description,
+	       :Overwrite => overwrite
+      }
+      return opts
+    end
+
+    def upload_file_options_with_hash(user_opts)
+      #Add in the api key
+      user_opts.merge!({:APIKey=> self.api_key})
+      return user_opts
+    end
+
+
+  end
+  
+end

data/postalmethods.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{postalmethods}
-  s.version = "1.1.3"
+  s.version = "1.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Cox", "Joe Fair"]
@@ -8,7 +8,14 @@ Gem::Specification.new do |s|
   s.description = %q{API wrapper library for the postal methods api.}
   s.email = ["joe@bodkinconsulting.com"]
   s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "README.txt"]
-  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "README.txt", "Rakefile", "config/hoe.rb", "config/requirements.rb", "lib/postalmethods.rb", "lib/postalmethods/document_processor.rb", "lib/postalmethods/exceptions.rb", "lib/postalmethods/get_letter_status.rb", "lib/postalmethods/send_letter.rb", "lib/postalmethods/utility.rb", "postalmethods.gemspec", "script/console", "script/destroy", "script/generate", "setup.rb", "spec/doc/WSDL-Output", "spec/doc/default.rb", "spec/doc/defaultMappingRegistry.rb", "spec/doc/sample.pdf", "spec/document_processor_spec.rb", "spec/get_letter_status_spec.rb", "spec/postalmethods_spec.rb", "spec/rcov.opts", "spec/send_letter_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/utility_spec.rb", "tasks/rspec.rake", "spec/doc/postcard_address_side_with_return_address.html", "spec/doc/postcard_image_side_with_return_address.html"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "README.txt", "Rakefile", "config/hoe.rb", "config/requirements.rb", "lib/postalmethods.wsdl", "lib/postalmethods.rb", "lib/postalmethods/document_processor.rb", "lib/postalmethods/exceptions.rb", "lib/postalmethods/get_letter_status.rb", "lib/postalmethods/send_letter.rb", "lib/postalmethods/send_postcard.rb", "lib/postalmethods/utility.rb", "postalmethods.gemspec", "script/console", "script/destroy", "script/generate", "setup.rb", "spec/doc/sample_image.jpg", "spec/doc/WSDL-Output", "spec/doc/default.rb", "spec/doc/defaultMappingRegistry.rb", "spec/doc/sample.pdf", "spec/document_processor_spec.rb", "spec/get_letter_status_spec.rb", "spec/postalmethods_spec.rb", "spec/rcov.opts", "spec/send_letter_spec.rb", "spec/send_postcard_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/utility_spec.rb", "tasks/rspec.rake", "spec/doc/postcard_address_side_with_return_address.html", "spec/doc/postcard_image_side_with_return_address.html", 
+
+
+
+
+
+  
+  ]
   s.has_rdoc = true
   s.homepage = 'http://www.postalmethods.com/resources/quickstart'
   s.post_install_message = %q{PostInstall.txt}

data/spec/send_postcard_spec.rb

@@ -0,0 +1,126 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Send Postcard" do
+  
+  before :each do
+    #Unique id - miliseconds
+    @time_id = (Time.now.to_f * 1000).to_i
+
+    @sample_image_name = "spec/doc/sample_image.jpg"
+    @doc = open(File.dirname(__FILE__) + '/doc/sample.pdf', 'rb'){|io| io.read}
+    @client = PostalMethods::Client.new(PM_OPTS)
+
+    @address_details = {
+      :AttentionLine1 => "The White House",
+      :Address1 => "1600 Pennsylvania Avenue NW",
+      :City => "Washington",
+      :State => "DC",
+      :PostalCode => "20500",
+      :Country => "USA"
+    }
+
+  end
+  
+  it "should upload a file" do
+    @client.prepare!
+    @client.upload_file(@sample_image_name).should == "MyFile:#{File.basename(@sample_image_name)}"
+  end
+
+  it "should upload a file from local binary data" do
+    @client.prepare!
+    @sample_data = open(@sample_image_name, "rb") {|io| io.read } 
+    @upload_details = {
+      :MyFileName => "sample_image_file.jpg",
+      :FileBinaryData => @sample_data,
+      :Permissions => "Account",
+      :Description => "Sample File #{@time_id}",
+      :Overwrite => true
+    }
+    filename = @client.upload_file(@upload_details)
+    filename.should == "MyFile:sample_image_file.jpg"
+  end
+
+  it "should upload a file from local binary data THEN send a postcard" do
+    @client.prepare!
+    @sample_data = IO.read(@sample_image_name)
+    @upload_details = {
+      :MyFileName => "sample_image_file.jpg",
+      :FileBinaryData => @sample_data,
+      :Permissions => "Account",
+      :Description => "Sample File #{@time_id}",
+      :Overwrite => true
+    }
+    filename = @client.upload_file(@upload_details)
+    filename.should == "MyFile:sample_image_file.jpg"
+    @client.send_postcard_and_address(filename, filename, @address_details).should > 0
+  end
+
+  it "should instantiate and send a postcard" do
+    @client.prepare!
+    @client.send_postcard_and_address(@sample_image_name, @sample_image_name, @address_details, "Sample Postcard at #{Time.now()}").should > 0
+  end
+
+  it "should upload a file THEN send a postcard" do
+    @client.prepare!
+    filename = @client.upload_file(@sample_image_name)
+    filename.should == "MyFile:#{File.basename(@sample_image_name)}"
+    @client.send_postcard_and_address(filename, filename, @address_details).should > 0
+  end
+  
+  it "should refuse to send a postcard before prepare" do
+    lambda {@client.send_letter(@doc, "the long goodbye")}.should raise_error(PostalMethods::NoPreparationException)
+  end  
+  
+  it "should raise the proper exception when trying to send a missing file" do
+    @client.prepare!
+    lambda {@client.send_postcard_and_address("missing.jpg", "missing.jpg", @address_details)}.should raise_error(Errno::ENOENT)
+  end
+
+  it "should upload a template" do
+    @addr_template_filename = File.dirname(__FILE__) + '/../spec/doc/postcard_address_side_with_return_address.html'
+    @addr_template = open(@addr_template_filename, 'rb'){|io| io.read }
+    @client.prepare!
+    @client.upload_file(@addr_template_filename).should == "MyFile:#{File.basename(@addr_template_filename)}"
+  end
+  
+  it "should send a postcard with two templates" do
+    @img_template_filename = File.dirname(__FILE__) + '/../spec/doc/postcard_image_side_with_return_address.html'
+    @img_template = open(@img_template_filename, 'rb'){|io| io.read }
+    @addr_template_filename = File.dirname(__FILE__) + '/../spec/doc/postcard_address_side_with_return_address.html'
+    @addr_template = open(@addr_template_filename, 'rb'){|io| io.read }
+    opts={}
+
+    #Prepare address side
+    opts[:AddressSideFileType]="HTML"
+    opts[:MyDescription]="Sending Two Template Postcard #{Time.now}"
+    opts[:AddressSideBinaryData]=@addr_template
+
+    #Prepare image side
+    opts[:ImageSideFileType]="HTML"
+    opts[:ImageSideBinaryData]=@img_template
+
+    opts.merge!@address_details
+    @client.prepare!
+    @client.send_postcard_and_address_advanced(opts).should > 0
+  end
+
+  it "should send a postcard with an image and template" do
+    @addr_template_filename = File.dirname(__FILE__) + '/../spec/doc/postcard_address_side_with_return_address.html'
+    @addr_template = open(@addr_template_filename, 'rb'){|io| io.read }
+    opts={}
+
+    #Prepare address side
+    opts[:AddressSideFileType]="HTML"
+    opts[:MyDescription]="Sending Template Postcard #{Time.now}"
+    opts[:AddressSideBinaryData]=@addr_template
+
+    #Prepare image side
+    opts[:ImageSideFileType]="jpg"
+    opts[:ImageSideBinaryData]=open(@sample_image_name){|io| io.read}
+
+    opts.merge!@address_details
+    @client.prepare!
+    @client.send_postcard_and_address_advanced(opts).should > 0
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: postalmethods
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 27
   prerelease: false
   segments: 
   - 1
   - 1
-  - 3
-  version: 1.1.3
+  - 4
+  version: 1.1.4
 platform: ruby
 authors: 
 - James Cox
@@ -75,17 +75,20 @@ files:
 - Rakefile
 - config/hoe.rb
 - config/requirements.rb
+- lib/postalmethods.wsdl
 - lib/postalmethods.rb
 - lib/postalmethods/document_processor.rb
 - lib/postalmethods/exceptions.rb
 - lib/postalmethods/get_letter_status.rb
 - lib/postalmethods/send_letter.rb
+- lib/postalmethods/send_postcard.rb
 - lib/postalmethods/utility.rb
 - postalmethods.gemspec
 - script/console
 - script/destroy
 - script/generate
 - setup.rb
+- spec/doc/sample_image.jpg
 - spec/doc/WSDL-Output
 - spec/doc/default.rb
 - spec/doc/defaultMappingRegistry.rb
@@ -95,6 +98,7 @@ files:
 - spec/postalmethods_spec.rb
 - spec/rcov.opts
 - spec/send_letter_spec.rb
+- spec/send_postcard_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/utility_spec.rb