Develop (#25)

* Display URL of card if it's updated

* Sync main and master  (#17)

* Refactor and bump cards

* Take in account matomo cards

* Detect local database dynamically

* Update config yml example

* Add specs for main lib

* Fix rubocop offenses

* Define module variables

* Add configs fixture in specs

* Add specs for 'main.find_db_for'

* Refactor and add documentation (#18)

* Add .env.example

* Add ruby platform to Gemfile.lock

* Add error for config file not found

* Fix rubocop offenses

* Update git ignore

* Add specs for main

* Fix rubocop offenses

* Remove failing spec

* Light fix in cards

* Add documentation

* [Refactor] - Cleanup of main program and libraries (#19)

* Refactor metabase_url

* Move query_interpreter

* Create Config class

* Define Config class

* Move ConfigNotFound to Config file

* Add config class

* Refactor config and main lib

* Optimizing main creation

* refactor main script

* Fix rubocop offenses

* Update rubocop rules and fix offenses

* Fix specs

* Add specs

* Update specs

* add specs for interpreter

* Fix api collection specs

* Fix api database specs

* Fix api session specs

* Fix api spec collection

* Remove unnecessary libraries

* Fix rubocop offenses

* Add URL for accessing created questions (#22)

* [Feature] - Meta column translator (#20)

* Add warnings for undefined database

* Free memory when fetching metabase cards

* Light optimization for metabase collection

* Move metabase card fetch in function context for memory

* Enable columns translation

* Remove byebug requirement

* Feature/add description (#24)

* Add description renaming

* Rename 'meta' to columns in mapping

* Fix Rubocop offenses

* Refactor fs card column translation

* Update cards subrepositories

* Harmonize error output on STDOUT

* Fix fs card translation

* Remove unnecessary rubocop rule

Co-authored-by: Quentinchampenois <[email protected]>

* Update submodules

* Ignore all .env files

* Add description to model creation

* Adapt specs

* Modify main.rb to precise config file directly as sys arg

* Update submodules

---------

Co-authored-by: Quentin Champenois <[email protected]>

Author: Dynnammo

.env.example

@@ -0,0 +1,3 @@
+METABASE_HOST=metabase.example.com
+METABASE_USERNAME=[email protected]
+METABASE_PASSWORD=secretpassword

.gitignore

@@ -10,6 +10,7 @@
 
 # rspec failure tracking
 .rspec_status
-.env
+.env*
 **/*.private
 config.yml
+.byebug_history

.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.7.1
   Exclude:
     - "bin/*.rb"
@@ -23,22 +24,23 @@ Layout/LineLength:
   Enabled: true
   Exclude:
     - spec/api/collection_spec.rb
-  Max: 120
+  Max: 130
 
 Metrics/AbcSize:
-  Enabled: true
-  Exclude:
-    - lib/decidim_metabase/api/session.rb
-
+  Enabled: false
 
 Metrics/ModuleLength:
   Enabled: true
   Exclude:
-    - spec/api/collection_spec.rb
+    - spec/**/*_spec.rb
+
+Metrics/MethodLength:
+  Enabled: false
 
 Metrics/BlockLength:
   Enabled: true
   Exclude:
-    - spec/api/collection_spec.rb
-    - spec/api/database_spec.rb
-    - spec/api/session_spec.rb
+    - spec/**/*_spec.rb
+
+Metrics/ClassLength:
+  Enabled: false

Gemfile

@@ -11,3 +11,4 @@ gem "rspec", "~> 3.0"
 
 gem "byebug"
 gem "rubocop", "~> 1.7"
+gem "webmock"

Gemfile.lock

@@ -10,18 +10,24 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     byebug (11.1.3)
     colorize (0.8.1)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
     dotenv (2.7.6)
     faraday (2.3.0)
       faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (2.0.3)
+    hashdiff (1.0.1)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
+    public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.3.0)
@@ -54,8 +60,13 @@ GEM
     ruby2_keywords (0.0.5)
     tsort (0.1.0)
     unicode-display_width (2.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-19
 
 DEPENDENCIES
@@ -64,6 +75,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)
+  webmock
 
 BUNDLED WITH
    2.3.10

cards/decidim_cards

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dotenv"
   spec.add_dependency "faraday"
   spec.add_dependency "tsort"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

cards/matomo_cards

@@ -0,0 +1,50 @@
+# Getting started with Metabase Automation !
+
+Let's see how to setup your environment for using the Metabase Automation System.
+
+## Requirements
+
+* Online Metabase instance
+* Username + Password able to connect on the instance
+* Decidim Database already set on Metabase
+
+## Let's start
+
+1. Set the required environment variable  
+Copy the file `.env.example` and rename it as `.env`. Once done, add your credentials and the metabase host. You must not add the metabase URL but the host only.
+
+2. Create the main `config.yml` file  
+This file is the global configuration of the project. It is used by the program to link local cards to the right Metabase database. Also, it allows to define the current locale and the decidim host.  
+
+There is several keys in this file : 
+```yaml
+---
+database:
+  decidim_cards:
+    name: <EXISTING METABASE DATABASE>
+  matomo_cards:
+    name: <EXISTING METABASE DATABASE>
+collection_name: <NEW OR EXISTING METABASE COLLECTION>
+language: fr # en
+host: <HOST>
+```
+* `database` - Allows to link a cards folder to a Metabase database
+  * In the example above, there is two keys `decidim_cards` and `matomo_cards`. These keys are the name of the folders present in `/cards`.
+  * You must define at least one database. For example you can remove the database key `matomo_cards`.
+  * You can find existing database in Metabase
+* `collection_name` - Name of collection on Metabase.
+  * If the collection doesn't exist, the program will create it. Otherwise it use the existing one.
+  * You can find an existing collection name in Metabase
+* `language` - Define the translation of cards in Metabase
+  * Cards must contains the right translation to work as expected (see example [decidim users translations](../cards/decidim_cards/users/locales/en.yml))
+  * If locale doesn't exist, default is English
+* `host` - Decidim host for cards which depends on the current host for request
+  * You can find this host in the __Metabase database > table Decidim Organizations > Host__
+
+3. Install dependencies  
+Run `bundle install`
+
+4. Execute program
+`bundle exec main.rb -v`
+
+> To prevent multiple authentication for each execution, program will store a valid token in '/token.private'. If file doesn't exist or token is deprecated, program will refresh it. This file is ignored by git.  

decidim_metabase.gemspec

@@ -13,11 +13,13 @@
 require_relative "decidim_metabase/object/filesystem_card"
 require_relative "decidim_metabase/object/database"
 require_relative "decidim_metabase/http_requests"
+require_relative "decidim_metabase/config"
 require_relative "decidim_metabase/query_interpreter"
 require_relative "decidim_metabase/topological_sort"
 require_relative "decidim_metabase/utils"
 require_relative "decidim_metabase/main"
 
+# DecidimMetabase allows to create and manage Metabase cards
 module DecidimMetabase
   class Error < StandardError; end