uniq_logger 0.1.4 → 0.1.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    uniq_logger (0.1.3)
+    uniq_logger (0.1.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,9 @@
 # UniqLogger
 
-TODO: Write a gem description
+- Add entries to an logfile, only if an uniq id is not already used.
+- automaticaly generate logfile rotations: new logfile für every day, motnh or year
+- send your logentries to another server per api using the same gem once as client and as a server
+- creates an CSV formated file which can be easely opened in e.g. Excel for endusers
 
 ## Installation
 
@@ -20,7 +23,63 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a configuration file config/uniq_logger.yml (view section 'Configuration')
+
+To create a logentry use:
+
+```ruby
+require 'uniq_logger'
+uniq_logger = UniqLogger.new
+uniq_logger.create("UniqID", ["data","to","save"] )
+```
+
+## Configuration File
+
+app/config/uniq_logger.yml
+
+```yml
+#Use a additional Log-Rotator which generates new logfiles for ['day','month','year'].
+#Default 'none'
+log_rotator: "month"
+
+#If log_rotator is set, this will be the prefix for the file name 
+log_rotator_prefix: "uniq_logger-"
+
+
+#Use a global LogFile [true,false]. Chech for existin logs only looks in global logfile
+#Default true
+global_logger: true
+
+#Name of the logfile to write to
+global_log_file_name: "uniq_logger.log"
+
+
+#if set to true, logentry creation returns 'false' if a logentry already exists with this ID
+# This is only on global Logfiles possible
+validates_uniqness_of_id: true
+
+#If a local Logfile should be created or a ftp Account ['local', 'remote']
+logfile_destination: "local"
+
+#Path where Logfiles should be saved
+path_to_local_logfiles: "../log/"
+
+#If logfile_destination is set to 'remote' use folloing api credentials
+remote:
+  auth_token: "xyz123abc"
+  server: "http://www.server.de"
+  endpoint: "/api/v1/logger"
+  url_param_for_id: "id"
+  url_param_for_data: "data"
+  basic_auth:
+    username: ""
+    password: ""
+
+#CSV Export Settings: Encoding Type (default 'utf8'), Column Separator (default ';')
+csv:
+  encoding: "UTF8"
+  col_sep: ";"
+```
 
 ## Contributing
 

data/lib/uniq_logger/base.rb

@@ -14,7 +14,7 @@ module UniqLogger
       elsif config["logfile_destination"] == "remote"
         create_remote_log_entry(uniq_id, data_to_save)
       else
-        puts "logfile_destination is not set to [local,ftp]"
+        puts "logfile_destination is not set to [local,remote]"
         return false
       end
     end
@@ -27,7 +27,7 @@ module UniqLogger
         logfilename = File.join(config["path_to_local_logfiles"], config["global_log_file_name"])
         logfile = File.open( File.expand_path(logfilename), "a" )
         
-        if is_uniq_id_in_log_hostory?(uniq_id,logfile)
+        if is_uniq_id_in_log_history?(uniq_id,logfile)
           return false
         end
         
@@ -49,14 +49,10 @@ module UniqLogger
     end
 
 
-    def is_uniq_id_in_log_hostory?(uniq_id,logfile)
+    def is_uniq_id_in_log_history?(uniq_id,logfile)
       if config["validates_uniqness_of_id"] == true
-        data = CSV.read(logfile, {:col_sep => config["csv"]["col_sep"], :encoding => config["csv"]["encoding"] })
-        list_of_ids = data.map{ |a| a[0]}
-        #puts data
-        if list_of_ids.include?(uniq_id)
-          return true
-        end
+        regexp_uniq_id = /^#{uniq_id};/
+        return open(logfile).grep(regexp_uniq_id).any?
       end
       return false
     end

data/lib/uniq_logger/version.rb

@@ -1,3 +1,3 @@
 module UniqLogger
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/lib/uniq_logger_spec.rb

@@ -27,6 +27,8 @@ describe UniqLogger::Base do
   end
   
   it 'should write a log to a logfile with validation of ID true' do
+    expect(@logger.create("12343", ["Vorname", "12344", "Strasse"])).to eq(true)
+    expect(@logger.create("12344", ["Vorname", "12343", "Strasse"])).to eq(true)
     expect(@logger.create("12345", ["Vorname", "Nachname", "Strasse"])).to eq(true)
     expect(@logger.create("12346", ["Vorname2", "Nachname2", "Strasse2"])).to eq(true)
     expect(@logger.create("12346", ["Vorname3", "Nachname3", "Strasse3"])).to eq(false)

data/uniq_logger.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Marco Metz"]
   spec.email         = ["marco.metz@gmail.com"]
   spec.summary       = %q{checks for existing Logentries and adds new LogEntries}
-  spec.description   = %q{Adds Entries to an Logfile, only if not already exist. Logfile can be on an ftp account}
+  spec.description   = %q{Adds entries to a logfile, only if they don't already exist. The logfile can be on a remote server}
   spec.homepage      = "https://github.com/ikuseiGmbH/uniq_logger"
   spec.license       = "GNU GENERAL PUBLIC LICENSE"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uniq_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,8 +91,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Adds Entries to an Logfile, only if not already exist. Logfile can be
-  on an ftp account
+description: Adds entries to a logfile, only if they don't already exist. The logfile
+  can be on a remote server
 email:
 - marco.metz@gmail.com
 executables: []
@@ -116,6 +116,7 @@ files:
 - template/uniq_logger.yml
 - uniq_logger-0.1.1.gem
 - uniq_logger-0.1.2.gem
+- uniq_logger-0.1.4.gem
 - uniq_logger.gemspec
 homepage: https://github.com/ikuseiGmbH/uniq_logger
 licenses: