nerves-hub/nerves_hub_user_api

HTTP Client for interacting with the NervesHub API

NervesHubUserAPI

Important

This is for the maint-v1.0 version of NervesHub. It has been merged into NervesHubCLI going forward.

---

This is a library for interacting with a NervesHub website programmatically. See NervesHubCLI for using it with mix.

Devices do not use this library to connect to a NervesHub server. See NervesHubLink for the reference client.

Installation

The package can be installed by adding nerves_hub_user_api to your list of dependencies in mix.exs:

def deps do
  [
    {:nerves_hub_user_api, "~> 0.8.0"}
  ]
end

The docs can be found at HexDocs.

Environment variables

NervesHubUserAPI may be configured using environment variables to simplify automation. Environment variables take precedence over configuration. The following variables are available:

• NERVES_HUB_SCHEME - NervesHub API endpoint scheme (defaults to https)
• NERVES_HUB_HOST - NervesHub API endpoint IP address or hostname
• NERVES_HUB_PORT - NervesHub API endpoint port (defaults to 443)
• NERVES_LOG_DISABLE_PROGRESS_BAR - Set to disable the progress bar on file transfers

Configuration

NervesHubUserAPI may also be configured in the config.exs. It supports the following keys:

• scheme NervesHub API endpoint scheme (defaults to https)
• host - NervesHub API endpoint address
• port - NervesHub API endpoint port (defaults to 443)
• ca_store - A module that exposes a single function ca_certs that returns certs as a list of DER encoded binaries.

nerves_hub_user_api's Issues

Support registering CA Certificate with a description

Counterpart of nerves-hub/nerves_hub_web#660

$NERVES_HUB_CA_DIR is not respected

  defp ca_certs() do
    [
      "/home/connor/workspace/oss/elixir/nerves/nerves-hub/ssl/ca.pem"
    ]
    |> Enum.map(&File.read!/1)
    |> Enum.map(&Certificate.from_pem!/1)
    |> Enum.map(&Certificate.to_der/1)
  end

Had to do this to get CA certs to load

When reading ca certs dir, invalid file should be ignored

In https://github.com/nerves-hub/nerves_hub_user_api/blob/main/lib/nerves_hub_user_api/api.ex#L150 , when reading cert files, invalid files should be ignored (README, .git, etc)

Support organization management

The user API should support adding, removing and listing the users in an organization.

`Unhandled error: {:error, :checkout_failure}` on OTP 24.3 when publishing firmware

Looks like OTP 24.3 broke pooling in hackney, which is the underlying adapter of Tesla, which is the HTTP library used here.

See benoitc/hackney#689 (comment) (which may or may not be related in fixing)