srack 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f202081833c00ca8d5204dcb2999a6a9156403bf73b7dc5a2f315f989995b18c
4
+ data.tar.gz: 37a500426bc460b58b4e2636f4ebafe6b09f709b1caebec9de0c713850b2fd54
5
+ SHA512:
6
+ metadata.gz: f797dbc99211d6e09d92b611b51e77e81a51924c36e3d2bfa6ed7fa570c552925e5b03f9f1b8bd8151e8d09ef876fef79d88d3c0ba385368e7eb4ebb1a9978aa
7
+ data.tar.gz: 17fb71ffa5ae165f138e871a7acabe672c2c621f5f909a4a598193a6d252228ecfc50c9e69306cd567c532819401627d3a74d974658d2f87d31fe12e1e89e532
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.standard.yml ADDED
@@ -0,0 +1,7 @@
1
+ # For available configuration options, see:
2
+ # https://github.com/testdouble/standard
3
+ ruby_version: 2.6
4
+
5
+ ignore:
6
+ - 'lib/**/*':
7
+ - Lint/RescueException
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2024-03-13
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at miguel@miguel.cc. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 Miguel Landaeta
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,58 @@
1
+ # SRack
2
+
3
+ Hacky serverless function Rack handler to enable Sinatra apps in AWS Lambda.
4
+
5
+ Based on [aws-samples/serverless-sinatra-sample](https://github.com/aws-samples/serverless-sinatra-sample)
6
+
7
+ ## Installation
8
+
9
+ Add the following line to your `Gemfile`:
10
+
11
+ ```ruby
12
+ gem "srack"
13
+ ```
14
+
15
+ Or just `gem install srack`.
16
+
17
+
18
+ ## Usage
19
+
20
+ Define your AWS Lambda function handler as the following:
21
+
22
+ ```ruby
23
+ require 'srack'
24
+
25
+ RACK_APP_CONFIG = "#{__dir__}/app/config.ru"
26
+
27
+ # Global object that responds to the call method. Stay outside of the handler
28
+ # to take advantage of container reuse
29
+ $app ||= Rack::Builder.parse_file(RACK_APP_CONFIG)
30
+ ENV['RACK_ENV'] ||= 'production'
31
+
32
+ def handler(event:, context:)
33
+ SRack::AWSLambdaHandler
34
+ .new($app)
35
+ .handle(event: event,
36
+ context: context)
37
+ end
38
+ ```
39
+
40
+ Then create a deployment zip with your AWS Lambda function and its dependencies.
41
+
42
+ ## Development
43
+
44
+ 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.
45
+
46
+ 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).
47
+
48
+ ## Contributing
49
+
50
+ Bug reports and pull requests are welcome on GitHub at https://github.com/nomadium/srack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nomadium/srack/blob/master/CODE_OF_CONDUCT.md).
51
+
52
+ ## License
53
+
54
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
55
+
56
+ ## Code of Conduct
57
+
58
+ Everyone interacting in the SRack project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nomadium/srack/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "standard/rake"
9
+
10
+ task default: %i[spec standard]
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SRack
4
+ VERSION = "0.1.0"
5
+ end
data/lib/srack.rb ADDED
@@ -0,0 +1,91 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+ require "rack"
5
+ require "base64"
6
+
7
+ require_relative "srack/version"
8
+
9
+ module SRack
10
+ class Error < StandardError; end
11
+
12
+ class AWSLambdaHandler
13
+ def initialize(rack_app)
14
+ @app = rack_app
15
+ end
16
+
17
+ def handle(event:, context:)
18
+ # Check if the body is base64 encoded. If it is, try to decode it
19
+ body = if event["isBase64Encoded"]
20
+ Base64.decode64 event["body"]
21
+ else
22
+ event["body"]
23
+ end || ""
24
+
25
+ # Rack expects the querystring in plain text, not a hash
26
+ headers = event.fetch "headers", {}
27
+
28
+ # Environment required by Rack (http://www.rubydoc.info/github/rack/rack/file/SPEC)
29
+ env = {
30
+ "REQUEST_METHOD" => event.fetch("requestContext").fetch("http").fetch("method"),
31
+ "SCRIPT_NAME" => "",
32
+ "PATH_INFO" => event.fetch("rawPath", ""),
33
+ # XXX: fix QUERY_STRING handling
34
+ "QUERY_STRING" => (event["queryStringParameters"] || {}).map { |k, v| "#{k}=#{v}" }.join("&"),
35
+ "SERVER_NAME" => headers.fetch("Host", "localhost"),
36
+ "SERVER_PORT" => headers.fetch("X-Forwarded-Port", 443).to_s,
37
+
38
+ "rack.version" => Rack::VERSION,
39
+ "rack.url_scheme" => headers.fetch("CloudFront-Forwarded-Proto") { headers.fetch("X-Forwarded-Proto", "https") },
40
+ "rack.input" => StringIO.new(body),
41
+ "rack.errors" => $stderr
42
+ }
43
+
44
+ # Pass request headers to Rack if they are available
45
+ headers.each_pair do |key, value|
46
+ # 'CloudFront-Forwarded-Proto' => 'CLOUDFRONT_FORWARDED_PROTO'
47
+ # Content-Type and Content-Length are handled specially per the Rack SPEC linked above.
48
+ name = key.upcase.tr "-", "_"
49
+ header = case name
50
+ when "CONTENT_TYPE", "CONTENT_LENGTH"
51
+ name
52
+ else
53
+ "HTTP_#{name}"
54
+ end
55
+ env[header] = value.to_s
56
+ end
57
+
58
+ begin
59
+ # Response from Rack must have status, headers and body
60
+ status, headers, body = @app.call env
61
+
62
+ # body is an array. We combine all the items to a single string
63
+ body_content = ""
64
+ body.each do |item|
65
+ body_content += item.to_s
66
+ end
67
+
68
+ # We return the structure required by AWS API Gateway since we integrate with it
69
+ # https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html
70
+ response = {
71
+ "statusCode" => status,
72
+ "headers" => headers,
73
+ "body" => body_content
74
+ }
75
+ if event["requestContext"].has_key?("elb")
76
+ # Required if we use Application Load Balancer instead of API Gateway
77
+ response["isBase64Encoded"] = false
78
+ end
79
+ rescue Exception => exception
80
+ # If there is _any_ exception, we return a 500 error with an error message
81
+ response = {
82
+ "statusCode" => 500,
83
+ "body" => exception.message
84
+ }
85
+ end
86
+
87
+ # By default, the response serializer will call #to_json for us
88
+ response
89
+ end
90
+ end
91
+ end
data/srack.gemspec ADDED
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/srack/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "srack"
7
+ spec.version = SRack::VERSION
8
+ spec.authors = ["Miguel Landaeta"]
9
+ spec.email = ["miguel@miguel.cc"]
10
+
11
+ spec.summary = "Ruby library to enable Sinatra apps to be run in AWS Lambda"
12
+ spec.homepage = "https://github.com/nomadium/srack"
13
+ spec.license = "MIT"
14
+ spec.required_ruby_version = ">= 2.6.0"
15
+
16
+ spec.metadata["homepage_uri"] = spec.homepage
17
+ spec.metadata["source_code_uri"] = spec.homepage
18
+ spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
19
+
20
+ # Specify which files should be added to the gem when it is released.
21
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
22
+ spec.files = Dir.chdir(__dir__) do
23
+ `git ls-files -z`.split("\x0").reject do |f|
24
+ (File.expand_path(f) == __FILE__) ||
25
+ f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
26
+ end
27
+ end
28
+ spec.bindir = "exe"
29
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
30
+ spec.require_paths = ["lib"]
31
+
32
+ # Uncomment to register a new dependency of your gem
33
+ spec.add_runtime_dependency "rack", "~> 3.0"
34
+ end
metadata ADDED
@@ -0,0 +1,70 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: srack
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Miguel Landaeta
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-03-13 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rack
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.0'
27
+ description:
28
+ email:
29
+ - miguel@miguel.cc
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - ".rspec"
35
+ - ".standard.yml"
36
+ - CHANGELOG.md
37
+ - CODE_OF_CONDUCT.md
38
+ - LICENSE.txt
39
+ - README.md
40
+ - Rakefile
41
+ - lib/srack.rb
42
+ - lib/srack/version.rb
43
+ - srack.gemspec
44
+ homepage: https://github.com/nomadium/srack
45
+ licenses:
46
+ - MIT
47
+ metadata:
48
+ homepage_uri: https://github.com/nomadium/srack
49
+ source_code_uri: https://github.com/nomadium/srack
50
+ changelog_uri: https://github.com/nomadium/srack/blob/master/CHANGELOG.md
51
+ post_install_message:
52
+ rdoc_options: []
53
+ require_paths:
54
+ - lib
55
+ required_ruby_version: !ruby/object:Gem::Requirement
56
+ requirements:
57
+ - - ">="
58
+ - !ruby/object:Gem::Version
59
+ version: 2.6.0
60
+ required_rubygems_version: !ruby/object:Gem::Requirement
61
+ requirements:
62
+ - - ">="
63
+ - !ruby/object:Gem::Version
64
+ version: '0'
65
+ requirements: []
66
+ rubygems_version: 3.4.19
67
+ signing_key:
68
+ specification_version: 4
69
+ summary: Ruby library to enable Sinatra apps to be run in AWS Lambda
70
+ test_files: []