From 46273af1b7af4568e7913d9e4127f3d4382d1856 Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Thu, 6 Sep 2018 18:38:42 +0200 Subject: [PATCH 1/8] Added missing 50x Server Error status codes --- CHANGELOG.md | 1 + src/httpHeader.cpp | 68 +++++++++++++++++++++++++--------------------- src/httpHeader.hpp | 12 ++++++-- 3 files changed, 47 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d11f26..dc91f59 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Fixed ### +- Missing 50x Server Error status codes are now available - A bug that generated a BAD_REQUEST response if the request method is not allowed by the server - A bug that generated a link-time error when using deserialization functions diff --git a/src/httpHeader.cpp b/src/httpHeader.cpp index b33ff3f..06fed63 100644 --- a/src/httpHeader.cpp +++ b/src/httpHeader.cpp @@ -16,26 +16,26 @@ const String requestMethodString[] const String responseString[] { "100 CONTINUE" , - "101 SWITCHING PROTOCOLS ", - "102 PROCESSING ", + "101 SWITCHING PROTOCOLS " , + "102 PROCESSING " , "200 OK" , - "201 CREATED ", - "202 ACCEPTED ", - "203 UNOFFICIAL INFO ", - "204 NO CONTENT ", - "205 RESET CONTENT ", - "206 PARTIAL CONTENT ", - "207 MULTI STATUS ", + "201 CREATED " , + "202 ACCEPTED " , + "203 UNOFFICIAL INFO " , + "204 NO CONTENT " , + "205 RESET CONTENT " , + "206 PARTIAL CONTENT " , + "207 MULTI STATUS " , "300 MULTIPLE CHOICES " , - "301 MOVED PERMANENTLY ", - "302 FOUND ", - "303 SEE OTHER ", - "304 NOT MODIFIED ", - "305 USE PROXY ", - "306 TEMPORARY REDIRECT ", - "307 PERMANENT REDIRECT ", + "301 MOVED PERMANENTLY " , + "302 FOUND " , + "303 SEE OTHER " , + "304 NOT MODIFIED " , + "305 USE PROXY " , + "306 TEMPORARY REDIRECT " , + "307 PERMANENT REDIRECT " , "400 BAD REQUEST " , "401 UNAUTHORIZED " , @@ -43,25 +43,31 @@ const String responseString[] "403 FORBIDDEN " , "404 NOT FOUND " , "405 METHOD NOT ALLOWED " , - "406 NOT ACCEPTABLE ", - "407 PROXY AUTH REQUIRED ", - "408 REQUEST TIMEOUT ", - "409 CONFLICT ", - "410 GONE ", - "411 LENGHT REQUIRED ", - "412 PRECONDITION FAILED ", - "413 ENTITY TOO LARGE ", - "414 URI TOO LONG ", - "415 UNSUPPORTED MEDIA TYPE ", - "416 REQUESTED RANGE NOT SATISFIABLE ", - "417 EXPECTATION FAILED ", - "418 I AM A TEAPOT ", - + "406 NOT ACCEPTABLE " , + "407 PROXY AUTH REQUIRED " , + "408 REQUEST TIMEOUT " , + "409 CONFLICT " , + "410 GONE " , + "411 LENGHT REQUIRED " , + "412 PRECONDITION FAILED " , + "413 ENTITY TOO LARGE " , + "414 URI TOO LONG " , + "415 UNSUPPORTED MEDIA TYPE " , + "416 REQUESTED RANGE NOT SATISFIABLE " , + "417 EXPECTATION FAILED " , + "418 I AM A TEAPOT " , "420 ENHACE YOUR CALM" , "422 UNPROCESSABLE ENTITY" , "426 UPGRADE REQUIRED" , "429 RETRY WITH" , - "451 UNAVAILABLE FOR LEGAL REASONS" + "451 UNAVAILABLE FOR LEGAL REASONS" , + + "500 INTERNAL SERVER ERROR" , + "501 NOT IMPLEMENTED" , + "502 BAD GATEWAY" , + "503 SERVICE UNAVAILABLE" , + "504 GATEWAY TIMEOUT" , + "505 HTTP VERSION NOT SUPPORTED" } ; http::Request_t::operator String() const diff --git a/src/httpHeader.hpp b/src/httpHeader.hpp index 4a6757d..11f133a 100644 --- a/src/httpHeader.hpp +++ b/src/httpHeader.hpp @@ -86,13 +86,19 @@ enum class http::Response REQUESTED_RANGE_NOT_SATISFIABLE , EXPECTATION_FAILED , I_AM_A_TEAPOT , - - // Server Error ENHACE_YOUR_CALM , UNPROCESSABLE_ENTITY , UPGRADE_REQUIRED , RETRY_WITH , - UNAVAILABLE_FOR_LEGAL_REASONS + UNAVAILABLE_FOR_LEGAL_REASONS , + + // Server error + INTERNAL_SERVER_ERROR , + NOT_IMPLEMENTED , + BAD_GATEWAY , + SERVICE_UNAVAILABLE , + GATEWAY_TIMEOUT , + HTTP_VERSION_NOT_SUPPORTED } ; /** From 60ff3cae38ab0a4b185f93d5dcad71847519750a Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Thu, 6 Sep 2018 18:52:18 +0200 Subject: [PATCH 2/8] A standard conformance fix about responses Return proper response code if a request method isn't implemented by the server --- CHANGELOG.md | 2 +- src/httpServer.hpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc91f59..e4f5b47 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Fixed ### - Missing 50x Server Error status codes are now available -- A bug that generated a BAD_REQUEST response if the request method is not allowed by the server +- A bug that generated a BAD_REQUEST response if the request method is not implemented by the server - A bug that generated a link-time error when using deserialization functions ## [1.0.0] - 2018-06-15 ## diff --git a/src/httpServer.hpp b/src/httpServer.hpp index de5ea1d..e847d05 100644 --- a/src/httpServer.hpp +++ b/src/httpServer.hpp @@ -119,7 +119,7 @@ void http::Server::replyTo( const RemoteClient < Client_t > & client ) else if( requestHandler == nullptr ) { logBuffer << "[FAIL] Request method not allowed by this server" ; - responseCode = Response::METHOD_NOT_ALLOWED ; + responseCode = Response::NOT_IMPLEMENTED ; } else requestHandler( inboundMessage, responseMessage ) ; } From d90b5dbc9e01e79939359a21da99f40443a40ebd Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Thu, 6 Sep 2018 20:37:25 +0200 Subject: [PATCH 3/8] Bumped version number --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 3e0e40f..fe82fbc 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=HTTP -version=1.0.0 +version=1.1.0 author=Giuseppe Masino (qub1750ul) maintainer=Giuseppe Masino (qub1750ul) sentence=A full HTTP/1.1 implementation library for Arduino. From 8a87fe8f8013e25aea3952dd7472e5fe47568b76 Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Thu, 6 Sep 2018 20:38:37 +0200 Subject: [PATCH 4/8] Fixed a compile error in the TestWebServer example --- examples/TestWebServer/TestWebServer.ino | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/TestWebServer/TestWebServer.ino b/examples/TestWebServer/TestWebServer.ino index 30b8d52..d3431ab 100644 --- a/examples/TestWebServer/TestWebServer.ino +++ b/examples/TestWebServer/TestWebServer.ino @@ -34,7 +34,7 @@ void loop() // If a request has been made from a remote client over the Ethernet connection // create a RemoteClient object that represents it - http::RemoteClient < EthernetClient > remoteClient = tcpServer.available() ; + http::RemoteClient < EthernetClient > remoteClient = ethernetServer.available() ; // Then pass the object to the server httpServer.replyTo( remoteClient ) ; From 8e09cc2dd7dce39b524134ab4afb0522343f62a1 Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Thu, 6 Sep 2018 23:19:56 +0200 Subject: [PATCH 5/8] Updated license details --- LICENSE.md | 427 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 17 ++- 2 files changed, 436 insertions(+), 8 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2e72ca1 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,427 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More_considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README.md b/README.md index bfd5646..3914c51 100644 --- a/README.md +++ b/README.md @@ -30,14 +30,15 @@ Powerful and easy to use. Creative Commons License
-The Arduino_HTTP\1.1 Library by Giuseppe Masino is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License and also under the following terms: +The Arduino_HTTP Library +by Giuseppe Masino +is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License -The softwares, source files, schematics and all other material are provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular scope and noninfringement. +If you need permissions that are beyond the scope of this license, you can ask me through this contacts, +in order of preference: -In no event shall me and/or other peopole that holds the rights and/or are implied in the creation and distribution of the above mentioned things be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising form, out of or in connection with the above mentioned things or the use or other dealings in it. +- Telegram : https://telegram.me/qub1750ul +- Twitter : https://twitter.com/qub1750ul +- Facebook page : https://facebook.com/dev.giuseppemasino/ -The above copyright notice and this permission notice shall accompany and/or be included ( depending on the type of work ) in all the derived works from mine, as addendum to compliance with the provisions above. - -If you need permissions that are beyond the scope of this license, you can ask to me through this facebook page https://www.facebook.com/dev.giuseppemasino/ - -The text of this license can also be found in the LICENSE.md file +The license text can be found in the LICENSE.md file From 4849c3a17d729f7182b563f572261ed42a324e82 Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Thu, 6 Sep 2018 23:34:33 +0200 Subject: [PATCH 6/8] Enabled keyword highlighting for Arduino IDE --- keywords.txt | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 keywords.txt diff --git a/keywords.txt b/keywords.txt new file mode 100644 index 0000000..fe7e8e2 --- /dev/null +++ b/keywords.txt @@ -0,0 +1,6 @@ +http::Server KEYWORD1 DATATYPE +http::RemoteClient KEYWORD1 DATATYPE + +replyTo KEYWORD2 + +IMPLEMENT_HTTP_REQUEST_HANDLER KEYWORD3 PREPROCESSOR From 728cbb5675a3a4ad97d7b9e99ac26b2fe57baf73 Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Thu, 6 Sep 2018 23:35:34 +0200 Subject: [PATCH 7/8] Updated CHANGELOG --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e4f5b47..dfbb680 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,11 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/). [![Keep a Changelog specification badge](https://img.shields.io/badge/Keep%20a%20Changelog%20Specification-1.0.0-orange.svg)](http://keepachangelog.com) [![Semantic Versioning specification badge](https://img.shields.io/badge/Semantic%20Versioning%20Specification-2.0.0-orange.svg)](http://semver.org) -## [Unreleased] ## +## [v1.1.0] - 2018-09-06 ## ### Added ### - This Changelog - Event log functionality +- The keywords.txt file for keyword highlighting in the Arduino IDE +- The LICENSE.md file ### Fixed ### From 02a4e8ed37f9c7552b7428de52203e82d5a9cfb4 Mon Sep 17 00:00:00 2001 From: Giuseppe Masino Date: Wed, 30 Jan 2019 21:27:52 +0100 Subject: [PATCH 8/8] Updated README Added a notice on how to find documentation Changed badge style --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3914c51..c207f42 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# HTTP/1.1 for Arduino # +

