simpleadmin 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76f59171482dd04fed72bebf9539ca7009bc9651
-  data.tar.gz: 46c686fdf3b9ed9372e45b6bae01b2c0f9e81376
+  metadata.gz: 0675ea91b122e24a24afa25b104acde743d73131
+  data.tar.gz: cd45192036a06b9ba99e14339b32f31fdc33699e
 SHA512:
-  metadata.gz: a8f4fba3311b03a45f58f10c9b071032077d62c3599c9ab28b42051e71f50dd4617e45ddedf5d2fa7df5272f0dfb9a86632766f6c7e9f224ef61b913f7ee907f
-  data.tar.gz: eba3762f113b10b4677d01ca9181dc216696298b1dcad670a4829e74eb2740ac981eeaf5245201b22416cd3c63c7d5222f90d470d269499ebd8b6ab90658af71
+  metadata.gz: 6065774f68b225cd6028d1f20a9c2f7ea41a75adfd3d23a8e964ee1c93ac8930afdfb9a696a1696fdbafc42596c79dca84c9dfdbe963b6276848fa0fef98cf6e
+  data.tar.gz: 929b39f84960a580dd8734d967e8183ecdf406958e4e414ace26b03d692fda526ac8b618bb77f299d2b368488911a9a17c6d3e9291ce1091d7e0e7fcc89d385c

data/.rubocop.yml

@@ -1,7 +1,14 @@
 AllCops:
   Exclude:
+    - 'spec/fixtures/**/*'
     - 'bin/*'
-  TargetRubyVersion: 2.4.1
+    - 'spec/support'
+    - 'spec/factories'
+    - 'spec/fixtures'
+    - 'spec/support/*'
+    - 'spec/spec_helper.rb'
+    - 'spec/rails_helper.rb'
+  TargetRubyVersion: 2.5.1
   DisplayCopNames: true
 
 Style/Encoding:
@@ -45,6 +52,9 @@ Metrics/PerceivedComplexity:
 Metrics/CyclomaticComplexity:
   Max: 20
 
+Metrics/ParameterLists:
+  Max: 10
+
 Style/ClassAndModuleChildren:
   Enabled: false
 
@@ -56,3 +66,9 @@ Layout/IndentationConsistency:
 
 Style/AccessModifierDeclarations:
   Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+Layout/IndentHash:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,8 @@
-sudo: false
-language: ruby
 rvm:
   - 2.4.1
-before_install: gem install bundler -v 1.16.1
+language: ruby
+
+before_script:
+  - psql -c 'create database example_app_test;' -U postgres
+
+script: xvfb-run bundle exec rspec

data/Gemfile

@@ -6,3 +6,16 @@ ruby '2.4.1'
 
 gem 'pg', '~> 0.18'
 gem 'rails', '~> 5.0.6'
+
+group :test do
+  gem 'codecov', require: false
+
+  gem 'database_cleaner'
+  gem 'rspec-rails'
+  gem 'webmock'
+
+  gem 'pry'
+
+  gem 'factory_bot_rails'
+  gem 'faker'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simpleadmin (1.2.1)
+    simpleadmin (1.2.7)
 
 GEM
   remote: https://rubygems.org/
@@ -43,16 +43,36 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
     arel (7.1.4)
     builder (3.2.3)
