zilla 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cfb7c21cb7e5af74461ab0c8caeb711368a7f8548e228fad039578dc3d1e42b
-  data.tar.gz: d2f8730e425912ab9ba43cdfb19190e59b446d64c123d84dfc392a7fd2bf2e02
+  metadata.gz: 67835482c78ededdf96d80a81e748354240776a1b8d696e3f8ea61a2e9a07a00
+  data.tar.gz: 1bac88fb8c3db62b72163318331f770e7145b4b55b7792420bf89cf2132f2452
 SHA512:
-  metadata.gz: aa3973517ead3d94119eeeefaa0549c47697f1f5ea4c1f5262c4bcfed55808dce4dcbcfac11b362f9b6465fd0aeee3eb3f0c3a1b4ab221e9a418628834c11ddd
-  data.tar.gz: 856bcf5b69ece2888f4b1b157cada1307b6cad333970581cf43a449cf2fb50c6cd3e59d6b794c027a16d2b9771572c79560f635741b168fa97926d9c2d28480d
+  metadata.gz: 646c19b46599f6cfb5791493a5a410e7702a1a706ffa1a0b7e919c56a6b2fb88b07b5f2e2111700bc344533e6810a96023dd627dcb4f1cad27306b5071954592
+  data.tar.gz: 71e3293b3e08583dd862faaf95550fbb9c701c7ddfde921ad1bca13e573127191d7dcd55e0db558c4a5632798fd2152d9222aeec8f04cdf85bf88cafe024d57c

data/.rspec

@@ -1,3 +1,4 @@
 --format progress
 --color
 --require spec_helper
+--order random

data/.rubocop.yml

@@ -44,4 +44,4 @@ Style/ClassAndModuleChildren:
   EnforcedStyle: compact
 
 RSpec/NestedGroups:
-  Max: 5
+  Max: 6

data/Gemfile

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in async-openapi.gemspec
 gemspec
 
 gem "rake", "~> 13.0"
@@ -13,7 +12,6 @@ gem "rubocop", "~> 1.21"
 gem "rubocop-performance"
 gem "rubocop-rspec"
 
-gem "async-rspec"
 gem "simplecov"
 gem "webmock"
 

data/Gemfile.lock

@@ -1,9 +1,7 @@
 PATH
   remote: .
   specs:
-    zilla (0.1.1)
-      async (~> 2.3.0)
-      async-http-faraday (~> 0.11)
+    zilla (0.1.3)
       faraday (~> 2.7.0)
       json_schemer (~> 0.2.0)
       memery (~> 1.4.0)
@@ -16,34 +14,9 @@ GEM
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    async (2.3.1)
-      console (~> 1.10)
-      io-event (~> 1.1)
-      timers (~> 4.1)
-    async-http (0.59.4)
-      async (>= 1.25)
-      async-io (>= 1.28)
-      async-pool (>= 0.2)
-      protocol-http (~> 0.23.1)
-      protocol-http1 (~> 0.14.0)
-      protocol-http2 (~> 0.14.0)
-      traces (>= 0.8.0)
-    async-http-faraday (0.11.0)
-      async-http (~> 0.42)
-      faraday
-    async-io (1.34.1)
-      async
-    async-pool (0.3.12)
-      async (>= 1.25)
-    async-rspec (1.16.1)
-      rspec (~> 3.0)
-      rspec-files (~> 1.0)
-      rspec-memory (~> 1.0)
     backport (1.2.0)
     benchmark (0.2.1)
     childprocess (4.1.0)
-    console (1.16.2)
-      fiber-local
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
@@ -55,11 +28,9 @@ GEM
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
-    fiber-local (1.0.0)
     hana (1.3.7)
     hashdiff (1.0.1)
     iniparse (1.5.0)
-    io-event (1.1.6)
     jaro_winkler (1.5.4)
     json (2.6.3)
     json_schemer (0.2.24)
