avo 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4553dfc5ece77cd00016511c8fe9bf3a7279fc6212cae4e76630c844ddf2f752
-  data.tar.gz: 523b264251fc3e68a6206824aff0ee064f7f74629a37afe5baa6bb70d0f2ff36
+  metadata.gz: 21149eeeb028f3834fe8d5571cb4bd78800c8a7e7968f26ebfc59ab106bea7ce
+  data.tar.gz: 77adc8b341c1222e937ba3f19acc311c4d18a29f65279061049bb3cfb22f9234
 SHA512:
-  metadata.gz: b3c0083fff832d7dd25eb909c4112b93affb91cc246e252edae609d615fab89f9bd09fe5afc486c3fa59c1b1a77474f80262331fec648591f38ee22f5bfa567d
-  data.tar.gz: 5f9110c138b401cc186e36c8b638c5de1703540f602f7bff6860701acf0ac850e551bb8a3672e18c8f7cd66fd8f21f3645dd548d4a31a27c0d6bb328743e024c
+  metadata.gz: 72c6106edf707ee07d7b4b1b9a6b3ea6fbbc83a88ab8c897cb452940d61ef10b586114069fe5af4cbf49339ac06bd0976cd60bf835922a9742f59e4524e38ad6
+  data.tar.gz: dc397f7fa9bdde84e619d4285ff5d3426cacce5980798dfc58535ae22390a33c4ec4152fe9d6ff91d2dc0967cae59a808558b87923a87409ba0ec982be3f1f18

data/Gemfile

@@ -23,54 +23,52 @@ gem 'inline_svg'
 gem 'countries'
 
 # Authorization
-gem "pundit"
-
-# These are the dummy app's dependencies
-group :development, :test do
-  # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-  gem 'rails', '~> 6.0.2', '>= 6.0.2.2'
-  # Use postgresql as the database for Active Record
-  gem 'pg', '>= 0.18', '< 2.0'
-  # Use Puma as the app server
-  gem 'puma', '~> 4.3.5'
-  # Use SCSS for stylesheets
-  gem 'sass-rails', '>= 6'
-  # Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
-  # gem 'turbolinks', '~> 5'
-  # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-  gem 'jbuilder', '~> 2.7'
-  # Use Redis adapter to run Action Cable in production
-  # gem 'redis', '~> 4.0'
-  # Use Active Model has_secure_password
-  # gem 'bcrypt', '~> 3.1.7'
-
-  # Use Active Storage variant
-  # gem 'image_processing', '~> 1.2'
-
-  # Reduces boot times through caching; required in config/boot.rb
-  gem 'bootsnap', '>= 1.4.2', require: false
-  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
-  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
-  gem 'dotenv-rails'
-  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
-  gem 'web-console', '>= 3.3.0'
-  gem 'listen', '>= 3.0.5', '< 3.2'
-  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-  gem 'spring'
-  gem 'spring-watcher-listen', '~> 2.0.0'
-
-  gem 'factory_bot_rails'
-  gem 'faker'
-
-  # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-  gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
-
-  gem 'devise'
-  gem 'database_cleaner'
-
-  gem 'ruby-debug-ide', require: false
-  gem 'debase'
-end
+gem 'pundit'
+
+# Dependencies for dummy_app
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 6.0.2', '>= 6.0.2.2'
+# Use postgresql as the database for Active Record
+gem 'pg', '>= 0.18', '< 2.0'
+# Use Puma as the app server
+gem 'puma', '~> 4.3.5'
+# Use SCSS for stylesheets
+gem 'sass-rails', '>= 6'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+# gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.7'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.2', require: false
+# Call 'byebug' anywhere in the code to stop execution and get a debugger console
+gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+gem 'dotenv-rails'
+# Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+gem 'web-console', '>= 3.3.0'
+gem 'listen', '>= 3.0.5', '< 3.2'
+# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+gem 'spring'
+gem 'spring-watcher-listen', '~> 2.0.0'
+
+gem 'factory_bot_rails'
+gem 'faker'
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+gem 'devise'
+gem 'database_cleaner'
+
+gem 'ruby-debug-ide', require: false
+gem 'debase'
 
 group :development, :test do
   gem 'rspec-rails', '~> 4.0.0'
@@ -83,6 +81,7 @@ group :development, :test do
   gem 'rubocop'
   gem 'simplecov', require: false
   gem 'simplecov-cobertura'
+  gem 'webmock'
 
   # Release helper
   gem 'bump', require: false
@@ -93,3 +92,5 @@ gem 'zeitwerk', '~> 2.3'
 
 # Pagination
 gem 'kaminari'
+
+gem 'httparty'

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    avo (0.2.1)
+    avo (0.3.1)
       countries
+      httparty
       inline_svg
       kaminari
-      rails (~> 6.0.2, >= 6.0.2.1)
+      pundit
+      rails (>= 6.0)
       webpacker
       zeitwerk
 
@@ -91,6 +93,7 @@ GEM
       i18n_data (~> 0.10.0)
       sixarm_ruby_unaccent (~> 1.1)
       unicode_utils (~> 1.4)
+    crack (0.4.4)
     crass (1.0.6)
     database_cleaner (1.8.5)
     debase (0.2.4.1)
@@ -123,6 +126,10 @@ GEM
     gem-release (2.1.1)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
+    hashdiff (1.0.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     i18n_data (0.10.0)
@@ -155,11 +162,15 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.2)
     msgpack (1.3.3)
+    multi_xml (0.6.0)
     nio4r (2.5.4)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
@@ -296,6 +307,10 @@ GEM
       nokogiri (~> 1.6)
       rubyzip (>= 1.3.0)
       selenium-webdriver (>= 3.0, < 4.0)
+    webmock (3.9.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     webpacker (4.3.0)
       activesupport (>= 4.2)
       rack-proxy (>= 0.6.1)
@@ -325,6 +340,7 @@ DEPENDENCIES
   faker
   fuubar
   gem-release
+  httparty
   inline_svg
   jbuilder (~> 2.7)
   kaminari
@@ -345,6 +361,7 @@ DEPENDENCIES
   tzinfo-data
   web-console (>= 3.3.0)
   webdrivers
+  webmock
   webpacker (~> 4.0)
   zeitwerk (~> 2.3)
 

data/README.md

@@ -1,69 +1,48 @@
 ![Tests](https://github.com/avo-hq/avo/workflows/Tests/badge.svg)
 ![reviewdog](https://github.com/avo-hq/avo/workflows/reviewdog/badge.svg)
 [![codecov](https://codecov.io/gh/avo-hq/avo/branch/master/graph/badge.svg?token=Q2LMFE4989)](https://codecov.io/gh/avo-hq/avo)
+[![Maintainability](https://api.codeclimate.com/v1/badges/676a0afa2cc79f03aa29/maintainability)](https://codeclimate.com/github/avo-hq/avo/maintainability)
 
-# Avo
-The missing Ruby on Rails admin
+![](https://avohq.io/img/logo-full-stroke-tiny-2x.png)
 
-## Usage
-How to use my plugin.
+**Configuration-based, no-maintenance, extendable Ruby on Rails admin**
 
-## Installation
-Add this line to your application's Gemfile:
+Avo is a beautiful next-generation framework that empowers you, the developer, to create fantastic admin panels for your Ruby on Rails apps with the flexibility to fit your needs as you grow.
 
-```ruby
-gem 'avo'
-```
+## Get started
 
-And then execute:
-```bash
-$ bundle
-```
+**Website**: [avohq.io](https://avohq.io)\
+**Documentation**: [docs.avohq.io](https://docs.avohq.io)\
+**Twitter**: [avo_hq](https://twitter.com/avo_hq)\
+**Community chat**: [discord](https://discord.gg/pkTF6y8)\
+**Issue tracker**: [GitHub issues](http://github.com/avo-hq/avo/issues)
 
-Or install it yourself as:
-```bash
-$ gem install avo
-```
+## Features
 
-## Testing
+  - **Code driven configuration** - Configure your Rails dashboard entirely by writing Ruby code.
+  - **Resource Management** - Create a CRUD interface for Active Record from one command. No more copy-pasting view and controller files around.
+  - **Active Storage support** - Amazingly easy, **one-line**, single or multi-file integration with **ActiveStorage**.
+  - **Grid view** - Beautiful card layout to showcase your content.
+  - **Actions** - Run custom actions to one or more of your resources with as little as pressing a button 💪
+  - **Filters** - Write your own custom filters to quickly segment your data.
+  - **Keeps your app clean** - You don't need to change your app to use Avo. Drop it in your existing app or add it to a new one and you're done 🙌
+  - **Custom fields***- No worries if we missed a field you need. Generate a custom field in a jiffy.
+  - **Dashboard widgets and metrics*** - Customize your dashboard with the tools and analytics you need.
+  - **Custom tools*** - You need to add a page with something completely new, you've got it!
+  - **Authorization*** - Leverage Pundit policies to build a robust and scalable authorization system.
+  - **Themable*** - Dress it up into your own colors.
+  - **Localization*** - Have it available in any language you need.
 
-We use `rspec` to run our tests. To run unit tests use `npm run test`. For system tests `npm run test-system` and to run them all `npm run test-all` or simply `rspec`
+  *Some features are still under development
 
-## Contributing
+# Installation
+Add this line to your application's `Gemfile`:
 
+```ruby
+gem 'avo'
 ```
-git clone
-cd avo
-bundle install
-yarn
-bin/rails server
-```
-
-You may also use the VSCode launcher to take advantage of the debugger.
-
-You may need to run `rake db:migrate && rake db:test:prepare` for local development.
-
-To start the Webpack dev server you need to have a different session running `bin/webpack-dev-server`.
 
-## License
-Commercial license.
-
-## Building, Releasing and Publishing
-
-### Build
-
-If you just need a quick development build of the gem, just run `rails build`.
-
-To build for **release** (production mode), you need to run `yarn build`. This will build a docker image that will build the gem using `production` env variables. At the end of the process it will place the new gem under `pkg/` directory.
-
-### Release
-
-To release the gem, run `yarn release [patch(default)|minor|major]`. This will increment the version name, cut a tag and push to GitHub. From there, GitHub Actions will take over to build the artifact, create a release and add the artifact to that release.
-
-At every PR merge a `Next release draft` release will be auto-filled by [Release drafter](https://github.com/marketplace/actions/release-drafter). When a real release happens (on `yarn release`). The contents body of that release will be moved to the actual release and the draft will be destroyed so it can be refilled on next PR's.
-
-### Publish
-
-To publish on GitHub package registry you need to run `yarn run publish`. This will publish the current version on their registry.
-
-As a prerequisite you need to have the GitHub token in your `~/.gem/credentials` file. You may run `echo ":github: Bearer GH_TOKEN" >> ~/.gem/credentials`.
+And then execute:
+```bash
+$ bundle install
+```

data/app/controllers/avo/application_controller.rb

@@ -5,7 +5,10 @@ module Avo
     before_action :init_app
 
     def init_app
-      Avo::App.init
+      Avo::App.boot unless Rails.env.production?
+      Avo::App.init request
+
+      @license = Avo::App.license
     end
 
     def exception_logger(exception)
@@ -20,6 +23,20 @@ module Avo
     end
 
     private
+      def resource
+        eager_load_files(resource_model).find params[:id]
+      end
+
+      def eager_load_files(query)
+        if avo_resource.attached_file_fields.present?
+          avo_resource.attached_file_fields.map(&:id).map do |field|
+            query = query.send :"with_attached_#{field}"
+          end
+        end
+
+        query
+      end
+
       def resource_model
         avo_resource.model
       end
@@ -27,5 +44,21 @@ module Avo
       def avo_resource
         App.get_resource params[:resource_name].to_s.camelize.singularize
       end
+
+      def authorize_user
+        return if params[:controller] == 'avo/search'
+
+        model = record = avo_resource.model
+
+        if ['show', 'edit', 'update'].include?(params[:action]) && params[:controller] == 'avo/resources'
+          record = resource
+        end
+
+        return render_unauthorized unless AuthorizationService::authorize_action current_user, record, params[:action]
+      end
+
+      def render_unauthorized
+        render json: { message: 'Unauthorized' }, status: 403
+      end
   end
 end

data/app/controllers/avo/filters_controller.rb

@@ -0,0 +1,19 @@
+require_dependency 'avo/application_controller'
+
+module Avo
+  class FiltersController < ApplicationController
+    before_action :authorize_user
+
+    def index
+      filters = []
+
+      avo_resource.get_filters.each do |filter|
+        filters.push(filter.new.render_response)
+      end
+
+      render json: {
+        filters: filters,
+      }
+    end
+  end
+end

data/app/controllers/avo/relations_controller.rb

@@ -0,0 +1,34 @@
+require_dependency 'avo/application_controller'
+
+module Avo
+  class RelationsController < ApplicationController
+    before_action :authorize_user
+
+    def attach
+      resource.send(params[:attachment_name]) << attachment_model
+
+      render json: {
+        success: true,
+        message: "#{attachment_class} attached.",
+      }
+    end
+
+    def detach
+      resource.send(params[:attachment_name]).delete attachment_model
+
+      render json: {
+        success: true,
+        message: "#{attachment_class} attached.",
+      }
+    end
+
+    private
+      def attachment_class
+        App.get_model_class_by_name params[:attachment_name].pluralize 1
+      end
+
+      def attachment_model
+        attachment_class.safe_constantize.find params[:attachment_id]
+      end
+  end
+end

data/app/controllers/avo/resource_overview_controller.rb

@@ -3,13 +3,15 @@ require_dependency 'avo/application_controller'
 module Avo
   class ResourceOverviewController < ApplicationController
     def index
-      resources = App.get_resources.map do |resource|
-        {
-          name: resource.name,
-          url: resource.url,
-          count: resource.model.count,
-        }
-      end
+      resources = App.get_resources
+        .select { |resource| AuthorizationService::authorize session_user, resource.model, Avo.configuration.authorization_methods.stringify_keys['index'] }
+        .map do |resource|
+          {
+            name: resource.name,
+            url: resource.url,
+            count: resource.model.count,
+          }
+        end
 
       render json: {
         resources: resources,
@@ -17,5 +19,10 @@ module Avo
         hide_docs: Avo.configuration.hide_documentation_link,
       }
     end
+
+    private
+      def session_user
+        current_user.present? ? current_user : nil
+      end
   end
 end