http

Overview

The http Fortran package provides a simple and convenient way to make HTTP requests and retrieve responses. It aims to simplify the process of interacting with web services by providing a high-level API.

Currently package includes the following features:

• Sending GET request (POST, PUT, DELETE, and other HTTP requests coming soon).
• Handling response data, including status code, content length, method, headers and content.
• Support for custom headers and request parameters.
• Error handling for unsuccessful requests.

Prerequisites

Before building the library, ensure that you have the necessary dependencies installed. On Ubuntu, you need to install the curl development headers. Use the following command:

sudo apt install -y libcurl4-openssl-dev

fpm usage

To use http within your fpm project, add the following to your package manifest file (fpm.toml):

[dependencies]
fhash = { git = "https://github.com/fortran-lang/http-client.git" }

Usage Example

The following example demonstrates how to use the http package to make a Simple GET request and process the response

program simple_get
    use http, only : response_type, request
    implicit none
    type(response_type) :: response

    ! Send a GET request to retrieve JSON data
    response = request(url='https://jsonplaceholder.typicode.com/todos/1')

    ! Check if the request was successful
    if (.not. response%ok) then
        print *, 'Error message:', response%err_msg
    else
        ! Print the response details
        print *, 'Response Code    :', response%status_code
        print *, 'Response Length  :', response%content_length
        print *, 'Response Method  :', response%method
        print *, 'Response Content :', response%content
    end if

end program simple_get

Ouptut :

 Response Code    :          200
 Response Length  :                    83
 Response Method  : GET
 Response Content : {
  "userId": 1,
  "id": 1,
  "title": "delectus aut autem",
  "completed": false
}

In this example, we make a GET request to the URL https://jsonplaceholder.typicode.com/todos/1 to retrieve JSON data. If the request is successful, we print the response code, content length, method, and content. If the request fails, we print the error message.

Contributing to project

Thank you for your interest in contributing to the http Fortran package! Contributions from the community are valuable in improving and enhancing the functionality of the package. This section provides a guide on how to get the code, build the library, and run examples and tests.

Get the code

To get started, follow these steps:

Clone the repository using Git:

git clone https://github.com/fortran-lang/http-client
cd http-client

Prerequisites

Before building the library, ensure that you have the necessary dependencies installed. On Ubuntu, you need to install the curl development headers. Use the following command:

sudo apt install -y libcurl4-openssl-dev

Build the library

The http package uses fpm as the build system. Make sure you have fpm version 0.8.x or later installed. To build the library, execute the following command within the project directory:

fpm build

Run examples

The http package provides example programs that demonstrate its usage. To run the examples, use the following command:

fpm run --example <example name>

Executing this command will execute the example programs, allowing you to see the package in action and understand how to utilize its features.

Run tests

The http package includes a test suite to ensure its functionality is working as expected. To run the tests, execute the following command:

fpm test

Running the tests will validate the behavior of the package and help identify any issues or regressions.

Contributing guidelines

When contributing to the http Fortran package, please keep the following guidelines in mind:

• Before making any substantial changes, it is recommended to open an issue to discuss the proposed changes and ensure they align with the project's goals.
• Fork the repository and create a new branch for your contribution.
• Ensure that your code adheres to the existing coding style and follows good software engineering practices.
• Write clear and concise commit messages.
• Make sure to test your changes and ensure they do not introduce regressions or break existing functionality.
• Submit a pull request with your changes, providing a clear explanation of the problem you are solving and the approach you have taken.

We appreciate your contributions and look forward to your valuable input in improving the http Fortran package.

Happy coding!