dummy_oscar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5584d49e06bc4edcee5e792298e85a72069935a162125bbb59cb0d3d2ae3cb73
+  data.tar.gz: f739356d1a5eea86e3acb3acb0967a49e0aeff9f994e6f35d97aafa1467f5f3d
+SHA512:
+  metadata.gz: 5f7a7b14cd5983b628b03c75b9e53b1032d354a06e92704a56565934f80f957a560a52ed2a4e5269ab0e47fccdf6d34516cbbd2b78860dd4e1d56f2a7a6bf181
+  data.tar.gz: 9108b0208db1eeefa880f082bc59fbc9be98c334ec399fc52d83a5a7e667b3261b6777fe55b53be320655df9f42e818a6e58050083ada550261e939d35cb4bf2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-04
+
+- 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 yuuji.yaginuma@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) 2024 Yuji Yaginuma
+
+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,81 @@
+# DummyOscar
+
+DummyOscar is tool for creating a dummy HTTP server and client.
+
+## Server
+
+You can define a path that returns a dummy response by YAML file. You can use ERB inside the file.
+
+Example:
+
+```yml
+# sample.yaml
+paths:
+  /:
+    get:
+      response:
+        status_code: 200
+        body: "hello,world"
+  /users:
+    post:
+      response:
+        status_code: 204
+    get:
+      response:
+        status_code: 200
+        body: '<%= File.read('test/fixtures/users.json') %>'
+  /users/dummy.json:
+    get:
+      response:
+        status_code: 200
+        body: <%= {name: 'dummy'}.to_json %>
+        content_type: 'application/json'
+  /users/.+/books:
+    get:
+      response:
+        status_code: 200
+        body: '[{"title":"Abc"},{"title":"deF"}]'
+        content_type: 'application/json'
+```
+
+You can now start the dummy server.
+
+```bash
+$ dummy_oscar s -C sample.yaml
+```
+
+```bash
+$ curl http://localhost:8282
+hello,world
+$ curl http://localhost:8282/users/1/books
+[{"title":"Abc"},{"title":"deF"}]
+```
+
+If you want to use custom methods inside the YAML, you can pass a Ruby file that will load during the parsing of the YAML file.
+
+```bash
+$ dummy_oscar s -C sample.yaml -r ./library_for_config.rb
+```
+
+## Client
+
+You can define a path and request body by YAML file. You can use ERB inside the file.
+
+Example:
+
+```yml
+requests:
+  hello:
+    path: "/"
+    method: "get"
+  create_user:
+    path: "/users"
+    method: "post"
+    body: <%= {name: 'dummy'}.to_json %>
+```
+
+You can send request like the following.
+
+```bash
+$ dummy_oscar c -C sample.yml -h http://localhost:5252 -c hello
+```

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create do |t|
+  t.verbose = true
+end
+
+task default: :test

data/exe/dummy_oscar

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dummy_oscar"
+
+DummyOscar::Cli.start

data/lib/dummy_oscar/app.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "erb"
+
+# NOTE: These requires are for using some methods in a config file.
+require "json"
+
+class DummyOscar::App
+  private_class_method :new
+
+  class << self
+    def build(config_file, library:)
+      new(config_file, library: library)
+    end
+  end
+
+  def initialize(config_file, library:)
+    @router = DummyOscar::Router.new
+    parse_config_file(config_file, library: library)
+  end
+
+  def app(env)
+    input = "'#{env['rack.input'].read}'"
+    $stdout.puts "Started #{env["REQUEST_METHOD"]} #{env["PATH_INFO"]} #{input}"
+
+    route = @router.find(path: env["PATH_INFO"], method: env["REQUEST_METHOD"])
+    if route
+      headers = {}
+      headers["Content-Type"] = route.response["content_type"] if route.response["content_type"]
+      return [route.response["status_code"], headers, [route.response["body"].to_s]]
+    end
+
+    [404, {}, ["Not found"]]
+  end
+
+  private
+
+  def parse_config_file(config_file, library:)
+    require(library) if library
+
+    source = ERB.new(File.read(config_file)).result(binding)
+    config = YAML.load(source)
+    config["paths"].each do |path, list|
+      list.each do |method, response|
+        raise DummyOscar::ParseConfigError, "You need to specify `:response` in the config file." if response["response"].nil?
+        @router.add(path: path, method: method, response: response["response"])
+      end
+    end
+  end
+end

