api_gateway_dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f1eb1c73e67130089d77a86f3c3257f7396c3d5
+  data.tar.gz: 10a2e1a752f017b4175a57d2f83bb67957740113
+SHA512:
+  metadata.gz: aa5f2c8b86552d811ea82ac4f0c1ff3069002b3b6c00d8246c9c689080085f167322353338e0d98fea158e475c9653dc43581036149486fd2368bfff47175dc1
+  data.tar.gz: 9fd32d847ba23c106fe0eaae1fd58cfc2291012666b5dd726e63a9b14f4b19fdb9a16fb213acb5af1d8306bab71d9e76da14fdf8f1fd10534c34d19afc0eab8f

data/.gitignore

@@ -0,0 +1,20 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore generate gems
+/*.gem
+
+# Ignore bundler config
+/.bundle
+
+# Ignore local rspec config
+/.rspec-local
+
+# rpsec's code coverage
+/coverage
+
+# Ignore Gemfile.lock
+/Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.simplecov

@@ -0,0 +1,2 @@
+SimpleCov.command_name 'test:units'
+SimpleCov.start

data/.travis.yml

@@ -0,0 +1,2 @@
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jan Sebastian Siwy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+[![Build Status](https://travis-ci.org/jansiwy/api_gateway_dsl.svg?branch=master)](https://travis-ci.org/jansiwy/api_gateway_dsl)
+[![Code Climate](https://codeclimate.com/github/jansiwy/api_gateway_dsl/badges/gpa.svg)](https://codeclimate.com/github/jansiwy/api_gateway_dsl)
+[![Test Coverage](https://codeclimate.com/github/jansiwy/api_gateway_dsl/badges/coverage.svg)](https://codeclimate.com/github/jansiwy/api_gateway_dsl/coverage)
+[![Issue Count](https://codeclimate.com/github/jansiwy/api_gateway_dsl/badges/issue_count.svg)](https://codeclimate.com/github/jansiwy/api_gateway_dsl)
+
+# Amazon API Gateway DSL
+
+Ruby DSL to generate a [Amazon API Gateway](https://aws.amazon.com/api-gateway/) definition.
+
+## Install
+
+Install the Gem with
+
+```bash
+gem install api_gateway_dsl
+```
+
+## Usage
+
+In order to generate a JSON or YAML representation of an Amazon API Gateway definition:
+
+```bash
+api_gateway_dsl json <dir>
+```
+
+or
+
+```bash
+api_gateway_dsl yaml <dir>
+```
+
+## Examples
+
+There are several examples demonstrating how to specify an Amazon API Gateway definition:
+
+* [GET Endpoint with HTTP Integration](spec/fixtures/http_get)
+* [POST Endpoint with Lambda Integration](spec/fixtures/lambda_post)
+* [POST Endpoint with Lambda Integration and CORS Support](spec/fixtures/lambda_post_with_cors)
+* [Greedy Endpoint for any HTTP method with HTTP proxy integration](spec/fixtures/greedy_http_proxy)
+* [OPTIONS Endpoint with Mock Integration](spec/fixtures/mock_options)

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/api_gateway_dsl.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'api_gateway_dsl/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'api_gateway_dsl'
+  s.version       = APIGatewayDSL::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = 'Ruby DSL to generate an Amazon API Gateway definition'
+  s.email         = 'api_gateway_dsl@jansiwy.de'
+  s.authors       = ['Jan Sebastian Siwy']
+  s.homepage      = 'https://github.com/jansiwy/api_gateway_dsl'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = ['api_gateway_dsl']
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '~> 5.0'
+  s.add_dependency 'thor', '~> 0.19'
+
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.5'
+  s.add_development_dependency 'rspec-json_expectations', '~> 2.1'
+
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+  s.add_development_dependency 'simplecov', '~> 0.14'
+end

data/bin/api_gateway_dsl

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib)
+
+require 'api_gateway_dsl'
+
+module APIGatewayDSL
+  class CLI < Thor
+
+    desc 'json DIR', 'prints the Amazon API Gateway Gateway definition in the specified directory as JSON'
+    def json(dir)
+      puts JSON.pretty_generate(document(dir))
+    end
+
+    desc 'yaml DIR', 'prints the Amazon API Gateway definition in the specified directory as YAML'
+    def yaml(dir)
+      puts YAML.dump(document(dir))
+    end
+
+    private
+
+    def document(dir)
+      Document.load(dir).as_json
+    end
+
+  end
+end
+
+APIGatewayDSL::CLI.start(ARGV)

data/lib/api_gateway_dsl.rb

@@ -0,0 +1,26 @@
+# Ruby SDK
+require 'pathname'
+require 'yaml'
+
+# ActiveSupport
+require 'active_support/all'
+
+module APIGatewayDSL
+
+end
+
+require 'api_gateway_dsl/context'
+require 'api_gateway_dsl/document'
+require 'api_gateway_dsl/integration'
+require 'api_gateway_dsl/mapping'
+require 'api_gateway_dsl/operation'
+require 'api_gateway_dsl/parameter'
+require 'api_gateway_dsl/response'
+require 'api_gateway_dsl/response_header'
+require 'api_gateway_dsl/response_integration'
+require 'api_gateway_dsl/template'
+
+require 'api_gateway_dsl/dsl/document_node'
+require 'api_gateway_dsl/dsl/integration_node'
+require 'api_gateway_dsl/dsl/operation_node'
+require 'api_gateway_dsl/dsl/response_node'

data/lib/api_gateway_dsl/context.rb

@@ -0,0 +1,13 @@
+module APIGatewayDSL
+  class Context
+
+    # Allows to change the current directory before loading another Ruby file,
+    # so that it is possible to use relative file names (e.g. to JSON schemata) within the DSL.
+    attr_accessor :current_dir, :default_body_file
+
+    def initialize(current_dir = nil)
+      @current_dir = current_dir
+    end
+
+  end
+end

data/lib/api_gateway_dsl/document.rb

@@ -0,0 +1,41 @@
+module APIGatewayDSL
+  class Document
+
+    def self.load(dir)
+      new do
+        ::Dir.glob(::Pathname.new(dir).join('**', '*.rb')) do |file|
+          file = ::Pathname.new(file)
+          self.context = Context.new(file.dirname)
+          instance_eval file.read, file.to_s, 1
+        end
+      end
+    end
+
+    attr_reader :operations
+    attr_accessor :title, :version, :description, :host, :schemes
+
+    def initialize(&block)
+      @operations = Operation::Collection.new
+
+      DSL::DocumentNode.new(self, &block)
+    end
+
+    def as_json # rubocop:disable Metrics/MethodLength
+      {}.tap do |result|
+        result[:swagger] = '2.0'
+
+        result[:info] = {}.tap do |info|
+          info[:title]       = title
+          info[:version]     = version
+          info[:description] = description.strip_heredoc if description
+        end
+
+        result[:host]    = host
+        result[:schemes] = schemes
+
+        result[:paths]   = operations.as_json
+      end.deep_stringify_keys
+    end
+
+  end
+end

data/lib/api_gateway_dsl/dsl/document_node.rb

@@ -0,0 +1,46 @@
+module APIGatewayDSL
+  module DSL
+    class DocumentNode < BasicObject
+
+      attr_accessor :context
+
+      def initialize(document, &block)
+        @document = document
+        instance_eval(&block) if block
+      end
+
+      # General
+
+      def title(value)
+        @document.title = value
+      end
+
+      def version(value)
+        @document.version = value
+      end
+
+      def description(value)
+        @document.description = value
+      end
+
+      def host(value)
+        @document.host = value
+      end
+
+      def schemes(*values)
+        @document.schemes = values
+      end
+
+      # Operations
+
+      %w( ANY DELETE GET OPTIONS PATCH POST PUT ).each do |method|
+        class_eval <<-END_OF_RUBY, __FILE__, __LINE__ + 1
+          def #{method}(path, **options, &block)
+            @document.operations << Operation.new(context, "#{method}", path, **options, &block)
+          end
+        END_OF_RUBY
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/dsl/integration_node.rb

@@ -0,0 +1,32 @@
+module APIGatewayDSL
+  module DSL
+    class IntegrationNode < BasicObject
+
+      def initialize(integration, &block)
+        @integration = integration
+        instance_eval(&block) if block
+      end
+
+      # Parameter Mappings
+
+      def path(name, source = nil)
+        @integration.mappings << Mapping.new('integration', 'request', 'path', name, source)
+      end
+
+      def query(name, source = nil)
+        @integration.mappings << Mapping.new('integration', 'request', 'query', name, source)
+      end
+
+      def header(name, source = nil)
+        @integration.mappings << Mapping.new('integration', 'request', 'header', name, source)
+      end
+
+      # Templates
+
+      def body(**options)
+        @integration.templates << Template.new(@integration.context, **options)
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/dsl/operation_node.rb

@@ -0,0 +1,66 @@
+module APIGatewayDSL
+  module DSL
+    class OperationNode < BasicObject
+
+      def initialize(operation, &block)
+        @operation = operation
+        instance_eval(&block) if block
+      end
+
+      # General
+
+      def summary(value)
+        @operation.summary = value
+      end
+
+      def description(value)
+        @operation.description = value
+      end
+
+      # Parameters
+
+      def path(name, **options)
+        @operation.parameters << Parameter::Path.new(name, **options)
+      end
+
+      def query(name, **options)
+        @operation.parameters << Parameter::Query.new(name, **options)
+      end
+
+      def header(name, **options)
+        @operation.parameters << Parameter::Header.new(name, **options)
+      end
+
+      # Integrations
+
+      %w( ANY DELETE GET OPTIONS PATCH POST PUT ).each do |method|
+        class_eval <<-END_OF_RUBY, __FILE__, __LINE__ + 1
+
+          def HTTP_#{method}(url, **options, &block)
+            @operation.integrations << Integration::HTTP.new(@operation, "#{method}", url, **options, &block)
+          end
+
+          def HTTP_PROXY_#{method}(url, **options, &block)
+            @operation.integrations << Integration::HTTPProxy.new(@operation, "#{method}", url, **options, &block)
+          end
+
+        END_OF_RUBY
+      end
+
+      def LAMBDA(lambda_arn, **options, &block) # rubocop:disable Style/MethodName
+        @operation.integrations << Integration::Lambda.new(@operation, lambda_arn, **options, &block)
+      end
+
+      def MOCK(status_code, **options) # rubocop:disable Style/MethodName
+        @operation.integrations << Integration::Mock.new(@operation, status_code, **options)
+      end
+
+      # Responses
+
+      def RESPONSE(status_code, regexp = nil, &block) # rubocop:disable Style/MethodName
+        @operation.responses << Response.new(@operation, status_code, regexp, &block)
+      end
+
+    end
+  end
+end

data/lib/api_gateway_dsl/dsl/response_node.rb

@@ -0,0 +1,24 @@
+module APIGatewayDSL
+  module DSL
+    class ResponseNode < BasicObject
+
+      def initialize(response, &block)
+        @response = response
+        instance_eval(&block) if block
+      end
+
+      # Header Mappings
+
+      def header(name, source = nil)
+        @response.mappings << Mapping.new('method', 'response', 'header', name, source)
+      end
+
+      # Templates
+
+      def body(**options)
+        @response.templates << Template.new(@response.context, **options)
+      end
+
+    end
+  end
+end