aftership-tracking-sdk 7.0.0

data/lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_response.rb

@@ -0,0 +1,161 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI::Model
+  class WeightEstimatedDeliveryDateResponse
+    # The weight unit of the package. 
+    # unit: String;
+    attr_accessor :unit
+
+    # The weight of the shipment.
+    # value: Float;
+    attr_accessor :value
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::WeightEstimatedDeliveryDateResponse` initialize method"
+      end
+
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      end 
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end 
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'unit' => :'String',
+        :'value' => :'Float',
+      }
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'unit' => :'unit',
+        :'value' => :'value',
+      }
+    end
+
+    # Builds the object from hash
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(key) && attributes[key].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[key].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[key].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[key])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param type [String] Data type
+    # @param value [String] Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        klass = AftershipAPI::Model.const_get(type)
+        klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param value [Object] Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+    def to_json(*a)
+      to_hash.to_json(*a)
+    end
+  end
+end

data/lib/aftership-tracking-sdk/sign_string.rb

@@ -0,0 +1,77 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+require 'openssl'
+require 'base64'
+require 'uri'
+
+module AftershipAPI
+  class SignString
+    class << self
+      def sign(params)
+        content_md5 = ''
+        content_type = ''
+        # Computed MD5 hash of the request body in uppercase hex format.
+        if params['body'].to_s != ''
+          content_md5 = Digest::MD5.hexdigest(params['body']).upcase
+          content_type = params['content_type']
+        end
+        # Extract all request headers with the as- prefix key
+        as_headers = params['headers'].select { |k, _| k.start_with?('as-') }
+
+        # Convert all the request header key to lowercase, sort the headers in ASCII code order
+        as_headers = as_headers.transform_keys(&:downcase).sort.to_h
+
+        # Remove leading spaces and trailing spaces from the header key and value
+        as_headers.transform_keys!(&:strip)
+        as_headers.transform_values!(&:strip)
+
+        # Concatenate each of the header key and value with :, to form a header pair
+        header_pairs = as_headers.map { |k, v| "#{k}:#{v}" }
+
+        # Concatenate all header pairs with the new line character (ASCII code 10)
+        canonicalized_headers = header_pairs.join("\n")
+
+        # canonicalized_resource is the path of the URL, including the query parameters
+        url = URI.parse params['url']
+        canonicalized_resource = url.path
+        if !params['query'].nil? && params['query'].length > 0
+          sorted_query = params['query'].sort_by { |k, v| [k, v] }
+          canonicalized_resource += '?' + URI.encode_www_form(sorted_query)
+        end
+
+        # Form the string to sign
+        string_to_sign = [
+          params['method'].upcase,
+          content_md5,
+          content_type,
+          params['date'],
+          canonicalized_headers,
+          canonicalized_resource
+        ].join("\n")
+
+        # Generate the signature
+        signature = ''
+        if params['auth_type'] == AUTHENTICATION_TYPE_AES
+          signature = sign_aes(string_to_sign, params['secret'])
+        elsif params['auth_type'] == AUTHENTICATION_TYPE_RSA
+          signature = sign_rsa(string_to_sign, params['secret'])
+        else
+          raise InvalidOptionError, "Invalid authentication type: #{params['auth_type']}"
+        end
+
+        signature	
+      end
+
+      def sign_aes(msg, key)
+        digest = OpenSSL::HMAC.digest("SHA256", key, msg)
+        Base64.strict_encode64(digest).strip
+      end
+
+      def sign_rsa(msg, key)
+        private_key = OpenSSL::PKey::RSA.new(key)
+        signature = private_key.sign_pss('SHA256', msg, salt_length: :digest, mgf1_hash: 'SHA256')
+        Base64.strict_encode64(signature).strip
+      end
+    end
+  end
+end

data/lib/aftership-tracking-sdk/version.rb

@@ -0,0 +1,5 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+module AftershipAPI
+  VERSION = '7.0.0'
+end

data/lib/aftership-tracking-sdk.rb

@@ -0,0 +1,47 @@
+# This code was auto generated by AfterShip SDK Generator.
+# Do not edit the class manually.
+# Common files
+require 'aftership-tracking-sdk/api_client'
+require 'aftership-tracking-sdk/error'
+require 'aftership-tracking-sdk/version'
+require 'aftership-tracking-sdk/configuration'
+require 'aftership-tracking-sdk/sign_string'
+
+# Models
+Dir[File.join(__dir__, 'aftership-tracking-sdk/models', '*.rb')].each { |file| require file }
+
+# APIs
+Dir[File.join(__dir__, 'aftership-tracking-sdk/api', '*.rb')].each { |file| require file }
+
+module AftershipAPI
+  @is_initialized = false
+
+  class << self
+    def configure
+      config = Configuration.default
+      yield(config) if block_given?
+
+      config.check
+
+      if !@is_initialized
+        @is_initialized = true
+        self.constants.each do |c|
+          next unless c[-3..-1] == 'Api'
+          attributes = [:attr1]
+          wrapper_class = self.const_set(c[0..-4], Struct.new(*attributes))
+          original_class = self.const_get(c)
+
+          original_class.public_instance_methods(false).each do |m|
+            wrapper_class.class_eval do
+              define_singleton_method m do |**arg| 
+                original_class.new.send(m, **arg)
+              end
+            end
+          end
+        end
+      end
+
+      config
+    end
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: aftership-tracking-sdk
+version: !ruby/object:Gem::Version
+  version: 7.0.0
+platform: ruby
+authors:
+- AfterShip Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: ''
+email:
+- support@aftership.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- aftership-tracking-sdk.gemspec
+- lib/aftership-tracking-sdk.rb
+- lib/aftership-tracking-sdk/api/courier.rb
+- lib/aftership-tracking-sdk/api/estimated_delivery_date.rb
+- lib/aftership-tracking-sdk/api/last_checkpoint.rb
+- lib/aftership-tracking-sdk/api/notification.rb
+- lib/aftership-tracking-sdk/api/tracking.rb
+- lib/aftership-tracking-sdk/api_client.rb
+- lib/aftership-tracking-sdk/configuration.rb
+- lib/aftership-tracking-sdk/error.rb
+- lib/aftership-tracking-sdk/models/additional_fields_v1.rb
+- lib/aftership-tracking-sdk/models/aftership_estimated_delivery_date_tracking.rb
+- lib/aftership-tracking-sdk/models/carbon_emissions_tracking.rb
+- lib/aftership-tracking-sdk/models/checkpoint.rb
+- lib/aftership-tracking-sdk/models/coordinate_checkpoint.rb
+- lib/aftership-tracking-sdk/models/courier.rb
+- lib/aftership-tracking-sdk/models/courier_response_v1.rb
+- lib/aftership-tracking-sdk/models/custom_estimated_delivery_date_tracking.rb
+- lib/aftership-tracking-sdk/models/custom_fields_tracking_update_tracking_by_slug_tracking_number_request.rb
+- lib/aftership-tracking-sdk/models/data_courier_response_v1.rb
+- lib/aftership-tracking-sdk/models/data_notification_response_v1.rb
+- lib/aftership-tracking-sdk/models/data_tracking_delete_response_v1.rb
+- lib/aftership-tracking-sdk/models/data_tracking_response_get_multiple_v1.rb
+- lib/aftership-tracking-sdk/models/data_tracking_response_v1.rb
+- lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_request.rb
+- lib/aftership-tracking-sdk/models/destination_address_estimated_delivery_date_response.rb
+- lib/aftership-tracking-sdk/models/detect_courier_response.rb
+- lib/aftership-tracking-sdk/models/estimated_delivery_date_request.rb
+- lib/aftership-tracking-sdk/models/estimated_delivery_date_response.rb
+- lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_request.rb
+- lib/aftership-tracking-sdk/models/estimated_pickup_estimated_delivery_date_response.rb
+- lib/aftership-tracking-sdk/models/events_checkpoint.rb
+- lib/aftership-tracking-sdk/models/first_estimated_delivery_tracking.rb
+- lib/aftership-tracking-sdk/models/get_all_couriers_response.rb
+- lib/aftership-tracking-sdk/models/get_checkpoint_by_slug_tracking_number_response.rb
+- lib/aftership-tracking-sdk/models/get_checkpoint_by_tracking_id_response.rb
+- lib/aftership-tracking-sdk/models/get_trackings_response.rb
+- lib/aftership-tracking-sdk/models/get_user_couriers_response.rb
+- lib/aftership-tracking-sdk/models/latest_estimated_delivery_tracking.rb
+- lib/aftership-tracking-sdk/models/mark_tracking_completed_by_id_request.rb
+- lib/aftership-tracking-sdk/models/mark_tracking_completed_by_slug_tracking_number_request.rb
+- lib/aftership-tracking-sdk/models/meta_v1.rb
+- lib/aftership-tracking-sdk/models/next_couriers_tracking.rb
+- lib/aftership-tracking-sdk/models/next_couriers_tracking_create_tracking_request.rb
+- lib/aftership-tracking-sdk/models/notification.rb
+- lib/aftership-tracking-sdk/models/notification_request_v1.rb
+- lib/aftership-tracking-sdk/models/notification_response_v1.rb
+- lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_request.rb
+- lib/aftership-tracking-sdk/models/order_processing_time_estimated_pickup_estimated_delivery_date_response.rb
+- lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_request.rb
+- lib/aftership-tracking-sdk/models/origin_address_estimated_delivery_date_response.rb
+- lib/aftership-tracking-sdk/models/pagination.rb
+- lib/aftership-tracking-sdk/models/partial_delete_tracking.rb
+- lib/aftership-tracking-sdk/models/partial_update_tracking.rb
+- lib/aftership-tracking-sdk/models/predict_batch_request.rb
+- lib/aftership-tracking-sdk/models/predict_batch_response.rb
+- lib/aftership-tracking-sdk/models/reason_events_checkpoint.rb
+- lib/aftership-tracking-sdk/models/slug_group_v1.rb
+- lib/aftership-tracking-sdk/models/tag_v1.rb
+- lib/aftership-tracking-sdk/models/tracking.rb
+- lib/aftership-tracking-sdk/models/tracking_create_tracking_request.rb
+- lib/aftership-tracking-sdk/models/tracking_delete_response_v1.rb
+- lib/aftership-tracking-sdk/models/tracking_detect_courier_request.rb
+- lib/aftership-tracking-sdk/models/tracking_response_get_multiple_v1.rb
+- lib/aftership-tracking-sdk/models/tracking_response_v1.rb
+- lib/aftership-tracking-sdk/models/tracking_update_tracking_by_id_request.rb
+- lib/aftership-tracking-sdk/models/tracking_update_tracking_by_slug_tracking_number_request.rb
+- lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_request.rb
+- lib/aftership-tracking-sdk/models/weight_estimated_delivery_date_response.rb
+- lib/aftership-tracking-sdk/sign_string.rb
+- lib/aftership-tracking-sdk/version.rb
+homepage: https://www.aftership.com/docs/tracking/quickstart/api-quick-start
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: API Overview Ruby Gem
+test_files: []