http-client-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e5c3210ef78433dbd893dd84ab971e11b72aa0485cafc8ba368e15f6f9b17ae
+  data.tar.gz: e4037a905331797ec6c6592b5e60fbdf4d21096f0145af079843036083ae7ece
+SHA512:
+  metadata.gz: 243f6a23d704b53248ec48e5097c02a39127b6fd66bdda1b37cb61d2296b092c073a18544bc48f5fbf686e4ebcf202440f05361bfebd2c202158bb32fb1d8cc8
+  data.tar.gz: db2e2547997536e89ac232d5d78ddfa6fcfebe7d6a7d143c41a598040eabe906b9279be5465ee4254383af56f2744a924294ad71b5e33fdf27a969b532b21648

data/README.md

@@ -0,0 +1,39 @@
+# Http::Client::Generator
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/http/client/generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/http-client-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/http-client-generator/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Http::Client::Generator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/http-client-generator/blob/master/CODE_OF_CONDUCT.md).

data/lib/http_client_generator/plugs/camelize_body.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  class Plugs
+    class CamelizeBody
+      Plugs.register :camelize_body, self
+
+      def initialize(_); end
+
+      def call(req)
+        body =
+          if req.json? && req.body.is_a?(Hash)
+            req.body.deep_transform_keys { |key| key.to_s.camelize(:lower).to_sym }
+          else
+            req.body
+          end
+
+        req.body = body
+
+        req
+      end
+    end
+  end
+end

data/lib/http_client_generator/plugs/set_request_id.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module HttpClientGenerator
+  class Plugs
+    class SetRequestid
+      Plugs.register :set_request_id, self
+
+      def initialize(header_name)
+        @header_name = header_name
+      end
+
+      def call(req)
+        req.headers[@header_name] = req.rest_args[:request_id] || SecureRandom.uuid
+        req
+      end
+    end
+  end
+end

data/lib/http_client_generator/plugs/underscore_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  class Plugs
+    class UnderscoreResponse
+      Plugs.register :underscore_response, self
+
+      def initialize(_); end
+
+      def call(req)
+        return req unless req.response_body.is_a?(Hash)
+
+        req.response_body = req.response_body.deep_transform_keys(&:underscore)
+
+        req
+      end
+    end
+  end
+end

data/lib/http_client_generator/plugs.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  class Plugs
+    include Singleton
+
+    def self.reqister(key, plug)
+      unless plug.respond_to?(:call)
+        raise "Plug should respond to #call got #{plug.inspect}"
+      end
+
+      instance.register(key, plug)
+    end
+
+    def self.read(key)
+      unless key.is_a?(Symbol)
+        raise "Expected symbol got #{key.inspect}"
+      end
+
+      instance.read(key)
+    end
+
+    def register(key, plug)
+      storage[key] = plug
+    end
+
+    def read(key)
+      storage[key]
+    end
+
+    private
+
+    def storage
+      @storage ||= {}
+    end
+  end
+end

data/lib/http_client_generator/request.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'http'
+
+module HttpClientGenerator
+  class Request
+    CONTENT_TYPES = %i[json text].freeze
+
+    DEFAULT_HEADERS_BY_CONTENT_TYPE = {
+      json: { accept: 'application/json', content_type: 'application/json' },
+      text: { content_type: 'text/plain' },
+    }.freeze
+
+    CONTENT_TYPES.each do |content_type|
+      define_method "#{content_type}?" do |request|
+        content_type == request.content_type
+      end
+    end
+
+    attr_accessor :verb, :content_type, :url, :headers, :body, :request_id, :response_body
+
+    def initialize(verb:, content_type:, url:, body:, rest_args:)
+      @verb = verb
+      @content_type = content_type
+      @url = url
+      @rest_args = rest_args
+      @body = body
+      @headers = {}
+    end
+
+    private
+
+    def default_headers
+      DEFAULT_HEADERS_BY_CONTENT_TYPE[content_type]
+    end
+  end
+end
+

