evertils 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65d895569799db5920d1b76e561a6a363fae85ee
-  data.tar.gz: f1acb30f9bbc5438504d9352977f2d1d159030e5
+  metadata.gz: 07a3dcfb90a36fe908d3631fd2913c8d11beb75d
+  data.tar.gz: 06ab1f37824726351c99669bbcd11be3a80aee32
 SHA512:
-  metadata.gz: f3d37d95646c11d7478323ef7f71209babfc096ba21b3bd1f8bb1a0c9cae6e0026a8976a30a0052821283a76bbd6c63d5f1d3f31d9226775dbe4bb5a32df719f
-  data.tar.gz: d005df3a6f82e6e30106816083ca3216730907908b4cb0b5bde02e6681bd90b67f1c6024d19fb5be6803313b0e4d8feeb396108235fb5b80ca08f49bc679f132
+  metadata.gz: 4f86f711952cf2be0a52e20a1b601158e945de39f1eb9c1ee6841d04ff85a67281e2809679d4101698783bec98ba7443c058d17734a3b5e56d2ea07cb93414cf
+  data.tar.gz: 9ec2672767c26c57e5241cf6fdd16c46daed47502b8751478244050439a4f85c45c5bb23b4aa1e948e17a9a208d6c47ec6c2e987f0adb7736b8bf9594392075f

data/Gemfile

@@ -1,6 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rubocop"
-gem "notifaction"
-gem "evernote-thrift"
-gem "mime-types"
+gem 'rubocop'
+gem 'notifaction'
+gem 'evernote-thrift'
+gem 'mime-types'
+gem 'rake'

data/README.md

