amico 1.2.0 → 2.0.0

data/.rvmrc

@@ -1 +1 @@
-rvm use --create ruby-1.9.3-p0@amico_gem
+rvm use --create ruby-1.9.3@amico_gem

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.0.0
+
+* Added `Amico.default_scope_key` and `scope` parameter to all of the methods to allow you to scope the calls to express relationships for different types of things
+
 # 1.2.0
 
 * Added pending to relationships

data/README.md

@@ -28,6 +28,7 @@ Amico.configure do |configuration|
   configuration.blocked_key = 'blocked'
   configuration.reciprocated_key = 'reciprocated'
   configuration.pending_key = 'pending'
+  configuration.default_scope_key = 'default'
   configuration.pending_follow = false
   configuration.page_size = 25
 end
@@ -47,6 +48,7 @@ Amico.configure do |configuration|
   configuration.blocked_key = 'blocked'
   configuration.reciprocated_key = 'reciprocated'
   configuration.pending_key = 'pending'
+  configuration.default_scope_key = 'default'
   configuration.pending_follow = false
   configuration.page_size = 25
 end
@@ -129,6 +131,7 @@ Amico.configure do |configuration|
   configuration.blocked_key = 'blocked'
   configuration.reciprocated_key = 'reciprocated'
   configuration.pending_key = 'pending'
+  configuration.default_scope_key = 'default'
   configuration.pending_follow = true
   configuration.page_size = 25
 end
