simple-admin 0.2.0.pre.alpha → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 918b5fdf9d9832094529ef09ba88f69adfe25e2e
-  data.tar.gz: db38dafc747766b9035aa868917aef2436250434
+  metadata.gz: b313a9b07cb42d38afd189ed5f9d36547e8f7a54
+  data.tar.gz: e01f13bcff49f9b858f74d191368bfb5e711838d
 SHA512:
-  metadata.gz: 1a331210fab23a5350425d379e67cf3eafa18a227aa28377ac9675b55df9754b5fac92c47000768b73595360f193c09d747f7db53a5770fbf8792a6ea2e9b719
-  data.tar.gz: a147d76f702bf61b237a0db5f4944e4f073d20849257cff09459166788205b872965f076c3c9d11263656ce12934b3e7cc41451d429e5e43089e7cc786b6c57f
+  metadata.gz: 6e000b24abaec6f299f952fb4d4813fb047c4dbae220f19f47e0442b05702955893784a16be0c9b48d0b49e29d96d0d40c6356eaf9de5822f00a136f2cedbc3d
+  data.tar.gz: ec4b4028579748601636afdc285aa5d91be4c3888921c0f944532098fe2f1228befc55862ff8dde548fc940acae690b934b1806b5d64768cc535abdcaae9fe82

data/.gitignore

@@ -5,11 +5,6 @@
 /coverage/
 /doc/
 /pkg/
