endicia_label_server-ruby 0.2.2

data/lib/endicia_label_server/parsers/postage_label_parser.rb

@@ -0,0 +1,52 @@
+require 'base64'
+
+module EndiciaLabelServer
+  module Parsers
+    class PostageLabelParser < ParserBase
+      attr_accessor :pic,
+                    :tracking_number,
+                    :final_postage,
+                    :transaction_id,
+                    :transaction_date_time,
+                    :postmark_date,
+                    :postage_balance,
+                    :cost_center,
+                    :requester_id,
+                    :label
+
+      def start_element(name)
+        super
+        @current_element = name.to_s
+      end
+
+      def value(value)
+        super
+
+        element = underscore(@current_element)
+        string_value = value.as_s
+        if switch_active? :Base64LabelImage
+          parse_label(string_value)
+        else
+          function_name = "#{element}="
+          send(function_name, string_value) if respond_to?(function_name)
+        end
+      end
+
+      def underscore(value)
+        value.gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+      end
+
+      def parse_label(encoded_label)
+        label_file = Tempfile.new(['endicia', '.png'])
+        label_file.binmode
+        label_file.write(Base64.decode64(encoded_label))
+        label_file.rewind
+        self.label = label_file
+      end
+    end
+  end
+end

data/lib/endicia_label_server/parsers/postage_rate_parser.rb

@@ -0,0 +1,43 @@
+module EndiciaLabelServer
+  module Parsers
+    class PostageRateParser < ParserBase
+      attr_accessor :rated_shipments
+
+      def initialize
+        super
+        self.rated_shipments = []
+        @current_rate = {}
+      end
+
+      def start_element(name)
+        super
+      end
+
+      def end_element(name)
+        super
+        return unless name == :Postage
+        rated_shipments << @current_rate
+        @current_rate = {}
+      end
+
+      def value(value)
+        super
+        if switch_active?(:Postage, :MailService)
+          parse_mail_service value
+        elsif switch_active?(:Postage, :Rate)
+          parse_total_charges value
+        end
+      end
+
+      def parse_mail_service(value)
+        service_code = EndiciaLabelServer::SERVICES.invert[value.as_s]
+        @current_rate[:service_code] = service_code
+        @current_rate[:service_name] = value.as_s
+      end
+
+      def parse_total_charges(value)
+        @current_rate[:total] = value.as_s
+      end
+    end
+  end
+end

data/lib/endicia_label_server/parsers/postage_rates_parser.rb

@@ -0,0 +1,16 @@
+module EndiciaLabelServer
+  module Parsers
+    class PostageRatesParser < PostageRateParser
+      def attr_value(name, value)
+        @current_rate[:total] = value.as_s if name == :TotalAmount
+      end
+
+      def value(value)
+        super
+        if switch_active?(:MailClass)
+          @current_rate[:mail_class] = value.as_s
+        end
+      end
+    end
+  end
+end

data/lib/endicia_label_server/parsers/user_sign_up_parser.rb

@@ -0,0 +1,24 @@
+module EndiciaLabelServer
+  module Parsers
+    class UserSignUpParser < ParserBase
+      attr_accessor :confirmation_number, :account_id, :token
+
+      def value(value)
+        super
+
+        string_value = value.as_s
+        if switch_active? :ConfirmationNumber
+          self.confirmation_number = string_value
+        elsif switch_active? :AccountID
+          self.account_id = string_value
+        elsif switch_active? :Token
+          self.token = string_value
+        end
+      end
+
+      def success?
+        !['0', 0].include? confirmation_number
+      end
+    end
+  end
+end

data/lib/endicia_label_server/service/mailpiece_shape.rb

