amico 2.0.0 → 2.0.1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.0.1
+
+* 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
 
 * 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

data/README.md

@@ -383,7 +383,7 @@ Amico.following?(1, 11, 'user')
 Amico.following(1)
  => ["11"] 
 
-Amico.following(1, Amico.default_options, 'user')
+Amico.following(1, {:page_size => Amico.page_size, :page => 1}, 'user')
  => ["11"] 
 
 Amico.following?(1, 11, 'project')
@@ -394,10 +394,24 @@ Amico.follow(1, 11, 'project')
 Amico.following?(1, 11, 'project')
  => true 
 
-Amico.following(1, Amico.default_options, 'project')
+Amico.following(1, {:page_size => Amico.page_size, :page => 1}, 'project')
  => ["11"]
 ```
 
+You can retrieve all of a particular type of relationship using the `all(id, type, scope)` call. For example:
+
+```ruby
+Amico.follow(1, 11)
+ => nil 
+Amico.follow(1, 12)
+ => nil 
+Amico.all(1, :following)
+ => ["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. 
+
 ## Documentation 
 
 The source for the [relationships module](https://github.com/agoragames/amico/blob/master/lib/amico/relationships.rb) is well-documented. There are some 

data/lib/amico/relationships.rb

@@ -6,7 +6,7 @@ module Amico
     # 
     # @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 scope [String] Scope for the call
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -29,7 +29,7 @@ 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
+    # @param scope [String] Scope for the call.
     # 
     # Examples
     #
@@ -52,7 +52,7 @@ 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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -76,7 +76,7 @@ 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
+    # @param scope [String] Scope for the call.
     # 
     # Examples
     # 
@@ -92,7 +92,7 @@ module Amico
     #
     # @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
+    # @param scope [String] Scope for the call.
     #
     # Example
     #
@@ -110,7 +110,7 @@ module Amico
     # 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
+    # @param scope [String] Scope for the call.
     # 
     # Examples
     # 
@@ -125,7 +125,7 @@ module Amico
     # 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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -140,7 +140,7 @@ module Amico
     # 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
+    # @param scope [String] Scope for the call.
     # 
     # Examples
     #
@@ -155,7 +155,7 @@ module Amico
     # 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
+    # @param scope [String] Scope for the call.
     # 
     # Examples
     # 
@@ -171,7 +171,7 @@ module Amico
     # 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
+    # @param scope [String] Scope for the call.
     # 
     # Examples
     #
@@ -188,7 +188,7 @@ module Amico
     #
     # @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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -204,7 +204,7 @@ module Amico
     #
     # @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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -220,7 +220,7 @@ module Amico
     #
     # @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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     # 
@@ -236,7 +236,7 @@ module Amico
     #
     # @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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -253,7 +253,7 @@ module Amico
     #
     # @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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -268,8 +268,8 @@ module Amico
     # 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
+    # @param page_options [Hash] Options to be passed for retrieving a page of followed individuals.
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -278,15 +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, scope = Amico.default_scope_key)
-      members("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{id}", options)
+    def following(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.following_key}:#{scope}:#{id}", page_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
+    # @param page_options [Hash] Options to be passed for retrieving a page of followers.
+    # @param scope [String] Scope for the call.
     #
     # Examples
     # 
@@ -295,15 +295,15 @@ module Amico
     #   Amico.followers(1, :page => 1)
     #
     # @return a page of followers for a given ID.
-    def followers(id, options = default_options, scope = Amico.default_scope_key)
-      members("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{id}", options)
+    def followers(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.followers_key}:#{scope}:#{id}", page_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
+    # @param page_options [Hash] Options to be passed for retrieving a page of blocked individuals.
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -312,15 +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, scope = Amico.default_scope_key)
-      members("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{id}", options)
+    def blocked(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.blocked_key}:#{scope}:#{id}", page_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
+    # @param page_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
     #
