api-regulator 0.1.0

data/lib/tasks/api_regulator_tasks.rake

@@ -0,0 +1,67 @@
+namespace :api_docs do
+  desc 'Generate OpenAPI schema'
+  task generate: :environment do
+    Rails.application.eager_load!
+
+    api_definitions = ApiRegulator.configuration.base_controller_klass.descendants.flat_map(&:api_definitions)
+    ApiRegulator::OpenApiGenerator.generate(api_definitions)
+  end
+
+  desc "Upload OpenAPI schema to ReadMe"
+  task :upload => :environment do
+    # ReadMe API key and version
+    readme_api_key = ENV['RDME_API_KEY'] || raise("RDME_API_KEY is not set")
+
+    # ReadMe API endpoint
+    readme_api_endpoint = "https://dash.readme.com/api/v1/api-specification"
+
+    # Read the OpenAPI schema file
+    unless File.exist?(ApiRegulator.configuration.docs_path)
+      raise "OpenAPI schema file not found at #{ApiRegulator.configuration.docs_path}"
+    end
+    openapi_content = File.read(ApiRegulator.configuration.docs_path)
+
+    # Upload to ReadMe
+    require 'net/http'
+    require 'uri'
+    require 'json'
+
+    if ApiRegulator.configuration.rdme_api_id
+      uri = URI.parse("#{readme_api_endpoint}/#{ApiRegulator.configuration.rdme_api_id}")
+      request = Net::HTTP::Put.new(uri)
+    else
+      uri = URI.parse(readme_api_endpoint)
+      request = Net::HTTP::Post.new(uri)
+    end
+    request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
+    request["Content-Type"] = "application/json"
+    request.body = {
+      spec: JSON.parse(openapi_content)
+    }.to_json
+
+    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+      http.request(request)
+    end
+
+    if response.code.to_i == 200
+      puts "OpenAPI schema successfully updated!"
+    elsif response.code.to_i == 201
+      puts "OpenAPI schema successfully created!"
+      puts "To use this for future publishing, add this to your ApiRegulator configs:"
+      puts ""
+      puts "  config.rdme_api_id = \"#{JSON.parse(response.body)["_id"]}\""
+      puts ""
+    else
+      puts "Failed to upload OpenAPI schema to ReadMe!"
+      puts "Response Code: #{response.code}"
+      puts "Response Body:"
+      pp JSON.parse(response.body)
+    end
+  end
+
+  desc 'Generate and upload OpenAPI schema'
+  task publish: :environment do
+    Rake::Task["api_docs:generate"].invoke
+    Rake::Task["api_docs:upload"].invoke
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: api-regulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Geoff Massanek
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: activemodel
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+description: Define your Rails APIs with a clean, familiar DSL. Validate them with
+  ActiveModel-like validations. Generate OpenAPI documentation.
+email:
+- geoff@stellarfi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-regulator.gemspec
+- bin/console
+- bin/setup
+- lib/api-regulator.rb
+- lib/api_regulator.rb
+- lib/api_regulator/api.rb
+- lib/api_regulator/configuration.rb
+- lib/api_regulator/controller_mixin.rb
+- lib/api_regulator/dsl.rb
+- lib/api_regulator/formats.rb
+- lib/api_regulator/open_api_generator.rb
+- lib/api_regulator/param.rb
+- lib/api_regulator/shared_schema.rb
+- lib/api_regulator/validation_error.rb
+- lib/api_regulator/validator.rb
+- lib/api_regulator/version.rb
+- lib/tasks/api_regulator_tasks.rake
+homepage: https://github.com/Stellarcred/stellar-gears
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Stellarcred/stellar-gears
+  source_code_uri: https://github.com/Stellarcred/stellar-gears
+  changelog_uri: https://github.com/Stellarcred/stellar-gears
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Define, document, and validate your Rails APIs
+test_files: []