onlinerbytodd 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68df277dd975a882ee28bb653d3652463aadd61b
+  data.tar.gz: e564d0d9df4310806efed938c71b3b1f1dc74be9
+SHA512:
+  metadata.gz: 9d931a3b2fae2e8468e58bb65e203f237f76d98f3b722eab4dd1c0fdadd719758639fd25b6d638b40f2b0f382e0bac41d536398b9587105633466b1923f41819
+  data.tar.gz: df39fca3d72eca232a9ce3376cc8c7c2ec7dfb338e42d92776836848f180a599ad57c219d612a9e4d3bea3eb9ee399fb246fb233206ff7a25079632e2357929a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in onliner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Todd Nestor
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# Onlinerbytodd
+
+* Built off of the onliner gem, but renamed so I could deploy it on rubygems,
+* this version plays nice with Heroku and RedisToGo, as of June 6, 2014.
+
+
+Gem for Rails application - provides you list of online users (for authentication gem 'devise')
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'onlinerbytodd'
+
+And then execute:
+
+    $ bundle
+
+Next you have to run this to make it install the initializer
+
+    $ rails g onlinerbytodd:install 
+
+## Usage
+
+For using functionality add to ApplicationControler:
+
+	before_filter { |c| current_user.track unless current_user.nil?}
+
+and In your model, add :onliner-by-todd to the current devise line at the end:
+
+	class User < ActiveRecord::Base
+		devise ..., :onlinerbytodd
+	end
+
+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)
+
+In this version I have modified the time to consider a user still online to 
+15 seconds, previously it was 300 seconds.  In a future version I will make
+this more easily customizable by users.
+
+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:
+
+	[] Allow users to customize the time for a user to be considered online
+		[] Make the onlinerbytodd.rb accept a variable for the time
+		[] Make that variable default to 15 seconds if not set
+		[] 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 onlinerbytodd 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; 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/onlinerbytodd/install_generator.rb

@@ -0,0 +1,12 @@
+require "rails"
+
+module Onlinerbytodd
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../templates', __FILE__)
+
+    def copy_files
+      create_file "config/initializers/onlinerbytodd.rb"
+      copy_file "onlinerbytodd.rb", "config/initializers/onlinerbytodd.rb"
+    end
+  end
+end

data/lib/generators/templates/onlinerbytodd.rb

@@ -0,0 +1,9 @@
+require "redis"
+
+if ( Rails.env.development? || Rails.env.test? )
+	uri = URI.parse("localhost:6379")
+else
+	uri = URI.parse(ENV["REDISTOGO_URL"])
+end
+
+REDIS = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)

data/lib/onlinerbytodd/model.rb

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

data/lib/onlinerbytodd/version.rb

@@ -0,0 +1,3 @@
+module Onlinerbytodd
+  VERSION = "1.0.0"
+end

data/lib/onlinerbytodd.rb

@@ -0,0 +1,13 @@
+require "onlinerbytodd/version"
+
+unless defined?(Devise)
+  require 'devise'
+end
+
+require 'onlinerbytodd'
+
+Devise.add_module :onlinerbytodd, :model => 'onlinerbytodd/model'
+
+module Onlinerbytodd
+end
+

data/onlinerbytodd.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onlinerbytodd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onlinerbytodd"
+  spec.platform    = Gem::Platform::RUBY
+  spec.version       = Onlinerbytodd::VERSION
+  spec.authors       = ["Todd Nestor"]
+  spec.email         = ["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'), built off of the onliner gem}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency('redis', '~> 3.0.6')
+  spec.add_dependency "redis-namespace", ">= 1.3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: onlinerbytodd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Todd Nestor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.6
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Gem for Rails application - provides you list of online users (for authentication
+  gem 'devise')
+email:
+- todd.nestor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/onlinerbytodd/install_generator.rb
+- lib/generators/templates/onlinerbytodd.rb
+- lib/onlinerbytodd.rb
+- lib/onlinerbytodd/model.rb
+- lib/onlinerbytodd/version.rb
+- onlinerbytodd.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for Rails application - provides you list of online users (for authentication
+  gem 'devise'), built off of the onliner gem
+test_files: []