-/spec/reports/
-/spec/example_app/log
-/spec/example_app/log/*
-/spec/example_app/public/*
-/spec/example_app/tmp
 /tmp/
 
 # rspec failure tracking

data/Gemfile

@@ -4,24 +4,5 @@ gemspec
 
 ruby '2.4.1'
 
-gem 'rails', '~> 5.0.0'
-
+gem 'rails', '~> 5.0.6'
 gem 'pg', '~> 0.18'
-gem 'rdoc', require: false
-
-group :development, :test do
-  gem 'factory_bot_rails'
-  gem 'rspec-rails'
-end
-
-group :test do
-  gem 'codecov',   require: false
-  gem 'simplecov', require: false
-
-  gem 'database_cleaner'
-  gem 'faker'
-  gem 'rails-controller-testing'
-  gem 'sprockets-rails', require: 'sprockets/railtie'
-
-  gem 'pry'
-end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Dmitriy Strukov
+Copyright (c) 2018 Dmitriy Strukov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,110 +4,33 @@
 [![codecov](https://codecov.io/gh/evil-raccoon/simple_admin/branch/master/graph/badge.svg)](https://codecov.io/gh/evil-raccoon/simple_admin)
 [![Inline docs](http://inch-ci.org/github/evil-raccoon/simple_admin.svg)](http://inch-ci.org/github/evil-raccoon/simple_admin)
 
-A framework for creating admin dashboards in an instant.
-[Try the demo][demo].
+A small API library to connect your application with SimpleAdmin service and create admin dashboards in an instant.
 
 ## Getting started
-Add SimpleAdmin to your Gemfile and run bundle:
 
 ![simple_admin](https://i.imgur.com/s1fGVRq.png)
 
-```ruby
-gem 'simple-admin'
-```
-
-The following generators will create rolify initializer and core migrations.  
-
-```ruby
-rails generate simple_admin:install
-rails generate simple_admin:migration
-
-rails db:migrate
-```
-
-Restart your server, and visit [http://localhost:3000/admin/system/entities](http://localhost:3000/admin/system/entities) for authentication.
-
-### Authentication
-
-Simple admin is very flexible solution, so you can use any gems for that purposes, all you need is just create `app/controllers/simple_admin/admin/application_controller.rb` and remove current_user and authenticate_user! methods with `raise NotImplemented` error and keep the following.
-
-```ruby
-  # app/controllers/simple_admin/admin/application_controller.rb
-
-  module SimpleAdmin
-    module Admin
-      class ApplicationController < ActionController::Base
-        layout 'simple_admin'
-
-        # use here you authentication before action  
-      end
-    end
-  end
-```
-
-After that create next partial:
-
-```ruby
-  # app/views/simple_admin/admin/shared/components/_logout.html.erb
-  
-  <ul class="nav-header pull-right">
-    <li>
-      <%= link_to t('simple_admin.actions.logout'), destroy_user_session_path, method: :delete %>
-    </li>
-  </ul>
-```
-
-### Devise integration
-Simple Admin supports devise, you need to add into the Gemfile `gem 'devise'` and run `rails generate simple_admin:install`. This will create view templates for authentication and registration, after that you need to create layout:
+Add SimpleAdmin to your Gemfile and run bundle:
 
 ```ruby
-# app/views/layouts/devise.html.erb
-
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Exampleapp</title>
-    <%= csrf_meta_tags %>
-
-    <%= stylesheet_link_tag    'simple_admin/application', media: 'all', 'data-turbolinks-track': 'reload' %>
-    <%= javascript_include_tag 'simple_admin/application', 'data-turbolinks-track': 'reload' %>
-  </head>
-
-  <body>
-    <%= yield %>
-  </body>
-</html>
+gem 'simple-admin'
 ```
 
-And add the layout to `application.rb`:
+After that, you need to mount simple admin built-in routes:
 
 ```ruby
-module Exampleapp
-  class Application < Rails::Application
-    config.to_prepare do
-      Devise::SessionsController.layout 'devise'
-    end
-  end
+# config/routes.rb
+Rails.application.routes.draw do
+  mount_for_simple_admin
 end
 ```
 
-## Customization
-You have two different ways to customize admin panel entities and fields, first way it's to use built in generator, it automatically create all fields for form and collection pages (excepting timestamps and id). All you need is run next command:
+Create initializer, add your secret key and restart server
 
 ```ruby
-  rails generate simple_admin:model_entities Post
+# config/initializers/simpleadmin.rb
+ENV['SIMPLE_ADMIN_SECRET_KEY'] = 'SECRET_KEY'
 ```
-Next way is to create entity in administrative panel and fields for it, you can do it on the entities page (http://localhost:3000/admin/system/entities).
-
-## Dependencies
-
-We try to minimize the use of third-party libraries, but Simple Admin built with the following open source projects:
-
-Tool                  | Description
---------------------- | -----------
-[Kaminari]            | Paginator for Ruby webapps
-
-[Kaminari]: https://github.com/kaminari/kaminari
 
 ## Contributing
 
@@ -117,13 +40,8 @@ Tool                  | Description
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-
-[CanCanCan]: https://github.com/CanCanCommunity/cancancan
-
 ## Copyright
 
 Released under MIT License.
 
-Copyright © 2017 Evil Raccoon.
-
-[demo]: https://simpleadmin.herokuapp.com
+Copyright © 2018 Evil Raccoon.

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

@@ -0,0 +1,6 @@
+module Api::V1
+  module SimpleAdmin
+    class BaseController < ActionController::API
+    end
+  end
+end

data/app/controllers/api/v1/simple_admin/credentials_controller.rb

@@ -0,0 +1,17 @@
+module Api::V1
+  module SimpleAdmin
+    class CredentialsController < BaseController
+      def verify_key
+        render json: {
+          secret_key_valid: secret_key_valid?
+        }
+      end
+
+      private
+
+        def secret_key_valid?
+          ENV['SIMPLE_ADMIN_SECRET_KEY'] == params[:secret_key]
+        end
+    end
+  end
+end

data/app/controllers/api/v1/simple_admin/entities_controller.rb

@@ -0,0 +1,28 @@
+module Api::V1
+  module SimpleAdmin
+    class EntitiesController < BaseController
+      before_action :load_models
+
+      def index
+        render json: {
+          entities_names: ApplicationRecord.descendants.map { |model| model.name }
+        }
+      end
+
+      def show
+        resource_klass = params[:id].capitalize.constantize
+
+        render json: {
+          name: resource_klass.name,
+          column_names: resource_klass.column_names
+        }
+      end
+
+      private
+
+        def load_models
+          Rails.application.eager_load!
+        end
+    end
+  end
+end

data/app/controllers/api/v1/simple_admin/resources_controller.rb

@@ -0,0 +1,105 @@
+module Api::V1
+  module SimpleAdmin
+    class ResourcesController < BaseController
+      def index
+        model_klass  = params[:model_klass_name].constantize
+        model_fields = params[:model_fields].map { |field_attributes| field_attributes[:field_name] }
+
+        per_page = params[:per_page].to_i
+        page     = params[:page].to_i if params[:page].present?
+        total    = model_klass.count
+
+        resources = model_klass.limit(per_page)
+
+        if params[:query].present?
+          search_result = search(params[:query], model_klass, params[:model_attributes])
+
+          resources = search_result[:resources]
+          total     = search_result[:total]
+        end
+
+        resources = resources.offset((per_page * page) - per_page) if page.present?
+        resources = resources.order(params[:sort][:column_name] => params[:sort][:order]) if params[:sort].present?
+
+        resources = resources.map do |resource|
+          _resource = {}
+
+          resource.attributes.each do |attribute_name, attribute_value|
+            next unless model_fields.include?(attribute_name)
+
+            if params[:model_fields].find { |field_attributes| field_attributes[:field_name] == attribute_name && field_attributes[:field_type] == 'image' }.present?
+              _resource[attribute_name] = "#{ENV['HOST']}/#{resource.public_send(attribute_name).url}"
+            else
+              _resource[attribute_name] = attribute_value
+            end
+          end
+
+          _resource
+        end
+
+        render json: {
+          resources: resources,
+          total:     total
+        }
+      end
+
+      def show
+        model_klass = params[:model_klass_name].constantize
+        model_fields = params[:model_fields].split(',')
+
+        resource = model_klass.find(params[:id]).attributes.slice(*model_fields)
+
+        render json: resource
+      end
+
+      def create
+        model_klass = params[:model_klass_name].constantize
+
+        resource = model_klass.new(resource_params)
+        resource.image = CarrierStringIO.new(Base64.decode64(resource_params[:image]))
+
+        if resource.save
+          render json: resource
+        else
+          render json: resource.errors
+        end
+      end
+
+      def update
+        model_klass = params[:model_klass_name].constantize
+        resource = model_klass.find(params[:id])
+
+        if resource.update(resource_params)
+          render json: resource
+        else
+          render json: resource.errors
+        end
+      end
+
+      def destroy
+        model_klass = params[:model_klass_name].constantize
+        resource = model_klass.find(params[:id])
+
+        resource.destroy
+      end
+
+      private
+
+        def search(search_query, model_klass, model_attributes)
+          return [] if model_attributes.empty?
+
+          query = model_attributes.map { |model_attribute| "#{model_attribute} LIKE ?" }.join(' OR ')
+          query_arguments = model_attributes.map { "%#{search_query}%" }
+
+          {
+            resources: model_klass.where(query, *query_arguments),
+            total:     model_klass.where(query, *query_arguments).count
+          }
+        end
+
+        def resource_params
+          params.require(:resource).permit!
+        end
+    end
+  end
+end

data/lib/simple-admin.rb

@@ -2,38 +2,4 @@ require 'simple_admin/version'
 require 'simple_admin/engine'
 
 module SimpleAdmin
-  module Refinements
-    require 'simple_admin/refinements/boolean'
-  end
-
-  module ResourceController
-    require 'simple_admin/resource_controller/actions_builder'
-    require 'simple_admin/resource_controller/controller_builder'
-
-    require 'simple_admin/resource_controller/crudify'
-    require 'simple_admin/resource_controller/crudify_dynamic_resource'
-
-    require 'simple_admin/resource_controller/dynamic_fields'
-  end
-
-  module Helpers
-    require 'simple_admin/helpers/url_helper'
-    require 'simple_admin/helpers/boolean_helper'
-  end
-
-  require 'simple_admin/config'
-  require 'simple_admin/search'
-
-  class << self
-    def mount_entities!(routing_mapper)
-      SimpleAdmin::Entity.resource_attributes.each do |resource_name, model_klass_name|
-        routing_mapper.resources(resource_name)
-
-        controller_builder = SimpleAdmin::ResourceController::ControllerBuilder.new(resource_name)
-        controller_builder.build!
-
-        SimpleAdmin::ResourceController::ActionsBuilder.initialize_actions!(controller_builder.controller_klass, model_klass_name)
-      end
-    end
-  end
 end

data/lib/simple_admin/engine.rb

@@ -1,16 +1,6 @@
-require 'bootstrap-sass'
-require 'jquery-ui-rails'
-require 'kaminari'
-
 require 'simple_admin/routes'
 
 module SimpleAdmin
   class Engine < Rails::Engine
-    initializer 'simple_admin.precompile', group: :all do |app|
-      app.config.assets.precompile += [
-        'simple_admin/application.css',
-        'simple_admin/application.js'
-      ]
-    end
   end
 end

data/lib/simple_admin/routes.rb

@@ -10,21 +10,16 @@ module ActionDispatch::Routing
     #     mount_for_simple_admin
     #   end
     #
-    # @since 0.1.2-alpha
+    # @since 1.0.0
 
     def mount_for_simple_admin
-      scope module: :simple_admin do
-        namespace :admin do
-          root 'system/entities#index'
+      namespace :api do
+        namespace :v1 do
+          namespace :simple_admin do
+            resources :entities,  only: [:index, :show]
+            resources :resources
 
-          get :search, to: 'search#index'
-
-          SimpleAdmin.mount_entities!(self) if ActiveRecord::Base.connection.table_exists?(:simple_admin_entities)
-
-          namespace :system do
-            resources :entities
-            resources :entity_field_types
-            resources :entity_fields, only: %i[create update destroy]
+            post 'verify_key' => 'credentials#verify_key'
           end
         end
       end

data/lib/simple_admin/version.rb

@@ -1,3 +1,3 @@
 module SimpleAdmin
-  VERSION = '0.2.0-alpha'.freeze
+  VERSION = '1.0.0'.freeze
 end