chore: #49 camelCase for the functionality and adding greedy to readme

Author: Hans-Seek

README.md

@@ -214,7 +214,7 @@ custom:
         path: /s3/{folder}/{file}
         method: get
         action: GetObject
-        pathoverride: '{folder}/{file}.xml'
+        pathOverride: '{folder}/{file}.xml'
         bucket:
           Ref: S3Bucket
         cors: true
@@ -229,6 +229,30 @@ custom:
 This will result in API Gateway setting the Path Override attribute to `{bucket}/{folder}/{file}.xml`
 So for example if you navigate to the API Gatway endpoint `/language/en` it will fetch the file in S3 from `{bucket}/language/en.xml`
 
+##### Can use greedy, for deeper Folders
+The forementioned example can also be shortened by a greedy approach. Thanks to @taylorreece for mentioning this.
+
+```yaml
+custom:
+  apiGatewayServiceProxies:
+    - s3:
+        path: /s3/{myPath+}
+        method: get
+        action: GetObject
+        pathOverride: '{myPath}.xml'
+        bucket:
+          Ref: S3Bucket
+        cors: true
+
+        requestParameters:
+          # if requestParameters has a 'integration.request.path.object' property you should remove the key setting
+          'integration.request.path.myPath': 'method.request.path.myPath'
+          'integration.request.path.object': 'context.requestId'
+          'integration.request.header.cache-control': "'public, max-age=31536000, immutable'"
+```
+
+This will translate for example `/s3/a/b/c` to `a/b/c.xml`
+
 ### SNS
 
 Sample syntax for SNS proxy in `serverless.yml`.

lib/apiGateway/schema.js

@@ -91,11 +91,11 @@ const roleArn = stringOrGetAtt('roleArn', 'Arn')
 
 const acceptParameters = Joi.object().pattern(Joi.string(), Joi.boolean().required())
 
-const pathoverride = Joi.string()
+const pathOverride = Joi.string()
 
 const proxy = Joi.object({
   path,
-  pathoverride,
+  pathOverride,
   method,
   cors,
   authorizationType,

lib/package/s3/compileMethodsToS3.js

@@ -144,8 +144,8 @@ module.exports = {
 
     let pather = '{bucket}/{object}'
 
-    if (_.has(http, 'pathoverride')) {
-      pather = '{bucket}/' + http.pathoverride
+    if (_.has(http, 'pathOverride')) {
+      pather = '{bucket}/' + http.pathOverride
     }
 
     const integration = {

lib/package/s3/compileMethodsToS3.test.js

@@ -697,7 +697,7 @@ describe('#compileMethodsToS3()', () => {
             key: {
               pathParam: 'item'
             },
-            pathoverride: '{folder}/{item}.xml',
+            pathOverride: '{folder}/{item}.xml',
             auth: { authorizationType: 'NONE' },
             requestParameters: {
               'integration.request.path.folder': 'method.request.path.folder',
@@ -805,4 +805,122 @@ describe('#compileMethodsToS3()', () => {
       }
     })
   })
+
+  it('should create corresponding resources when s3 GetObject proxy is given with a greedy path override', () => {
+    serverlessApigatewayServiceProxy.validated = {
+      events: [
+        {
+          serviceName: 's3',
+          http: {
+            path: '/{myPath+}',
+            method: 'get',
+            bucket: {
+              Ref: 'MyBucket'
+            },
+            action: 'GetObject',
+            key: {
+              pathParam: 'myPath'
+            },
+            pathOverride: '{myPath}.xml',
+            auth: { authorizationType: 'NONE' },
+            requestParameters: {
+              'integration.request.path.myPath': 'method.request.path.myPath'
+            }
+          }
+        }
+      ]
+    }
+    serverlessApigatewayServiceProxy.apiGatewayRestApiLogicalId = 'ApiGatewayRestApi'
+    serverlessApigatewayServiceProxy.apiGatewayResources = {
+      '/{myPath+}': {
+        name: 'greedyPath',
+        resourceLogicalId: 'ApiGatewayPathOverrideS3'
+      }
+    }
+
+    serverlessApigatewayServiceProxy.compileMethodsToS3()
+    expect(serverless.service.provider.compiledCloudFormationTemplate.Resources).to.deep.equal({
+      ApiGatewayMethodgreedyPathGet: {
+        Type: 'AWS::ApiGateway::Method',
+        Properties: {
+          HttpMethod: 'GET',
+          RequestParameters: {
+            'method.request.path.myPath': true
+          },
+          AuthorizationType: 'NONE',
+          AuthorizationScopes: undefined,
+          AuthorizerId: undefined,
+          ApiKeyRequired: false,
+          ResourceId: { Ref: 'ApiGatewayPathOverrideS3' },
+          RestApiId: { Ref: 'ApiGatewayRestApi' },
+          Integration: {
+            Type: 'AWS',
+            IntegrationHttpMethod: 'GET',
+            Credentials: { 'Fn::GetAtt': ['ApigatewayToS3Role', 'Arn'] },
+            Uri: {
+              'Fn::Sub': ['arn:aws:apigateway:${AWS::Region}:s3:path/{bucket}/{myPath}.xml', {}]
+            },
+            PassthroughBehavior: 'WHEN_NO_MATCH',
+            RequestParameters: {
+              'integration.request.path.bucket': {
+                'Fn::Sub': [
+                  "'${bucket}'",
+                  {
+                    bucket: {
+                      Ref: 'MyBucket'
+                    }
+                  }
+                ]
+              },
+              'integration.request.path.object': 'method.request.path.myPath',
+              'integration.request.path.myPath': 'method.request.path.myPath'
+            },
+            IntegrationResponses: [
+              {
+                StatusCode: 400,
+                SelectionPattern: '4\\d{2}',
+                ResponseParameters: {},
+                ResponseTemplates: {}
+              },
+              {
+                StatusCode: 500,
+                SelectionPattern: '5\\d{2}',
+                ResponseParameters: {},
+                ResponseTemplates: {}
+              },
+              {
+                StatusCode: 200,
+                SelectionPattern: '2\\d{2}',
+                ResponseParameters: {
+                  'method.response.header.Content-Type': 'integration.response.header.Content-Type',
+                  'method.response.header.content-type': 'integration.response.header.content-type'
+                },
+                ResponseTemplates: {}
+              }
+            ]
+          },
+          MethodResponses: [
+            {
+              ResponseParameters: {
+                'method.response.header.Content-Type': true,
+                'method.response.header.content-type': true
+              },
+              ResponseModels: {},
+              StatusCode: 200
+            },
+            {
+              ResponseParameters: {},
+              ResponseModels: {},
+              StatusCode: 400
+            },
+            {
+              ResponseParameters: {},
+              ResponseModels: {},
+              StatusCode: 500
+            }
+          ]
+        }
+      }
+    })
+  })
 })