macaw_framework 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20f895377b3f0eea2494e091fab22b81734f6625d840ed2414c557db4db29ac2
+  data.tar.gz: 0ce55bbbbb41a5da4ab1622c72ced7300bfc4cb8b75091702fffb21822415ce2
+SHA512:
+  metadata.gz: 033b20344e924fb6cf66a75df40dd18fcee89967738392529b7f6dbab02e7301af275156d81a5601222428a03ae9796af751b048ab09632debfe87fcc5c86516
+  data.tar.gz: c2c09a27334e8904f2b7e714a6ac71df95140fe7e088ddcf23e71a29a125c0cc72cce2395939ce18d2e5ebb3998fb28c8a8a0a912de99c9e070004a0b78483a9

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+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.
+
+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.
+
+## Scope
+
+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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at aria.diniz.dev@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**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.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**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.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**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.
+
+### 4. Permanent Ban
+
+**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.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in macaw_framework.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Aria Diniz
+
+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,62 @@
+# MacawFramework
+
+This is a framework for developing web applications. Please have in mind that this is still a work in progress and
+it is strongly advised to not use it for production purposes for now. Anyone who wishes to contribute is welcome.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add macaw_framework
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install macaw_framework
+
+## Usage
+
+The usage of the framework still very simple. Actually it support 5 HTTP verbs: GET, POST, PUT, PATCH and DELETE.
+For now, the framework can't resolve client request body and headers. The support for this will be included soon.
+
+The default server port is 8080. To choose a different port, create a file with the name `application.json` 
+in the same directory of the script that will start the application with the following content:
+
+```json
+{
+  "macaw": {
+    "port": 80
+  }
+}
+```
+
+Example of usage:
+
+```ruby
+require 'macaw_framework'
+require 'json'
+
+m = Macaw.new
+
+m.get('/hello_world') do
+  return JSON.pretty_generate({ hello_message: 'Hello World!' }), 200
+end
+
+m.start!
+```
+
+The above example will start a server and will create a GET endpoint at localhost/hello_world.
+
+The verb methods must always return a String or nil (Used as response) and a number corresponding the 
+HTTP Status Code to be returned to the client.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ariasdiniz/macaw_framework. 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/ariasdiniz/macaw_framework/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MacawFramework project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ariasdiniz/macaw_framework/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/macaw_framework/endpoint_not_mapped_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+##
+# Error raised when the client calls
+# for a path that doesn't exist.
+class EndpointNotMappedError < StandardError
+  def initialize(msg = 'Undefined endpoint')
+    super
+  end
+end

data/lib/macaw_framework/http_status_code.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+##
+# Module containing a map for HTTP Status Codes
+# and their respective messages.
+module HttpStatusCode
+  ##
+  # Http Status Code Map
+  HTTP_STATUS_CODE_MAP = {
+    100 => 'Continue',
+    101 => 'Switching Protocols',
+    102 => 'Processing',
+    103 => 'Early Hints',
+    200 => 'OK',
+    201 => 'Created',
+    202 => 'Accepted',
+    203 => 'Non-Authoritative Information',
+    204 => 'No Content',
+    205 => 'Reset Content',
+    206 => 'Partial Content',
+    207 => 'Multi-Status',
+    208 => 'Already Reported',
+    226 => 'IM Used',
+    300 => 'Multiple Choices',
+    301 => 'Moved Permanently',
+    302 => 'Found',
+    303 => 'See Other',
+    304 => 'Not Modified',
+    305 => 'Use Proxy',
+    307 => 'Temporary Redirect',
+    308 => 'Permanent Redirect',
+    400 => 'Bad Request',
+    401 => 'Unauthorized',
+    402 => 'Payment Required',
+    403 => 'Forbidden',
+    404 => 'Not Found',
+    405 => 'Method Not Allowed',
+    406 => 'Not Acceptable',
+    407 => 'Proxy Authentication Required',
+    408 => 'Request Timeout',
+    409 => 'Conflict',
+    410 => 'Gone',
+    411 => 'Length Required',
+    412 => 'Precondition Failed',
+    413 => 'Content Too Large',
+    414 => 'URI Too Long',
+    415 => 'Unsupported Media Type',
+    416 => 'Range Not Satisfiable',
+    417 => 'Expectation Failed',
+    421 => 'Misdirected Request',
+    422 => 'Unprocessable Content',
+    423 => 'Locked',
+    424 => 'Failed Dependency',
+    425 => 'Too Early',
+    426 => 'Upgrade Required',
+    427 => 'Unassigned',
+    428 => 'Precondition Required',
+    429 => 'Too Many Requests',
+    430 => 'Unassigned',
+    431 => 'Request Header Fields Too Large',
+    451 => 'Unavailable For Legal Reasons',
+    500 => 'Internal Server Error',
+    501 => 'Not Implemented',
+    502 => 'Bad Gateway',
+    503 => 'Service Unavailable',
+    504 => 'Gateway Timeout',
+    505 => 'HTTP Version Not Supported',
+    506 => 'Variant Also Negotiates',
+    507 => 'Insufficient Storage',
+    508 => 'Loop Detected',
+    509 => 'Unassigned',
+    510 => 'Not Extended (OBSOLETED)',
+    511 => 'Network Authentication Required'
+  }.freeze
+end

