Merge pull request esl#21 from paulo-ferraz-oliveira/remove/hrl

Remove hrl

Author: paulo-ferraz-oliveira

.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+---
+name: CI for lhttpc
+on:
+  pull_request:
+    branches:
+      - master
+jobs:
+  ci:
+    name: Run checks and tests over ${{matrix.otp_vsn}} and ${{matrix.os}}
+    runs-on: ${{matrix.os}}
+    strategy:
+      matrix:
+        otp_vsn: [19.3, 20.3, 21.3, 22.3, 23.1]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v2
+      - name: version
+        run: make version

.gitignore

@@ -1,21 +1,6 @@
-ebin/*
-
-doc/edoc-info
-doc/*.html
-doc/*.png
-doc/*.css
-util/*.beam
-cover_report/
-test/*.beam
-test/*.log
-
-.eunit
-
-
-*.plt
+.rebar3
+_build
 erl_crash.dump
-
-
-_build/
-log/
-TEST-*.xml
+logs
+rebar3.crashdump
+TEST-*

.travis.yml

@@ -1,90 +1,121 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html)
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 since version `3.0.0`.
 
+## [Unreleased]
+
+### Added
+
+- all types that are exposed via API functions to their respective module's `export_type` sections
+
+### Removed
+
+- lhttpc_types.hrl
+- lhttpc.hrl
+- defined types that are unused internally (and not exported)
+
 ## [3.3.0] - 2020-05-22
 
 ### Added
+
 - compatibility with OTP 23
 
 ### Changed
+
 - Travis constraints: updated version as per our current reality; added `make check`
 - minimum supported version to 19.3
 - README.md: removed outdated info; added test-related info
 
 ### Fixed
+
 - some broken tests
 
 ## [3.2.0] - 2020-04-30
 
 ### Changed
+
 - source of dependencies to Hex, for quicker builds
 
 ### Removed
+
 - support for OTP 17
 - support for OTP 18
 - support for rebar2
 
 ## [3.1.0] - 2020-03-12
 
 ### Added
+
 - exported types lhttpc:result/0 and lhttpc:headers/0
 
 ### Changed
+
 - CA bundles, to base them on the latest Mozilla Included CA Certificate List
 
 ### Fixed
+
 - OTP 21 dialyzer warnings
 
 ## [3.0.7] - 2019-09-25
-#
+
 ### Fixed
+
 - unwarranted throwing of exception(s) to consumer during racy pool creation
 
 ## [3.0.6] - 2019-09-24
-#
+
 ### Fixed
+
 - warning on rebar3 over ssl_verify_fun's missing .app description
 
 ## [3.0.5] - 2019-02-01
-#
+
 ### Fixed
+
 - potential compilation issues when importing lib. as a dependency on OTP 21
 
 ## [3.0.4] - 2019-01-23
-#
+
 ### Fixed
+
 - bad specification of returned error reasons on :request/{4,5,6,9}
 
 ## [3.0.3] - 2019-01-18
-#
+
 ### Fixed
+
 - dialyzer warnings
 
 ## [3.0.2] - 2018-09-13
-#
+
 ### Fixed
+
 - OTP 21 compile-time warnings
 
 ## [3.0.1] - 2018-08-07
-#
+
 ### Fixed
+
 - rebar2 support
 
 ## [3.0.0] - 2018-08-07
-#
+
 ### Added
+
 - missing boot dependencies
 
 ### Changed
+
 - application was rebar3ified while still being usable as a rebar2 dependency
 - application version is now determined from git
 - HTTPS requests are now secure by default
 
 ### Fixed
+
 - unintelligibility of which test cases failed (main suite)
 - low test coverage due to broken test cases that prevented others from running
 
@@ -118,14 +149,14 @@ Version 1.2.5:
 * Fix for decoding chunked HTTP responses with extraneous whitespace
   (thanks to Bob Ippolito)
     * api.facebook.com includes extra whitespace in its chunked HTTP response
-      length, e.g. "6  \r\n" instead of "6\r\n". 
+      length, e.g. "6  \r\n" instead of "6\r\n".
 
 Version 1.2.4:
 * Fix handling of HTTP response code 304 (patch by Ben Slavin)
 
 Version 1.2.3:
 * Fix handling of unexpected 100 Continue response (patch by Magnus Henoch)
- 
+
 Version 1.2.2:
 * Fix Host header, add port number (reported by Benoit Chesneau)
 
@@ -143,7 +174,7 @@ Version 1.2.0:
     * The client can either return {ok, Result} or {error, Reason}. Reason
       (which wasn't very well defined before) can now be:
         * connection_closed: The server closed the connection on us (N times
-          in case it happens just after sending the request) 
+          in case it happens just after sending the request)
         * connect_timeout: If the TCP stack gives up or we hit the
           connect_timeout option
         * timeout: If the overall request timeout value is hit
@@ -165,14 +196,14 @@ Version 1.1.2:
 * Fix minor error with {active, once} instead of {active, true} in manager
 * Remove socket and try to find another if the manager can't set controlling
   process due to socket error
-* Improve test suite 
+* Improve test suite
 
 Version 1.1.1:
 * Fix problem with empty lists in dicts when last socket is consumed
-* Improve test suite to include cover report 
+* Improve test suite to include cover report
 
 Version 1.1.0:
-* Support for configurable connection timeout 
+* Support for configurable connection timeout
 
 Version 1.0.0:
 * Initial version

CHANGELOG.md

@@ -1,11 +1,39 @@
-# Migration Plan
+# Migration guide
+
 Whenever there's an interface breaking change (a change in the project's major version),
 required migration instructions will be detailed in this file.
 
+## From [3.x] to [4.x]
+
+### Update
+
+- your code to depend on types from `lhttpc:` and `lhttpc_client:` and not (imported)
+`lhttpc_types.hrl` (a simple `dialyzer` procedure should put into evidence what is mis-specified)
+- your code to not depend on `lhttpc.hrl`'s `lhttpc_url` record:
+  - if you're "building" the record, you can use
+`lhttpc_client:new_url(Host, Port, Path, IsSSL, User, Password)` where you were once using
+`#lhttpc_url{ host = Host,
+              port = Port,
+              path = Path,
+              is_ssl = IsSSL,
+              user = User,
+              password = Password }`
+(`lhttpc_client:new_url/4` also available, for convenience)
+- your code to access the `lhttpc_url` record content via new accessor functions
+`lhttpc_client:url(LhttpcURL, FieldName)`
+
+### Remove
+
+- your code's import of `lhttpc_types.hrl`
+- your code's import of `lhttpc.hrl`
+
 ## From [2.x] to [3.x]
+
 ### Update
+
 - calls to lhttpc:request/{4,5,6,9} requesting HTTPS URLs which you **do** need to keep
   insecure, and only if you need to do so, by explicitly using the new `verify_ssl_cert` option:
+
 ```erlang
 % before:
 lhttpc:request("https://self-signed.badssl.com", "GET", [], <<>>, 5000).
@@ -14,7 +42,9 @@ lhttpc:request("https://self-signed.badssl.com", "GET", [], <<>>, 5000).
 lhttpc:request("https://self-signed.badssl.com", "GET", [], <<>>, 5000,
                [{verify_ssl_cert, false}]).
 ```
+
 ### Other info
+
 - new dependencies:
-    - `certifi` (version 2.3.1)
-    - `ssl_verify_fun` (version 1.1.4)
+  - `certifi` (version 2.3.1)
+  - `ssl_verify_fun` (version 1.1.4)

LICENCE LICENSELICENCE renamed to LICENSE

@@ -1,47 +1,62 @@
-REBAR3_URL=https://s3.amazonaws.com/rebar3/rebar3
+SHELL := bash
+.ONESHELL:
+.SHELLFLAGS := -euc
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
 
-ifeq ($(wildcard rebar3),rebar3)
-	REBAR3 = $(CURDIR)/rebar3
-endif
+version: upgrade clean compile check test edoc
+.PHONY: version
 
-REBAR3 ?= $(shell test -e `which rebar3` 2>/dev/null && which rebar3 || echo "./rebar3")
-
-ifeq ($(REBAR3),)
-	REBAR3 = $(CURDIR)/rebar3
-endif
+shell:
+	@rebar3 shell
+.PHONY: shell
 
-.PHONY: all build clean check dialyzer xref test cover shell
+upgrade: upgrade-rebar3_lint
+.PHONY: upgrade
 
-.NOTPARALLEL: check
+upgrade-rebar3_lint:
+	@rebar3 plugins upgrade rebar3_lint
+.PHONY: upgrade-rebar3_lint
 
-all: build
+clean:
+	@rebar3 clean -a
+.PHONY: clean
 
-build: $(REBAR3)
-	@$(REBAR3) compile
+compile:
+	@rebar3 compile
+.PHONY: compile
 
-$(REBAR3):
-	wget $(REBAR3_URL) || curl -Lo rebar3 $(REBAR3_URL)
-	@chmod a+x rebar3
+check: xref dialyzer elvis-rock
+.PHONY: check
 
-clean: $(REBAR3)
-	@$(REBAR3) clean
+xref:
+	@rebar3 as test xref
+.PHONY: xref
 
-check: dialyzer xref
+dialyzer:
+	@rebar3 as test dialyzer
+.PHONY: dialyzer
 
-dialyzer: $(REBAR3)
-	@$(REBAR3) dialyzer
+elvis-rock:
+	@rebar3 lint
+.PHONY: elvis-rock
 
-xref: $(REBAR3)
-	@$(REBAR3) xref
+test: eunit ct cover
+.PHONY: test
 
-test: $(REBAR3)
-	@$(REBAR3) do ct, eunit
+eunit:
+	@rebar3 eunit
+.PHONY: eunit
 
-test-travis: $(REBAR3)
-	@$(REBAR3) as travis-ci do ct, eunit
+ct:
+	@rebar3 ct
+.PHONY: ct
 
-cover: test
-	@$(REBAR3) cover
+cover:
+	@rebar3 cover
+.PHONY: cover
 
-shell:
-	@$(REBAR3) shell
+edoc:
+	@rebar3 edoc
+.PHONY: edoc

MIGRATION.md

@@ -1,7 +1,7 @@
 # lhttpc
 
-[![](https://travis-ci.com/miniclip/lhttpc.png?branch=master)](https://travis-ci.com/miniclip/lhttpc)
-[![Erlang][erlang badge]][erlang downloads]
+![CI for lhttpc](https://github.com/miniclip/lhttpc/workflows/CI%20for%20lhttpc/badge.svg)
+[![erlang][erlang badge]][erlang downloads]
 
 [erlang badge]: https://img.shields.io/badge/erlang-%3E%3D19.3-lightgrey
 [erlang downloads]: http://www.erlang.org/download