data/lib/dummy_oscar/cli.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+class DummyOscar::Cli
+  class << self
+    def start(argv = ARGV)
+      cli = new(argv)
+      options = cli.parse
+
+      if options[:mode] == "s"
+        DummyOscar::Server.new(config_file: options[:config], port: options[:port], library: options[:library]).start
+      else
+        DummyOscar::Client.new(config_file: options[:config], command: options[:command], library: options[:library], host: options[:host]).start
+      end
+    end
+  end
+
+  CMD = 'dummy_oscar'
+  USAGE = <<~USAGE
+  sub commands are:
+     s :     run with server mode
+     c :     run with client mode
+  See '#{CMD} COMMAND --help' for more information on a specific command.
+  USAGE
+
+  def initialize(argv)
+    @argv = argv
+    @options = {}
+  end
+
+  def parse
+    global_command.order!(@argv)
+    @options[:mode] = @argv.shift
+    subcommand = subcommands[@options[:mode]]
+    unless subcommand
+      puts global_command.help
+      exit!
+    end
+
+    subcommand.order!(@argv)
+    raise OptionParser::MissingArgument.new("-C") if @options[:config].nil?
+    @options
+  end
+
+  private
+
+  def global_command
+    @global_command ||= OptionParser.new do |opts|
+      opts.banner = "Usage: #{CMD} [options] [subcommand [options]]"
+      opts.separator ""
+      opts.separator USAGE
+    end
+  end
+
+  def subcommands
+    {
+      's' => OptionParser.new do |opts|
+        opts.banner = "Usage: dummy_oscar s [options]"
+
+        opts.on("-p", "--port NUMBER", "Port number", Integer) do |v|
+          @options[:port] = v.to_i
+        end
+
+        opts.on("-C", "--config PATH", "Config file path") do |v|
+          @options[:config] = v
+        end
+
+        opts.on("-r", "--require PATH", "require the library before parse a config file") do |v|
+          @options[:library] = v
+        end
+      end,
+      'c' => OptionParser.new do |opts|
+        opts.banner = "Usage: dummy_oscar c [options]"
+
+        opts.on("-C", "--config PATH", "Config file path") do |v|
+          @options[:config] = v
+        end
+
+        opts.on("-r", "--require PATH", "require the library before parse a config file") do |v|
+          @options[:library] = v
+        end
+
+        opts.on("-c", "--command NAME", "Command") do |v|
+          @options[:command] = v
+        end
+
+        opts.on("-h", "--host NAME", "Host name") do |v|
+          @options[:host] = v
+        end
+      end
+    }
+  end
+end

data/lib/dummy_oscar/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "uri"
+
+class DummyOscar::Client
+  def initialize(config_file:, host:, command:, library: nil)
+    raise DummyOscar::ArgumentError, "Pleaes specify command argument." if command.nil?
+
+    @command = command
+    @commands = {}
+    @host = host
+    parse_config_file(config_file: config_file, library: library)
+  end
+
+  def start
+    request = @commands[@command]
+    raise DummyOscar::ArgumentError, "'#{@command}' did not find." if request.nil?
+
+    request_options = {}
+    request_options[:body] = request["body"] unless request["body"].nil?
+    request_options[:query] = request["query"] unless request["query"].nil?
+
+    response = HTTParty.public_send(request["method"].downcase, URI.join(@host, request["path"]).to_s, request_options)
+    $stdout.puts response.body
+  end
+
+  private
+
+  def parse_config_file(config_file:, library:)
+    require(library) if library
+
+    source = ERB.new(File.read(config_file)).result(binding)
+    config = YAML.load(source)
+
+    config["requests"].each do |name, request|
+      if request["path"].nil? || request["method"].nil?
+        raise DummyOscar::ParseConfigError, "You need to specify both `:path` and `:method` in the config file."
+      end
+      @commands[name] = request
+    end
+  end
+end

data/lib/dummy_oscar/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DummyOscar
+  class Error < StandardError; end
+  class ParseConfigError < Error; end
+  class ArgumentError < Error; end
+end

data/lib/dummy_oscar/router.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class DummyOscar::Router
+  Route = Struct.new(:path, :method, :response)
+
+  def initialize
+    @routes = []
+  end
+
+  def add(path:, method:, response:)
+    @routes << Route.new(path, method.downcase, response)
+  end
+
+  def find(path:, method:)
+    @routes.detect do |route|
+      /\A(?:#{route.path})\z/.match?(path) && route.method == method.downcase
+    end
+  end
+end

data/lib/dummy_oscar/server.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "puma"
+require "puma/launcher"
+
+class DummyOscar::Server
+  DEFAULT_PORT = 8282
+
+  def initialize(config_file:, port: nil, library: nil)
+    @port = port || DEFAULT_PORT
+    @app_builder = DummyOscar::App.build(config_file, library: library)
+  end
+
+  def start
+    conf = Puma::Configuration.new do |user_config|
+      user_config.threads(1, 4)
+      user_config.port(@port)
+      user_config.app { |env| @app_builder.app(env) }
+    end
+    $stdout.puts("Listening on http://localhost:#{@port}")
+    Puma::Launcher.new(conf, log_writer: Puma::LogWriter.null).run
+  end
+end

data/lib/dummy_oscar/version.rb

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

data/lib/dummy_oscar.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "dummy_oscar/version"
+require_relative "dummy_oscar/errors"
+require_relative "dummy_oscar/server"
+require_relative "dummy_oscar/client"
+require_relative "dummy_oscar/app"
+require_relative "dummy_oscar/router"
+require_relative "dummy_oscar/cli"

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: dummy_oscar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Yaginuma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- yuuji.yaginuma@gmail.com
+executables:
+- dummy_oscar
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/dummy_oscar
+- lib/dummy_oscar.rb
+- lib/dummy_oscar/app.rb
+- lib/dummy_oscar/cli.rb
+- lib/dummy_oscar/client.rb
+- lib/dummy_oscar/errors.rb
+- lib/dummy_oscar/router.rb
+- lib/dummy_oscar/server.rb
+- lib/dummy_oscar/version.rb
+homepage: https://github.com/y-yagi/dummy_oscar
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/y-yagi/dummy_oscar
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key: 
+specification_version: 4
+summary: The tool for creating a dummy HTTP server and client.
+test_files: []