data/lib/macaw_framework/version.rb

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

data/lib/macaw_framework.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require_relative 'macaw_framework/endpoint_not_mapped_error'
+require_relative 'macaw_framework/http_status_code'
+require_relative 'macaw_framework/version'
+require 'socket'
+require 'json'
+
+module MacawFramework
+  ##
+  # Class responsible for creating endpoints and
+  # starting the web server.
+  class Macaw
+    include(HttpStatusCode)
+    def initialize
+      begin
+        config = JSON.parse(File.read('application.json'))
+        @port = config['macaw']['port']
+      rescue StandardError
+        @port ||= 8080
+      end
+      @port ||= 8080
+    end
+
+    ##
+    # Creates a GET endpoint associated
+    # with the respective path.
+    # @param {String} path
+    # @param {Proc} block
+    # @return {Integer, String}
+    def get(path, &block)
+      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
+      define_singleton_method("get_#{path_clean}", block)
+    end
+
+    ##
+    # Creates a POST endpoint associated
+    # with the respective path.
+    # @param {String} path
+    # @param {Proc} block
+    # @return {String, Integer}
+    def post(path, &block)
+      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
+      define_singleton_method("post_#{path_clean}", block)
+    end
+
+    ##
+    # Creates a PUT endpoint associated
+    # with the respective path.
+    # @param {String} path
+    # @param {Proc} block
+    # @return {String, Integer}
+    def put(path, &block)
+      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
+      define_singleton_method("put_#{path_clean}", block)
+    end
+
+    ##
+    # Creates a PATCH endpoint associated
+    # with the respective path.
+    # @param {String} path
+    # @param {Proc} block
+    # @return {String, Integer}
+    def patch(path, &block)
+      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
+      define_singleton_method("patch_#{path_clean}", block)
+    end
+
+    ##
+    # Creates a DELETE endpoint associated
+    # with the respective path.
+    # @param {String} path
+    # @param {Proc} block
+    # @return {String, Integer}
+    def delete(path, &block)
+      path_clean = path[0] == '/' ? path[1..].gsub('/', '_') : path.gsub('/', '_')
+      define_singleton_method("delete_#{path_clean}", block)
+    end
+
+    ##
+    # Starts the web server
+    def start!
+      server = TCPServer.open(@port)
+      puts "Starting server at port #{@port}"
+      loop do
+        Thread.start(server.accept) do |client|
+          method_name = extract_client_info(client)
+          raise EndpointNotMappedError unless respond_to?(method_name)
+
+          message, status = send(method_name)
+          status ||= 200
+          message ||= 'Ok'
+          client.puts "HTTP/1.1 #{status} #{HTTP_STATUS_CODE_MAP[status]} \r\n\r\n#{message}"
+          client.close
+        rescue EndpointNotMappedError
+          client.print "HTTP/1.1 404 Not Found\r\n\r\n"
+          client.close
+        rescue StandardError
+          client.print "HTTP/1.1 500 Internal Server Error\r\n\r\n"
+          client.close
+        end
+      end
+    end
+
+    private
+
+    ##
+    # Method for extracting headers and body from client request
+    # STILL IN DEVELOPMENT
+    # @todo finish implementation
+    def extract_client_info(client)
+      method_name = client.gets.gsub('HTTP/1.1', '').gsub('/', '_').strip!.downcase
+      method_name.gsub!(' ', '')
+      method_name
+    end
+  end
+end

data/sig/macaw_framework/macaw.rbs

@@ -0,0 +1,21 @@
+module MacawFramework
+  class Macaw
+    @port: int
+
+    def delete: -> nil
+
+    def get: -> nil
+
+    def patch: -> nil
+
+    def post: -> nil
+
+    def put: -> nil
+
+    def start!: -> nil
+
+    private
+
+    def extract_client_info: -> nil
+  end
+end

data/sig/macaw_framework.rbs

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

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: macaw_framework
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aria Diniz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-06 00:00:00.000000000 Z
+dependencies: []
+description: A project started for study purpose that I intend to keep working on.
+email:
+- aria.diniz.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/macaw_framework.rb
+- lib/macaw_framework/endpoint_not_mapped_error.rb
+- lib/macaw_framework/http_status_code.rb
+- lib/macaw_framework/version.rb
+- sig/macaw_framework.rbs
+- sig/macaw_framework/macaw.rbs
+homepage: https://github.com/ariasdiniz/macaw_framework
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ariasdiniz/macaw_framework
+  source_code_uri: https://github.com/ariasdiniz/macaw_framework
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: A web framework still in development.
+test_files: []