okshot 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3779b73a09c5841b6c98731300dad286e36191ce5b97af4345ae9eeb644ecbc4
-  data.tar.gz: f9350c2863dc423896db54be135322742f2e0a2933ff6cb904a76668a279b628
+  metadata.gz: dac8faf503714e6c195b6d07c2b046b873d857df50e72e33ae3d227081fcbe3e
+  data.tar.gz: 485a3c0fa9c11e545adad059dd6f9e36dbba8fc154c10914c79358ce953402c5
 SHA512:
-  metadata.gz: eb242769569c4bf1fd1c7b5a602924873cc1e173cd395f0ae2861037e746bc55ac14afa7f719223115b0afd8342b4d9ed3a10d7dfcc2f5090a2ccf96929d17e9
-  data.tar.gz: bd55a425d8bc90024fd7b6a6f1bf907715c509907e09fd3a4a3e3192195ab6570458f1dd5b171e4f6f3eecba64d1086afe4b3c30aae0ba0d62e8e6f31e66ac38
+  metadata.gz: dcf40412c7284cfaebb31e74d68a504363b70ff87a5dea4dfdfd208878906c6d4a027dcac758a118226c6115f2ef376ad7ba442c5fc251ded89f12f0ffc40375
+  data.tar.gz: 490d644591fc142ef9fcf3c40aab21731d2f70596fe4d4dadf2d2347ee097ad1658369424f8df0d8f1b922419bc0318b76dee7c18f36607ab37a1375e796a82c

data/README.org

@@ -6,7 +6,6 @@
  \___/|_|\_\___/_| |_|\___/ \__|
 #+end_example
 
-# #+html: <img src="https://github.com/200ok-ch/okshot/workflows/CI/badge.svg"/>
 #+html: <a href="https://rubygems.org/gems/okshot"> <img src="https://badge.fury.io/rb/okshot.svg"/></a>
 
 * NAME
@@ -17,18 +16,21 @@
 
   #+begin_example
     Usage: okshot [options]
+        -C, --copy-to-clipboard          Copy PNG file from clipboard and upload
         -s, --simple                     Take a screenshot without annotation and upload
-        -c, --copy-clipboard             Copy PNG file from clipboard and upload
+        -c, --copy-from-clipboard        Copy PNG file from clipboard and upload
         -i, --inkscape                   Use inkscape to edit the screenshot and upload
   #+end_example
 
 * DESCRIPTION
 
-=okshot= takes a screenshot, saves it to a FTP server and copies a web
-accessible URL to your clipboard. Optionally, the screenshot can be
-annotated using Inkscape.
+=okshot= takes a screenshot, optionally annotates it and then saves it
+either to the clipboard or uploads it to a FTP server and copies a web
+accessible URL to your clipboard.
 
 This gem is inspired by the lack of good screenshot tooling in Linux.
+However, Linux has all the tools available that can easily be strung
+together to get the ultimate screenshot tool.
 
 For uploading the files via FTP, it needs these environment variables set:
 
@@ -57,21 +59,31 @@ export OKSHOT_URL_PREFIX=https://okshot.your_domain.ch
 
 It uses the following standard Linux tools. For all flags, it requires:
 
