usps-ruby-client 0.1.0

data/lib/helpers/erubis_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module ErubisHelper
+  def self.tabs(amount = 1)
+    (0..amount).map { "\t" }.join
+  end
+
+  def self.spaces(amount = 1)
+    (0..amount).map { "\s" }.join
+  end
+end

data/lib/tasks/api.rake

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+require 'amazing_print'
+require 'nokogiri'
+require 'erubis'
+require 'active_support'
+require 'active_support/core_ext'
+require 'pry'
+require 'helpers/erubis_helper'
+
+namespace :usps do
+  namespace :api do
+    task :update do
+      def dig_set(obj, keys, value)
+        key = keys.first
+        if keys.length == 1
+          obj[key] = value
+        else
+          obj[key] = {} unless obj[key]
+          dig_set(obj[key], keys.slice(1..-1), value)
+        end
+      end
+
+      def table_array_to_hash_array(columns, rows)
+        rows.map do |row|
+          row_data = {}
+          columns.each_with_index do |k, i|
+            row_data[k.to_s.gsub(/[[:space:]]+/, ' ').strip] =
+              row[i].is_a? String ? row[i].to_s.gsub(/[[:space:]]+/, ' ').strip : row[i]
+          end
+          row_data
+        end
+      end
+
+      def standardize_table_hash_array(arr)
+        arr.map do |option|
+          next if option['Tag Name'].split('/').pop.strip.casecmp('userid').zero?
+
+          {
+            type: option['Type'],
+            name: option['Tag Name'].split('/').pop.strip,
+            required: option['Occurs'] == 'Required',
+            description: option['Description'],
+          }
+        end.compact
+      end
+
+      def table_hash_array_to_shape(arr)
+        shape = {}
+
+        nesting = []
+        arr[0][:type] = '(Alias)' unless arr[0][:type].casecmp('(alias)').zero?
+        arr.each do |tag|
+          if tag[:type].casecmp('(alias)').zero?
+            if nesting.last == tag[:name]
+              nesting.pop
+            else
+              nesting.push(tag[:name])
+              dig_set(shape, nesting, tag.merge(children: {}))
+            end
+          elsif tag[:type].casecmp('(group)').zero?
+            if nesting.last == tag[:name]
+              nesting.pop(2)
+            else
+              nesting.push(:children)
+              nesting.push(tag[:name])
+              dig_set(shape, nesting, tag.merge(children: {}))
+            end
+          elsif nesting.length.positive?
+            nesting_with_children = nesting + [:children]
+            dig_set(shape, nesting_with_children,
+                    shape.dig(*nesting_with_children).merge({ tag[:name] => tag.merge(children: {}) }))
+          else
+            shape[tag[:name]] = tag
+          end
+        end
+        shape
+      end
+
+      def pp_xml(xml = '')
+        doc = Nokogiri.XML(xml) do |config|
+          config.default_xml.noblanks
+        end
+        doc.to_xml(indent: 2)
+      end
+
+      @failed_methods = []
+
+      @endpoint_files = []
+
+      def parse_doc(path)
+        doc = Nokogiri::HTML(File.open(path))
+
+        table_of_contents = {}
+        raw_table_of_contents = doc.search('sdt[docparttype="Table of Contents"] p a').map do |link|
+          full_title = link.content.tr("\n", ' ')
+          next if full_title.blank?
+
+          full_version = full_title.match(/^[\d.]+/)[0]
+          major, minor, tiny = full_version.split('.')
+
+          title = full_title.match(/\s+[A-Za-z\s\t.:]*\s+/)[0].gsub(/[[:space:]]+/,
+                                                                    ' ').strip.chomp('.')
+
+          data = {
+            # full_title: full_title,
+            # link: link['href'],
+            anchor: link['href'].split('#')[1],
+            version: full_version,
+            major: major,
+            minor: minor,
+            tiny: tiny,
+            title: title,
+          }
+
+          table_of_contents[major] ||= []
+          table_of_contents[major] << data
+
+          data
+        end
+
+        data = table_of_contents.map do |section_number, section|
+          section_data = {}
+          section.each do |subsection|
+            header_node = doc.search("a[name=#{subsection[:anchor]}]")[0].parent
+            header_node = header_node.next_element if header_node.content.blank? && header_node.next_element
+
+            content_node = if header_node.next_element && header_node.next_element.content.present?
+                             header_node.next_element
+                           elsif header_node.parent.next_element && header_node.parent.next_element.content.present?
+                             header_node.parent.next_element
+                           else
+                             header_node.parent.parent.next_element
+                           end
+            next unless content_node # For section 1
+
+            section_data[:link] = subsection[:link]
+
+            if subsection[:version] == "#{section_number}.0"
+              section_data[:title] = subsection[:title]
+            elsif subsection[:title] == 'Overview'
+              section_data[:description] = content_node.content.tr("\n", ' ')
+            elsif subsection[:title] == 'API Signature'
+              columns, *rows = content_node.search('tr').map do |tr|
+                tr.search('td').map do |td|
+                  td.content.gsub(/\n\s/, '').strip
+                end
+              end
+              section_data[:signature] = table_array_to_hash_array(columns, rows)
+              section_data[:url] =
+                "#{section_data[:signature][0]['Scheme']}#{section_data[:signature][0]['Host']}#{section_data[:signature][0]['Path'].chomp('?')}"
+              section_data[:group] =
+                section_data[:signature][0]['API'].sub('API=', '').gsub(/[[:space:]]+/,
+                                                                        ' ').strip
+            # ap section_data[:signature]
+            # ap section_data[:signature].map{|s| s[]}
+            # elsif subsection[:title] == "Request Descriptions"
+            # 	columns, *rows = content_node.search('tr').map{|tr| tr.search('td').map{|td| td.content.gsub(/\n\s/, '').strip}}
+            # 	section_data[:request_descriptions] = table_hash_array_to_shape(standardize_table_hash_array(table_array_to_hash_array(columns, rows)))
+            elsif subsection[:title] == 'Sample Request'
+              title, xml = content_node.content.gsub(/[[:space:]]+/, ' ').strip.split('<', 2)
+              xml = pp_xml("<#{xml}")
+              section_data[:sample_request] = <<~XML
+                #{title}
+                #{xml}
+              XML
+            elsif subsection[:title] == 'Response Descriptions' || subsection[:title] == 'Request Descriptions'
+              columns, *rows = content_node.search('tr').map do |tr|
+                next if tr.ancestors('table').length > 1
+
+                tr.search('td').map do |td|
+                  has_table = td.search('table').length.positive?
+                  if !has_table
+                    td.content.gsub(/\n\s/, '').strip
+                  else
+                    table = td.search('table')[0]
+                    c, *r = table.search('tr').map do |tr|
+                      tr.search('td').map do |td|
+                        td.content.gsub(/\n\s/, '').strip
+                      end
+                    end
+                    table_array_to_hash_array(c, r)
+                  end
+                end
+              end.compact
+              binding.pry if rows.blank?
+              section_data[subsection[:title].downcase.gsub(/\s+/, '_').to_sym] =
+                table_hash_array_to_shape(standardize_table_hash_array(table_array_to_hash_array(
+                                                                         columns, rows
+                                                                       )))
+            elsif subsection[:title] == 'Sample Response'
+              title, xml = content_node.content.gsub(/[[:space:]]+/, ' ').strip.split('<', 2)
+              xml = pp_xml("<#{xml}")
+              section_data[:sample_response] = <<~XML
+                #{title}
+                #{xml}
+              XML
+            end
+          end
+
+          section_data
+        end
+
+        method_template = Erubis::Eruby.new(File.read('lib/usps/api/templates/method.erb'))
+        method_spec_template = Erubis::Eruby.new(File.read('lib/usps/api/templates/method_spec.erb'))
+        data.each do |api|
+          next if api[:group].nil? || api[:group].empty?
+
+          # begin
+          rendered_method = method_template.result(group: api[:group], data: api)
+          File.write("lib/usps/api/endpoints/#{api[:group].underscore}.rb", rendered_method)
+
+          rendered_method_spec = method_spec_template.result(group: api[:group], data: api)
+          File.write("spec/usps/api/endpoints/#{api[:group].underscore}_spec.rb",
+                     rendered_method_spec)
+
+          @endpoint_files << {
+            file: api[:group].underscore,
+            module: api[:group].camelize,
+          }
+          # rescue => e
+          # 	@failed_methods << {
+          # 		file: path,
+          # 		api: api[:group],
+          # 	}
+          # end
+        end
+      end
+
+      failed_docs = []
+      Dir.glob('lib/data/api/*.htm').each do |f|
+        ap f
+        # begin
+        parse_doc(f)
+        # rescue => e
+        # 	failed_docs << f
+        # end
+      end
+
+      endpoints_template = Erubis::Eruby.new(File.read('lib/usps/api/templates/endpoints.erb'))
+      File.write(
+        'lib/usps/api/endpoints.rb',
+        endpoints_template.result(files: @endpoint_files.sort_by { |f| f[:file] })
+      )
+    end
+  end
+end

data/lib/usps-ruby-client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'usps/version'
+require 'usps/logger'
+require 'usps/config'
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'builder'
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'logger'
+
+require_relative 'usps/api/errors/usps_error'
+require_relative 'usps/api/errors/too_many_requests_error'
+# require_relative 'usps/api/error'
+# require_relative 'usps/api/errors'
+require_relative 'usps/faraday/response/raise_error'
+require_relative 'usps/faraday/connection'
+require_relative 'usps/faraday/request'
+# require_relative 'usps/api/mixins'
+require_relative 'usps/api/xml'
+require_relative 'usps/api/endpoints'
+# require_relative 'usps/pagination/cursor'
+require_relative 'usps/client'
+
+# module Usps
+#   class Error < StandardError; end
+#   # Your code goes here...
+# end

data/lib/usps/api/endpoints.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+require_relative 'endpoints/carrier_pickup_schedule'
+require_relative 'endpoints/city_state_lookup'
+require_relative 'endpoints/e_vs_express_mail_intl'
+require_relative 'endpoints/e_vs_first_class_mail_intl'
+require_relative 'endpoints/e_vs_priority_mail_intl'
+require_relative 'endpoints/e_vsgxg_get_label'
+require_relative 'endpoints/e_vsi_cancel'
+require_relative 'endpoints/hfp_facility_info'
+require_relative 'endpoints/intl_rate_v2'
+require_relative 'endpoints/pts_email'
+require_relative 'endpoints/pts_pod'
+require_relative 'endpoints/pts_rre'
+require_relative 'endpoints/ptst_pod'
+require_relative 'endpoints/rate_v4'
+require_relative 'endpoints/scan'
+require_relative 'endpoints/track_v2'
+require_relative 'endpoints/usps_returns_label'
+require_relative 'endpoints/verify'
+require_relative 'endpoints/zip_code_lookup'
+
+module Usps
+  module Api
+    module Endpoints
+      include CarrierPickupSchedule
+      include CityStateLookup
+      include EVSExpressMailIntl
+      include EVSFirstClassMailIntl
+      include EVSPriorityMailIntl
+      include EVSGXGGetLabel
+      include EVSICancel
+      include HFPFacilityInfo
+      include IntlRateV2
+      include PTSEmail
+      include PTSPod
+      include PTSRre
+      include PTSTPod
+      include RateV4
+      include SCAN
+      include TrackV2
+      include USPSReturnsLabel
+      include Verify
+      include ZipCodeLookup
+
+      ACTIONS = {
+        carrier_pickup_schedule: 'CarrierPickupSchedule',
+        city_state_lookup: 'CityStateLookup',
+        e_vs_express_mail_intl: 'EVSExpressMailIntl',
+        e_vs_first_class_mail_intl: 'EVSFirstClassMailIntl',
+        e_vs_priority_mail_intl: 'EVSPriorityMailIntl',
+        e_vsgxg_get_label: 'EVSGXGGetLabel',
+        e_vsi_cancel: 'EVSICancel',
+        hfp_facility_info: 'HFPFacilityInfo',
+        intl_rate_v2: 'IntlRateV2',
+        pts_email: 'PTSEmail',
+        pts_pod: 'PTSPod',
+        pts_rre: 'PTSRre',
+        ptst_pod: 'PTSTPod',
+        rate_v4: 'RateV4',
+        scan: 'SCAN',
+        track_v2: 'TrackV2',
+        usps_returns_label: 'USPSReturnsLabel',
+        verify: 'Verify',
+        zip_code_lookup: 'ZipCodeLookup',
+      }.freeze
+    end
+  end
+end

data/lib/usps/api/endpoints/carrier_pickup_schedule.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# This file was auto-generated by lib/tasks/api.rake
+
+module Usps
+	module Api
+		module Endpoints
+			module CarrierPickupSchedule
+				#
+				# Package Pickup Schedule API
+				#
+				# The Package Pickup Schedule API schedules a
+				# Package Pickup and provides the user a confirmation number for the scheduled
+				# pickup. Prior to making a Pickup Schedule call, it is recommended to use
+				# the Pickup Availability API to confirm that service is available.
+				#
+				# @option option [(Alias)] :CarrierPickupScheduleRequest (Required)
+				#   @option option [String] :FirstName (Required)
+				#   - Only alpha characters, apostrophes, spaces, periods, and hyphens "-" may be used. For example: <FirstName>John</FirstName>
+				#   @option option [String] :LastName (Required)
+				#   - Only alpha characters, apostrophes, spaces, periods and hyphens "-" may be used. For example: <LastName>Doe</LastName>
+				#   @option option [String] :FirmName (Optional)
+				#   - Only alpha and numeric characters, apostrophes, spaces, hyphens "-" and ampersands "&" may be used. Use this tag for a firm or company name. Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address. Note: FirmName is Optional except if the First Name and Last Name tags are null. For example: <FirmName>ABC Company</FirmName>
+				#   @option option [String] :SuiteOrApt (Required)
+				#   - Apartment or suite number. Optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building. For example: <SuiteOrApt>Suite 777</SuiteOrApt>
+				#   @option option [String] :Address2 (Required)
+				#   - Street address. For example: <Address2>1390 Market Street</Address2>
+				#   @option option [String] :Urbanization (Required)
+				#   - Use this tag for Urbanization (for Puerto Rico only). ZIP Code prefixes 006 to 009, if area is so designated.
+				#   @option option [String] :City (Required)
+				#   - City name. Either ZIP5 or City and State are required. For example: <City>Houston</City>
+				#   @option option [String] :State (Required)
+				#   - State abbreviation. Either ZIP5 or City and State are required. For example: <State>TX</State>
+				#   @option option [String] :ZIP5 (Required)
+				#   - 5-digit ZIP Code. Either ZIP5 or City and State are required. For example: <ZIP5>77058</ZIP5>
+				#   @option option [String] :ZIP4 (Required)
+				#   - Use this tag for a 4 digit ZIP Code. For example: <ZIP4>1234</ZIP4>
+				#   @option option [String] :Phone (Required)
+				#   - Two formats are allowed: (###) 123-4567 or ###-123-4567. For example: <Phone>5555551234</Phone> or <Phone>555-555-1234</Phone>
+				#   @option option [String] :Extension (Optional)
+				#   - Optional value for Phone Extension. For example: <Extension>201</Extension>
+				#   @option option [(Group)] :Package (Required)
+				#   - No values entered with this tag. <ServiceType> and <Count> tags are embedded under this. Refer to the XML request example section, below, to see how these embedded tags are formatted. If the <Count> for a service type is zero, you do not need to encode a <Package> but you must have at least one <Package> with embedded <ServiceType> and <Count> tags.
+				#     @option option [String] :ServiceType (Required)
+				#     - This tag is embedded under the <Package> tag. If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags. Refer to the XML Request Example below to see how these embedded tags are formatted. For example: <ServiceType>PriorityMailExpress</ServiceType>
+				#     @option option [String] :Count (Required)
+				#     - This tag is embedded under the <Package> tag. Enter the number of packages for the accompanying <ServiceType> tag. Maximum characters allowed: 3 or 999 packages. If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags. Refer to the XML request example section, below, to see how these embedded tags are formatted. For example: <Count>2</Count>
+				#     @option option [String] :EstimatedWeight (Required)
+				#     - Enter the estimated aggregate weight (in pounds) of all packages being picked up. For example: <EstimatedWeight>14</EstimatedWeight>
+				#     @option option [String] :PackageLocation (Required)
+				#     - Enter one of the following values: Note: "Other" requires information in the value for the <SpecialInstructions> tag. For example: <PackageLocation>Front Door</PackageLocation>
+				#     @option option [String] :SpecialInstructions (Optional)
+				#     - Value Required when PackageLocation is “Other”. Only alpha, numeric, commas, periods, apostrophes, _, &, -, ( ), ?, #, / +, @ and space characters may be used. For example: <SpecialInstructions>Packages are behind the screen door.</SpecialInstructions>
+				#     @option option [String] :EmailAddress (Optional)
+				#     - If provided, email notifications will be sent confirming package pickup, or request changes and cancellations. Maximum characters allowed: 50. For example: <EmailAddress>cpapple@email.com</EmailAddress>
+
+				#
+				# @see 
+				def carrier_pickup_schedule(options = {})
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request missing') if options[:carrier_pickup_schedule_request].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :first_name missing') if options[:carrier_pickup_schedule_request][:first_name].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :last_name missing') if options[:carrier_pickup_schedule_request][:last_name].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :suite_or_apt missing') if options[:carrier_pickup_schedule_request][:suite_or_apt].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :address2 missing') if options[:carrier_pickup_schedule_request][:address2].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :urbanization missing') if options[:carrier_pickup_schedule_request][:urbanization].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :city missing') if options[:carrier_pickup_schedule_request][:city].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :state missing') if options[:carrier_pickup_schedule_request][:state].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :zip5 missing') if options[:carrier_pickup_schedule_request][:zip5].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :zip4 missing') if options[:carrier_pickup_schedule_request][:zip4].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :phone missing') if options[:carrier_pickup_schedule_request][:phone].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :package missing') if options[:carrier_pickup_schedule_request][:package].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :package, :service_type missing') if options[:carrier_pickup_schedule_request][:package][:service_type].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :package, :count missing') if options[:carrier_pickup_schedule_request][:package][:count].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :package, :estimated_weight missing') if options[:carrier_pickup_schedule_request][:package][:estimated_weight].nil?
+					throw ArgumentError.new('Required arguments :carrier_pickup_schedule_request, :package, :package_location missing') if options[:carrier_pickup_schedule_request][:package][:package_location].nil?
+
+					request = build_request(:carrier_pickup_schedule, options)
+					get('https://secure.shippingapis.com/ShippingAPI.dll', {
+						API: 'CarrierPickupSchedule',
+						XML: request,
+					})
+				end
+
+				private
+
+				def tag_unless_blank(xml, tag_name, data)
+					xml.tag!(tag_name, data) unless data.blank? || data.nil?
+				end
+
+				def build_carrier_pickup_schedule_request(xml, options = {})
+					xml.tag!('FirstName', options[:carrier_pickup_schedule_request][:first_name])
+					xml.tag!('LastName', options[:carrier_pickup_schedule_request][:last_name])
+					tag_unless_blank(xml, 'FirmName', options[:carrier_pickup_schedule_request][:firm_name])
+					xml.tag!('SuiteOrApt', options[:carrier_pickup_schedule_request][:suite_or_apt])
+					xml.tag!('Address2', options[:carrier_pickup_schedule_request][:address2])
+					xml.tag!('Urbanization', options[:carrier_pickup_schedule_request][:urbanization])
+					xml.tag!('City', options[:carrier_pickup_schedule_request][:city])
+					xml.tag!('State', options[:carrier_pickup_schedule_request][:state])
+					xml.tag!('ZIP5', options[:carrier_pickup_schedule_request][:zip5])
+					xml.tag!('ZIP4', options[:carrier_pickup_schedule_request][:zip4])
+					xml.tag!('Phone', options[:carrier_pickup_schedule_request][:phone])
+					tag_unless_blank(xml, 'Extension', options[:carrier_pickup_schedule_request][:extension])
+					xml.tag!('Package') do
+						xml.tag!('ServiceType', options[:carrier_pickup_schedule_request][:package][:service_type])
+						xml.tag!('Count', options[:carrier_pickup_schedule_request][:package][:count])
+						xml.tag!('EstimatedWeight', options[:carrier_pickup_schedule_request][:package][:estimated_weight])
+						xml.tag!('PackageLocation', options[:carrier_pickup_schedule_request][:package][:package_location])
+						tag_unless_blank(xml, 'SpecialInstructions', options[:carrier_pickup_schedule_request][:package][:special_instructions])
+						tag_unless_blank(xml, 'EmailAddress', options[:carrier_pickup_schedule_request][:package][:email_address])
+					end 
+					xml.target!
+				end
+
+			end
+		end
+	end
+end