@@ -10,7 +10,7 @@ Utilities for talking to your Evernote account.  Create notes, generate statisti
 Get your Evernote Developer Tokens [here](https://www.evernote.com/Login.action?targetUrl=%2Fapi%2FDeveloperToken.action).
 
 ## Logging Specification
-See [this document](LOGGING_SPECIFICATION.md) to see how it all gets organized.
+See [this document](https://github.com/aapis/evertils/wiki/Logging-Specification) to see how it all gets organized.
 
 ## How to Use
 
@@ -20,3 +20,4 @@ See [this document](LOGGING_SPECIFICATION.md) to see how it all gets organized.
 |new|Manually create notes|`evertils new note "STUFF"`, `evertils new share_note "STUFF"`, `other task | evertils new share_note --title="Piped data note"`|
 |get|Get data from Evernote|`evertils get notebook`|
 |convert|Convert your notes to Markdown, then back to ENML|(coming soon)|
+|status|View script information and other data|`evertils status`|

data/bin/evertils

@@ -19,10 +19,9 @@ require_relative "../lib/kernel.rb"
 require_relative "../lib/version.rb"
 require_relative "../lib/helpers/time.rb"
 require_relative "../lib/helpers/results.rb"
+require_relative "../lib/log.rb"
 require_relative "../lib/config.rb"
 require_relative "../lib/request.rb"
-require_relative "../lib/log.rb"
-require_relative "../lib/constants.rb"
 require_relative "../lib/utils.rb"
 require_relative "../lib/logs.rb"
 require_relative "../lib/command.rb"

data/lib/config.rb

@@ -1,4 +1,15 @@
 module Evertils
+  PACKAGE_NAME = "evertils"
+  INSTALLED_DIR = Gem::Specification.find_by_name(Evertils::PACKAGE_NAME).gem_dir
+  LOG_DIR = INSTALLED_DIR + "/logs"
+  DEFAULT_LOG = Evertils::Log.new # no args means default log
+  HELPER_DIR = INSTALLED_DIR + "/lib/helpers/"
+  CONTROLLER_DIR = INSTALLED_DIR + "/lib/controllers/"
+  MODEL_DIR = INSTALLED_DIR + "/lib/models/"
+  TEMPLATE_DIR = INSTALLED_DIR + "/lib/configs/templates/"
+  LOG_DIGEST_LENGTH = 20
+  DEBUG = false
+
   class Cfg
     def bootstrap!
       begin
@@ -10,5 +21,21 @@ module Evertils
         Notify.error("#{e.to_s}\n#{e.backtrace.join("\n")}")
       end
     end
+
+    def constant?(name)
+      name == name.upcase
+    end
+
+    def options
+      keys = Evertils.constants.select do |name|
+        constant? name
+      end
+
+      hash = {}
+      keys.each do |key|
+        hash[key] = Evertils.const_get(key)
+      end
+      hash
+    end
   end
 end

data/lib/controller.rb

@@ -7,6 +7,18 @@ module Evertils
       
       # Perform pre-run tasks
       def pre_exec
+        begin
+          # interface with the Evernote API so we can use it later
+          @model = Evertils::Helper.load('evernote')
+
+          # user = @model.user
+          # Notify.success("Welcome, #{user.name} (#{user.username})")
+        rescue ::Evernote::EDAM::Error::EDAMSystemException => e
+          Notify.error("Evernote.authenticate error\n#{e.message} (#{e.errorCode})")
+        rescue ::Evernote::EDAM::Error::EDAMUserException => e
+          Notify.error("Evernote.authenticate error\n#{e.parameter} (#{e.errorCode})")
+        end
+
         OptionParser.new do |opt|
           opt.banner = "#{Evertils::PACKAGE_NAME} controller command [...-flags]"
 
@@ -18,7 +30,7 @@ module Evertils
           opt.on("-V", "--version", "Show app version") do |v|
             # short output
             @version = Evertils::PACKAGE_VERSION
-          end      
+          end
         end.parse!
       end
 
@@ -75,44 +87,45 @@ module Evertils
       end
 
       private
-        # autoload and instantiate required libraries, models and helpers
-        def auto_load_required(modules = [])
-          loaded = {:controller => {}, :helper => {}, :model => {}}
-          
-          begin
-            modules.each do |mod|
-              if File.exists? "#{Evertils::INSTALLED_DIR}/lib/controllers/#{mod}.rb"
-                require "#{Evertils::INSTALLED_DIR}/lib/controllers/#{mod}.rb"
-                
-                loaded[:controller][mod] = Evertils::Controller.const_get(mod.capitalize).new
-              else
-                raise StandardError, "Controller not found: #{mod}"
-              end
-
-              if File.exists? "#{Evertils::INSTALLED_DIR}/lib/helpers/#{mod}.rb"
-                require "#{Evertils::INSTALLED_DIR}/lib/helpers/#{mod}.rb"
-                loaded[:helper][mod] = Evertils::Helper.const_get(mod.capitalize).new
-
-                # auto-instantiate new instance of helper for the new instance of the controller
-                loaded[:controller][mod].helper = loaded[:helper][mod]
-              end
-
-              if File.exists? "#{Evertils::INSTALLED_DIR}/lib/models/#{mod}.rb"
-                require "#{Evertils::INSTALLED_DIR}/lib/models/#{mod}.rb"
-                loaded[:model][mod] = Evertils::Model.const_get(mod.capitalize).new
-
-                # auto-instantiate new instance of model for the new instance of the controller
-                loaded[:controller][mod].model = loaded[:model][mod]
-              else
-                loaded[:controller][mod].model = Model::Base.new
-              end
+
+      # autoload and instantiate required libraries, models and helpers
+      def auto_load_required(modules = [])
+        loaded = {:controller => {}, :helper => {}, :model => {}}
+        
+        begin
+          modules.each do |mod|
+            if File.exists? "#{Evertils::INSTALLED_DIR}/lib/controllers/#{mod}.rb"
+              require "#{Evertils::INSTALLED_DIR}/lib/controllers/#{mod}.rb"
+              
+              loaded[:controller][mod] = Evertils::Controller.const_get(mod.capitalize).new
+            else
+              raise StandardError, "Controller not found: #{mod}"
+            end
+
+            if File.exists? "#{Evertils::INSTALLED_DIR}/lib/helpers/#{mod}.rb"
+              require "#{Evertils::INSTALLED_DIR}/lib/helpers/#{mod}.rb"
+              loaded[:helper][mod] = Evertils::Helper.const_get(mod.capitalize).new
+
+              # auto-instantiate new instance of helper for the new instance of the controller
+              loaded[:controller][mod].helper = loaded[:helper][mod]
             end
 
-            loaded
-          rescue StandardError => e
-            Notify.error(e.message)
+            if File.exists? "#{Evertils::INSTALLED_DIR}/lib/models/#{mod}.rb"
+              require "#{Evertils::INSTALLED_DIR}/lib/models/#{mod}.rb"
+              loaded[:model][mod] = Evertils::Model.const_get(mod.capitalize).new
+
+              # auto-instantiate new instance of model for the new instance of the controller
+              loaded[:controller][mod].model = loaded[:model][mod]
+            else
+              loaded[:controller][mod].model = Model::Base.new
+            end
           end
+
+          loaded
+        rescue StandardError => e
+          Notify.error(e.message)
         end
+      end
     end
   end
 end

data/lib/controllers/convert.rb

@@ -4,37 +4,22 @@ module Evertils
       attr_accessor :title, :file, :notebook
 
       def pre_exec
-        begin
-          # interface with the Evernote API so we can use it later
-          @model = Evertils::Helper.load('evernote')
-
-          # all methods require internet to make API calls
-          @methods_require_internet.push(:daily, :weekly, :monthly)
-
-          # command flag parser
-          OptionParser.new do |opt|
-            opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
-
-            opt.on("-m", "--to-markdown", "Convert to MD format") do |b|
-              @markdown = b
-            end
-
-            opt.on("-e", "--to-enml", "Convert to ENML") do |b|
-              @file = b
-            end
-
-            opt.on("-n", "--notebook=PBOOK", "Attach a file to your custom note") do |notebook|
-              @notebook = notebook.capitalize
-            end
-          end.parse!
-
-          # user = @model.user
-          # Notify.success("Welcome, #{user.name} (#{user.username})")
-        rescue ::Evernote::EDAM::Error::EDAMSystemException => e
-          Notify.error("Evernote.authenticate error\n#{e.message} (#{e.errorCode})")
-        rescue ::Evernote::EDAM::Error::EDAMUserException => e
-          Notify.error("Evernote.authenticate error\n#{e.parameter} (#{e.errorCode})")
-        end
+        # command flag parser
+        OptionParser.new do |opt|
+          opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
+
+          opt.on("-m", "--to-markdown", "Convert to MD format") do |b|
+            @markdown = b
+          end
+
+          opt.on("-e", "--to-enml", "Convert to ENML") do |b|
+            @file = b
+          end
+
+          opt.on("-n", "--notebook=PBOOK", "Attach a file to your custom note") do |notebook|
+            @notebook = notebook.capitalize
+          end
+        end.parse!
 
         super
       end

data/lib/controllers/generate.rb

@@ -4,20 +4,7 @@ module Evertils
       attr_accessor :force, :start
 
       def pre_exec
-        begin
-          # interface with the Evernote API so we can use it later
-          @model = Evertils::Helper.load('evernote')
-
-          # all methods require internet to make API calls
-          @methods_require_internet.push(:daily, :weekly, :monthly, :deployment)
-
-          # user = @model.user
-          # Notify.success("Welcome, #{user.name} (#{user.username})")
-        rescue ::Evernote::EDAM::Error::EDAMSystemException => e
-          Notify.error("Evernote.authenticate error\n#{e.message} (#{e.errorCode})")
-        rescue ::Evernote::EDAM::Error::EDAMUserException => e
-          Notify.error("Evernote.authenticate error\n#{e.parameter} (#{e.errorCode})")
-        end
+        @methods_require_internet.push(:daily, :weekly, :monthly, :deployment)
 
         OptionParser.new do |opt|
           opt.banner = "#{Evertils::PACKAGE_NAME} generate timeframe [...-flags]"

data/lib/controllers/get.rb

@@ -4,37 +4,22 @@ module Evertils
       attr_accessor :title, :file, :notebook
 
       def pre_exec
-        begin
-          # interface with the Evernote API so we can use it later
-          @model = Evertils::Helper.load('evernote')
+        # command flag parser
+        OptionParser.new do |opt|
+          opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
 
-          # all methods require internet to make API calls
-          @methods_require_internet.push(:daily, :weekly, :monthly)
-
-          # command flag parser
-          OptionParser.new do |opt|
-            opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
-
-            opt.on("-t", "--title=TITLE", "Set a custom title") do |title|
-              @title = title
-            end
-
-            opt.on("-f", "--file=PATH", "Attach a file to your custom note") do |file|
-              @file = file
-            end
+          opt.on("-t", "--title=TITLE", "Set a custom title") do |title|
+            @title = title
+          end
 
-            opt.on("-n", "--notebook=PBOOK", "Attach a file to your custom note") do |notebook|
-              @notebook = notebook
-            end
-          end.parse!
+          opt.on("-f", "--file=PATH", "Attach a file to your custom note") do |file|
+            @file = file
+          end
 
-          # user = @model.user
-          # Notify.success("Welcome, #{user.name} (#{user.username})")
-        rescue ::Evernote::EDAM::Error::EDAMSystemException => e
-          Notify.error("Evernote.authenticate error\n#{e.message} (#{e.errorCode})")
-        rescue ::Evernote::EDAM::Error::EDAMUserException => e
-          Notify.error("Evernote.authenticate error\n#{e.parameter} (#{e.errorCode})")
-        end
+          opt.on("-n", "--notebook=PBOOK", "Attach a file to your custom note") do |notebook|
+            @notebook = notebook
+          end
+        end.parse!
 
         super
       end

data/lib/controllers/new.rb

@@ -4,55 +4,43 @@ module Evertils
       attr_accessor :title, :file, :notebook
 
       def pre_exec
-        begin
-          # interface with the Evernote API so we can use it later
-          @model = Evertils::Helper.load('evernote')
+        # all methods require internet to make API calls
+        @methods_require_internet.push(:daily, :weekly, :monthly)
 
-          # all methods require internet to make API calls
-          @methods_require_internet.push(:daily, :weekly, :monthly)
-
-          @title = "Evertils - Custom Note"
-
-          # command flag parser
-          OptionParser.new do |opt|
-            opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
-
-            opt.on("-t", "--title=TITLE", "Set a custom title") do |title|
-              @title = title
-            end
-
-            opt.on("-f", "--file=PATH", "Attach a file to your custom note") do |file|
-              @file = file
-            end
-
-            opt.on("-n", "--notebook=PBOOK", "Choose the notebook to add your note to") do |notebook|
-              @notebook = notebook
-            end
-
-            opt.on("-b", "--body=BODY", "Note body") do |body|
-              @body = body
-            end
-
-            opt.on("-t", "--tags=list", "Assign tags to the new note") do |tags|
-              @tags = tags
-            end
-
-            opt.on("-c", "--created_on=DATE", "Set note created date") do |created_on|
-              # Evernote cuts the last 3 values off of your timestamp because
-              # it "accurate to milliseconds", so we have to add them back or
-              # else the date is all messed up
-              parsed = Date.parse(created_on)
-              @created_on = (parsed.to_time.to_i.to_s + "000").to_i
-            end
-          end.parse!
-
-          # user = @model.user
-          # Notify.success("Welcome, #{user.name} (#{user.username})")
-        rescue ::Evernote::EDAM::Error::EDAMSystemException => e
-          Notify.error("Evernote.authenticate error\n#{e.message} (#{e.errorCode})")
-        rescue ::Evernote::EDAM::Error::EDAMUserException => e
-          Notify.error("Evernote.authenticate error\n#{e.parameter} (#{e.errorCode})")
-        end
+        @title = "Evertils - Custom Note"
+        
+        # command flag parser
+        OptionParser.new do |opt|
+          opt.banner = "#{Evertils::PACKAGE_NAME} new note [...-flags]"
+
+          opt.on("-t", "--title=TITLE", "Set a custom title") do |title|
+            @title = title
+          end
+
+          opt.on("-f", "--file=PATH", "Attach a file to your custom note") do |file|
+            @file = file
+          end
+
+          opt.on("-n", "--notebook=PBOOK", "Choose the notebook to add your note to") do |notebook|
+            @notebook = notebook
+          end
+
+          opt.on("-b", "--body=BODY", "Note body") do |body|
+            @body = body
+          end
+
+          opt.on("-t", "--tags=list", "Assign tags to the new note") do |tags|
+            @tags = tags
+          end
+
+          opt.on("-c", "--created_on=DATE", "Set note created date") do |created_on|
+            # Evernote cuts the last 3 values off of your timestamp because
+            # it "accurate to milliseconds", so we have to add them back or
+            # else the date is all messed up
+            parsed = Date.parse(created_on)
+            @created_on = (parsed.to_time.to_i.to_s + "000").to_i
+          end
+        end.parse!
 
         super
       end

data/lib/controllers/status.rb

@@ -0,0 +1,13 @@
+module Evertils
+  module Controller
+    class Status < Controller::Base
+
+      def default
+        $config.options.each_pair do |key, value|
+          puts "#{key}: #{value}"
+        end
+      end
+
+    end
+  end
+end

data/lib/router.rb

@@ -1,23 +1,7 @@
 module Evertils
   class Router
     def route
-      # Populate request params
-      $request = Request.new
-
-      # include the controller
-      if File.exists? "#{Evertils::CONTROLLER_DIR}#{$request.controller}.rb"
-        require "#{Evertils::CONTROLLER_DIR}#{$request.controller}.rb"
-      end
-
-      # include helpers
-      if File.exists? "#{Evertils::HELPER_DIR}#{$request.controller}.rb"
-        require "#{Evertils::HELPER_DIR}#{$request.controller}.rb"
-      end
-
-      # include models
-      if File.exists? "#{Evertils::MODEL_DIR}#{$request.controller}.rb"
-        require "#{Evertils::MODEL_DIR}#{$request.controller}.rb"
-      end
+      pre_exec
 
       # Create object context and pass it the required command line arguments
       begin
@@ -59,7 +43,13 @@ module Evertils
             end
 
             # Run the controller
-            context.exec
+            # Call a default action for controllers which do not require a third
+            # argument, i.e. evertils status 
+            if context.respond_to? :default
+              context.default
+            else
+              context.exec
+            end
 
             # Run cleanup commands
             context.post_exec
@@ -71,5 +61,25 @@ module Evertils
         Notify.error("#{e.to_s}\n#{e.backtrace.join("\n")}")
       end
     end
+
+    def pre_exec
+      # Populate request params
+      $request = Request.new
+
+      # include the controller
+      if File.exists? "#{Evertils::CONTROLLER_DIR}#{$request.controller}.rb"
+        require "#{Evertils::CONTROLLER_DIR}#{$request.controller}.rb"
+      end
+
+      # include helpers
+      if File.exists? "#{Evertils::HELPER_DIR}#{$request.controller}.rb"
+        require "#{Evertils::HELPER_DIR}#{$request.controller}.rb"
+      end
+
+      # include models
+      if File.exists? "#{Evertils::MODEL_DIR}#{$request.controller}.rb"
+        require "#{Evertils::MODEL_DIR}#{$request.controller}.rb"
+      end
+    end
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Evertils
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evertils
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ryan Priebe
@@ -28,12 +28,12 @@ files:
 - lib/configs/templates/daily.enml
 - lib/configs/templates/monthly.enml
 - lib/configs/templates/weekly.enml
-- lib/constants.rb
 - lib/controller.rb
 - lib/controllers/convert.rb
 - lib/controllers/generate.rb
 - lib/controllers/get.rb
 - lib/controllers/new.rb
+- lib/controllers/status.rb
 - lib/helper.rb
 - lib/helpers/evernote-enml.rb
 - lib/helpers/evernote-markdown.rb

data/lib/constants.rb

@@ -1,12 +0,0 @@
-module Evertils
-  PACKAGE_NAME = "evertils"
-  INSTALLED_DIR = Gem::Specification.find_by_name(Evertils::PACKAGE_NAME).gem_dir
-  LOG_DIR = INSTALLED_DIR + "/logs"
-  DEFAULT_LOG = Log.new # no args means default log
-  HELPER_DIR = INSTALLED_DIR + "/lib/helpers/"
-  CONTROLLER_DIR = INSTALLED_DIR + "/lib/controllers/"
-  MODEL_DIR = INSTALLED_DIR + "/lib/models/"
-  TEMPLATE_DIR = INSTALLED_DIR + "/lib/configs/templates/"
-  LOG_DIGEST_LENGTH = 20
-  DEBUG = false
-end