@@ -83,13 +54,6 @@ GEM
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
-    protocol-hpack (1.4.2)
-    protocol-http (0.23.12)
-    protocol-http1 (0.14.6)
-      protocol-http (~> 0.22)
-    protocol-http2 (0.14.2)
-      protocol-hpack (~> 1.4)
-      protocol-http (~> 0.18)
     public_suffix (5.0.1)
     racc (1.6.2)
     rainbow (3.1.1)
@@ -107,10 +71,6 @@ GEM
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-files (1.1.3)
-      rspec (~> 3.0)
-    rspec-memory (1.0.3)
-      rspec (~> 3.0)
     rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
@@ -160,8 +120,6 @@ GEM
       yard (~> 0.9, >= 0.9.24)
     thor (1.2.1)
     tilt (2.0.11)
-    timers (4.3.5)
-    traces (0.8.0)
     unicode-display_width (2.4.2)
     uri_template (0.7.0)
     webmock (3.18.1)
@@ -177,7 +135,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  async-rspec
   overcommit
   rake (~> 13.0)
   rspec (~> 3.0)

data/lib/zilla/client_factory.rb

@@ -8,15 +8,15 @@ module Zilla::ClientFactory
   }.freeze
 
   class << self
-    def build(input)
-      definition = Zilla::LoaderFactory.build(input).load
+    def build(input, host: nil, scheme: nil, &block)
+      definition = Zilla::LoaderFactory.build(input, &block).load
 
       version = definition["swagger"]
 
       raise ArgumentError, "#{input.inspect} is not an OpenAPI definition" if version.nil?
       raise UnsupportedVersion, "usupported version #{version.inspect}" if version && CLIENTS[version].nil?
 
-      CLIENTS[version].new(definition)
+      CLIENTS[version].new(definition, host:, scheme:, faraday_config_block: block)
     end
   end
 end

data/lib/zilla/loader_factory.rb

@@ -4,13 +4,13 @@ module Zilla::LoaderFactory
   class UnknownLoader < Zilla::Error; end
 
   class << self
-    def build(input)
+    def build(input, &block)
       case input
       when Hash
         Zilla::Loaders::Hash
       when String
         for_string(input)
-      end.new(input)
+      end.new(input, faraday_config_block: block)
     rescue NoMethodError
       raise UnknownLoader, "cannot find loader for #{input.inspect}"
     end

data/lib/zilla/loaders/http.rb

@@ -3,7 +3,7 @@
 class Zilla::Loaders::HTTP < Zilla::Loaders::Loader
   def load_string
     Faraday.new(input) do |f|
-      f.adapter :async_http
+      @faraday_config_block.call(f, :loader)
       f.response :raise_error
     end.get.body
   end

data/lib/zilla/loaders/loader.rb

@@ -5,8 +5,9 @@ class Zilla::Loaders::Loader
 
   attr_reader :input
 
-  def initialize(input)
+  def initialize(input, faraday_config_block: nil)
     @input = input
+    @faraday_config_block = faraday_config_block || ->(_f, _target) {}
   end
 
   def load

data/lib/zilla/version.rb

@@ -4,5 +4,5 @@ module Zilla
   module Version
   end
 
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/zilla/versions/v20/client.rb

@@ -5,14 +5,15 @@ class Zilla::Versions::V20::Client
 
   include Memery
 
-  attr_reader :json, :host, :scheme
+  attr_reader :json, :host, :scheme, :faraday_config_block
 
-  def initialize(json, host: nil, scheme: :https)
+  def initialize(json, host: nil, scheme: nil, faraday_config_block: nil) # rubocop:disable Metrics/AbcSize
     @json = json
     @host = host || api.host || raise(ArgumentError, ":host must be specified")
-    @scheme = scheme.to_s
+    @scheme = (scheme || :https).to_s
+    @faraday_config_block = faraday_config_block || ->(_f, _target) {}
 
-    unless api.schemes.include?(@scheme)
+    if api.schemes && !api.schemes.include?(@scheme)
       raise ArgumentError, "unsupported scheme #{@scheme.inspect}. Supported: #{api.schemes}"
     end
 
