data_pitcher 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad5b48b5dd9a15701d6addf471f7b5c0d6fe8051
-  data.tar.gz: 9f3432b52d4c4d0d034ed38f7fac6bf987412c5e
+  metadata.gz: 9160b5110005e8d31749729dfdfedd2172fc0327
+  data.tar.gz: 12a7743e035d76d11fce3946e41b055e2f464525
 SHA512:
-  metadata.gz: 80c06d4e5e9d3dc43ec914e8a723f96d40f61e67dd3da2946d3a6f36b853e9c9634ff66308b42b2896d3c9c0be414830c44d80e5a1afdd178ad56681fdcee71d
-  data.tar.gz: d19d9efddc0e1dc59525e44222eeea653980d202fa15da9823216fff10d2267aeb528501813492822bad02cc4b0f5b6a2ae02cb105e8278c4b9972312188546c
+  metadata.gz: 3a29f48edb6a2906826b044a8d416fa8153661efa00a99b7bebefd86eb81078dfc90993d9569182d370549fc81ae0b1339e4b8cae9ef361cc64b037dad2e4e35
+  data.tar.gz: 2f425a302fcfc7132fce72f89a80d5000f65409649838fdf523c9e916a97b2be8c2c3a112e4769fde5c0f48390bc1e8dc8fff4e3d53a233501c28888c3a9d237

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    data_pitcher (0.1.0)
+    data_pitcher (0.1.1)
       activerecord (>= 3.2)
       google_drive
 

data/README.md

@@ -1,26 +1,97 @@
 # DataPitcher
 
-DataPitcher send SQL result data to your google spreadsheets.
+DataPitcher send SQL result data to your Google Spreadsheet.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'data_pitcher'
 ```
 
-And then execute:
+Download and install by running:
+
+```bash
+$ bundle install
+```
+
+Initialize with:
+
+```bash
+$ bundle exec rails generate data_pitcher:install
+```
+
+This adds the following files which are used for configuration:
+
+* config/data_pitcher.yml
+* config/initializer/data_pitcher.rb
+
+Check the comments in each file for more information.
+
+## How to use
+
+### Authorization
+
+DataPicther use a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) for accessing Google Spreadsheet. Service account can only access documents explicitly shared (or created) with the service account. It means that your program can only access documents that can be accessed with your service account.
+
+To use a service account, follow these steps:
+
+1. Go to the [credentials page](https://console.developers.google.com/apis/credentials) in the Google Developer Console.
+2. Create a new project, or select an exisiting project.
+3. Click "Create credentials" -> "Service account".
+4. Click "Create" and download the keys a JSON file.
+5. Activate the Drive API for your project in the [Google API Console](https://console.developers.google.com/apis/library).
+6. Rename your JSON file to "service_account.json", and put to "[RAILS_ROOT]/config/service_account.json"
+
+Optionally, you can change the path, and the file name. When you change these items, please change the following code so as not to forget.
+
+```ruby
+# config/initializer/data_pitcher.rb
+DataPitcher.configure do |config|
+  config.google_service_account_json_path = Rails.root.join('config', 'service_account.json')
+end
+```
+
+### Setting the YAML file
+
+DataPicther sends SQL results to the specified spreadsheet. To do this, you need to set the key of the destination spreadsheet and the path to the SQL file.
+
+For example:
+
+* Spreadsheet URL: `https://docs.google.com/spreadsheets/d/1QlOBVmsEau8EupE5Kj7AqoHLQTjInoq0GpwPkW7_WdU/edit#gid=0`
+* SQL file path: `[RAILS_ROOT]/lib/sqls/conversion_rates.sql`
+
+```yaml
+# config/data_pitcher.yml
+data_pitcher:
+  - spreadsheet_key: 1QlOBVmsEau8EupE5Kj7AqoHLQTjInoq0GpwPkW7_WdU
+    sql_path: <%= Rails.root.join('lib', 'sqls', 'conversion_rates.sql') %>
+```
+
+To send multiple SQLs to multiple spreadsheets, add them to the array in the YAML file.
+
+### Send data
+
+The easiest way is to set the following Rake task to cron. This task executes all the commands defined in the YAML file.
+
 ```bash
-$ bundle
+$ bundle exec rake data_pitcher:export:run
 ```
 
-## Setup
+Or, you can manually execute sending data programmatically as follows:
 
 ```ruby
-bundle exec rails g data_pitcher:install
+DataPitcher::Spreadsheet.new('<SPREADSHEET KEY>').replace_worksheet_with_query('<SQL QUERY STRING>')
 ```
 
-TODO: write more
+### (Optionally) Check YAML definition
+
+By executing the following command, you can check whether the definition of YAML file is correct without actually sending data.
+
+```bash
+$ bundle exec rake data_pitcher:export:dry_run
+```
 
 ## Contributing
 Contribution directions go here.

data/lib/data_pitcher.rb

@@ -4,6 +4,7 @@ require 'data_pitcher/executor'
 require 'data_pitcher/result'
 require 'data_pitcher/spreadsheet'
 require 'data_pitcher/batch'
+require 'data_pitcher/command'
 
 module DataPitcher
   class << self

data/lib/data_pitcher/batch.rb

