micro_api 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 760d9919d69b54e4fedf75c0d33c3e5fd92b40b90d276f0c5b03957e59c1cc03
-  data.tar.gz: f4d1dbd92376d089ba6e1dbc2ec68b4f4a7f19c9dd6da4c98c991533ec8dfc49
+  metadata.gz: 931fe90b19dce2b382d2bf2a9aaa8c8387d8e473cd12ce31a9f9c7faa74cd10b
+  data.tar.gz: '091df9223364158ce18f3adaf343e8ee42c62df40b0e2745af75e8d1e132d7be'
 SHA512:
-  metadata.gz: 6f18a322f332c97f230b3cd92dcd5a674b74556c3c3ddbccd45fc2afcd8546661924e61d8e7d70dcc09648eecf07baac78da4dc0517852b8081fbe778bb24831
-  data.tar.gz: 6fbe29b7dd071e6d80d7f64c28e32e9bf4f04c615a74fe9b6c954ac2b6df93aed373efec7ed66ec60ceffc0c2d1ed3a678ae37bc204be402d4e2cb3f8e21fda6
+  metadata.gz: c1fb1c1fa9ec7b39e6f37ce75493e0d0ebc5693d107d93cedf259771d444b0b11aca0e850eafa00ad5ae2caa72b9245d92a7314c6f95df3366009250545243b5
+  data.tar.gz: 452621f6f949ccaa271e62952ea28708841d1e589fff4268fbd223c5fae47486eee3bf741b42db0995a67cae650522e0a04b07dc541cd57611183ea1325fa438

data/README.md

@@ -1,5 +1,5 @@
 # MicroApi
-Short description and motivation.
+This is a Rails plugin that would like to help the startup of rails applications oriented to microservices or, in general, application deployed on the cloud.
 
 ## Usage
 How to use my plugin.
@@ -13,7 +13,8 @@ gem "micro_api"
 
 And then execute:
 ```bash
-$ bundle
+bundle
+bundle exec rails generate micro_api:install
 ```
 
 Or install it yourself as:

data/app/controllers/micro_api/static_controller.rb

@@ -12,5 +12,10 @@ module MicroApi
         itag: ENV.fetch("IMAGE_TAG", nil),                    # image tag
       }
     end
+
+    def no_route_matches
+      exception = ActionController::RoutingError.new("No route matches [#{request.method}] #{request.path}")
+      render json: { error: exception.message }, status: :not_found
+    end
   end
 end

data/lib/generators/micro_api/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Main installation generator.
+
+Example:
+    bin/rails generate micro_api:install
+
+    This will create:
+        - config/initializers/micro_api.rb
+        - config/environments/staging.rb

data/lib/generators/micro_api/install/install_generator.rb

@@ -0,0 +1,68 @@
+module MicroApi
+  # main generator installer
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    argument :component, type: :string, default: 'all',
+                         banner: "all|application|initializer|route"
+
+    def main
+      method_name = "generate_micro_api_#{component}"
+      return unless self.class.private_method_defined?(method_name)
+
+      send(method_name)
+    end
+
+    private
+
+    def local_methods
+      private_methods.select { |e| e.to_s.include? "generate_micro_api_" }
+    end
+
+    desc "This generator creates all installs"
+    def generate_micro_api_all
+      local_methods.each do |method_name|
+        next if method_name == __method__
+
+        send(method_name)
+      end
+    end
+
+    desc "This generator add row in application.rb file"
+    def generate_micro_api_application
+      application_list = ["\n"]
+      application_list << "config.active_record.default_timezone = :utc" if defined?(ActiveRecord)
+      application_list << "config.time_zone = 'CET'"
+
+      inject_into_file 'config/application.rb', before: /\n  end$/ do
+        application_list.join("\n    ").gsub("    \n", "\n")
+      end
+    end
+
+    desc "This generator creates an initializer file at config/initializers"
+    def generate_micro_api_initializer
+      template "micro_api.rb", "#{Rails.root}/config/initializers/micro_api.rb"
+      template "staging.rb", "#{Rails.root}/config/environments/staging.rb"
+    end
+
+    desc "This generator add 'api namespace' rows in routes.rb file"
+    def generate_micro_api_route_api_namespace
+      inject_into_file 'config/routes.rb', before: "  # Defines the root path route" do
+        "  namespace :api, defaults: { format: :json } do\n  end\n\n"
+      end
+    end
+
+    desc "This generator add final rows in routes.rb file"
+    def generate_micro_api_route_last
+      routes_list = [
+        "\n",
+        "mount MicroApi::Engine, at: MicroApi.routes_path, as: '#{MicroApi.routes_path}'",
+        "match '*path', to: 'micro_api/static#no_route_matches', via: :all"
+      ]
+
+      inject_into_file 'config/routes.rb', before: /\nend$/ do
+        routes_list.join("\n  ").gsub("  \n", "\n")
+      end
+    end
+  end
+end

data/lib/generators/micro_api/install/templates/micro_api.rb

@@ -0,0 +1,5 @@
+require 'micro_api'
+
+MicroApi.setup do |config|
+  config.routes_path = "/mse"
+end

data/lib/generators/micro_api/install/templates/staging.rb

@@ -0,0 +1,5 @@
+require_relative "production"
+
+Rails.application.configure do
+  # Your overriders goes here...
+end

data/lib/micro_api/engine.rb

@@ -1,8 +1,34 @@
+require 'lograge'
+
 module MicroApi
   class Engine < ::Rails::Engine
     isolate_namespace MicroApi
     config.generators.api_only = true
 
+    initializer "micro_api.lograge.init" do |app|
+      app.configure do
+        config.lograge.enabled = true
+        config.lograge.base_controller_class = "ActionController::API"
+        config.lograge.formatter = Lograge::Formatters::Json.new
+        config.colorize_logging = false
+        config.lograge.logger = ActiveSupport::Logger.new($stdout)
+
+        config.lograge.ignore_custom = lambda do |event|
+          event.payload[:path] == "#{MicroApi.routes_path}/healthz" && event.payload[:request].remote_ip =~ /^10\./
+        end
+        config.lograge.custom_payload do |controller|
+          {
+            level: :info,
+            log_type: :rails,
+            request_id: controller.request.request_id,
+            host: controller.request.host,
+            remote_ip: controller.request.remote_ip,
+            image_tag: ENV['IMAGE_TAG']
+          }
+        end
+      end
+    end
+
     config.generators do |g|
       g.test_framework :rspec,
         controller_specs: true,

data/lib/micro_api/version.rb

@@ -1,3 +1,3 @@
 module MicroApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/micro_api.rb

@@ -2,5 +2,12 @@ require "micro_api/version"
 require "micro_api/engine"
 
 module MicroApi
-  # Your code goes here...
+  
+  mattr_accessor :routes_path
+  @@routes_path = "/mse"  
+
+  def self.setup
+    yield self
+  end
+
 end

data/spec/dummy/config/application.rb

@@ -37,5 +37,7 @@ module Dummy
     config.api_only = true
 
     config.hosts << "www.example.com"
+
+    config.time_zone = 'CET'
   end
 end

data/spec/dummy/config/routes.rb

@@ -1,3 +1,14 @@
 Rails.application.routes.draw do
-  mount MicroApi::Engine => "/micro_api"
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  namespace :api, defaults: { format: :json } do
+  end
+
+  # Defines the root path route ("/")
+  # root "articles#index"
+
+  # mount MicroApi::Engine => "/micro_api"
+
+  mount MicroApi::Engine, at: MicroApi.routes_path, as: '/mse'
+  match '*path', to: 'micro_api/static#no_route_matches', via: :all
 end

data/spec/generator/micro_api/installs_generator_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+require 'rails/generators'
+require 'generators/micro_api/install/install_generator'
+
+RSpec.describe MicroApi::InstallGenerator, type: :generator do
+  before :all do
+    remove_config
+  end
+
+  after :all do
+    remove_config
+  end
+
+  it 'installs config file properly' do
+    described_class.start
+    system "cd spec/dummy/ && bin/rails generate micro_api:install"
+    expect(File.file?(config_file)).to be true
+    expect(File.file?(staging_env_file)).to be true
+  end
+
+  it 'installs config file properly routing', type: :routing do
+    expect(get("#{MicroApi.routes_path}/version")).to route_to(
+      controller: 'micro_api/static',
+      action: 'version',
+      format: :json
+    )
+
+    expect(get("#{MicroApi.routes_path}/healthz")).to route_to(
+      controller: 'micro_api/static',
+      action: 'healthz',
+      format: :json
+    )
+  end
+end

data/spec/rails_helper.rb

@@ -57,4 +57,5 @@ RSpec.configure do |config|
   # config.filter_gems_from_backtrace("gem name")
 
   config.include RequestSpecHelper, type: :request
+  config.include FileSpecHelper, type: :generator
 end

data/spec/requests/micro_api/static_healthz_spec.rb

@@ -0,0 +1,21 @@
+require 'rails_helper'
+
+RSpec.describe "Statics" do
+  describe "GET /healthz" do
+    before { @route = get("#{MicroApi.routes_path}/healthz") }
+
+    it "returns http success", type: :request do
+      expect(response).to have_http_status(:success)
+      expect(response.header['Content-Type']).to include 'application/json'
+      expect(json).to have_key('status')
+    end
+
+    it "routes /micro_api/version to the static controller", type: :routing do
+      expect(@route).to route_to(
+        controller: 'micro_api/static',
+        action: 'healthz',
+        format: :json
+      )
+    end
+  end
+end

