quickbase_logger 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd97401e3954fe004aadd70e4ae411cda9ffb399
-  data.tar.gz: ebb5998fb7323b845fefdc1eb7f125638387bd3e
+  metadata.gz: efa3a3cc1ebde57d54f764d842ce953b61c3029b
+  data.tar.gz: fd3a0fea2568617f71c3e29cf62c431ea8ccbc0c
 SHA512:
-  metadata.gz: bd8bb9c8688a4fb53de27d8064148fad907a009cba46943ed15f8dd1962f7eb46e80e603a654368afcac4453b2572b8dbe63f741d31f3fda2bf4bb3bc6b1f835
-  data.tar.gz: a2cce192236c0121548fd3efd6933582f8812941b39f899f3d340b5d63b13114641bd3a3213a701aaadf684e884a66e5d72fc91f05884314ce5fbf9b61d9ebb0
+  metadata.gz: 6a336837b323bb72c668fd99d5e8e31f809dccfee29763468c9017f3a393c23b8808b7330f1dbbdd5775ad881a4c18fab5b90481446297e282051a36ab392ec3
+  data.tar.gz: 70a958cd4efabf05b31eaedf1cd7cd93e13399a4a80f2ab77baf2c310df14f050208134b94a9df48f05e2b6b32ce7701a8fcff3c414159e161677777ea256f3a

data/.gitignore

@@ -14,4 +14,5 @@
 *.a
 mkmf.log
 *.DS_Store
-*.gem
+*.gem
+*.log

data/README.md

