MVP

Author: Andrea-Scuderi

.gitignore

@@ -1,3 +1,4 @@
 build
 swift-shared-libs
-.serverless
+.serverless
+.build

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing Guidelines
+
+Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 
+documentation, we greatly value feedback and contributions from our community.
+
+Please read through this document before submitting any issues or pull requests to ensure we have all the necessary 
+information to effectively respond to your bug report or contribution.
+
+
+## Reporting Bugs/Feature Requests
+
+We welcome you to use the GitHub issue tracker to report bugs or suggest features.
+
+When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already 
+reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
+
+* A reproducible test case or series of steps
+* The version of our code being used
+* Any modifications you've made relevant to the bug
+* Anything unusual about your environment or deployment
+
+
+## Contributing via Pull Requests
+Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
+
+1. You are working against the latest source on the *master* branch.
+2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
+3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
+
+To send us a pull request, please:
+
+1. Fork the repository.
+2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
+3. Ensure local tests pass.
+4. Commit to your fork using clear commit messages.
+5. Send us a pull request, answering any default questions in the pull request interface.
+6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+
+GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 
+[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
+
+
+## Finding contributions to work on
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted') issues is a great place to start. 
+
+
+## Code of Conduct
+This project has adopted the [contributor-covenant.org](https://www.contributor-covenant.org) code of conduct.
+
+
+## Security issue notifications
+If you discover a potential security issue in this projectplease do **not** create a public github issue.
+If the security issue is relared to the library send a private email.
+If the security issue is related to AWS notify [AWS/Amazon Security](http://aws.amazon.com/security/vulnerability-reporting/).
+If the security issue is related to Swift notify [Apple Security](https://support.apple.com/en-ie/HT201220).
+
+
+## Licensing
+
+See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+
+We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

Makefile

@@ -14,14 +14,20 @@
 
 # Use this tag to build a customized local image
 
-SWIFT_VERSION?=5.2.3
-LAYER_VERSION?=5-2.3
+SWIFT_VERSION?=nightly-amazonlinux2
+LAYER_VERSION?=nightly-amazonlinux2
+DOCKER_OS?=amazonlinux2
+
+# SWIFT_VERSION?=5.2.3-bionic
+# LAYER_VERSION?=5-2-3-bionic
+# DOCKER_OS=bionic
 
 DOCKER_TAG=nio-swift:$(SWIFT_VERSION)
 SWIFT_DOCKER_IMAGE=$(DOCKER_TAG)
 SWIFT_LAMBDA_LIBRARY=nio-swift-lambda-runtime-$(LAYER_VERSION)
 SWIFT_CONFIGURATION=release
 
+BUILD_PATH=.build
 SERVERLESS_BUILD=build
 SERVERLESS_LAYER=swift-lambda-runtime
 
@@ -44,6 +50,15 @@ LAMBDA_BUILD_PATH=$(ROOT_BUILD_PATH)
 # use this for local development
 MOUNT_ROOT=$(shell pwd)
 DOCKER_PROJECT_PATH=$(SWIFT_PROJECT_PATH)
+ROOT_BUILD_PATH=./.build
+LAYER_BUILD_PATH=$(ROOT_BUILD_PATH)/layer
+LAMBDA_BUILD_PATH=$(ROOT_BUILD_PATH)/lambda
+LOCAL_LAMBDA_PATH=$(ROOT_BUILD_PATH)/local
+LOCALSTACK_TMP=$(ROOT_BUILD_PATH)/.tmp
+TMP_BUILD_PATH=$(ROOT_BUILD_PATH)/tmp
+DATETIME=$(shell date +'%y%m%d-%H%M%S')
+DOCKER_FOLDER=docker
+BOOTSTRAP=$(DOCKER_FOLDER)/$(SWIFT_VERSION)/bootstrap
 
 docker_build:
 	docker build --tag $(DOCKER_TAG) docker/$(SWIFT_VERSION)/.
@@ -56,41 +71,42 @@ build_lambda:
 			$(SWIFT_DOCKER_IMAGE) \
 			/bin/bash -c "swift build --configuration $(SWIFT_CONFIGURATION)"
 
-cp_to_serverless_build: create_build_directory
+cp_lambda_to_sls_build_local: create_build_directory
 	docker run \
 			--rm \
 			--volume "$(MOUNT_ROOT)/:/src" \
 			--workdir "/src/$(DOCKER_PROJECT_PATH)" \
 			$(SWIFT_DOCKER_IMAGE) \
-			/bin/bash -c "swift build -c $(SWIFT_CONFIGURATION) --show-bin-path | tr '\n' '/' > .build/path.txt; echo '$(SWIFT_EXECUTABLE)' >> .build/path.txt |  cat .build/path.txt | xargs cp -t ../$(SERVERLESS_BUILD); rm .build/path.txt"
+			/bin/bash -c "swift build -c $(SWIFT_CONFIGURATION) --show-bin-path | tr '\n' '/' > $(BUILD_PATH)/path.txt; echo '$(SWIFT_EXECUTABLE)' >> $(BUILD_PATH)/path.txt |  cat $(BUILD_PATH)/path.txt | xargs cp -t ../$(SERVERLESS_BUILD); rm $(BUILD_PATH)/path.txt"
 
 create_build_directory:
 	if [ ! -d "$(LAMBDA_BUILD_PATH)" ]; then mkdir -p $(LAMBDA_BUILD_PATH); fi
 	if [ ! -d "$(LAYER_BUILD_PATH)" ]; then mkdir -p $(LAYER_BUILD_PATH); fi
 	if [ ! -d "$(SERVERLESS_BUILD)" ]; then mkdir -p $(SERVERLESS_BUILD); fi
 
 package_lambda: create_build_directory build_lambda
-	zip -r -j $(LAMBDA_BUILD_PATH)/$(LAMBDA_ZIP) $(SWIFT_PROJECT_PATH)/.build/$(SWIFT_CONFIGURATION)/$(SWIFT_EXECUTABLE)
+	zip -r -j $(LAMBDA_BUILD_PATH)/$(LAMBDA_ZIP) $(SWIFT_PROJECT_PATH)/$(BUILD_PATH)/$(SWIFT_CONFIGURATION)/$(SWIFT_EXECUTABLE)
 
 package_layer: create_build_directory
 	$(eval SHARED_LIBRARIES := $(shell cat docker/$(SWIFT_VERSION)/swift-shared-libraries.txt | tr '\n' ' '))
 	mkdir -p $(SHARED_LIBS_FOLDER)/lib
+ifeq '$(DOCKER_OS)' 'xenial'
 	docker run \
 			--rm \
 			--volume "$(shell pwd)/:/src" \
 			--workdir "/src" \
 			$(SWIFT_DOCKER_IMAGE) \
 			cp /lib64/ld-linux-x86-64.so.2 $(SHARED_LIBS_FOLDER)
+endif
 	docker run \
 			--rm \
 			--volume "$(shell pwd)/:/src" \
 			--workdir "/src" \
 			$(SWIFT_DOCKER_IMAGE) \
 			cp -t $(SHARED_LIBS_FOLDER)/lib $(SHARED_LIBRARIES)
-	zip -r $(LAYER_BUILD_PATH)/$(LAYER_ZIP) bootstrap $(SHARED_LIBS_FOLDER)
+	cp $(BOOTSTRAP) $(SHARED_LIBS_FOLDER)
+	cd $(SHARED_LIBS_FOLDER); pwd; zip -r ../$(LAYER_BUILD_PATH)/$(LAYER_ZIP) bootstrap lib
 
-unzip_package_to_build: create_build_directory
+cp_layer_to_sls_build_local: create_build_directory
 	if [ ! -d "./$(SERVERLESS_BUILD)/$(SERVERLESS_LAYER)" ]; then mkdir -p ./$(SERVERLESS_BUILD)/$(SERVERLESS_LAYER); fi
-	cp $(LAYER_BUILD_PATH)/$(LAYER_ZIP) ./$(SERVERLESS_BUILD)/$(SERVERLESS_LAYER)/$(LAYER_ZIP)
-	unzip ./$(SERVERLESS_BUILD)/$(SERVERLESS_LAYER)/$(LAYER_ZIP) -d ./$(SERVERLESS_BUILD)/$(SERVERLESS_LAYER)
-	rm ./$(SERVERLESS_BUILD)/$(SERVERLESS_LAYER)/$(LAYER_ZIP)
+	cp -R ./$(SHARED_LIBS_FOLDER)/. ./$(SERVERLESS_BUILD)/$(SERVERLESS_LAYER)

Products/Package.resolved

@@ -7,6 +7,7 @@ let package = Package(
     name: "swift-rest-api",
     products: [
         // Products define the executables and libraries produced by a package, and make them visible to other packages.
+        .executable(name: "Products", targets: ["Products"]),
         .library(
             name: "ProductService",
             targets: ["ProductService"]

Products/Package.swift

@@ -1,22 +1,119 @@
-#Serverless Swift REST API
+# AWS Serverless Swift-Sprinter API Template
 
+[![Swift 5.2.3](https://img.shields.io/badge/Swift-5.2.3-blue.svg)](https://swift.org/download/) [![docker amazonlinux2](https://img.shields.io/badge/docker-amazonlinux2-orange.svg)](https://swift.org/download/)
 
-Install Serverless Framework
+This package demostrates how to write a Scalable REST API with the Serverless stack by using only Swift as development language.
+
+## Swift-Sprinter Product API Example
+
+The example shows how to build a Rest API based on a `Product` swift class.
+
+```swift
+public struct Product: Codable {
+    public let sku: String
+    public let name: String
+    public let description: String
+    public var createdAt: String?
+    public var updatedAt: String?
+}
 ```
-curl -o- -L https://slss.io/install | bash
+
+## API Definition
+
+```
+- /Product
+    -> GET
+    -> POST
+    -> PUT 
+- /Product/{sku}
+    -> DELETE
+    -> GET
 ```
 
-Export the binary PATH
+JSON body for PUT and POST
+```JSON
+{
+	"sku": "3",
+    "name": "Book",
+    "description": "Book 3"
+}
 ```
-export PATH="$HOME/.serverless/bin:$PATH"
+
+## Serverless architecture
+
+The architecture is based on the classical AWS Serverless stack: APIGateway, Lambda and DynamoDB.
+- `APIGateway`: acts as a `proxy` for the `Lambda` and exposing it to the internet.
+- `Lambda`: is the computational layer.
+- `DynamoDB`: is the AWS `NoSQL` database
+
+Advantages:
+- Pay per use
+- No fixed costs
+- Auto-Scaling
+- DevOps
+
+## Application
+
+The application uses [Swift-Sprinter](https://github.com/swift-sprinter/aws-lambda-swift-sprinter) as AWS Custom Lambda Runtime and acts as a presentation layer of the DynamoDB content via Web.
+
+The following frameworks are used:
+- [aws-lambda-swift-sprinter-nio-plugin](https://github.com/swift-sprinter/aws-lambda-swift-sprinter-nio-plugin): Implements the AWS Custom Runtime usin Swift NIO.
+- [aws-sdk-swift](https://github.com/swift-aws/aws-sdk-swift): Interacts with DynamoDB
+
+## Requirements
+
+- Install [Docker](https://docs.docker.com/install/)
+- Install [Serverless Framework](https://www.serverless.com/framework/docs/getting-started/)
+- Ensure your AWS Account has the right [credentials](https://www.serverless.com/framework/docs/providers/aws/guide/credentials/) to deploy a Serverless stack.
+- Clone this repository. From the command line type:
+
+```console
+git clone https://github.com/swift-sprinter/aws-serverless-swift-sprinter-web-template
+cd aws-serverless-swift-sprinter-web-template
 ```
+- Ensure you can run `make`:
 
-Build Swift
+```console
+make --version
 ```
-build.sh
+
+the `Makefile` was developed with this version:
 ```
+GNU Make 3.81
+Copyright (C) 2006  Free Software Foundation, Inc.
+This is free software; see the source for copying conditions.
+There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
+PARTICULAR PURPOSE.
 
-Deploy Swift
+This program built for i386-apple-darwin11.3.0
+```
+
+## Build
+
+Use the following command to build the code before using the serverless commands:
+```
+./build.sh
+```
+
+## Deploy
+
+Deploy the full solution to your AWS using Serverless:
+```
+./deploy.sh
+```
+
+After the deployment is completed, the URL of the website is provided by the Serverless framework.
+
+## Update
+
+Rebuild the code and update the Lambda to your AWS using Serverless:
+```
+./update.sh
+```
+
+## Remove
+
+To remove the deployment use:
+```
+serverless remove
 ```
-deploy.sh
-```