@@ -11,9 +11,15 @@ module DataPitcher
       YAML.load(ERB.new(File.read(@yaml_path)).result)['data_pitcher']
     end
 
-    def execute
-      commands.each do |command|
-        DataPitcher::Spreadsheet.new(command['spreadsheet_key'], command['sql_path']).replace_worksheet_with_query
+    def execute(dry_run: true)
+      commands.each.with_index(1) do |command, index|
+        begin
+          if DataPitcher::Command.new(command['spreadsheet_key'], command['sql_path'], dry_run: dry_run, index: index).execute
+            puts "##{index} command: sending completed."
+          end
+        rescue => e
+          puts "[ERROR] ##{index} command skipped: #{e.class} #{e.message}"
+        end
       end
     end
   end

data/lib/data_pitcher/command.rb

@@ -0,0 +1,53 @@
+module DataPitcher
+  class Command
+    def initialize(spreadsheet_key, sql_path, dry_run: true, index: 1)
+      @spreadsheet_key = spreadsheet_key
+      @sql_path = sql_path
+      @dry_run = dry_run
+      @index = index
+    end
+
+    def execute
+      @dry_run ? dry_run : run
+    end
+
+    def dry_run
+      puts dry_run_log
+      false
+    end
+
+    def run
+      unless spreadsheet.valid?
+        puts "[ERROR] ##{@index} command skipped: DataPitcher can not access to spreadsheet (#{@spreadsheet_key})"
+        return false
+      end
+      unless executor.valid?
+        puts "[ERROR] ##{@index} command skipped: SQL is invalid (#{@sql_path})"
+        return false
+      end
+      spreadsheet.replace_worksheet_with_query(sql_query)
+    end
+
+    def spreadsheet
+      @spreadsheet ||= DataPitcher::Spreadsheet.new(@spreadsheet_key)
+    end
+
+    def executor
+      @executor ||= DataPitcher::Executor.new(sql_query)
+    end
+
+    def sql_query
+      @sql_query ||= File.read(@sql_path)
+    end
+
+    def dry_run_log
+      <<-EOS
+##{@index} command
+  spreadsheet_key: #{@spreadsheet_key}
+    valid?: #{spreadsheet.valid?}
+  sql_path: #{@sql_path}
+    valid?: #{executor.valid?}
+      EOS
+    end
+  end
+end

data/lib/data_pitcher/executor.rb

@@ -5,7 +5,14 @@ module DataPitcher
     end
 
     def execute
-      result(select(@query))
+      result(select_query)
+    end
+
+    def valid?
+      select_query
+      true
+    rescue => e
+      false
     end
 
     private
@@ -23,9 +30,9 @@ module DataPitcher
       result
     end
 
-    def select(query)
+    def select_query
       with_sandbox do
-        connection.exec_query(query)
+        connection.exec_query(@query)
       end
     end
 

data/lib/data_pitcher/spreadsheet.rb

@@ -2,9 +2,8 @@ require 'google_drive'
 
 module DataPitcher
   class Spreadsheet
-    def initialize(spreadsheet_key, sql_path)
+    def initialize(spreadsheet_key)
       @spreadsheet_key = spreadsheet_key
-      @sql_path = sql_path
     end
 
     def spreadsheet
@@ -26,8 +25,8 @@ module DataPitcher
       worksheet.save
     end
 
-    def fill_sheet
-      result = DataPitcher::Executor.new(read_query).execute
+    def fill_sheet(sql_query)
+      result = DataPitcher::Executor.new(sql_query).execute
       worksheet.reload
       # fill header
       result.header.each.with_index(1) do |val, col_index|
@@ -42,16 +41,16 @@ module DataPitcher
       worksheet.save
     end
 
-    def read_query
-      # TODO: 例外処理
-      File.open(@sql_path) do |file|
-        file.read
-      end
+    def replace_worksheet_with_query(sql_query)
+      clear_sheet
+      fill_sheet(sql_query)
     end
 
-    def replace_worksheet_with_query
-      clear_sheet
-      fill_sheet
+    def valid?
+      worksheet
+      true
+    rescue => e
+      false
     end
 
     def session

data/lib/data_pitcher/tasks/data_pitcher_tasks.rake

@@ -1,6 +1,17 @@
 namespace :data_pitcher do
   desc 'Export data to google spreadsheets with SQL'
-  task execute: :environment do
-    DataPitcher::Batch.new.execute
+  namespace :export do
+    task run: :environment do
+      export(dry_run: false)
+    end
+    task dry_run: :environment do
+      export(dry_run: true)
+    end
   end
 end
+
+def export(dry_run: true)
+  puts "** Start export data / sending: #{!dry_run}"
+  DataPitcher::Batch.new.execute(dry_run: dry_run)
+  puts "** Completed export data / sending: #{!dry_run}"
+end

data/lib/data_pitcher/version.rb

@@ -1,3 +1,3 @@
 module DataPitcher
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_pitcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Masahiro Nishimi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -69,6 +69,7 @@ files:
 - data_pitcher.gemspec
 - lib/data_pitcher.rb
 - lib/data_pitcher/batch.rb
+- lib/data_pitcher/command.rb
 - lib/data_pitcher/configuration.rb
 - lib/data_pitcher/executor.rb
 - lib/data_pitcher/railtie.rb