👁 Image
FiftyOne.Pipeline.Engines.FiftyOne 4.5.57

51Degrees Pipeline API

👁 Data rewards the curious
Pipeline API

Developer Documentation | NuGet | Package | NuGet | Package | | --- | --- | --- | --- | | 👁 NuGet
| CloudRequestEngine | 👁 NuGet
| Examples.Shared | | 👁 NuGet
| Core | 👁 NuGet
| JavaScriptBuilder | | 👁 NuGet
| Engines | 👁 NuGet
| JsonBuilder | | 👁 NuGet
| Engines.FiftyOne | 👁 NuGet
| Web | | 👁 NuGet
| Engines.TestHelpers | 👁 NuGet
| Web.Shared |

Introduction

This repository contains all the projects required to build the .NET implementation of the Pipeline API. Individual engines (For example, device detection) are in separate repositories.

The specification is also available on GitHub and is recommended reading if you wish to understand the concepts and design of this API.

Dependencies

Visual Studio 2022 or later is recommended. Although Visual Studio Code can be used for working with most of the projects.

The Pipeline projects are written in C# and target .NET Standard 2.0.3 The Web integration multi-targets the following: - .NET Core 3.1 - .NET Core 8.0 - .NET Framework 4.6.2

The tested versions page shows the .NET versions that we currently test against. The software may run fine against other versions, but additional caution should be applied.

Strong naming

All NuGet packages published from this repository are strong-name signed so they can be referenced by strong-named consumer applications (notably .NET Framework hosts that enforce strong-name identity at assembly load).

How signing is wired

The same 51Degrees.publickey file is committed at the root of each shipping repo. Signing is configured once via and applies to every project:

• Local developer builds use the PublicSign pattern — the compiler stamps the public key into each assembly so it is identified as strong-named, but no cryptographic signature is produced. Only 51Degrees.publickey (committed) is needed, so contributors can build and test without any secrets.
• Production builds (CI only) receive the matching private .snk from a GitHub organization secret, so the assemblies in the published NuGet packages carry a real cryptographic signature.

The same public key token appears on every FiftyOne.* DLL shipped from this repo and its upstream library repos (caching-dotnet, common-dotnet), so the dependency chain remains consistent under strong-name identity checks.

Why vendor/Stubble/ exists

Strong-named assemblies can only reference other strong-named assemblies. FiftyOne.Pipeline.JavaScriptBuilder depends on Stubble.Core, and the upstream NuGet package is not strong-named. A request to publish a strong-named build has been open in that project since December 2019 — see StubbleOrg/Stubble#85 — with no progress in over five years.

Rather than wait, the Stubble source is vendored under and built from source as a project reference. It inherits the strong-naming configuration from the repo root and ships strong-signed alongside our own assemblies. Stubble is MIT-licensed and the upstream copyright and licence notices are preserved unchanged in the vendored tree.

Solutions and projects

• FiftyOne.Pipeline - The core projects that comprise the Pipeline API.
  • FiftyOne.Pipeline.Core - The core Pipeline classes such as Pipeline, FlowData, FlowElement and Evidence.
  • FiftyOne.Pipeline.Engines - Functionality for AspectEngines, a specialized FlowElement with additional features.
  • FiftyOne.Pipeline.Engines.FiftyOne - Functionality that is specific to 51Degrees aspect engines.
• FiftyOne.Pipeline.Web - Projects that are relevant to the Pipeline API ASP.NET integration.
  • FiftyOne.Pipeline.Web - ASP.NET Core integration.
  • FiftyOne.Pipeline.Web.Framework - ASP.NET Framework integration.
  • FiftyOne.Pipeline.Web.Minify - FlowElement which takes the JavaScript function from the JavaScriptBundler element and minifies it.
  • FiftyOne.Pipeline.Web.Shared - Shared code that is used by both Core and Framework ASP.NET integrations.
• FiftyOne.Pipeline.Elements - Projects for various common Flow Elements that are used by multiple other solutions.
  • FiftyOne.Pipeline.JavaScriptBuilder - An element that packages values from all 'JavaScript' properties from all engines into a single JavaScript function.
  • FiftyOne.Pipeline.JsonBuilder - An element that serializes all properties from all engines into JSON format.
• FiftyOne.CloudRequestEngine - Projects related to making general requests to the 51Degrees cloud.
  • FiftyOne.Pipeline.CloudRequestEngine - An engine that makes requests to the 51Degrees cloud service.

Installation

You can either clone this repository and reference the projects locally or you can reference the NuGet packages directly.

Install-Package FiftyOne.Pipeline.Core
Install-Package FiftyOne.Pipeline.Engines
Install-Package FiftyOne.Pipeline.Engines.FiftyOne
Install-Package FiftyOne.Pipeline.Web
Install-Package FiftyOne.Pipeline.Web.Minify
Install-Package FiftyOne.Pipeline.JsonBuilder
Install-Package FiftyOne.Pipeline.JavaScriptBuilder
Install-Package FiftyOne.Pipeline.CloudRequestEngine

Note that the packages have dependencies on each other so you'll never need to install all of them individually. For example, Installing FiftyOne.Pipeline.Engines.FiftyOne will automatically add FiftyOne.Pipeline.Engines and FiftyOne.Pipeline.Core.

Examples

Pipeline Examples

There are several examples available that demonstrate how to make use of the Pipeline API in isolation. These are described in the table below. If you want examples that demonstrate how to use 51Degrees products such as device detection, then these are available in the corresponding repository and on our website.

The CloudRequestEngine\GettingStarted example requires a resource key. It reads the aligned 51DEGREES_RESOURCE_KEY environment variable first, then the legacy RESOURCE_KEY variable. A resource key with the free properties used by the examples can be created at https://configure.51degrees.com/Wkqxf3Bs?utm_source=github&utm_medium=readme&utm_campaign=pipeline-dotnet&utm_content=readme.md&utm_term=pipeline-examples.

Tests

• FiftyOne.Pipeline.CloudRequestEngine.Tests - Tests for the CloudRequestEngine and builder.
• FiftyOne.Pipeline.Core.Tests - Tests for FlowElement and FlowData base classes.
• FiftyOne.Pipeline.Engines.Tests - Tests for AspectEngines and AspectData base classes.
• FiftyOne.Pipeline.Engines.FiftyOne.Tests - Tests for 51Degrees specific aspect engines.
• FiftyOne.Pipeline.Examples.Tests - Tests for developer examples. This will automatically run all the examples and ensure they do not crash.
• FiftyOne.Pipeline.Web.Tests - Tests for web integration functionality.

The tests can be run from within Visual Studio or (in most cases) by using the dotnet test command line tool.

Project documentation

For complete documentation on the Pipeline API and associated engines, see the 51Degrees documentation site.