onliner 0.0.4 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 815e5bc8ff9054e693bfc0f452f419dce638055f
-  data.tar.gz: d8448f15ce046d696a502078a401dda2ba8955a8
+  metadata.gz: c719b6058b329be36c1bafccd4b81726f75f6cc8
+  data.tar.gz: e0117d25f0d5d2221944307df968ce1056c56137
 SHA512:
-  metadata.gz: 9431a99ececb41636ec4596f5d44dbd9abbbc30a80967b16917b05b8661bc8b53a7712797c025a6727a8cd95769d9a7e77274ad489cfa9d33e0a88f62e8b01ed
-  data.tar.gz: 9a5726cc5886146746986963a562a8b28cd75282d285ff5720dd990adbb37a71f110578b116c31f62433b152a1ea321f5a9d2e17d9dc8c3550c4b2fb866f3899
+  metadata.gz: 4fb7dcdf1c498e82586ee5a15d52ee399b78bbcb5264668fadb4d492b3247d9eb151f66aeac9a66dfab6c8c3ec8efc4a9b5891baf5c5a49c04d66a607dc694be
+  data.tar.gz: f2cb05db60dd8d2c0b2e4058eeee16c497884080ed698ea0421f5f87d67b4b2e0ca9dc88f83c312790a078ca81edc104789d2d22aa2a2cab1278fb9fd21c689b

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 kbokhonko
+Copyright (c) 2014 Todd Nestor
 
 MIT License
 

data/README.md

@@ -1,6 +1,4 @@
-# Onliner
-
-
+# onliner
 Gem for Rails application - provides you list of online users (for authentication gem 'devise')
 
 ## Installation
@@ -13,9 +11,16 @@ And then execute:
 
     $ bundle
 
-For installing gem to your app run:
+Next you have to run this to make it install the initializer
+
+    $ rails g onliner:install
 
-    $ rails g onliner:install 
+*Note: if you are doing this on a Heroku server run the following command:
+
+	$ heroku run rails g onliner:install
+
+Do not do a run:detached as it prompts you and you will have to manually
+terminate the process if you run:detached.
 
 ## Usage
 
@@ -23,18 +28,48 @@ For using functionality add to ApplicationControler:
 
 	before_filter { |c| current_user.track unless current_user.nil?}
 
-and In your model, add :lastseenable as such:
+and In your model, add :onliner-by-todd to the current devise line at the end:
 
 	class User < ActiveRecord::Base
-		devise ..., :lastseenable
+		devise ..., :onliner
 	end
 
-Helper for online users list:
+Helper for online users list (for the whole list, not just an individual):
 
 	Model.online, e.g. User.online, Admin.online
 
+To see if a user is online you would run something like this:
+
+	User.online.include?(user)
+
+Now you can override the default time to check for user activity.  It defaults
+to 15 seconds (i.e. if the user hasn't done anything for 15 seconds they are
+not considered online).  To override this with say 30 seconds you would do the
+following:
+
+	User.online(30).include?(user)
+
+I have also modified the code to work more easily with RedisToGo on Heroku.
+It now works with RedisToGo on Heroku, it needed the password to be parsed,
+now it is.
+
+Tasks for future versions:
+
+- [x] Allow users to customize the time for a user to be considered online
+	- [x] Make the onliner.rb accept a variable for the time
+	- [x] Make that variable default to 15 seconds if not set
+	- [x] Provide instructions for how a user can override the default
+- [ ] Have software ignore Redis errors so if this gem doesn't work it doesn't break the app
+	- [ ] Add an exception for if REDIS isn't set or is unreachable
+	- [ ] Have onliner notify the user (either a flash message or an e-mail)
+	- [ ] make that notification message alterable (and the destination alterable)
+		
+		* This is mainly because if you hit your limit for your current RedisToGo plan or other applicable plan it would currently break the whole app
+		* If we have this gem send the user an e-mail or something, or set a flash message, then the user can know what is going on and can fix it
+
 ## Requirement
 
-  * Redis;
+  * Redis; this gem will make sure the dependencies get installed but you have 
+  	to make sure you have it on your server, for Heroku I recommend RedisToGo.
   
   * Devise;

data/lib/generators/templates/onliner.rb

@@ -6,4 +6,4 @@ else
 	uri = URI.parse(ENV["REDISTOGO_URL"])
 end
 
-REDIS = Redis.new(:host => uri.host, :port => uri.port)
+REDIS = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)

data/lib/onliner/model.rb

@@ -4,23 +4,27 @@ module Devise
       extend ActiveSupport::Concern
 
       module ClassMethods
-        def online 
-          array_ids = []    
-          online_array = REDIS.hgetall "o_#{self.to_s.downcase.pluralize}"
+        def online(time=15)
+          if defined?(REDIS)
+            array_ids = []
+            online_array = REDIS.hgetall "o_#{self.to_s.downcase.pluralize}"
 
-          online_array.each do |k, v|
-            if (Time.now - v.to_time <= 300)
-              array_ids << k.to_i 
-            end 
-          end
+            online_array.each do |k, v|
+              if (Time.now - v.to_time <= time)
+                array_ids << k.to_i
+              end
+            end
 
-          self.find( array_ids )
+            self.find( array_ids )
+          end
         end
-      end      
+      end
 
       def track
-        REDIS.mapped_hmset "o_#{self.class.to_s.downcase.pluralize}", { id.to_s => "#{Time.now}" }
+        if defined?(REDIS)
+          REDIS.mapped_hmset "o_#{self.class.to_s.downcase.pluralize}", { id.to_s => "#{Time.now}" }
+        end
       end
     end
   end
-end
+end

data/lib/onliner/version.rb

@@ -1,3 +1,3 @@
 module Onliner
-  VERSION = "0.0.4"
+  VERSION = "1.1.1"
 end

data/onliner.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "onliner"
   spec.platform    = Gem::Platform::RUBY
   spec.version       = Onliner::VERSION
-  spec.authors       = ["kbokhonko"]
-  spec.email         = ["kolya.bokhonko@gmail.com"]
+  spec.authors       = ["kbokhonko", "Todd Nestor"]
+  spec.email         = ["kolya.bokhonko@gmail.com", "todd.nestor@gmail.com"]
   spec.description   = "Gem for Rails application - provides you list of online users (for authentication gem 'devise')"
-  spec.summary       = %q{Gem for Rails application - provides you list of online users (for authentication gem 'devise')}
+  spec.summary       = %q{Gem for Rails application - provides you list of online users (for authentication gem 'devise'), built off of the onliner gem}
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -23,4 +23,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency('redis', '~> 3.0.6')
   spec.add_dependency "redis-namespace", ">= 1.3.0"
-end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: onliner
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.1.1
 platform: ruby
 authors:
 - kbokhonko
+- Todd Nestor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +71,7 @@ description: Gem for Rails application - provides you list of online users (for
   gem 'devise')
 email:
 - kolya.bokhonko@gmail.com
+- todd.nestor@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -109,5 +111,5 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Gem for Rails application - provides you list of online users (for authentication
-  gem 'devise')
+  gem 'devise'), built off of the onliner gem
 test_files: []