api_gateway_dsl 0.1.0

data/spec/fixtures/lambda_post_with_cors/pets/post.rb

@@ -0,0 +1,11 @@
+POST '/pets', cors: true do
+  header 'Accept-Language'
+
+  LAMBDA 'arn:aws:lambda:eu-west-1:123456789012:function:create_pet'
+
+  RESPONSE 201 do
+    header 'Location', integration: { response: { body: 'location' } }
+  end
+
+  RESPONSE 500, /\n|.*/
+end

data/spec/fixtures/lambda_post_with_cors/pets/request/body.vtl

@@ -0,0 +1,9 @@
+#set( $inputRoot = $input.path('$') )
+{
+  "pet": {
+    "name": $input.json('$.pet.name')
+  }
+  "meta": {
+    "accept_language": "${util.escapeJavaScript($input.params('Accept-Language')).replaceAll("\\'","'")}"
+  }
+}

data/spec/fixtures/lambda_post_with_cors/pets/request/body.yml

@@ -0,0 +1,7 @@
+type: "object"
+properties:
+  pet:
+    type: "object"
+    properties:
+      name:
+        type: "string"

data/spec/fixtures/lambda_post_with_cors/pets/response/201.vtl

@@ -0,0 +1 @@
+{}

data/spec/fixtures/lambda_post_with_cors/pets/response/201.yml

@@ -0,0 +1 @@
+type: "object"

data/spec/fixtures/lambda_post_with_cors/pets/response/500.vtl

@@ -0,0 +1,3 @@
+{
+  "message": "Something went wrong!"
+}

data/spec/fixtures/lambda_post_with_cors/pets/response/500.yml

@@ -0,0 +1,4 @@
+type: "object"
+properties:
+  message:
+    type: "string"

data/spec/fixtures/markdown.rb

@@ -0,0 +1,73 @@
+require 'pathname'
+require 'yaml'
+
+module APIGatewayDSL
+  class Generator
+
+    def initialize(dir)
+      @dir = Pathname.new(dir)
+
+      File.open(dir.join('README.md'), 'w') do |fd|
+        @fd = fd
+        fixture
+      end
+    end
+
+    private
+
+    def fixture # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      puts "# #{result['info']['title']}"
+      puts
+      if result['info']['description']
+        puts result['info']['description']
+        puts
+      end
+      puts '## Given'
+      puts
+      Dir.glob(@dir.join('*.rb')).map { |f| Pathname.new(f) }.each do |file|
+        file(file, false)
+      end
+      Dir.glob(@dir.join('*', '*.rb')).map { |f| Pathname.new(f) }.each do |file|
+        file(file)
+      end
+      Dir.glob(@dir.join('*', '*', '*')).map { |f| Pathname.new(f) }.each do |file|
+        file(file)
+      end
+      puts '## Generates'
+      puts
+      file(result_file)
+    end
+
+    def result_file
+      @result_file ||= Pathname.new(@dir.join('index.yml'))
+    end
+
+    def result
+      @result ||= YAML.safe_load(result_file.read)
+    end
+
+    def file(file, content = true) # rubocop:disable Metrics/MethodLength
+      relative_file = file.relative_path_from(@dir)
+
+      if content
+        puts "* [`#{relative_file}`](#{relative_file})"
+        puts
+        puts "  ```#{file.extname[1..-1]}"
+        puts file.read.gsub(/^/, '  ')
+        puts '  ```'
+      else
+        puts "* [`#{relative_file}`](#{relative_file}) (skipped for readability)"
+      end
+      puts
+    end
+
+    def puts(*args)
+      @fd.puts(*args)
+    end
+
+  end
+end
+
+Dir.glob('spec/fixtures/*').map { |f| Pathname.new(f) }.select(&:directory?).each do |fixture|
+  APIGatewayDSL::Generator.new(fixture)
+end

data/spec/fixtures/mock_options/README.md

@@ -0,0 +1,80 @@
+# OPTIONS Endpoint with Mock Integration
+
+This example demonstrates how to specify an OPTIONS endpoint for the path `/pets` which uses a mock integration in
+order to return constant values to add CORS support for the `/pets` path.
+
+## Configuration
+
+* The mock integration returns a `200`.
+* The mock integration passes returns constant values for the `Access-Control-Allow-Headers`,
+  `Access-Control-Allow-Methods`, and `Access-Control-Allow-Origin` headers which enable the CORS support.
+
+## Given
+
+* [`index.rb`](index.rb) (skipped for readability)
+
+* [`pets/options.rb`](pets/options.rb)
+
+  ```rb
+  OPTIONS '/pets' do
+    MOCK 200
+  
+    RESPONSE 200 do
+      header 'Access-Control-Allow-Headers', 'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'
+      header 'Access-Control-Allow-Methods', 'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'
+      header 'Access-Control-Allow-Origin',  '*'
+    end
+  end
+  ```
+
+## Generates
+
+* [`index.yml`](index.yml)
+
+  ```yml
+  swagger: "2.0"
+  info:
+    version: "1.2.3"
+    title: "OPTIONS Endpoint with Mock Integration"
+    description: |
+      This example demonstrates how to specify an OPTIONS endpoint for the path `/pets` which uses a mock integration in
+      order to return constant values to add CORS support for the `/pets` path.
+  
+      ## Configuration
+  
+      * The mock integration returns a `200`.
+      * The mock integration passes returns constant values for the `Access-Control-Allow-Headers`,
+        `Access-Control-Allow-Methods`, and `Access-Control-Allow-Origin` headers which enable the CORS support.
+  host: "api.example.com"
+  schemes:
+    - "https"
+  paths:
+    /pets:
+      options:
+        responses:
+          '200':
+            description: "200 response"
+            headers:
+              Access-Control-Allow-Origin:
+                type: "string"
+              Access-Control-Allow-Methods:
+                type: "string"
+              Access-Control-Allow-Headers:
+                type: "string"
+        x-amazon-apigateway-integration:
+          responses:
+            default:
+              statusCode: "200"
+              responseParameters:
+                method.response.header.Access-Control-Allow-Methods: "'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'"
+                method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'"
+                method.response.header.Access-Control-Allow-Origin: "'*'"
+          requestTemplates:
+            application/json: |
+              {
+                "statusCode": 200
+              }
+          passthroughBehavior: "WHEN_NO_TEMPLATES"
+          type: "mock"
+  ```
+

data/spec/fixtures/mock_options/index.rb

@@ -0,0 +1,15 @@
+title 'OPTIONS Endpoint with Mock Integration'
+version '1.2.3'
+description <<-EOS
+  This example demonstrates how to specify an OPTIONS endpoint for the path `/pets` which uses a mock integration in
+  order to return constant values to add CORS support for the `/pets` path.
+
+  ## Configuration
+
+  * The mock integration returns a `200`.
+  * The mock integration passes returns constant values for the `Access-Control-Allow-Headers`,
+    `Access-Control-Allow-Methods`, and `Access-Control-Allow-Origin` headers which enable the CORS support.
+EOS
+
+host 'api.example.com'
+schemes 'https'

data/spec/fixtures/mock_options/index.yml

@@ -0,0 +1,44 @@
+swagger: "2.0"
+info:
+  version: "1.2.3"
+  title: "OPTIONS Endpoint with Mock Integration"
+  description: |
+    This example demonstrates how to specify an OPTIONS endpoint for the path `/pets` which uses a mock integration in
+    order to return constant values to add CORS support for the `/pets` path.
+
+    ## Configuration
+
+    * The mock integration returns a `200`.
+    * The mock integration passes returns constant values for the `Access-Control-Allow-Headers`,
+      `Access-Control-Allow-Methods`, and `Access-Control-Allow-Origin` headers which enable the CORS support.
+host: "api.example.com"
+schemes:
+  - "https"
+paths:
+  /pets:
+    options:
+      responses:
+        '200':
+          description: "200 response"
+          headers:
+            Access-Control-Allow-Origin:
+              type: "string"
+            Access-Control-Allow-Methods:
+              type: "string"
+            Access-Control-Allow-Headers:
+              type: "string"
+      x-amazon-apigateway-integration:
+        responses:
+          default:
+            statusCode: "200"
+            responseParameters:
+              method.response.header.Access-Control-Allow-Methods: "'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'"
+              method.response.header.Access-Control-Allow-Headers: "'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'"
+              method.response.header.Access-Control-Allow-Origin: "'*'"
+        requestTemplates:
+          application/json: |
+            {
+              "statusCode": 200
+            }
+        passthroughBehavior: "WHEN_NO_TEMPLATES"
+        type: "mock"

