acts_as_amico
ActiveModel injectable relationships (e.g. friendships) backed by Redis using the Amico gem
Installation
gem install acts_as_amico
or in your Gemfile
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.
Basic Usage
require 'acts_as_amico'
=> true
# Configure the Amico sub-framework
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"]Non-ID Keys
You can also use non-id keys
class Admin < ActiveRecord::Base
acts_as_amico :amico_key => :name
validates_uniqueness_of :name # -> do this or be sorry
validates_presence_of :name # -> this too, you've been warned
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"]ActiveResource Models
You can use active resource models as well
class RestObject < ActiveResource::Base
self.site = 'http://mettadore.com/junk'
acts_as_amico :amico_key => :title
end
usera = User.create
rest_object = RestObject.find(123)
rest_object.title
=> "Bread and Circus"
usera.follow! rest_object
usera.following? rest_object
=> true
usera.following
=> ["Bread and Circus"]One note about ActiveResource: You have to be careful what you use as the :amico_key. For
instance, using acts_as_amico :amico_key => :name is an exceptionally bad idea because
this will cause a SystemStackError: stack level too deep because acts_as_amico uses
the Rails::Object#send method to get the key, and for some reason if the send method even
touches the string/symbol "name" we get cascaded through the object graph.
Documentation
Acts_as_amico is feature complete with the amico gem. The Amico API usage page shows a more complete suite of methods. The source for the Amico relationships module is well-documented. There are some simple examples in the method documentation. You can also refer to the Amico online documentation.
Future Plans
- Clean up the ActiveResource integration and figure out why :name is so dangerous.
- Better document the code
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.
