{"id":16964956,"url":"https://github.com/propensive/telekinesis","last_synced_at":"2025-07-19T19:03:54.379Z","repository":{"id":43838971,"uuid":"511672525","full_name":"propensive/telekinesis","owner":"propensive","description":"A lightweight URI representation and HTTP client","archived":false,"fork":false,"pushed_at":"2025-02-12T15:41:51.000Z","size":3309,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-19T11:07:12.788Z","etag":null,"topics":["http","http-client","rest","scala"],"latest_commit_sha":null,"homepage":"https://propensive.com/telekinesis/","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/propensive.png","metadata":{"files":{"readme":".github/readme.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-07T20:57:58.000Z","updated_at":"2025-02-12T15:41:55.000Z","dependencies_parsed_at":"2023-02-19T18:01:04.683Z","dependency_job_id":"d24367ea-1f8b-41c9-afb9-6c9508d8ddbf","html_url":"https://github.com/propensive/telekinesis","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/propensive/telekinesis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Ftelekinesis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Ftelekinesis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Ftelekinesis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Ftelekinesis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/telekinesis/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Ftelekinesis/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265992482,"owners_count":23860913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["http","http-client","rest","scala"],"created_at":"2024-10-13T23:44:41.137Z","updated_at":"2025-07-19T19:03:54.359Z","avatar_url":"https://github.com/propensive.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg alt=\"GitHub Workflow\" src=\"https://img.shields.io/github/actions/workflow/status/propensive/telekinesis/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/telekinesis/actions)\n[\u003cimg src=\"https://img.shields.io/discord/633198088311537684?color=8899f7\u0026label=DISCORD\u0026style=for-the-badge\" height=\"24\"\u003e](https://discord.com/invite/MBUrkTgMnA)\n\u003cimg src=\"/doc/images/github.png\" valign=\"middle\"\u003e\n\n# Telekinesis\n\n__A lightweight HTTP client and server for the Loom generation__\n\n__Telekinesis__ is a lightweight HTTP client for sending and HTTP requests.\n\n## Features\n\n- immutable API optimized for Scala 3 and lightweight concurrency with Loom\n- Simple and flexible request handling\n- HTTP server can be run standalone or wrap a servlet container\n- typesafe representations of HTTP request and response headers and MIME types\n- transparent typeclass-based request body query parameter serialization and deserialization\n- optional pattern-matching on requests\n- fast streaming without complexity\n- safe parameter and header access\n- typesafe representation of URLs\n\n## Availability\n\n\n\n\n\n\n\n## Getting Started\n\nHere is an example of a simple HTTP request:\n\n```scala\nimport telekinesis.*\n\nval response = url\"http://example.com/test\".query(flag = t\"yes\", param = t\"7\").get().as[Text]\n```\n\n### Sending an HTTP request\n\nAn HTTP request may be sent by calling one of the HTTP methods—`get`, `post`, `put`, `options`, `head`, `trace`,\n`delete`, `connect` or `patch`—on the `Http` object. As a minimum, these methods all take a URL as their first\nparameter. This may be provided as a `Url` (see below) or a `Text`, or any type which has a contextual\n`ToLocation` instance which can convert it into URL string. This may be useful for integration with alternitave\nURL representations.\n\nIf the request is successful, a response will be returned synchronously as an `HttpResponse` instance.\n`HttpResponse` provides the methods `status` (the HTTP status code), `headers` (a map of HTTP response headers),\nand `body` which will be a representation of the response body, in bytes.\n\nThe easiest way to access the body is by converting it to another type, using a contextual reader. That can be\nachieved by calling `as` with an appropriate type, for example,\n```scala\nurl\"https://example.com/service\".get().as[Text]\n```\nor with a suitable JSON library such as [Jacinta](https://propensive.com/opensource/jacinta/),\n```scala\nimport jacinta.*\nurl\"http://example.com/file\".post(content).as[Json]\n```\n\n### Request and response bodies\n\nThe type of `body` is `Body`, defined as an alias for, `Unit | IArray[Byte] | LazyList[IArray[Byte]]`, a union\ntype corresponding to the cases of an empty response, a response of known length, and a streamed response,\nrespectively.\n\nThis type is commonly used for both requests and responses.\n\n### Error handling\n\nHTTP requests may fail for a variety of reasons. These will be thrown as `HttpError`s only when the `as` method\nis invoked (an `HttpResponse` is always returned from `get` or `post`, even in the event of a failure status).\nAn `HttpError` contains a `status` field of the HTTP status code.\n\nSome HTTP requests will fail, but will still send a useful response body which can be read and interpreted like\nany other, albeit from the `HttpError` instance.\n\nHere is an example of an HTTP error being handled:\n\n```scala\ntry uri.get().as[Text]\ncatch\n  case error@HttpError(HttpStatus.NotFound, _) =\u003e\n    t\"The page was not found. The server responded with: ${error.as[Text]}\"\n  case HttpError(_, _) =\u003e\n    t\"The request failed\"\n```\n\n\n\n\n\n\n## Status\n\nTelekinesis is classified as __fledgling__. For reference, Soundness projects are\ncategorized into one of the following five stability levels:\n\n- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity\n- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns\n- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement\n- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later\n- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipated\n\nProjects at any stability level, even _embryonic_ projects, can still be used,\nas long as caution is taken to avoid a mismatch between the project's stability\nlevel and the required stability and maintainability of your own project.\n\nTelekinesis is designed to be _small_. Its entire source code currently consists\nof 1202 lines of code.\n\n## Building\n\nTelekinesis will ultimately be built by Fury, when it is published. In the\nmeantime, two possibilities are offered, however they are acknowledged to be\nfragile, inadequately tested, and unsuitable for anything more than\nexperimentation. They are provided only for the necessity of providing _some_\nanswer to the question, \"how can I try Telekinesis?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Telekinesis's build\n   structure, dependencies and source location; the file format should be short\n   and quite intuitive. Copy the sources into a source directory in your own\n   project, then repeat (recursively) for each of the dependencies.\n\n   The sources are compiled against the latest nightly release of Scala 3.\n   There should be no problem to compile the project together with all of its\n   dependencies in a single compilation.\n\n2. *Build with [Wrath](https://github.com/propensive/wrath/)*\n\n   Wrath is a bootstrapping script for building Telekinesis and other projects in\n   the absence of a fully-featured build tool. It is designed to read the `fury`\n   file in the project directory, and produce a collection of JAR files which can\n   be added to a classpath, by compiling the project and all of its dependencies,\n   including the Scala compiler itself.\n   \n   Download the latest version of\n   [`wrath`](https://github.com/propensive/wrath/releases/latest), make it\n   executable, and add it to your path, for example by copying it to\n   `/usr/local/bin/`.\n\n   Clone this repository inside an empty directory, so that the build can\n   safely make clones of repositories it depends on as _peers_ of `telekinesis`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Telekinesis's dependencies.\n\n   If the build was successful, the compiled JAR files can be found in the\n   `.wrath/dist` directory.\n\n## Contributing\n\nContributors to Telekinesis are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/telekinesis/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Telekinesis\neasier.\n\nPlease __do not__ contact project maintainers privately with questions unless\nthere is a good reason to keep them private. While it can be tempting to\nrepsond to such questions, private answers cannot be shared with a wider\naudience, and it can result in duplication of effort.\n\n## Author\n\nTelekinesis was designed and developed by Jon Pretty, and commercial support and\ntraining on all aspects of Scala 3 is available from [Propensive\nO\u0026Uuml;](https://propensive.com/).\n\n\n\n## Name\n\nThe library provides a way of handling URIs, performing \"action at a distance\",\nor _telekinesis_; specifically the processing of a request on a remote server.\nA man called Uri was also famed for his ability to perform telekinesis with\nspoons.\n\nIn general, Soundness project names are always chosen with some rationale,\nhowever it is usually frivolous. Each name is chosen for more for its\n_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no\nbias towards names with positive or \"nice\" meanings—since many of the libraries\nperform some quite unpleasant tasks.\n\nNames should be English words, though many are obscure or archaic, and it\nshould be noted how willingly English adopts foreign words. Names are generally\nof Greek or Latin origin, and have often arrived in English via a romance\nlanguage.\n\n## Logo\n\nThe logo shows the characters `://`, which form part of every URL.\n\n## License\n\nTelekinesis is copyright \u0026copy; 2025 Jon Pretty \u0026 Propensive O\u0026Uuml;, and\nis made available under the [Apache 2.0 License](/license.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Ftelekinesis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Ftelekinesis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Ftelekinesis/lists"}