From 569cdb5b524ad8d45ac0cf1fedf8cf3f092d1dd7 Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Fri, 1 Jan 2021 02:40:27 +0100 Subject: [PATCH] Initial import --- .gitignore | 6 ++ LICENSE.txt | 165 +++++++++++++++++++++++++++++++++++++++ Makefile | 20 +++++ README.md | 93 ++++++++++++++++++++++ config/wishes.csv.sample | 2 + shard.lock | 10 +++ shard.yml | 25 ++++++ src/main.cr | 142 +++++++++++++++++++++++++++++++++ 8 files changed, 463 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.txt create mode 100644 Makefile create mode 100644 README.md create mode 100644 config/wishes.csv.sample create mode 100644 shard.lock create mode 100644 shard.yml create mode 100644 src/main.cr diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b25607f --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +_build +*.csv +*.ods +/lib +/tmp +*.log diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d52645e --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ + +PROGNAME=happy-send + +all: help + +build: # ## build binary + crystal build -o _build/$(PROGNAME) src/main.cr + +help: ## print this help + @echo "Usage: make " + @echo "" + @echo "With one of following targets:" + @echo "" + @awk 'BEGIN {FS = ":.*?## "} \ + /^[a-zA-Z_-]+:.*?## / \ + { sub("\\\\n",sprintf("\n%22c"," "), $$2); \ + printf("\033[36m%-20s\033[0m %s\n", $$1, $$2); \ + }' $(MAKEFILE_LIST) + @echo "" + diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee5655f --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +# Happy Send + +Happy-Send is a tool that makes it easy to send wishes to lots of people through short text messages. + +It simply parses a CSV file and uses [KDE Connect](https://community.kde.org/KDEConnect) command line tool to control your smartphone. + + +## Installation + +1. Make sure that a recent version of Crystal (0.35) is installed +2. Make sure that kdeconnect-cli is installed + +Then run the following commands : + + $ shards install + $ make build + +That should create the binary `_build/happy-send` + +## Usage + +### Available options + + + Happy Send - Mass send short text messages via your smartphone + kdeconnect + + Usage: + + main_of_clim_library [options] [arguments] + + Options: + + -s, --send really send messages (dry-run by default) [type:Bool] + -w, --wait=SECONDS wait SECONDS between each message (default: 5) [type:Int32] [default:5] + -v, --verbose enable debug messages [type:Bool] + -c FILE, --csv=FILE CSV with firstname,lastname,number,message [type:String] [required] + --help Show this help. + + +### Preparing your file + +Fill a CSV file respecting the structure below. Note you can insert variables from +other columns within your message. + + "group","firstname","lastname","number","message" + "MAINTAINER","Glenn","Rolland","+33673983956","Happy new year {{ firstname }} !" + "HEROES","Jon","Snow","+33xxxxxx","Happy new year {{ firstname }} ! Winter is coming." + "HEROES","Harry","Potter","+32xxxxxx","Happy new year {{ firstname }} ! Expecto patronum in 2021 !" + "HEROES","Luke","Skywalker","+33xxxxxx","Happy new year {{ firstname }} ! May the force be with you in 2021" + +Verify what will be done with the following command. No message will be sent yet : + + $ _build/happy-send --csv config/friends.csv + +### Sending the messages ! + +Make sure your that + +1. Your smartphone has the KDE Connect app installed. +2. Your smartphone is connected on the same wifi network as your computer + +Verify that your computer is able to detect your smartphone + + $ kdeconnect-cli -a + - Galaxy S8: b4fade0a33cdf703 (paired and reachable) + 1 device found + +If it is ok for you, launch it for real : + + $ _build/happy-send --send --csv config/friends.csv + + +## Contributing + +1. Fork it ( http://github.com/glenux/musala-push/fork ) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request + + +## Credits + +* [Glenn Y. ROLLAND](https://github.com/glenux) - author & maintainer: +* You? Fork the project and become a contributor! + +Got questions? Need help? Tweet at [@glenux](https://twitter.com/glenux) + + +## License + +Happy Send is Copyright © 2018-2019 Glenn ROLLAND. It is free software, and may be redistributed under the terms specified in the LICENSE.txt file. + diff --git a/config/wishes.csv.sample b/config/wishes.csv.sample new file mode 100644 index 0000000..b367f14 --- /dev/null +++ b/config/wishes.csv.sample @@ -0,0 +1,2 @@ +"group","firstname","lastname","number","message" +"MAINTAINER","Glenn","Rolland","+33673983956","Happy new year {{ firstname }} !" diff --git a/shard.lock b/shard.lock new file mode 100644 index 0000000..9a0503d --- /dev/null +++ b/shard.lock @@ -0,0 +1,10 @@ +version: 2.0 +shards: + clim: + git: https://github.com/at-grandpa/clim.git + version: 0.14.0 + + crustache: + git: https://github.com/MakeNowJust/crustache.git + version: 2.4.3 + diff --git a/shard.yml b/shard.yml new file mode 100644 index 0000000..5b2a681 --- /dev/null +++ b/shard.yml @@ -0,0 +1,25 @@ +name: happy-new-year-with-kdeconnect +version: 0.1.0 + +# authors: +# - name + +# description: | +# Short description of happy-new-year-with-kdeconnect + +# dependencies: +# pg: +# github: will/crystal-pg +# version: "~> 0.5" +dependencies: + clim: + github: at-grandpa/clim + version: 0.14.0 + crustache: + github: MakeNowJust/crustache + +# development_dependencies: +# webmock: +# github: manastech/webmock.cr + +# license: MIT diff --git a/src/main.cr b/src/main.cr new file mode 100644 index 0000000..b05917d --- /dev/null +++ b/src/main.cr @@ -0,0 +1,142 @@ +require "clim" +require "csv" +require "log" +require "crustache" +require "colorize" + +LOG = ::Log.for("happy") +#LOG = Logger.new(STDOUT, level: Logger::WARN) + +class HappyApp + + def initialize(csv = "", wait = 5, send = false) + @config = csv + @wait = wait + @send = send + @device = "" + end + + def validate() + if File.exists? @config + LOG.info { "Found configuration file '#{@config}'. Good." } + else + LOG.error { "ERROR: configuration file '#{@config}' does not exist!" } + exit 1 + end + + if !@device.to_s.empty? + LOG.info { "Found device '#{@device}'. Good." } + else + LOG.error { "ERROR: unable to detect kdeconnect device!" } + exit 1 + end + end + + def detect_device() + @device = `kdeconnect-cli --list-available --id-only`.strip + end + + def send_message(row_h) + + template = Crustache.parse row_h["message"] + row_h["message"] = Crustache.render template, row_h + LOG.debug { "Rendered text = #{row_h["message"]}" } + + if !@send + LOG.warn { "Dry-run mode. Not sending message for #{row_h.values}" } + return + end + + LOG.warn { "Sending message for #{row_h.values}" } + res = Process.run( + "kdeconnect-cli", + [ + "--device", @device, + "--destination", row_h["number"], + "--send-sms", row_h["message"] + ], + output: STDOUT, + input: STDIN, + error: STDERR + ) + if !res.success? + LOG.warn { "Command status error for #{row_h.values}" } + end + + rescue e + LOG.error { "Error while sending message for #{row_h.values}. #{e.message}" } + end + + def exec() + File.open(@config) do |csv_fh| + csv = CSV.new(csv_fh, headers: true, strip: true) + # puts csv.inspect + csv.each do |row_strip| + row = row_strip.row + row_h = row.to_h + + if row["firstname"] =~ /^\s*$/ || row["firstname"] =~ /^#.*$/ + LOG.debug { "Skipping line for #{row_h.values}" } + next + end + + # Check number + if row["number"].empty? + LOG.warn { "Missing number for #{row_h.values}. Skipping" } + next + end + row_h["number"] = row["number"].gsub(/\s+/,"") + + send_message(row_h) + sleep @wait + + end + puts "SUCCESS" + end + end +end + +class HappyCli < Clim + main do + desc "Happy Send - Mass send short text messages via your smartphone + kdeconnect" + + option "-s", "--send", + type: Bool, + desc: "really send messages (dry-run by default)" + + option "-w", "--wait=SECONDS", + type: Int32, + default: 5, + desc: "wait SECONDS between each message (default: 5)" + + option "-v", "--verbose", + type: Bool, + desc: "enable debug messages" + + option "-c FILE", "--csv=FILE", + type: String, + required: true, + desc: "CSV with firstname,lastname,number,message" + + run do |opts, args| + Log.setup(:warn) + Log.setup(:debug) if opts.verbose + + if opts.send + Log.warn { "Disabling dry-run mode : messages will be sent !" } + STDERR.puts "Disabling dry-run mode. Type 'yes' to confirm or anything else to exit" + if STDIN.gets.to_s.strip != "yes" + Log.warn { "Disabling dry-run was not confirmed. Exiting" } + exit 1 + end + end + + app = HappyApp.new(csv: opts.csv, send: opts.send, wait: opts.wait) + app.detect_device + app.validate + app.exec + end + end +end + +HappyCli.start(ARGV)