@@ -191,11 +194,217 @@ Amico.reciprocated?(1, 11)
  => true 
 ```
 
+Use amico with nicknames instead of IDs. NOTE: This could cause you much hardship later on if you allow nicknames to change.
+
+```ruby
+require 'amico'
+ 
+Amico.configure do |configuration|
+  configuration.redis = Redis.new
+  configuration.namespace = 'amico'
+  configuration.following_key = 'following'
+  configuration.followers_key = 'followers'
+  configuration.blocked_key = 'blocked'
+  configuration.reciprocated_key = 'reciprocated'
+  configuration.pending_key = 'pending'
+  configuration.default_scope_key = 'default'
+  configuration.pending_follow = false
+  configuration.page_size = 25
+end
+
+Amico.follow('bob', 'jane')
+ 
+Amico.following?('bob', 'jane')
+ => true 
+
+Amico.following?('jane', 'bob')
+ => false 
+
+Amico.follow('jane', 'bob')
+
+Amico.following?('jane', 'bob')
+ => true 
+
+Amico.following_count('bob')
+ => 1 
+
+Amico.followers_count('bob')
+ => 1 
+
+Amico.unfollow('jane', 'bob')
+
+Amico.following_count('jane')
+ => 0
+
+Amico.following_count('bob')
+ => 1 
+
+Amico.follower?('bob', 'jane')
+ => false 
+
+Amico.follower?('jane', 'bob')
+ => true 
+
+Amico.following('bob')
+ => ["jane"] 
+
+Amico.block('bob', 'jane')
+
+Amico.following?('jane', 'bob')
+ => false 
+
+Amico.blocked?('bob', 'jane')
+ => true 
+
+Amico.blocked?('jane', 'bob')
+ => false 
+
+Amico.unblock('bob', 'jane')
+ => true 
+
+mico.blocked?('bob', 'jane')
+ => false 
+
+Amico.following?('jane', 'bob')
+ => false 
+
+Amico.follow('jane', 'bob')
+ => nil 
+
+Amico.follow('bob', 'jane')
+ => [1, 1] 
+
+Amico.reciprocated?('bob', 'jane')
+ => true 
+
+Amico.reciprocated('bob')
+ => ["jane"] 
+```
+
+Use amico with nicknames instead of IDs and pending follows. NOTE: This could cause you much hardship later on if you allow nicknames to change.
+
+```ruby
+require 'amico'
+ => true 
+
+Amico.configure do |configuration|
+  configuration.redis = Redis.new
+  configuration.namespace = 'amico'
+  configuration.following_key = 'following'
+  configuration.followers_key = 'followers'
+  configuration.blocked_key = 'blocked'
+  configuration.reciprocated_key = 'reciprocated'
+  configuration.pending_key = 'pending'
+  configuration.default_scope_key = 'default'
+  configuration.pending_follow = true
+  configuration.page_size = 25
+end
+
+Amico.follow('bob', 'jane')
+
+Amico.follow('jane', 'bob')
+
+Amico.pending?('bob', 'jane')
+ => true 
+
+Amico.pending?('jane', 'bob')
+ => true 
+
+Amico.accept('bob', 'jane')
+
+Amico.pending?('bob', 'jane')
+ => false 
+
+Amico.pending?('jane', 'bob')
+ => true 
+
+Amico.following?('bob', 'jane')
+ => true 
+
+Amico.following?('jane', 'bob')
+ => false 
+
+Amico.follower?('jane', 'bob')
+ => true 
+
+Amico.follower?('bob', 'jane')
+ => false 
+
+Amico.accept('jane', 'bob')
+
+Amico.pending?('bob', 'jane')
+ => false 
+
+Amico.pending?('jane', 'bob')
+ => false 
+
+Amico.following?('bob', 'jane')
+ => true 
+
+Amico.following?('jane', 'bob')
+ => true 
+
+Amico.follower?('jane', 'bob')
+ => true 
+
+Amico.follower?('bob', 'jane')
+ => true 
+
+Amico.reciprocated?('bob', 'jane')
+ => true 
+```
+
+All of the calls support a `scope` parameter to allow you to scope the calls to express relationships for different types of things. For example:
+
+```ruby
+require 'amico'
+
+Amico.configure do |configuration|
+  configuration.redis = Redis.new
+  configuration.namespace = 'amico'
+  configuration.following_key = 'following'
+  configuration.followers_key = 'followers'
+  configuration.blocked_key = 'blocked'
+  configuration.reciprocated_key = 'reciprocated'
+  configuration.pending_key = 'pending'
+  configuration.default_scope_key = 'user'
+  configuration.pending_follow = false
+  configuration.page_size = 25
+end
+
+Amico.follow(1, 11)
+
+Amico.following?(1, 11)
+ => true 
+
+Amico.following?(1, 11, 'user')
+ => true 
+
+Amico.following(1)
+ => ["11"] 
+
+Amico.following(1, Amico.default_options, 'user')
+ => ["11"] 
+
+Amico.following?(1, 11, 'project')
+ => false 
+
+Amico.follow(1, 11, 'project')
+
+Amico.following?(1, 11, 'project')
+ => true 
+
+Amico.following(1, Amico.default_options, 'project')
+ => ["11"]
+```
+
 ## Documentation 
 
 The source for the [relationships module](https://github.com/agoragames/amico/blob/master/lib/amico/relationships.rb) is well-documented. There are some 
 simple examples in the method documentation. You can also refer to the [online documentation](http://rubydoc.info/github/agoragames/amico/master/frames).
 
+## Future Plans
+
 ## FAQ?
 
 ### Why use Redis sorted sets and not Redis sets?

data/lib/amico/configuration.rb

@@ -25,6 +25,9 @@ module Amico
     # Key used to indicate whether or not a follow should be pending or not.
     attr_writer :pending_follow
 
+    # Default key used to indicate the scope for the current call
+    attr_writer :default_scope_key
+
     # Page size to be used when paging through the various types of relationships.
     attr_writer :page_size
 
@@ -40,6 +43,7 @@ module Amico
     #     configuration.blocked_key = 'blocked'
     #     configuration.reciprocated_key = 'reciprocated'
     #     configuration.pending_key = 'pending'
+    #     configuration.default_scope_key = 'default'
     #     configuration.pending_follow = false
     #     configuration.page_size = 25
     #   end
@@ -89,6 +93,13 @@ module Amico
       @pending_key ||= 'pending'
     end
 
+    # Default key used in Redis for tracking scope for the given relationship calls.
+    #
+    # @return the default key used in Redis for tracking scope for the given relationship calls.
+    def default_scope_key
+      @default_scope_key ||= 'default'
+    end
+
     # Key used to indicate whether or not a follow should be pending or not.
     #
     # @return the key used to indicate whether or not a follow should be pending or not.

data/lib/amico/relationships.rb

@@ -5,20 +5,21 @@ module Amico
     # relationship if so.
     # 
     # @param from_id [String] The ID of the individual establishing the follow relationship.
-    # @param to_id [String] The ID of the individual to be followed. 
+    # @param to_id [String] The ID of the individual to be followed.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
     #   Amico.follow(1, 11)
-    def follow(from_id, to_id)
+    def follow(from_id, to_id, scope = Amico.default_scope_key)
       return if from_id == to_id
-      return if blocked?(to_id, from_id)
-      return if Amico.pending_follow && pending?(from_id, to_id)
+      return if blocked?(to_id, from_id, scope)
+      return if Amico.pending_follow && pending?(from_id, to_id, scope)
 
       unless Amico.pending_follow
-        add_following_followers_reciprocated(from_id, to_id)
+        add_following_followers_reciprocated(from_id, to_id, scope)
       else
-        Amico.redis.zadd("#{Amico.namespace}:#{Amico.pending_key}:#{to_id}", Time.now.to_i, from_id)
+        Amico.redis.zadd("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{to_id}", Time.now.to_i, from_id)
       end
     end
 
@@ -28,20 +29,21 @@ module Amico
     #
     # @param from_id [String] The ID of the individual removing the follow relationship.
     # @param to_id [String] The ID of the individual to be unfollowed.
+    # @param scope [String] Scope for the call
     # 
     # Examples
     #
     #   Amico.follow(1, 11)
     #   Amico.unfollow(1, 11)
-    def unfollow(from_id, to_id)
+    def unfollow(from_id, to_id, scope = Amico.default_scope_key)
       return if from_id == to_id
 
       Amico.redis.multi do
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.following_key}:#{from_id}", to_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.followers_key}:#{to_id}", from_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{from_id}", to_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{to_id}", from_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.pending_key}:#{to_id}", from_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{from_id}", to_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{to_id}", from_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{from_id}", to_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{to_id}", from_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{to_id}", from_id)
       end
     end  
 
@@ -50,22 +52,23 @@ module Amico
     #
     # @param from_id [String] The ID of the individual blocking the relationship.
     # @param to_id [String] The ID of the individual being blocked.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
     #   Amico.block(1, 11)
-    def block(from_id, to_id)
+    def block(from_id, to_id, scope = Amico.default_scope_key)
       return if from_id == to_id
 
       Amico.redis.multi do
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.following_key}:#{from_id}", to_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.following_key}:#{to_id}", from_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.followers_key}:#{to_id}", from_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.followers_key}:#{from_id}", to_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{from_id}", to_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{to_id}", from_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.pending_key}:#{from_id}", to_id)
-        Amico.redis.zadd("#{Amico.namespace}:#{Amico.blocked_key}:#{from_id}", Time.now.to_i, to_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{from_id}", to_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{to_id}", from_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{to_id}", from_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{from_id}", to_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{from_id}", to_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{to_id}", from_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{from_id}", to_id)
+        Amico.redis.zadd("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{from_id}", Time.now.to_i, to_id)
       end
     end
 
@@ -73,21 +76,23 @@ module Amico
     #
     # @param from_id [String] The ID of the individual unblocking the relationship.
     # @param to_id [String] The ID of the blocked individual.
+    # @param scope [String] Scope for the call
     # 
     # Examples
     # 
     #   Amico.block(1, 11)
     #   Amico.unblock(1, 11)
-    def unblock(from_id, to_id)
+    def unblock(from_id, to_id, scope = Amico.default_scope_key)
       return if from_id == to_id
 
-      Amico.redis.zrem("#{Amico.namespace}:#{Amico.blocked_key}:#{from_id}", to_id)
+      Amico.redis.zrem("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{from_id}", to_id)
     end
 
     # Accept a relationship that is pending between two IDs.
     #
     # @param from_id [String] The ID of the individual accepting the relationship.
     # @param to_id [String] The ID of the individual to be accepted.
+    # @param scope [String] Scope for the call
     #
     # Example
     #
@@ -96,15 +101,16 @@ module Amico
     #   Amico.accept(1, 11)
     #   Amico.pending?(1, 11) # false
     #   Amico.following?(1, 11) #true
-    def accept(from_id, to_id)
+    def accept(from_id, to_id, scope = Amico.default_scope_key)
       return if from_id == to_id
 
-      add_following_followers_reciprocated(from_id, to_id)
+      add_following_followers_reciprocated(from_id, to_id, scope)
     end
 
     # Count the number of individuals that someone is following.
     #
     # @param id [String] ID of the individual to retrieve following count for.
+    # @param scope [String] Scope for the call
     # 
     # Examples
     # 
@@ -112,13 +118,14 @@ module Amico
     #   Amico.following_count(1)
     #
     # @return the count of the number of individuals that someone is following.
-    def following_count(id)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{id}")
+    def following_count(id, scope = Amico.default_scope_key)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{id}")
     end
 
     # Count the number of individuals that are following someone.
     #
     # @param id [String] ID of the individual to retrieve followers count for.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -126,13 +133,14 @@ module Amico
     #   Amico.followers_count(1)
     # 
     # @return the count of the number of individuals that are following someone.
-    def followers_count(id)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{id}")
+    def followers_count(id, scope = Amico.default_scope_key)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{id}")
     end
 
     # Count the number of individuals that someone has blocked.
     #
     # @param id [String] ID of the individual to retrieve blocked count for.
+    # @param scope [String] Scope for the call
     # 
     # Examples
     #
@@ -140,13 +148,14 @@ module Amico
     #   Amico.blocked_count(1)
     #
     # @return the count of the number of individuals that someone has blocked.
-    def blocked_count(id)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:#{id}")
+    def blocked_count(id, scope = Amico.default_scope_key)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{id}")
     end
 
     # Count the number of individuals that have reciprocated a following relationship.
     #
     # @param id [String] ID of the individual to retrieve reciprocated following count for.
+    # @param scope [String] Scope for the call
     # 
     # Examples
     # 
@@ -155,13 +164,14 @@ module Amico
     #   Amico.reciprocated_count(1)
     #
     # @return the count of the number of individuals that have reciprocated a following relationship.
-    def reciprocated_count(id)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{id}")
+    def reciprocated_count(id, scope = Amico.default_scope_key)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{id}")
     end
 
     # Count the number of relationships pending for an individual.
     #
     # @param id [String] ID of the individual to retrieve pending count for.
+    # @param scope [String] Scope for the call
     # 
     # Examples
     #
@@ -170,14 +180,15 @@ module Amico
     #   Amico.pending_count(1) # 2
     #
     # @return the count of the number of relationships pending for an individual.
-    def pending_count(id)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:#{id}")
+    def pending_count(id, scope = Amico.default_scope_key)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{id}")
     end
 
     # Check to see if one individual is following another individual.
     #
     # @param id [String] ID of the individual checking the following status.
     # @param following_id [String] ID of the individual to see if they are being followed by id.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -185,14 +196,15 @@ module Amico
     #   Amico.following?(1, 11)
     #
     # @return true if id is following following_id, false otherwise
-    def following?(id, following_id)
-      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.following_key}:#{id}", following_id).nil?
+    def following?(id, following_id, scope = Amico.default_scope_key)
+      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{id}", following_id).nil?
     end
 
     # Check to see if one individual is a follower of another individual.
     #
     # @param id [String] ID of the individual checking the follower status.
     # @param following_id [String] ID of the individual to see if they are following id.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -200,14 +212,15 @@ module Amico
     #   Amico.follower?(1, 11)
     #
     # @return true if follower_id is following id, false otherwise
-    def follower?(id, follower_id)
-      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.followers_key}:#{id}", follower_id).nil?
+    def follower?(id, follower_id, scope = Amico.default_scope_key)
+      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{id}", follower_id).nil?
     end
 
     # Check to see if one individual has blocked another individual.
     #
     # @param id [String] ID of the individual checking the blocked status.
     # @param blocked_id [String] ID of the individual to see if they are blocked by id.
+    # @param scope [String] Scope for the call
     #
     # Examples
     # 
@@ -215,14 +228,15 @@ module Amico
     #   Amico.blocked?(1, 11)
     #
     # @return true if id has blocked blocked_id, false otherwise
-    def blocked?(id, blocked_id)
-      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.blocked_key}:#{id}", blocked_id).nil?
+    def blocked?(id, blocked_id, scope = Amico.default_scope_key)
+      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{id}", blocked_id).nil?
     end
 
     # Check to see if one individual has reciprocated in following another individual.
     #
     # @param from_id [String] ID of the individual checking the reciprocated relationship.
     # @param to_id [String] ID of the individual to see if they are following from_id.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -231,14 +245,15 @@ module Amico
     #   Amico.reciprocated?(1, 11)
     #
     # @return true if both individuals are following each other, false otherwise
-    def reciprocated?(from_id, to_id)
-      following?(from_id, to_id) && following?(to_id, from_id)
+    def reciprocated?(from_id, to_id, scope = Amico.default_scope_key)
+      following?(from_id, to_id, scope) && following?(to_id, from_id, scope)
     end
 
     # Check to see if one individual has a pending relationship in following another individual.
     #
     # @param from_id [String] ID of the individual checking the pending relationships.
     # @param to_id [String] ID of the individual to see if they are pending a follow from from_id.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -246,14 +261,15 @@ module Amico
     #   Amico.pending?(1, 11) # true
     #
     # @return true if the relationship is pending, false otherwise
-    def pending?(from_id, to_id)
-      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.pending_key}:#{to_id}", from_id).nil?
+    def pending?(from_id, to_id, scope = Amico.default_scope_key)
+      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{to_id}", from_id).nil?
     end
 
     # Retrieve a page of followed individuals for a given ID.
     #
     # @param id [String] ID of the individual.
     # @param options [Hash] Options to be passed for retrieving a page of followed individuals.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -262,14 +278,15 @@ module Amico
     #   Amico.following(1, :page => 1)
     #
     # @return a page of followed individuals for a given ID.
-    def following(id, options = default_options)
-      members("#{Amico.namespace}:#{Amico.following_key}:#{id}", options)
+    def following(id, options = default_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{id}", options)
     end
 
     # Retrieve a page of followers for a given ID.
     #
     # @param id [String] ID of the individual.
     # @param options [Hash] Options to be passed for retrieving a page of followers.
+    # @param scope [String] Scope for the call
     #
     # Examples
     # 
@@ -278,14 +295,15 @@ module Amico
     #   Amico.followers(1, :page => 1)
     #
     # @return a page of followers for a given ID.
-    def followers(id, options = default_options)
-      members("#{Amico.namespace}:#{Amico.followers_key}:#{id}", options)
+    def followers(id, options = default_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{id}", options)
     end
 
     # Retrieve a page of blocked individuals for a given ID.
     #
     # @param id [String] ID of the individual.
     # @param options [Hash] Options to be passed for retrieving a page of blocked individuals.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -294,14 +312,15 @@ module Amico
     #   Amico.blocked(1, :page => 1)
     #
     # @return a page of blocked individuals for a given ID.
-    def blocked(id, options = default_options)
-      members("#{Amico.namespace}:#{Amico.blocked_key}:#{id}", options)
+    def blocked(id, options = default_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{id}", options)
     end
 
     # Retrieve a page of individuals that have reciprocated a follow for a given ID.
     #
     # @param id [String] ID of the individual.
     # @param options [Hash] Options to be passed for retrieving a page of individuals that have reciprocated a follow.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -312,14 +331,15 @@ module Amico
     #   Amico.reciprocated(1, :page => 1)
     #
     # @return a page of individuals that have reciprocated a follow for a given ID.
-    def reciprocated(id, options = default_options)
-      members("#{Amico.namespace}:#{Amico.reciprocated_key}:#{id}", options)
+    def reciprocated(id, options = default_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{id}", options)
     end
 
     # Retrieve a page of pending relationships for a given ID.
     #
     # @param id [String] ID of the individual.
     # @param options [Hash] Options to be passed for retrieving a page of pending relationships.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -328,14 +348,15 @@ module Amico
     #   Amico.pending(1, :page => 1)
     #
     # @return a page of pending relationships for a given ID.
-    def pending(id, options = default_options)
-      members("#{Amico.namespace}:#{Amico.pending_key}:#{id}", options)
+    def pending(id, options = default_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{id}", options)
     end
 
     # Count the number of pages of following relationships for an individual.
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size.
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -344,14 +365,15 @@ module Amico
     #   Amico.following_page_count(1)
     #
     # @return the number of pages of following relationships for an individual.
-    def following_page_count(id, page_size = Amico.page_size)
-      total_pages("#{Amico.namespace}:#{Amico.following_key}:#{id}", page_size)
+    def following_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+      total_pages("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{id}", page_size)
     end
 
     # Count the number of pages of follower relationships for an individual.
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -360,14 +382,15 @@ module Amico
     #   Amico.followers_page_count(1)
     #
     # @return the number of pages of follower relationships for an individual.
-    def followers_page_count(id, page_size = Amico.page_size)
-      total_pages("#{Amico.namespace}:#{Amico.followers_key}:#{id}", page_size)
+    def followers_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+      total_pages("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{id}", page_size)
     end
 
     # Count the number of pages of blocked relationships for an individual.
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -376,14 +399,15 @@ module Amico
     #   Amico.blocked_page_count(1)
     #    
     # @return the number of pages of blocked relationships for an individual.
-    def blocked_page_count(id, page_size = Amico.page_size)
-      total_pages("#{Amico.namespace}:#{Amico.blocked_key}:#{id}", page_size)
+    def blocked_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+      total_pages("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{id}", page_size)
     end
 
     # Count the number of pages of reciprocated relationships for an individual.
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -394,14 +418,15 @@ module Amico
     #   Amico.reciprocated_page_count(1)
     #    
     # @return the number of pages of reciprocated relationships for an individual.
-    def reciprocated_page_count(id, page_size = Amico.page_size)
-      total_pages("#{Amico.namespace}:#{Amico.reciprocated_key}:#{id}", page_size)
+    def reciprocated_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+      total_pages("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{id}", page_size)
     end
 
     # Count the number of pages of pending relationships for an individual.
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
+    # @param scope [String] Scope for the call
     #
     # Examples
     #
@@ -410,39 +435,39 @@ module Amico
     #   Amico.pending_page_count(1) # 1
     #    
     # @return the number of pages of pending relationships for an individual.
-    def pending_page_count(id, page_size = Amico.page_size)
-      total_pages("#{Amico.namespace}:#{Amico.pending_key}:#{id}", page_size)
-    end
+    def pending_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+      total_pages("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{id}", page_size)
+    end    
 
     private
 
+    # Default options for doing, for example, paging.
+    #
+    # @return a hash of the default options.
+    def default_options
+      {:page_size => Amico.page_size, :page => 1}
+    end
+
     # Add the following, followers and check for a reciprocated relationship. To be used from the 
     # +follow++ and ++accept++ methods.
     #
     # @param from_id [String] The ID of the individual establishing the follow relationship.
     # @param to_id [String] The ID of the individual to be followed. 
-    def add_following_followers_reciprocated(from_id, to_id)
+    def add_following_followers_reciprocated(from_id, to_id, scope)
       Amico.redis.multi do
-        Amico.redis.zadd("#{Amico.namespace}:#{Amico.following_key}:#{from_id}", Time.now.to_i, to_id)
-        Amico.redis.zadd("#{Amico.namespace}:#{Amico.followers_key}:#{to_id}", Time.now.to_i, from_id)
-        Amico.redis.zrem("#{Amico.namespace}:#{Amico.pending_key}:#{to_id}", from_id)
+        Amico.redis.zadd("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{from_id}", Time.now.to_i, to_id)
+        Amico.redis.zadd("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{to_id}", Time.now.to_i, from_id)
+        Amico.redis.zrem("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{to_id}", from_id)
       end
 
       if reciprocated?(from_id, to_id)
         Amico.redis.multi do
-          Amico.redis.zadd("#{Amico.namespace}:#{Amico.reciprocated_key}:#{from_id}", Time.now.to_i, to_id)
-          Amico.redis.zadd("#{Amico.namespace}:#{Amico.reciprocated_key}:#{to_id}", Time.now.to_i, from_id)
+          Amico.redis.zadd("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{from_id}", Time.now.to_i, to_id)
+          Amico.redis.zadd("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{to_id}", Time.now.to_i, from_id)
         end
       end      
     end
 
-    # Default options for doing, for example, paging.
-    #
-    # @return a hash of the default options.
-    def default_options
-      {:page_size => Amico.page_size, :page => 1}
-    end
-
     # Count the total number of pages for a given key in a Redis sorted set.
     #
     # @param key [String] Redis key.

data/lib/amico/version.rb

@@ -1,3 +1,3 @@
 module Amico
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/spec/amico/configuration_spec.rb

@@ -10,6 +10,7 @@ describe Amico::Configuration do
         configuration.blocked_key.should eql('blocked')
         configuration.reciprocated_key.should eql('reciprocated')
         configuration.pending_key.should eql('pending')
+        configuration.default_scope_key.should eql('default')
         configuration.pending_follow.should be_false
         configuration.page_size.should be(25)
       end

data/spec/amico/relationships_spec.rb

@@ -5,23 +5,23 @@ describe Amico::Relationships do
     it 'should allow you to follow' do
       Amico.follow(1, 11)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:1").should be(1)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:11").should be(1)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:1").should be(1)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{Amico.default_scope_key}:11").should be(1)
     end
 
     it 'should not allow you to follow yourself' do
       Amico.follow(1, 1)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:1").should be(0)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:1").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:1").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{Amico.default_scope_key}:1").should be(0)
     end
 
     it 'should add each individual to the reciprocated set if you both follow each other' do
       Amico.follow(1, 11)
       Amico.follow(11, 1)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:1").should be(1)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:11").should be(1)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{Amico.default_scope_key}:1").should be(1)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{Amico.default_scope_key}:11").should be(1)
     end
   end
 
@@ -29,15 +29,15 @@ describe Amico::Relationships do
     it 'should allow you to unfollow' do
       Amico.follow(1, 11)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:1").should be(1)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:11").should be(1)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:1").should be(1)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{Amico.default_scope_key}:11").should be(1)
 
       Amico.unfollow(1, 11)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:1").should be(0)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:11").should be(0)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:1").should be(0)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:11").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:1").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{Amico.default_scope_key}:11").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{Amico.default_scope_key}:1").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{Amico.default_scope_key}:11").should be(0)
     end
   end
 
@@ -46,29 +46,29 @@ describe Amico::Relationships do
       Amico.follow(11, 1)
       Amico.block(1, 11)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:11").should be(0) 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:1").should be(1) 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:1").should be(0)
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:11").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:11").should be(0) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:#{Amico.default_scope_key}:1").should be(1) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{Amico.default_scope_key}:1").should be(0)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.reciprocated_key}:#{Amico.default_scope_key}:11").should be(0)
     end
 
     it 'should allow you to block someone who is not following you' do
       Amico.block(1, 11)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:11").should be(0) 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:1").should be(1) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:11").should be(0) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:#{Amico.default_scope_key}:1").should be(1) 
     end
 
     it 'should not allow someone you have blocked to follow you' do
       Amico.block(1, 11)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:11").should be(0) 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:1").should be(1) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:11").should be(0) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:#{Amico.default_scope_key}:1").should be(1) 
 
       Amico.follow(11, 1)
 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:11").should be(0) 
-      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:1").should be(1) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:11").should be(0) 
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.blocked_key}:#{Amico.default_scope_key}:1").should be(1) 
     end
 
     it 'should not allow you to block yourself' do
@@ -282,23 +282,23 @@ describe Amico::Relationships do
       it 'should allow you to follow but the relationship is initially pending' do
         Amico.follow(1, 11)
 
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:1").should be(0)
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:11").should be(0)
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:11").should be(1)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:1").should be(0)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{Amico.default_scope_key}:11").should be(0)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:#{Amico.default_scope_key}:11").should be(1)
       end
 
       it 'should remove the pending relationship if you have a pending follow, but you unfollow' do
         Amico.follow(1, 11)
 
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:1").should be(0)
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:11").should be(0)
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:11").should be(1)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:1").should be(0)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{Amico.default_scope_key}:11").should be(0)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:#{Amico.default_scope_key}:11").should be(1)
 
         Amico.unfollow(1, 11)
 
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:1").should be(0)
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:11").should be(0)
-        Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:11").should be(0)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{Amico.default_scope_key}:1").should be(0)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{Amico.default_scope_key}:11").should be(0)
+        Amico.redis.zcard("#{Amico.namespace}:#{Amico.pending_key}:#{Amico.default_scope_key}:11").should be(0)
       end
 
       it 'should remove the pending relationship and add to following and followers if #accept is called' do
@@ -390,6 +390,21 @@ describe Amico::Relationships do
     end
   end
 
+  describe 'scope' do
+    it 'should allow you to scope a call to follow a different thing' do
+      Amico.default_scope_key = 'user'
+      Amico.follow(1, 11, 'user')
+      Amico.following?(1, 11).should be_true
+      Amico.following?(1, 11, 'user').should be_true
+      Amico.following(1).should eql(["11"])
+      Amico.following(1, {:page_size => Amico.page_size, :page => 1}, 'user').should eql(["11"])
+      Amico.following?(1, 11, 'project').should be_false
+      Amico.follow(1, 11, 'project')
+      Amico.following?(1, 11, 'project').should be_true
+      Amico.following(1, {:page_size => Amico.page_size, :page => 1}, 'project').should eql(["11"])
+    end
+  end
+
   private
 
   def add_reciprocal_followers(count = 26, block_relationship = false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amico
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2157986940 !ruby/object:Gem::Requirement
+  requirement: &2153496040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157986940
+  version_requirements: *2153496040
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157986520 !ruby/object:Gem::Requirement
+  requirement: &2153495620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157986520
+  version_requirements: *2153495620
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157986100 !ruby/object:Gem::Requirement
+  requirement: &2153495200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157986100
+  version_requirements: *2153495200
 description: Relationships (e.g. friendships) backed by Redis
 email:
 - dczarnecki@agoragames.com
@@ -81,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4319511261827775332
+      hash: 1543039261316922594
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4319511261827775332
+      hash: 1543039261316922594
 requirements: []
 rubyforge_project: amico
 rubygems_version: 1.8.10