gemfather-stable 2.2.2

data/lib/api_generator/pagination/relation.rb

@@ -0,0 +1,114 @@
+class ApiGenerator::Pagination::Relation
+  include Enumerable
+
+  attr_reader :options
+
+  def initialize(config, options = {}, &fetch_block)
+    @config = config
+    @options = options
+    @fetch_block = fetch_block
+  end
+
+  # Получение всех записей начиная с текущей страницы (страницы грузятся по мере необходимости,
+  # и элементы передаются в enumerator)
+  def all_remaining
+    expand(all_remaining: true)
+  end
+
+  def order(sort)
+    expand(sort: sort)
+  end
+
+  # @return [Enumerator, ApiGenerator::Pagination::Relation] Enumerator по всем элементам,
+  # Если задана опция all_remaining, клиент посылает запросы за следующими страницами
+  # по мере необходимости, иначе загружаются только элементы текущей страницы
+  def each(&block)
+    return to_enum(:each) unless block
+
+    data.each(&block)
+
+    return self if !all_remaining? || last_page?
+
+    next_relation.each(&block)
+  end
+
+  # Возвращает ответ в исходном виде
+  def response
+    @response ||= fetch_block.call(self)
+  end
+
+  # @return [Integer] количество элементов на текущей странице
+  def size
+    data.size
+  end
+
+  # @return [Integer] общее количество элементов на всех страницах
+  # @raise [NotImplementedError] в случае, если коллбэк `total` не задан в конфиге DSL
+  def total
+    raise NotImplementedError, 'Total callback is not set in configuration' if config[:total].blank?
+
+    config[:total]&.call(response)
+  end
+  alias total_count total
+
+  # @return [Integer] общее количество элементов на всех страницах (сначала загрузит все страницы)
+  def total!
+    total
+  rescue NotImplementedError
+    self.class.new(config, {}, &fetch_block).all_remaining.count
+  end
+  alias total_count! total!
+
+  alias all to_a
+
+  def inspect
+    class_name_with_status = [self.class, ('(not fetched)' if @response.blank?)].compact.join(' ')
+
+    "#<#{class_name_with_status} #{options}>"
+  end
+
+  alias to_s inspect
+
+  def pretty_print(pretty_printer)
+    pretty_printer.text(inspect)
+  end
+
+  def request_options
+    options.except(:all_remaining)
+  end
+
+  private
+
+  attr_reader :fetch_block, :config
+
+  def data
+    case data_key
+    when Symbol, String
+      response.public_send(data_key)
+    when Array
+      response.dig(*data_key)
+    else
+      raise ArgumentError, 'Data key should be a symbol, string or array'
+    end
+  end
+
+  def expand(**options)
+    self.class.new(config, self.options.merge(options), &fetch_block)
+  end
+
+  def data_key
+    config[:data_key] || :itself
+  end
+
+  def all_remaining?
+    options[:all_remaining]
+  end
+
+  def next_relation
+    raise NotImplementedError
+  end
+
+  def last_page?
+    raise NotImplementedError
+  end
+end

data/lib/api_generator/pagination.rb

@@ -0,0 +1,2 @@
+module ApiGenerator::Pagination
+end

data/lib/api_generator/railtie.rb

@@ -0,0 +1,24 @@
+module ApiGenerator
+  module Railtie
+    # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+    def self.extended(klass)
+      return unless defined?(Rails)
+
+      klass.class_eval do |target_class|
+        initializer_name = "#{target_class.to_s.deconstantize.underscore}.configure"
+        initializer initializer_name, after: 'initialize_logger' do
+          target_class.name.deconstantize.constantize::Client.configure do |config|
+            config.user_agent = [
+              Rails.application.class.module_parent_name.underscore,
+              Rails.env,
+              config.user_agent,
+            ].join(' - ')
+
+            config.logger = Rails.logger if Rails.env.development? || Rails.env.test?
+          end
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+  end
+end

data/lib/api_generator/services/base_create.rb

@@ -0,0 +1,56 @@
+module ApiGenerator
+  module Services
+    class BaseCreate
+      include Helpers::Utils
+
+      attr_reader :target, :data
+
+      def initialize(target, data)
+        @target = target
+        @data = data
+      end
+
+      def call
+        raise NotImplementedError
+      end
+
+      private
+
+      def templates(name)
+        File.expand_path(templates_files[name.to_sym], templates_folder)
+      end
+
+      def folders(name)
+        File.expand_path(target_folders[name.to_sym], root)
+      end
+
+      def render_template(name)
+        render(templates(name.to_sym), data.for_template)
+      end
+
+      def root
+        target || File.expand_path(Dir.pwd)
+      end
+
+      def source_root
+        gemfather_lib_path = $LOAD_PATH.grep(/gems\/gemfather/).first
+
+        return File.expand_path('../', gemfather_lib_path) if gemfather_lib_path
+
+        File.expand_path('../../../', __dir__)
+      end
+
+      def templates_folder
+        File.expand_path('./templates', source_root)
+      end
+
+      def templates_files
+        raise NotImplementedError
+      end
+
+      def target_folders
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/api_generator/services/create_api.rb

@@ -0,0 +1,87 @@
+module ApiGenerator
+  module Services
+    class CreateApi < BaseCreate
+      PATH_MARKER = 'PATHS'.freeze
+      ACTION_MARKER = 'ACTIONS'.freeze
+      INCLUDE_MARKER = 'INCLUDES'.freeze
+
+      def call
+        prepare_folders
+
+        create_api_module
+        add_path
+        add_action
+        add_module_to_client
+
+        create_api_spec
+      end
+
+      private
+
+      def prepare_folders
+        create_dir(folders(:api))
+        create_dir(folders(:spec_api))
+      end
+
+      def create_api_module
+        return if File.exist?(api_module)
+
+        copy_template(templates(:api_module), api_module, data.for_template)
+      end
+
+      def add_path
+        inject_after_str(api_module, PATH_MARKER, render_template(:path))
+      end
+
+      def add_action
+        if data.paginate
+          inject_after_str(api_module, INCLUDE_MARKER, render_template(:include_helpers))
+          inject_after_str(api_module, ACTION_MARKER, render_template(:action_paginate))
+        else
+          inject_after_str(api_module, ACTION_MARKER, render_template(:action))
+        end
+      end
+
+      def add_module_to_client
+        inject_after_str(client_class, INCLUDE_MARKER, render_template(:include_namespace))
+      end
+
+      def create_api_spec
+        copy_template(templates(:api_spec), api_spec, data.for_template)
+      end
+
+      def api_module
+        File.expand_path("./#{data.namespace}.rb", folders(:api))
+      end
+
+      def client_class
+        File.expand_path('./client.rb', folders(:app))
+      end
+
+      def api_spec
+        File.expand_path("./#{data.namespace}_spec.rb", folders(:spec_api))
+      end
+
+      def templates_files
+        {
+          api_module: './api/api_module.erb',
+          path: './api/path.erb',
+          action: './api/action.erb',
+          action_paginate: './api/action_paginate.erb',
+          include_helpers: './api/include_helpers.erb',
+          include_namespace: './api/include_namespace.erb',
+          api_spec: './specs/api_spec.erb',
+        }
+      end
+
+      def target_folders
+        {
+          app: "./lib/#{data.app_short_name}",
+          api: "./lib/#{data.app_short_name}/api",
+          spec: './spec',
+          spec_api: './spec/api',
+        }
+      end
+    end
+  end
+end

data/lib/api_generator/services/create_model.rb

@@ -0,0 +1,69 @@
+module ApiGenerator
+  module Services
+    class CreateModel < BaseCreate
+      def call
+        prepare_folders
+
+        create_models
+        create_models_specs
+      end
+
+      private
+
+      def prepare_folders
+        create_dir(folders(:model_namespace_action))
+        create_dir(folders(:spec_model))
+      end
+
+      def create_models
+        models.each do |model|
+          copy_template(templates(model), target_model(model), data.for_template)
+        end
+      end
+
+      def create_models_specs
+        specs.each do |template|
+          copy_template(templates(template), target_spec(template), data.for_template)
+        end
+      end
+
+      def models
+        %i[request response]
+      end
+
+      def specs
+        %i[request_spec response_spec]
+      end
+
+      def target_spec(template)
+        File.expand_path("./#{template}.rb", folders(:spec_model))
+      end
+
+      def target_model(template)
+        File.expand_path("./#{template}.erb", folders(:model_namespace_action))
+      end
+
+      def target_folders
+        {
+          model: "./lib/#{data.app_short_name}/model",
+          model_namespace: "./lib/#{data.app_short_name}/model/#{data.namespace}",
+          model_namespace_action:
+            "./lib/#{data.app_short_name}/model/#{data.namespace}/#{data.action}",
+          spec: './spec',
+          spec_model: "./spec/model/#{data.namespace}/#{data.action}",
+        }
+      end
+
+      def templates_files
+        {
+          request: './models/request.erb',
+          response: './models/response.erb',
+          responses: './models/responses.erb',
+          paginated_response: './models/paginated_response.erb',
+          request_spec: './specs/request_spec.erb',
+          response_spec: './specs/response_spec.erb',
+        }
+      end
+    end
+  end
+end

data/lib/api_generator/services/create_scaffold.rb

@@ -0,0 +1,53 @@
+module ApiGenerator
+  module Services
+    class CreateScaffold
+      attr_accessor :namespace, :action, :http_method, :paginate
+
+      # rubocop:disable Style/OptionalBooleanParameter
+      def initialize(namespace, action, http_method, paginate = false, root = nil)
+        @namespace = namespace
+        @action = action
+        @http_method = http_method
+        @paginate = paginate
+        @root = root || File.expand_path(Dir.pwd)
+      end
+      # rubocop:enable Style/OptionalBooleanParameter
+
+      def call
+        create_api_w_specs
+        create_models_w_specs
+      end
+
+      private
+
+      def create_api_w_specs
+        Services::CreateApi.new(@root, data).call
+      end
+
+      def create_models_w_specs
+        Services::CreateModel.new(@root, data).call
+      end
+
+      def data
+        Models::Data.new(
+          namespace: namespace,
+          action: action,
+          http_method: http_method,
+          paginate: paginate,
+          app_name: app_name,
+          app_short_name: app_name,
+        )
+      end
+
+      def app_name
+        @app_name ||= begin
+          gemspec = Dir[File.expand_path('./*', @root)].grep(/\.gemspec/).first
+
+          raise 'Not root of the API gem' unless gemspec
+
+          File.basename(gemspec, '.gemspec')
+        end
+      end
+    end
+  end
+end

data/lib/api_generator/services/gemfather.rb

@@ -0,0 +1,81 @@
+module ApiGenerator
+  module Services
+    class Gemfather < Thor
+      include Thor::Actions
+
+      # octal notation for rubocop
+      EXEC_MODE = 0o0755
+
+      cattr_accessor :target_dir
+      attr_accessor :app_name, :app_name_class, :app_short_name,
+                    :app_short_name_class, :author, :email, :version
+
+      # rubocop:disable Metrics/MethodLength
+      desc 'generates API gem', 'generates basic API gem with the provided name'
+      def generate_client(app_name)
+        check_app_name(app_name)
+        setup_template_variables(app_name)
+
+        check_if_folder_exists
+
+        directory(template_path, destination_path, { context: binding })
+
+        inside(destination_path) do
+          empty_directory('log')
+          run('bundle')
+          run('bundle binstubs rspec-core rubocop --force')
+          run('git init')
+          set_executables
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      private
+
+      private_class_method :source_root
+
+      def check_app_name(app_name)
+        raise(Thor::Error, 'APP_NAME is not provided') unless app_name
+        raise(Thor::Error, "Folder #{app_name} name already exists") if Dir.exist?("./#{app_name}")
+      end
+
+      def setup_template_variables(app_name)
+        self.app_name = app_name
+        self.app_short_name = app_name
+        self.app_name_class = app_short_name.camelize
+        self.app_short_name_class = app_short_name.camelize
+        self.author = 'Domclick Ruby Team'
+        self.email = `git config user.email`
+        self.version = ApiGenerator::VERSION
+      end
+
+      def check_if_folder_exists
+        Dir.exist?(destination_path) &&
+          (file_collision(destination_path) ||
+            raise(Thor::Error, 'Directory already exists'))
+      end
+
+      def destination_path
+        File.expand_path(app_name, called_from_path)
+      end
+
+      def called_from_path
+        self.class.target_dir || Dir.pwd
+      end
+
+      def template_path
+        File.expand_path('./gem_template', self.class.source_root)
+      end
+
+      def set_executables
+        Dir[File.expand_path('./*', 'bin')].each do |file|
+          chmod(file, EXEC_MODE)
+        end
+      end
+
+      def self.source_root
+        File.expand_path('./../../../', __dir__)
+      end
+    end
+  end
+end

data/lib/api_generator/version.rb

@@ -0,0 +1,3 @@
+module ApiGenerator
+  VERSION = '2.2.2'.freeze
+end

data/lib/api_generator.rb

