haveapi 0.31.1 → 0.32.0

data/test_support/dynamic_documentation_api.rb

@@ -7,6 +7,17 @@ module DynamicDocumentationAPI
   def self.receipts
     @receipts ||= []
   end
+
+  def self.events
+    @events ||= []
+  end
+
+  def self.record_authentication(request, provider, user)
+    request.env['dynamic_documentation.provider'] = provider if user
+    events << { type: 'authentication', provider:, authenticated: !user.nil? }
+    user
+  end
+
   User = Struct.new(:login)
 
   class RequestTrace
@@ -17,7 +28,12 @@ module DynamicDocumentationAPI
 
     def call(env)
       status, headers, body = @app.call(env)
-      @output.puts("DYNAMIC_DOCUMENTATION_REQUEST #{JSON.generate({ method: env['REQUEST_METHOD'], path: env['PATH_INFO'], status: })}")
+      trace = { method: env['REQUEST_METHOD'], path: env['PATH_INFO'], status: }
+      if env['PATH_INFO'].start_with?('/mount/')
+        provider = env['dynamic_documentation.provider']
+        DynamicDocumentationAPI.events << trace.merge(type: 'request', provider:, authenticated: !provider.nil?)
+      end
+      @output.puts("DYNAMIC_DOCUMENTATION_REQUEST #{JSON.generate(trace)}")
       [status, headers, body]
     end
   end
@@ -25,21 +41,24 @@ module DynamicDocumentationAPI
   class BasicProvider < HaveAPI::Authentication::Basic::Provider
     protected
 
-    def find_user(_request, username, password)
-      User.new(username) if username == 'fixture-user' && password == 'fixture-password'
+    def find_user(request, username, password)
+      user = User.new(username) if username == 'user' && password == 'secret'
+      DynamicDocumentationAPI.record_authentication(request, 'basic', user)
     end
   end
 
   class TokenConfig < HaveAPI::Authentication::Token::Config
     request do
       handle do |request, result|
-        if request.input[:user] == 'fixture-user' && request.input[:password] == 'fixture-password'
+        if request.input[:user] == 'user' && request.input[:password] == 'secret'
           result.token = 'fixture-challenge'
           result.next_action = 'verify'
           result.complete = false
           result.valid_to = Time.now + 3600
+          DynamicDocumentationAPI.events << { type: 'token_request', provider: 'token', authenticated: false }
           result.ok
         else
+          DynamicDocumentationAPI.events << { type: 'token_request_rejected', provider: 'token', authenticated: false }
           result.error = 'Invalid fixture credentials'
           result
         end
@@ -49,12 +68,14 @@ module DynamicDocumentationAPI
     action :verify do
       input { string :code, required: true }
       handle do |request, result|
-        if request.token == 'fixture-challenge' && request.input[:code] == '123456'
-          result.token = 'fixture-token'
+        if request.token == 'fixture-challenge' && request.input[:code] == 'code'
+          result.token = 'example-token'
           result.complete = true
           result.valid_to = Time.now + 3600
+          DynamicDocumentationAPI.events << { type: 'token_verification', provider: 'token', authenticated: true }
           result.ok
         else
+          DynamicDocumentationAPI.events << { type: 'token_verification_rejected', provider: 'token', authenticated: false }
           result.error = 'Invalid fixture challenge'
           result
         end
@@ -64,8 +85,9 @@ module DynamicDocumentationAPI
     renew { handle { |_request, result| result.ok } }
     revoke { handle { |_request, result| result.ok } }
 
-    def find_user_by_token(_request, token)
-      User.new('fixture-user') if token == 'fixture-token'
+    def find_user_by_token(request, token)
+      user = User.new('user') if token == 'example-token'
+      DynamicDocumentationAPI.record_authentication(request, 'token', user)
     end
   end
 
@@ -80,7 +102,8 @@ module DynamicDocumentationAPI
 
     def authenticate(request)
       value = request.env['HTTP_X_FIXTURE_OAUTH2'] || request.env['HTTP_AUTHORIZATION']&.delete_prefix('Bearer ')
-      User.new('fixture-user') if value == 'fixture-access-token'
+      user = User.new('user') if value == 'example-access-token'
+      value ? DynamicDocumentationAPI.record_authentication(request, 'oauth2', user) : nil
     end
   end
 
@@ -137,6 +160,8 @@ module DynamicDocumentationAPI
   end
 
   def self.build
+    receipts.clear
+    events.clear
     HaveAPI.implicit_version = '2'
     api = HaveAPI::Server.new(Resources)
     api.use_version('2')
@@ -147,7 +172,7 @@ module DynamicDocumentationAPI
     api.connect_hook(:pre_mount) do |ret, _server, sinatra|
       sinatra.get '/__acceptance_receipts' do
         content_type 'application/json'
-        JSON.generate(DynamicDocumentationAPI.receipts)
+        JSON.generate(actions: DynamicDocumentationAPI.receipts, events: DynamicDocumentationAPI.events)
       end
       ret
     end

data/test_support/dynamic_python_login_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe HaveAPI::ClientExamples::PythonClient do
       response = request.options('http://example.test/mount/v2/')
       expect(response.status).to eq(200), response.body
       envelope = JSON.parse(response.body)
+      expect(envelope.fetch('status')).to be(true), envelope.inspect
       description = envelope.fetch('response')
       context = dynamic_context(description:)
       rendered = renderer.render(:auth, context:, auth_method: :token, auth_description: description.fetch('authentication').fetch('token'))
@@ -21,7 +22,6 @@ RSpec.describe HaveAPI::ClientExamples::PythonClient do
         import ast
         import json
         import sys
-        from types import SimpleNamespace
         from haveapi_client._protocol import CallContext, build_request, parse_description, parse_resources
         from haveapi_client.exceptions import ValidationError
 
@@ -30,15 +30,7 @@ RSpec.describe HaveAPI::ClientExamples::PythonClient do
         calls = [node for node in ast.walk(tree) if isinstance(node, ast.Call)
                  and isinstance(node.func, ast.Attribute) and node.func.attr == "begin_token_login"]
         assert len(calls) == 1
-        environment = {
-            "HAVEAPI_AUTH_user": json.dumps("fixture-user"),
-            "HAVEAPI_AUTH_password": json.dumps("fixture-password"),
-            "HAVEAPI_AUTH_scope": json.dumps("all"),
-            "HAVEAPI_AUTH_lifetime": json.dumps("fixed"),
-        }
-        expression = ast.Expression(body=calls[0].args[0])
-        params = eval(compile(expression, "<rendered-login-input>", "eval"),
-                      {"json": json, "os": SimpleNamespace(environ=environment)})
+        params = ast.literal_eval(calls[0].args[0])
         description = parse_description(fixture["envelope"])
         action = parse_resources(description.authentication["token"]["resources"])["token"].actions["request"]
         assert action.input.parameters["lifetime"].required
@@ -65,7 +57,7 @@ RSpec.describe HaveAPI::ClientExamples::PythonClient do
       )
       expect(status).to be_success, output
       actual = JSON.parse(output)
-      expected = { 'user' => 'fixture-user', 'password' => 'fixture-password', 'scope' => 'all', 'lifetime' => 'fixed' }
+      expected = { 'user' => 'user', 'password' => 'secret', 'scope' => 'scope', 'lifetime' => 'fixed' }
       expect(actual.fetch('params')).to eq(expected)
       expect(actual.fetch('body')).to eq('token' => expected)
       expect(actual.fetch('url')).to eq('https://api.example.test/mount/_auth/token/tokens')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.31.1
+  version: 0.32.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.1
+        version: 0.32.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.31.1
+        version: 0.32.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,8 @@ files:
 - benchmarks/spec/client_examples_spec.rb
 - doc/client-examples.md
 - doc/create-client.md
+- doc/documentation-oauth.md
+- doc/documentation-ui.md
 - doc/hooks.erb
 - doc/index.md
 - doc/json-schema.html
@@ -268,7 +270,12 @@ files:
 - lib/haveapi/context.rb
 - lib/haveapi/documentation_clients.rb
 - lib/haveapi/documentation_context.rb
+- lib/haveapi/documentation_helpers.rb
+- lib/haveapi/documentation_oauth.rb
 - lib/haveapi/documentation_schema.rb
+- lib/haveapi/documentation_search.rb
+- lib/haveapi/documentation_search_index.rb
+- lib/haveapi/documentation_validators.rb
 - lib/haveapi/example.rb
 - lib/haveapi/example_list.rb
 - lib/haveapi/exceptions.rb
@@ -292,9 +299,11 @@ files:
 - lib/haveapi/params.rb
 - lib/haveapi/public/css/bootstrap-theme.min.css
 - lib/haveapi/public/css/bootstrap.min.css
+- lib/haveapi/public/css/documentation.css
 - lib/haveapi/public/css/highlight.css
 - lib/haveapi/public/doc/protocol.png
 - lib/haveapi/public/js/bootstrap.min.js
+- lib/haveapi/public/js/documentation.js
 - lib/haveapi/public/js/highlight-LICENSE
 - lib/haveapi/public/js/highlight.pack.js
 - lib/haveapi/public/js/highlighter.js
@@ -305,6 +314,7 @@ files:
 - lib/haveapi/resources/action_state.rb
 - lib/haveapi/route.rb
 - lib/haveapi/server.rb
+- lib/haveapi/shared_documentation_helpers.rb
 - lib/haveapi/spec/api_builder.rb
 - lib/haveapi/spec/api_response.rb
 - lib/haveapi/spec/helpers.rb
@@ -330,17 +340,30 @@ files:
 - lib/haveapi/views/doc_sidebars/create-client.erb
 - lib/haveapi/views/doc_sidebars/json-schema.erb
 - lib/haveapi/views/doc_sidebars/protocol.erb
+- lib/haveapi/views/documentation/search_form.erb
+- lib/haveapi/views/documentation/search_index.erb
+- lib/haveapi/views/documentation/search_results.erb
 - lib/haveapi/views/index.erb
 - lib/haveapi/views/main_layout.erb
+- lib/haveapi/views/shared_documentation.erb
+- lib/haveapi/views/shared_sidebar.erb
 - lib/haveapi/views/version_page.erb
 - lib/haveapi/views/version_page/auth_body.erb
 - lib/haveapi/views/version_page/client_auth.erb
 - lib/haveapi/views/version_page/client_example.erb
 - lib/haveapi/views/version_page/client_init.erb
+- lib/haveapi/views/version_page/client_overview.erb
 - lib/haveapi/views/version_page/client_result.erb
+- lib/haveapi/views/version_page/example_panels.erb
 - lib/haveapi/views/version_page/resource_body.erb
+- lib/haveapi/views/version_page/resource_directory.erb
+- lib/haveapi/views/version_page/usage.erb
 - lib/haveapi/views/version_sidebar.erb
 - lib/haveapi/views/version_sidebar/auth_nav.erb
+- lib/haveapi/views/version_sidebar/auth_resource_nav.erb
+- lib/haveapi/views/version_sidebar/authentication_control.erb
+- lib/haveapi/views/version_sidebar/authentication_status.erb
+- lib/haveapi/views/version_sidebar/brand.erb
 - lib/haveapi/views/version_sidebar/resource_nav.erb
 - spec/.rubocop.yml
 - spec/action/authorize_spec.rb
@@ -349,14 +372,18 @@ files:
 - spec/action/validation_http_status_spec.rb
 - spec/action_state_spec.rb
 - spec/authentication/basic_spec.rb
+- spec/authentication/oauth2_chain_spec.rb
 - spec/authentication/oauth2_spec.rb
+- spec/authentication/oauth2_token_validation_spec.rb
 - spec/authentication/token_spec.rb
 - spec/authentication/token_version_routes_spec.rb
 - spec/authorization_spec.rb
+- spec/client_examples/assets/documentation_test.cjs
 - spec/client_examples/assets/highlighter_test.cjs
 - spec/client_examples/assets/tabs_test.cjs
 - spec/client_examples/context_performance_spec.rb
 - spec/client_examples/context_spec.rb
+- spec/client_examples/detail_spec.rb
 - spec/client_examples/dynamic_acceptance.md
 - spec/client_examples/dynamic_acceptance.rb
 - spec/client_examples/dynamic_acceptance_spec.rb
@@ -366,20 +393,39 @@ files:
 - spec/client_examples/dynamic_mounted_paths_spec.rb
 - spec/client_examples/dynamic_python_spec.rb
 - spec/client_examples/go_spec.rb
+- spec/client_examples/presentation_spec.rb
 - spec/client_examples/profile_mount_spec.rb
 - spec/client_examples/profiles_spec.rb
 - spec/client_examples/rust_client_spec.rb
+- spec/client_examples/shell_spec.rb
 - spec/client_examples/structural_schema_spec.rb
 - spec/client_examples/syntax_spec.rb
 - spec/client_examples/ts_generated_client_spec.rb
 - spec/client_examples/typescript_profiles_spec.rb
 - spec/common_spec.rb
 - spec/documentation/auth_filtering_spec.rb
+- spec/documentation/canonical_routes_spec.rb
 - spec/documentation/client_examples_spec.rb
+- spec/documentation/client_overview_spec.rb
 - spec/documentation/current_user_html_escaping_spec.rb
+- spec/documentation/example_variants_spec.rb
 - spec/documentation/examples_spec.rb
+- spec/documentation/fixtures/search_index.json
 - spec/documentation/host_html_escaping_spec.rb
+- spec/documentation/identity_and_guides_spec.rb
+- spec/documentation/identity_context_spec.rb
+- spec/documentation/navigation_spec.rb
+- spec/documentation/oauth_fixture_spec.rb
+- spec/documentation/oauth_spec.rb
+- spec/documentation/oauth_transport_spec.rb
 - spec/documentation/performance_spec.rb
+- spec/documentation/reference_headings_spec.rb
+- spec/documentation/search_index_routes_spec.rb
+- spec/documentation/search_index_spec.rb
+- spec/documentation/search_routes_spec.rb
+- spec/documentation/search_spec.rb
+- spec/documentation/shared_pages_spec.rb
+- spec/documentation/validators_spec.rb
 - spec/documentation_spec.rb
 - spec/envelope_spec.rb
 - spec/extensions/action_exceptions_spec.rb
@@ -391,6 +437,8 @@ files:
 - spec/parameters/typed_spec.rb
 - spec/params_spec.rb
 - spec/performance/comparator_spec.rb
+- spec/performance/documentation_identity_fixture_spec.rb
+- spec/performance/documentation_shapes_spec.rb
 - spec/performance/endpoint_contract_spec.rb
 - spec/performance/endpoint_scaling_spec.rb
 - spec/performance/event_baseline_spec.rb
@@ -417,6 +465,7 @@ files:
 - test_support/all_client_performance_fixture.rb
 - test_support/client_test_api.rb
 - test_support/client_test_server.rb
+- test_support/documentation_oauth_fixture.rb
 - test_support/documentation_performance_fixture.rb
 - test_support/dynamic_documentation_api.rb
 - test_support/dynamic_protocol_spec.rb