+    codecov (0.1.14)
+      json
+      simplecov
+      url
+    coderay (1.1.2)
     concurrent-ruby (1.1.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     crass (1.0.4)
+    database_cleaner (1.7.0)
     diff-lcs (1.3)
+    docile (1.3.1)
     erubis (2.7.0)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
+    factory_bot_rails (4.11.1)
+      factory_bot (~> 4.11.1)
+      railties (>= 3.0.0)
+    faker (1.9.1)
+      i18n (>= 0.7)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
+    hashdiff (0.3.8)
     i18n (1.3.0)
       concurrent-ruby (~> 1.0)
+    json (2.1.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -66,6 +86,10 @@ GEM
     nokogiri (1.9.1)
       mini_portile2 (~> 2.4.0)
     pg (0.21.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
     rack (2.0.6)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -105,7 +129,21 @@ GEM
     rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -117,6 +155,11 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    url (0.3.2)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.3)
@@ -129,11 +172,18 @@ DEPENDENCIES
   actionview
   activerecord
   bundler (~> 1.15)
+  codecov
+  database_cleaner
+  factory_bot_rails
+  faker
   pg (~> 0.18)
+  pry
   rails (~> 5.0.6)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec-rails
   simpleadmin!
+  webmock
 
 RUBY VERSION
    ruby 2.4.1p111

data/README.md

@@ -1,9 +1,10 @@
-[![Gem Version](https://badge.fury.io/rb/simpleadmin.svg)](https://rubygems.org/gems/simpleadmin)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ca0015b11992514879c5/maintainability)](https://codeclimate.com/github/getsimpleadmin/simpleadmin/maintainability)
+[![Build Status](https://secure.travis-ci.org/getsimpleadmin/simpleadmin.svg?branch=master)](http://travis-ci.org/getsimpleadmin/simpleadmin) [![codecov.io](https://codecov.io/github/getsimpleadmin/simpleadmin/coverage.svg?branch=master)](https://codecov.io/github/getsimpleadmin/simpleadmin?branch=master)[![Gem Version](https://badge.fury.io/rb/simpleadmin.svg)](https://rubygems.org/gems/simpleadmin)[![Maintainability](https://api.codeclimate.com/v1/badges/ca0015b11992514879c5/maintainability)](https://codeclimate.com/github/getsimpleadmin/simpleadmin/maintainability)
 
-# SimpleAdmin
+# [SimpleAdmin](http://getsimpleadmin.com)
 
-SimpleAdmin allows you to create a personalized administrative panel for your business and edit it without special knowledge in programming and works with any stack, because you are not tied to a specific programming language.
+SimpleAdmin is a service for people with no special skills that enables a simple change of interface and decrease of your costs on a webpage development.
+
+You do not need to waste your time on development and technical support. The Simple Admin team will help you pay focus on the key thing – your Product.
 
 This is small API library to connect your application with SimpleAdmin service. 
 

data/app/controllers/simple_admin/base_controller.rb

@@ -5,7 +5,11 @@ module SimpleAdmin
     private
 
       def verify_key_is_valid!
-        return head(:forbidden) unless request.headers['SimpleAdmin-Secret-Key'] == ENV['SIMPLE_ADMIN_SECRET_KEY']
+        return head(:forbidden) if key_is_invalid?
+      end
+
+      def key_is_invalid?
+        request.headers['SimpleAdmin-Secret-Key'] != ENV['SIMPLE_ADMIN_SECRET_KEY']
       end
   end
 end

data/app/controllers/simple_admin/entities_controller.rb

@@ -1,36 +1,25 @@
 module SimpleAdmin
   class EntitiesController < BaseController
-    before_action :load_models
+    before_action :load_models!
+    before_action :entity_service
 
     def index
-      models = []
-
-      ApplicationRecord.descendants.each do |model|
-        models << {
-          name: model.name,
-          columns: model.columns.map { |column| { name: column.name, type: column.sql_type.parameterize.underscore } }
-        }
-      end
-
-      render json: {
-        models: models
-      }
+      render json: @entity_service.index_action
     end
 
     def show
       resource_klass = params[:id].constantize
 
-      render json: {
-        name: resource_klass.name,
-        column_names: resource_klass.column_names,
-        columns: resource_klass.columns.map { |column| { name: column.name, type: column.sql_type.parameterize.underscore } },
-        reflections: resource_klass.reflections.keys
-      }
+      render json: @entity_service.show_action(resource_klass)
     end
 
     private
 
-      def load_models
+      def entity_service
+        @entity_service = EntityService.new
+      end
+
+      def load_models!
         Rails.application.eager_load!
       end
   end

data/app/controllers/simple_admin/entity_field_type_actions_controller.rb

@@ -1,9 +1,13 @@
 module SimpleAdmin
   class EntityFieldTypeActionsController < BaseController
     def create
-      field_type = params[:entity_field_type_name].constantize
-
-      render json: field_type.new.run(params[:field_name], params[:model_klass_name])
+      render json: entity_field_type.new.run(params[:field_name], params[:model_klass_name])
     end
+
+    private
+
+      def entity_field_type
+        params[:entity_field_type_name].constantize
+      end
   end
 end

data/app/controllers/simple_admin/resources_controller.rb

@@ -1,31 +1,22 @@
 module SimpleAdmin
   class ResourcesController < BaseController
     def index
-      resource_service = ResourcesService.new(params[:model_klass_name], params[:model_fields])
-                                         .index_action(params[:per_page], params[:page], params[:sort],
-                                                       params[:query], params[:model_attributes], params[:reflection_tables],
-                                                       params[:reflection_columns])
-
-      render json: {
-        resources: resource_service.resources,
-        total: resource_service.total
-      }
+      resource_service = ResourceService.new(model_klass, model_fields)
+
+      render json: resource_service.index_action(params[:per_page], params[:page], params[:sort],
+                                                 params[:query], params[:model_attributes], params[:reflection_tables], params[:reflection_columns])
     end
 
     def show
-      model_fields = params[:model_fields].map { |model_field| model_field['field_name'] }
-
-      resource = model_klass.find(params[:id]).attributes.slice(*model_fields)
+      resource = model_klass.find(params[:id])
 
-      render json: resource
+      render json: resource.attributes.slice(*model_fields)
     end
 
     def show_by
-      model_fields = params[:model_fields].map { |model_field| model_field['field_name'] }
+      resource = model_klass.find_by(params[:column_name] => params[:column_value])
 
-      resource = model_klass.find_by(params[:column_name] => params[:column_value]).attributes.slice(*model_fields)
-
-      render json: resource
+      render json: resource.attributes.slice(*model_fields)
     end
 
     def show_total
@@ -64,6 +55,10 @@ module SimpleAdmin
         params[:model_klass_name].constantize
       end
 
+      def model_fields
+        params[:model_fields].map { |model_field| model_field['field_name'] }
+      end
+
       def resource_params
         params.require(:resource).permit!
       end

data/app/services/entity_service.rb

@@ -0,0 +1,33 @@
+class EntityService
+  def index_action
+    models = []
+
+    ApplicationRecord.descendants.each do |model|
+      name = model.name
+      columns = model.columns.map do |column|
+        {
+          name: column.name,
+          type: column.sql_type.parameterize.underscore
+        }
+      end
+
+      models.push(
+        name: name,
+        columns: columns
+      )
+    end
+
+    {
+      models: models
+    }
+  end
+
+  def show_action(resource_klass)
+    {
+      name:         resource_klass.name,
+      column_names: resource_klass.column_names,
+      columns:      resource_klass.columns.map { |column| { name: column.name, type: column.sql_type.parameterize.underscore } },
+      reflections:  resource_klass.reflections.keys
+    }
+  end
+end

data/app/services/resource_search_service.rb

@@ -0,0 +1,22 @@
+class ResourceSearchService
+  attr_reader :search_query, :model_klass, :model_attributes
+
+  def initialize(search_query, model_klass, model_attributes)
+    @search_query = search_query
+
+    @model_klass = model_klass
+    @model_attributes = model_attributes
+  end
+
+  def run
+    return [] if model_attributes.empty?
+
+    query = model_attributes.map { |model_attribute| "#{model_attribute} LIKE ?" }.join(' OR ')
+    query_arguments = model_attributes.map { "%#{search_query}%" }
+
+    OpenStruct.new(
+      resources: model_klass.where(query, *query_arguments),
+      total: model_klass.where(query, *query_arguments).count
+    )
+  end
+end

data/app/services/{resources_service.rb → resource_service.rb}

@@ -1,9 +1,9 @@
-class ResourcesService
+class ResourceService
   attr_reader :model_klass, :model_fields
 
-  def initialize(model_klass_name, model_fields)
-    @model_klass  = model_klass_name.constantize
-    @model_fields = model_fields.map { |field_attributes| field_attributes[:field_name] }
+  def initialize(model_klass, model_fields)
+    @model_klass  = model_klass
+    @model_fields = model_fields
   end
 
   def index_action(per_page, page, sort, query, model_attributes, reflection_tables, reflection_columns)
@@ -20,10 +20,11 @@ class ResourcesService
     end
 
     if query.present?
-      search_result = search(query, model_klass, model_attributes)
+      resource_search_service_instance = ResourceSearchService.new(query, model_klass_name, model_attributes)
+      resource_search_service_result   = resource_search_service_instance.run
 
-      resources = search_result[:resources]
-      total     = search_result[:total]
+      resources = resource_search_service_result.resources
+      total     = resource_search_service_result.total
     end
 
     resources = resources.offset((per_page * page) - per_page) if page.present?
@@ -34,23 +35,9 @@ class ResourcesService
       resources.order(id: :asc)
                 end
 
-    OpenStruct.new(
+    {
       resources: resources.pluck(*model_fields).map { |resource| model_fields.zip(resource).to_h },
       total: total
-    )
+    }
   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
 end

data/lib/simpleadmin/routes.rb

@@ -1,26 +1,14 @@
 module ActionDispatch::Routing
   class Mapper
-    # Contain built-in routes
-    #
-    # @example
-    #
-    #   # config/routes.rb
-    #
-    #   Rails.application.routes.draw do
-    #     mount_for_simple_admin
-    #   end
-    #
-    # @since 1.0.0
-
     def mount_simpleadmin
       namespace :simple_admin do
-        resources :entities,  only: %i[index show]
+        resources :entities, only: %i[index show]
         resources :entity_field_type_actions, only: :create
 
-        resources :resources
-
-        get 'resource_show_by',    to: 'resources#show_by'
-        get 'resource_show_total', to: 'resources#show_total'
+        resources :resources do
+          get :show_by,    on: :collection
+          get :show_total, on: :collection
+        end
 
         get 'version', to: 'versions#show'
       end

data/lib/simpleadmin/version.rb

@@ -1,3 +1,3 @@
 module Simpleadmin
-  VERSION = '1.2.7'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simpleadmin
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0
 platform: ruby
 authors:
 - Dmitriy Strukov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,7 +116,9 @@ files:
 - app/controllers/simple_admin/resources_controller.rb
 - app/controllers/simple_admin/versions_controller.rb
 - app/services/entity_field_types/status_field.rb
-- app/services/resources_service.rb
+- app/services/entity_service.rb
+- app/services/resource_search_service.rb
+- app/services/resource_service.rb
 - bin/console
 - bin/setup
 - lib/simpleadmin.rb