HTTP/1.1 for Arduino

-![Project status badge](https://img.shields.io/badge/Project%20status-ACTIVE-brightgreen.svg) -[![License badge](https://img.shields.io/badge/license-custom%20CC%20BY--SA%204.0-brightgreen.svg)](https://github.com/qub1750ul/Arduino_HTTP/blob/master/LICENSE.md) -[![Arduino Library specification badge](https://img.shields.io/badge/Arduino%20Library%20Specification%20-rev.%202.1-blue.svg)](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification) -[![Arduino IDE compatibility badge](https://img.shields.io/badge/Arduino%20IDE%20compatibility-1.6.10+-blue.svg)](https://www.arduino.cc/en/Main/Software) -[![Keep a Changelog specification badge](https://img.shields.io/badge/Keep%20a%20Changelog%20Specification-1.0.0-orange.svg)](http://keepachangelog.com) -[![Semantic Versioning specification badge](https://img.shields.io/badge/Semantic%20Versioning%20Specification-2.0.0-orange.svg)](http://semver.org) +[![License badge](https://img.shields.io/badge/license-custom%20CC%20BY--SA%204.0-brightgreen.svg?style=for-the-badge)](https://github.com/qub1750ul/Arduino_HTTP/blob/master/LICENSE.md) + +[![Arduino Library specification badge](https://img.shields.io/badge/Arduino%20Library%20Specification%20-rev%202.1-00878F.svg?style=for-the-badge)](https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification) +[![Arduino IDE compatibility badge](https://img.shields.io/badge/Arduino%20IDE%20compatibility-1.6.10+-00878F.svg?style=for-the-badge)](https://www.arduino.cc/en/Main/Software) + +[![Keep a Changelog badge](https://img.shields.io/badge/Keep%20a%20Changelog-1.0.0-orange.svg?style=for-the-badge)](http://keepachangelog.com) +[![Semantic Versioning badge](https://img.shields.io/badge/Semantic%20Versioning-2.0.0-orange.svg?style=for-the-badge)](http://semver.org) +[![Git Flow badge](https://img.shields.io/badge/Git%20Flow--transparent.svg?style=for-the-badge&logo=git)](https://nvie.com/posts/a-successful-git-branching-model/) ## Description ## @@ -24,6 +26,17 @@ Powerful and easy to use. [Checkout the wiki for more information](https://github.com/qub1750ul/Arduino_HTTP/wiki/) +**DEVELOPER NOTICE :** + +1. Currently this is a functional implementation of HTTP. + It's my intention to complete it as stated above, but when this will happen + is undefined. + +2. Currently i'm too lazy / busy to write a proper documentation page. + However the source code is very well documented in doxygen style, so if you're + searching for documentation your current options are either to directly look for comments in the source or try using doxygen. + The choice is yours. + ## About the author & license info ##