api-regulator 0.1.18 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14218b23d39f49f124677c3c4e1a20b9ce71ddc6c4908f45850b6d65a898ecb0
-  data.tar.gz: a60a16f1df4d29586b2a85bbfcd7a37287b7fdfdc56574651eb7b89b595e4481
+  metadata.gz: 837c44e67ec38b0e133c4aa4bb42959bd8488497da252a71d2eed57d2c366b3b
+  data.tar.gz: ae1383ca7891e8c4e07967f4a52e497375faab6d495d72201403ce73f88d06cd
 SHA512:
-  metadata.gz: c2bd79c082c6e2f6f3eaf220947b25c01d7360c1b0486acae1f402065a3fb3be8db454c3fc651f45800ee805f4f4edb6f59787c7148a2128095b8dd20b07820b
-  data.tar.gz: d176e785342fb4ec6674621651a439cc0d2c8fefb425fb2b5dbc447bd4aaf9e11eb8b2e1e1d0f09ad1dc5a658a15a0e5bc23f4c1c8524a711c85f5cff3b279fa
+  metadata.gz: 42f8341aa27841393a663ac1fa2ec2b540dbedaf54d3a3d2b6144e2369933514e7cc896e2dc6929363f5c5fac140d378618a1e16304d0c24e72ba3746644d119
+  data.tar.gz: 39da0748340946964f64615dc392f742e47ccfce02b9c2c09cb9a80cc85aaf206128ae480f27ab57c44722c56db99e83ed13c7d2846bf6c54c8882abda417748

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-regulator (0.1.18)
+    api-regulator (0.1.20)
       activemodel (~> 8.0)
       activesupport (~> 8.0)
 
@@ -88,7 +88,7 @@ GEM
     connection_pool (2.5.0)
     crass (1.0.6)
     date (3.4.1)
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.0)
     drb (2.2.1)
     erubi (1.13.1)
     globalid (1.2.1)
@@ -100,7 +100,7 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    logger (1.6.5)
+    logger (1.6.6)
     loofah (2.24.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -113,7 +113,7 @@ GEM
     mini_mime (1.1.5)
     mini_portile2 (2.8.8)
     minitest (5.25.4)
-    net-imap (0.5.5)
+    net-imap (0.5.6)
       date
       net-protocol
     net-pop (0.1.2)
@@ -135,7 +135,7 @@ GEM
       date
       stringio
     racc (1.8.1)
-    rack (3.1.9)
+    rack (3.1.10)
     rack-session (2.1.0)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)

data/README.md

@@ -43,7 +43,14 @@ Run `bundle install` to install the gem.
      config.api_base_url = "/api/v1" # Set a common base path for your API endpoints
      config.docs_path = Rails.root.join("doc").to_s # Path for folder for docs
      config.app_name = "My API" # shows in docs
-     config.rdme_api_id = ENV["RDME_API_ID"] # Optional: ReadMe API ID for schema uploads
+
+     # Optional: ReadMe versions and API ID for schema uploads
+     config.versions = {
+       "v1.0" => "abc123",
+       "v1.0-internal" => "abc345"
+     }
+     config.default_version = "v1.0-internal"
+
      config.servers = [
        { url: "https://stg.example.com", description: "Staging", "x-default": true },
        { url: "https://example.com", description: "Production" }
@@ -120,7 +127,8 @@ Generate OpenAPI documentation using the provided Rake tasks:
 
 1. **Generate the Schema:**
    ```bash
-   rake api_docs:generate
+   rake api_docs:generate # uses default (or no) version
+   VERSION=v1.0-internal rake api_docs:generate # specifies the to generate
    ```
 
 2. **Upload to ReadMe (Optional)**:

data/lib/api_regulator/api.rb

@@ -1,14 +1,15 @@
 module ApiRegulator
   class Api
-    attr_reader :controller_class, :controller_path, :controller_name, :action_name, :description, :title, :params, :responses
+    attr_reader :controller_class, :controller_path, :controller_name, :action_name, :description, :title, :params, :responses, :versions
 
-    def initialize(controller_class, action_name, desc: nil, title: nil, &block)
+    def initialize(controller_class, action_name, desc: nil, title: nil, versions: [], &block)
       @controller_class = controller_class
       @controller_name = controller_class.name
       @controller_path = controller_class.controller_path
       @action_name = action_name.to_s
       @description = desc
       @title = title
+      @versions = Array(versions).map(&:to_sym)
 
       @params = []
       @responses = {}
@@ -16,9 +17,9 @@ module ApiRegulator
       instance_eval(&block) if block_given?
     end
 
-    def param(name, type = nil, item_type: nil, desc: "", location: :body, allow_arbitrary_keys: false, **options, &block)
-      param = Param.new(name, type, item_type: item_type, desc: desc, location: location, api: self, allow_arbitrary_keys: allow_arbitrary_keys, **options, &block)
-      @params << param
+    def param(name, type = nil, **options, &block)
+      options[:api] ||= self
+      @params << Param.new(name, type, **options, &block)
     end
 
     def ref(ref_name, except: [], only: [])
@@ -90,6 +91,12 @@ module ApiRegulator
       ]
     end
 
