swaggerless 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3957d34d703acc47061180dbd8b43d3151b3c405
-  data.tar.gz: c6a3cc8a239e1e9331d51d717c05295e1698865e
+  metadata.gz: a18e0970662d5508436a06af8726f2e089267b79
+  data.tar.gz: 5b0c2c01580632917534d72395a498b5e2177554
 SHA512:
-  metadata.gz: 528d0603f06d9ea0a977eda1053ede2d2a9dd4d486afd54c798a3bf1752bbf0752cfd3b4da93ff584bbbd161fa184deea324ab1b3540af4f24607f67c68764c5
-  data.tar.gz: 9c257895feada0e6905ff4740c478b60b0c860c5a0f44655afd4df9e74da98b45f968b51df81be59816bdcbe121c888da7e8883087a2f3d60fc4f8e6dbf9962b
+  metadata.gz: 2c76fde123ac403e8209bacd1df3745b8f275a0b91f3c787d231ee7fa989f0bc12d2ad6df4e8a111ebf669fa84f8637d73c2a9b2c0ec267d111d2970771f9f8e
+  data.tar.gz: c9827f1950e48f15fde341e552688fa300cf3a343d53b32b8b23d0804e5fe8e2b8e0cdaa97f781279776b6fb3f1e2b668ebd4cb3293334a5e0edb29117c9735f

data/README.md

@@ -23,6 +23,63 @@ And then execute:
 Or install it yourself as:
 
     $ gem install swaggerless
+    
+## Usage for desing first microservice development
+    
+The gem was designed to be used together with Rake. It exports default taks to get you started. It can also be used with any framework.
+
+All you need to start is the design of your service in Open API spec (Swagger). For example for an `some_endpoint`
+
+```
+  /some_endpoint:
+    post:
+      produces:
+      - "application/json"
+      responses:
+        200:
+          description: "200 response"
+          schema:
+            $ref: "#/definitions/WebhookPayload"
+      x-amazon-lambda-name: HipchatAgileIntegrations
+      x-amazon-lambda-handler: lambda.handler
+      x-amazon-lambda-runtime: nodejs4.3
+      x-amazon-lambda-timeout: 10
+      x-amazon-apigateway-integration:
+        type: aws_proxy
+        httpMethod: POST
+        passthroughBehavior: when_no_match
+``` 
+
+As you can see apart from standard [API Gateway Extensions to Swagger](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html) this gem will be additionally looking for:
+- x-amazon-lambda-name (required)
+- x-amazon-lambda-handler
+- x-amazon-lambda-runtime
+- x-amazon-lambda-timeout
+- x-amazon-lambda-log-forwarder
+
+Once you have that, it is time to create your Rakefile
+
+```
+require 'swaggerless'
+
+cmd = 'cp package.json src/ && npm install --production --prefix src && rm src/package.json'
+%x[ #{cmd} ]
+
+@awsAccount = <AWS account ID>
+@lambdaRoleArn = <AWS role you want to use for lambda execution>
+@awsRegion = <AWS region>
+```
+
+and then calling `rake -T` should get you the following output:
+
+```
+rake swaggerless:clean                # Clean
+rake swaggerless:clean_aws_resources  # Clean AWS resources
+rake swaggerless:delete[environment]  # Remove stage and cleanup
+rake swaggerless:deploy[environment]  # Deploys to an environment specified as parameter
+rake swaggerless:package              # Package the project for AWS Lambda
+```
+
 
 ## Contributing
 

data/lib/swaggerless/deployer.rb

@@ -28,28 +28,30 @@ module Swaggerless
 
     def deploy_authoirizers_and_update_authorizers_uri(lambda_role_arn, swagger)
       lambdas_configs = @swaggerExtractor.get_lambda_map(swagger)
-      swagger["securityDefinitions"].each do |securityDefinitionName, securityDefinition|
-        if securityDefinition[AMZ_APIGATEWAY_AUTHORIZER] != nil then
-          authorizer = securityDefinition[EXT_LAMBDA_NAME]
-          if securityDefinition[EXT_LAMBDA_NAME] and securityDefinition[EXT_LAMBDA_HANDLER] then
-            config = lambdas_configs[securityDefinition[EXT_LAMBDA_NAME]]
-            securityDefinition[AMZ_APIGATEWAY_AUTHORIZER]["authorizerUri"] =
-                deploy_lambda_and_attach_log_forwarder(lambda_role_arn, securityDefinition, config)
-          elsif securityDefinition[EXT_LAMBDA_NAME]
-            securityDefinition[AMZ_APIGATEWAY_AUTHORIZER]["authorizerUri"] = "arn:aws:apigateway:#{@region}:lambda:path/2015-03-31/functions/arn:aws:lambda:#{@region}:#{@account}:function:#{authorizer}/invocations"
-          end
-          policy_exists = false
-          policy_name = "API_2_#{authorizer}".gsub(":","_")
-          begin
-            existing_policies = @lambda_client.get_policy(function_name: authorizer).data
-            existing_policy = JSON.parse(existing_policies.policy)
-            policy_exists = existing_policy['Statement'].select { |s| s['Sid'] == policy_name }.any?
-          rescue Aws::Lambda::Errors::ResourceNotFoundException
+      if swagger.key?("securityDefinitions") then
+        swagger["securityDefinitions"].each do |securityDefinitionName, securityDefinition|
+          if securityDefinition[AMZ_APIGATEWAY_AUTHORIZER] != nil then
+            authorizer = securityDefinition[EXT_LAMBDA_NAME]
+            if securityDefinition[EXT_LAMBDA_NAME] and securityDefinition[EXT_LAMBDA_HANDLER] then
+              config = lambdas_configs[securityDefinition[EXT_LAMBDA_NAME]]
+              securityDefinition[AMZ_APIGATEWAY_AUTHORIZER]["authorizerUri"] =
+                  deploy_lambda_and_attach_log_forwarder(lambda_role_arn, securityDefinition, config)
+            elsif securityDefinition[EXT_LAMBDA_NAME]
+              securityDefinition[AMZ_APIGATEWAY_AUTHORIZER]["authorizerUri"] = "arn:aws:apigateway:#{@region}:lambda:path/2015-03-31/functions/arn:aws:lambda:#{@region}:#{@account}:function:#{authorizer}/invocations"
+            end
             policy_exists = false
