haveapi 0.29.9 → 0.30.0

data/test_support/dynamic_python_login_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'open3'
+require 'rack/mock'
+require_relative 'dynamic_documentation_api'
+require_relative '../spec/client_examples/dynamic_fixture'
+
+RSpec.describe HaveAPI::ClientExamples::PythonClient do
+  include DynamicExampleFixture
+
+  [described_class, HaveAPI::ClientExamples::PythonAsyncClient].each do |renderer|
+    it "preserves actual required token input in the rendered #{renderer.id} mapping and native builder" do
+      request = Rack::MockRequest.new(DynamicDocumentationAPI.build.app)
+      response = request.options('http://example.test/mount/v2/')
+      expect(response.status).to eq(200), response.body
+      envelope = JSON.parse(response.body)
+      description = envelope.fetch('response')
+      context = dynamic_context(description:)
+      rendered = renderer.render(:auth, context:, auth_method: :token, auth_description: description.fetch('authentication').fetch('token'))
+      expect(rendered[:status]).to eq(:code), rendered.inspect
+      script = <<~PY
+        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
+
+        fixture = json.load(sys.stdin)
+        tree = ast.parse(fixture["source"])
+        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)})
+        description = parse_description(fixture["envelope"])
+        action = parse_resources(description.authentication["token"]["resources"])["token"].actions["request"]
+        assert action.input.parameters["lifetime"].required
+        assert "fixed" in action.input.parameters["lifetime"].raw["validators"]["include"]["values"]
+        assert not action.input.parameters["interval"].required
+        context = CallContext(action, (), {}, 1)
+        built = build_request(description, context, base_url=fixture["base_url"], params=params)
+        body = json.loads(built.content)
+        missing = dict(params)
+        del missing["lifetime"]
+        try:
+            build_request(description, context, base_url=fixture["base_url"], params=missing)
+        except ValidationError as error:
+            errors = {key: list(value) for key, value in error.errors.items()}
+        else:
+            raise AssertionError("Missing required lifetime was accepted")
+        print(json.dumps({"params": params, "body": body, "url": built.url, "missing_errors": errors}))
+      PY
+      root = File.expand_path('../../..', __dir__)
+      output, status = Open3.capture2e(
+        { 'PYTHONPATH' => File.join(root, 'clients/python/src'), 'PYTHONDONTWRITEBYTECODE' => '1' },
+        File.join(root, 'clients/python/.venv/bin/python'), '-c', script,
+        stdin_data: JSON.generate({ envelope:, source: rendered.fetch(:code), base_url: context.base_url })
+      )
+      expect(status).to be_success, output
+      actual = JSON.parse(output)
+      expected = { 'user' => 'fixture-user', 'password' => 'fixture-password', 'scope' => 'all', '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')
+      expect(actual.fetch('missing_errors')).to eq('lifetime' => ['required parameter is missing'])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.29.9
+  version: 0.30.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.9
+        version: 0.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.9
+        version: 0.30.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +210,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/client-examples.md
 - doc/create-client.md
 - doc/hooks.erb
 - doc/index.md
@@ -240,14 +241,23 @@ files:
 - lib/haveapi/authorization.rb
 - lib/haveapi/client_example.rb
 - lib/haveapi/client_examples/curl.rb
-- lib/haveapi/client_examples/fs_client.rb
+- lib/haveapi/client_examples/dynamic_helpers.rb
+- lib/haveapi/client_examples/go_client.rb
 - lib/haveapi/client_examples/http.rb
+- lib/haveapi/client_examples/js_async_client.rb
 - lib/haveapi/client_examples/js_client.rb
 - lib/haveapi/client_examples/php_client.rb
+- lib/haveapi/client_examples/python_async_client.rb
+- lib/haveapi/client_examples/python_client.rb
 - lib/haveapi/client_examples/ruby_cli.rb
 - lib/haveapi/client_examples/ruby_client.rb
+- lib/haveapi/client_examples/rust_client.rb
+- lib/haveapi/client_examples/ts_async_client.rb
+- lib/haveapi/client_examples/ts_client.rb
 - lib/haveapi/common.rb
 - lib/haveapi/context.rb
+- lib/haveapi/documentation_clients.rb
+- lib/haveapi/documentation_context.rb
 - lib/haveapi/example.rb
 - lib/haveapi/example_list.rb
 - lib/haveapi/exceptions.rb
@@ -274,6 +284,7 @@ files:
 - lib/haveapi/public/css/highlight.css
 - lib/haveapi/public/doc/protocol.png
 - lib/haveapi/public/js/bootstrap.min.js
+- lib/haveapi/public/js/highlight-LICENSE
 - lib/haveapi/public/js/highlight.pack.js
 - lib/haveapi/public/js/highlighter.js
 - lib/haveapi/public/js/jquery-1.11.1.min.js
@@ -315,6 +326,7 @@ files:
 - 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_result.erb
 - lib/haveapi/views/version_page/resource_body.erb
 - lib/haveapi/views/version_sidebar.erb
 - lib/haveapi/views/version_sidebar/auth_nav.erb
@@ -330,9 +342,24 @@ files:
 - spec/authentication/token_spec.rb
 - spec/authentication/token_version_routes_spec.rb
 - spec/authorization_spec.rb
+- spec/client_examples/assets/highlighter_test.cjs
+- spec/client_examples/assets/tabs_test.cjs
+- spec/client_examples/context_spec.rb
+- spec/client_examples/dynamic_acceptance.md
+- spec/client_examples/dynamic_acceptance.rb
+- spec/client_examples/dynamic_acceptance_spec.rb
+- spec/client_examples/dynamic_fixture.rb
+- spec/client_examples/dynamic_js_spec.rb
+- spec/client_examples/dynamic_metadata_spec.rb
+- spec/client_examples/dynamic_mounted_paths_spec.rb
+- spec/client_examples/dynamic_python_spec.rb
+- spec/client_examples/go_spec.rb
+- spec/client_examples/profiles_spec.rb
+- spec/client_examples/rust_client_spec.rb
 - spec/client_examples/syntax_spec.rb
 - spec/common_spec.rb
 - spec/documentation/auth_filtering_spec.rb
+- spec/documentation/client_examples_spec.rb
 - spec/documentation/current_user_html_escaping_spec.rb
 - spec/documentation/examples_spec.rb
 - spec/documentation/host_html_escaping_spec.rb
@@ -361,6 +388,9 @@ files:
 - spec/validators/presence_spec.rb
 - test_support/client_test_api.rb
 - test_support/client_test_server.rb
+- test_support/dynamic_documentation_api.rb
+- test_support/dynamic_protocol_spec.rb
+- test_support/dynamic_python_login_spec.rb
 licenses:
 - MIT
 metadata: {}

data/lib/haveapi/client_examples/fs_client.rb

@@ -1,119 +0,0 @@
-require 'haveapi/client_example'
-
-module HaveAPI::ClientExamples
-  class FsClient < HaveAPI::ClientExample
-    label 'File system'
-    code :bash
-    order 40
-
-    def init
-      "# Mount the file system\n$ haveapi-fs #{base_url} #{mountpoint} -o version=#{version}"
-    end
-
-    def auth(method, desc)
-      case method
-      when :basic
-        <<~END
-          # Provide credentials as file system options
-          #{init} -o auth_method=basic,user=myuser,password=secret
-
-          # If username or password isn't provided, the user is asked on stdin
-          #{init} -o auth_method=basic,user=myuser
-          Password: secret
-        END
-
-      when :token
-        <<~END
-          # Authenticate using username and password
-          #{init} -o auth_method=token,user=myuser
-          Password: secret
-
-          # If you have generated a token, you can use it
-          #{init} -o auth_method=token,token=yourtoken
-
-          # Note that the file system can read config file from haveapi-client, so if
-          # you set up authentication there, the file system will use it.
-        END
-
-      when :oauth2
-        '# OAuth2 is not supported by haveapi-fs.'
-      end
-    end
-
-    def example(sample)
-      cmd = [init]
-
-      path = [mountpoint].concat(resource_path)
-
-      unless class_action?
-        if !sample[:path_params] || sample[:path_params].empty?
-          raise "example {#{sample}} of action #{resource_path.join('.')}.#{action_name} is for an instance action but does not include URL parameters"
-        end
-
-        path << sample[:path_params].first.to_s
-      end
-
-      path << 'actions' << action_name
-
-      cmd << "\n# Change to action directory"
-      cmd << "$ cd #{File.join(path)}"
-
-      if sample[:request] && !sample[:request].empty?
-        cmd << "\n# Prepare input parameters"
-
-        sample[:request].each do |k, v|
-          cmd << "$ echo '#{v}' > input/#{k}"
-        end
-      end
-
-      cmd << "\n# Execute the action"
-      cmd << '$ echo 1 > exec'
-
-      cmd << "\n# Query the action's result"
-      cmd << '$ cat status'
-      cmd << (sample[:status] ? '1' : '0')
-
-      if sample[:status]
-        if sample[:response] && !sample[:response].empty? \
-           && %i[hash object].include?(action[:output][:layout])
-          cmd << "\n# Query the output parameters"
-
-          sample[:response].each do |k, v|
-            cmd << "$ cat output/#{k}"
-
-            cmd << if v === true
-                     '1'
-
-                   elsif v === false
-                     '0'
-
-                   else
-                     v.to_s
-                   end
-
-            cmd << "\n"
-          end
-        end
-
-      else
-        cmd << "\n# Get the error message"
-        cmd << '$ cat message'
-        cmd << sample[:message]
-
-        cmd << "\n# Parameter errors can be seen in the `errors` directory"
-        cmd << '$ ls errors'
-        cmd << (sample[:errors] || {}).keys.join("\n")
-      end
-
-      cmd.join("\n")
-    end
-
-    def mountpoint
-      "/mnt/#{host}"
-    end
-
-    def class_action?
-      action[:path].index(/:[a-zA-Z\-_]+/).nil?
-    end
-  end
-end