amico 2.0.1 → 2.1.0

data/CHANGELOG.md

@@ -1,21 +1,27 @@
-# 2.0.1
+# CHANGELOG
+
+## 2.1.0 (2012-08-20)
+
+* Added `count(id, type, scope = Amico.default_scope_key)` and `page_count(id, type, page_size = Amico.page_size, scope = Amico.default_scope_key)` as convenience methods for retrieving the count or the page count for the various types of relationships.
+
+## 2.0.1 (2012-03-14)
 
 * Added `Amico.all(id, type, scope)` to retrieve all of the individuals for a given id, type (e.g. following) and scope. Thanks to @mettadore for the initial code and inspiration.
 * Clarified parameters in following, followers, blocked, reciprocated, and pending calls.
 
-# 2.0.0
+## 2.0.0 (2012-02-28)
 
 * 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
+## 1.2.0 (2012-02-22)
 
 * Added pending to relationships
 
-# 1.1.0
+## 1.1.0 (2012-01-13)
 
 * Added blocking to relationships
 * Added reciprocated to relationships
 
-# 1.0.0 (2012-01-11)
+## 1.0.0 (2012-01-11)
 
 * Initial release

data/README.md

@@ -12,9 +12,9 @@ or in your `Gemfile`
 gem 'amico'
 ```
 
-Make sure your redis server is running! Redis configuration is outside the scope of this README, but 
+Make sure your redis server is running! Redis configuration is outside the scope of this README, but
 check out the Redis documentation, http://redis.io/documentation.
-  
+
 ## Usage
 
 Configure amico:
@@ -38,7 +38,7 @@ Use amico:
 
 ```ruby
 require 'amico'
- => true 
+ => true
 
 Amico.configure do |configuration|
   configuration.redis = Redis.new
@@ -54,34 +54,34 @@ Amico.configure do |configuration|
 end
 
 Amico.follow(1, 11)
-=> [1, 1] 
+=> [1, 1]
 
 Amico.following?(1, 11)
- => true 
+ => true
 
 Amico.following?(11, 1)
- => false 
+ => false
 
 Amico.follow(11, 1)
- => [1, 1] 
+ => [1, 1]
 
 Amico.following?(11, 1)
- => true 
+ => true
 
 Amico.following_count(1)
- => 1 
+ => 1
 
 Amico.followers_count(1)
- => 1 
+ => 1
 
 Amico.unfollow(11, 1)
- => [1, 1] 
+ => [1, 1]
 
 Amico.following_count(11)
- => 0 
+ => 0
 
 Amico.following_count(1)
- => 1 
+ => 1
 
 Amico.follower?(1, 11)
  => false
@@ -90,13 +90,13 @@ Amico.following(1)
  => ["11"]
 
 Amico.block(1, 11)
- => [1, 1, 1, 1, 1] 
+ => [1, 1, 1, 1, 1]
 
 Amico.following?(11, 1)
- => false 
+ => false
 
 Amico.blocked?(1, 11)
- => true 
+ => true
 
 Amico.unblock(1, 11)
  => true
