onlineable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 253399538f87316c4e2b12b95a5346f173344670
+  data.tar.gz: 751e768073cec33fea1db6ae0c29cf7bed1bc72a
+SHA512:
+  metadata.gz: e4f03fbf79702831d8710299faf51c463ed32c87a463640c8b352ca34440ed97fbe0d2ee4c35bb1fd7ffbfd06bcac36967b1768d0962d6b76e1273b8909c51bf
+  data.tar.gz: ba977af685988f597fc610f623f2aadb9c5ae75c9d28050a6b4292ae40394ff46368a08299ba7b8b939d88ad37fa4b8e439b7403dc27e773c64f11c44a0077be

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,65 @@
+# onlineable
+Gem for Rails application - provides you list of online users (for authentication gem 'devise') for ActiveRecord ou Mongoid.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'onlineable'
+
+And then execute:
+
+    $ bundle install
+
+Next you have to run this to make it install the initializer
+
+    $ rails g onlineable:install
+
+*Note: if you are doing this on a Heroku server run the following command:
+
+	$ heroku run rails g onlineable: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
+
+For using functionality add to ApplicationControler:
+
+	  before_action { |c| current_usuario.track_online unless current_usuario.nil?}
+
+This will make the app consider the online user while they interact with the application.
+
+and In your template, add: onlineable-by-todd for the current device line at the end, and if you want to change the time (in seconds or minutes) that a user is considered online add below: time seconds: n or time minutes: n, the default is seconds: 30.
+
+	class User < ActiveRecord::Base
+		devise ..., :onlineable
+		time seconds:30 #or
+		time minutes:2
+	end
+
+Helper for online users list (for the whole list, not just an individual):
+
+	Model.who_online, e.g. User.who_online, Admin.who_online
+
+To see if a user is online you would run something like this:
+
+	User.who_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.who_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.
+
+## 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/onlineable/install_generator.rb

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

data/lib/generators/templates/onlineable.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/onlineable.rb

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

data/lib/onlineable/model.rb

@@ -0,0 +1,54 @@
+module Devise
+  module Models
+    module Onlineable
+      extend ActiveSupport::Concern
+      module ClassMethods
+        attr_reader :time_opts
+
+        def who_online(time_def=nil)
+          opts = get_time_opts
+          if time_def
+            time = time_def
+          else
+            time = opts[:seconds].present? ? opts[:seconds].to_i : opts[:minutes].to_i
+          end
+
+          if defined?(REDIS)
+            array_ids = []
+            online_array = REDIS.hgetall "o_#{self.to_s.downcase.pluralize}"
+
+            online_array.each do |k, v|
+              seconds_diff = (Time.now - v.to_time).to_i.abs
+              if (opts[:seconds].present? && (seconds_diff <= time)) || (opts[:minutes].present? && ((seconds_diff / 60) <= time)) || (Time.now - v.to_time <= time)
+                array_ids << k
+              end
+            end
+            self.find( array_ids )
+          end
+        end
+
+        def get_time_opts
+          if self.time_opts.blank?
+            opts = {seconds: 30}
+          elsif self.time_opts.present?
+            opts = self.time_opts
+          end
+          opts || {}
+        end
+
+        private
+
+        def time(opts={})
+          @time_opts = opts
+        end
+      end
+
+      def track_online
+        if defined?(REDIS)
+          REDIS.mapped_hmset "o_#{self.class.to_s.downcase.pluralize}", { id.to_s => "#{Time.now}" }
+        end
+      end
+
+    end
+  end
+end

data/lib/onlineable/version.rb

@@ -0,0 +1,3 @@
+module Onlineable
+  VERSION = "1.0.1"
+end

data/onlineable.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onlineable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "onlineable"
+  spec.platform    = Gem::Platform::RUBY
+  spec.version       = Onlineable::VERSION
+  spec.authors       = ["guilhermeap", "Jeová Guilherme de Carvalho Filho"]
+  spec.email         = ["jguilhermeap@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 onlineable 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,114 @@
+--- !ruby/object:Gem::Specification
+name: onlineable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- guilhermeap
+- Jeová Guilherme de Carvalho Filho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-17 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:
+- jguilhermeap@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/onlineable/install_generator.rb
+- lib/generators/templates/onlineable.rb
+- lib/onlineable.rb
+- lib/onlineable/model.rb
+- lib/onlineable/version.rb
+- onlineable.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.4.5
+signing_key: 
+specification_version: 4
+summary: Gem for Rails application - provides you list of online users (for authentication
+  gem 'devise'), built off of the onlineable gem
+test_files: []