khiem-nguyen / takenoko Goto Github PK

#Takenoko ##Description Rails gem for getting data from Google spreedsheet then export to files or database via simple interface and rake tasks

##What's new in versions 0.1.1

• Simpler config, easier to use by using spreadsheet as config
• Add validator and filter for each row
• Allow authorization by both service account and personal account
• Allow skip rows, worksheets by '#'
• Fix minor bugs

##Install

gem "takenoko"

#Generate config/initializers/takenoko.rb
rails generate takenoko:config

Update config/initializers/takenoko.rb

conf.sheet_id = "SPREADSHEET_ID"    

Other global options, you can overwrite these options in mapping file for each table

You can refer HERE for how to get cridential_file when using service account permission

"*": Allow overwrite in mapping_file.yaml

###3. Create mapping_file.yaml

tables:
  table1:
    worksheet_id: #
    columns_mapping:
      table_col_1:spread_sheet_colA
      table_col_2:spread_sheet_colB
      table_col_3:spread_sheet_colC

  table2:
    spreadsheet_id: Example
...

Tables: Hash of tables

Table option

##Usage

First row will be header definition(Use # to skip rows)

For all tables

Takenoko.all_to_db
Takenoko.all_to_yaml
...    

For single table

Takenoko.table_to_db(table_name)
Takenoko.table_to_yaml(table_name)

For all tables

rake takenoko:all_to_db
rake takenoko:all_to_yaml
...    

For single table

rake takenoko:table_to_db[table_name]
rake takenoko:table_to_yaml[table_name]

Takenoko uses three method for post processing. Defined them in your postprocess_class. By default, postprocess_class will be class_name in mapping_file.yml

• spreadsheet_row_valid?(row) => bool : skip invalid rows (Optional)
• postprocess_spreadsheet_row(row) => row : modify row, return processed row(Optional)
• postprocess_spreadsheet_table(table) => row : modify whole dowloaded table, return processed table(Optional)

Just put '#' before your worksheet name or column name to skip it