dyn-api-gen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 111b28326bb3103ebbe599f9aff1c0954dc043772493b72d473f7c5dd7a280be
+  data.tar.gz: b29bc2a3e7444a41981ee241d8fd96270ffab3bc1fa324b0dd7b3838e47570e3
+SHA512:
+  metadata.gz: 40fb530f33a34df9330de1aec000c5b4663f67ffea43855afd018257ec51fedb11db0e1cca78ff3bf9a312886354729f7b0784b02a4a1b110c5bffbba201c013
+  data.tar.gz: 6bee1fbbdcdefd82197db66bc9431103999d75ded12e957f459ccd273f9458170b5e7a8597783fd752fb6c791314beb9e63d211c70d756f7674cb541ca552a53

data/README.md

@@ -0,0 +1,21 @@
+# dyn-api-gen
+Dynamic API client generator. Aims to follow OpenAPI + JSON API standards
+
+
+# Usage (WIP)
+
+
+```ruby
+ApiClient = DynApiGen::Generator.generate('./swagger/v1/openapi.yaml')
+
+request =
+  EmancuApiClient::SalesmatchingMakeAliases
+    .delete_salesmatching_make_alias
+    .with_headers
+    .with_dealership_id(5)
+    .with_page_size(4)
+    .with_filter_deal_type('some,valid,filters')
+
+# EmancuApiClient.send_request(request, with_jwt: '123')
+
+```

data/dyn-api-gen.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'dyn-api-gen'
+  s.version     = '0.0.1'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = 'Dynamic API client generator. Aims to follow OpenAPI + JSON API standards'
+  s.authors     = ['Emiliano Mancuso']
+  s.email       = ['emiliano.mancuso@gmail.com', 'developers@carwow.co.uk']
+  s.homepage    = 'http://github.com/carwow/dyn-api-gen'
+  s.license     = 'MIT'
+
+  s.files = Dir[
+    'README.md',
+    'rakefile',
+    'lib/**/*.rb',
+    '*.gemspec'
+  ]
+  s.test_files = Dir['test/*.*']
+
+  s.add_development_dependency 'test-unit', '~> 3.3'
+end

data/lib/dyn_api_gen.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require_relative 'dyn_api_gen/parameter'
+require_relative 'dyn_api_gen/request'
+require_relative 'dyn_api_gen/generator'
+
+module DynApiGen
+
+end

data/lib/dyn_api_gen/generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module DynApiGen
+  class Generator
+    RequestDefinition = Struct.new(:namespace, :name, :verb, :path, :parameters)
+
+    def initialize(openapi_path)
+      @openapi_path = openapi_path
+      @module = Module.new
+    end
+
+    def self.generate(path)
+      new(path).generate
+    end
+
+    def generate
+      requests = []
+
+      openapi['paths'].each do |path, endpoints|
+        endpoints.each do |verb, detail|
+          name = to_underscore(detail.fetch('operationId'))
+          parameters = detail.fetch('parameters').map(&Parameter.method(:new))
+
+          detail.fetch('tags').each do |namespace|
+            requests << RequestDefinition.new(to_camelcase(namespace), name, verb, path, parameters)
+          end
+        end
+      end
+
+      requests.group_by(&:namespace).each do |namespace, req_definitions|
+        namespace_module = Module.new
+        puts namespace
+        req_definitions.each do |req_def|
+          puts "> #{req_def.name}"
+          namespace_module.define_singleton_method(req_def.name) do
+            Request.new(req_def.to_h)
+          end
+        end
+
+        @module.send(:const_set, namespace, namespace_module)
+        # @module.const_set(namespace, namespace_module)
+      end
+
+      @module
+    end
+
+    private
+
+    def openapi
+      @openapi ||= YAML.load_file(@openapi_path)
+    end
+
+    def to_underscore(str)
+      str.gsub(/(.)([A-Z])/, '\1_\2').downcase
+    end
+
+    def to_camelcase(str)
+      str.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/dyn_api_gen/parameter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DynApiGen
+  class Parameter
+    attr_reader :name, :in, :required, :default
+
+    def initialize(openapi_definition)
+      @name, @in, @required = openapi_definition.fetch_values('name', 'in', 'required')
+      @default = openapi_definition['default']
+    end
+
+    def header?
+      @in == 'header'
+    end
+
+    def to_method_name
+      @name.gsub(/(\[|\])/, '[' => '_', ']' => '').downcase
+    end
+  end
+end

data/lib/dyn_api_gen/request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module DynApiGen
+  class Request
+    def initialize(**kwargs)
+      @name, @verb, @path, @parameters =
+        kwargs.fetch_values(:name, :verb, :path, :parameters)
+
+      @with_params = {}
+      @with_headers = {}
+
+      create_with_methods!
+      fill_default_headers
+      fill_default_params
+    end
+
+    # Setthe headers to be used. It merges whatever is defined
+    def with_headers(new_headers)
+      @with_headers.merge!(new_headers)
+      self
+    end
+
+    private
+
+    # This method will generate the `with_*` instance methods dynamically,
+    # to set the params needed by this request.
+    def create_with_methods!
+      @parameters.reject(&:header?).each do |parameter|
+        self.class.define_method(:"with_#{parameter.to_method_name}") do |value|
+          @with_params[parameter.name] = value
+          self
+        end
+      end
+    end
+
+    def fill_default_headers
+      @parameters.select { |p| p.header? && p.default }.each do |parameter|
+        @with_headers[parameter.name] = parameter.default
+      end
+    end
+
+    def fill_default_params
+      @parameters.select { |p| !p.header? && p.default }.each do |parameter|
+        @with_params[parameter.name] = parameter.default
+      end
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,8 @@
+task :default => :test
+
+desc 'Run tests'
+task :test do
+  require File.expand_path('./test/helper', File.dirname(__FILE__))
+
+  Dir['test/**/*_test.rb'].each { |file| load file }
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'rubygems'
+require 'bundler/setup'
+require 'dyn_api_gen'
+require 'test/unit'
+
+def reject(condition, message="Expected condition to be unsatisfied")
+  assert !condition, message
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: dyn-api-gen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Emiliano Mancuso
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description:
+email:
+- emiliano.mancuso@gmail.com
+- developers@carwow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- dyn-api-gen.gemspec
+- lib/dyn_api_gen.rb
+- lib/dyn_api_gen/generator.rb
+- lib/dyn_api_gen/parameter.rb
+- lib/dyn_api_gen/request.rb
+- rakefile
+- test/helper.rb
+homepage: http://github.com/carwow/dyn-api-gen
+licenses:
+- MIT
+metadata: {}
+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.1.6
+signing_key:
+specification_version: 4
+summary: Dynamic API client generator. Aims to follow OpenAPI + JSON API standards
+test_files:
+- test/helper.rb