@@ -0,0 +1,92 @@
+module EndiciaLabelServer
+  module Service
+
+    class MailpieceShape
+      attr_accessor :service_name
+
+      MAILPIECESHAPES.each do |mailpiece|
+        define_method "#{Util.underscore(mailpiece).gsub(' ', '_')}_mailpiece" do
+           mailpiece
+        end
+      end
+
+      def initialize(service_name)
+        @service_name = service_name
+      end
+
+      def all
+        send("#{Util.underscore(service_name).gsub(' ', '_').to_sym}_mailpiece_shapes")
+      end
+
+      private
+
+      def express_mail_mailpiece_shapes
+        [flat_mailpiece, parcel_mailpiece, large_parcel_mailpiece, flat_rate_legal_envelope_mailpiece, flat_rate_padded_envelope_mailpiece, flat_rate_gift_card_envelope_mailpiece, small_flat_rate_envelope_mailpiece]
+      end
+
+      def express_mail_international_mailpiece_shapes
+        [flat_mailpiece, flat_rate_padded_envelope_mailpiece, parcel_mailpiece, flat_rate_envelope_mailpiece]
+      end
+
+      def priority_mail_express_mailpiece_shapes
+        [flat_mailpiece, parcel_mailpiece, large_parcel_mailpiece, flat_rate_envelope_mailpiece]
+      end
+
+      def priority_mail_express_international_mailpiece_shapes
+        [flat_mailpiece, flat_rate_padded_envelope_mailpiece, parcel_mailpiece, flat_rate_envelope_mailpiece]
+      end
+
+      def first_class_mail_mailpiece_shapes
+        [letter_mailpiece, flat_mailpiece, parcel_mailpiece]
+      end
+
+      def library_mail_mailpiece_shapes
+        [parcel_mailpiece]
+      end
+
+      def media_mail_mailpiece_shapes
+        [parcel_mailpiece]
+      end
+
+      def standard_post_mailpiece_shapes
+        [parcel_mailpiece, large_parcel_mailpiece]
+      end
+
+      def parcel_select_mailpiece_shapes
+        [parcel_mailpiece, large_parcel_mailpiece]
+      end
+
+      def parcel_select_barcoded_nonpresorted_mailpiece_shapes
+        [parcel_mailpiece, large_parcel_mailpiece]
+      end
+
+      def priority_mail_mailpiece_shapes
+        [flat_mailpiece, parcel_mailpiece, large_parcel_mailpiece, flat_rate_legal_envelope_mailpiece, flat_rate_padded_envelope_mailpiece, flat_rate_gift_card_envelope_mailpiece, small_flat_rate_envelope_mailpiece]
+      end
+
+      def critical_mail_mailpiece_shapes
+        []
+      end
+
+      def first_class_mail_international_mailpiece_shapes
+        [letter_mailpiece, flat_mailpiece, parcel_mailpiece]
+      end
+
+      def first_class_package_international_service_mailpiece_shapes
+        [letter_mailpiece, flat_mailpiece, parcel_mailpiece]
+      end
+
+      def priority_mail_international_mailpiece_shapes
+        [flat_mailpiece, parcel_mailpiece, flat_rate_envelope_mailpiece, flat_rate_legal_envelope_mailpiece, flat_rate_padded_envelope_mailpiece, small_flat_rate_box_mailpiece, medium_flat_rate_box_mailpiece, large_flat_rate_box_mailpiece]
+      end
+
+      def priority_mail_express_flat_rate_envelope_mailpiece_shapes
+        [flat_rate_envelope_mailpiece]
+      end
+
+      def priority_mail_flat_rate_envelope_mailpiece_shapes
+        [flat_rate_envelope_mailpiece]
+      end
+    end
+  end
+end

data/lib/endicia_label_server/services.rb

@@ -0,0 +1,37 @@
+module EndiciaLabelServer
+  SERVICES = {
+    'Express' => 'Express Mail',
+    'PriorityExpress' => 'Priority Mail Express',
+    'First' => 'First-Class Mail',
+    'LibraryMail' => 'Library Mail',
+    'MediaMail' => 'Media Mail',
+    'StandardPost' => 'Standard Post',
+    'ParcelSelect' => 'Parcel Select Barcoded Nonpresorted',
+    'Priority' => 'Priority Mail',
+    'CriticalMail' => 'Critical Mail',
+    'ExpressMailInternational' => 'Express Mail International',
+    'PriorityMailExpressInternational' => 'Priority Mail Express International',
+    'FirstClassMailInternational' => 'First Class Mail International',
+    'FirstClassPackageInternationalService' => 'First Class Package International Service',
+    'PriorityMailInternational' => 'Priority Mail International',
+    'PriorityMailFlatRateEnvelope' => 'Priority Mail Flat Rate Envelope',
+    'PriorityMailExpressFlatRateEnvelope' => 'Priority Mail Express Flat Rate Envelope'
+  }
+
+  MAILPIECESHAPES = [
+    'Flat',
+    'Letter',
+    'FlatRateGiftCardEnvelope',
+    'FlatRatePaddedEnvelope',
+    'LargeParcel',
+    'Parcel',
+    'SmallFlatRateEnvelope',
+    'FlatRateLegalEnvelope',
+    'SmallFlatRateEnvelope',
+    'Parcel',
+    'FlatRateEnvelope',
+    'SmallFlatRateBox',
+    'MediumFlatRateBox',
+    'LargeFlatRateBox'
+  ]
+end