@@ -70,12 +70,23 @@ QuickbaseLogger is built on top of the wonderful [QuickbaseRecord](https://githu
 ### Methods and API
 Using QuickbaseLogger is as simple as instantiating an instance of QuickbaseLogger::Logger and wrapping any code you want logged to your Script Logs QuickBase table in the #log_to_quickbase method on that instance.
 
+##### Text Logger File Name
 QuickbaseLogger::Logger.new accepts a :related_script argument that is the [Record ID#] of the parent Script record, and an optional :file_name argument for the name of the text log file. If no :file_name argument is given it will default to "quickbase_logger_default"
 
 ```ruby
   qb_logger = QuickbaseLogger::Logger.new(related_script: 123, file_name: 'my_awesome_log_file')
 ```
 
+##### Purge Old Logs
+By default, the Script Log records in QuickBase that are related to the current QuickbaseLogger::Logger instance will be deleted after 180 days. To override this functionality you can add a :purge_frequency argument to the .new method. This should be an integer value representing the number of days after which to delete records (based on the [Date Created] field in QuickBase).
+
+```ruby
+  # "purge_frequency: 7" means that Script Log records created before 7 days ago will be deleted at the end of the #log_to_quickbase method execution
+  qb_logger = QuickbaseLogger::Logger.new(related_script: 123, file_name: 'my_awesome_log_file', purge_frequency: 7)
+```
+
+
+##### #log_to_quickbase
 The instance returned from QuickbaseLogger::Logger.new has a method named #log_to_quickbase that accepts a block of code you want to capture in you logs. While inside the scope of the #log_to_quickbase method, you have access to #info(message), #warn(message), and #error(message) methods on the logger instance that simply log the given message to the :log field on the Script Logs table in QuickBase as well as the text logger. Each of these methods will capture the time of the log automatically.
 
 ```ruby
@@ -109,7 +120,7 @@ class SomeAwesomeScript
 end
 ```
 
-Here's how the #log_to_quickbase method is structured (for your reference):
+Here's how the source code for the #log_to_quickbase method is structured (for your reference):
 
 ```ruby
   def log_to_quickbase

data/lib/quickbase_logger/logger.rb

@@ -2,18 +2,21 @@ module QuickbaseLogger
   class Logger
     include QuickbaseRecord::Model
 
-    attr_accessor :text_logger
+    attr_accessor :text_logger, :purge_frequency
 
     def initialize(options={})
       raise ArgumentError.new("QuickbaseLogger::Logger.new must receive a :related_script argument.") unless options[:related_script]
 
       @log = []
       @start = "#{formatted_date} #{formatted_time}"
+      @purge_frequency = options.fetch(:purge_frequency, 180)
 
       file_name = options.fetch(:file_name, 'quickbase_logger_default')
       @text_logger = ::Logger.new("#{formatted_logger_path}#{file_name}.log", "monthly") # standard ruby Logger instance
+      @text_logger.info("===== #{Date.today.strftime('%m/%d/%Y')} =====")
       @text_logger.info("START")
-      super
+
+      super(options)
     end
 
     def log_to_quickbase
@@ -28,6 +31,8 @@ module QuickbaseLogger
         log_failure_to_quickbase(err)
         raise err
       end
+
+      purge_logs
     end
 
     def info(message)
@@ -42,17 +47,32 @@ module QuickbaseLogger
       log << "Error [#{formatted_time}]: #{message}"
     end
 
+    def purge_logs
+      purge_date = Date.today - purge_frequency.days
+      purge_date = purge_date.strftime("%m/%d/%Y")
+      related_script_fid = self.class.fields[:related_script].fid
+
+      begin
+        qb_client.purge_records(self.class.dbid, {query: "{#{related_script_fid}.EX.#{related_script}}AND{1.OBF.#{purge_date}}"})
+      rescue StandardError => e
+        text_logger.error("--- FAILED TO PURGE OLD RECORDS ---")
+        text_logger.error(err)
+        text_logger.error("BACKTRACE:\n\t#{err.backtrace.slice(0, 10).join("\n\t")}")
+        raise err
+      end
+    end
+
     private
 
     def log_success_to_text_file
-      joined_logs = self.log.join("\n")
-      text_logger.info("LOGS:\n#{joined_logs}")
+      joined_logs = self.log.join("\n\t")
+      text_logger.info("LOGS:\n\t#{joined_logs}")
       text_logger.info("END")
     end
 
     def log_failure_to_text_file(err)
-      joined_logs = self.log.join("\n")
-      text_logger.info("LOGS:\n#{joined_logs}")
+      joined_logs = self.log.join("\n\t")
+      text_logger.info("LOGS:\n\t#{joined_logs}")
 
       text_logger.error("ERROR: #{err}")
       text_logger.error("BACKTRACE:\n\t#{err.backtrace.slice(0, 10).join("\n\t")}")
@@ -67,7 +87,7 @@ module QuickbaseLogger
       begin
         save
       rescue StandardError => err
-        text_logger.error("-- COULD NOT WRITE SUCCESS TO QUICKBASE --")
+        text_logger.error("--- COULD NOT WRITE SUCCESS TO QUICKBASE ---")
         text_logger.error(err)
         text_logger.error("BACKTRACE:\n\t#{err.backtrace.slice(0, 10).join("\n\t")}")
         raise err
@@ -85,7 +105,7 @@ module QuickbaseLogger
       begin
         save
       rescue StandardError => err
-        text_logger.error("-- COULD NOT WRITE FAILURE TO QUICKBASE --")
+        text_logger.error("--- COULD NOT WRITE FAILURE TO QUICKBASE ---")
         text_logger.error(err)
         text_logger.error("BACKTRACE:\n\t#{err.backtrace.slice(0, 10).join("\n\t")}")
         raise err

data/lib/quickbase_logger/version.rb

@@ -1,3 +1,3 @@
 module QuickbaseLogger
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/quickbase_logger_spec.rb

@@ -19,9 +19,16 @@ end
 
 RSpec.describe QuickbaseLogger::Logger do
   describe '.initialize' do
+    before do
+      @logger = QuickbaseLogger::Logger.new(related_script: 123)
+    end
+
     it "defines a parent script that all log records will be related to" do
-      logger = QuickbaseLogger::Logger.new(related_script: 123)
-      expect(logger.related_script).to eq(123)
+      expect(@logger.related_script).to eq(123)
+    end
+
+    it "sets a default purge_frequency of 180 days" do
+      expect(@logger.purge_frequency).to eq(180)
     end
   end
 
@@ -32,9 +39,19 @@ RSpec.describe QuickbaseLogger::Logger do
       expect(qb_logger).to receive(:save)
 
       qb_logger.log_to_quickbase do
-        qb_logger.info('Hello, world!')
-        qb_logger.warn('Danger ahead...')
-        qb_logger.error('OH NO!!!')
+        qb_logger.info('testing that #save is called')
+      end
+    end
+
+    it "deletes records older than the purge frequency" do
+      qb_logger = QuickbaseLogger::Logger.new(related_script: 1, purge_frequency: 0)
+      purge_date = Date.today.strftime("%m/%d/%Y")
+
+      # the query "{10.EX.1}AND{1.OBF.#{purge_date}}" uses the FID for related_script and date_created, respectively
+      expect_any_instance_of(AdvantageQuickbase::API).to receive(:purge_records).with('bkd86zn87', {query: "{10.EX.1}AND{1.OBF.#{purge_date}}"})
+
+      qb_logger.log_to_quickbase do
+        qb_logger.info('testing that #purge_records is called')
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbase_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Cullen Jett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,6 @@ files:
 - lib/quickbase_logger/logger.rb
 - lib/quickbase_logger/version.rb
 - quickbase_logger.gemspec
-- spec/log/quickbase_logger_default.log
 - spec/quickbase_logger_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cullenjett/quickbase_logger
@@ -115,6 +114,5 @@ signing_key:
 specification_version: 4
 summary: Use Quickbase tables as a logging platform
 test_files:
-- spec/log/quickbase_logger_default.log
 - spec/quickbase_logger_spec.rb
 - spec/spec_helper.rb