+    def for_version?(version)
+      return true unless versions.present? && version.present?
+
+      versions.include?(version.to_sym)
+    end
+
     def allows_body?
       http_method != "get"
     end

data/lib/api_regulator/configuration.rb

@@ -1,6 +1,6 @@
 module ApiRegulator
   class Configuration
-    attr_accessor :api_base_url, :app_name, :docs_path, :rdme_api_id, :servers
+    attr_accessor :api_base_url, :app_name, :docs_path, :versions, :default_version, :servers
 
     def initialize
       # Set default values

data/lib/api_regulator/dsl.rb

@@ -9,7 +9,7 @@ module ApiRegulator
     end
 
     module ClassMethods
-      def api(controller_class, action, desc: nil, title: nil, &block)
+      def api(controller_class, action, desc: nil, title: nil, versions: [], &block)
         @api_definitions ||= []
 
         api_definition = Api.new(
@@ -17,6 +17,7 @@ module ApiRegulator
           action.to_s,
           desc: desc,
           title: title,
+          versions: versions,
           &block
         )
 

data/lib/api_regulator/open_api_generator.rb

@@ -2,35 +2,60 @@ require 'json'
 
 module ApiRegulator
   class OpenApiGenerator
-    def self.generate(api_definitions)
-      schema = {
+    def self.generate(api_definitions, version: ApiRegulator.configuration.default_version)
+      generator = new(api_definitions, version: version)
+      generator.generate
+    end
+
+    def self.schema_file_path(version: ApiRegulator.configuration.default_version)
+      file_name = version.present? ? "openapi-#{version}.json" : "openapi.json"
+      [
+        ApiRegulator.configuration.docs_path,
+        "/",
+        file_name
+      ].compact.join
+    end
+
+    attr_reader :api_definitions
+    attr_reader :version
+    attr_reader :final_schema
+
+    def initialize(api_definitions, version:)
+      @api_definitions = api_definitions
+      @version = version
+    end
+
+    def generate
+      @final_schema = {
         openapi: '3.1.0', # Explicitly target OpenAPI 3.1.0
         info: {
           title: ApiRegulator.configuration.app_name,
-          version: '1.0.0',
           description: 'Generated by ApiRegulator'
         },
         servers: ApiRegulator.configuration.servers,
         paths: {}
       }
+      final_schema[:info][:version] = version if version.present?
 
-      add_components(schema)
-      add_security(schema)
-      add_webhooks(schema)
+      add_components
+      add_security
+      add_webhooks
 
       api_definitions.each do |api|
-        add_api_to_schema(schema, api)
+        add_api_to_schema(api)
       end
 
-      schema_path = "#{ApiRegulator.configuration.docs_path}/openapi.json"
-      File.write(schema_path, JSON.pretty_generate(schema))
+      schema_path = self.class.schema_file_path(version: version)
+      File.write(schema_path, JSON.pretty_generate(final_schema))
       puts "OpenAPI schema generated: #{schema_path}"
     end
 
     private
 
-    def self.add_api_to_schema(schema, api)
-      schema[:paths][api.path] ||= {}
+    def add_api_to_schema(api)
+      return unless api.for_version?(version)
+
+      final_schema[:paths][api.path] ||= {}
       data = {
         summary: api.title,
         description: api.description.presence || api.title,
@@ -43,10 +68,10 @@ module ApiRegulator
       data[:requestBody] = generate_request_body(api) if api.allows_body?
       data.delete(:requestBody) if data[:requestBody].blank?
 
-      schema[:paths][api.path][api.http_method] = data
+      final_schema[:paths][api.path][api.http_method] = data
     end
 
-    def self.generate_request_body(api)
+    def generate_request_body(api)
       params = api.params.select(&:body?)
       return {} if params.empty?
 
@@ -60,7 +85,7 @@ module ApiRegulator
       }
     end
 
-    def self.expand_nested_params(params)
+    def expand_nested_params(params)
       schema = {
         type: 'object',
         properties: {},
@@ -68,6 +93,8 @@ module ApiRegulator
       }
 
       params.each do |param|
+        next unless param.for_version?(version)
+
         schema[:properties][param.name] =
           if param.type == :array
             generate_array_schema(param)
@@ -86,7 +113,7 @@ module ApiRegulator
       schema
     end
 
-    def self.generate_array_schema(param)
+    def generate_array_schema(param)
       item_schema = param.children.any? ? generate_object_schema(param) : { type: param.item_type }
 
       {
@@ -96,24 +123,26 @@ module ApiRegulator
       }.compact
     end
 
-    def self.generate_object_schema(param)
+    def generate_object_schema(param)
       object_schema = expand_nested_params(param.children)
       object_schema[:description] = param.desc if param.desc.present?
       object_schema[:type] = param.allow_nil? ? ['object', 'null'] : 'object'
       object_schema
     end
 
-    def self.generate_parameters(api)
-      api.params.select(&:parameter?).map do |p|
-        generate_param_schema(p)
+    def generate_parameters(api)
+      api.params.select(&:parameter?).filter_map do |param|
+        next unless param.for_version?(version)
+
+        generate_param_schema(param)
           .merge({
-            name: p.name,
-            required: p.location == :path || p.required? || false
+            name: param.name,
+            required: param.path? || param.required? || false
           })
       end
     end
 
-    def self.generate_param_schema(param)
+    def generate_param_schema(param)
       schema = {}
 
       schema[:description] = param.desc if param.desc.present?
@@ -136,7 +165,7 @@ module ApiRegulator
       schema
     end
 
-    def self.generate_param_schema_details(param, schema)
+    def generate_param_schema_details(param, schema)
       # Add length constraints
       if param.options[:length]
         schema[:minLength] = param.options[:length][:minimum] if param.options[:length][:minimum]
@@ -178,7 +207,7 @@ module ApiRegulator
 
     end
 
-    def self.generate_responses(api)
+    def generate_responses(api)
       Hash[api.responses.sort].each_with_object({}) do |(status_code, schema), responses|
         if schema.options[:ref]
           shared_schema = ApiRegulator.shared_schema(schema.options[:ref])
@@ -209,17 +238,17 @@ module ApiRegulator
       end
     end
 
-    def self.add_components(schema)
-      add_shared_schemas(schema)
-      add_security_schemes(schema)
+    def add_components
+      add_shared_schemas
+      add_security_schemes
     end
 
-    def self.add_webhooks(schema)
+    def add_webhooks
       return if ApiRegulator.webhook_definitions.empty?
 
-      schema[:webhooks] ||= {}
+      final_schema[:webhooks] ||= {}
       ApiRegulator.webhook_definitions.each do |webhook|
-        schema[:webhooks][webhook.event_name] = {
+        final_schema[:webhooks][webhook.event_name] = {
           post: {
             summary: webhook.title,
             description: webhook.description.presence || webhook.title,
@@ -239,30 +268,30 @@ module ApiRegulator
       end
     end
 
-    def self.add_shared_schemas(schema)
+    def add_shared_schemas
       return unless ApiRegulator.shared_schemas.present?
 
-      schema[:components] ||= {}
-      schema[:components][:schemas] ||= {}
+      final_schema[:components] ||= {}
+      final_schema[:components][:schemas] ||= {}
 
       ApiRegulator.shared_schemas.each do |name, shared_schema|
-        schema[:components][:schemas][name] = expand_nested_params(shared_schema.params).merge(
+        final_schema[:components][:schemas][name] = expand_nested_params(shared_schema.params).merge(
           description: shared_schema.description
         ).compact
       end
     end
 
-    def self.add_security_schemes(schema)
+    def add_security_schemes
       return unless ApiRegulator.security_schemes.present?
 
-      schema[:components] ||= {}
-      schema[:components][:securitySchemes] = ApiRegulator.security_schemes
+      final_schema[:components] ||= {}
+      final_schema[:components][:securitySchemes] = ApiRegulator.security_schemes
     end
 
-    def self.add_security(schema)
+    def add_security
       return unless ApiRegulator.security.present?
 
-      schema[:security] = ApiRegulator.security
+      final_schema[:security] = ApiRegulator.security
     end
   end
 end

data/lib/api_regulator/param.rb

@@ -1,24 +1,27 @@
 module ApiRegulator
   class Param
-    attr_reader :name, :type, :options, :item_type, :desc, :location, :children, :api, :allow_arbitrary_keys
+    attr_reader :name, :type, :options, :item_type, :desc, :location, :children, :api, :allow_arbitrary_keys, :versions
 
-    def initialize(name, type = nil, item_type: nil, desc: "", location: :body, api: nil, allow_arbitrary_keys: false, **options, &block)
+    def initialize(name, type = nil, **options, &block)
       @name = name
       @type = type&.to_sym || (block_given? ? :object : :string)
-      @item_type = item_type
-      @location = location.to_sym
-      @desc = desc
-      @options = options
+
+      @item_type = options.delete(:item_type)
+      @desc = options.delete(:desc) || ""
+      @location = (options.delete(:location) || :body).to_sym
+      @api = options.delete(:api)
+      @allow_arbitrary_keys = options.delete(:allow_arbitrary_keys) || false
+      @versions = Array(options.delete(:versions)).map(&:to_sym)
+
       @children = []
-      @api = api
-      @allow_arbitrary_keys = allow_arbitrary_keys
+      @options = options
 
       instance_eval(&block) if block_given?
     end
 
-    def param(name, type = nil, item_type: nil, desc: "", location: :body, allow_arbitrary_keys: false, **options, &block)
-      child = Param.new(name, type, item_type: item_type, desc: desc, location: location, api: api, allow_arbitrary_keys: allow_arbitrary_keys, **options, &block)
-      @children << child
+    def param(name, type = nil, **options, &block)
+      options[:api] ||= api
+      @children << Param.new(name, type, **options, &block)
     end
 
     def ref(ref_name, except: [], only: [])
@@ -111,6 +114,12 @@ module ApiRegulator
       end
     end
 
+    def for_version?(version)
+      return true unless versions.present? && version.present?
+
+      versions.include?(version.to_sym)
+    end
+
     def body?
       location == :body
     end

data/lib/api_regulator/shared_schema.rb

@@ -10,9 +10,8 @@ module ApiRegulator
       instance_eval(&block) if block_given?
     end
 
-    def param(name, type = nil, item_type: nil, desc: "", location: :body, allow_arbitrary_keys: false, **options, &block)
-      param = Param.new(name, type, item_type: item_type, desc: desc, location: location, allow_arbitrary_keys: allow_arbitrary_keys, **options, &block)
-      @params << param
+    def param(name, type = nil, **options, &block)
+      @params << Param.new(name, type, **options, &block)
     end
 
     def response(status_code, description_or_options, &block)

data/lib/api_regulator/version.rb

@@ -1,3 +1,3 @@
 module ApiRegulator
-  VERSION = "0.1.18"
+  VERSION = "0.1.20"
 end

data/lib/api_regulator/webhook.rb

@@ -13,9 +13,8 @@ module ApiRegulator
       instance_eval(&block) if block_given?
     end
 
-    def param(name, type = nil, item_type: nil, desc: "", location: :body, allow_arbitrary_keys: false, **options, &block)
-      param = Param.new(name, type, item_type: item_type, desc: desc, location: location, allow_arbitrary_keys: allow_arbitrary_keys, **options, &block)
-      @params << param
+    def param(name, type = nil, **options, &block)
+      @params << Param.new(name, type, **options, &block)
     end
 
     def ref(ref_name, except: [], only: [])

data/lib/tasks/api_regulator_tasks.rake

@@ -3,21 +3,26 @@ require 'yaml'
 namespace :api_docs do
   desc 'Generate OpenAPI schema'
   task generate: :environment do
+    # Set an empty api key if none is provided
+    ENV['RDME_API_KEY'] ||= ''
+    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
+
     Rails.application.eager_load! # Ensure all controllers and API definitions are loaded
 
-    ApiRegulator::OpenApiGenerator.generate(ApiRegulator.api_definitions)
+    ApiRegulator::OpenApiGenerator.generate(ApiRegulator.api_definitions, version: version.presence)
   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_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
+    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
 
     # ReadMe API endpoint
     readme_api_endpoint = "https://dash.readme.com/api/v1/api-specification"
 
     # Read the OpenAPI schema file
-    schema_path = "#{ApiRegulator.configuration.docs_path}/openapi.json"
+    schema_path =  ApiRegulator::OpenApiGenerator.schema_file_path(version: version)
     unless File.exist?(schema_path)
       raise "OpenAPI schema file not found at #{schema_path}"
     end
@@ -28,8 +33,8 @@ namespace :api_docs do
     require 'uri'
     require 'json'
 
-    if ApiRegulator.configuration.rdme_api_id
-      uri = URI.parse("#{readme_api_endpoint}/#{ApiRegulator.configuration.rdme_api_id}")
+    if version.present?
+      uri = URI.parse("#{readme_api_endpoint}/#{ApiRegulator.configuration.versions[version]}")
       request = Net::HTTP::Put.new(uri)
     else
       uri = URI.parse(readme_api_endpoint)
@@ -37,6 +42,7 @@ namespace :api_docs do
     end
     request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
     request["Content-Type"] = "application/json"
+    request["x-readme-version"] = version if version.present?
     request.body = {
       spec: JSON.parse(openapi_content)
     }.to_json
@@ -51,7 +57,9 @@ namespace :api_docs do
       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 "  config.versions = {"
+      puts "    \"<versionNumber>\": \"#{JSON.parse(response.body)["_id"]}\""
+      puts "  }"
       puts ""
     else
       puts "Failed to upload OpenAPI schema to ReadMe!"
@@ -71,7 +79,8 @@ namespace :api_docs do
   desc "Upload custom pages to ReadMe"
   task :upload_pages => :environment do
     # Configuration
-    readme_api_key = ENV['RDME_API_KEY'] || raise("RDME_API_KEY is not set")
+    readme_api_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
+    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
     base_readme_api_endpoint = "https://dash.readme.com/api/v1/docs"
 
     # Discover all documentation files
@@ -106,6 +115,7 @@ namespace :api_docs do
       end
       request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
       request["Content-Type"] = "application/json"
+      request["x-readme-version"] = version if version.present?
       request.body = request_body.compact.to_json
 
       # Send the request
@@ -130,7 +140,8 @@ namespace :api_docs do
   desc "View all categories on Readme.com"
   task :fetch_categories => :environment do
     # Configuration
-    readme_api_key = ENV['RDME_API_KEY'] || raise("RDME_API_KEY is not set")
+    readme_api_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
+    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
     readme_categories_api_endpoint = "https://dash.readme.com/api/v1/categories"
 
     # Build the API request
@@ -138,6 +149,7 @@ namespace :api_docs do
     request = Net::HTTP::Get.new(uri)
     request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
     request["Content-Type"] = "application/json"
+    request["x-readme-version"] = version if version.present?
 
     # Send the request
     response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
@@ -173,11 +185,13 @@ namespace :api_docs do
   end
 
   def check_if_page_exists(slug)
-    readme_api_key = ENV['RDME_API_KEY'] || raise("RDME_API_KEY is not set")
+    readme_api_key = ENV['RDME_API_KEY'].presence || raise("RDME_API_KEY is not set")
+    version = ENV['VERSION'] || ApiRegulator.configuration.default_version
     uri = URI.parse("https://dash.readme.com/api/v1/docs/#{slug}")
     request = Net::HTTP::Get.new(uri)
     request["Authorization"] = "Basic #{Base64.strict_encode64(readme_api_key)}"
     request["Content-Type"] = "application/json"
+    request["x-readme-version"] = version if version.present?
 
     # Send the request
     response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-regulator
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.20
 platform: ruby
 authors:
 - Geoff Massanek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-11 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport