lambda_open_api 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c565a700e0bceffbac7749e3dda568cc957a12134d132ee24ec5c525851f394
-  data.tar.gz: 8a478edc71b50c63a18654c66ad577f1454565d2f5699eeb1b0337e108c3f73e
+  metadata.gz: 829f0a399f63ee1437bc2610fe834e5dde1d7748f5cba35a453015af14320b61
+  data.tar.gz: d0f6ee7fa8f5bf0248074e0d1437bb628c80951f16e4b190fe5630039f033058
 SHA512:
-  metadata.gz: 88788828d826014db9639e1e0525185e3a626ce8c645195a24211d03974bcd4dbccb85f4faa3d3347fe2c864b40ef46f6e92dfbcfffce64b7e8e90f9630fc5d1
-  data.tar.gz: ca67c4eb57ea54bc37f0e90c1a5c38c2f8925600a999b33e618430733901dcfae221e33f06c580f813a49cd8f4a0f53dfd7cfe8037abe755e0945c0e099a8f7e
+  metadata.gz: '09b5dedbebbcef578ef0763ddf8d683a318f44e4695844719b853043dbc7302c1fb0a8ab532b993d6806fee8f51997d6eec4ed768304d9d87b1fdf331ad7fc53'
+  data.tar.gz: '0831a372977b701c2602f33b75796178e1c324b4ee761b96e4aef4eb30d4218045011a0af29efae70e016f0ae825787fd45b4a5bb2a23264ba108a23c11396ef'

data/README.md

@@ -1,22 +1,191 @@
 # 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
+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. 
 
 ## 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
+Add to your gem file:
+```ruby
+group :test do
+  gem 'rspec'
+  gem 'lambda_open_api'
+end
+```
+    
+Create an initializer file to configure the gem. 
+```ruby
+LambdaOpenApi.configure do |config|
+  config.file_name = "open_api.json"
+  config.title = "My Example Api"
+  config.description = "About this api"
+  config.version = "1"
+  config.host = "https://my_example_api.com"
+  config.schemes = ["https"]
+  config.consumes = ["application/json"] 
+  config.produces = ["application/json"]
+end
+```
+
+Include the gem in your spec hepler file `spec/spec_helper.rb` or any file that gets loaded before rspec is ran. 
+```ruby
+require "lambda_open_api"
+
+RSpec.configure do |config|
+  # ...
+  # the rest of your normal config
+  #...
+end
+```
+
+That's it!
 
 ## Usage
 
-TODO: Write usage instructions here
+Let's say we have a lmabda that looks something like this.
+```ruby
+require_relative '../spec_helper'
+
+class MyLambda
+  def self.process(event:, context: {})
+    body = JSON.parse(event["body"])
+
+    # do something useful
+
+    {
+      statusCode: 200,
+      body: { message: "processed", name: body["name"], email: body["email"] }
+    }
+  end
+end
+```
+
+We can write a spec file like this:
+
+```ruby
+RSpec.describe MyLambda do
+
+  resource "Users" do
+
+    get "users/{id}" do
+      path_summery "Some very high level details"
+      path_description "Some more details about this path"
+
+      example_case "200" do
+        parameter({id: 1})
+
+        event_body({
+          name: "Timbo Baggins",
+          email: "tbaggings@hotmail.com"
+        }.to_json)
+
+        event_headers({
+          "Api-Key" => "the_api_key"
+        })
+
+        run_example do
+          expect(lambda_response[:body]).to eq({:message => "processed", :email=>"tbaggings@hotmail.com", :name=>"Timbo Baggins"})
+          expect(lambda_response[:statusCode]).to eq(200)
+        end
+      end
+    end
+
+  end
+end
+```
+
+Run rspec 
+```bash
+rspec
+```
+
+An Open Api file will be generated and saved that looks like this:
+```json
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "My Example Api",
+    "description": "About this api",
+    "version": "1"
+  },
+  "host": "https://my_example.com",
+  "schemes": [
+    "https"
+  ],
+  "consumes": [
+    "application/json"
+  ],
+  "produces": [
+    "application/json"
+  ],
+  "paths": {
+    "users/{id}": {
+      "get": {
+        "tags": [
+          "Users"
+        ],
+        "summary": "Some very high level details",
+        "description": "Some more details about this path",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "",
+            "required": true,
+            "type": "integer"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "description": "",
+            "required": false,
+            "schema": {
+              "description": "",
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "email": {
+                  "type": "string"
+                }
+              },
+              "required": [
+
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "examples": {
+              "application/json": {
+                "statusCode": 200,
+                "body": {
+                  "message": "processed",
+                  "name": "Timbo Baggins",
+                  "email": "tbaggings@hotmail.com"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+```
+
+From https://editor-next.swagger.io/
+<img width="853" alt="Screen Shot 2023-01-30 at 9 42 18 AM" src="https://user-images.githubusercontent.com/9610694/215508235-c0edfadb-6df1-4cc5-83ef-43fdecc9dc34.png">
+
+<img width="851" alt="Screen Shot 2023-01-30 at 9 42 04 AM" src="https://user-images.githubusercontent.com/9610694/215508248-b852cff0-2bf3-40ae-a601-43c0e6173831.png">
 
 ## Development
 
@@ -26,7 +195,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lambda_open_api.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Timothyjb/lambda_open_api.
 
 ## License
 

data/lib/lambda_open_api/builder.rb

@@ -50,7 +50,7 @@ module LambdaOpenApi
     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}
+      @event.request_context = {"httpMethod" => verb.upcase}
 
       yield
 
@@ -65,14 +65,12 @@ module LambdaOpenApi
     end
 
     def run_example(test_name=nil, &block)
-      lambda_response_value = invoke_lambda
-      @action.set_response(lambda_response_value)
+      klass = create_class
 
       it "#{test_name || @action.path_name}" do
-        @lambda_response_value = lambda_response_value
-
+        @klass = klass
         def lambda_response
-          @lambda_response_value
+          @lambda_response ||= @klass.invoke
         end
 
         instance_eval &block
@@ -99,6 +97,33 @@ module LambdaOpenApi
       OpenStruct.new(aws_request_id: "123")
     end
 
+    def create_class
+      dynamic_name = "ClassName#{rand(10000)}"
+      klass = Object.const_set(dynamic_name, Class.new do
+        def self.set_event(event)
+          @event = event
+        end
+
+        def self.event
+          @event
+        end
+
+        def self.set_described_class(klass)
+          @klass = klass
+        end
+
+        def self.invoke
+          invokcation = LambdaOpenApi::Invoker.new(klass: @klass, method: "process", event: @event.json, context: OpenStruct.new(aws_request_id: "123"))
+
+          invokcation.response_body
+        end
+      end)
+
+      klass.set_event(@event)
+      klass.set_described_class(described_class)
+      klass
+    end
+
   end
 end
 

data/lib/lambda_open_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lambda_open_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Timothyjb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest