micro_api 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88d34ac6588812baff48c14c12b1ab5dac85de8ce875a633b10ed557fd207319
-  data.tar.gz: '0924c15c703900c1fb9f90387bd1af51da634ca1d52bc4eae3436b93080cc954'
+  metadata.gz: 99a6cfc6d82c9d35036f0b7fffb1a7076ad78593e731ee1a025e68fcb60d82dd
+  data.tar.gz: 41a25e79645d7f6bb5b9f3135bbb0436ab96ac15f2492512d47c4b6b7ecd9aca
 SHA512:
-  metadata.gz: e792082eb0e8dddfd11db78b6f8ffe85219851d7599fb1c1c0035803ae9de121985cab7a5f61b79ff568a0a0597b94b772a8c8fe1140f08ade427acc8260c0be
-  data.tar.gz: 523a47666b6ab4affed06d1fd0e3c30b52e7a0c9409d246ddc8f811b893a65fb219a51b874db5830ee3c397e530d511e39eff49641562b0be8b4a08edb37c162
+  metadata.gz: 9d7f1a612213b649bbe000fef4878674733fa2834406d3151e64b0d8fc25d2575166832a6db26e435b6d1be1fa4ce78e23e82373e73da1d429ec28ca392dee5d
+  data.tar.gz: 917ab03be4c3901914ab3c1c21c339fa09eae405889891f7209fe0f70e965782f08fbfeecef2d5012baa76e8451b5153aaa3a9aff982f89afcbc2aa8f18b0995

data/README.md

@@ -2,7 +2,16 @@
 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.
+How to use my plugin in a existing project
+```bash
+bundle add micro_api
+```
+
+
+```bash
+gem install micro_api
+```
+
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -10,6 +19,11 @@ Add this line to your application's Gemfile:
 ```ruby
 gem "micro_api"
 ```
+from localpath
+```ruby
+gem 'micro_api', path: '/gems/micro_api'
+```
+
 
 And then execute:
 ```bash

data/app/controllers/micro_api/static_controller.rb

@@ -9,6 +9,7 @@ module MicroApi
         ac:   Rails.application.class.to_s.split("::").first, # app code
         cenv: ENV.fetch("CLOUD_ENV", "local"),                # cloud env
         env:  Rails.env,                                      # rails env
+        av:   app_version,
         itag: ENV.fetch("IMAGE_TAG", nil),                    # image tag
       }
     end
@@ -17,5 +18,13 @@ module MicroApi
       exception = ActionController::RoutingError.new("No route matches [#{request.method}] #{request.path}")
       render json: { error: exception.message }, status: :not_found
     end
+
+    private
+
+    def app_version
+      Rails.application.class::VERSION
+    rescue StandardError
+      nil
+    end
   end
 end

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

@@ -30,8 +30,13 @@ module MicroApi
 
     desc "This generator add row in application.rb file"
     def generate_micro_api_application
-      application 'config.active_record.default_timezone = :utc' if defined?(ActiveRecord)
-      application 'config.time_zone = "CET"'
+      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"
@@ -40,10 +45,24 @@ module MicroApi
       template "staging.rb", "#{Rails.root}/config/environments/staging.rb"
     end
 
-    desc "This generator add row in routes.rb file"
-    def generate_micro_api_route
-      route "mount MicroApi::Engine, at: MicroApi.routes_path, as: '#{MicroApi.routes_path}'"
-      route "match '*path', to: 'micro_api/static#no_route_matches', via: :all"
+    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/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.1"
+  VERSION = "0.1.3"
 end

data/spec/dummy/config/application.rb

@@ -21,6 +21,8 @@ require "micro_api"
 
 module Dummy
   class Application < Rails::Application
+    VERSION = '1.2.3'.freeze
+
     config.load_defaults Rails::VERSION::STRING.to_f
 
     # Configuration for the application, engines, and railties goes here.
@@ -38,6 +40,6 @@ module Dummy
 
     config.hosts << "www.example.com"
 
-    config.time_zone = "CET"
+    config.time_zone = 'CET'
   end
 end

data/spec/dummy/config/routes.rb

@@ -1,5 +1,14 @@
 Rails.application.routes.draw do
+  # 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/requests/micro_api/static_healthz_spec.rb

@@ -4,6 +4,12 @@ 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',
@@ -11,10 +17,5 @@ RSpec.describe "Statics" do
         format: :json
       )
     end
-    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
   end
 end

data/spec/requests/micro_api/static_version_spec.rb

@@ -7,7 +7,8 @@ RSpec.describe "Statics" do
     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')
+      expect(json.keys).to contain_exactly('ac', 'cenv', 'env', 'itag', 'av')
+      expect(json['av']).to eq('1.2.3'.freeze)
     end
 
     it "routes /micro_api/version to the static controller", type: :routing do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: micro_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - ''
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-25 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -107,8 +121,6 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/puma.rb
 - spec/dummy/config/routes.rb
-- spec/dummy/log/development.log
-- spec/dummy/tmp/development_secret.txt
 - spec/generator/micro_api/installs_generator_spec.rb
 - spec/rails_helper.rb
 - spec/requests/micro_api/static_healthz_spec.rb
@@ -125,7 +137,7 @@ metadata:
   homepage_uri: https://github.com/lelered/micro_api
   source_code_uri: https://github.com/lelered/micro_api
   changelog_uri: https://github.com/lelered/micro_api/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
-signing_key:
+rubygems_version: 3.4.19
+signing_key: 
 specification_version: 4
 summary: Engine plugin for Ruby on Rails applications
 test_files:
@@ -163,8 +175,6 @@ test_files:
 - spec/dummy/config/puma.rb
 - spec/dummy/config/routes.rb
 - spec/dummy/config.ru
-- spec/dummy/log/development.log
-- spec/dummy/tmp/development_secret.txt
 - spec/generator/micro_api/installs_generator_spec.rb
 - spec/rails_helper.rb
 - spec/requests/micro_api/static_healthz_spec.rb