merge master

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+## Description
+
+
+## GitHub Issues
+<!-- Proposed changes should be discussed in an issue before submitting a PR. -->
+<!-- Link to relevant tickets here. -->
+

.gitignore

@@ -73,3 +73,4 @@ target/
 *.swo
 *~
 tests/zappa_settings.json
+tests/example_template_outputs

CHANGELOG.md

@@ -1,5 +1,60 @@
 # Zappa Changelog
 
+## 0.28.0
+* `--json` for machine readable status output
+* `--all` for global deployment prep
+* Better exit code handling
+* Get AWS region from profile if not set in zappa_settings.json
+* Fix broken Django management command invocation
+* Add Kinesis permission
+* Add capability to specify authoriser arn
+* Various refactors and small fixes
+
+## 0.27.1
+
+* Bump lambda-packages
+* Fix new Django unicode problems (#397)
+* Ensure env vars are strings via @scoates
+* Fix #382
+
+## 0.27.0
+
+* Remove many hacks using new API Gateway features.
+    * Closes #303, #363, #361
+    * See the [blog post](https://blog.zappa.io/posts/unhacking-zappa-with-new-apigateway-features) for more details!
+* Bump dependancies - make sure you reinstall your requirements!
+* Improved stack update handling.
+
+### 0.26.1 (Never Published)
+
+* Warn on namespace collisions.
+* Bump lambda-packages version.
+
+## 0.26.0
+
+* Use simplified API Gateway configuration, via @koriaf.
+* Add better support for `use_apigateway` without any supplied app function. Reported by @mguidone.
+* Truncate illegally long event functions names. Reported by @mguidone.
+
+## 0.25.1
+
+* Remove 'boto' from default excludes. #333, thanks Claude!
+* Don't allow invalid API Gateway characters in the config. Thanks @scoates!
+* Better respect for `use_apigateway` in `update` command.
+* Avoids hang with API Gateway limit reached.
+* Fix DynamoDB/Kinesis event sources, add docs. Big thanks Claude!
+
+## 0.25.0
+
+* Add ability to invoke raw python strings, like so:
+
+    `zappa invoke dev "print 1+2+3" --raw`
+
+* Fixes multi-argument `manage` commands.
+* Updated related documentation.
+* Fixes places where program was exiting with status 0 instead of -1. Thanks @mattc!
+* Adds old-to-new-style check on delete, thanks @mathom.
+
 ## 0.24.2
 
 * Fix a problem from trying to `update` old-style API routes using new Tropo code. Ensures `touch` works as intended again. Fix by @mathom.

example/authmodule.py

@@ -0,0 +1,218 @@
+"""
+Copyright 2015-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at
+     http://aws.amazon.com/apache2.0/
+or in the "license" file accompanying this file. This file 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.
+"""
+from __future__ import print_function
+
+import re
+import time
+import pprint
+import json
+
+
+def lambda_handler(event, context):
+    print("Client token: " + event['authorizationToken'])
+    print("Method ARN: " + event['methodArn'])
+    """validate the incoming token"""
+    """and produce the principal user identifier associated with the token"""
+
+    """this could be accomplished in a number of ways:"""
+    """1. Call out to OAuth provider"""
+    """2. Decode a JWT token inline"""
+    """3. Lookup in a self-managed DB"""
+    principalId = "user|a1b2c3d4"
+
+    """you can send a 401 Unauthorized response to the client by failing like so:"""
+    """raise Exception('Unauthorized')"""
+
+    """if the token is valid, a policy must be generated which will allow or deny access to the client"""
+
+    """if access is denied, the client will recieve a 403 Access Denied response"""
+    """if access is allowed, API Gateway will proceed with the backend integration configured on the method that was called"""
+
+    """this function must generate a policy that is associated with the recognized principal user identifier."""
+    """depending on your use case, you might store policies in a DB, or generate them on the fly"""
+
+    """keep in mind, the policy is cached for 5 minutes by default (TTL is configurable in the authorizer)"""
+    """and will apply to subsequent calls to any method/resource in the RestApi"""
+    """made with the same token"""
+
+    """the example policy below denies access to all resources in the RestApi"""
+    tmp = event['methodArn'].split(':')
+    apiGatewayArnTmp = tmp[5].split('/')
+    awsAccountId = tmp[4]
+
+    policy = AuthPolicy(principalId, awsAccountId)
+    policy.restApiId = apiGatewayArnTmp[0]
+    policy.region = tmp[3]
+    policy.stage = apiGatewayArnTmp[1]
+
+    # Blueprint denies all methods by default
+    # policy.denyAllMethods()
+
+    # Example allows all methods
+    policy.allowAllMethods()
+
+    """policy.allowMethod(HttpVerb.GET, "/pets/*")"""
+
+    """finally, build the policy and exit the function using return"""
+    return policy.build()
+
+class HttpVerb:
+    GET     = "GET"
+    POST    = "POST"
+    PUT     = "PUT"
+    PATCH   = "PATCH"
+    HEAD    = "HEAD"
+    DELETE  = "DELETE"
+    OPTIONS = "OPTIONS"
+    ALL     = "*"
+
+class AuthPolicy(object):
+    awsAccountId = ""
+    """The AWS account id the policy will be generated for. This is used to create the method ARNs."""
+    principalId = ""
+    """The principal used for the policy, this should be a unique identifier for the end user."""
+    version = "2012-10-17"
+    """The policy version used for the evaluation. This should always be '2012-10-17'"""
+    pathRegex = "^[/.a-zA-Z0-9-\*]+$"
+    """The regular expression used to validate resource paths for the policy"""
+
+    """these are the internal lists of allowed and denied methods. These are lists
+    of objects and each object has 2 properties: A resource ARN and a nullable
+    conditions statement.
+    the build method processes these lists and generates the approriate
+    statements for the final policy"""
+    allowMethods = []
+    denyMethods = []
+
+    restApiId = "*"
+    """The API Gateway API id. By default this is set to '*'"""
+    region = "*"
+    """The region where the API is deployed. By default this is set to '*'"""
+    stage = "*"
+    """The name of the stage used in the policy. By default this is set to '*'"""
+
+    def __init__(self, principal, awsAccountId):
+        self.awsAccountId = awsAccountId
+        self.principalId = principal
+        self.allowMethods = []
+        self.denyMethods = []
+
+    def _addMethod(self, effect, verb, resource, conditions):
+        """Adds a method to the internal lists of allowed or denied methods. Each object in
+        the internal list contains a resource ARN and a condition statement. The condition
+        statement can be null."""
+        if verb != "*" and not hasattr(HttpVerb, verb):
+            raise NameError("Invalid HTTP verb " + verb + ". Allowed verbs in HttpVerb class")
+        resourcePattern = re.compile(self.pathRegex)
+        if not resourcePattern.match(resource):
+            raise NameError("Invalid resource path: " + resource + ". Path should match " + self.pathRegex)
+
+        if resource[:1] == "/":
+            resource = resource[1:]
+
+        resourceArn = ("arn:aws:execute-api:" +
+            self.region + ":" +
+            self.awsAccountId + ":" +
+            self.restApiId + "/" +
+            self.stage + "/" +
+            verb + "/" +
+            resource)
+
+        if effect.lower() == "allow":
+            self.allowMethods.append({
+                'resourceArn' : resourceArn,
+                'conditions' : conditions
+            })
+        elif effect.lower() == "deny":
+            self.denyMethods.append({
+                'resourceArn' : resourceArn,
+                'conditions' : conditions
+            })
+
+    def _getEmptyStatement(self, effect):
+        """Returns an empty statement object prepopulated with the correct action and the
+        desired effect."""
+        statement = {
+            'Action': 'execute-api:Invoke',
+            'Effect': effect[:1].upper() + effect[1:].lower(),
+            'Resource': []
+        }
+
+        return statement
+
+    def _getStatementForEffect(self, effect, methods):
+        """This function loops over an array of objects containing a resourceArn and
+        conditions statement and generates the array of statements for the policy."""
+        statements = []
+
+        if len(methods) > 0:
+            statement = self._getEmptyStatement(effect)
+
+            for curMethod in methods:
+                if curMethod['conditions'] is None or len(curMethod['conditions']) == 0:
+                    statement['Resource'].append(curMethod['resourceArn'])
+                else:
+                    conditionalStatement = self._getEmptyStatement(effect)
+                    conditionalStatement['Resource'].append(curMethod['resourceArn'])
+                    conditionalStatement['Condition'] = curMethod['conditions']
+                    statements.append(conditionalStatement)
+
+            statements.append(statement)
+
+        return statements
+
+    def allowAllMethods(self):
+        """Adds a '*' allow to the policy to authorize access to all methods of an API"""
+        self._addMethod("Allow", HttpVerb.ALL, "*", [])
+
+    def denyAllMethods(self):
+        """Adds a '*' allow to the policy to deny access to all methods of an API"""
+        self._addMethod("Deny", HttpVerb.ALL, "*", [])
+
+    def allowMethod(self, verb, resource):
+        """Adds an API Gateway method (Http verb + Resource path) to the list of allowed
+        methods for the policy"""
+        self._addMethod("Allow", verb, resource, [])
+
+    def denyMethod(self, verb, resource):
+        """Adds an API Gateway method (Http verb + Resource path) to the list of denied
+        methods for the policy"""
+        self._addMethod("Deny", verb, resource, [])
+
+    def allowMethodWithConditions(self, verb, resource, conditions):
+        """Adds an API Gateway method (Http verb + Resource path) to the list of allowed
+        methods and includes a condition for the policy statement. More on AWS policy
+        conditions here: http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#Condition"""
+        self._addMethod("Allow", verb, resource, conditions)
+
+    def denyMethodWithConditions(self, verb, resource, conditions):
+        """Adds an API Gateway method (Http verb + Resource path) to the list of denied
+        methods and includes a condition for the policy statement. More on AWS policy
+        conditions here: http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html#Condition"""
+        self._addMethod("Deny", verb, resource, conditions)
+
+    def build(self):
+        """Generates the policy document based on the internal lists of allowed and denied
+        conditions. This will generate a policy with two main statements for the effect:
+        one statement for Allow and one statement for Deny.
+        Methods that includes conditions will have their own statement in the policy."""
+        if ((self.allowMethods is None or len(self.allowMethods) == 0) and
+            (self.denyMethods is None or len(self.denyMethods) == 0)):
+            raise NameError("No statements defined for the policy")
+
+        policy = {
+            'principalId' : self.principalId,
+            'policyDocument' : {
+                'Version' : self.version,
+                'Statement' : []
+            }
+        }
+
+        policy['policyDocument']['Statement'].extend(self._getStatementForEffect("Allow", self.allowMethods))
+        policy['policyDocument']['Statement'].extend(self._getStatementForEffect("Deny", self.denyMethods))
+
+        return policy

example/zappa_settings.json

@@ -38,6 +38,9 @@
         "function": "mymodule.myfunc",
         "expression": "rate(5 minutes)"
         }],
