From 937f2e96ec7f81cf61294fb1ce1af5ef32245cb6 Mon Sep 17 00:00:00 2001 From: Jan Romann Date: Wed, 17 Nov 2021 00:38:21 +0100 Subject: [PATCH] meta: initial commit --- .gitignore | 10 ++ .gitlab/issue_templates/Bug Report.md | 30 ++++ .gitlab/issue_templates/Discussion.md | 13 ++ .gitlab/issue_templates/Documentation.md | 13 ++ .gitlab/issue_templates/Misc.md | 11 ++ .gitlab/issue_templates/New Feature.md | 17 ++ .gitlab/issue_templates/Test.md | 13 ++ CHANGELOG.md | 3 + CODEOWNERS | 6 + LICENSE-APACHE | 202 +++++++++++++++++++++++ LICENSE-MIT | 21 +++ README.md | 58 +++++++ analysis_options.yaml | 30 ++++ example/dart_wot_example.dart | 6 + lib/dart_wot.dart | 8 + lib/src/dart_wot_base.dart | 6 + pubspec.yaml | 15 ++ test/dart_wot_test.dart | 16 ++ 18 files changed, 478 insertions(+) create mode 100644 .gitignore create mode 100644 .gitlab/issue_templates/Bug Report.md create mode 100644 .gitlab/issue_templates/Discussion.md create mode 100644 .gitlab/issue_templates/Documentation.md create mode 100644 .gitlab/issue_templates/Misc.md create mode 100644 .gitlab/issue_templates/New Feature.md create mode 100644 .gitlab/issue_templates/Test.md create mode 100644 CHANGELOG.md create mode 100644 CODEOWNERS create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md create mode 100644 analysis_options.yaml create mode 100644 example/dart_wot_example.dart create mode 100644 lib/dart_wot.dart create mode 100644 lib/src/dart_wot_base.dart create mode 100644 pubspec.yaml create mode 100644 test/dart_wot_test.dart diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..65c34dc8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +# Files and directories created by pub. +.dart_tool/ +.packages + +# Conventional directory for build outputs. +build/ + +# Omit committing pubspec.lock for library packages; see +# https://dart.dev/guides/libraries/private-files#pubspeclock. +pubspec.lock diff --git a/.gitlab/issue_templates/Bug Report.md b/.gitlab/issue_templates/Bug Report.md new file mode 100644 index 00000000..941a44a7 --- /dev/null +++ b/.gitlab/issue_templates/Bug Report.md @@ -0,0 +1,30 @@ +## Summary + + + +## Steps to reproduce + + + +## What is the current bug behavior? + + + +## What is the expected correct behavior? + + + +## Relevant logs and/or screenshots + + + +## Possible fixes + + + +## Related Issues/MRs + + + +/label ~"type::bug" diff --git a/.gitlab/issue_templates/Discussion.md b/.gitlab/issue_templates/Discussion.md new file mode 100644 index 00000000..7ce68628 --- /dev/null +++ b/.gitlab/issue_templates/Discussion.md @@ -0,0 +1,13 @@ +## Summary + + + +## Discussion Points + + + +## Related Issues/MRs + + + +/label ~"type::discussion" diff --git a/.gitlab/issue_templates/Documentation.md b/.gitlab/issue_templates/Documentation.md new file mode 100644 index 00000000..b73a751d --- /dev/null +++ b/.gitlab/issue_templates/Documentation.md @@ -0,0 +1,13 @@ +## Summary + + + +## Description + + + +## Related Issues/MRs + + + +/label ~"type::documentation" diff --git a/.gitlab/issue_templates/Misc.md b/.gitlab/issue_templates/Misc.md new file mode 100644 index 00000000..4eb8c405 --- /dev/null +++ b/.gitlab/issue_templates/Misc.md @@ -0,0 +1,11 @@ +## Summary + + + +## Description + + + +/label ~"type::misc" + + diff --git a/.gitlab/issue_templates/New Feature.md b/.gitlab/issue_templates/New Feature.md new file mode 100644 index 00000000..a991fd2b --- /dev/null +++ b/.gitlab/issue_templates/New Feature.md @@ -0,0 +1,17 @@ +## Summary + + + +## Description + + + +## Implementation steps + + + +## Related Issues/MRs + + + +/label ~"type::feature" diff --git a/.gitlab/issue_templates/Test.md b/.gitlab/issue_templates/Test.md new file mode 100644 index 00000000..6685c524 --- /dev/null +++ b/.gitlab/issue_templates/Test.md @@ -0,0 +1,13 @@ +## Summary + + + +## Description + + + +## Related Issues/MRs + + + +/label ~"type::test" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..effe43c8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +## 1.0.0 + +- Initial version. diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000..31007b26 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,6 @@ +## CODEOWNERS for autoreview assigning in gitlab + +# https://docs.gitlab.com/ee/user/project/code_owners.html + +[Maintainers] +# * [ENTER USERNAME HERE AND UNCOMMENT] \ No newline at end of file diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 00000000..5caf8840 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 The NAMIB Project Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..d9f674c4 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# dart_wot: A W3C Web of Things implementation written in Dart + +dart_wot is an implementation of the +Web of Things [Scripting API](https://w3c.github.io/wot-scripting-api/) modelled +after the WoT reference implementation +[node-wot](https://github.com/eclipse/thingweb.node-wot). +It is supposed to support CoAP and HTTP as its first implementation milestones. +The API, however, should allow for a relatively easy expansion to other protocols +in the future. + +## Features + +TODO: List what your package can do. Maybe include images, gifs, or videos. + +## Getting started + +TODO: List prerequisites and provide or point to information on how to +start using the package. + +## Usage + +TODO: Include short and useful examples for package users. Add longer examples +to `/example` folder. + +```dart +const like = 'sample'; +``` + +## Additional information + +TODO: Tell users more about the package: where to find more information, how to +contribute to the package, how to file issues, what response they can expect +from the package authors, and more. + +## License + +Licensed under either of + +* Apache License, Version 2.0 + ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +* MIT license + ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +## Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +## Maintainers + +This project is currently maintained by the following developers: + +| Name | Email Address | GitHub Username | +|:----------:|:--------------------:|:--------------------------------------------:| +| Jan Romann | jan.romann@uni-bremen.de | [JKRhb](https://github.com/JKRhb) | diff --git a/analysis_options.yaml b/analysis_options.yaml new file mode 100644 index 00000000..dee8927a --- /dev/null +++ b/analysis_options.yaml @@ -0,0 +1,30 @@ +# This file configures the static analysis results for your project (errors, +# warnings, and lints). +# +# This enables the 'recommended' set of lints from `package:lints`. +# This set helps identify many issues that may lead to problems when running +# or consuming Dart code, and enforces writing Dart using a single, idiomatic +# style and format. +# +# If you want a smaller set of lints you can change this to specify +# 'package:lints/core.yaml'. These are just the most critical lints +# (the recommended set includes the core lints). +# The core lints are also what is used by pub.dev for scoring packages. + +include: package:lints/recommended.yaml + +# Uncomment the following section to specify additional rules. + +# linter: +# rules: +# - camel_case_types + +# analyzer: +# exclude: +# - path/to/excluded/files/** + +# For more information about the core and recommended set of lints, see +# https://dart.dev/go/core-lints + +# For additional information about configuring this file, see +# https://dart.dev/guides/language/analysis-options diff --git a/example/dart_wot_example.dart b/example/dart_wot_example.dart new file mode 100644 index 00000000..a3db9dfc --- /dev/null +++ b/example/dart_wot_example.dart @@ -0,0 +1,6 @@ +import 'package:dart_wot/dart_wot.dart'; + +void main() { + var awesome = Awesome(); + print('awesome: ${awesome.isAwesome}'); +} diff --git a/lib/dart_wot.dart b/lib/dart_wot.dart new file mode 100644 index 00000000..ca76fc2c --- /dev/null +++ b/lib/dart_wot.dart @@ -0,0 +1,8 @@ +/// Support for doing something awesome. +/// +/// More dartdocs go here. +library dart_wot; + +export 'src/dart_wot_base.dart'; + +// TODO: Export any libraries intended for clients of this package. diff --git a/lib/src/dart_wot_base.dart b/lib/src/dart_wot_base.dart new file mode 100644 index 00000000..e8a6f159 --- /dev/null +++ b/lib/src/dart_wot_base.dart @@ -0,0 +1,6 @@ +// TODO: Put public facing types in this file. + +/// Checks if you are awesome. Spoiler: you are. +class Awesome { + bool get isAwesome => true; +} diff --git a/pubspec.yaml b/pubspec.yaml new file mode 100644 index 00000000..9e02ece4 --- /dev/null +++ b/pubspec.yaml @@ -0,0 +1,15 @@ +name: dart_wot +description: A W3C Web of Things implementation written in Dart. +version: 1.0.0 +# homepage: https://www.example.com + +environment: + sdk: '>=2.14.4 <3.0.0' + + +# dependencies: +# path: ^1.8.0 + +dev_dependencies: + lints: ^1.0.0 + test: ^1.16.0 diff --git a/test/dart_wot_test.dart b/test/dart_wot_test.dart new file mode 100644 index 00000000..2f8d616e --- /dev/null +++ b/test/dart_wot_test.dart @@ -0,0 +1,16 @@ +import 'package:dart_wot/dart_wot.dart'; +import 'package:test/test.dart'; + +void main() { + group('A group of tests', () { + final awesome = Awesome(); + + setUp(() { + // Additional setup goes here. + }); + + test('First Test', () { + expect(awesome.isAwesome, isTrue); + }); + }); +}