-          end
-          unless policy_exists
-            @lambda_client.add_permission({function_name: "arn:aws:lambda:#{@region}:#{@account}:function:#{authorizer}",
-              statement_id: policy_name, action: "lambda:*", principal: 'apigateway.amazonaws.com'})
+            policy_name = "API_2_#{authorizer}".gsub(":","_")
+            begin
+              existing_policies = @lambda_client.get_policy(function_name: authorizer).data
+              existing_policy = JSON.parse(existing_policies.policy)
+              policy_exists = existing_policy['Statement'].select { |s| s['Sid'] == policy_name }.any?
+            rescue Aws::Lambda::Errors::ResourceNotFoundException
+              policy_exists = false
+            end
+            unless policy_exists
+              @lambda_client.add_permission({function_name: "arn:aws:lambda:#{@region}:#{@account}:function:#{authorizer}",
+                statement_id: policy_name, action: "lambda:*", principal: 'apigateway.amazonaws.com'})
+            end
           end
         end
       end
@@ -124,6 +126,7 @@ module Swaggerless
       puts "Deploying #{function_name}"
       runtime ||= 'nodejs4.3'
       timeout ||= 5
+      permissionStatementId = Digest::SHA1.hexdigest "API_2_#{function_name}_#{@function_alias}"
       begin
         @lambda_client.get_alias({function_name: function_name, name: @function_alias})
       rescue Aws::Lambda::Errors::ResourceNotFoundException
@@ -139,7 +142,7 @@ module Swaggerless
         end
         puts "Creating alias #{@function_alias}"
         alias_resp = @lambda_client.create_alias({function_name: function_name, name: @function_alias, function_version: lambda_response.version, description: "Deployment of new version on " +  Time.now.inspect})
-        @lambda_client.add_permission({function_name: alias_resp.alias_arn, statement_id: "API_2_#{function_name}_#{@function_alias}", action: "lambda:*", principal: 'apigateway.amazonaws.com'})
+        @lambda_client.add_permission({function_name: alias_resp.alias_arn, statement_id: permissionStatementId, action: "lambda:*", principal: 'apigateway.amazonaws.com'})
       end
       return "arn:aws:apigateway:#{@region}:lambda:path/2015-03-31/functions/arn:aws:lambda:#{@region}:#{@account}:function:#{function_name}:#{@function_alias}/invocations"
     end
@@ -196,8 +199,8 @@ module Swaggerless
           puts "API available at #{url}"
           return url;
         rescue Aws::APIGateway::Errors::TooManyRequestsException => e
-          STDERR.puts 'WARNING: Got TooManyRequests response from API Gateway. Waiting for a second.'
-          sleep(1)
+          STDERR.puts 'WARNING: Got TooManyRequests response from API Gateway. Waiting...'
+          sleep(5)
         end
       end
 

data/lib/swaggerless/swaggerextractor.rb

@@ -22,10 +22,11 @@ module Swaggerless
           process_lambda_config(lambdas_map, method_config, swagger)
         end
       end
-
-      swagger["securityDefinitions"].each do |securityDefinitionName, securityDefinition|
-        if securityDefinition[AMZ_APIGATEWAY_AUTHORIZER] != nil
-          process_lambda_config(lambdas_map, securityDefinition, swagger)
+      if swagger.key?("securityDefinitions") then
+        swagger["securityDefinitions"].each do |securityDefinitionName, securityDefinition|
+          if securityDefinition[AMZ_APIGATEWAY_AUTHORIZER] != nil
+            process_lambda_config(lambdas_map, securityDefinition, swagger)
+          end
         end
       end
       return lambdas_map

data/lib/swaggerless/version.rb

@@ -1,3 +1,3 @@
 module Swaggerless
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

data/lib/tasks/swaggerless.rake

@@ -38,6 +38,11 @@ namespace :swaggerless do
 
     FileUtils.mkdir_p 'output'
 
+    if not @swaggerSpecFile then
+      @swaggerSpecFile = 'swagger.yaml'
+      STDERR.puts("Swagger file not configured. Trying default ('#{@swaggerSpecFile}'). Set @swaggerSpecFile to point to swagger yaml file if you use different file name")
+    end
+
     if not @packageDir then
       @packageDir = 'src'
       STDERR.puts("Package directory not configured. Trying default ('#{@packageDir}'). Set @packageDir to point to the directory that should be packaged for AWS Lambda")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggerless
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Rafal Nowosielski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler