forest_admin_agent 1.0.0.pre.beta.47 → 1.0.0.pre.beta.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56cd6d9f71a53bee234570bccd942191684758b3a0b261549c8cf504f02d7b64
-  data.tar.gz: 5e1ef6098d3e45feccf9e521a4e1ee0684a76eaa0c7b19fcd3a09a1a565604b1
+  metadata.gz: 40e4df2d99083f936e9cf9a4693f20d69cc6d3b2b86d8ef8c66abafdbd554d2b
+  data.tar.gz: 732d5c6d7c20f67558d609c1a8e28d834bbb1b01bd0880988721409e4bc564d7
 SHA512:
-  metadata.gz: 34525c9a9648c71da21fd815b4a16608db211fc897fbe8def79445c3d800b56ac6339f8a3e6e4ae6f9b5043da9c735bd5c3ebd4fed434dc7c279dc6781531c3c
-  data.tar.gz: 1fd874f037ef715a8f1f8cc9a887abc97311c304c5171c37a94f6b9499cb5fc8b1d57d3fcfca6734f3b129d91a1af2dfebe8b1231d6a747feada2ff7b4a026da
+  metadata.gz: '009c1d66c244400c79b66dc66fa1acd0bcdd80de1c7cea811050352bdc1dc6ec494025a732f2a52b9368319db782da1fb720aa0cef1bc2d427c98a145da5614d'
+  data.tar.gz: a349fd075afbc6ed33fd44aba00dcd71f79b2d8ec767b4877f7756c41540368f25827a2501b825b92af08e7db9ce426a8009972a0af44f5a2334acc75fc5ac29

data/forest_admin_agent.gemspec

@@ -17,7 +17,7 @@ admin work on any Ruby application."
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ForestAdmin/agent-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/ForestAdmin/agent-ruby/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/ForestAdmin/agent-ruby/blob/main/CHANGELOG.md"
   spec.metadata["rubygems_mfa_required"] = "false"
 
   # Specify which files should be added to the gem when it is released.

data/lib/forest_admin_agent/http/router.rb

@@ -12,10 +12,12 @@ module ForestAdminAgent
           Charts::Charts.new.routes,
           Resources::Count.new.routes,
           Resources::Delete.new.routes,
+          Resources::Csv.new.routes,
           Resources::List.new.routes,
           Resources::Show.new.routes,
           Resources::Store.new.routes,
           Resources::Update.new.routes,
+          Resources::Related::CsvRelated.new.routes,
           Resources::Related::ListRelated.new.routes,
           Resources::Related::CountRelated.new.routes,
           Resources::Related::AssociateRelated.new.routes,

data/lib/forest_admin_agent/routes/abstract_route.rb

@@ -15,8 +15,8 @@ module ForestAdminAgent
         @routes ||= {}
       end
 
-      def add_route(name, method, uri, closure)
-        @routes[name] = { method: method, uri: uri, closure: closure }
+      def add_route(name, method, uri, closure, format = 'json')
+        @routes[name] = { method: method, uri: uri, closure: closure, format: format }
       end
 
       def setup_routes

data/lib/forest_admin_agent/routes/resources/csv.rb

@@ -0,0 +1,51 @@
+module ForestAdminAgent
+  module Routes
+    module Resources
+      class Csv < AbstractAuthenticatedRoute
+        include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
+        include ForestAdminAgent::Utils
+
+        def setup_routes
+          add_route(
+            'forest_list_csv',
+            'get',
+            '/:collection_name.:format',
+            ->(args) { handle_request(args) },
+            'csv'
+          )
+
+          self
+        end
+
+        def handle_request(args = {})
+          build(args)
+          @permissions.can?(:browse, @collection)
+          @permissions.can?(:export, @collection)
+          filter = ForestAdminDatasourceToolkit::Components::Query::Filter.new(
+            condition_tree: ConditionTreeFactory.intersect(
+              [
+                @permissions.get_scope(@collection),
+                ForestAdminAgent::Utils::QueryStringParser.parse_condition_tree(
+                  @collection, args
+                )
+              ]
+            ),
+            search: ForestAdminAgent::Utils::QueryStringParser.parse_search(@collection, args),
+            search_extended: ForestAdminAgent::Utils::QueryStringParser.parse_search_extended(args)
+          )
+          projection = ForestAdminAgent::Utils::QueryStringParser.parse_projection(@collection, args)
+          records = @collection.list(@caller, filter, projection)
+          filename = args[:params][:filename] || "#{args[:params]["collection_name"]}.csv"
+          filename += '.csv' unless /\.csv$/i.match?(filename)
+
+          {
+            content: {
+              export: CsvGenerator.generate(records, projection)
+            },
+            filename: filename
+          }
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_agent/routes/resources/list.rb

@@ -4,7 +4,6 @@ module ForestAdminAgent
   module Routes
     module Resources
       class List < AbstractAuthenticatedRoute
-        include ForestAdminAgent::Builder
         include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
         def setup_routes
           add_route('forest_list', 'get', '/:collection_name', ->(args) { handle_request(args) })

data/lib/forest_admin_agent/routes/resources/related/csv_related.rb