@@ -0,0 +1,18 @@
+require 'active_support'
+require 'active_support/inflector'
+require 'active_support/core_ext/module/introspection'
+require 'active_support/core_ext/object/try'
+require 'dry-configurable'
+require 'faraday_middleware'
+require 'faraday'
+require 'hashie'
+require 'delegate'
+require 'thor'
+require 'erb'
+
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ApiGenerator
+end

data/templates/api/action.erb

@@ -0,0 +1,10 @@
+def <%= action %>(request_or_hash)
+  request = if request_or_hash.is_a?(Model::<%= namespace.camelize %>::<%= action.camelize %>::Request)
+    request_or_hash
+  else
+    Model::<%= namespace.camelize %>::<%= action.camelize %>::Request.new(params)
+  end
+
+  response = connection.<%= http_method %>(<%= action.upcase %>_PATH, request)
+  Model::<%= namespace.camelize %>::<%= action.camelize %>::Response.new(response.body)
+end

data/templates/api/action_paginate.erb

@@ -0,0 +1,10 @@
+def <%= action %>(request_or_hash, &req_block)
+  request = if request_or_hash.is_a?(Model::<%= namespace.camelize %>::<%= action.camelize %>::Request)
+    request_or_hash
+  else
+    Model::<%= namespace.camelize %>::<%= action.camelize %>::Request.new(params)
+  end
+
+  response = connection.<%= http_method %>(<%= action.upcase %>_PATH, request, &req_block)
+  Model::<%= namespace.camelize %>::<%= action.camelize %>::Response.new(response.body)
+end

data/templates/api/api_module.erb

@@ -0,0 +1,11 @@
+module <%= app_short_name.camelize %>
+  module Api
+    module <%= namespace.camelize %>
+      # INCLUDES
+
+      # PATHS
+
+      # ACTIONS
+    end
+  end
+end

data/templates/api/include_helpers.erb

@@ -0,0 +1,9 @@
+include ApiGenerator::Pagination::Dsl
+
+paginate :<%= action %>,
+         with: :limit_offset,
+         on_request: proc { |req, limit: nil, offset: nil, sort: nil| }
+         data_key: :data_key,
+         limit: :limit.to_proc,
+         offset: :offset.to_proc,
+         total: :total.to_proc

data/templates/api/include_namespace.erb

@@ -0,0 +1 @@
+include <%= app_short_name.camelize %>::Api::<%= namespace.camelize %>

data/templates/api/path.erb

@@ -0,0 +1 @@
+<%= action.upcase %>_PATH = '/<%= action %>'.freeze

data/templates/models/request.erb

@@ -0,0 +1,11 @@
+module <%= app_short_name.camelize %>
+  module Model
+    module <%= namespace.camelize %>
+      module <%= action.camelize %>
+        class Request < ApiGenerator::Models::Base
+
+        end
+      end
+    end
+  end
+end

data/templates/models/response.erb

@@ -0,0 +1,11 @@
+module <%= app_short_name.camelize %>
+  module Model
+    module <%= namespace.camelize %>
+      module <%= action.camelize %>
+        class Response < ApiGenerator::Models::Base
+
+        end
+      end
+    end
+  end
+end

data/templates/specs/api_spec.erb

@@ -0,0 +1,15 @@
+require_relative '../spec_helper'
+
+RSpec.describe <%= app_short_name.camelize %>::Api::<%= namespace.camelize %> do
+  describe '<%= namespace %>' do
+    let(:client) { <%= app_short_name.camelize %>.client }
+
+    describe '#<%= action %>' do
+      let(:params) { {} }
+
+      it 'makes successful request', vcr: { cassette_name: '<%= namespace.camelize %>/<%= action %>/success' } do
+        expect { client.<%= action %>(params) }.not_to raise_error
+      end
+    end
+  end
+end

data/templates/specs/request_spec.erb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe <%= app_short_name.camelize %>::Model::<%= namespace.camelize %>::<%= action.camelize %>::Request do
+  describe 'request model' do
+    let(:properties) { {} }
+    let(:model) { described_class.new(properties) }
+
+    it 'behaves like request' do
+      expect(model).to eq(properties)
+    end
+  end
+end

data/templates/specs/response_spec.erb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe <%= app_short_name.camelize %>::Model::<%= namespace.camelize %>::<%= action.camelize %>::Response do
+  describe 'response model' do
+    let(:properties) { {} }
+    let(:model) { described_class.new(properties) }
+
+    it 'behaves like response' do
+      expect(model).to eq(properties)
+    end
+  end
+end