@@ -121,7 +121,7 @@ Use amico (with pending relationships for follow):
 
 ```ruby
 require 'amico'
- => true 
+ => true
 
 Amico.configure do |configuration|
   configuration.redis = Redis.new
@@ -137,68 +137,68 @@ Amico.configure do |configuration|
 end
 
 Amico.follow(1, 11)
- => true 
+ => true
 
 Amico.follow(11, 1)
- => true 
+ => true
 
 Amico.pending?(1, 11)
- => true 
+ => true
 
 Amico.pending?(11, 1)
- => true 
+ => true
 
 Amico.accept(1, 11)
- => nil 
+ => nil
 
 Amico.pending?(1, 11)
- => false 
+ => false
 
 Amico.pending?(11, 1)
- => true 
+ => true
 
 Amico.following?(1, 11)
- => true 
+ => true
 
 Amico.following?(11, 1)
- => false 
+ => false
 
 Amico.follower?(11, 1)
- => true 
+ => true
 
 Amico.follower?(1, 11)
- => false 
+ => false
 
 Amico.accept(11, 1)
- => [1, 1] 
+ => [1, 1]
 
 Amico.pending?(1, 11)
- => false 
+ => false
 
 Amico.pending?(11, 1)
- => false 
+ => false
 
 Amico.following?(1, 11)
- => true 
+ => true
 
 Amico.following?(11, 1)
- => true 
+ => true
 
 Amico.follower?(11, 1)
- => true 
+ => true
 
 Amico.follower?(1, 11)
- => true 
- 
+ => true
+
 Amico.reciprocated?(1, 11)
- => true 
+ => 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'
@@ -213,23 +213,23 @@ Amico.configure do |configuration|
 end
 
 Amico.follow('bob', 'jane')
- 
+
 Amico.following?('bob', 'jane')
- => true 
+ => true
 
 Amico.following?('jane', 'bob')
- => false 
+ => false
 
 Amico.follow('jane', 'bob')
 
 Amico.following?('jane', 'bob')
- => true 
+ => true
 
 Amico.following_count('bob')
- => 1 
+ => 1
 
 Amico.followers_count('bob')
- => 1 
+ => 1
 
 Amico.unfollow('jane', 'bob')
 
@@ -237,55 +237,55 @@ Amico.following_count('jane')
  => 0
 
 Amico.following_count('bob')
- => 1 
+ => 1
 
 Amico.follower?('bob', 'jane')
- => false 
+ => false
 
 Amico.follower?('jane', 'bob')
- => true 
+ => true
 
 Amico.following('bob')
- => ["jane"] 
+ => ["jane"]
 
 Amico.block('bob', 'jane')
 
 Amico.following?('jane', 'bob')
- => false 
+ => false
 
 Amico.blocked?('bob', 'jane')
- => true 
+ => true
 
 Amico.blocked?('jane', 'bob')
- => false 
+ => false
 
 Amico.unblock('bob', 'jane')
- => true 
+ => true
 
-mico.blocked?('bob', 'jane')
- => false 
+Amico.blocked?('bob', 'jane')
+ => false
 
 Amico.following?('jane', 'bob')
- => false 
+ => false
 
 Amico.follow('jane', 'bob')
- => nil 
+ => nil
 
 Amico.follow('bob', 'jane')
- => [1, 1] 
+ => [1, 1]
 
 Amico.reciprocated?('bob', 'jane')
- => true 
+ => true
 
 Amico.reciprocated('bob')
- => ["jane"] 
+ => ["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 
+ => true
 
 Amico.configure do |configuration|
   configuration.redis = Redis.new
@@ -305,53 +305,53 @@ Amico.follow('bob', 'jane')
 Amico.follow('jane', 'bob')
 
 Amico.pending?('bob', 'jane')
- => true 
+ => true
 
 Amico.pending?('jane', 'bob')
- => true 
+ => true
 
 Amico.accept('bob', 'jane')
 
 Amico.pending?('bob', 'jane')
- => false 
+ => false
 
 Amico.pending?('jane', 'bob')
- => true 
+ => true
 
 Amico.following?('bob', 'jane')
- => true 
+ => true
 
 Amico.following?('jane', 'bob')
- => false 
+ => false
 
 Amico.follower?('jane', 'bob')
- => true 
+ => true
 
 Amico.follower?('bob', 'jane')
- => false 
+ => false
 
 Amico.accept('jane', 'bob')
 
 Amico.pending?('bob', 'jane')
- => false 
+ => false
 
 Amico.pending?('jane', 'bob')
- => false 
+ => false
 
 Amico.following?('bob', 'jane')
- => true 
+ => true
 
 Amico.following?('jane', 'bob')
- => true 
+ => true
 
 Amico.follower?('jane', 'bob')
- => true 
+ => true
 
 Amico.follower?('bob', 'jane')
- => true 
+ => true
 
 Amico.reciprocated?('bob', 'jane')
- => true 
+ => 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:
@@ -375,24 +375,24 @@ end
 Amico.follow(1, 11)
 
 Amico.following?(1, 11)
- => true 
+ => true
 
 Amico.following?(1, 11, 'user')
- => true 
+ => true
 
 Amico.following(1)
- => ["11"] 
+ => ["11"]
 
 Amico.following(1, {:page_size => Amico.page_size, :page => 1}, 'user')
- => ["11"] 
+ => ["11"]
 
 Amico.following?(1, 11, 'project')
- => false 
+ => false
 
 Amico.follow(1, 11, 'project')
 
 Amico.following?(1, 11, 'project')
- => true 
+ => true
 
 Amico.following(1, {:page_size => Amico.page_size, :page => 1}, 'project')
  => ["11"]
@@ -402,37 +402,105 @@ You can retrieve all of a particular type of relationship using the `all(id, typ
 
 ```ruby
 Amico.follow(1, 11)
- => nil 
+ => nil
 Amico.follow(1, 12)
- => nil 
+ => nil
 Amico.all(1, :following)
- => ["12", "11"] 
+ => ["12", "11"]
 ```
 
-`type` can be one of :following, :followers, :blocked, :reciprocated, :pending. Use this with caution 
-as there may potentially be a large number of items that could be returned from this call. 
+`type` can be one of :following, :followers, :blocked, :reciprocated, :pending. Use this with caution
+as there may potentially be a large number of items that could be returned from this call.
 
-## Documentation 
+## Method Summary
 
-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).
+```ruby
+# Relations
+
+# Establish a follow relationship between two IDs.
+follow(from_id, to_id, scope = Amico.default_scope_key)
+# Remove a follow relationship between two IDs.
+unfollow(from_id, to_id, scope = Amico.default_scope_key)
+# Block a relationship between two IDs.
+block(from_id, to_id, scope = Amico.default_scope_key)
+# Unblock a relationship between two IDs.
+unblock(from_id, to_id, scope = Amico.default_scope_key)
+# Accept a relationship that is pending between two IDs.
+accept(from_id, to_id, scope = Amico.default_scope_key)
+
+# Retrieval
+
+# Retrieve a page of followed individuals for a given ID.
+following(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+# Retrieve a page of followers for a given ID.
+followers(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+# Retrieve a page of blocked individuals for a given ID.
+blocked(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+# Retrieve a page of individuals that have reciprocated a follow for a given ID.
+reciprocated(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+# Retrieve a page of pending relationships for a given ID.
+pending(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+
+# Retrieve all of the individuals for a given id, type (e.g. following) and scope.
+all(id, type, scope = Amico.default_scope_key)
+
+# Counts
+
+# Count the number of individuals that someone is following.
+following_count(id, scope = Amico.default_scope_key)
+# Count the number of individuals that are following someone.
+followers_count(id, scope = Amico.default_scope_key)
+# Count the number of individuals that someone has blocked.
+blocked_count(id, scope = Amico.default_scope_key)
+# Count the number of individuals that have reciprocated a following relationship.
+reciprocated_count(id, scope = Amico.default_scope_key)
+# Count the number of relationships pending for an individual.
+pending_count(id, scope = Amico.default_scope_key)
+
+# Count the number of pages of following relationships for an individual.
+following_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+# Count the number of pages of follower relationships for an individual.
+followers_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+# Count the number of pages of blocked relationships for an individual.
+blocked_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+# Count the number of pages of reciprocated relationships for an individual.
+reciprocated_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+# Count the number of pages of pending relationships for an individual.
+pending_page_count(id, page_size = Amico.page_size, scope = Amico.default_scope_key)
+
+# Checks
+
+# Check to see if one individual is following another individual.
+following?(id, following_id, scope = Amico.default_scope_key)
+# Check to see if one individual is a follower of another individual.
+follower?(id, follower_id, scope = Amico.default_scope_key)
+# Check to see if one individual has blocked another individual.
+blocked?(id, blocked_id, scope = Amico.default_scope_key)
+# Check to see if one individual has reciprocated in following another individual.
+reciprocated?(from_id, to_id, scope = Amico.default_scope_key)
+# Check to see if one individual has a pending relationship in following another individual.
+pending?(from_id, to_id, scope = Amico.default_scope_key)
+```
 
-## Future Plans
+## 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).
 
 ## FAQ?
 
 ### Why use Redis sorted sets and not Redis sets?
 
-Based on the work I did in developing [leaderboard](https://github.com/agoragames/leaderboard), 
-leaderboards backed by Redis, I know I wanted to be able to page through the various relationships. 
-This does not seem to be possible given the current set of commands for Redis sets. 
+Based on the work I did in developing [leaderboard](https://github.com/agoragames/leaderboard),
+leaderboards backed by Redis, I know I wanted to be able to page through the various relationships.
+This does not seem to be possible given the current set of commands for Redis sets.
 
-Also, by using the "score" in Redis sorted sets that is based on the time of when a relationship 
-is established, we can get our "recent friends". It is possible that the scoring function may be 
+Also, by using the "score" in Redis sorted sets that is based on the time of when a relationship
+is established, we can get our "recent friends". It is possible that the scoring function may be
 user-defined in the future to allow for some specific ordering.
-  
+
 ## Contributing to amico
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project