motion_vj 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWUwMzVjNGM0YWFjMzEwNmMxMGJmMGZmOTlkMjA0MDVhMzBkNWFmMw==
+    NmUzNGIxZDY1ZjAwMDI4YTU5OTM2YWExMmFiZDAyODdmNGNkZDc0Mg==
   data.tar.gz: !binary |-
-    MTgwODhmYzliNjRiNTM2MjBkNzdjZWQxODFiZDZkZTdkMGJjNTM3ZQ==
+    NTE5ZDViYTQ1ZGVjYjRkMDhiNGI0ZjUzYmNlMDg2YTY0ZWVjMjk0YQ==
 SHA512:
   metadata.gz: !binary |-
-    MjJlMTEyM2I1MjM3NGYwODU3NTY5OGJmMTA2NjdlZjlhOTEwYmZmZjAzN2Q4
-    YTcwZjczZGIzMzI0N2FiMmNiOGFhMjlkZjQ3MDMyZTc1OTI5Y2VmYzlkNGY1
-    NDdiODljZjg5NmJjZGJjYzcwMWE4MTc0YmUxY2I1YTEwZmFkZWU=
+    MDA2NDQzMzFhMTQ3ODNjZTFkYTEyMGM5NWRlYjE2ZGE1MWY2NjI1NjU4MWQz
+    NmU1NjFkNGJjZTZkOWExOWE5Y2QxYWFlNjczNjgxZGIwMzIxYmQ2MGIwMGQ4
+    N2E1MTk1YjljYWQ1ZGIxNTQwYzdiNTE5ZmFiN2UyNjM5ZTFkMTA=
   data.tar.gz: !binary |-
-    ZTQ0NWJiOGFkZGYxOThlNjQ3YTk0NGRkM2E5MTdhZGJjM2VjNTFhZWZlZjJm
-    Mjg4Y2VjNjc0MjNlMzJlYmI3OTI5MWEzNjc2MTdkMGFlN2QwNGNjMjU3ZjIz
-    YmY4MTQ3ODY4N2NlMGIzNDk5YWFhNWQ0ODUwNjE3NDdhODNmYzU=
+    NjU3Y2FlYjAzOTFjOGNiMjIyMzQ3N2FjNmJmM2U3MDQ1MmQ2NjJjM2M1NDAy
+    MjI2NmU3Y2Y3OTFlMzNkMjA4ODExYmY4OTk1ZTg4NWMwYTI4M2Y5NzljMWJh
+    M2U3ZTg0YmQzYWM3ODA1ODhiMWE0YzJkYmIzNDIwYzE4NWU1OTM=

data/README.md

@@ -8,11 +8,40 @@ Install the gem and make the executable available:
 
     $ gem install motion_vj
 