@@ -331,15 +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, scope = Amico.default_scope_key)
-      members("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{id}", options)
+    def reciprocated(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.reciprocated_key}:#{scope}:#{id}", page_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
+    # @param page_options [Hash] Options to be passed for retrieving a page of pending relationships.
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -348,15 +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, scope = Amico.default_scope_key)
-      members("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{id}", options)
+    def pending(id, page_options = default_paging_options, scope = Amico.default_scope_key)
+      members("#{Amico.namespace}:#{Amico.pending_key}:#{scope}:#{id}", page_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
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -373,7 +373,7 @@ module Amico
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
-    # @param scope [String] Scope for the call
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -390,7 +390,7 @@ module Amico
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
-    # @param scope [String] Scope for the call
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -407,7 +407,7 @@ module Amico
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
-    # @param scope [String] Scope for the call
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -426,7 +426,7 @@ module Amico
     #
     # @param id [String] ID of the individual.
     # @param page_size [int] Page size (default: Amico.page_size).
-    # @param scope [String] Scope for the call
+    # @param scope [String] Scope for the call.
     #
     # Examples
     #
@@ -437,14 +437,26 @@ module Amico
     # @return the number of pages of pending relationships for an individual.
     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    
+    end
+
+    # Retrieve all of the individuals for a given id, type (e.g. following) and scope
+    #
+    # @param id [String] ID of the individual.
+    # @param type [Symbol] One of :following, :followers, :blocked, :reciprocated, :pending
+    # @param scope [String] Scope for the call.
+    def all(id, type, scope = Amico.default_scope_key)
+      valid_types = [:following, :followers, :blocked, :reciprocated, :pending]
+      raise "Must be one of #{valid_types.to_s}" if !valid_types.include?(type)
+      count = self.send("#{type.to_s}_count".to_sym, id, scope)
+      count > 0 ? self.send("#{type}", id, {:page_size => count}, scope) : []
+    end
 
     private
 
-    # Default options for doing, for example, paging.
+    # Default paging options.
     #
-    # @return a hash of the default options.
-    def default_options
+    # @return a hash of the default paging options.
+    def default_paging_options
       {:page_size => Amico.page_size, :page => 1}
     end
 
@@ -484,8 +496,8 @@ module Amico
     # @param options [Hash] Default options for paging.
     #
     # @return a page of items from a Redis sorted set without scores.
-    def members(key, options = default_options)
-      options = default_options.dup.merge!(options)
+    def members(key, options = default_paging_options)
+      options = default_paging_options.dup.merge!(options)
       if options[:page] < 1
         options[:page] = 1
       end

data/lib/amico/version.rb

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

data/spec/amico/relationships_spec.rb

@@ -405,6 +405,83 @@ describe Amico::Relationships do
     end
   end
 
+  describe '#all' do
+    it 'should raise an exception if passing an invalid type' do
+      lambda {Amico.all(1, :unknown)}.should raise_error      
+    end
+
+    it 'should return the correct list when calling all for various types' do
+      add_reciprocal_followers(5)
+
+      [:following, :followers, :reciprocated].each do |type|
+        list = Amico.all(1, type)
+        # It is 29, not 30, since you cannot follow yourself
+        list.length.should be(4)
+      end
+    end
+
+    it 'should return the correct list when calling all for a pending relationship' do
+      Amico.pending_follow = true
+      add_reciprocal_followers(5)
+
+      [:following, :followers, :reciprocated].each do |type|
+        list = Amico.all(1, type)
+        list.length.should be(0)
+      end
+
+      pending_list = Amico.all(1, :pending)
+      pending_list.length.should be(4)
+
+      Amico.pending_follow = false
+    end
+
+    it 'should return the correct list when calling all for a blocked relationship' do
+      add_reciprocal_followers(5, true)
+
+      [:following, :followers, :reciprocated].each do |type|
+        list = Amico.all(1, type)
+        list.length.should be(0)
+      end
+
+      blocked_list = Amico.all(1, :blocked)
+      blocked_list.length.should be(4)
+    end
+  end
+
+  describe '#following with options and scope' do
+    it 'should allow you to pass in an empty set of options that will use the default options' do
+      add_reciprocal_followers(5)
+
+      following = Amico.following(1, {}, Amico.default_scope_key)
+      following.length.should be(4)
+    end
+
+    it 'should allow you to pass in options that will override the option in the default options' do
+      add_reciprocal_followers(5)
+
+      following = Amico.following(1, {:page_size => 1}, Amico.default_scope_key)
+      following.length.should be(1)
+    end
+
+    it 'should allow you to pass in an empty set of options that will use the default options with a custom scope' do
+      Amico.default_scope_key = 'friends'
+      add_reciprocal_followers(5)
+
+      following = Amico.following(1, {}, 'friends')
+      following.length.should be(4)
+      Amico.default_scope_key = 'default'
+    end
+
+    it 'should allow you to pass in options that will override the option in the default options with a custom scope' do
+      Amico.default_scope_key = 'friends'
+      add_reciprocal_followers(5)
+
+      following = Amico.following(1, {:page_size => 1}, 'friends')
+      following.length.should be(1)
+      Amico.default_scope_key = 'default'
+    end
+  end
+
   private
 
   def add_reciprocal_followers(count = 26, block_relationship = false)

data/spec/amico/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Amico::VERSION' do
+  it 'should be the correct version' do
+    Amico::VERSION.should == '2.0.1'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amico
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2153496040 !ruby/object:Gem::Requirement
+  requirement: &2152963800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153496040
+  version_requirements: *2152963800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153495620 !ruby/object:Gem::Requirement
+  requirement: &2152963380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153495620
+  version_requirements: *2152963380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153495200 !ruby/object:Gem::Requirement
+  requirement: &2152962960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153495200
+  version_requirements: *2152962960
 description: Relationships (e.g. friendships) backed by Redis
 email:
 - dczarnecki@agoragames.com
@@ -66,6 +66,7 @@ files:
 - lib/amico/version.rb
 - spec/amico/configuration_spec.rb
 - spec/amico/relationships_spec.rb
+- spec/amico/version_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/agoragames/amico
 licenses: []
@@ -81,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1543039261316922594
+      hash: 1022229374045319322
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1543039261316922594
+      hash: 1022229374045319322
 requirements: []
 rubyforge_project: amico
 rubygems_version: 1.8.10
@@ -100,4 +101,5 @@ summary: Relationships (e.g. friendships) backed by Redis
 test_files:
 - spec/amico/configuration_spec.rb
 - spec/amico/relationships_spec.rb
+- spec/amico/version_spec.rb
 - spec/spec_helper.rb