data/lib/endicia_label_server/util.rb

@@ -0,0 +1,29 @@
+module EndiciaLabelServer
+  module Util
+    class << self
+      def camelize(value)
+        value.to_s.split('_').map { |v| capitalize_with_id_exception(v) }.join
+      end
+
+      def capitalize_with_id_exception(value)
+        (value == 'id') ? 'ID' : value.capitalize
+      end
+
+      def singularize(word)
+        if word =~ /([a-zA-Z]+?)(s\b|\b)/i
+          return $1
+        else
+          return word
+        end
+      end
+
+      def underscore(word)
+        word.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+      end
+    end
+  end
+end

data/lib/endicia_label_server/version.rb

@@ -0,0 +1,10 @@
+module EndiciaLabelServer
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 2
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/spec/endicia_label_server/builders/builder_base_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe EndiciaLabelServer::Builders::BuilderBase do
+  describe '.add_array' do
+    let(:builder) { EndiciaLabelServer::Builders::BuilderBase.new 'MyBuilder' }
+
+    subject { builder.to_xml.gsub(/\s+/, "") }
+
+    before do
+      builder.add_array :test, ['1', '2']
+    end
+
+    it "should return valid XML" do
+      should eql '<MyBuilder><Test><TestID>1</TestID><TestID>2</TestID></Test></MyBuilder>'
+    end
+  end
+
+  describe '.add_hash' do
+    context "When passed symbolized keys" do
+      let(:builder) { EndiciaLabelServer::Builders::BuilderBase.new 'MyBuilder' }
+
+      subject { builder.to_xml.gsub(/\s+/, "") }
+
+      before do
+        builder.add_hash :test, { id: '1', source: 'test' }
+      end
+
+      it "should return valid XML" do
+        should eql '<MyBuilder><Test><ID>1</ID><Source>test</Source></Test></MyBuilder>'
+      end
+    end
+
+    context "When passed string keys" do
+      let(:builder) { EndiciaLabelServer::Builders::BuilderBase.new 'MyBuilder' }
+
+      subject { builder.to_xml.gsub(/\s+/, "") }
+
+      before do
+        builder.add_hash 'TestTest', { 'ID' => '1', 'SourceSource' => 'test' }
+      end
+
+      it "should return valid XML" do
+        should eql '<MyBuilder><TestTest><ID>1</ID><SourceSource>test</SourceSource></TestTest></MyBuilder>'
+      end
+    end
+  end
+end

data/spec/endicia_label_server/connection/change_pass_phrase_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'tempfile'
+require 'faker'
+
+describe EndiciaLabelServer::Connection, '.change_pass_phrase' do
+  before do
+    Excon.defaults[:mock] = true
+  end
+
+  after do
+    Excon.stubs.clear
+  end
+
+  let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
+  let(:server) { EndiciaLabelServer::Connection.new(test_mode: true) }
+
+  context "when changing a users pass phrase" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when "#{EndiciaLabelServer::Connection::ROOT_PATH}#{EndiciaLabelServer::Connection::CHANGE_PASS_PHRASE_ENDPOINT}"
+          {body: File.read("#{stub_path}/change_pass_phrase_success.xml"), status: 200}
+        end
+      end
+    end
+
+    subject do
+      server.change_pass_phrase do |connection|
+        connection.add :requester_id, ENV['ENDICIA_REQUESTER_ID']
+        connection.add :request_id, 'ABC'
+        connection.add :certified_intermediary, {
+          account_id: '1234567',
+          pass_phrase: 'SUPER SECRET AND SECURE PASSWORD',
+          token: 'AGAIN ANOTHER AWESOME SECRET TOKEN'
+        },
+        new_pass_phrase: 'iAmAPassword1_c'
+      end
+    end
+
+    it "should return a single rate" do
+      expect { subject }.not_to raise_error
+      expect(subject.success?).to be_truthy
+    end
+  end
+end

data/spec/endicia_label_server/connection/multiple_rate_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe EndiciaLabelServer::Connection, '.rates' do
+  before do
+    Excon.defaults[:mock] = true
+  end
+
+  after do
+    Excon.stubs.clear
+  end
+
+  let(:expected_rates) {
+    [
+      {:mail_class => 'First', :total=>"1.93", :service_code=>"First", :service_name=>"First-Class Mail"},
+      {:mail_class => 'Priority', :total=>"6.51", :service_code=>"Priority", :service_name=>"Priority Mail"},
+      {:mail_class => 'PriorityExpress', :total=>"27.68", :service_code=>"PriorityExpress", :service_name=>"Priority Mail Express"},
+      {:mail_class => 'LibraryMail', :total=>"2.56", :service_code=>"LibraryMail", :service_name=>"Library Mail"},
+      {:mail_class => 'MediaMail', :total=>"2.69", :service_code=>"MediaMail", :service_name=>"Media Mail"},
+      {:mail_class => 'ParcelSelect', :total=>"6.68", :service_code=>"ParcelSelect", :service_name=>"Parcel Select Barcoded Nonpresorted"}
+    ]
+  }
+
+  def apply_config_to_rate_builder(rate_builder)
+    rate_builder.add :certified_intermediary, {
+      account_id: ENV['ENDICIA_ACCOUNT_ID'],
+      pass_phrase: ENV['ENDICIA_PASS_PHRASE'],
+      token: ENV['ENDICIA_TOKEN']
+    }
+    rate_builder.add :requester_id, ENV['ENDICIA_REQUESTER_ID']
+    rate_builder.add :mail_class, "Domestic"
+    rate_builder.add :mailpiece_dimensions, {
+      length: '10',
+      width: '10',
+      height: '10'
+    }
+    rate_builder.add :weight_oz, "2"
+    rate_builder.add :from_postal_code, '90210'
+    rate_builder.add :to_postal_code, '02215'
+    rate_builder.add :to_country_code, 'US'
+  end
+
+  let(:stub_path) { File.expand_path("../../../stubs", __FILE__) }
+  let(:server) { EndiciaLabelServer::Connection.new(test_mode: true) }
+
+  context "if requesting multiple rates with a block" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when "#{EndiciaLabelServer::Connection::ROOT_PATH}#{EndiciaLabelServer::Connection::REQUEST_RATES_ENDPOINT}"
+          {body: File.read("#{stub_path}/postage_rates_success.xml"), status: 200}
+        end
+      end
+    end
+
+    subject do
+      server.rates do |rate_builder|
+        apply_config_to_rate_builder(rate_builder)
+      end
+    end
+
+    it "should return a single rate" do
+      expect { subject }.not_to raise_error
+      expect(subject.rated_shipments).not_to be_empty
+      expect(subject.rated_shipments.count).to eql 6
+      expect(subject.rated_shipments).to eql expected_rates
+    end
+  end
+
+  context "if requesting multiple rates with a parameter" do
+    before do
+      Excon.stub({:method => :post}) do |params|
+        case params[:path]
+        when "#{EndiciaLabelServer::Connection::ROOT_PATH}#{EndiciaLabelServer::Connection::REQUEST_RATES_ENDPOINT}"
+          {body: File.read("#{stub_path}/postage_rates_success.xml"), status: 200}
+        end
+      end
+    end
+
+    let(:rate_builder) {
+      EndiciaLabelServer::Builders::PostageRatesBuilder.new.tap do |rate_builder|
+        apply_config_to_rate_builder(rate_builder)
+      end
+    }
+
+    subject do
+      server.rates(rate_builder)
+    end
+
+    it "should return a single rate" do
+      expect { subject }.not_to raise_error
+      expect(subject.rated_shipments).not_to be_empty
+      expect(subject.rated_shipments.count).to eql 6
+      expect(subject.rated_shipments).to eql expected_rates
+    end
+  end
+end