lambda_open_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c565a700e0bceffbac7749e3dda568cc957a12134d132ee24ec5c525851f394
+  data.tar.gz: 8a478edc71b50c63a18654c66ad577f1454565d2f5699eeb1b0337e108c3f73e
+SHA512:
+  metadata.gz: 88788828d826014db9639e1e0525185e3a626ce8c645195a24211d03974bcd4dbccb85f4faa3d3347fe2c864b40ef46f6e92dfbcfffce64b7e8e90f9630fc5d1
+  data.tar.gz: ca67c4eb57ea54bc37f0e90c1a5c38c2f8925600a999b33e618430733901dcfae221e33f06c580f813a49cd8f4a0f53dfd7cfe8037abe755e0945c0e099a8f7e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lambda_open_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    lambda_open_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    diff-lcs (1.5.0)
+    minitest (5.16.3)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby-progressbar (1.11.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  lambda_open_api!
+  minitest
+  minitest-reporters
+  rake (~> 13.0)
+  rspec
+
+BUNDLED WITH
+   2.3.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Tim
+
+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,33 @@
+# LambdaOpenApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lambda_open_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add lambda_open_api
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install lambda_open_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lambda_open_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/lambda_open_api.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/lambda_open_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "lambda_open_api"
+  spec.version = LambdaOpenApi::VERSION
+  spec.authors = ["Timothyjb"]
+  spec.email = ["timothyjbarkley@gmail.com"]
+
+  spec.summary = "A DSL for generating OpenAPI (swagger) files for APIs using AWS Lambda"
+  spec.description = "This gem is a light weight DSL that works with rspec to allow developers to generate an OpenAPI (swagger) file based an AWS Lambda invoked by API Gateway. It works by writing a simple unit test for your lambda's code. When the test is executed, the input event and returned response are captured and used to build an OpenAPI file."
+  spec.homepage = "https://github.com/Timothyjb/lambda_open_api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Timothyjb/lambda_open_api"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "rspec"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/lambda_open_api/action.rb

@@ -0,0 +1,62 @@
+require_relative "path_parameter"
+require_relative "body_parameter"
+require_relative "response"
+
+module LambdaOpenApi
+  class Action
+    PARAMATER_EXPRESION = /[:\{](\w+)\}?/
+
+    attr_accessor :method, :http_verb, :name, :param, :path_name, :parameters, :responses, :code, :description, :summery
+
+    def initialize(name:, http_verb:, path_name:)
+      @responses = {}
+      @parameters = []
+      @name = name
+      @http_verb = http_verb
+      @path_name = path_name
+
+      interpolate_path_paramater
+    end
+
+    def interpolate_path_paramater
+      matches = @path_name.scan PARAMATER_EXPRESION
+
+      return unless matches.any?
+
+      matches.flatten.each do |match|
+        @parameters << LambdaOpenApi::PathParameter.new(name: match).json
+      end
+    end
+
+    def set_request_body(data)
+      @parameters << LambdaOpenApi::BodyParameter.new(data).json
+    end
+
+    def set_response(data)
+      @responses["200"] = LambdaOpenApi::Response.new(data).json
+    end
+
+    def action_json
+      {
+        "tags"=> [titleize(@name)],
+        "summary"=> @summery,
+        "description"=> @description,
+        "consumes"=> [
+          "application/json"
+        ],
+        "produces"=> [
+          "application/json"
+        ],
+        "parameters" => @parameters,
+        "responses" => @responses
+      }
+    end
+
+
+    def titleize(string)
+      string.to_s.split("_").map{|word| word.capitalize}.join(" ")
+    end
+
+  end
+
+end

data/lib/lambda_open_api/body_parameter.rb

@@ -0,0 +1,38 @@
+require_relative "body_property.rb"
+
+module LambdaOpenApi
+  class BodyParameter
+    attr_accessor :data
+
+    def initialize(data = nil, file_name: nil)
+      @file_name = file_name
+
+      @data = data
+      if data.nil? && File.exists?("lib/lambda_open_api/examples/requests/#{file_name}.json")
+        json = File.open("lib/lambda_open_api/examples/requests/#{file_name}.json").read
+        @data = JSON.parse(json)
+      end
+    end
+
+    def json
+      hash = LambdaOpenApi::BodyProperty.new
+      hash.generate(@data)
+      {
+        "name"=> "body",
+        "in"=> "body",
+        "description"=> "",
+        "required"=> false,
+        "schema"=> {
+          "description"=> "",
+          "type"=> "object",
+          "properties"=> hash.props,
+          "required"=> []
+        }
+      }
+    end
+
+  end
+end
+
+
+

data/lib/lambda_open_api/body_property.rb

@@ -0,0 +1,35 @@
+module LambdaOpenApi
+  class BodyProperty
+
+    attr_accessor :props
+
+    def generate(hash)
+      @props = {}
+
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          hash = LambdaOpenApi::BodyProperty.new
+          hash.generate(value)
+
+          props[key.to_s] = {
+            "type"=>  "object",
+            "properties"=> hash.props
+          }
+        else
+          props[key.to_s] = {
+            "type"=>  value_type(value)
+          }
+        end
+      end
+    end
+
+    def value_type(value)
+      klass = value.class.name.downcase
+      return "boolean" if klass == "trueclass" || klass == "falseclass"
+      klass
+    end
+
+  end
+end
+
+

data/lib/lambda_open_api/builder.rb

@@ -0,0 +1,105 @@
+require "rspec"
+require_relative "action"
+require_relative "event"
+
+module LambdaOpenApi
+  module Builder
+    attr_accessor :actions, :name, :default_event_hash
+
+    CRUD_VERBS = [:get, :put, :post, :delete]
+
+    def resource(name)
+      @actions = []
+      @default_event = LambdaOpenApi::Event.new
+      @name = name
+
+      yield
+
+      actions.each do |request|
+        LambdaOpenApi::Formatter.add_request(request)
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if CRUD_VERBS.include?(method)
+        crud_verb(method.to_s, args.first, &block)
+        return
+      end
+
+      if method.to_s.start_with?("event")
+        variable = method.to_s.sub("event_", "")
+        return @event.send("#{variable}=", args.first)
+      end
+
+      if method.to_s.start_with?("default_event")
+        variable = method.to_s.sub("default_event_", "")
+        return @default_event.send("#{variable}=", args.first)
+      end
+
+      if method.to_s.start_with?("path")
+        string = method.to_s.sub("path_", "")
+        if @action.respond_to?(string)
+          return @action.send("#{string}=", args.first)
+        end
+      end
+
+      raise NameError.new("NameError (undefined local variable or method `#{method}' for #{self})")
+    end
+
+    # get, put, post, delete
+    def crud_verb(verb, path)
+      @action = LambdaOpenApi::Action.new(name: @name, http_verb: verb, path_name: path)
+      @event = @default_event.dup
+      @event.request_context = {"httpMethod": verb.upcase}
+
+      yield
+
+      @action.set_request_body(JSON.parse(@event.body))
+      actions << @action
+    end
+
+    def example_case(code)
+      @action.code = code
+
+      yield
+    end
+
+    def run_example(test_name=nil, &block)
+      lambda_response_value = invoke_lambda
+      @action.set_response(lambda_response_value)
+
+      it "#{test_name || @action.path_name}" do
+        @lambda_response_value = lambda_response_value
+
+        def lambda_response
+          @lambda_response_value
+        end
+
+        instance_eval &block
+      end
+    end
+
+
+    def parameter(hash)
+      path = @action.path_name.dup
+      @event.resource = path.gsub(LambdaOpenApi::Action::PARAMATER_EXPRESION) {|match|
+        match = hash[match.delete('{}:').to_sym]
+      }
+    end
+
+    def invoke_lambda
+      parameter({}) if @event.resource.nil?
+
+      invokcation = LambdaOpenApi::Invoker.new(klass: described_class, method: "process", event: @event.json, context: lambda_context)
+
+      invokcation.response_body
+    end
+
+    def lambda_context
+      OpenStruct.new(aws_request_id: "123")
+    end
+
+  end
+end
+
+

data/lib/lambda_open_api/configuration.rb

@@ -0,0 +1,16 @@
+module LambdaOpenApi
+  class Configuration
+    attr_accessor :file_name, :title, :description, :version, :host, :schemes, :consumes, :produces
+
+    def initialize
+      @file_name = "open_api.json"
+      @title = "Workflow Settings Api"
+      @description = "About this api"
+      @version = "1"
+      @host = "https://google.com"
+      @schemes = ["https"]
+      @consumes = ["application/json"]
+      @produces = ["application/json"]
+    end
+  end
+end

data/lib/lambda_open_api/event.rb

@@ -0,0 +1,33 @@
+module LambdaOpenApi
+  class Event
+    attr_accessor :resource,
+                  :path,
+                  :http_method,
+                  :request_context,
+                  :headers,
+                  :multi_value_headers,
+                  :query_string_parameters,
+                  :multi_value_query_string_parameters,
+                  :path_parameters,
+                  :stage_variables,
+                  :body,
+                  :is_base64_encoded
+
+    def json
+      {
+        "resource" => resource,
+        "path" => path,
+        "httpMethod" => http_method,
+        "requestContext" => request_context,
+        "headers" => headers,
+        "multiValueHeaders" => multi_value_headers,
+        "queryStringParameters" => query_string_parameters,
+        "multiValueQueryStringParameters" => multi_value_query_string_parameters,
+        "pathParameters" => path_parameters,
+        "stageVariables" => stage_variables,
+        "body" => body,
+        "isBase64Encoded" => is_base64_encoded
+      }
+    end
+  end
+end

data/lib/lambda_open_api/formatter.rb

@@ -0,0 +1,34 @@
+
+module LambdaOpenApi
+  class Formatter
+    @paths = {}
+
+    class << self
+      def add_request(resource)
+        @paths[resource.path_name] ||= {}
+        @paths[resource.path_name][resource.http_verb] = resource.action_json
+      end
+
+      def generate_docs
+        open_api = high_level.merge({"paths" => @paths})
+
+        File.open(LambdaOpenApi.configuration.file_name, "w") {|f| f.write(JSON.pretty_generate(open_api) + "\n") }
+      end
+
+      def high_level
+        {
+          "swagger" => "2.0",
+          "info" => {
+            "title" => LambdaOpenApi.configuration.title,
+            "description" => LambdaOpenApi.configuration.description,
+            "version" => LambdaOpenApi.configuration.version
+          },
+          "host" => LambdaOpenApi.configuration.host,
+          "schemes" => LambdaOpenApi.configuration.schemes,
+          "consumes" => LambdaOpenApi.configuration.consumes,
+          "produces" => LambdaOpenApi.configuration.produces
+        }
+      end
+    end
+  end
+end

data/lib/lambda_open_api/invoker.rb

@@ -0,0 +1,15 @@
+module LambdaOpenApi
+  class Invoker
+
+    attr_accessor :response
+
+    def initialize(klass:, method:, event:, context:)
+      @response = klass.send(method || "process", event: event, context: context)
+    end
+
+    def response_body
+      response["body"] || response
+    end
+
+  end
+end

data/lib/lambda_open_api/path_parameter.rb

@@ -0,0 +1,22 @@
+module LambdaOpenApi
+  class PathParameter
+    attr_accessor :name, :in, :description, :required, :type
+
+    def initialize(name: nil)
+      @name = name
+    end
+
+    def json
+      {
+        "name"=> @name || "id",
+        "in"=> @in || "path",
+        "description"=> @description || "",
+        "required"=> @required || true,
+        "type"=> @type || "integer"
+      }
+    end
+  end
+end
+
+
+

data/lib/lambda_open_api/response.rb

@@ -0,0 +1,22 @@
+module LambdaOpenApi
+  class Response
+    attr_accessor :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def json
+      {
+        "examples": {
+          "application/json": @data
+        }
+      }
+    end
+  end
+end
+
+
+
+
+

data/lib/lambda_open_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LambdaOpenApi
+  VERSION = "0.1.0"
+end

data/lib/lambda_open_api.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require "json"
+
+require_relative "lambda_open_api/formatter"
+require_relative "lambda_open_api/version"
+require_relative "lambda_open_api/configuration"
+require_relative "lambda_open_api/builder"
+require_relative "lambda_open_api/invoker"
+
+module LambdaOpenApi
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end
+
+
+# Monkey patching
+
+module LambdaOpenApiNotification
+  def fully_formatted(colorizer=::RSpec::Core::Formatters::ConsoleCodes)
+    LambdaOpenApi::Formatter.generate_docs unless failure_count > 0 || errors_outside_of_examples_count > 0
+    super
+  end
+end
+
+RSpec::Core::Notifications::SummaryNotification.prepend(LambdaOpenApiNotification)
+RSpec::Core::ExampleGroup.extend(LambdaOpenApi::Builder)

data/sig/lambda_open_api.rbs

@@ -0,0 +1,4 @@
+module LambdaOpenApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: lambda_open_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timothyjb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a light weight DSL that works with rspec to allow developers
+  to generate an OpenAPI (swagger) file based an AWS Lambda invoked by API Gateway.
+  It works by writing a simple unit test for your lambda's code. When the test is
+  executed, the input event and returned response are captured and used to build an
+  OpenAPI file.
+email:
+- timothyjbarkley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lambda_open_api.gemspec
+- lib/lambda_open_api.rb
+- lib/lambda_open_api/action.rb
+- lib/lambda_open_api/body_parameter.rb
+- lib/lambda_open_api/body_property.rb
+- lib/lambda_open_api/builder.rb
+- lib/lambda_open_api/configuration.rb
+- lib/lambda_open_api/event.rb
+- lib/lambda_open_api/formatter.rb
+- lib/lambda_open_api/invoker.rb
+- lib/lambda_open_api/path_parameter.rb
+- lib/lambda_open_api/response.rb
+- lib/lambda_open_api/version.rb
+- sig/lambda_open_api.rbs
+homepage: https://github.com/Timothyjb/lambda_open_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Timothyjb/lambda_open_api
+  source_code_uri: https://github.com/Timothyjb/lambda_open_api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A DSL for generating OpenAPI (swagger) files for APIs using AWS Lambda
+test_files: []