followable 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    followable (0.0.1)
+      redis (~> 3.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    redis (3.0.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  followable!
+  rspec (~> 2.11.0)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fajar Budiprasetyo
+
+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,33 @@
+followable
+==========
+
+Followable adds following feature to any ActiveRecord object using Redis.  
+Inspired by http://jimneath.org/2011/03/24/using-redis-with-ruby-on-rails.html.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'followable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install followable
+
+## Usage
+
+class User < ActiveRecord::Base
+  include Followable
+end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/followable.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/followable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Fajar Budiprasetyo"]
+  gem.email         = ["fajar.ab@gmail.com"]
+  gem.description   = %q{ adds following feature to any ActiveRecord object using Redis }
+  gem.summary       = %q{ Followable adds following feature to any ActiveRecord object using Redis }
+  gem.homepage      = "https://github.com/fajarb/followable"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "followable"
+  gem.require_paths = ["lib"]
+  gem.version       = Followable::VERSION
+
+  gem.add_runtime_dependency('redis', '~> 3.0.1')
+
+  gem.add_development_dependency('rspec', '~> 2.11.0')
+end

data/lib/followable.rb

@@ -0,0 +1,65 @@
+require "followable/version"
+require "redis"
+
+module Followable
+  extend ActiveSupport::Concern
+  
+  # follow an object
+  def follow!(object)
+    $redis.multi do
+      $redis.sadd(self.redis_key(:following, object), object.id)
+      $redis.sadd(object.redis_key(:followers, object), self.id)
+    end
+  end
+  
+  # unfollow an object
+  def unfollow!(object)
+    $redis.multi do
+      $redis.srem(self.redis_key(:following, object), user.id)
+      $redis.srem(user.redis_key(:followers, object), self.id)
+    end
+  end
+  
+  # objects that self follows
+  def followers
+    object_ids = $redis.smembers(self.redis_key(:followers, self))
+    self.class.where(:id => object_ids)
+  end
+
+  # objects that follow self
+  def following
+    object_ids = $redis.smembers(self.redis_key(:following, self))
+    self.class.where(:id => object_ids)
+  end
+
+  # objects who follow and are being followed by self
+  # def friends
+  #   user_ids = $redis.sinter(self.redis_key(:following), self.redis_key(:followers))
+  #   User.where(:id => user_ids)
+  # end
+
+  # does the object follow self
+  def followed_by?(object)
+    $redis.sismember(self.redis_key(:followers, object), object.id)
+  end
+  
+  # does self follow user
+  def following?(object)
+    $redis.sismember(self.redis_key(:following, object), object.id)
+  end
+
+  # number of followers
+  def followers_count
+    $redis.scard(self.redis_key(:followers, self))
+  end
+
+  # number of users being followed
+  def following_count
+    $redis.scard(self.redis_key(:following, self))
+  end
+  
+  # helper method to generate redis keys
+  def redis_key(str, object)
+    "user:#{self.id}:#{str}:#{object.class.name.downcase}"
+  end
+end

data/lib/followable/version.rb

@@ -0,0 +1,3 @@
+module Followable
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: followable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fajar Budiprasetyo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: ! ' adds following feature to any ActiveRecord object using Redis '
+email:
+- fajar.ab@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- followable.gemspec
+- lib/followable.rb
+- lib/followable/version.rb
+homepage: https://github.com/fajarb/followable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Followable adds following feature to any ActiveRecord object using Redis
+test_files: []