freight_kit 0.1.20 → 0.1.22

data/lib/freight_kit/platforms/dsdc.rb

@@ -0,0 +1,82 @@
+module FreightKit
+  module Platforms
+    # Carriers whose APIs follow the NMFTA Digital Standards Development Council (DSDC) LTL API standards.
+    #
+    # The standards define paths and payloads but not hosts or authentication, so subclasses set `API[:domain]`
+    # (and `API[:prefix]` if the carrier mounts the APIs under one) and implement {#authorization_headers}.
+    #
+    # @see https://dsdc.nmfta.org/apis
+    # @see https://github.com/dsdcapis/less-than-truckload/tree/main/api-specs
+    class DSDC < Platform
+      class << self
+        def required_credential_types = %i[api]
+      end
+
+      API = {
+        endpoints: {
+          # eBOL 2.1.0
+          cancel_bol: '/bol/v1/app/%<pro>s',
+          create_bol: '/bol/v1/app/',
+          update_bol: '/bol/v1/app/%<pro>s',
+          # Pickup Request and Visibility 1.0.0
+          cancel_pickup: '/v1/pickups/%<pickup_id>s',
+          create_pickup: '/v1/pickups/',
+          show_pickup: '/v1/pickups/',
+          update_pickup: '/v1/pickups/%<pickup_id>s',
+          # In-Transit Visibility 1.0.0
+          track: '/shipment/pro/%<pro>s/verified'
+        },
+        methods: {
+          cancel_bol: :delete,
+          cancel_pickup: :delete,
+          create_bol: :post,
+          create_pickup: :post,
+          show_pickup: :get,
+          track: :get,
+          update_bol: :put,
+          update_pickup: :put
+        },
+        use_ssl: true
+      }.freeze
+      JSON_HEADERS = { Accept: 'application/json', 'Content-Type': 'application/json' }.freeze
+
+      protected
+
+      # @return [Hash] Headers that authenticate requests, e.g. a bearer token or API key.
+      def authorization_headers = raise NotImplementedError, "#{name}: #authorization_headers not implemented"
+
+      # @param action [Symbol] A key of `API[:endpoints]`.
+      # @param body [Hash, nil] Payload, sent as JSON.
+      # @param query [Hash, nil] Query parameters, e.g. `lookupType` and `lookupValue` for `:show_pickup`.
+      # @param path_params [Hash] Values for the endpoint's placeholders, e.g. `pro:`.
+      def build_request(action, body: nil, query: nil, **path_params)
+        request = {
+          body: body&.to_json,
+          headers: JSON_HEADERS.merge(authorization_headers),
+          method: self.class::API.dig(:methods, action),
+          query:,
+          url: build_url(action, **path_params)
+        }
+
+        save_request(request)
+        request
+      end
+
+      def build_url(action, **path_params)
+        api = self.class::API
+        endpoint = format(api.dig(:endpoints, action), **path_params.transform_values { |value| ERB::Util.url_encode(value.to_s) })
+
+        "#{api[:use_ssl] ? 'https' : 'http'}://#{api[:domain]}#{api[:prefix]}#{endpoint}"
+      end
+
+      def commit(request)
+        response = HTTPClient.request(request[:method], request[:url], **request.slice(:body, :headers, :query), proxy_url:)
+
+        raise InvalidCredentialsError, "HTTP #{response.code}: #{response}" if [401, 403].include?(response.code)
+        raise HTTPError.new(body: response.body, code: response.code) unless (200..299).cover?(response.code)
+
+        response.parsed_response
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/mutation/quote_create.rb

