user_stamp 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 778222999ec6c78d8a08b51f23524cab1bd169cb
+  data.tar.gz: 53a6b9114afb779991d02bb17a214d2c5f427fe6
+SHA512:
+  metadata.gz: fe1892f8678cc327238def83455311654ae78a022d77e8724c2029c0f4c2ae879be209cfca6ea5e7ba7ae08977f267c57b6c00af6ccf190ea22ca370fe5f3f82
+  data.tar.gz: a9ad277a20c3cf4da3f77bbdc7112d125245cd56473a79ce1d9699d5089510679ee7d45d5ee75258fdec1c9cec043adc3289e5087046d449b7c29d456f407013

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 PD Technology Solutions, LLC 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,65 @@
+= UserStamp
+Provides the functionality to automatically update records in the database with the logged in users identity.  Alleviates the need to update the identify of the user for every save, update or destroy.
+
+This gem has been build using ruby v2.1.2 and rails 3.2.x
+
+
+== Requirements
+Users must be logged into the system so there is a current_user object.  Authentication engines such as Devise provides this object.  
+By default the identify field is called login_name.  The login_name field is a string in the User model/table.
+
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'user_stamp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install user_stamp
+
+
+== Setup
+  1.   After including the gem in you project, run:
+         rails generate user_stamp install
+       This copies the config file to /config/initilizers/user_stamp.rb
+
+  2.   In the ApplicationController file add the line:
+	     before_filter :set_user_stamp
+
+  3.  In each /app/model/{file}, include UserStamp
+
+  4.  Add the user identity fields to each table.  If you do not need to store one of the fields, simply do not add it to the model.
+      The identity fields must be named: created_user, updated_user and destroy_user.
+      If you are storing the login_name or email, make these fields of type string.
+      If you are storing the id value, then make these field of type integer in the database.
+
+That's it.  Enjoy.
+ 
+
+== Deficencies
+  In future versions the three identity fields should be made configurable.
+  The tree identify field (created_user, updated_user and destory_user) needs to be manually added to each table.  A rails generate script might be included in future versions to automatically create the migration to add the fields.
+  Also a short cut marco needs to be added to ease the adding of the identify fields.   
+
+== License
+
+This library is free software and utilizes the MIT License.  Please refer to the MIT-LICENSE file for details.
+
+
+== Acknowledgments
+
+PD Technology Solutions provides this gem AS-IS with no warrenty.  
+All copyrights, 2015, reserved.  You may fork this code for your own purposes, however credit to PD Technology Solutions must be included.
+
+
+== Change Log
+
+4/19/15 v0.0.2 - First working version completed.
+
+4/17/15 V0.0.1 - Initial Commit

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UserStamp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/config/routes.rb

@@ -0,0 +1,28 @@
+#     This file is part of the UserStamp library that provides tools to
+#     track who created, updated, or destroyed a record in the database.
+#
+#     https://github.com/mjpete3/user_stamp
+#     
+#     Copyright (C) 2015 PD Technology Solutions, LLC
+#
+#     Permission is hereby granted, free of charge, to any person obtaining
+#     a copy of this software and associated documentation files (the
+#     "Software"), to deal in the Software without restriction, including
+#     without limitation the rights to use, copy, modify, merge, publish,
+#     distribute, sublicense, and/or sell copies of the Software, and to
+#     permit persons to whom the Software is furnished to do so, subject to
+#     the following conditions:
+#
+#     The above copyright notice and this permission notice shall be
+#     included in all copies or substantial portions of the Software.
+#
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Rails.application.routes.draw do
+end

data/lib/generators/user_stamp/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Copies the default user_stamp initilizer file in config/initializer 
+
+Example:
+    rails generate user_stamp install 
+
+    This will create:
+        config/initializer/user_stamp.rb
+        

data/lib/generators/user_stamp/templates/user_stamp.template

