sp2db 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fac51c488482e0d04613279cb0e38c75c2f5cfa9
+  data.tar.gz: fa08f175fb5b8466731420e8e86d2963484a0150
+SHA512:
+  metadata.gz: 028cb9e83c1cbec58766f1ea0721fa63ed5f60dda8fd3b3fe821bb0da5581028c4eec68199a8ea2d9892c9ce4b0da5777de3fad6ae0209b1d06ab435699aec6d
+  data.tar.gz: 13c90ddfad22da59508a5a4751aec79725aa1f813f53979a97531f06ca21826d0db5ae33033a958bd6bee29ca96df27d936994b4837068773076864ef3c8937c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at khiemns.k54@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sp2db.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,180 @@
+PATH
+  remote: .
+  specs:
+    sp2db (0.0.3)
+      google-api-client (~> 0.11)
+      google_drive (~> 2.1)
+      rails (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.0)
+      actionpack (= 5.2.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.0)
+      activesupport (= 5.2.0)
+      globalid (>= 0.3.6)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activestorage (5.2.0)
+      actionpack (= 5.2.0)
+      activerecord (= 5.2.0)
+      marcel (~> 0.3.1)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    erubi (1.7.1)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    google-api-client (0.23.4)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (>= 0.5, < 0.7.0)
+      httpclient (>= 2.8.1, < 3.0)
+      mime-types (~> 3.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+    google_drive (2.1.3)
+      google-api-client (>= 0.11.0, < 1.0.0)
+      googleauth (>= 0.5.0, < 1.0.0)
+      nokogiri (>= 1.5.3, < 2.0.0)
+    googleauth (0.6.2)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      logging (~> 2.0)
+      memoist (~> 0.12)
+      multi_json (~> 1.11)
+      os (~> 0.9)
+      signet (~> 0.7)
+    httpclient (2.8.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    jwt (2.1.0)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    memoist (0.16.0)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mimemagic (0.3.2)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    os (0.9.6)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.0)
+      actioncable (= 5.2.0)
+      actionmailer (= 5.2.0)
+      actionpack (= 5.2.0)
+      actionview (= 5.2.0)
+      activejob (= 5.2.0)
+      activemodel (= 5.2.0)
+      activerecord (= 5.2.0)
+      activestorage (= 5.2.0)
+      activesupport (= 5.2.0)
+      bundler (>= 1.3.0)
+      railties (= 5.2.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    signet (0.8.1)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uber (0.1.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  sp2db!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Khiêm Nguyễn
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 KhiemNS
+
+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,180 @@
+# Sp2db
+
+Google Spreadsheet import tool for Rails app.
+
+## Installation
+
+```ruby
+gem 'sp2db'
+```
+
+## Basic usage
+
+### Initialized
+
+```bash
+bundle exec rails sp2db:config
+```
+
+### In model
+```ruby
+class ExampleModel < ApplicationRecord
+
+  include Sp2db::ImportConcern
+
+end
+```
+
+### Import task
+
+For single table or multiple tables
+```bash
+# Import spreadsheet to database directy
+bundle exec rake sp2db:sp_to_db[table1,table2]
+
+# Export spreadsheet to csv then import to database. Suite for data version control
+bundle exec rake sp2db:sp_to_csv[table1,table2]
+bundle exec rake sp2db:csv_to_db[table1,table2]
+```
+
+For all tables
+```bash
+bundle exec rake sp2db:sp_to_db
+# Or
+bundle exec rake sp2db:sp_to_csv
+bundle exec rake sp2db:csv_to_db
+```
+
+## Advanced usage
+
+### Model config
+
+Use sp2db_options or sp2db_`option_name` to add more config to model table
+
+Example
+```
+class ExampleModel < ApplicationRecord
+  include Sp2db::ImportConcern
+
+  sp2db_options spreadsheet_id: "ANOTHER SHEET ID",
+                import_strategy: :overwrite
+                ...
+end
+```
+
+Other options:
+* find_columns: Columns to find existed record, default: [:id]
+* required_columns: Columns which values must be present to be a valid row, Example: [:name, title]
+* priority: table priority for import, default: 0
+* import_strategy: Import strategy
+* sheet_name: work sheet name
+* spreadsheet_id: Spreadsheet id, use to overwrite default spreadsheet id
+* data_transform: method name or lambda to tranform spreadsheet raw data to standart input
+  Example:
+  ```ruby
+  sp2db_options data_transform: :tranform_raw_data_to_standard_method
+  # Or use lambda
+  sp2db_options data_transform: ->(raw-data, opts) {
+    # Logic for data tranformation
+  }
+  # Or other form
+  sp2db_options_data_transform do |raw_data, opts|
+    # Logic for data tranformation
+  end
+  ```
+* process_data: Use to remove invalid data or change column value before import, value: Symbol or lambda
+* before_import_row: Run before each row import, value: Symbol or lambda
+* after_import_row: Run after each row import, value: Symbol or lambda
+* after_import_table: Run after table import, value: Symbol or lambda
+
+### Import process and usage of hooks
+
+* Spreadsheet raw data: [[cellA1, cellA2,...],[cellB1, cellB2],...]
+
+⬇
+
+* Data tranform: This step is used to tranform raw data to standard input with the first row is header and following data rows. (Use case: tranform vertical spreadsheet to horizontal spreadsheet)
+
+⬇
+
+* Raw data filter(private): remove columns starting with # and blank rows, check required rows(starting with "!") to remove
+
+⬇
+
+* Data process: Remove invalid rows, cols, change row values before importing, Output from this step will be input for file exporting
+
+⬇
+
+* Before row import: Run before each row importing, use case: change row data, add file for upload, ..
+
+⬇
+
+* After row import: Run after each row importing, use case: notification or file upload
+
+⬇
+
+* After table import: Run after each table importing, use case: notification or error handling
+
+### Import strategy
+
+Import strategy to process import, there are 4 strategies supprted by default
+
+* truncate_all: Truncate table before importing, default
+* overwrite: Overwrite when existed record found
+* skip: Skip and not update when existed record found
+* fill_empty: Only fill blank columns of found record
+
+To add custom strategy
+```ruby
+Sp2db::ImportStrategy.add :custom_stragy do
+  # Then overwrite method from Sp2db::ImportStrategy::Base to define behavior
+  # Example for truncate all
+  def before_import
+    model.all.delete_all # Delete all record before importing
+  end
+end
+```
+
+### Error handling while import
+
+Data will be rollbacked when ActiveRecord::ActiveRecordError be thrown, to change this behavior change exception_handler config, there 3 options for this
+* raise: raise exception when occurs, defaut
+* skip: skip exception
+* A lambda for customize behavior
+  Example
+
+  ```ruby
+  Sp2db.config do |conf|
+    ...
+    config.exception_handler.row_import_error = -> (exception){
+      # Handle exeption, return true to continue or false to skip
+    }
+
+  end
+  ```
+
+### For non model table
+
+Sometimes we need to export spreadsheet to file without active record model or the model is not exist
+```ruby
+Sp2db.config do |conf|
+  conf.non_model_tables = {
+    "table_names" => {
+      sheet_id: "ANOTHER SHEET ID"
+      ...
+    }
+  }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/khiemns54/sp2db. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sp2db project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/khiemns54/sp2db/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/generators/sp2db/config_generator.rb

@@ -0,0 +1,13 @@
+module Sp2db
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc 'takenoko_config.rb'
+
+      def copy_config_file
+        template 'sp2db.rb', 'config/initializers/sp2db.rb'
+      end
+    end
+  end
+end

data/lib/generators/sp2db/templates/sp2db.rb

@@ -0,0 +1,27 @@
+Sp2db.config do |conf|
+  conf.credential = "path to credential file OR Json string OR Hash" # required
+  conf.spreadsheet_id = "SHEET ID" # Required
+
+  # Other regular optional config
+
+  # export_location: Location for exported files, default:  "db/spreadsheets"
+  # import_strategy: Specify import strategy, default: :truncate_all, Other: :fill_empty, :skip, :overwrite
+
+  # exception_handler: Import behavior when exception occurs
+  # Default:
+  # config.exception_handler.row_import_error = :raise
+  # config.exception_handler.table_import_error = :raise
+
+  # download_before_import: Export spreadsheet to csv automaticaly when import to database, default: false
+
+  # non_model_tables: define non model sheet for file exporting only
+  # Example:
+  # config.non_model_tables = {
+  #   table_names: {
+  #     sheet_name: "sheet_name"
+  #   }
+  # }
+
+  # default_find_columns: Default find column to update, default: [:id]
+
+end