@@ -21,7 +22,7 @@ class Zilla::Versions::V20::Client
 
   memoize def api = API.new(json)
 
-  memoize def executor = Executor.new(scheme, host)
+  memoize def executor = Executor.new(scheme, host, faraday_config_block:)
 
   private
 

data/lib/zilla/versions/v20/endpoint.rb

@@ -8,6 +8,8 @@ class Zilla::Versions::V20::Endpoint
   attr_reader :path, :method, :json, :definitions
 
   def initialize(path, method, json, definitions: {})
+    raise ArgumentError, "json must be a Hash, given: #{json.class.inspect}" unless json.instance_of?(Hash)
+
     @path = path
     @method = method
     @json = json
@@ -23,4 +25,5 @@ class Zilla::Versions::V20::Endpoint
   memoize def path_template = PathTemplate.new(path)
 
   memoize def parameters = Parameters.new(json["parameters"], definitions:)
+  memoize def responses = json["responses"].transform_values { |v| JSONSchemer.schema(v) }
 end

data/lib/zilla/versions/v20/executor.rb

@@ -5,24 +5,26 @@ class Zilla::Versions::V20::Executor
 
   attr_reader :scheme, :host
 
-  def initialize(scheme, host)
+  def initialize(scheme, host, faraday_config_block:)
     @scheme = scheme
     @host = host
+    @faraday_config_block = faraday_config_block || ->(_, _target) {}
   end
 
   def call(endpoint, *args, **params)
-    path_parameters = endpoint.path_template.path_parameters(*args, **params)
-    validate_path_params!(endpoint, path_parameters)
+    normalized = endpoint.parameters.normalize!(*args, **params)
 
-    path = endpoint.path_template.render(*args, **path_parameters)
-    connection.public_send(endpoint.method, path)
+    path = endpoint.path_template.render(*args, **normalized[:path])
+    response = connection.public_send(endpoint.method, path, **normalized[:query])
+
+    validate_response!(endpoint, response)
   end
 
   private
 
   memoize def connection
     Faraday.new("#{scheme}://#{host}") do |f|
-      f.adapter :async_http
+      @faraday_config_block.call(f, :client)
       f.response :raise_error
     end
   end
@@ -32,4 +34,14 @@ class Zilla::Versions::V20::Executor
       endpoint.parameters[k].validate!(v)
     end
   end
+
+  def validate_response!(endpoint, response)
+    schema = endpoint.responses[response.status.to_s]
+    parsed_body = JSON.parse(response.body)
+    errors = schema.validate(parsed_body)
+
+    raise ArgumentError, errors.to_a.to_s if errors.any?
+
+    parsed_body
+  end
 end

data/lib/zilla/versions/v20/parameter.rb

@@ -16,6 +16,9 @@ class Zilla::Versions::V20::Parameter
     end
   end
 
+  def in?(location) = json["in"] == location
+  def required? = !!@json["required"]
+
   def validate!(value)
     errors = schema.validate(value)
 

data/lib/zilla/versions/v20/parameters.rb

@@ -4,6 +4,15 @@ class Zilla::Versions::V20::Parameters
   include Zilla::Versions::V20
 
   include Memery
+  include Enumerable
+
+  LOCATIONS = {
+    path: "path",
+    query: "query",
+    body: "body",
+    header: "header",
+    form_data: "formData"
+  }.freeze
 
   attr_reader :json, :definitions
 
@@ -12,13 +21,75 @@ class Zilla::Versions::V20::Parameters
     @definitions = definitions
   end
 
+  def normalize!(*args, **params)
+    normalized = LOCATIONS.keys.inject({}) do |acc, location|
+      acc.merge(location => send("normalize_#{location}_params!", args, params))
+    end
+    validate!(normalized, params)
+  end
+
   memoize def parameters
     json.map { Parameter.new(_1, definitions:) }
         .group_by(&:name)