data/lib/http_client_generator/resource.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  class Resource
+    attr_reader :verb, :content_type, :name, :req_plugs, :resp_plugs
+
+    def initialize(verb:, content_type:, name:, req_plugs:, resp_plugs:)
+      @verb = verb
+      @content_type = content_type
+      @name = name
+      @req_plugs = req_plugs
+      @resp_plugs = resp_plugs
+    end
+
+    def perform_request(url_helper, base, url_options, body, rest_args)
+      request = prepare_request(url_helper, url_options, body, rest_args)
+
+      request_attributes = [request.verb, request.url]
+
+      if request.body
+        request.body = request.body.to_json if request.json?
+        request_attributes << { body: request.body }
+      end
+
+      request.response_body = HTTP[request.headers].public_send(*request_attributes).to_s
+
+      process_response(request)
+    rescue HTTP::Error => e
+      raise base::RequestError, e.message, e.backtrace, cause: nil
+    end
+
+    private
+
+    def prepare_request(url_helper, url_options, body, rest_args)
+      url = url_helper.public_send(:"#{name}", url_options)
+
+      request = Request.new(
+        verb: verb, url: url, content_type: content_type, body: body, rest_args: rest_args
+      )
+
+      req_plugs.reduce(request) { |req, plug| plug.call(req) }
+    end
+
+    def process_response(request)
+      request.response_body =
+        begin
+          request.response_body = JSON.parse(request.response_body, symbolize_names: true)
+        rescue JSON::ParserError
+          request.response_body
+        end
+
+      resp_plugs.reduce(request) { |req, plug| plug.call(req) }
+    end
+  end
+end

data/lib/http_client_generator/resources_definition.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  class ResourcesDefinition
+    attr_reader :resources
+
+    DEFAULT_OPTIONS = {
+      content_type: :json
+    }.freeze
+
+    HTTP_VERBS = %i[get post put patch].freeze
+
+    def initialize(req_plugs = [], resp_plugs = [])
+      @resources = []
+      @req_plugs = req_plugs
+      @resp_plugs = resp_plugs
+    end
+
+    HTTP_VERBS.each do |verb|
+      define_method(verb) do |name, **options|
+        @resources << build_resource(verb, name, options)
+      end
+    end
+
+    def req_plug(plug, *args, **kwargs)
+      @req_plugs <<
+        if plug.respond_to?(:call)
+          plug
+        else if plug.respond_to?(:new)
+          plug.new(*args, **kwargs)
+        else
+          Plugs.read(plug).new(*args, **kwargs)
+        end
+    end
+
+    def resp_plug(plug, *args, **kwargs)
+      @resp_plugs <<
+        if plug.respond_to?(:call)
+          plug
+        else if plug.respond_to?(:new)
+          plug.new(*args, **kwargs)
+        else
+          Plugs.read(plug).new(*args, **kwargs)
+        end
+    end
+
+    def namespace(_name, &block)
+      namespaced_definition = ResourcesDefinition.new(req_plugs, resp_plugs)
+      namespaced_definition.instance_eval(&block)
+      @resources << namespaced_definition.resources
+    end
+
+    private
+
+    def build_resource(verb, name, options)
+      Resource.new(
+        verb: verb, name: name, req_plugs: @req_plugs, resp_plugs: @resp_plugs, **with_defaults(options)
+      )
+    end
+
+    def with_defaults(options)
+      DEFAULT_OPTIONS.merge(options)
+    end
+  end
+end

data/lib/http_client_generator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HttpClientGenerator
+  VERSION = '0.1.0'
+end

data/lib/http_client_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+Zeitwerk::Loader.for_gem.setup
+
+module HttpClientGenerator
+  def self.included(base)
+    super
+
+    base.extend(self)
+    base.const_set(:Error, Class.new(StandardError))
+    base.const_set(:RequestError, Class.new(base::Error))
+  end
+
+  def url_helper(module_name)
+    @url_helper = module_name
+  end
+
+  def resources(&block)
+    resources_definition = ResourcesDefinition.new
+    resources_definition.instance_eval(&block)
+    resources = resources_definition.resources
+
+    resources.each do |resource|
+      method_name = :"#{resource.name}_#{resource.verb}"
+
+      define_singleton_method(method_name) do |url_options = {}, body: nil, **rest_args|
+        resource.perform_request(@url_helper, @base, url_options, body, rest_args)
+      end
+    end
+  end
+
+  def configure(&configure)
+    @config = self.class::Configuration.new
+      .tap(&configure)
+      .tap { |c| user_process_config(c) if respond_to?(:user_process_config) }
+      .tap(&:freeze)
+  end
+
+  def process_config(&block)
+    define_singleton_method(:user_process_config, block)
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: http-client-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Egorov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Ruby Http Client generator
+email:
+- moonmeander47@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/http_client_generator.rb
+- lib/http_client_generator/plugs.rb
+- lib/http_client_generator/plugs/camelize_body.rb
+- lib/http_client_generator/plugs/set_request_id.rb
+- lib/http_client_generator/plugs/underscore_response.rb
+- lib/http_client_generator/request.rb
+- lib/http_client_generator/resource.rb
+- lib/http_client_generator/resources_definition.rb
+- lib/http_client_generator/version.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Ruby Http Client generator
+test_files: []