forest_admin_rails 1.0.0.pre.beta.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1299315823fb267116811e6ae29fb9985a66b9d1cd1711cb1cce87c5066f4ad1
+  data.tar.gz: 93b595e413b2da5cd6eaf5ab0ffa14255af02698964db6d9eeda40e916056933
+SHA512:
+  metadata.gz: c92087cb113959bac21c93d319419a0b991499b9b08ca77adda74b7ec9deb9c573d4bc79bdcba067c2201f4a652b6b72a0a26500b743f4c4c56801af6badc820
+  data.tar.gz: db33af05dbf38c3987dc2ab42c4a04abe5c2b9675c8ccee4694484529253bed68eae2865afc741bfc43ef0885ac9c5de9cb545875e9366b8778c00a621003164

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 FORESTADMIN
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# ForestAdmin
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "forest_admin"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install forest_admin
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/setup"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/forest_admin_rails/forest_controller.rb

@@ -0,0 +1,51 @@
+module ForestAdminRails
+  class ForestController < ActionController::Base
+    skip_forgery_protection
+
+    def index
+      if ForestAdminAgent::Http::Router.routes.key? params['route_alias']
+        route = ForestAdminAgent::Http::Router.routes[params['route_alias']]
+
+        begin
+          forest_response route[:closure].call({ params: params.to_unsafe_h, headers: request.headers.to_h })
+        rescue StandardError => e
+          exception_handler e
+        end
+      else
+        render json: { error: 'Route not found' }, status: 404
+      end
+    end
+
+    def forest_response(data = {})
+      render json: data[:content], status: data[:status] || 200
+    end
+
+    def exception_handler(exception)
+      if exception.is_a? ForestAdminAgent::Http::Exceptions::AuthenticationOpenIdClient
+        data = {
+          error: exception.error,
+          error_description: exception.error_description,
+          state: exception.state
+        }
+      else
+        data = {
+          errors: [
+            {
+              name: exception.name,
+              detail: exception.message,
+              status: exception.status
+            }
+          ]
+        }
+
+        data[:errors][0][:data] = exception.data if exception.defined? :data
+
+        # TODO: IMPLEMENT LOGGING
+        # if Facades::Container.cache(:is_production)
+        # end
+      end
+
+      render json: data, status: exception.status
+    end
+  end
+end

data/app/helpers/forest_admin_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module ForestAdminRails
+  module ApplicationHelper
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+ForestAdminRails::Engine.routes.draw do
+  ForestAdminAgent::Http::Router.routes.each do |name, agent_route|
+    match agent_route[:uri], to: 'forest#index', via: agent_route[:method], as: name, route_alias: name
+  end
+end

data/lib/forest_admin_rails/engine.rb

@@ -0,0 +1,55 @@
+require 'forest_admin_agent'
+require 'rack/cors'
+
+module Rack
+  class Cors
+    class Resource
+      def to_preflight_headers(env)
+        h = to_headers(env)
+        if env['HTTP_ACCESS_CONTROL_REQUEST_PRIVATE_NETWORK'] == 'true'
+          h['Access-Control-Allow-Private-Network'] = 'true'
+        end
+        if env[HTTP_ACCESS_CONTROL_REQUEST_HEADERS]
+          h['Access-Control-Allow-Headers'] = env[HTTP_ACCESS_CONTROL_REQUEST_HEADERS]
+        end
+        h
+      end
+    end
+  end
+end
+
+module ForestAdminRails
+  class Engine < ::Rails::Engine
+    isolate_namespace ForestAdminRails
+
+    config.after_initialize do
+      agent_factory = ForestAdminAgent::Builder::AgentFactory.instance
+      agent_factory.setup(ForestAdminRails.config)
+      load_configuration
+      load_cors
+    end
+
+    def load_configuration
+      return unless File.exist?(Rails.root.join('lib', 'forest_admin_rails', 'create_agent.rb'))
+
+      # force eager loading models
+      Rails.application.eager_load!
+
+      # setup agent
+      require Rails.root.join('lib', 'forest_admin_rails', 'create_agent.rb')
+      ForestAdminRails::CreateAgent.setup!
+    end
+
+    def load_cors
+      config.middleware.insert_before 0, Rack::Cors do
+        allow do
+          hostnames = [/\A.*\.forestadmin\.com\z/]
+          hostnames += ENV['CORS_ORIGINS'].split(',') if ENV['CORS_ORIGINS']
+
+          origins hostnames
+          resource '*', headers: :any, methods: :any, credentials: true, max_age: 86_400
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_rails/version.rb