+      "authorizer": {
+        "function": "authmodule.lambda_handler"
+      },
       "aws_region": "us-west-2",
       "s3_bucket": "zappa-test-bucket",
       "app_function": "app.app",

requirements.txt

@@ -1,18 +1,18 @@
 base58==0.2.3
-boto3==1.4.0
-botocore==1.4.56
+botocore==1.4.67
+boto3==1.4.1
 docutils==0.12
 futures==3.0.5
 hjson==2.0.2
 jmespath==0.9.0
 kappa==0.6.0
-lambda-packages==0.8.0
+lambda-packages==0.10.0
 python-dateutil==2.5.3
 python-slugify==1.2.1
 requests>=2.10.0
 six==1.10.0
 tqdm==4.8.4
-troposphere==1.8.1
+troposphere==1.8.2
 Werkzeug==0.11.11
 wheel==0.29.0
-wsgi-request-logger==0.4.5
+wsgi-request-logger==0.4.6

setup.py

@@ -5,7 +5,7 @@
 # Set external files
 try:
     from pypandoc import convert
-    README = convert('README.md', 'rst')     
+    README = convert('README.md', 'rst')
 except ImportError:
     README = open(os.path.join(os.path.dirname(__file__), 'README.md')).read()
 
@@ -17,14 +17,14 @@
 
 setup(
     name='zappa',
-    version='0.24.2',
+    version='0.28.0',
     packages=['zappa'],
     install_requires=required,
     tests_require=test_required,
     test_suite='nose.collector',
     include_package_data=True,
     license='MIT License',
-    description='Serverless WSGI With AWS Lambda + API Gateway',
+    description='Server-less Python Web Services for AWS Lambda and API Gateway',
     long_description=README,
     url='https://github.com/Miserlou/Zappa',
     author='Rich Jones',

test_requirements.txt

@@ -1,5 +1,5 @@
 coveralls==1.1
-Django==1.10.1
+Django==1.10.2
 mock==2.0.0
 nose==1.3.7
 placebo==0.8.1

test_settings.py

@@ -25,6 +25,8 @@
 
 ENVIRONMENT_VARIABLES={'testenv': 'envtest'}
 
+AUTHORIZER_FUNCTION='test_settings.authorizer_event'
+
 
 def prebuild_me():
     print("This is a prebuild script!")
@@ -49,6 +51,8 @@ def aws_dynamodb_event(event, content):
 def aws_kinesis_event(event, content):
     return "AWS KINESIS EVENT"
 
+def authorizer_event(event, content):
+    return "AUTHORIZER_EVENT"
 
 def command():
     print("command")