Packages

shippex

0.6.5
0.18.0 0.17.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.16 0.6.15 0.6.14 0.6.13 0.6.12 0.6.11 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.3 0.5.2 0.5.1 0.5.0 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.1 0.3.0 0.2.0 0.1.1 0.1.0

Shippex is an abstraction of commonly used features in shipping with various carriers. It provides a (hopefully) pleasant API to work with carrier- provided web interfaces for fetching rates and printing shipping labels.

HexDocs

Current section

Files

Jump to
Readme
43 Versions
5 Dependencies
Dependants
Files
Activity
shippex lib shippex carrier.ex
Raw

lib/shippex/carrier.ex 

defmodule Shippex.Carrier do

  @moduledoc """

  Defines a behaviour for implementing a new Carrier module. Includes a helper

  function for fetching the Carrier module.

  """



  alias Shippex.Carrier



  @callback fetch_rates(Shipment.t()) :: [{atom, Rate.t()}]

  @callback fetch_rate(Shipment.t(), Service.t()) :: [{atom, Rate.t()}] | {atom, Rate.t()}

  @callback create_transaction(Shipment.t(), atom() | Service.t()) :: {atom, Transaction.t() | map}

  @callback cancel_transaction(Transaction.t()) :: {atom, String.t()}

  @callback cancel_transaction(Shipment.t(), String.t()) :: {atom, String.t()}



  @type t :: atom



  @doc """

  Fetches a Carrier module by its atom/string representation.



      iex> Carrier.module(:ups)

      Carrier.UPS

      iex> Carrier.module("UPS")

      Carrier.UPS

      iex> Carrier.module("ups")

      Carrier.UPS

  """

  @spec module(atom | String.t()) :: module()

  def module(carrier) when is_atom(carrier) do

    module =

      case carrier do

        :ups -> Carrier.UPS

        :usps -> Carrier.USPS

        c -> raise "#{c} is not a supported carrier at this time."

      end



    available_carriers = Shippex.carriers()



    if carrier in available_carriers do

      module

    else

      raise Shippex.InvalidConfigError,

            "#{inspect(carrier)} not found in carriers: #{inspect(available_carriers)}"

    end

  end



  def module(string) when is_bitstring(string) do

    string

    |> String.downcase()

    |> String.to_atom()

    |> module

  end

end