simple_proxy 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e591a4ec1a9b51c3419c06ecc3c24d19ce3d3efb55a432f2c79b0fbf92579e10
+  data.tar.gz: c56bd93ef4f2b410d1c4050e6a00ae541fed6cdf664d04362b2d5c9c3711526f
+SHA512:
+  metadata.gz: b94faf3d47f1003ae8ff2386d689fa4791cd2140ad3ad8809bd6395c03bae307a52bc2ad9be4203d4bf802b3fc5874899a06862ba2ecdcd1a144f03903dba908
+  data.tar.gz: baf33ac3068006fdbc739dd131e995578f7942160dd5cdc06c8de879feeaba8b98bfb6a791d4f7c439908400a872adca454a5088c7199fde89fc28460e91f312

data/.rspec

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

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,18 @@
+# Changelog
+All notable changes to "simple_proxy" will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1] - 2023-09-24
+
+### Added
+- Initial release of the simple_proxy gem.
+- Basic proxy features using Sinatra and HTTParty.
+- Support for cross-origin resource sharing (CORS) with `Sinatra::CrossOrigin`.
+- GET, POST, PUT, HEAD and DELETE HTTP methods are now supported via '/proxy' endpoint.
+- Added the ability to proxy requests, with support for transferring headers and parameters.
+- Introduced a mechanism for starting and stopping the server using `self.run!` and `self.quit!` methods.
+- Configured the server to bind to '0.0.0.0' and listen on port 4567.
+
+[Unreleased]: https://github.com/your_username/simple_proxy/compare/v1.0.0...HEAD
+[1.0.1]: https://github.com/your_username/simple_proxy/releases/tag/v1.0.1

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 arjun.verma8412@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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Arjun Verma
+
+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,112 @@
+
+
+<div>
+  <img src="./assets/logo.png" alt="Simple Proxy Logo" width="50" style="border-radius: 16px; display:inline; vertical-align: middle;">
+  <h1 style="display:inline; vertical-align: middle; margin-left: 10px;">Simple Proxy</h1>
+</div> <br>
+
+
+[![Build Status](https://travis-ci.com/username/projectname.svg?branch=main)](https://travis-ci.com/username/projectname)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/simple_proxy.svg)](https://badge.fury.io/rb/simple_proxy)
+[![Downloads](https://img.shields.io/gem/dt/simple_proxy.svg)](https://rubygems.org/gems/simple_proxy)
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://rubydoc.info/github/Hetu-Labs/simple_proxy)
+
+**Simple Proxy** is a lightweight and easy-to-use proxy server built with Ruby, Sinatra, and HTTParty. It's designed to forward requests to specified target URLs, making it a versatile tool for developers working with APIs and web services.
+
+## Features
+
+- Supports GET, POST, and PUT HTTP methods.
+- Supports Cross-Origin Resource Sharing (CORS) with `Sinatra::CrossOrigin`.
+- Transfers headers and parameters to the target URL.
+- Provides mechanisms for starting and stopping the server.
+
+## Installation
+
+To install Simple Proxy, you can add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_proxy'
+```
+and then execute:
+
+```bash
+bundle install
+```
+
+or simply install it from the command line:
+
+```bash
+gem install simple_proxy
+```
+
+## Usage
+
+To use Simple Proxy, you can require it in your application:
+
+```ruby
+require 'simple_proxy'
+```
+
+#### Starting the Server
+To start the server:
+
+```ruby
+SimpleProxy.run!
+```
+
+#### Stopping the Server
+To stop the server:
+
+```ruby
+SimpleProxy.quit!
+```
+
+#### CLI
+You can also start or stop the server from the command line:
+
+```bash
+simple_proxy start
+```
+
+```bash
+simple_proxy stop
+```
+
+#### Proxying Requests
+To proxy requests, you can use the '/proxy' endpoint:
+
+```ruby
+get '/proxy' do
+  SimpleProxy.proxy(params, request)
+end
+```
+
+##### Making Proxy Requests
+Once the server is running, you can make proxy requests to the following endpoints:
+
+* GET /proxy?url=target_url
+* POST /proxy?url=target_url
+* PUT /proxy?url=target_url
+* HEAD /proxy?url=target_url
+* DELETE /proxy?url=target_url
+
+Replace target_url with the URL you want to proxy the request to.
+
+## Contributing
+Contributions are welcome! Please read our [Code of Conduct](https://github.com/Hetu-Labs/simple_proxy/blob/main/CODE_OF_CONDUCT.md) before contributing to help this project stay welcoming.
+
+* Fork it (https://github.com/Hetu-Labs/simple_proxy/fork)
+* Create your feature branch (git checkout -b feature/fooBar)
+* Commit your changes (git commit -am 'Add some fooBar')
+* Push to the branch (git push origin feature/fooBar)
+* Create a new Pull Request
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/Hetu-Labs/simple_proxy/blob/main/LICENSE.txt) file for details.
+
+## Code of Conduct
+Please note that this project is released with a Contributor [Code of Conduct](https://github.com/Hetu-Labs/simple_proxy/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
+
+## Changelog
+For all notable changes made to this project, see the [Changelog](https://github.com/Hetu-Labs/simple_proxy/blob/main/CHANGELOG.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/simple_proxy

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+require_relative '../lib/simple_proxy'
+
+command = ARGV.first
+pid_file = 'simple_proxy.pid'
+
+def server_running?(pid_file)
+  return false unless File.exist?(pid_file)
+
+  pid = File.read(pid_file).to_i
+  begin
+    Process.getpgid(pid)
+    true
+  rescue Errno::ESRCH
+    false
+  end
+end
+
+def print_not_running_message
+  puts "\e[33m⚠️\e[0m  Server is not running!"
+end
+
+def print_already_running_message
+  puts "\e[33m⚠️\e[0m  Server is already running!"
+end
+
+def print_start_message
+  puts "\e[32m✔\e[0m Server is up and running!"
+end
+
+def print_stop_message
+  puts "\e[32m✔\e[0m Server has been stopped!"
+end
+
+def print_error_message
+  puts "\e[31m✘\e[0m Invalid command. Use 'start' to start the server and 'stop' to stop it."
+end
+
+case command
+when 'start'
+  if server_running?(pid_file)
+    print_already_running_message
+  else
+    SimpleProxy::App.run!
+    print_start_message
+  end
+when 'stop'
+  if server_running?(pid_file)
+    SimpleProxy::App.quit!
+    print_stop_message
+  else
+    print_not_running_message
+  end
+else
+  print_error_message
+end

data/lib/simple_proxy/version.rb

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

data/lib/simple_proxy.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative "simple_proxy/version"
+require 'sinatra/base'
+require 'httparty'
+require 'sinatra/cross_origin'
+
+module SimpleProxy
+  class Error < StandardError; end
+
+  class App < Sinatra::Base
+    set :bind, '0.0.0.0'
+    set :port, 4567
+
+    configure do
+      set :logging, nil
+      set :dump_errors, false
+      set :raise_errors, false
+      register Sinatra::CrossOrigin
+      enable :cross_origin
+    end
+
+    before do
+      cross_origin
+    end
+
+    # routes for the proxy server
+    options "*" do
+      response.headers["Allow"] = "GET, PUT, POST, DELETE, OPTIONS"
+      response.headers["Access-Control-Allow-Headers"] = "X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept, X-Api-Key"
+      200
+    end
+
+
+    # Handle GET requests
+    get '/proxy' do
+      proxy_request(:get)
+    end
+
+    # Handle POST requests
+    post '/proxy' do
+      proxy_request(:post)
+    end
+
+    # Handle PUT requests
+    put '/proxy' do
+      proxy_request(:put)
+    end
+
+    # Handle HEAD requests
+    put '/proxy' do
+      proxy_request(:head)
+    end
+
+    # Handle DELETE requests
+    put '/proxy' do
+      proxy_request(:delete)
+    end
+
+    def proxy_request(method)
+      target_url = params['url']
+
+      # Remove 'url' from params to avoid sending it in the query parameters
+      params.delete('url')
+
+      options = {
+        query: params, # Send remaining params as query parameters
+        headers: extract_request_headers
+      }
+
+      if [:post, :put].include?(method)
+        options[:body] = request.body.read
+        options[:headers]['Content-Type'] = 'application/json'
+      end
+
+      response = HTTParty.send(method, target_url, options)
+
+      content_type response.headers['content-type']
+      headers 'Accept-all' => 'true' # Add the Accept-all header to the response
+
+      response.body
+    end
+
+    def extract_request_headers
+      headers = {}
+      env.each do |key, value|
+        # HTTP_HEADER_NAME format is how Rack sends headers
+        if key.start_with?('HTTP_') && !['HTTP_VERSION', 'HTTP_HOST'].include?(key)
+          # Convert HTTP_HEADER_NAME to Header-Name
+          header_name = key[5..-1].split('_').collect(&:capitalize).join('-')
+          headers[header_name] = value
+        end
+      end
+      headers
+    end
+
+    # start the server
+    def self.run!
+      pid = Process.fork do
+        $stderr.reopen(File.new('/dev/null', 'w'))
+        $stdout.reopen(File.new('/dev/null', 'w'))
+        super()
+      end
+      File.write('simple_proxy.pid', pid)
+    end
+
+    # stop the server
+    def self.quit!
+      if File.exist?('simple_proxy.pid')
+        pid = File.read('simple_proxy.pid').to_i
+        Process.kill("TERM", pid)
+        File.delete('simple_proxy.pid')
+      else
+        puts "No running instance found"
+      end
+    end
+  end
+end

data/sig/simple_proxy.rbs

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

data/simple_proxy.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/simple_proxy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "simple_proxy"
+  spec.version = SimpleProxy::VERSION
+  spec.authors = ["Arjun Verma"]
+  spec.email = ["arjun.verma@hetu-labs.com"]
+
+  spec.summary = "This gem is a pivotal component in a suite of Developer Productivity Software, specifically designed to resolve CORS restrictions that occur when the frontend and backend domains are different. It aims to eliminate the impediments in the Software Development Life Cycle (SDLC), ensuring smoother and more efficient development processes, thereby significantly reducing SDLC turnaround times."
+  spec.description = "The gem in development is part of a suite of Developer Productivity Software that is strategically designed to enhance efficiency and productivity during the Software Development Life Cycle (SDLC). It mainly addresses the limitations and blockades encountered due to Cross-Origin Resource Sharing (CORS) policies that often hinder smooth interaction between the frontend and backend components when hosted on different domains."
+  spec.homepage = "https://www.hetu-labs.com/"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Hetu-Labs/simple_proxy"
+  spec.metadata["changelog_uri"] = "https://github.com/Hetu-Labs/simple_proxy/blob/main/CHANGELOG.md"
+
+  # 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|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["simple_proxy"]
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_runtime_dependency "sinatra", "~> 3.1.0"
+  spec.add_runtime_dependency "httparty", "~> 0.21.0"
+  spec.add_runtime_dependency "sinatra-cross_origin", "~> 0.4.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: simple_proxy
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Arjun Verma
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: sinatra-cross_origin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: The gem in development is part of a suite of Developer Productivity Software
+  that is strategically designed to enhance efficiency and productivity during the
+  Software Development Life Cycle (SDLC). It mainly addresses the limitations and
+  blockades encountered due to Cross-Origin Resource Sharing (CORS) policies that
+  often hinder smooth interaction between the frontend and backend components when
+  hosted on different domains.
+email:
+- arjun.verma@hetu-labs.com
+executables:
+- simple_proxy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/logo.png
+- bin/simple_proxy
+- lib/simple_proxy.rb
+- lib/simple_proxy/version.rb
+- sig/simple_proxy.rbs
+- simple_proxy.gemspec
+homepage: https://www.hetu-labs.com/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.hetu-labs.com/
+  source_code_uri: https://github.com/Hetu-Labs/simple_proxy
+  changelog_uri: https://github.com/Hetu-Labs/simple_proxy/blob/main/CHANGELOG.md
+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.7
+signing_key:
+specification_version: 4
+summary: This gem is a pivotal component in a suite of Developer Productivity Software,
+  specifically designed to resolve CORS restrictions that occur when the frontend
+  and backend domains are different. It aims to eliminate the impediments in the Software
+  Development Life Cycle (SDLC), ensuring smoother and more efficient development
+  processes, thereby significantly reducing SDLC turnaround times.
+test_files: []