shipengine_sdk 1.0.3

data/lib/shipengine/utils/user_agent.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  module Utils
+    #
+    # Class responsible for managing the user agent.
+    #
+    class UserAgent
+      attr_reader :version, :platform
+
+      def initialize(version = VERSION, platform = RUBY_PLATFORM)
+        raise ::StandardError, 'Cannot get version' unless version
+        raise ::StandardError, 'Cannot get platform' unless platform
+
+        @version = version
+        @platform = platform
+      end
+
+      def to_s
+        "shipengine-ruby/#{@version} (#{@platform})"
+      end
+    end
+  end
+end

data/lib/shipengine/utils/validate.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'shipengine/exceptions'
+
+module ShipEngine
+  module Utils
+    module Validate
+      class << self
+        def not_nil(field, value)
+          return unless value.nil?
+
+          raise Exceptions.create_required_error(field)
+        end
+
+        def not_nil_or_empty_str(field, value)
+          not_nil(field, value)
+          return unless value == ''
+
+          raise Exceptions.create_required_error(field)
+        end
+
+        def str(field, value)
+          not_nil(field, value)
+          return if value.is_a?(String)
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be a String.")
+        end
+
+        def non_empty_str(field, value)
+          str(field, value)
+          return unless value.empty?
+
+          raise Exceptions.create_invalid_field_value_error("#{field} cannot be empty.")
+        end
+
+        def non_whitespace_str(field, value)
+          str(field, value)
+          return unless value.strip.empty?
+
+          raise Exceptions.create_invalid_field_value_error("#{field} cannot be all whitespace.")
+        end
+
+        def hash(field, value)
+          not_nil(field, value)
+          return if value.is_a?(Hash)
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be Hash.")
+        end
+
+        def bool(field, value)
+          not_nil(field, value)
+          return if [true, false].include?(value)
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be a Boolean.")
+        end
+
+        def number(field, value)
+          not_nil(field, value)
+          return if value.is_a?(Numeric)
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be Numeric.")
+        end
+
+        def int(field, value)
+          number(field, value)
+          return if value.to_i == value
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be a whole number.")
+        end
+
+        def non_neg_int(field, value)
+          int(field, value)
+          return if value >= 0
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be zero or greater.")
+        end
+
+        def positive_int(field, value)
+          int(field, value)
+          return if value.positive?
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be greater than zero.")
+        end
+
+        def array(field, value)
+          not_nil(field, value)
+
+          return if value.is_a?(Array)
+
+          raise Exceptions.create_invalid_field_value_error("#{field} must be an Array.")
+        end
+
+        def array_of_str(field, value)
+          array(field, value)
+          value.each do |v|
+            next if v.is_a?(String)
+
+            raise Exceptions.create_invalid_field_value_error("#{field} must be an Array of Strings.")
+          end
+        end
+
+        def validate_input_address(address); end
+      end
+    end
+  end
+end

data/lib/shipengine/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ShipEngine
+  VERSION = '1.0.3'
+end

data/lib/shipengine.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# for client class
+require 'shipengine/internal_client'
+require 'shipengine/domain'
+require 'shipengine/configuration'
+
+# just for exporting
+require 'shipengine/utils/validate'
+require 'shipengine/version'
+require 'shipengine/constants'
+require 'observer'
+
+module ShipEngine
+  class Client
+    attr_accessor :configuration
+
+    def initialize(api_key, retries: nil, timeout: nil, page_size: nil, base_url: nil)
+      @configuration = Configuration.new(
+        api_key:,
+        retries:,
+        base_url:,
+        timeout:,
+        page_size:
+      )
+
+      @internal_client = ShipEngine::InternalClient.new(@configuration)
+      @addresses = Domain::Addresses.new(@internal_client)
+      @carriers = Domain::Carriers.new(@internal_client)
+      @labels = Domain::Labels.new(@internal_client)
+      @rates = Domain::Rates.new(@internal_client)
+      @tracking = Domain::Tracking.new(@internal_client)
+    end
+
+    #
+    # Validate an array of address
+    #
+    # @param addresses [Array<ShipEngine::Domain::Addresses::AddressValidation::Request>]
+    # @param config [Hash?]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    #
+    # @return [Array<ShipEngine::Domain::Addresses::AddressValidation::Response>]
+    #
+    # @see https://shipengine.github.io/shipengine-openapi/#operation/validate_address
+    def validate_addresses(address, config = {})
+      @addresses.validate(address, config)
+    end
+
+    #
+    # List all of the users Carriers
+    #
+    # @param config [Hash?]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    #
+    # @return [ShipEngine::Domain::Carriers::ListCarriers::Response]
+    #
+    # @see https://shipengine.github.io/shipengine-openapi/#operation/list_carriers
+    def list_carriers(config: {})
+      @carriers.list_carriers(config:)
+    end
+
+    # Create label from Rate Id
+    #
+    # @param rate_id [String]
+    # @param params [Hash]
+    # @param config [Hash]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    # @return [ShipEngine::Domain::Labels::CreateFromRate::Response]
+    #
+    # @see https://shipengine.github.io/shipengine-openapi/#operation/create_label_from_rate
+    def create_label_from_rate(rate_id, params, config = {})
+      @labels.create_from_rate(rate_id, params, config)
+    end
+
+    # Create label from Shipment Details
+    #
+    # @param params [Hash]
+    # @param config [Hash]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    # @return [ShipEngine::Domain::Labels::CreateFromShipmentDetails::Response]
+    #
+    # @see https://shipengine.github.io/shipengine-openapi/#operation/create_label
+    def create_label_from_shipment_details(params, config = {})
+      @labels.create_from_shipment_details(params, config)
+    end
+
+    # Void label with Label Id
+    #
+    # @param label_id [String]
+    # @param config [Hash]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    # @return [ShipEngine::Domain::Labels::CreateFromShipmentDetails::Response]
+    #
+    # @see https://shipengine.github.io/shipengine-openapi/#operation/create_label
+    def void_label_with_label_id(label_id, config = {})
+      @labels.void(label_id, config)
+    end
+
+    # Get Rates with Shipment Details
+    #
+    # @param Shipment Details [Hash]
+    # @param config [Hash]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    # @return [ShipEngine::Domain::Tracking::TrackUsingLabelId::Response]
+    #
+    def get_rates_with_shipment_details(shipment_details, config = {})
+      @rates.get_rates_with_shipment_details(shipment_details, config)
+    end
+
+    # Track Package by package id (recommended)
+    #
+    # @param label_id [String] <description>
+    # @param config [Hash]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    # @return [ShipEngine::Domain::Tracking::TrackUsingLabelId::Response]
+    #
+    def track_using_label_id(label_id, config = {})
+      @tracking.track_using_label_id(label_id, config)
+    end
+
+    #
+    # Track Package by tracking number. Tracking by package_id is preferred [@see #track_package_by_id]
+    # @param tracking_number [String] <description>
+    # @param config [Hash]
+    # @option config [String?] :api_key
+    # @option config [String?] :base_url
+    # @option config [Number?] :retries
+    # @option config [Number?] :timeout
+    #
+    # @return [ShipEngine::Domain::Tracking::TrackUsingCarrierCodeAndTrackingNumber::Response]
+    #
+    def track_using_carrier_code_and_tracking_number(carrier_code, tracking_number, config = {})
+      @tracking.track_using_carrier_code_and_tracking_number(carrier_code, tracking_number, config)
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: shipengine_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- ShipEngine Development Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/faraday/raise_http_exception.rb
+- lib/shipengine.rb
+- lib/shipengine/configuration.rb
+- lib/shipengine/constants.rb
+- lib/shipengine/constants/base.rb
+- lib/shipengine/constants/countries.rb
+- lib/shipengine/domain.rb
+- lib/shipengine/domain/addresses.rb
+- lib/shipengine/domain/addresses/address_validation.rb
+- lib/shipengine/domain/carriers.rb
+- lib/shipengine/domain/carriers/list_carriers.rb
+- lib/shipengine/domain/labels.rb
+- lib/shipengine/domain/labels/create_from_rate.rb
+- lib/shipengine/domain/labels/create_from_shipment_details.rb
+- lib/shipengine/domain/labels/void_label.rb
+- lib/shipengine/domain/rates.rb
+- lib/shipengine/domain/rates/get_with_shipment_details.rb
+- lib/shipengine/domain/tracking.rb
+- lib/shipengine/domain/tracking/track_using_carrier_code_and_tracking_number.rb
+- lib/shipengine/domain/tracking/track_using_label_id.rb
+- lib/shipengine/exceptions.rb
+- lib/shipengine/exceptions/error_code.rb
+- lib/shipengine/exceptions/error_type.rb
+- lib/shipengine/internal_client.rb
+- lib/shipengine/utils/base58.rb
+- lib/shipengine/utils/pretty_print.rb
+- lib/shipengine/utils/request_id.rb
+- lib/shipengine/utils/user_agent.rb
+- lib/shipengine/utils/validate.rb
+- lib/shipengine/version.rb
+homepage: https://github.com/ShipEngine/shipengine-ruby
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: The Official Ruby SDK for ShipEngine.
+test_files: []