-        .transform_values(&:first)
+        .transform_values do |params|
+          raise(ArgumentError, "parameter names must be unique: #{params}") if params.count > 1
+
+          params.first
+        end
+  end
+
+  LOCATIONS.each do |name, key|
+    memoize(define_method("#{name}_parameters") do
+      parameters.filter { |_k, param| param.in?(key) }
+    end)
   end
 
-  def empty? = parameters.empty?
   def names = parameters.keys
   def [](name) = parameters[name]
+  def each(*, **, &) = parameters.each(*, **, &)
+
+  private
+
+  def normalize_path_params!(args, params)
+    params = params.transform_keys(&:to_s).slice(*path_parameters.keys)
+
+    if args.any?
+      raise ArgumentError, "path params must be passed EITHER in args OR in params" if params.any?
+
+      params = normalize_path_args(args)
+    end
+
+    return params if params.count == path_parameters.count
+
+    raise ArgumentError,
+          "there must be exactly #{path_parameters.count} path parameters in params. Given: #{params.count}"
+  end
+
+  def normalize_query_params!(_args, params) = params.transform_keys(&:to_s).slice(*query_parameters.keys)
+  def normalize_body_params!(_args, _params) = {}
+  def normalize_form_data_params!(_args, _params) = {}
+  def normalize_header_params!(_args, _params) = {}
+
+  def validate!(normalized, params)
+    params.each_key do |k|
+      raise ArgumentError, "unknown parameter #{k.inspect}" unless parameters[k.to_s]
+    end
+
+    parameters.each_value do |parameter|
+      p = normalized.dig(parameter.in.to_sym, parameter.name)
+      parameter.validate!(p) if parameter.required? || p
+    end
+    normalized
+  end
+
+  def normalize_path_args(args)
+    if args.count == path_parameters.count
+      return path_parameters.each_key.with_index.with_object({}) do |(k, i), acc|
+        acc[k] = args[i]
+      end
+    end
+
+    raise ArgumentError,
+          "there must be exactly #{path_parameters.count} path parameters in args. Given: #{args.count}"
+  end
 end

data/lib/zilla/versions/v20/path.rb

@@ -5,6 +5,8 @@ class Zilla::Versions::V20::Path
 
   include Memery
 
+  VERBS = ["get", "post", "put", "patch", "delete", "head", "options"].freeze
+
   attr_reader :path, :json, :definitions
 
   def initialize(path, json, definitions: {})
@@ -14,7 +16,13 @@ class Zilla::Versions::V20::Path
   end
 
   memoize def endpoints
+    parameters = json.fetch("parameters", []) # weird kubernetes API definition
+
     json.each_with_object({}) do |(k, v), acc|
+      next unless VERBS.include?(k)
+
+      v = v.merge("parameters" => v.fetch("parameters", []) + parameters)
+
       acc[k] = Endpoint.new(path, k, v, definitions:)
     end
   end

data/lib/zilla/versions/v20/path_template.rb

@@ -28,7 +28,7 @@ class Zilla::Versions::V20::PathTemplate
 
     return validate!(params.transform_keys(&:to_s)) if params.any?
 
-    @parameters.keys.each.with_index.with_object({}) do |(k, i), acc|
+    @parameters.each_key.with_index.with_object({}) do |(k, i), acc|
       acc[k] = args[i]
     end
   end

data/lib/zilla.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "async"
-require "async/http/faraday"
 require "faraday"
 require "oj"
 require "zeitwerk"
@@ -15,9 +13,12 @@ loader.inflector.inflect(
   "api" => "API"
 )
 
-# Your code goes here...
-module Zilla # rubocop:disable Style/ClassAndModuleChildren
+module Zilla
   class Error < StandardError; end
+
+  def self.for(input, host: nil, scheme: nil, &)
+    Zilla::ClientFactory.build(input, host:, scheme:, &)
+  end
 end
 
 loader.setup

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: zilla
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-29 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: async
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-- !ruby/object:Gem::Dependency
-  name: async-http-faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement