endicia_label_server-ruby 0.2.2

data/endicia_label_server.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/endicia_label_server/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'endicia_label_server-ruby'
+  gem.version     = EndiciaLabelServer::Version::STRING
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ['Veeqo']
+  gem.email       = ['helpme@veeqo.com']
+  gem.homepage    = 'https://github.com/veeqo/endicia_label_server-ruby'
+  gem.summary     = 'Endicia Label Server'
+  gem.description = 'Gem for accessing the Endicia Label Server XML API from Ruby'
+
+  gem.license     = 'AGPL-3.0'
+
+  gem.required_rubygems_version = '>= 1.3.6'
+
+  gem.add_runtime_dependency 'ox', '~> 2.2', '>= 2.2.0'
+  gem.add_runtime_dependency 'excon', '~> 0.45', '>= 0.45.3'
+  gem.add_runtime_dependency 'insensitive_hash', '~> 0.3.3', '>= 0.3.3'
+
+  gem.files        = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.require_path = 'lib'
+end

data/lib/endicia_label_server-ruby.rb

@@ -0,0 +1,2 @@
+# This file is automatically loaded by Bundler
+require 'endicia_label_server'

data/lib/endicia_label_server.rb

@@ -0,0 +1,33 @@
+module EndiciaLabelServer
+  GEM_NAME = 'endicia_label_server'
+
+  autoload :SERVICES,                "#{GEM_NAME}/services"
+  autoload :MAILPIECESHAPES,                "#{GEM_NAME}/services"
+
+  module Service
+    autoload :MailpieceShape,          "#{GEM_NAME}/service/mailpiece_shape"
+  end
+
+  autoload :Version,               "#{GEM_NAME}/version"
+  autoload :Connection,            "#{GEM_NAME}/connection"
+  autoload :Exceptions,            "#{GEM_NAME}/exceptions"
+  autoload :Util,                  "#{GEM_NAME}/util"
+
+  module Builders
+    autoload :BuilderBase,             "#{GEM_NAME}/builders/builder_base"
+    autoload :PostageRateBuilder,      "#{GEM_NAME}/builders/postage_rate_builder"
+    autoload :PostageRatesBuilder,     "#{GEM_NAME}/builders/postage_rates_builder"
+    autoload :UserSignUpBuilder,       "#{GEM_NAME}/builders/user_sign_up_builder"
+    autoload :PostageLabelBuilder,     "#{GEM_NAME}/builders/postage_label_builder"
+    autoload :ChangePassPhraseBuilder, "#{GEM_NAME}/builders/change_pass_phrase_builder"
+  end
+
+  module Parsers
+    autoload :ParserBase,              "#{GEM_NAME}/parsers/parser_base"
+    autoload :PostageRateParser,       "#{GEM_NAME}/parsers/postage_rate_parser"
+    autoload :PostageRatesParser,      "#{GEM_NAME}/parsers/postage_rates_parser"
+    autoload :UserSignUpParser,        "#{GEM_NAME}/parsers/user_sign_up_parser"
+    autoload :PostageLabelParser,      "#{GEM_NAME}/parsers/postage_label_parser"
+    autoload :ChangePassPhraseParser,  "#{GEM_NAME}/parsers/change_pass_phrase_parser"
+  end
+end

data/lib/endicia_label_server/builders/builder_base.rb

@@ -0,0 +1,91 @@
+require 'ox'
+
+module EndiciaLabelServer
+  module Builders
+    # The {BuilderBase} class builds Endicia XML Objects.
+    #
+    # @author Paul Trippett
+    # @since 0.1.0
+    # @abstract
+    # @attr [Ox::Document] document The XML Document being built
+    # @attr [Ox::Element] root The XML Root
+    class BuilderBase
+      include Ox
+      include Exceptions
+
+      attr_accessor :document,
+                    :root
+
+      # Initializes a new {BuilderBase} object
+      #
+      # @param [String] root_name The Name of the XML Root
+      # @return [void]
+      def initialize(root_name, opts = {})
+        initialize_xml_roots root_name
+
+        document << root
+
+        opts.each_pair { |k, v| add(k, v) }
+      end
+
+      def add(*args)
+        first_arg = args.first
+        last_arg = args.last
+        root_key = Util.camelize(first_arg)
+
+        if last_arg.is_a? Hash
+          add_hash root_key, last_arg
+        elsif last_arg.is_a? Array
+
+        else
+          root << element_with_value(root_key, last_arg)
+        end
+      end
+
+      def add_hash(root_key, data)
+        xml_root_key = (root_key.is_a? String) ? root_key : Util.camelize(root_key)
+        root << Element.new(xml_root_key).tap do |org|
+          data.each_pair do |key, value|
+            xml_child_key = (key.is_a? String) ? key : Util.camelize(key)
+            org << element_with_value(xml_child_key, value)
+          end
+        end
+      end
+
+      def add_array(root_key, data)
+        xml_root_key = Util.camelize(root_key)
+        root << Element.new(xml_root_key).tap do |org|
+          child_key = "#{Util.singularize(xml_root_key)}ID"
+          data.each do |value|
+            org << element_with_value(child_key, value)
+          end
+        end
+      end
+
+      # Returns a String representation of the XML document being built
+      #
+      # @return [String]
+      def to_xml
+        Ox.to_xml document
+      end
+
+      def to_http_post
+        "#{post_field}=#{to_xml}"
+      end
+
+      private
+
+      def initialize_xml_roots(root_name)
+        self.document = Document.new
+        self.root = Element.new(root_name)
+      end
+
+      def element_with_value(name, value)
+        fail InvalidAttributeError, name unless value.respond_to?(:to_str)
+        Element.new(name).tap do |request_action|
+          request_action << value.to_str
+        end
+      end
+    end
+  end
+end