-- [[https://imagemagick.org/][imagemagick]]
-- [[https://linux.die.net/man/1/ftp][ftp]]
-- [[https://linux.die.net/man/1/uuidgen][uuigen]]
-- [[https://linux.die.net/man/1/xclip][xclip]]
+| Program     | Rationale                                                        |
+|-------------+------------------------------------------------------------------|
+| [[https://imagemagick.org/][imagemagick]] | Takes the actual screenshot as a PNG file.                       |
+| [[https://linux.die.net/man/1/uuidgen][uuigen]]      | Adds a partial UUID to the screenshot name to ensure uniqueness. |
+| [[https://linux.die.net/man/1/xclip][xclip]]       | Copies the public screenshot URL to the clipboard.               |
+| [[http://manpages.ubuntu.com/manpages/xenial/man1/notify-send.1.html][notify-send]] | Creates a desktop notification that the URL is in the clipboard. |
+
+Without the flag =-C= (=--copy-to-clipboard=), the file is uploaded to
+an FTP server and requires:
+
+| Program     | Rationale                                                        |
+|-------------+------------------------------------------------------------------|
+| [[https://linux.die.net/man/1/ftp][ftp]]         | Uploads the final screenshot to a FTP server.                    |
 
 For the flag =-i=, it additionally requires:
 
-- [[https://linux.die.net/man/1/wmctrl][wmctrl]]
-- [[https://inkscape.org/][inkscape]]
-- [[https://imagemagick.org/][imagemagick]]
+| Program  | Rationale                           |
+|----------+-------------------------------------|
+| [[https://inkscape.org/][inkscape]] | Annotate the image in all the ways. |
+| [[https://linux.die.net/man/1/wmctrl][wmctrl]]   | Starts Inkscape in full screen.     |
 
 Install dependencies:
 
 #+begin_src shell
-apt-get install imagemagick ftp inkscape wmctrl uuid-runtime xclip
+apt-get install imagemagick ftp inkscape wmctrl uuid-runtime xclip libnotify-bin
 #+end_src
 
 * DEVELOPMENT

data/bin/take_screenshot.sh

@@ -14,7 +14,6 @@ elif [[ $1 == -h ]]; then
   echo " -c: Copy clipboard to file and upload"
   echo " -i: Use inkscape to edit the screenshot and upload"
   echo " -h: Show this help"
-  exit 0
 elif [[ $1 == -i ]]; then
   import /tmp/$screenshot
 
@@ -62,19 +61,31 @@ else
   exit 1
 fi
 
-HOST=$OKSHOT_HOST
-USER=$OKSHOT_USER
-PASSWD=$OKSHOT_PASSWORD
+echo "SCREENSHOT FILE: "
 
-ftp -p -n -v $HOST <<END_SCRIPT
+echo "/tmp/${screenshot}"
+
+
+if [[ $2 == -C ]]; then
+  # Copy to clipboard
+  xclip -selection clipboard -t image/png -i /tmp/$screenshot
+
+  notify-send "Copied screenshot to clipboard"
+else
+  # Upload to host
+  HOST=$OKSHOT_HOST
+  USER=$OKSHOT_USER
+  PASSWD=$OKSHOT_PASSWORD
+
+  ftp -p -n -v $HOST <<END_SCRIPT
 user $USER $PASSWD
 put /tmp/$screenshot $screenshot
 quit
 END_SCRIPT
 
-screenshot_url="$OKSHOT_URL_PREFIX/$screenshot"
-
-echo $screenshot_url | xclip -selection c
+  screenshot_url="$OKSHOT_URL_PREFIX/$screenshot"
+  echo $screenshot_url | xclip -selection c
+  notify-send "Copied $screenshot_url to clipboard"
+fi
 
-notify-send "Copied $screenshot_url to clipboard"
-rm /tmp/$screenshot
+exit 0

data/lib/ok/shot.rb

@@ -2,6 +2,7 @@
 # coding: utf-8
 
 require 'optparse'
+require 'ostruct'
 require 'set'
 require 'readline'
 require 'fileutils'
@@ -11,40 +12,49 @@ module OK
     class Error < StandardError; end
     extend self
 
-    def take_screenshot(flag)
+    def take_screenshot(options)
       bin_dir = File.expand_path(File.join(%w[.. .. .. bin]), __FILE__)
-      shell_script_path = File.join(bin_dir, "take_screenshot.sh -#{flag}")
+      shell_script_path = File.join(bin_dir, "take_screenshot.sh -#{options.flag}")
+      shell_script_path += " -C" if options.copy_to_clipboard
       `#{shell_script_path}`
     end
 
     def main
+      options = OpenStruct.new
       OptionParser.new do |opts|
         opts.banner = 'Usage: okshot [options]'
+        opts.on(
+          '-C',
+          '--copy-to-clipboard',
+          'Copy PNG file from clipboard and upload'
+        ) do |c|
+          options.copy_to_clipboard = true
+        end
         opts.on(
           '-s',
           '--simple',
           'Take a screenshot without annotation and upload'
         ) do |c|
-          take_screenshot('s')
-          exit
+          options.flag = 's'
         end
         opts.on(
           '-c',
-          '--copy-clipboard',
+          '--copy-from-clipboard',
           'Copy PNG file from clipboard and upload'
         ) do |c|
-          take_screenshot('c')
-          exit
+          options.flag = 'c'
         end
         opts.on(
           '-i',
           '--inkscape',
           'Use inkscape to edit the screenshot and upload'
         ) do |c|
-          take_screenshot('i')
-          exit
+          options.flag = 'i'
         end
       end.parse!
+
+      take_screenshot(options)
+      exit
     end
   end
 end

data/lib/ok/version.rb

@@ -1,5 +1,5 @@
 module OK
   module Shot
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okshot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alain M. Lafon