data/spec/requests/micro_api/static_spec.rb

@@ -1,25 +1,14 @@
 require 'rails_helper'
 
 RSpec.describe "Statics", type: :request do
-  describe "GET /healthz" do
-    it "returns http success" do
-      get "/micro_api/healthz"
-      expect(response).to have_http_status(:success)
-      expect(response.header['Content-Type']).to include 'application/json'
-      expect(json).not_to be_empty
-      expect(json).to have_key('status')
-    end
-  end
-
-  describe "GET /version" do
-    it "returns http success" do
-      get "/micro_api/version"
-      expect(response).to have_http_status(:success)
-      expect(response.header['Content-Type']).to include 'application/json'
-      expect(json).not_to be_empty
-      expect(json).to have_key('env')
-      expect(json).to have_key('cenv')
-      expect(json).to have_key('itag')
+  describe "GET /" do
+    context 'when the route does not exist' do
+      it "returns http success" do
+        get "#{MicroApi.routes_path}/"
+        expect(response).to have_http_status(:not_found)
+        expect(response.header['Content-Type']).to include 'application/json'
+        expect(json).not_to be_empty
+      end
     end
   end
 end

data/spec/requests/micro_api/static_version_spec.rb

@@ -0,0 +1,21 @@
+require 'rails_helper'
+
+RSpec.describe "Statics" do
+  describe "GET /version" do
+    before { @route = get("#{MicroApi.routes_path}/version") }
+
+    it "returns http success", type: :request do
+      expect(response).to have_http_status(:success)
+      expect(response.header['Content-Type']).to include 'application/json'
+      expect(json.keys).to contain_exactly('ac', 'cenv', 'env', 'itag')
+    end
+
+    it "routes /micro_api/version to the static controller", type: :routing do
+      expect(@route).to route_to(
+        controller: 'micro_api/static',
+        action: 'version',
+        format: :json
+      )
+    end
+  end
+end

data/spec/support/file_spec_helper.rb

@@ -0,0 +1,16 @@
+require 'fileutils'
+
+module FileSpecHelper
+  def config_file
+    "#{Rails.root}/config/initializers/micro_api.rb"
+  end
+
+  def staging_env_file
+    "#{Rails.root}/config/environments/staging.rb"
+  end
+
+  def remove_config
+    FileUtils.remove_file config_file      if File.file?(config_file)
+    FileUtils.remove_file staging_env_file if File.file?(staging_env_file)
+  end
+end

data/spec/support/request_spec_helper.rb

@@ -2,6 +2,6 @@ module RequestSpecHelper
   def json
     @json ||= JSON.parse(response.body)
   rescue
-    @json ||= nil
+    @json ||= {}
   end
 end

metadata

@@ -1,31 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: micro_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-19 00:00:00.000000000 Z
+date: 2023-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,13 +53,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: lograge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -58,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.4.3
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.4.3
+        version: 6.0.0
 description: Rails engine plugin that would like to help the startup of rails applications
   oriented to microservices or, in general, to the cloud.
 email:
@@ -81,6 +95,10 @@ files:
 - app/controllers/micro_api/static_controller.rb
 - app/models/micro_api/application_record.rb
 - config/routes.rb
+- lib/generators/micro_api/install/USAGE
+- lib/generators/micro_api/install/install_generator.rb
+- lib/generators/micro_api/install/templates/micro_api.rb
+- lib/generators/micro_api/install/templates/staging.rb
 - lib/micro_api.rb
 - lib/micro_api/engine.rb
 - lib/micro_api/version.rb
@@ -103,9 +121,13 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/puma.rb
 - spec/dummy/config/routes.rb
+- spec/generator/micro_api/installs_generator_spec.rb
 - spec/rails_helper.rb
+- spec/requests/micro_api/static_healthz_spec.rb
 - spec/requests/micro_api/static_spec.rb
+- spec/requests/micro_api/static_version_spec.rb
 - spec/spec_helper.rb
+- spec/support/file_spec_helper.rb
 - spec/support/request_spec_helper.rb
 homepage: https://github.com/lelered/micro_api
 licenses:
@@ -130,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Engine plugin for Ruby on Rails applications
@@ -153,7 +175,11 @@ test_files:
 - spec/dummy/config/puma.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/config.ru
+- spec/generator/micro_api/installs_generator_spec.rb
 - spec/rails_helper.rb
+- spec/requests/micro_api/static_healthz_spec.rb
 - spec/requests/micro_api/static_spec.rb
+- spec/requests/micro_api/static_version_spec.rb
 - spec/spec_helper.rb
+- spec/support/file_spec_helper.rb
 - spec/support/request_spec_helper.rb