data/lib/endicia_label_server/builders/change_pass_phrase_builder.rb

@@ -0,0 +1,18 @@
+require 'ox'
+
+module EndiciaLabelServer
+  module Builders
+    class ChangePassPhraseBuilder < BuilderBase
+      include Ox
+
+      def initialize(opts = {})
+        super 'ChangePassPhraseRequest', opts
+        root[:TokenRequested] = 'false'
+      end
+
+      def post_field
+        'ChangePassPhraseRequestXML'
+      end
+    end
+  end
+end

data/lib/endicia_label_server/builders/postage_label_builder.rb

@@ -0,0 +1,24 @@
+require 'ox'
+
+module EndiciaLabelServer
+  module Builders
+    # The {PostageLabelBuilder} class builds Endicia XML LabelRequest
+    # Objects.
+    #
+    # @author Paul Trippett
+    # @since 0.1.0
+    class PostageLabelBuilder < BuilderBase
+      include Ox
+
+      # Initializes a new {RateBuilder} object
+      #
+      def initialize(opts = {})
+        super 'LabelRequest', opts
+      end
+
+      def post_field
+        'labelRequestXML'
+      end
+    end
+  end
+end

data/lib/endicia_label_server/builders/postage_rate_builder.rb

@@ -0,0 +1,23 @@
+require 'ox'
+
+module EndiciaLabelServer
+  module Builders
+    # The {PostageRateBuilder} class builds Endicia XML PostageRate Objects.
+    #
+    # @author Paul Trippett
+    # @since 0.1.0
+    class PostageRateBuilder < BuilderBase
+      include Ox
+
+      # Initializes a new {RateBuilder} object
+      #
+      def initialize(opts = {})
+        super 'PostageRateRequest', opts
+      end
+
+      def post_field
+        'postageRateRequestXML'
+      end
+    end
+  end
+end

data/lib/endicia_label_server/builders/postage_rates_builder.rb

@@ -0,0 +1,23 @@
+require 'ox'
+
+module EndiciaLabelServer
+  module Builders
+    # The {PostageRatesBuilder} class builds Endicia XML Rate Objects.
+    #
+    # @author Paul Trippett
+    # @since 0.1.0
+    class PostageRatesBuilder < BuilderBase
+      include Ox
+
+      # Initializes a new {RateBuilder} object
+      #
+      def initialize(opts = {})
+        super 'PostageRatesRequest', opts
+      end
+
+      def post_field
+        'postageRatesRequestXML'
+      end
+    end
+  end
+end

data/lib/endicia_label_server/builders/user_sign_up_builder.rb

@@ -0,0 +1,24 @@
+require 'ox'
+
+module EndiciaLabelServer
+  module Builders
+    # The {UserSignUpBuilder} class builds Endicia XML Rate Objects.
+    #
+    # @author Paul Trippett
+    # @since 0.1.0
+    class UserSignUpBuilder < BuilderBase
+      include Ox
+
+      # Initializes a new {RateBuilder} object
+      #
+      def initialize(opts = {})
+        super 'UserSignUpRequest', opts
+        root[:TokenRequested] = 'true'
+      end
+
+      def post_field
+        'UserSignUpRequestXML'
+      end
+    end
+  end
+end

data/lib/endicia_label_server/connection.rb

@@ -0,0 +1,96 @@
+require 'uri'
+require 'excon'
+require 'digest/md5'
+require 'ox'
+
+module EndiciaLabelServer
+  # The {Connection} class acts as the main entry point to performing rate and
+  # ship operations against the Endicia API.
+  #
+  # @author Paul Trippett
+  # @abstract
+  # @since 0.1.0
+  # @attr [String] url The base url to use either TEST_URL or LIVE_URL
+  class Connection
+    include EndiciaLabelServer::Builders
+    include EndiciaLabelServer::Parsers
+
+    attr_accessor :url
+
+    TEST_URL = 'https://elstestserver.endicia.com'
+    LIVE_URL = 'https://labelserver.endicia.com'
+    ROOT_PATH = '/LabelService/EwsLabelService.asmx/'
+
+    GET_POSTAGE_LABEL_ENDPOINT = 'GetPostageLabelXML'
+    REQUEST_RATE_ENDPOINT = 'CalculatePostageRateXML'
+    REQUEST_RATES_ENDPOINT = 'CalculatePostageRatesXML'
+    GET_USER_SIGNUP_ENDPOINT = 'GetUserSignUpXML'
+    CHANGE_PASS_PHRASE_ENDPOINT = 'ChangePassPhraseXML'
+
+    DEFAULT_PARAMS = {
+      test_mode: false
+    }
+
+    HEADERS = {
+      'Content-Type' => 'application/x-www-form-urlencoded'
+    }
+
+    # Initializes a new {Connection} object
+    #
+    # @param [Hash] params The initialization options
+    # @option params [Boolean] :test_mode If TEST_URL should be used for
+    #   requests to the Endicia Label Server URL
+    def initialize(params = {})
+      params = DEFAULT_PARAMS.merge(params)
+      self.url = (params[:test_mode]) ? TEST_URL : LIVE_URL
+    end
+
+    def rate(builder = nil, &block)
+      builder_proxy(builder, REQUEST_RATE_ENDPOINT, PostageRateBuilder,
+                    PostageRateParser, block)
+    end
+
+    def rates(builder = nil, &block)
+      builder_proxy(builder, REQUEST_RATES_ENDPOINT, PostageRatesBuilder,
+                    PostageRatesParser, block)
+    end
+
+    def get_label(builder = nil, &block)
+      builder_proxy(builder, GET_POSTAGE_LABEL_ENDPOINT, PostageLabelBuilder,
+                    PostageLabelParser, block)
+    end
+
+    def sign_up(builder = nil, &block)
+      builder_proxy(builder, GET_USER_SIGNUP_ENDPOINT, UserSignUpBuilder,
+                    UserSignUpParser, block)
+    end
+
+    def change_pass_phrase(builder = nil, &block)
+      builder_proxy(builder, CHANGE_PASS_PHRASE_ENDPOINT, ChangePassPhraseBuilder,
+                    ChangePassPhraseParser, block)
+    end
+
+    private
+
+    def build_url(endpoint)
+      "#{url}#{ROOT_PATH}#{endpoint}"
+    end
+
+    def get_response_stream(path, body)
+      response = Excon.post(build_url(path), body: body, headers: HEADERS)
+      StringIO.new(response.body)
+    end
+
+    def builder_proxy(builder, path, builder_type, parser, block)
+      if builder.nil? && block
+        builder = builder_type.new
+        block.call builder
+      end
+
+      response = get_response_stream path, builder.to_http_post
+      parser.new.tap do |p|
+        Ox.sax_parse(p, response)
+      end
+    end
+  end
+end

data/lib/endicia_label_server/exceptions.rb

@@ -0,0 +1,5 @@
+module EndiciaLabelServer
+  module Exceptions
+    class InvalidAttributeError < StandardError; end
+  end
+end

data/lib/endicia_label_server/parsers/change_pass_phrase_parser.rb

@@ -0,0 +1,20 @@
+module EndiciaLabelServer
+  module Parsers
+    class ChangePassPhraseParser < ParserBase
+      attr_accessor :requester_id, :request_id, :token
+
+      def value(value)
+        super
+
+        string_value = value.as_s
+        if switch_active? :RequesterID
+          self.requester_id = string_value
+        elsif switch_active? :RequestID
+          self.request_id = string_value
+        elsif switch_active? :Token
+          self.token = string_value
+        end
+      end
+    end
+  end
+end

data/lib/endicia_label_server/parsers/parser_base.rb

@@ -0,0 +1,42 @@
+require 'uri'
+require 'ox'
+
+module EndiciaLabelServer
+  module Parsers
+    class ParserBase < ::Ox::Sax
+      attr_accessor :switches,
+                    :status_code,
+                    :error_description
+
+      def initialize
+        self.switches = {}
+      end
+
+      def start_element(name)
+        element_tracker_switch name, true
+      end
+
+      def end_element(name)
+        element_tracker_switch name, false
+      end
+
+      def value(value)
+        string_value = value.as_s
+        self.status_code = string_value if switch_active? :Status
+        self.error_description = string_value if switch_active? :ErrorMessage
+      end
+
+      def element_tracker_switch(element, currently_in)
+        switches[element] = currently_in
+      end
+
+      def switch_active?(*elements)
+        elements.all? { |element| switches[element] == true }
+      end
+
+      def success?
+        ['0', 0].include? status_code
+      end
+    end
+  end
+end