V0.6.0 --single-sync flag

Author: jorinvo

README.md

@@ -87,6 +87,18 @@ Often you don't want to open up another port just for OAuth of a small sync tool
 To work around this you can run `java -jar googlesheets-sql-sync.jar --auth-only` on your local machine, then copy the generated `googlesheets_sql_sync.auth.json` file to your server and on the server run `java -jar googlesheets-sql-sync.jar --no-server`
 
 
+### Single Sync
+
+If you don't want to keep the syncing your data in an interval but want to sync only once,
+you can do so by passing the `single-sync` like this: `java -jar googlesheets-sql-sync.jar --single-sync`
+
+
+
+## Metrics
+
+By default a simple Prometheus counter `googlesheets_sql_sync_count` is provided at `/metrics`.
+
+
 ### Customization
 
 The program can be configured using command line flags. To see available options, run:

project.clj

@@ -1,4 +1,4 @@
-(defproject googlesheets-sql-sync "0.5.2"
+(defproject googlesheets-sql-sync "0.6.0"
   :description "Keep your SQL database in sync with Google Sheets"
   :url "https://github.com/jorinvo/googlesheets-sql-sync"
   :license {:name "MIT"

src/googlesheets_sql_sync/core.clj

@@ -8,9 +8,20 @@
    [googlesheets-sql-sync.metrics :as metrics]
    [googlesheets-sql-sync.worker :as worker]))
 
+(defn stop
+  "Stops system. If system is not running, nothing happens."
+  [{:keys [timeout> work> stop-server]}]
+  (log/info "\nShutting down")
+  (when stop-server
+    (stop-server))
+  (when timeout>
+    (close! timeout>))
+  (when work>
+    (close! work>)))
+
 (defn start
   "Build a system from options, start it and return it."
-  [{:as options :keys [api-rate-limit auth-only no-metrics no-server]}]
+  [{:as options :keys [api-rate-limit auth-only no-metrics no-server single-sync]}]
   (try
     (let [ctx (assoc options
                      :work>     (chan)
@@ -23,32 +34,30 @@
                               (<! c))
                             (stop-server))))
         (cond-> ctx
-            true
-            (assoc :timeout>
-                   (interval/create-timeout> (:work> ctx) [:sync]))
+          (not single-sync)
+          (assoc :timeout>
+                 (interval/create-timeout> (:work> ctx) [:sync]))
+
+          single-sync
+          (assoc :timeout>
+                 (chan))
 
-            (not (or no-server no-metrics))
-            (metrics/init)
+          (not (or no-server no-metrics))
+          (metrics/init)
 
-            (not no-server)
-            (#(assoc % :stop-server (web/start %)))
+          (not no-server)
+          (#(assoc % :stop-server (web/start %)))
 
-            true
-            (#(assoc % :worker> (worker/start %))))))
+          true
+          (#(assoc % :worker> (worker/start %)))
+
+          single-sync
+          (#(do (go (<! (:timeout> %))
+                    (stop %))
+                %)))))
     (catch Exception e (do (log/error "Error while starting:" (.getMessage e))
                            :not-ok))))
 
-(defn stop
-  "Stops system. If system is not running, nothing happens."
-  [{:keys [timeout> work> stop-server]}]
-  (log/info "\nShutting down")
-  (when stop-server
-    (stop-server))
-  (when timeout>
-    (close! timeout>))
-  (when work>
-    (close! work>)))
-
 (defn trigger-sync
   "Tell system to sync, but doesn't wait for sync to complete."
   [{:keys [work>]}]

src/googlesheets_sql_sync/options.clj

@@ -26,6 +26,7 @@
                                   :default  "https://www.googleapis.com/oauth2/v4/token"
                                   :validate [valid-url? "Must be a valid URL"]}
                :auth-only        {:desc     "Setup authentication, then quit, don't sync"}
+               :single-sync      {:desc     "Sync once only, then quit"}
                :no-server        {:desc     "Disable server, disables authentication and metrics"}
                :no-metrics       {:desc     "Disable metrics"}])
 

src/googlesheets_sql_sync/worker.clj

@@ -21,7 +21,7 @@
 
 (defn- do-sync
   "Authenticate, fetch data and update DB"
-  [{:keys [config-file no-server timeout> throttler user-oauth-url] :as ctx}]
+  [{:as ctx :keys [config-file no-server timeout> throttler user-oauth-url single-sync]}]
   (try
     (let [cfg (config/get config-file)]
       (try
@@ -38,7 +38,8 @@
               :not-ok)
             (show-init-message (:google_credentials cfg) user-oauth-url)))
         (catch Exception e (log/error (.getMessage e) "\nSync failed")))
-      (log/info "Next sync in" (interval/->string (:interval cfg)))
+      (when-not single-sync
+        (log/info "Next sync in" (interval/->string (:interval cfg))))
       (async/put! timeout> (:interval cfg)))
     (catch Exception e (do (log/error "Failed reading config file" (.getMessage e))
                            :not-ok))))