@@ -0,0 +1,60 @@
+module ForestAdminAgent
+  module Routes
+    module Resources
+      module Related
+        class CsvRelated < AbstractRelatedRoute
+          include ForestAdminAgent::Utils
+          include ForestAdminDatasourceToolkit::Utils
+          include ForestAdminDatasourceToolkit::Components::Query::ConditionTree
+
+          def setup_routes
+            add_route(
+              'forest_related_list_csv',
+              'get',
+              '/:collection_name/:id/relationships/:relation_name.:format',
+              ->(args) { handle_request(args) },
+              'csv'
+            )
+
+            self
+          end
+
+          def handle_request(args = {})
+            build(args)
+            @permissions.can?(:browse, @collection)
+            @permissions.can?(:export, @collection)
+
+            filter = ForestAdminDatasourceToolkit::Components::Query::Filter.new(
+              condition_tree: ConditionTreeFactory.intersect(
+                [
+                  @permissions.get_scope(@collection),
+                  ForestAdminAgent::Utils::QueryStringParser.parse_condition_tree(@child_collection, args)
+                ]
+              )
+            )
+            projection = ForestAdminAgent::Utils::QueryStringParser.parse_projection_with_pks(@child_collection, args)
+            id = Utils::Id.unpack_id(@collection, args[:params]['id'], with_key: true)
+            records = Collection.list_relation(
+              @collection,
+              id,
+              args[:params]['relation_name'],
+              @caller,
+              filter,
+              projection
+            )
+
+            filename = args[:params][:filename] || "#{args[:params]["relation_name"]}.csv"
+            filename += '.csv' unless /\.csv$/i.match?(filename)
+
+            {
+              content: {
+                export: CsvGenerator.generate(records, projection)
+              },
+              filename: filename
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_agent/routes/resources/related/list_related.rb

@@ -23,7 +23,6 @@ module ForestAdminAgent
           def handle_request(args = {})
             build(args)
             @permissions.can?(:browse, @collection)
-            # TODO: add csv behaviour
 
             filter = ForestAdminDatasourceToolkit::Components::Query::Filter.new(
               condition_tree: ConditionTreeFactory.intersect(

data/lib/forest_admin_agent/utils/csv_generator.rb

@@ -0,0 +1,44 @@
+require 'csv'
+
+module ForestAdminAgent
+  module Utils
+    class CsvGenerator
+      def self.generate(records, projection)
+        data = {}
+        projection.each do |schema_field|
+          is_relation = schema_field.include?(':') && projection.relations.key?(schema_field.split(':').first)
+          col_name = (is_relation ? schema_field.split(':').first : schema_field)
+
+          data[col_name] = []
+          records.each do |row|
+            data[col_name] << if is_relation
+                                row[col_name][schema_field.split(':').last]
+                              else
+                                row[col_name]
+                              end
+          end
+        end
+
+        generate_csv_string(data)
+      end
+
+      # data = {
+      #   "id" => [1, 2],
+      #   "email" => ["mv@test.com", "na@test.com"],
+      #   "name" => ["Matthieu", "Nicolas"],
+      # }
+      def self.generate_csv_string(data)
+        CSV.generate do |csv|
+          # headers
+          csv << data.keys
+
+          num_rows = data.values.first.size
+          num_rows.times do |i|
+            row = data.keys.map { |key| data[key][i] }
+            csv << row
+          end
+        end
+      end
+    end
+  end
+end

data/lib/forest_admin_agent/utils/schema/schema_emitter.rb

@@ -7,7 +7,7 @@ module ForestAdminAgent
       class SchemaEmitter
         LIANA_NAME = "forest-rails"
 
-        LIANA_VERSION = "1.0.0-beta.47"
+        LIANA_VERSION = "1.0.0-beta.48"
 
         def self.get_serialized_schema(datasource)
           schema_path = Facades::Container.cache(:schema_path)

data/lib/forest_admin_agent/version.rb

@@ -1,3 +1,3 @@
 module ForestAdminAgent
-  VERSION = "1.0.0-beta.47"
+  VERSION = "1.0.0-beta.48"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forest_admin_agent
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.47
+  version: 1.0.0.pre.beta.48
 platform: ruby
 authors:
 - Matthieu
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-22 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -218,7 +218,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
-- README.md
 - Rakefile
 - forest_admin
 - forest_admin_agent.gemspec
@@ -249,10 +248,12 @@ files:
 - lib/forest_admin_agent/routes/charts/api_chart_datasource.rb
 - lib/forest_admin_agent/routes/charts/charts.rb
 - lib/forest_admin_agent/routes/resources/count.rb
+- lib/forest_admin_agent/routes/resources/csv.rb
 - lib/forest_admin_agent/routes/resources/delete.rb
 - lib/forest_admin_agent/routes/resources/list.rb
 - lib/forest_admin_agent/routes/resources/related/associate_related.rb
 - lib/forest_admin_agent/routes/resources/related/count_related.rb
+- lib/forest_admin_agent/routes/resources/related/csv_related.rb
 - lib/forest_admin_agent/routes/resources/related/dissociate_related.rb
 - lib/forest_admin_agent/routes/resources/related/list_related.rb
 - lib/forest_admin_agent/routes/resources/related/update_related.rb
@@ -272,6 +273,7 @@ files:
 - lib/forest_admin_agent/utils/condition_tree_parser.rb
 - lib/forest_admin_agent/utils/context_variables.rb
 - lib/forest_admin_agent/utils/context_variables_injector.rb
+- lib/forest_admin_agent/utils/csv_generator.rb
 - lib/forest_admin_agent/utils/error_messages.rb
 - lib/forest_admin_agent/utils/id.rb
 - lib/forest_admin_agent/utils/query_string_parser.rb
@@ -300,7 +302,7 @@ licenses:
 metadata:
   homepage_uri: https://www.forestadmin.com
   source_code_uri: https://github.com/ForestAdmin/agent-ruby
-  changelog_uri: https://github.com/ForestAdmin/agent-ruby/CHANGELOG.md
+  changelog_uri: https://github.com/ForestAdmin/agent-ruby/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []

data/README.md

@@ -1,35 +0,0 @@
-# Agent
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/agent_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/agent_ruby.
-
-## License
-
-The gem is available as open source under the terms of the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html).