swaggerless 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9674dbf5858fbd49c52d4618342cef130958ce2b
+  data.tar.gz: 117d7804b5871e64b30fcc80dcb7e75786c3ebbf
+SHA512:
+  metadata.gz: 39003efb6aa3728827e9d48ff8e7fffabf8d6a6bb7f752a43d94355e8aa480d39733f3d2dbc6162b3cdff4068f102742c4fba1ab3bab1ee379f3300ed5fb78e9
+  data.tar.gz: 5f1e63e1565cca994550547068f279c27fdf24ab6ad3b771213243649613d1c8a68e61b1ce25dff0541b5cc7ba6d6ec1b1b35545174f4d667da7b518792123a1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+# Swaggerless
+
+This simple gem is supposed to speed up work on deploying serverless applications into the AWS.
+The idea behind this particualar development workflow is simple:
+
+1. Design you API using [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification)
+2. Add extension entries to the specification accoding to [AWS Guidelines](http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html)
+3. Add couple more extension entries to taste, that help the gem do the right thing
+4. Inlcude the Swaggerless in your Rakefile and see your service stub deployed to AWS Lambda, fronted by API Gateway
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swaggerless'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swaggerless
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swaggerless.
+

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task :default => :spec

data/lib/swaggerless.rb

@@ -0,0 +1,6 @@
+Dir["#{File.expand_path(File.dirname(__FILE__))}/**/*.rb"].each { |f| require f }
+
+STDOUT.sync = true
+STDERR.sync = true
+
+load 'tasks/swaggerless.rake'

data/lib/swaggerless/deployer.rb

@@ -0,0 +1,135 @@
+require "aws-sdk"
+
+module Swaggerless
+
+  class Deployer
+
+    def initialize(account, region, env)
+      @env = env
+      @region = region
+      @account = account
+      @apiGatewayClient = Aws::APIGateway::Client.new(region: @region)
+      @outputPath = 'output'
+      @function_alias = get_current_package_alias
+    end
+
+    def create_lambda_package(directory, outputName)
+      Swaggerless::Packager.new(directory, "#{outputName}.zip")
+    end
+
+    def self.get_service_prefix(swagger)
+      return swagger["info"]["title"].gsub(/\s+/, '_')
+    end
+
+    def update_authorizer_uri(swagger)
+      swagger["securityDefinitions"].each do |securityDefinitionName, securityDefinition|
+        if securityDefinition['x-amazon-apigateway-authorizer'] != nil then
+          authorizer = securityDefinition['x-amazon-apigateway-authorizer-lambda']
+          securityDefinition['x-amazon-apigateway-authorizer']["authorizerUri"] = "arn:aws:apigateway:#{@region}:lambda:path/2015-03-31/functions/arn:aws:lambda:#{@region}:#{@account}:function:#{authorizer}/invocations"
+          lambdaClient = Aws::Lambda::Client.new(region: @region)
+          policy_exists = false
+          begin
+            existing_policies = lambdaClient.get_policy(function_name: authorizer).data
+            existing_policy = JSON.parse(existing_policies.policy)
+            policy_exists = existing_policy['Statement'].select { |s| s['Sid'] == "API_2_#{authorizer}" }.any?
+          rescue Aws::Lambda::Errors::ResourceNotFoundException
+            policy_exists = false
+          end
+          unless policy_exists
+            lambdaClient.add_permission({function_name: "arn:aws:lambda:#{@region}:#{@account}:function:#{authorizer}",
+              statement_id: "API_2_#{authorizer}", action: "lambda:*", principal: 'apigateway.amazonaws.com'})
+          end
+        end
+      end
+    end
+
+    def deploy_lambdas_and_update_integration_uris(lambda_role_arn, swagger)
+      deployedOperations = Hash.new
+      swagger["paths"].each do |path, path_config|
+        path_config.each do |method, method_config|
+          if method_config['operationId'] then
+            if deployedOperations[method_config['operationId']] == nil then
+              function_name = Deployer.get_service_prefix(swagger) + "_" + method_config['operationId'].split(".").last
+              deployedOperations[method_config['operationId']] =
+                  deploy_lambda(lambda_role_arn, function_name, method_config["summary"], method_config['x-amazon-lambda-runtime'] || 'nodejs4.3',
+                                method_config['operationId'], method_config['x-amazon-lambda-timeout'] || 5)
+            end
+            method_config['x-amazon-apigateway-integration']['uri'] = deployedOperations[method_config['operationId']]
+          end
+        end
+      end
+    end
+
+    def deploy_lambda(lambda_role_arn, function_name, summary, runtime, handler, timeout)
+      puts "Deploying #{function_name}"
+      lambdaClient = Aws::Lambda::Client.new(region: @region)
+      begin
+        lambdaClient.get_alias({function_name: function_name, name: @function_alias})
+      rescue Aws::Lambda::Errors::ResourceNotFoundException
+        lambdaResponse = nil
+        zipFileContent = File.read(File.join(@outputPath,"#{@function_alias}.zip"))
+        begin
+          lambdaClient.get_function({function_name: function_name})
+          lambdaResponse = lambdaClient.update_function_code({function_name: function_name, zip_file: zipFileContent, publish: true})
+          lambdaClient.update_function_configuration({function_name: function_name, runtime: runtime, role: lambda_role_arn, handler: handler, description: summary, timeout: timeout})
+        rescue Aws::Lambda::Errors::ResourceNotFoundException
+          puts "Creating new function #{function_name}"
+          lambdaResponse = lambdaClient.create_function({function_name: function_name, runtime: runtime, role: lambda_role_arn, handler: handler, code: { zip_file: zipFileContent }, description: summary, publish: true, timeout: timeout})
+        end
+        puts "Creating alias #{@function_alias}"
+        aliasResp = lambdaClient.create_alias({function_name: function_name, name: @function_alias, function_version: lambdaResponse.version, description: "Deployment of new version on " +  Time.now.inspect})
+        lambdaClient.add_permission({function_name: aliasResp.alias_arn, statement_id: "API_2_#{function_name}_#{@function_alias}", 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
+
+    def get_current_package_alias
+      zipFiles = Dir["#{@outputPath}/*.zip"]
+      if zipFiles.length == 0 then
+        raise 'No package in the output folder. Unable to continue.'
+      elsif zipFiles.length == 0
+        raise 'Multiple package in the output folder. Unable to continue.'
+      end
+      return File.basename(zipFiles.first, '.zip')
+    end
+
+    def create_api_gateway(swagger)
+      puts "Creating API Gateway"
+      apis = @apiGatewayClient.get_rest_apis(limit: 500).data
+      api = apis.items.select { |a| a.name == swagger['info']['title'] }.first
+
+      if api then
+        resp = @apiGatewayClient.put_rest_api({rest_api_id: api.id, mode: "overwrite", fail_on_warnings: true, body: swagger.to_yaml})
+      else
+        resp = @apiGatewayClient.import_rest_api({fail_on_warnings: true, body: swagger.to_yaml})
+      end
+
+      if resp.warnings then
+        resp.warnings.each do |warning|
+          STDERR.puts "WARNING: " + warning
+        end
+      end
+
+      return resp.id
+    end
+
+    def create_api_gateway_deployment(lambda_role_arn, swagger)
+      deploy_lambdas_and_update_integration_uris(lambda_role_arn, swagger)
+      update_authorizer_uri(swagger)
+      apiId = self.create_api_gateway(swagger);
+      while true do
+        begin
+          puts "Creating API Gateway Deployment"
+          @apiGatewayClient.create_deployment({rest_api_id: apiId, stage_name: @env, description: "Automated deployment of #{@env}", variables: { "env" => @env }});
+          break
+        rescue Aws::APIGateway::Errors::TooManyRequestsException => e
+          STDERR.puts 'WARNING: Got TooManyRequests response from API Gateway. Waiting for a second.'
+          sleep(1)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/swaggerless/packager.rb

@@ -0,0 +1,57 @@
+require "zip"
+require 'digest/sha1'
+
+module Swaggerless
+
+  class Packager
+
+    def initialize(input_dir, output_file)
+      @input_dir = input_dir
+      @output_file = output_file
+    end
+
+    def write
+      version_hash = version_hash()
+      entries = Dir.entries(@input_dir) - %w(. ..)
+
+      ::Zip::File.open("#{@output_file}_#{version_hash}.zip", ::Zip::File::CREATE) do |io|
+        write_entries entries, '', io
+      end
+    end
+
+    private
+
+    def version_hash()
+      files = Dir["#{@input_dir}/**/*"].reject{|f| File.directory?(f)}
+      content = files.map{|f| File.read(f)}.join
+      Digest::SHA1.hexdigest(content).to_s
+    end
+
+    def write_entries(entries, path, io)
+      entries.each do |e|
+        zip_file_path = path == '' ? e : File.join(path, e)
+        disk_file_path = File.join(@input_dir, zip_file_path)
+
+
+        if File.directory? disk_file_path
+          recursively_deflate_directory(disk_file_path, io, zip_file_path)
+        else
+          put_into_archive(disk_file_path, io, zip_file_path)
+        end
+      end
+    end
+
+    def recursively_deflate_directory(disk_file_path, io, zip_file_path)
+      io.mkdir zip_file_path
+      subdir = Dir.entries(disk_file_path) - %w(. ..)
+      write_entries subdir, zip_file_path, io
+    end
+
+    def put_into_archive(disk_file_path, io, zip_file_path)
+      io.get_output_stream(zip_file_path) do |f|
+        f.write(File.open(disk_file_path, 'rb').read)
+      end
+    end
+  end
+
+end

data/lib/swaggerless/version.rb

@@ -0,0 +1,3 @@
+module Swaggerless
+  VERSION = "0.1.0"
+end

data/lib/tasks/swaggerless.rake

@@ -0,0 +1,52 @@
+require "yaml"
+require "json"
+require "swaggerless"
+require 'fileutils'
+
+desc 'Deploys to an environment specified as parameter'
+task :deploy, [ :environment ] => [ :clean, :package ] do |t, args|
+  puts "Deploying API Gateway"
+  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 @lambdaRoleArn then
+    raise "Unable to continue. Please configue @lambdaRoleArn in the Rakefile"
+  end
+
+  if not @awsRegion then
+    @awsRegion = ENV['AWS_REGION'] || 'eu-west-1'
+    STDERR.puts("AWS Region is not configured. Trying default ('#{@awsRegion}'). Set @awsRegion to point to swagger yaml file if you use different file name")
+  end
+
+  if not @awsAccount then
+    raise "Unable to continue. Please configue @awsAccount in the Rakefile"
+  end
+
+  swagger_content = File.read(@swaggerSpecFile)
+  swagger = YAML.load(swagger_content)
+  Swaggerless::Deployer.new(@awsAccount, @awsRegion, args[:environment]).create_api_gateway_deployment(@lambdaRoleArn, swagger)
+end
+
+desc 'Package the project for AWS Lambda'
+task :package do
+  puts "Packaging"
+
+  FileUtils.mkdir_p 'output'
+
+  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")
+  end
+
+  swagger_content = File.read(@swaggerSpecFile)
+  swagger = YAML.load(swagger_content)
+  servicePrefix = Swaggerless::Deployer.get_service_prefix(swagger)
+  Swaggerless::Packager.new(@packageDir, "output/#{servicePrefix}").write
+end
+
+desc 'Clean'
+task :clean do
+  FileUtils.rm_rf('output')
+end

data/swaggerless.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swaggerless/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swaggerless"
+  spec.version       = Swaggerless::VERSION
+  spec.authors       = ["Rafal Nowosielski"]
+  spec.email         = ["rafal@nowosielski.email"]
+
+  spec.summary       = "The gem includes common tasks needed to deploy design first serverless to the AWS"
+  spec.description   = "The gem includes common tasks needed to deploy design first Open API spec to AWS using Lambdas and API Gateway"
+  spec.homepage      = "https://open.cimpress.io"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "aws-sdk", "~> 2.6"
+  spec.add_runtime_dependency "rubyzip"
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: swaggerless
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafal Nowosielski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The gem includes common tasks needed to deploy design first Open API
+  spec to AWS using Lambdas and API Gateway
+email:
+- rafal@nowosielski.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/swaggerless.rb
+- lib/swaggerless/deployer.rb
+- lib/swaggerless/packager.rb
+- lib/swaggerless/version.rb
+- lib/tasks/swaggerless.rake
+- swaggerless.gemspec
+homepage: https://open.cimpress.io
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: The gem includes common tasks needed to deploy design first serverless to
+  the AWS
+test_files: []