data/spec/fixtures/mock_options/pets/options.rb

@@ -0,0 +1,9 @@
+OPTIONS '/pets' do
+  MOCK 200
+
+  RESPONSE 200 do
+    header 'Access-Control-Allow-Headers', 'Content-Type,Authorization,X-Amz-Date,X-Api-Key,X-Amz-Security-Token'
+    header 'Access-Control-Allow-Methods', 'DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT'
+    header 'Access-Control-Allow-Origin',  '*'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+
+require 'rspec/json_expectations'
+
+require 'api_gateway_dsl'

metadata

@@ -0,0 +1,265 @@
+--- !ruby/object:Gem::Specification
+name: api_gateway_dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Sebastian Siwy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: 
+email: api_gateway_dsl@jansiwy.de
+executables:
+- api_gateway_dsl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- api_gateway_dsl.gemspec
+- bin/api_gateway_dsl
+- lib/api_gateway_dsl.rb
+- lib/api_gateway_dsl/context.rb
+- lib/api_gateway_dsl/document.rb
+- lib/api_gateway_dsl/dsl/document_node.rb
+- lib/api_gateway_dsl/dsl/integration_node.rb
+- lib/api_gateway_dsl/dsl/operation_node.rb
+- lib/api_gateway_dsl/dsl/response_node.rb
+- lib/api_gateway_dsl/integration.rb
+- lib/api_gateway_dsl/integration/collection.rb
+- lib/api_gateway_dsl/integration/http.rb
+- lib/api_gateway_dsl/integration/http_proxy.rb
+- lib/api_gateway_dsl/integration/lambda.rb
+- lib/api_gateway_dsl/integration/mock.rb
+- lib/api_gateway_dsl/mapping.rb
+- lib/api_gateway_dsl/mapping/collection.rb
+- lib/api_gateway_dsl/operation.rb
+- lib/api_gateway_dsl/operation/collection.rb
+- lib/api_gateway_dsl/parameter.rb
+- lib/api_gateway_dsl/parameter/body.rb
+- lib/api_gateway_dsl/parameter/collection.rb
+- lib/api_gateway_dsl/parameter/header.rb
+- lib/api_gateway_dsl/parameter/path.rb
+- lib/api_gateway_dsl/parameter/query.rb
+- lib/api_gateway_dsl/parameter/simple.rb
+- lib/api_gateway_dsl/response.rb
+- lib/api_gateway_dsl/response/collection.rb
+- lib/api_gateway_dsl/response_header.rb
+- lib/api_gateway_dsl/response_header/collection.rb
+- lib/api_gateway_dsl/response_integration.rb
+- lib/api_gateway_dsl/response_integration/collection.rb
+- lib/api_gateway_dsl/template.rb
+- lib/api_gateway_dsl/template/collection.rb
+- lib/api_gateway_dsl/version.rb
+- spec/api_gateway_dsl/document_spec.rb
+- spec/fixtures/greedy_http_proxy/README.md
+- spec/fixtures/greedy_http_proxy/index.rb
+- spec/fixtures/greedy_http_proxy/index.yml
+- spec/fixtures/greedy_http_proxy/pets/proxy.rb
+- spec/fixtures/http_get/README.md
+- spec/fixtures/http_get/index.rb
+- spec/fixtures/http_get/index.yml
+- spec/fixtures/http_get/pets/get.rb
+- spec/fixtures/http_get/pets/response/200.vtl
+- spec/fixtures/http_get/pets/response/200.yml
+- spec/fixtures/http_get/pets/response/500.vtl
+- spec/fixtures/http_get/pets/response/500.yml
+- spec/fixtures/lambda_post/README.md
+- spec/fixtures/lambda_post/index.rb
+- spec/fixtures/lambda_post/index.yml
+- spec/fixtures/lambda_post/pets/post.rb
+- spec/fixtures/lambda_post/pets/request/body.vtl
+- spec/fixtures/lambda_post/pets/request/body.yml
+- spec/fixtures/lambda_post/pets/response/201.vtl
+- spec/fixtures/lambda_post/pets/response/201.yml
+- spec/fixtures/lambda_post/pets/response/500.vtl
+- spec/fixtures/lambda_post/pets/response/500.yml
+- spec/fixtures/lambda_post_with_cors/README.md
+- spec/fixtures/lambda_post_with_cors/index.rb
+- spec/fixtures/lambda_post_with_cors/index.yml
+- spec/fixtures/lambda_post_with_cors/pets/post.rb
+- spec/fixtures/lambda_post_with_cors/pets/request/body.vtl
+- spec/fixtures/lambda_post_with_cors/pets/request/body.yml
+- spec/fixtures/lambda_post_with_cors/pets/response/201.vtl
+- spec/fixtures/lambda_post_with_cors/pets/response/201.yml
+- spec/fixtures/lambda_post_with_cors/pets/response/500.vtl
+- spec/fixtures/lambda_post_with_cors/pets/response/500.yml
+- spec/fixtures/markdown.rb
+- spec/fixtures/mock_options/README.md
+- spec/fixtures/mock_options/index.rb
+- spec/fixtures/mock_options/index.yml
+- spec/fixtures/mock_options/pets/options.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jansiwy/api_gateway_dsl
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby DSL to generate an Amazon API Gateway definition
+test_files:
+- spec/api_gateway_dsl/document_spec.rb
+- spec/fixtures/greedy_http_proxy/README.md
+- spec/fixtures/greedy_http_proxy/index.rb
+- spec/fixtures/greedy_http_proxy/index.yml
+- spec/fixtures/greedy_http_proxy/pets/proxy.rb
+- spec/fixtures/http_get/README.md
+- spec/fixtures/http_get/index.rb
+- spec/fixtures/http_get/index.yml
+- spec/fixtures/http_get/pets/get.rb
+- spec/fixtures/http_get/pets/response/200.vtl
+- spec/fixtures/http_get/pets/response/200.yml
+- spec/fixtures/http_get/pets/response/500.vtl
+- spec/fixtures/http_get/pets/response/500.yml
+- spec/fixtures/lambda_post/README.md
+- spec/fixtures/lambda_post/index.rb
+- spec/fixtures/lambda_post/index.yml
+- spec/fixtures/lambda_post/pets/post.rb
+- spec/fixtures/lambda_post/pets/request/body.vtl
+- spec/fixtures/lambda_post/pets/request/body.yml
+- spec/fixtures/lambda_post/pets/response/201.vtl
+- spec/fixtures/lambda_post/pets/response/201.yml
+- spec/fixtures/lambda_post/pets/response/500.vtl
+- spec/fixtures/lambda_post/pets/response/500.yml
+- spec/fixtures/lambda_post_with_cors/README.md
+- spec/fixtures/lambda_post_with_cors/index.rb
+- spec/fixtures/lambda_post_with_cors/index.yml
+- spec/fixtures/lambda_post_with_cors/pets/post.rb
+- spec/fixtures/lambda_post_with_cors/pets/request/body.vtl
+- spec/fixtures/lambda_post_with_cors/pets/request/body.yml
+- spec/fixtures/lambda_post_with_cors/pets/response/201.vtl
+- spec/fixtures/lambda_post_with_cors/pets/response/201.yml
+- spec/fixtures/lambda_post_with_cors/pets/response/500.vtl
+- spec/fixtures/lambda_post_with_cors/pets/response/500.yml
+- spec/fixtures/markdown.rb
+- spec/fixtures/mock_options/README.md
+- spec/fixtures/mock_options/index.rb
+- spec/fixtures/mock_options/index.yml
+- spec/fixtures/mock_options/pets/options.rb
+- spec/spec_helper.rb