Merge branch 'release/1.0.0'

Author: diana.ionita

.circleci/config.yml

@@ -0,0 +1,67 @@
+version: 2
+
+references:
+  container_config: &container_config
+    docker:
+      - image: circleci/node:8.10
+    environment:
+      MOCHA_FILE: ./test-results/unit/test-results.xml
+
+  poke_npmrc: &poke_npmrc
+    run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+
+  restore_npm_cache: &restore_npm_cache
+    restore_cache:
+      keys:
+      - v1-dependencies-{{ checksum "package.json" }}
+      - v1-dependencies-
+
+  save_npm_cache: &save_npm_cache
+    save_cache:
+      paths:
+        - node_modules
+      key: v1-dependencies-{{ checksum "package.json" }}
+
+  create_test_results_dir: &create_test_results_dir
+    run: 
+      command: |
+        mkdir ./test-results
+        mkdir ./test-results/unit
+        
+  store_test_results: &store_test_results
+    store_test_results:
+      path: ./test-results
+
+jobs:
+  dev:
+    <<: *container_config
+    steps:
+      - *poke_npmrc
+      - checkout
+      - *restore_npm_cache
+      - run: npm install
+      - *save_npm_cache
+      - run: npm run test -- --reporter mocha-junit-reporter
+      - *store_test_results
+  
+  live:
+    <<: *container_config
+    steps:
+      - *poke_npmrc
+      - checkout
+      - *restore_npm_cache
+      - run: npm install
+      - *save_npm_cache
+      - run: npm publish
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - dev
+      - live:
+          requires:
+            - dev
+          filters:
+            branches:
+              only: master

.gitignore

@@ -0,0 +1,5 @@
+# package directories
+node_modules
+
+# Serverless directories
+.serverless

.npmignore

@@ -0,0 +1,5 @@
+# package directories
+node_modules
+
+test
+.gitignore

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Tests",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+      "args": [
+        "test/**/*.js",
+        "-t",
+        "10000",
+        "--color"
+      ]
+    },
+  ]
+}

README.md

@@ -1,2 +1,58 @@
 # serverless-api-gateway-caching
-In progress.
+
+[![CircleCI](https://circleci.com/gh/DianaIonita/serverless-api-gateway-caching.svg?style=svg)](https://circleci.com/gh/DianaIonita/serverless-api-gateway-caching)
+
+## Intro
+A plugin for the serverless framework which helps with configuring caching for API Gateway endpoints.
+
+## Good to know
+If you enable caching globally, it does NOT automatically enable caching for your endpoints - you have to be explicit about which endpoints should have caching enabled.
+However, disabling caching globally disables it across endpoints.
+
+## Example
+
+```yml
+plugins:
+  - serverless-api-gateway-caching
+
+custom:
+  # Enable or disable caching globally
+  apiGatewayCaching:
+    enabled: true
+    clusterSize: '0.5' # defaults to '0.5'
+    ttlInSeconds: 300 # defaults to the maximum allowed: 3600
+
+functions:
+  # Responses are not cached
+  list-all-cats:
+    handler: rest_api/cats/get/handler.handle
+    role: listCatsRole
+    events:
+      - http:
+          path: /cats
+          method: get
+          caching:
+            enabled: false # default is false
+
+  # Responses are cached based on the 'pawId' path parameter and the 'Accept-Language' header
+  get-cat-by-paw-id:
+    handler: rest_api/cat/get/handler.handle
+    events:
+      - http:
+          path: /cats/{pawId}
+          method: get
+          caching:
+            enabled: true
+            ttlInSeconds: 3600
+            cacheKeyParameters:
+              - name: request.path.pawId
+                required: true
+              - name: request.header.Accept-Language
+                required: false
+```
+
+## Limitations
+* For HTTP method `ANY`, caching will be enabled only for the `GET` method and disabled for the other methods.
+
+## Currently not supported:
+* lambda functions with many http events