openapi3_invoker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bba8b08b9ad66d44f3acf497a35c6eabb18df985d2afbd77746f6f9f4f372718
+  data.tar.gz: 154d5af22babe40808e9b457c207b361b6fac1b704b4f98418e6a09994b19792
+SHA512:
+  metadata.gz: 23dc0b036008cb6aaf8087c3e9153614b86f22198e82d10379908bd572a1e05fe88e8ff9d6a6d657cf6139b0ebff079cc67b0d394eaafd3cd991d91a434a40fe
+  data.tar.gz: e291750b6e312732e224d3df3dc6aeb6c7b02bf48a872e3b31ca5c9fbbb70989b8f057bb3e984989e29bca4647623d3cf93e7b144734c9ecb5100d3046a5dead

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chris Petersen
+
+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,39 @@
+# Openapi3Invoker
+
+This gem builds off of (openapi3_parser)[https://github.com/kevindew/openapi3_parser] to enable simple calling of OpenAPI operations.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add openapi3_invoker
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install openapi3_invoker
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openapi3_invoker. 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/[USERNAME]/openapi3_invoker/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 Openapi3Invoker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/openapi3_invoker/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/openapi3_invoker/client.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'cgi'
+
+module Openapi3Invoker
+  class Client
+    attr_reader :openapi
+    attr_reader :connection_opts
+    attr_reader :base_url
+
+    def initialize(openapi, base_url: nil, connection_opts: {})
+      @openapi = openapi
+      @connection_opts = connection_opts
+      @base_url = base_url || openapi.servers.first.url
+    end
+
+    def invoke(path_name, method_name, parameters: {}, headers: {}, body: nil)
+      raise Error::ServerNotSpecified unless base_url
+      raise Error::InvalidMethod unless %w[get delete put patch post head trace options].include?(method_name.to_s.downcase)
+      path = openapi.paths[path_name]
+      raise Error::InvalidPath unless path
+      method = path.send(method_name.to_s.downcase)
+      raise Error::InvalidMethodPathCombo unless method
+
+      raise Error::NotYetImplemented.new("Request Body is not yet supported") if method.request_body&.required?
+      method.parameters.each do |parameter|
+        raise Error::MissingParameter if(parameter.required? && !parameters.key?(parameter.name))
+      end
+
+      response = case method_name
+      when "get"
+        resulting_url = full_url(path_name, method, parameters: parameters)
+        connection.get(resulting_url, headers)
+      when "delete", "put", "patch", "post", "head", "trace", "options"
+        raise Error::NotYetImplemented.new("Only GET requests are currently supported")
+      end
+      response.body
+    end
+
+    # We're expect this method to called from invoke, so much of the error checking has already happened
+    # This would normally be a protected method, but we're making it public for testing purposes
+    def full_url(path_name, openapi_method, parameters: {})
+      path_name = path_name.dup
+      query_params = {}
+      openapi_method.parameters.each do |parameter|
+        case parameter.in
+        when "path"
+          value = parameters[parameter.name]
+          raise Error::MissingParameter unless value
+          path_name.gsub!("{#{parameter.name}}", value.to_s)
+        when "query"
+          value = parameters[parameter.name]
+          query_params[parameter.name] = value if value
+          raise Error::MissingParameter if(parameter.required? && !value)
+        end
+      end
+
+      url = [base_url.chomp('/'), path_name].join('')
+      uri = URI(url)
+      unless query_params.empty?
+        uri.query = URI.encode_www_form(query_params)
+      end
+      uri.to_s
+    end
+
+    def connection
+      adapter = connection_opts.delete(:adapter)
+      @connection ||= Faraday.new(connection_opts) do |faraday|
+        faraday.adapter( *adapter || Faraday.default_adapter )
+      end
+    end
+  end
+end

data/lib/openapi3_invoker/error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Openapi3Invoker
+  # An abstract class for Exceptions produced by this Gem
+  class Error < ::RuntimeError
+    # Raised in cases the user has specified an invalid HTTP verb
+    class InvalidMethod < Error; end
+
+    # Raised in cases the user has specified a path that is not contained in the underlying OpenAPI document
+    class InvalidPath < Error; end
+
+    # Raised in cases the user specifies a path and method that are not valid together
+    class InvalidMethodPathCombo < Error; end
+
+    # Raised in cases that a function is called that is not yet implemented
+    class NotYetImplemented < Error; end
+
+    # Raised in cases that a function is called that is not yet implemented
+    class ServerNotSpecified < Error; end
+
+    # Raised in cases that a required parameter is missing
+    class MissingParameter < Error; end
+  end
+end

data/lib/openapi3_invoker/version.rb

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

data/lib/openapi3_invoker.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+files = Dir.glob(File.join(__dir__, "openapi3_invoker", "**", "*.rb"))
+files.each { |file| require file }
+
+module Openapi3Invoker
+  # Given an Openapi3Parser::Document this will return a Client object that
+  # can invoke operations.
+  #
+  # @param  [Openapi3Parser::Document] the OpenAPI document
+  #
+  # @return [Client]
+  def self.new(document, base_url: nil, connection_opts: {})
+    Client.new(document, base_url: base_url, connection_opts: connection_opts)
+  end
+end

data/sig/openapi3_invoker.rbs

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: openapi3_invoker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Petersen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openapi3_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem builds off of openapi3_parser to simplify invoking OpenAPI 3.0
+  operations.
+email:
+- chris@petersen.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/openapi3_invoker.rb
+- lib/openapi3_invoker/client.rb
+- lib/openapi3_invoker/error.rb
+- lib/openapi3_invoker/version.rb
+- sig/openapi3_invoker.rbs
+homepage: https://github.com/assaydepot/openapi3_invoker
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/assaydepot/openapi3_invoker
+  source_code_uri: https://github.com/assaydepot/openapi3_invoker
+  changelog_uri: https://github.com/assaydepot/openapi3_invoker/releases
+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: A gem to simplify invoking OpenAPI 3.0 operations
+test_files: []