+## Configuration
+
+The configuration file should look like this:
+
+```yaml
+# config.yml
+
+# To obtain the app key and secret, go to https://www.dropbox.com/developers/apps/create
+db_app_key: <App key from Dropbox>
+db_app_secret: <App secret from Dropbox>
+# The token can be generated using `--get-token`. Please see the Usage section of the README.
+db_app_token: <App token from Dropbox>
+# The Dropbox directory where the files will be uploaded.
+db_videos_dir: /
+
+# The motion CLI name.
+motion_cmd: motion
+# Path to the PID file that will be created when running.
+pid_file: /var/run/motion/motion.pid
+# Directory where motion save the videos.
+videos_dir: /var/run/motion/videos
+# Extension of the videos that should be uploaded.
+videos_extension: avi
+```
+
+You must provide it using the `--config-file` option as pointed by the [Usage](#usage) section.
+
 ## Usage
 
-Once installed, a Dropbox token is needed to start. Run `motionvj --get-token` and follow the instructions.
+So that `motionvj` can access a Dropbox account, a Dropbox token needs to be created. This will be a one time action, and it can be acomplished running `motionvj --get-token --config-file config.yml`, where `config.yml` is the file detailed by the [Configuration](#configuration) section of this README. Once the token is created, it should be added to the same configuration file.
+
+To start uploading new videos, just run `motionvj --config-file config.yml`. This should upload new videos that end with the extension indicated by the configuration file. After a file is uploaded to Dropbox, it is then deleted from the local filesystem.
 
-For more details, run `motionvj --help`:
+For more options, run `motionvj --help`:
 
 ```
 Usage: motionvj [options]

data/exe/motionvj

@@ -2,26 +2,36 @@
 
 require 'motion_vj'
 
-require 'dotenv'
 require 'fileutils'
 require 'optparse'
+require 'yaml'
 
 class App
-  def self.parse!(argv)
-    options = {}
+  attr_accessor :options, :config
+
+  def initialize(argv)
+    parse!(argv)
+    load_config!
+    start
+  end
+
+  private
+
+  def parse!(argv)
+    self.options = {}
     opt_parser = OptionParser.new do |opts|
       opts.banner = 'Usage: motionvj [options]'
 
       opts.separator 'Required:'
 
-      opts.on('-c', '--config-file [CONFIG_FILE]', 'Path to the configuration file') do |config_filepath|
-        options[:config_filepath] = config_filepath
+      opts.on('-c', '--config-file [CONFIG_YAML_FILE]', 'Path to the configuration YAML file') do |config_filepath|
+        self.options[:config_filepath] = config_filepath
       end
 
       opts.separator 'Optional:'
 
       opts.on('-t', '--get-token', 'Get the Dropbox token') do
-        options[:get_token] = true
+        self.options[:get_token] = true
       end
 
       opts.separator 'Common:'
@@ -44,72 +54,70 @@ class App
       abort opt_parser.to_s
     end
 
-    if options[:config_filepath].nil? || options[:config_filepath].to_s.strip.empty?
-      $stderr.puts 'The configuration file is required.'
+    if self.options[:config_filepath].nil? || self.options[:config_filepath].to_s.strip.empty?
+      $stderr.puts 'The configuration YAML file is required.'
       abort opt_parser.to_s
     end
-
-    options
   end
 
-  def self.start(options)
-    Dotenv.load(options[:config_filepath])
-    self.check_config
+  def load_config!
+    self.config = YAML.load_file(self.options[:config_filepath])
+    blank_config_msg = %w( db_videos_dir motion_cmd pid_file videos_dir videos_extension ).map { |key|
+      key if /\A[[:space:]]*\z/ === self.config[key].to_s
+    }.compact
+    abort "The following configuration options are missing:\n#{ blank_config_msg.join("\n") }" unless blank_config_msg.empty?
+  rescue Errno::ENOENT
+    abort "Could not open the configuration file: #{ self.options[:config_filepath] }"
+  end
 
+  def start
     trap('INT') do
-      self.remove_pid_file
+      remove_pid_file
       exit 2
     end
 
-    self.create_pid_file
+    create_pid_file
 
     if options[:get_token]
-      MotionVj.get_dropbox_token(self.get_env('DP_APP_KEY'), self.get_env('DP_APP_SECRET'))
+      MotionVj.get_dropbox_token(self.config['db_app_key'], self.config['db_app_secret'])
     else
-      MotionVj.start(get_env('DP_APP_TOKEN'))
+      MotionVj.start(db_app_token:     self.config['db_app_token'],
+                     videos_dir:       self.config['videos_dir'],
+                     videos_extension: self.config['videos_extension'],
+                     motion_cmd:       self.config['motion_cmd'],
+                     db_videos_dir:    self.config['db_videos_dir'])
       sleep
     end
+  ensure
+    remove_pid_file
   end
 
-  private
-
-  def self.check_config
-    %w( MOTION_CMD VIDEOS_DIR VIDEO_EXTENTION PID_FILE DB_VIDEOS_DIR ).each { |key| self.get_env(key) }
-  end
-
-  def self.get_env(key)
-    value = ENV[key]
-    abort "The environment variable '#{key}' is blank or defined." if value.to_s.strip.empty?
-    value
-  end
-
-  def self.read_pid
+  def read_pid
     pid = nil
-    if File.exist?(ENV['PID_FILE'])
-      File.open(ENV['PID_FILE'], 'r') do |f|
+    if File.exist?(self.config['pid_file'])
+      File.open(self.config['pid_file'], 'r') do |f|
         pid = f.gets.to_i rescue nil
       end
     end
     pid
   end
 
-  def self.create_pid_file
-    pid = self.read_pid
+  def create_pid_file
+    pid = read_pid
     if pid && !pid.zero?
       pid_exist = !!Process.kill(0, pid) rescue false
-      abort "motionvj is already running. Please check the PID in '#{ENV['PID_FILE']}'." if pid_exist
+      abort "motionvj is already running. Please check the PID in '#{ self.config['pid_file'] }'." if pid_exist
     end
 
-    File.open(ENV['PID_FILE'], 'w') do |f|
+    File.open(self.config['pid_file'], 'w') do |f|
       f.puts Process.pid
     end
   end
 
-  def self.remove_pid_file
-    pid = self.read_pid
-    FileUtils.rm_f(ENV['PID_FILE']) if pid && pid === Process.pid
+  def remove_pid_file
+    pid = read_pid
+    FileUtils.rm_f(self.config['pid_file']) if pid && pid === Process.pid
   end
 end
 
-options = App.parse!(ARGV)
-App.start(options)
+App.new(ARGV)

data/lib/motion_vj.rb

@@ -9,20 +9,20 @@ require 'listen'
 module MotionVj
   def self.get_dropbox_token(app_key, app_secret)
     token = MotionVj::Client.get_token(app_key, app_secret)
-    puts "Your Dropbox access token for this app is: #{token}"
+    puts "Your Dropbox access token for this app is: #{ token }"
   end
 
-  def self.start(token)
-    listener = Listen.to(ENV['VIDEOS_DIR'], only: /\.#{Regexp.escape ENV['VIDEO_EXTENTION']}$/) do |modified_filepaths, _, removed_filepaths|
+  def self.start(options)
+    listener = Listen.to(options[:videos_dir], only: /\.#{ Regexp.escape options[:videos_extension] }$/) do |modified_filepaths, _, removed_filepaths|
       # handle addded files
       unless modified_filepaths.empty?
-        client = MotionVj::Client.new(token)
-        motion_lsof = `lsof -c #{ENV['MOTION_CMD']}`
+        client = MotionVj::Client.new(options[:db_app_token], options[:db_videos_dir])
+        motion_lsof = `lsof -c #{ options[:motion_cmd] }`
 
         modified_filepaths.each do |filepath|
           file_basename = File.basename filepath
 
-          if motion_lsof =~ /#{Regexp.escape file_basename}/
+          if motion_lsof =~ /#{ Regexp.escape(file_basename) }/
             Logger.error "Added file still in use."
             next
           end
@@ -32,12 +32,12 @@ module MotionVj
             begin
               if client.upload(filepath)
                 FileUtils.rm_f(filepath)
-                Logger.info "'#{file_basename}' was uploaded."
+                Logger.info "'#{ file_basename }' was uploaded."
               else
-                Logger.error "Could not upload '#{file_basename}'."
+                Logger.error "Could not upload '#{ file_basename }'."
               end
             rescue => e
-              Logger.error "Could not upload '#{file_basename}'."
+              Logger.error "Could not upload '#{ file_basename }'."
             end
           end
         end
@@ -45,7 +45,7 @@ module MotionVj
 
       # handle removed files
       removed_filepaths.each do |filepath|
-        Logger.info "'#{File.basename(filepath)}' deleted."
+        Logger.info "'#{ File.basename(filepath) }' deleted."
       end
     end
     listener.start

data/lib/motion_vj/client.rb

@@ -2,15 +2,16 @@ require 'dropbox_sdk'
 
 module MotionVj
   class Client
-    attr_reader :db_client
+    attr_reader :db_client, :videos_dir
 
-    def initialize(token)
+    def initialize(token, videos_dir)
       @db_client = DropboxClient.new(token)
+      @videos_dir = videos_dir
     end
 
     def file_exist?(filename)
       begin
-        metadata = db_client.metadata(File.join(ENV['DB_VIDEOS_DIR'], filename))
+        metadata = self.db_client.metadata(File.join(self.videos_dir, filename))
         metadata && !metadata['is_dir'] && metadata['bytes'] && metadata['bytes'] > 0
       rescue DropboxError => e
         false
@@ -19,7 +20,7 @@ module MotionVj
 
     def upload(filepath)
       open(filepath) do |file|
-        metadata = db_client.put_file(File.join(ENV['DB_VIDEOS_DIR'], File.basename(filepath)), file, true)
+        metadata = self.db_client.put_file(File.join(self.videos_dir, File.basename(filepath)), file, true)
         metadata && !metadata['is_dir'] && metadata['bytes'] && metadata['bytes'] > 0
       end
     end
@@ -28,7 +29,7 @@ module MotionVj
       flow = DropboxOAuth2FlowNoRedirect.new(app_key, app_secret)
       authorize_url = flow.start
 
-      puts "1. Go to: #{authorize_url}"
+      puts "1. Go to: #{ authorize_url }"
       puts '2. Click "Allow" (you might have to log in first)'
       puts '3. Copy the authorization code'
       print 'Enter the authorization code here: '

data/lib/motion_vj/helpers/input.rb

@@ -5,7 +5,7 @@ module MotionVj
         loop do
           value = $stdin.gets.to_s.strip
           if value.empty?
-            print("Please provide a valid #{input_name}:")
+            print("Please provide a valid #{ input_name }: ")
           else
             return value  
           end

data/lib/motion_vj/logger.rb

@@ -11,7 +11,7 @@ module MotionVj
     private
 
     def self.format(msg, type)
-      "[motionvj][#{Time.now.utc.strftime("%Y-%m-%d %H:%M:%S %Z")}][#{type}]: #{msg}"
+      "[motionvj][#{ Time.now.utc.strftime("%Y-%m-%d %H:%M:%S %Z") }][#{ type }]: #{ msg }"
     end
   end
 end

data/lib/motion_vj/version.rb

@@ -1,3 +1,3 @@
 module MotionVj
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/motion_vj.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'dotenv', "~> 2.0"
   spec.add_dependency 'dropbox-sdk', "~> 1.6"
   spec.add_dependency 'listen', "~> 3.0"
 

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: motion_vj
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roque Pinel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dropbox-sdk
   requirement: !ruby/object:Gem::Requirement