model_info 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5246392322490ce9575c71a6c33bbf2892440d91a53a72855a796967fb7b9f31
-  data.tar.gz: d96067439db1995a3d4e7c5f35307cb0b8ed750f314e528e4ad00c56ca56d35e
+  metadata.gz: e20bfbae6791d932df14a9b96cab61967b47d4cbed0fa69dd69bcaf6e232d970
+  data.tar.gz: 6d80e18b10fc55e142bb7ad9ad5a786ab416b602f08c12f9b3d38026b0486263
 SHA512:
-  metadata.gz: e88f6e3e2eef8b8a06eb8afb3d4fef6643bbd0e057901274bc30a1350cf7166266a6cdabc6de72e07d05ee60d630ddea2d6cddf1240ffa62e2bd17425e77eef4
-  data.tar.gz: b45c787971ab44fca264d54403c4738e030325c182ec96c63fccf86556b456132bdda5d6fb9f0f4147647949349f723e416bb30936002defad33de8f255e9d29
+  metadata.gz: 151d3fa3ffa070a8515552aef0d74660ea78b4fa9a101fe154df072b9332795f9e5e1dc4f78ebb9cf7b61a974fd4ba4b423515fd10f5ff460e4ef5f40bef2acb
+  data.tar.gz: f185599bcbc84cd5cb54b374037fd65cd3df07a1bda73570b0a2da96d3132211e143268057f4313b0100966738c9d59e4f3bd1f1d90effb11a435d5a68d083b9

data/README.rdoc

@@ -2,6 +2,19 @@
 
 ModelInfo provides the UI interface for the CRUD of all models (including engine's) and their associated models.
 It also provides you the download link for CSV and JSON format of Model's data.
+
+== API 
+
+It provides the API support for all models  to fetch the model information suppose we have a model Article
+
+Then the API's will be
+- GET    /model_info/api/v1/articles(.:format) 
+- POST   /api/v1/articles(.:format)        
+- GET    /api/v1/articles/:id(.:format)    
+- PUT    /api/v1/articles/:id(.:format)
+- DELETE /api/v1/articles/:id(.:format)    
+
+
 == Installation
 
 Add this line to your application's Gemfile:
@@ -19,3 +32,5 @@ After successful installation of gem the UI interface will be available on
 your_application_url */model_info/models*
 
 example: localhost:3000/model_info
+
+To use the API of model_info Please curl the request or use any API platform for using this.

data/app/controllers/model_info/api/v1/associations_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ModelInfo
+  module Api
+    module V1
+      class AssociationsController < BaseController
+      end
+    end
+  end
+end

data/app/controllers/model_info/api/v1/base_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModelInfo
+  module Api
+    module V1
+      # :nodoc
+      class BaseController < ::ApplicationController
+        def models_array
+          Rails.application.eager_load!
+          model_names = ActiveRecord::Base.descendants.collect { |model| model.to_s if model.table_exists? }.compact
+          model_names.delete('ActiveStorage::Blob')
+          model_names.delete('ActiveStorage::Attachment')
+          @model_array = model_names.map(&:pluralize).map(&:downcase)
+        end
+      end
+    end
+  end
+end

data/app/controllers/model_info/api/v1/models_controller.rb

@@ -0,0 +1,57 @@
+module ModelInfo
+  module Api
+    module V1
+      # :nodoc
+      class ModelsController < BaseController
+        before_action :find_model_object, only: %i[edit update show destroy]
+
+        # GET /models or /models.json
+        def index
+          render json: model.all
+        end
+
+        # GET /comapnies/new
+        def show
+          render json: @model_object
+        end
+
+        def create
+          model_object = model.new(permit_params)
+          if model_object.save
+            render json: { status: :created }
+          end
+        end
+
+        def update
+          @model_object.update(permit_params)
+        end
+
+        def destroy
+          @model_object.destroy
+        end
+
+        private
+
+        def model
+          model = request.path.split('/').select { |element| models_array.include?(element) }.first
+          @model = model.classify.constantize
+        end
+
+        # Only allow a list of trusted parameters through.
+        def permit_params
+          params.require(:"#{model.to_s.downcase}").permit(model_attributes)
+        end
+
+        def model_attributes
+          except ||= %w[id created_at updated_at]
+          model.attribute_names.reject { |attr| except.include?(attr) }
+        end
+
+        # Use callbacks to share common setup or constraints between actions.
+        def find_model_object
+          @model_object = model.find(params[:id])
+        end
+      end
+    end
+  end
+end

data/app/controllers/model_info/application_controller.rb

@@ -1,14 +1,14 @@
 module ModelInfo
   class ApplicationController < ::ApplicationController
     #========================= Example =================================#
-    #class Employee < ApplicationRecord
+    # class Employee < ApplicationRecord
     #  has_many :projects
-    #end
+    # end
     #============================ Naming Conventions ====================#
     # model_class 'Employee'
     # model_name 'employee'
     # model_object_id '1'
-    # model_data '#<Employee id: 1, name: "rooh", salary: 138001, month: "jan", created_at: "2018-08-29 07:47:43", updated_at: "2018-09-12 09:35:09", manager_id: 8, lock_version: 4>'
+    # model_data '#<Employee id: 1, name: "Alen", salary: 10000, month: "Jan",manager_id: 8, lock_version: 4>'
     # associated_model_class 'Project'
     # associated_model_name 'projects'
     # associated_model_object_id '1'
@@ -17,15 +17,15 @@ module ModelInfo
     before_action :models_tab
 
     private
+
     def models_tab
-      array=[], @model_array=[]
+      @model_array = []
       Rails.application.eager_load!
-      array=ActiveRecord::Base.descendants.collect { |x| x.to_s if x.table_exists? }.compact
-      array.each do |x|
-        if x.split('::').last.split('_').first != 'HABTM'
-          @model_array.push(x)
-        end
+      model_names = ActiveRecord::Base.descendants.collect { |model| model.to_s if model.table_exists? }.compact
+      model_names.each do |model_name|
+        @model_array.push(model_name) if model_name.split('::').last.split('_').first != 'HABTM'
         @model_array.delete('ActiveRecord::SchemaMigration')
+        $model_array = @model_array
       end
     end
   end

data/app/controllers/model_info/models_controller.rb

@@ -3,10 +3,11 @@ require_dependency 'model_info/application_controller'
 module ModelInfo
   class ModelsController < ApplicationController
     before_action :model_class_and_name
-    before_action :set_model_data, only: [:show, :edit, :update]
+    before_action :set_model_data, only: %i[show edit update]
 
-    def display
-      @model_class, @page = params[:model_class] || @model_array.try(:first), params[:page] || 1
+    def index
+      @model_class = params[:model_class] || @model_array&.first
+      @page = params[:page] || 1
       @model_pagination = @model_class.constantize.page(@page).per(10)
     end
 
@@ -24,11 +25,9 @@ module ModelInfo
       end
     end
 
-    def edit
-    end
+    def edit; end
 
-    def show
-    end
+    def show; end
 
     def update
       if @model_data.update(permit_params)
@@ -56,7 +55,7 @@ module ModelInfo
     end
 
     def set_model_data
-      @model_data=@model_class.find(params[:model_object_id])
+      @model_data = @model_class.find(params[:model_object_id])
     end
   end
-end
+end

data/config/routes.rb

@@ -1,23 +1,37 @@
 ModelInfo::Engine.routes.draw do
+  root to: 'models#index'
 
-  root to: 'models#display'
-
-  get 'model_display', to: 'models#display'
-  get 'models',to: 'models#index'
-  get 'model_new',to: 'models#new'
-  post 'model_create',to: 'models#create'
-  get 'model_show',to: 'models#show'
-  get 'model_edit',to: 'models#edit'
-  patch 'model_update',to: 'models#update'
+  namespace :api do
+    namespace :v1 do
+      Rails.application.eager_load!
+      model_names = ActiveRecord::Base.descendants.collect { |model| model.to_s if model.table_exists? }.compact
+      model_names.delete('ActiveStorage::Blob')
+      model_names.delete('ActiveStorage::Attachment')
+      model_names = model_names.map(&:pluralize).map(&:downcase)
+      model_names.each do |model|
+        get model, to: 'models#index'
+        post model, to: 'models#create'
+        get "#{model}/:id", to: 'models#show'
+        put "#{model}/:id", to: 'models#update'
+        delete "#{model}/:id", to: 'models#destroy'
+      end
+    end
+  end
+  get 'models', to: 'models#index'
+  get 'model_new', to: 'models#new'
+  post 'model_create', to: 'models#create'
+  get 'model_show', to: 'models#show'
+  get 'model_edit', to: 'models#edit'
+  patch 'model_update', to: 'models#update'
   delete 'model_destroy', to: 'models#destroy'
 
-  get 'associations_index', to: 'associations#index'
-  get 'association_new',to: 'associations#new'
-  post 'association_create',to: 'associations#create'
-  get 'association_show',to: 'associations#show'
-  get 'association_edit',to: 'associations#edit'
-  patch 'association_update',to: 'associations#update'
-  delete 'association_destroy',to: 'associations#destroy'
+  get 'associations_index',  to: 'associations#index'
+  get 'association_new', to: 'associations#new'
+  post 'association_create', to: 'associations#create'
+  get 'association_show', to: 'associations#show'
+  get 'association_edit', to: 'associations#edit'
+  patch 'association_update', to: 'associations#update'
+  delete 'association_destroy', to: 'associations#destroy'
 
   get 'download_csv', to: 'downloads#download_csv'
   get 'download_json', to: 'downloads#download_json'

data/lib/model_info/engine.rb

@@ -4,9 +4,8 @@ module ModelInfo
   class Engine < ::Rails::Engine
     isolate_namespace ModelInfo
 
-    initializer 'model_info', before: :load_config_initializers do |app|      
-      app.config.assets.precompile += %w( model_info/application.js model_info/application.css)
-      
+    initializer 'model_info', before: :load_config_initializers do |app|
+      app.config.assets.precompile += %w[model_info/application.js model_info/application.css)] if app.config.assets.present?
       Rails.application.routes.append do
         mount ModelInfo::Engine, at: '/model_info'
       end

data/lib/model_info/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModelInfo
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_info
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - nitanshu verma
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap
@@ -56,6 +56,9 @@ files:
 - app/assets/stylesheets/model_info/bootstrap.css
 - app/assets/stylesheets/model_info/bootstrap.min.css
 - app/assets/stylesheets/model_info/sytle.css.scss
+- app/controllers/model_info/api/v1/associations_controller.rb
+- app/controllers/model_info/api/v1/base_controller.rb
+- app/controllers/model_info/api/v1/models_controller.rb
 - app/controllers/model_info/application_controller.rb
 - app/controllers/model_info/associations_controller.rb
 - app/controllers/model_info/downloads_controller.rb
@@ -70,8 +73,8 @@ files:
 - app/views/model_info/associations/index.html.erb
 - app/views/model_info/associations/new.html.erb
 - app/views/model_info/associations/show.html.erb
-- app/views/model_info/models/display.html.erb
 - app/views/model_info/models/edit.html.erb
+- app/views/model_info/models/index.html.erb
 - app/views/model_info/models/new.html.erb
 - app/views/model_info/models/show.html.erb
 - app/views/model_info/shared/_flash_messages.html.erb