@@ -0,0 +1,32 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Mutation
+          class QuoteCreate
+            DETAILS = Client.parse(<<~GRAPHQL)
+              mutation($input: QuoteCreateInput!) {
+                quoteCreate(input: $input) {
+                  rates {
+                    carrierName
+                    chargeCents
+                    chargeCurrency
+                    expiresAt
+                    id
+                    reference
+                    scac
+                    transitDays
+                  }
+                  shipment {
+                    id
+                    loadId
+                  }
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/mutation/shipment_create.rb

@@ -0,0 +1,29 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Mutation
+          class ShipmentCreate
+            DETAILS = Client.parse(<<~GRAPHQL)
+              mutation($input: ShipmentCreateInput!) {
+                shipmentCreate(input: $input) {
+                  shipment {
+                    documents {
+                      contentType
+                      kind
+                      url
+                    }
+                    id
+                    loadId
+                    pro
+                    status
+                  }
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/broker_carrier.rb

@@ -0,0 +1,37 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class BrokerCarrier
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($id: ID!) {
+                brokerCarrier(id: $id) {
+                  account
+                  accountDesc
+                  brokerCustomer {
+                    customer {
+                      id
+                      name
+                    }
+                    id
+                  }
+                  carrier {
+                    id
+                    mcNumber
+                    name
+                    scac
+                  }
+                  createInvoiceOnPickup
+                  daysToPayAfterInvoiceDate
+                  id
+                  shipmentsCount
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/broker_carriers.rb

@@ -0,0 +1,45 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class BrokerCarriers
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($filter: BrokerCarrierFilter, $page: Int, $pageSize: Int, $sort: [String!]) {
+                brokerCarriers(filter: $filter, page: $page, pageSize: $pageSize, sort: $sort) {
+                  items {
+                    account
+                    accountDesc
+                    brokerCustomer {
+                      customer {
+                        id
+                        name
+                      }
+                      id
+                    }
+                    carrier {
+                      id
+                      mcNumber
+                      name
+                      scac
+                    }
+                    createInvoiceOnPickup
+                    daysToPayAfterInvoiceDate
+                    id
+                    shipmentsCount
+                  }
+                  page
+                  pageSize
+                  pages
+                  totalItems
+                  updatedAt
+                  version
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/broker_customer.rb

@@ -0,0 +1,54 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class BrokerCustomer
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($id: ID!) {
+                brokerCustomer(id: $id) {
+                  accountingCustomerId
+                  canQuote
+                  customer {
+                    id
+                    name
+                  }
+                  id
+                  officeAddress {
+                    city
+                    country {
+                      alpha2Code
+                    }
+                    id
+                    region {
+                      abbreviation
+                    }
+                    street
+                    street2
+                    timeZoneName
+                    zipCode
+                  }
+                  primaryPickupAddress {
+                    city
+                    country {
+                      alpha2Code
+                    }
+                    id
+                    region {
+                      abbreviation
+                    }
+                    street
+                    street2
+                    timeZoneName
+                    zipCode
+                  }
+                  validFreightClasses
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/broker_customers.rb

@@ -0,0 +1,62 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class BrokerCustomers
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($filter: BrokerCustomerFilter, $page: Int, $pageSize: Int, $sort: [String!]) {
+                brokerCustomers(filter: $filter, page: $page, pageSize: $pageSize, sort: $sort) {
+                  items {
+                    accountingCustomerId
+                    canQuote
+                    customer {
+                      id
+                      name
+                    }
+                    id
+                    officeAddress {
+                      city
+                      country {
+                        alpha2Code
+                      }
+                      id
+                      region {
+                        abbreviation
+                      }
+                      street
+                      street2
+                      timeZoneName
+                      zipCode
+                    }
+                    primaryPickupAddress {
+                      city
+                      country {
+                        alpha2Code
+                      }
+                      id
+                      region {
+                        abbreviation
+                      }
+                      street
+                      street2
+                      timeZoneName
+                      zipCode
+                    }
+                    validFreightClasses
+                  }
+                  page
+                  pageSize
+                  pages
+                  totalItems
+                  updatedAt
+                  version
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/carrier.rb

@@ -0,0 +1,22 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class Carrier
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($id: ID!) {
+                carrier(id: $id) {
+                  id
+                  mcNumber
+                  name
+                  scac
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/carriers.rb

@@ -0,0 +1,30 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class Carriers
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($filter: CarrierFilter, $page: Int, $pageSize: Int, $sort: [String!]) {
+                carriers(filter: $filter, page: $page, pageSize: $pageSize, sort: $sort) {
+                  items {
+                    id
+                    mcNumber
+                    name
+                    scac
+                  }
+                  page
+                  pageSize
+                  pages
+                  totalItems
+                  updatedAt
+                  version
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/customer.rb

@@ -0,0 +1,20 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class Customer
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($id: ID!) {
+                customer(id: $id) {
+                  id
+                  name
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/customers.rb

@@ -0,0 +1,28 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class Customers
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($filter: CustomerFilter, $page: Int, $pageSize: Int, $sort: [String!]) {
+                customers(filter: $filter, page: $page, pageSize: $pageSize, sort: $sort) {
+                  items {
+                    id
+                    name
+                  }
+                  page
+                  pageSize
+                  pages
+                  totalItems
+                  updatedAt
+                  version
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/invoice.rb

@@ -0,0 +1,31 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class Invoice
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($id: ID!) {
+                invoice(id: $id) {
+                  balanceCents
+                  balanceCurrency
+                  dueOn
+                  id
+                  issuedOn
+                  number
+                  paidAt
+                  shipment {
+                    id
+                    loadId
+                  }
+                  totalCents
+                  totalCurrency
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/invoices.rb

@@ -0,0 +1,39 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class Invoices
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($filter: InvoiceFilter, $page: Int, $pageSize: Int, $sort: [String!]) {
+                invoices(filter: $filter, page: $page, pageSize: $pageSize, sort: $sort) {
+                  items {
+                    balanceCents
+                    balanceCurrency
+                    dueOn
+                    id
+                    issuedOn
+                    number
+                    paidAt
+                    shipment {
+                      id
+                      loadId
+                    }
+                    totalCents
+                    totalCurrency
+                  }
+                  page
+                  pageSize
+                  pages
+                  totalItems
+                  updatedAt
+                  version
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/shipment.rb

@@ -0,0 +1,102 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          class Shipment
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($id: ID!) {
+                shipment(id: $id) {
+                  bol
+                  bookedAt
+                  brokerCarrier {
+                    account
+                    carrier {
+                      id
+                      mcNumber
+                      name
+                      scac
+                    }
+                    id
+                  }
+                  brokerCustomer {
+                    customer {
+                      id
+                      name
+                    }
+                    id
+                  }
+                  canceledAt
+                  createdAt
+                  customerReference
+                  deliveredAt
+                  deliveryAppointmentAt
+                  deliveryAppointmentOn
+                  deliveryEtaOn
+                  departedOriginTerminalAt
+                  dispatchedAt
+                  events {
+                    city
+                    countryAlpha2
+                    id
+                    name
+                    occurredAt
+                    regionIso31662
+                    typeCode
+                    zipCode
+                  }
+                  id
+                  loadId
+                  lostOn
+                  outForDeliveryAt
+                  pendingAppointmentSince
+                  pickedUpAt
+                  pickupDriverAssignedAt
+                  pickupOn
+                  pro
+                  receiverAddress {
+                    city
+                    country {
+                      alpha2Code
+                    }
+                    id
+                    region {
+                      abbreviation
+                    }
+                    street
+                    street2
+                    timeZoneName
+                    zipCode
+                  }
+                  receiverName
+                  shipperAddress {
+                    city
+                    country {
+                      alpha2Code
+                    }
+                    id
+                    region {
+                      abbreviation
+                    }
+                    street
+                    street2
+                    timeZoneName
+                    zipCode
+                  }
+                  shipperBol
+                  shipperName
+                  shipperReference
+                  status
+                  totalChargesCents
+                  totalChargesCurrency
+                  truckload
+                  updatedAt
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freight_kit/platforms/next_tms/graphql_client/query/shipment_documents.rb

@@ -0,0 +1,29 @@
+module FreightKit
+  module Platforms
+    class NextTMS
+      class GraphQLClient
+        module Query
+          # Never cached, since document URLs expire after 5 minutes
+          class ShipmentDocuments
+            DETAILS = Client.parse(<<~GRAPHQL)
+              query($filter: ShipmentFilter, $page: Int, $pageSize: Int) {
+                shipments(filter: $filter, page: $page, pageSize: $pageSize) {
+                  items {
+                    documents {
+                      contentType
+                      filename
+                      kind
+                      url
+                    }
+                    id
+                    loadId
+                  }
+                }
+              }
+            GRAPHQL
+          end
+        end
+      end
+    end
+  end
+end