@@ -0,0 +1,3 @@
+module ForestAdminRails
+  VERSION = "1.0.0-beta.21"
+end

data/lib/forest_admin_rails.rb

@@ -0,0 +1,32 @@
+require 'dry-configurable'
+require 'forest_admin_rails/version'
+require 'forest_admin_rails/engine'
+require 'zeitwerk'
+require 'rails/railtie'
+require 'forest_admin_agent'
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.setup
+
+module ForestAdminRails
+  extend Dry::Configurable
+
+  setting :debug, default: true
+  setting :auth_secret
+  setting :env_secret
+  setting :forest_server_url, default: 'https://api.forestadmin.com'
+  setting :is_production, default: Rails.env.production?
+  setting :prefix, default: 'forest'
+  setting :permission_expiration, default: 300
+  setting :cache_dir, default: :'tmp/cache/forest_admin'
+  setting :schema_path, default: File.join(Dir.pwd, '.forestadmin-schema.json')
+  setting :project_dir, default: Dir.pwd
+  setting :loggerLevel, default: 'info'
+  setting :logger, default: nil
+
+  if defined?(Rails::Railtie)
+    # logic for cors middleware,... here // or it might be into Engine
+    //
+  end
+end

data/lib/generators/forest_admin_rails/install_generator.rb

@@ -0,0 +1,16 @@
+module ForestAdminRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      argument :env_secret, type: :string, required: true, desc: 'required', banner: 'env_secret'
+
+      def install
+        @auth_secret = SecureRandom.hex(20)
+        @env_secret = env_secret
+        template 'initializers/config.rb', 'config/initializers/forest_admin_rails.rb'
+        template 'create_agent.rb', 'lib/forest_admin_rails/create_agent.rb'
+        route "mount ForestAdminRails::Engine => '/#{ForestAdminRails.config[:prefix]}'"
+      end
+    end
+  end
+end

data/lib/generators/forest_admin_rails/templates/create_agent.rb

@@ -0,0 +1,16 @@
+module ForestAdminRails
+  class CreateAgent
+    def self.setup!
+      database_configuration = Rails.configuration.database_configuration
+      datasource = ForestAdminDatasourceActiveRecord::Datasource.new(database_configuration[Rails.env])
+
+      @create_agent = ForestAdminAgent::Builder::AgentFactory.instance.add_datasource(datasource)
+      customize
+      @create_agent.build
+    end
+
+    def self.customize
+      # @create_agent.add_datasource....
+    end
+  end
+end

data/lib/generators/forest_admin_rails/templates/initializers/config.rb

@@ -0,0 +1,4 @@
+ForestAdminRails.configure do |config|
+  config.auth_secret = '<%= @auth_secret %>'
+  config.env_secret = '<%= @env_secret %>'
+end

data/lib/tasks/forest_admin_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :forest_admin_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: forest_admin_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta.21
+platform: ruby
+authors:
+- Matthieu
+- Nicolas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: |-
+  Forest is a modern admin interface that works on all major web frameworks. This gem makes Forest
+  admin work on any Rails application (Rails >= 6.1).
+email:
+- matthv@gmail.com
+- nicolasalexandre9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/forest_admin_rails/forest_controller.rb
+- app/helpers/forest_admin_rails/application_helper.rb
+- config/routes.rb
+- lib/forest_admin_rails.rb
+- lib/forest_admin_rails/engine.rb
+- lib/forest_admin_rails/version.rb
+- lib/generators/forest_admin_rails/install_generator.rb
+- lib/generators/forest_admin_rails/templates/create_agent.rb
+- lib/generators/forest_admin_rails/templates/initializers/config.rb
+- lib/tasks/forest_admin_rails_tasks.rake
+homepage: https://www.forestadmin.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.forestadmin.com
+  source_code_uri: https://github.com/ForestAdmin/rails-forest_admin
+  changelog_uri: https://github.com/ForestAdmin/rails-forest_admin/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Official Rails Agent for Forest Admin.
+test_files: []