@@ -0,0 +1,26 @@
+
+#
+# Initilization file for UserStamp gem
+#
+UserStamp.configure do |config|
+  
+  # ===== Config.current_user =====
+  # Set the name of the user object created when checking authentication
+  # By default uses the current_user object that devise creates
+  # need to make sure that the user_field is defined within the user object
+  
+  # Default
+  # config.current_user = :current_user
+  
+  
+  # ===== Config.user_field ====== 
+  # The field within the user object / user database that is stored for each record in the database
+  # To change the behavior to store the user.id field use the following config: 
+  # config.user_field = :id
+  # To store the user's email use the following config:
+  # config.user_field = :email
+  
+  # Default 
+  # config.user_field = :login_name
+  
+end

data/lib/generators/user_stamp/user_stamp_generator.rb

@@ -0,0 +1,34 @@
+#     This file is part of the UserStamp library that provides tools to
+#     track who created, updated, or destroyed a record in the database.
+#
+#     https://github.com/mjpete3/user_stamp
+#     
+#     Copyright (C) 2015 PD Technology Solutions, LLC
+#
+#     Permission is hereby granted, free of charge, to any person obtaining
+#     a copy of this software and associated documentation files (the
+#     "Software"), to deal in the Software without restriction, including
+#     without limitation the rights to use, copy, modify, merge, publish,
+#     distribute, sublicense, and/or sell copies of the Software, and to
+#     permit persons to whom the Software is furnished to do so, subject to
+#     the following conditions:
+#
+#     The above copyright notice and this permission notice shall be
+#     included in all copies or substantial portions of the Software.
+#
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class UserStampGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  
+  # copies the user_stamp template to the initializer directory
+  def copy_initializer_file
+    copy_file "user_stamp.template", "config/initializers/user_stamp.rb"
+  end
+end

data/lib/tasks/user_stamp_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :user_stamp do
+#   # Task goes here
+# end

data/lib/user_stamp.rb

@@ -0,0 +1,36 @@
+#     This file is part of the UserStamp library that provides tools to
+#     track who created, updated, or destroyed a record in the database.
+#
+#     https://github.com/mjpete3/user_stamp
+#     
+#     Copyright (C) 2015 PD Technology Solutions, LLC
+#
+#     Permission is hereby granted, free of charge, to any person obtaining
+#     a copy of this software and associated documentation files (the
+#     "Software"), to deal in the Software without restriction, including
+#     without limitation the rights to use, copy, modify, merge, publish,
+#     distribute, sublicense, and/or sell copies of the Software, and to
+#     permit persons to whom the Software is furnished to do so, subject to
+#     the following conditions:
+#
+#     The above copyright notice and this permission notice shall be
+#     included in all copies or substantial portions of the Software.
+#
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'devise'
+
+require "user_stamp/engine"
+require "user_stamp/config"
+require "user_stamp/user_stamp"
+require "user_stamp/app_controller"
+require "user_stamp/user"
+
+module UserStamp
+end

data/lib/user_stamp/app_controller.rb

@@ -0,0 +1,40 @@
+#     This file is part of the UserStamp library that provides tools to
+#     track who created, updated, or destroyed a record in the database.
+#
+#     https://github.com/mjpete3/user_stamp
+#     
+#     Copyright (C) 2015 PD Technology Solutions, LLC
+#
+#     Permission is hereby granted, free of charge, to any person obtaining
+#     a copy of this software and associated documentation files (the
+#     "Software"), to deal in the Software without restriction, including
+#     without limitation the rights to use, copy, modify, merge, publish,
+#     distribute, sublicense, and/or sell copies of the Software, and to
+#     permit persons to whom the Software is furnished to do so, subject to
+#     the following conditions:
+#
+#     The above copyright notice and this permission notice shall be
+#     included in all copies or substantial portions of the Software.
+#
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+module UserStamp
+  module AppController
+    
+    #
+    # Called by the main application using a :before_filter
+    #
+    def set_user_stamp
+      # use the current_user configuration as an object within the main app
+      User.current = self.send(UserStamp.configuration.current_user)
+    end
+
+  end
+end

data/lib/user_stamp/config.rb

@@ -0,0 +1,60 @@
+#     This file is part of the UserStamp library that provides tools to
+#     track who created, updated, or destroyed a record in the database.
+#
+#     https://github.com/mjpete3/user_stamp
+#     
+#     Copyright (C) 2015 PD Technology Solutions, LLC
+#
+#     Permission is hereby granted, free of charge, to any person obtaining
+#     a copy of this software and associated documentation files (the
+#     "Software"), to deal in the Software without restriction, including
+#     without limitation the rights to use, copy, modify, merge, publish,
+#     distribute, sublicense, and/or sell copies of the Software, and to
+#     permit persons to whom the Software is furnished to do so, subject to
+#     the following conditions:
+#
+#     The above copyright notice and this permission notice shall be
+#     included in all copies or substantial portions of the Software.
+#
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'active_support/configurable'
+
+module UserStamp
+  #
+  # Configures global settings for UserStamp
+  # UserStamp.configure do |config|
+  #   config.user_field = [:login_name]
+  # end 
+  
+  
+  def self.configuration
+    @config ||= Configuration.new
+  end
+  
+  
+  # Global settings for UserStamp
+  def self.configure
+    yield configuration
+  end
+
+
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :current_user
+    config_accessor :user_field
+    
+    # set the defaults
+    def initialize
+      self.current_user = :current_user
+      self.user_field   = :login_name
+    end  
+  end
+
+end

data/lib/user_stamp/engine.rb

@@ -0,0 +1,37 @@
+#     This file is part of the UserStamp library that provides tools to
+#     track who created, updated, or destroyed a record in the database.
+#
+#     https://github.com/mjpete3/user_stamp
+#     
+#     Copyright (C) 2015 PD Technology Solutions, LLC
+#
+#     Permission is hereby granted, free of charge, to any person obtaining
+#     a copy of this software and associated documentation files (the
+#     "Software"), to deal in the Software without restriction, including
+#     without limitation the rights to use, copy, modify, merge, publish,
+#     distribute, sublicense, and/or sell copies of the Software, and to
+#     permit persons to whom the Software is furnished to do so, subject to
+#     the following conditions:
+#
+#     The above copyright notice and this permission notice shall be
+#     included in all copies or substantial portions of the Software.
+#
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module UserStamp
+  class Engine < ::Rails::Engine      
+
+    # initialize the ActionController so the methods in AppController are 
+    # available in the main application_controller   
+    initializer "userstamp.load_helpers" do |app|
+      ActionController::Base.send :include, UserStamp::AppController
+    end  
+
+  end
+end

data/lib/user_stamp/user.rb

@@ -0,0 +1,41 @@
+#     This file is part of the UserStamp library that provides tools to
+#     track who created, updated, or destroyed a record in the database.
+#
+#     https://github.com/mjpete3/user_stamp
+#     
+#     Copyright (C) 2015 PD Technology Solutions, LLC
+#
+#     Permission is hereby granted, free of charge, to any person obtaining
+#     a copy of this software and associated documentation files (the
+#     "Software"), to deal in the Software without restriction, including
+#     without limitation the rights to use, copy, modify, merge, publish,
+#     distribute, sublicense, and/or sell copies of the Software, and to
+#     permit persons to whom the Software is furnished to do so, subject to
+#     the following conditions:
+#
+#     The above copyright notice and this permission notice shall be
+#     included in all copies or substantial portions of the Software.
+#
+#     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#     LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#     OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module UserStamp
+
+  class User < ActiveRecord::Base
+    # attr_accessible :title, :body
+    
+    def self.current=(user)
+      Thread.current[:current_user] = user
+    end
+    
+    def self.current
+      Thread.current[:current_user]
+    end
+    
+  end
+end