amico 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in 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,98 @@
+# amico
+
+Relationships (e.g. friendships) backed by Redis.
+
+## Installation
+
+`gem install amico`
+
+or in your `Gemfile`
+
+```ruby
+gem '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.page_size = 25
+end
+```
+
+Use amico:
+
+```ruby
+require 'amico'
+ => true 
+
+Amico.configure do |configuration|
+  configuration.redis = Redis.new
+  configuration.namespace = 'amico'
+  configuration.following_key = 'following'
+  configuration.followers_key = 'followers'
+  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"]
+```
+
+You can pass `:page => 1` and `:page_size => 25` options into the `following` and `followers` methods. Set the values as appropriate.
+  
+## 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
+* 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) 2012 David Czarnecki. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+  # spec.ruby_opts = ['-w']
+end
+
+task :default => :spec

data/amico.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'amico/version'
+
+Gem::Specification.new do |s|
+  s.name        = "amico"
+  s.version     = Amico::VERSION
+  s.authors     = ["David Czarnecki"]
+  s.email       = ["dczarnecki@agoragames.com"]
+  s.homepage    = "https://github.com/agoragames/amico"
+  s.summary     = %q{Relationships (e.g. friendships) backed by Redis}
+  s.description = %q{Relationships (e.g. friendships) backed by Redis}
+
+  s.rubyforge_project = "amico"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('redis')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+end

data/lib/amico.rb

@@ -0,0 +1,9 @@
+require 'redis'
+require 'amico/version'
+require 'amico/configuration'
+require 'amico/relationships'
+
+module Amico
+  extend Configuration
+  extend Relationships
+end

data/lib/amico/configuration.rb

@@ -0,0 +1,29 @@
+module Amico
+  module Configuration
+    attr_accessor :redis
+    attr_accessor :namespace
+    attr_accessor :following_key
+    attr_accessor :followers_key
+    attr_accessor :page_size
+
+    def configure
+      yield self
+    end
+
+    def namespace
+      @namespace ||= 'amico'
+    end
+
+    def following_key
+      @following_key ||= 'following'
+    end
+
+    def followers_key
+      @followers_key ||= 'followers'
+    end
+
+    def page_size
+      @page_size ||= 25
+    end
+  end
+end

data/lib/amico/relationships.rb

@@ -0,0 +1,82 @@
+module Amico
+  module Relationships
+    def follow(from_id, to_id)
+      return if from_id == to_id
+
+      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)
+      end
+    end
+
+    def unfollow(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)
+      end
+    end
+
+    def following_count(id)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.following_key}:#{id}")
+    end
+
+    def followers_count(id)
+      Amico.redis.zcard("#{Amico.namespace}:#{Amico.followers_key}:#{id}")
+    end
+
+    def following?(id, following_id)
+      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.following_key}:#{id}", following_id).nil?
+    end
+
+    def follower?(id, follower_id)
+      !Amico.redis.zscore("#{Amico.namespace}:#{Amico.followers_key}:#{id}", follower_id).nil?
+    end
+
+    def following(id, options = default_options)
+      members("#{Amico.namespace}:#{Amico.following_key}:#{id}", options)
+    end
+
+    def followers(id, options = default_options)
+      members("#{Amico.namespace}:#{Amico.followers_key}:#{id}", options)
+    end
+
+    def following_page_count(id, page_size = Amico.page_size)
+      total_pages("#{Amico.namespace}:#{Amico.following_key}:#{id}", page_size)
+    end
+
+    def followers_page_count(id, page_size = Amico.page_size)
+      total_pages("#{Amico.namespace}:#{Amico.followers_key}:#{id}", page_size)
+    end
+
+    private
+
+    def default_options
+      {:page_size => Amico.page_size, :page => 1}
+    end
+
+    def total_pages(key, page_size)
+      (Amico.redis.zcard(key) / page_size.to_f).ceil
+    end
+
+    def members(key, options = default_options)
+      options = default_options.dup.merge!(options)
+      if options[:page] < 1
+        options[:page] = 1
+      end
+
+      if options[:page] > total_pages(key, options[:page_size])
+        options[:page] = total_pages(key, options[:page_size])
+      end
+
+      index_for_redis = options[:page] - 1
+      starting_offset = (index_for_redis * options[:page_size])
+
+      if starting_offset < 0
+        starting_offset = 0
+      end
+
+      ending_offset = (starting_offset + options[:page_size]) - 1
+      Amico.redis.zrevrange(key, starting_offset, ending_offset, :with_scores => false)
+    end
+  end
+end

data/lib/amico/version.rb

@@ -0,0 +1,3 @@
+module Amico
+  VERSION = '1.0.0'
+end

data/spec/amico/configuration_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Amico::Configuration do
+  describe '#configure' do
+    it 'should have default attributes' do
+      Amico.configure do |configuration|
+        configuration.namespace.should eql('amico')
+        configuration.following_key.should eql('following')
+        configuration.followers_key.should eql('followers')
+        configuration.page_size.should be(25)
+      end
+    end
+  end
+end

data/spec/amico/relationships_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe Amico::Relationships do
+  describe '#follow' 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)
+    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)
+    end
+  end
+
+  describe '#unfollow' 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.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)
+    end
+  end
+
+  describe '#following_count' do
+    it 'should return the correct count' do
+      Amico.follow(1, 11)
+      Amico.following_count(1).should be(1)
+    end
+  end
+
+  describe '#followers_count' do
+    it 'should return the correct count' do
+      Amico.follow(1, 11)
+      Amico.followers_count(11).should be(1)
+    end
+  end
+
+  describe '#following?' do
+    it 'should return that you are following' do
+      Amico.follow(1, 11)
+      Amico.following?(1, 11).should be_true
+      Amico.following?(11, 1).should be_false
+
+      Amico.follow(11, 1)
+      Amico.following?(11, 1).should be_true
+    end
+  end
+
+  describe '#follower?' do
+    it 'should return that you are being followed' do
+      Amico.follow(1, 11)
+      Amico.follower?(11, 1).should be_true
+      Amico.follower?(1,11).should be_false
+
+      Amico.follow(11, 1)
+      Amico.follower?(1,11).should be_true
+    end
+  end
+
+  describe '#following' do
+    it 'should return the correct list' do
+      Amico.follow(1, 11)
+      Amico.follow(1, 12)
+      Amico.following(1).should eql(["12", "11"])
+      Amico.following(1, :page => 5).should eql(["12", "11"])
+    end
+
+    it 'should page correctly' do
+      add_reciprocal_followers
+      
+      Amico.following(1, :page => 1, :page_size => 5).size.should be(5)
+      Amico.following(1, :page => 1, :page_size => 10).size.should be(10)
+      Amico.following(1, :page => 1, :page_size => 26).size.should be(25)
+    end
+  end
+
+  describe '#followers' do
+    it 'should return the correct list' do
+      Amico.follow(1, 11)
+      Amico.follow(2, 11)
+      Amico.followers(11).should eql(["2", "1"])
+      Amico.followers(11, :page => 5).should eql(["2", "1"])
+    end
+
+    it 'should page correctly' do
+      add_reciprocal_followers
+
+      Amico.followers(1, :page => 1, :page_size => 5).size.should be(5)
+      Amico.followers(1, :page => 1, :page_size => 10).size.should be(10)
+      Amico.followers(1, :page => 1, :page_size => 26).size.should be(25)
+    end
+  end
+
+  describe '#following_page_count' do
+    it 'should return the correct count' do
+      add_reciprocal_followers
+
+      Amico.following_page_count(1).should be(1)
+      Amico.following_page_count(1, 10).should be(3)
+      Amico.following_page_count(1, 5).should be(5)
+    end
+  end
+
+  describe '#followers_page_count' do
+    it 'should return the correct count' do
+      add_reciprocal_followers
+
+      Amico.followers_page_count(1).should be(1)
+      Amico.followers_page_count(1, 10).should be(3)
+      Amico.followers_page_count(1, 5).should be(5)
+    end
+  end
+
+  private
+
+  def add_reciprocal_followers(count = 26)
+    1.upto(count) do |outer_index|
+      1.upto(count) do |inner_index|
+        if outer_index != inner_index
+          Amico.follow(outer_index, inner_index + 1000)
+          Amico.follow(inner_index + 1000, outer_index)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'amico'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Amico.configure do |configuration|
+      redis = Redis.new
+      redis.flushall
+      configuration.redis = redis
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: amico
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- David Czarnecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2160263060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160263060
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2160261920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160261920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2160260960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160260960
+description: Relationships (e.g. friendships) backed by Redis
+email:
+- dczarnecki@agoragames.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amico.gemspec
+- lib/amico.rb
+- lib/amico/configuration.rb
+- lib/amico/relationships.rb
+- lib/amico/version.rb
+- spec/amico/configuration_spec.rb
+- spec/amico/relationships_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/agoragames/amico
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2423888867059560591
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2423888867059560591
+requirements: []
+rubyforge_project: amico
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Relationships (e.g. friendships) backed by Redis
+test_files:
+- spec/amico/configuration_spec.rb
+- spec/amico/relationships_spec.rb
+- spec/spec_helper.rb