acts_as_amico 0.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc
+doc
+*.rdb
+.idea
+*.sqlite3
+*.log
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3@amico_gem

data/API.md

@@ -0,0 +1,361 @@
+```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 = false
+  configuration.page_size = 25
+end
+
+Amico.follow(1, 11)
+=> [1, 1]
+
+Amico.following?(1, 11)
+ => true
+
+Amico.following?(11, 1)
+ => false
+
+Amico.follow(11, 1)
+ => [1, 1]
+
+Amico.following?(11, 1)
+ => true
+
+Amico.following_count(1)
+ => 1
+
+Amico.followers_count(1)
+ => 1
+
+Amico.unfollow(11, 1)
+ => [1, 1]
+
+Amico.following_count(11)
+ => 0
+
+Amico.following_count(1)
+ => 1
+
+Amico.follower?(1, 11)
+ => false
+
+Amico.following(1)
+ => ["11"]
+
+Amico.block(1, 11)
+ => [1, 1, 1, 1, 1]
+
+Amico.following?(11, 1)
+ => false
+
+Amico.blocked?(1, 11)
+ => true
+
+Amico.unblock(1, 11)
+ => true
+
+Amico.blocked?(1, 11)
+ => false
+
+Amico.follow(11, 1)
+ => nil
+
+Amico.follow(1, 11)
+ => [1, 1]
+
+Amico.reciprocated?(1, 11)
+ => true
+
+Amico.reciprocated(1)
+ => ["11"]
+```
+
+Use amico (with pending relationships for follow):
+
+```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(1, 11)
+ => true
+
+Amico.follow(11, 1)
+ => true
+
+Amico.pending?(1, 11)
+ => true
+
+Amico.pending?(11, 1)
+ => true
+
+Amico.accept(1, 11)
+ => nil
+
+Amico.pending?(1, 11)
+ => false
+
+Amico.pending?(11, 1)
+ => true
+
+Amico.following?(1, 11)
+ => true
+
+Amico.following?(11, 1)
+ => false
+
+Amico.follower?(11, 1)
+ => true
+
+Amico.follower?(1, 11)
+ => false
+
+Amico.accept(11, 1)
+ => [1, 1]
+
+Amico.pending?(1, 11)
+ => false
+
+Amico.pending?(11, 1)
+ => false
+
+Amico.following?(1, 11)
+ => true
+
+Amico.following?(11, 1)
+ => true
+
+Amico.follower?(11, 1)
+ => true
+
+Amico.follower?(1, 11)
+ => true
+
+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, {:page_size => Amico.page_size, :page => 1}, 'user')
+ => ["11"]
+
+Amico.following?(1, 11, 'project')
+ => false
+
+Amico.follow(1, 11, 'project')
+
+Amico.following?(1, 11, 'project')
+ => true
+
+Amico.following(1, {:page_size => Amico.page_size, :page => 1}, 'project')
+ => ["11"]
+```

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 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
+
+# 1.1.0
+
+* Added blocking to relationships
+* Added reciprocated to relationships
+
+# 1.0.0 (2012-01-11)
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 David Czarnecki
+
+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,185 @@
+# acts_as_amico
+
+ActiveModel injectable relationships (e.g. friendships) backed by Redis.
+
+## Installation
+
+`gem install acts_as_amico`
+
+or in your `Gemfile`
+
+```ruby
+gem 'acts_as_amico'
+```
+
+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:
+
+```ruby
+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 module loadable methods:
+
+```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 = false
+  configuration.page_size = 25
+end
+
+class User < ActiveRecord::Base
+ acts_as_amico
+end
+
+usera = User.create
+userb = user.create
+
+usera.follow! userb
+=> nil
+
+usera.following? userb
+ => true
+
+userb.following? usera
+ => false
+
+userb.follow! usera
+ => [1, 1]
+
+userb.following? usera
+ => true
+
+usera.following_count
+ => 1
+
+usera.followers_count
+ => 1
+
+userb.unfollow! usera
+ => [1, 1, 1, 1, 0]
+
+userb.following_count
+ => 0
+
+usera.following_count
+ => 1
+
+usera.follower? userb
+ => false
+
+puts userb.id
+ => 11
+
+usera.following
+ => ["11"]
+
+usera.block! userb
+ => [1, 0, 1, 0, 0, 0, 0, 1]
+
+userb.following? usera
+ => false
+
+usera.blocked? userb
+ => true
+
+usera.unblock! userb
+ => true
+
+usera.blocked? userb
+ => false
+
+userb.follow! usera
+ => nil
+
+usera.follow! userb
+ => [1, 1]
+
+usera.reciprocated? userb
+ => true
+
+puts userb.id
+ => 11
+
+usera.reciprocated
+ => ["11"]
+```
+
+You can also use non-id keys:
+
+```ruby
+class Admin < ActiveRecord::Base
+  acts_as_amico :amico_key => "name"
+  validates_uniqueness_of :name  # -> do this or be sorry :)
+end
+
+usera = User.create
+
+puts usera.id
+ => 18
+
+admin = Admin.create :name => "frank"
+
+usera.follow! admin
+ => nil
+
+admin.follow! usera
+ => [1, 1]
+
+admin.followers
+ => ["18"]
+
+usera.followers
+ => ["frank"]
+```
+
+## Documentation 
+
+Acts_as_amico is feature complete with the amico gem. [The Amico API usage page](https://github.com/mettadore/amico/blob/master/API.md)
+shows a more complete suite of methods. The source for the [Amico 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
+[Amico online documentation](http://rubydoc.info/github/agoragames/amico/master/frames).
+
+## Future Plans
+
+Clean up the ActiveResource integration
+
+## Contributing to acts_as_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
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) John Metta. See LICENSE.txt for further details.
+