acts_as_friendable 0.5.0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/*.log
+spec/config/database.yml
+spec/reports
+/spec/tmp/*
+*.sqlite3
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeremy Ward
+
+MIT License
+
+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,104 @@
+# ActsAsFriendable
+
+ActsAsFriendable provides a Friendship model, relevent scopes, and many instance methods to quickly and easily add Social Networking functionality to your Rails application.
+
+## Overview
+
+ActsAsFriendable defines a "friendship" as a two-way relationship which is initiated by one user and approved by the other user. So, we have two states of a friendship (not-approved-yet or approved) and we have two directions of friendship relative to the current user: friendships requested by the current user (we’ll call these “direct” friendships), and friendships requested to the current user (we’ll call these “inverse” friendships).
+
+## Installation
+
+Add ActsAsFriendable to you Gemfile:
+
+```ruby
+ gem 'acts_as_friendable'
+```
+
+And then intall it with bundler by executing:
+
+```shell
+bundle install
+```
+
+Install and run the migrations:
+
+```shell
+rails g acts_as_friendable:install
+rails db:migrate
+```
+
+## Usage
+
+ActsAsFriendable is meant to be used on one Active Record model. The model can be named anything you like, but it will most frequently be 'User'. **Note:** you'll need to manually add ActsAsFriendable to your model class.
+
+```ruby
+class User < ActiveRecord::Base
+  include ActsAsFriendable
+end
+```
+
+`include ActsAsFriendable` adds all of the ActsAsFriendable goodness to the model.
+
+### Scopes and Methods
+
+Given the "friendship" definition in the Overview, we have 4 possible states of Friendship:
+
+1. direct approved
+2. indirect approved
+3. direct not-approved
+4. indirect not-approved
+
+States #1 and #2 are simply what we will be calling "friends." They are approved relationships, no matter the direction. Because we don’t care who requested the friendship once it’s approved, we will group these together.
+
+State #3 is what we call "pending friends." Other users whom the current user has requested to be friends with and which are awaiting approval. These are out of of the control of the current user and just waiting to be approved or rejected.
+
+State #4 is what we call "requested friends." Other user who have requested that the current user be their friend and are awaiting the approval of the current user. These are the actionable items for the current user to approve or reject. Ignoring a friend request simply deletes the non-approved Friendship (similar to Facebook). It doesn't the the other person they were reject but allows them to send another friend request if they want.
+
+With that understanding we have the following scopes / "lookup" methods available to us:
+
+```ruby
+class User < ActiveRecord::Base
+  include ActsAsFriendable
+end
+
+@user = User.find(1) # assuming there is a user in the database
+
+@user.friendships
+@user.inverse_friendships
+@user.direct_friends
+@user.inverse_friends
+@user.pending_friends
+@user.requested_friendships
+@user.friends # => amalgamation of direct_friends and inverse_friends
+
+# Additionally, we have several convenience methods to help in sorting, listing, finding, etc.
+
+ # provides a map of the current user's friend's ids
+@user.friend_ids
+
+# provides a map of ids of all current and requested friends of the current user
+#   - useful in querying for new friends
+@user.pending_and_friend_ids
+
+# includes the current user's id in the map of friend's ids
+#   - useful when you need to inlude the current user in a collection (Activities, Comments, Leaderboards, etc.)
+@user.friend_ids_and_me
+
+
+```
+
+## Testing
+
+ActsAsFriendable uses RSpec for its test coverage. Inside the gem directory, you can run the specs with:
+
+```shell
+rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/acts_as_friendable.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_friendable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_friendable"
+  spec.version       = ActsAsFriendable::VERSION
+  spec.authors       = ["Jeremy Ward"]
+  spec.email         = ["jrmy.ward@gmail.com"]
+  spec.description   = %q{ActsAsFriendable provides a Friendship model, relevent scopes, and many instance methods to quickly and easily add Social Networking functionality to your Rails application.}
+  spec.summary       = %q{A drop-in solution to add Friendship functionality to a Rails application.}
+  spec.homepage      = "https://github.com/jrmyward/acts_as_friendable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails', '~> 3.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'ammeter'
+  spec.add_development_dependency "database_cleaner"
+end

data/lib/acts_as_friendable.rb

@@ -0,0 +1,26 @@
+require "active_record"
+require "active_record/version"
+require "acts_as_friendable/model_additions"
+require "acts_as_friendable/friendships"
+require "acts_as_friendable/version"
+
+module ActsAsFriendable
+  def self.included(receiver)
+    receiver.class_eval do
+      has_many :friendships, :class_name => "ActsAsFriendable::Friendship", :dependent => :destroy
+      has_many :inverse_friendships, :class_name => "ActsAsFriendable::Friendship", :foreign_key => "friend_id", :dependent => :destroy
+      has_many :direct_friends, :through => :friendships, :conditions => ["approved = ?", true], :source => :friend
+      has_many :inverse_friends, :through => :inverse_friendships, :conditions => ["approved = ?", true], :source => :user
+      has_many :pending_friends, :through => :friendships, :conditions => ["approved = ?", false], :source => :friend
+      has_many :requested_friendships, :through => :inverse_friendships, :conditions => ["approved = ?", false], :source => :user
+    end
+
+    ActsAsFriendable::Friendship.class_eval do
+      belongs_to "#{receiver.to_s.underscore}".to_sym, :class_name => "#{receiver.to_s}", :foreign_key => "user_id"
+      belongs_to :friend, :class_name => "#{receiver.to_s}", :foreign_key => "friend_id"
+    end
+
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+end

data/lib/acts_as_friendable/friendships.rb

@@ -0,0 +1,5 @@
+module ActsAsFriendable
+  class Friendship < ActiveRecord::Base
+    attr_accessible :approved, :friend_id, :user_id
+  end
+end

data/lib/acts_as_friendable/model_additions.rb

@@ -0,0 +1,29 @@
+module ActsAsFriendable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+  end
+
+  module InstanceMethods
+    def friends
+      direct_friends | inverse_friends
+    end
+
+    def friend_ids
+      friends.map {|f| f.id}
+    end
+
+    def friend_ids_and_me
+      friend_ids << id
+    end
+
+    def pending_and_friend_ids
+      pending_and_friend_ids = []
+      pending_and_friend_ids << friend_ids
+      pending_and_friend_ids << pending_friends.map {|f| f.id}
+      pending_and_friend_ids.flatten
+    end
+  end
+
+end

data/lib/acts_as_friendable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsFriendable
+  VERSION = "0.5.0"
+end

data/lib/generators/acts_as_friendable/install/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/migration'
+
+module ActsAsFriendable
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Generates Friendship migration"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migration
+        migration_template 'migration.rb', 'db/migrate/acts_as_friendable.rb'
+      end
+    end
+  end
+end

data/lib/generators/acts_as_friendable/install/templates/migration.rb

@@ -0,0 +1,11 @@
+class ActsAsFriendable < ActiveRecord::Migration
+  def change
+    create_table :friendships do |t|
+      t.integer :user_id
+      t.integer :friend_id
+      t.boolean :approved
+
+      t.timestamps
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'acts_as_friendable'

data/spec/acts_as_friendable/friendships_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe ActsAsFriendable::Friendship do
+  let(:user) { User.create!({ first_name: 'James', last_name: 'Bond' }) }
+
+  it "should respond to user" do
+    ActsAsFriendable::Friendship.instance_methods.include?(:user).should be_true
+  end
+
+  it "should respond to friend" do
+    ActsAsFriendable::Friendship.instance_methods.include?(:friend).should be_true
+  end
+
+end

data/spec/acts_as_friendable/model_additions_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe ActsAsFriendable do
+  let(:user) { User.create!({ first_name: 'Bruce', last_name: 'Wayne' }) }
+  let(:user_2) { User.create!({ first_name: 'Clark', last_name: 'Kent' }) }
+  let(:user_3) { User.create!({ first_name: 'Peter', last_name: 'Parker' }) }
+  let(:user_4) { User.create!({ first_name: 'Bruce', last_name: 'Banner' }) }
+  let(:user_5) { User.create!({ first_name: 'Tony', last_name: 'Stark' }) }
+
+  before(:each) do
+    ActsAsFriendable::Friendship.create({user_id: user.id, friend_id: user_2.id, approved: true})
+    ActsAsFriendable::Friendship.create({user_id: user_3.id, friend_id: user.id, approved: true})
+    ActsAsFriendable::Friendship.create({user_id: user_4.id, friend_id: user.id, approved: false})
+    ActsAsFriendable::Friendship.create({user_id: user.id, friend_id: user_5.id, approved: false})
+  end
+
+  describe "Reciever" do
+    it "should respond to friendships" do
+      user.should respond_to(:friendships)
+    end
+
+    it "should respond to inverse_friendships" do
+      user.should respond_to(:inverse_friendships)
+    end
+
+    it "should respond to direct_friends" do
+      user.should respond_to(:direct_friends)
+    end
+
+    it "should respond to inverse_friends" do
+      user.should respond_to(:inverse_friends)
+    end
+
+    it "should respond to pending_friends" do
+      user.should respond_to(:pending_friends)
+    end
+
+    it "should respond to requested_friendships" do
+      user.should respond_to(:requested_friendships)
+    end
+  end
+
+  describe "Scope" do
+
+    describe "friendships" do
+      it "collects all user-initiated relationships" do
+        r = user.friendships
+        r[0].friend_id.should == user_2.id
+      end
+    end
+
+    describe "inverse_friendships" do
+      it "collects all stranger-initiated relationships" do
+        r = user.inverse_friendships
+        r[0].user_id.should == user_3.id
+      end
+    end
+
+    describe "direct_friends" do
+      it "collects approved user-initiated relationships" do
+        r = user.direct_friends
+        r[0].id.should == user_2.id
+      end
+    end
+
+    describe "inverse_friends" do
+      it "collects approved stranger-initiated relationships" do
+        r = user.inverse_friends
+        r[0].id.should == user_3.id
+      end
+    end
+
+    describe "pending_friends" do
+      it "collects un-approved user-initiated relationships" do
+        r = user_4.pending_friends
+        r[0].id.should == user.id
+      end
+    end
+
+    describe "requested_friendships" do
+      it "collects un-approved stranger-initiated relationships" do
+        r = user.requested_friendships
+        r[0].id.should == user_4.id
+      end
+    end
+
+    describe "friends" do
+      it "collects a user's approved direct_friends and inverse_friends" do
+        r = user.friends
+        r[0].id.should == user_2.id
+        r[1].id.should == user_3.id
+      end
+    end
+  end
+
+  describe "Instance Method" do
+
+    describe "friend_ids" do
+      it "should return an array of all direct_friends and inverse_friends ids" do
+        user.friend_ids.include?(user_2.id).should be_true
+        user.friend_ids.include?(user_5.id).should be_false
+      end
+    end
+
+    describe "friend_ids_and_me" do
+      it "should return an array of approved friend ids plus the current user's id" do
+        user_3.friend_ids_and_me.should == [user.id, user_3.id]
+      end
+    end
+
+    describe "pending_and_friend_ids" do
+      it "should return an array of all approved friends and user-initiated pending friends" do
+        user.pending_and_friend_ids.include?(user_2.id).should be_true
+        user.pending_and_friend_ids.include?(user_5.id).should be_true
+      end
+    end
+
+  end
+
+end

data/spec/config/database.yml.sample

@@ -0,0 +1,19 @@
+sqlite3:
+  adapter: sqlite3
+  database: acts_as_friendable.sqlite3
+
+mysql:
+  adapter: mysql2
+  hostname: localhost
+  username: root
+  password:
+  database: acts_as_friendable
+  charset: utf8
+
+postgresql:
+  adapter: postgresql
+  hostname: localhost
+  username: postgres
+  password:
+  database: acts_as_friendable
+  encoding: utf8

data/spec/config/models.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include ActsAsFriendable
+end

data/spec/config/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define :version => 0 do
+
+  create_table "friendships", :force => true do |t|
+    t.integer  "user_id"
+    t.integer  "friend_id"
+    t.boolean  "approved"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "first_name"
+    t.string   "last_name"
+  end
+
+end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+# Generators are NOT automatically loaded by Rails
+require 'generators/acts_as_friendable/install/install_generator'
+
+describe ActsAsFriendable::Generators::InstallGenerator do
+  # Tell the generator where to put its output (what it thinks of as Rails.root)
+  destination File.expand_path("../../../tmp", __FILE__)
+
+  before do
+    prepare_destination
+    Rails::Generators.options[:rails][:orm] = :active_record
+  end
+
+  describe 'no arguments' do
+    before { run_generator  }
+
+    describe 'db/migrate/acts_as_friendable.rb' do
+      subject { file('db/migrate/acts_as_friendable.rb') }
+      it { should be_a_migration }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'acts_as_friendable'
+require 'ammeter/init'
+require 'database_cleaner'
+
+# set adapter to use, default is sqlite3
+# to use an alternative adapter run => rake spec DB='postgresql'
+db_name = ENV['DB'] || 'sqlite3'
+database_yml = File.expand_path('../config/database.yml', __FILE__)
+
+if File.exists?(database_yml)
+  active_record_configuration = YAML.load_file(database_yml)
+
+  ActiveRecord::Base.configurations = active_record_configuration
+  config = ActiveRecord::Base.configurations[db_name]
+
+  begin
+    ActiveRecord::Base.establish_connection(db_name)
+    ActiveRecord::Base.connection
+  rescue
+    case db_name
+    when /mysql/
+      ActiveRecord::Base.establish_connection(config.merge('database' => nil))
+      ActiveRecord::Base.connection.create_database(config['database'],  {:charset => 'utf8', :collation => 'utf8_unicode_ci'})
+    when 'postgresql'
+      ActiveRecord::Base.establish_connection(config.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+      ActiveRecord::Base.connection.create_database(config['database'], config.merge('encoding' => 'utf8'))
+    end
+
+    ActiveRecord::Base.establish_connection(config)
+  end
+
+  ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+  ActiveRecord::Base.default_timezone = :utc
+
+  ActiveRecord::Base.silence do
+    ActiveRecord::Migration.verbose = false
+
+    load(File.expand_path('../config/schema.rb', __FILE__))
+    load(File.expand_path('../config/models.rb', __FILE__))
+  end
+
+else
+  raise "Please create #{database_yml} first to configure your database. Take a look at: spec/config/database.yml.sample"
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_friendable
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Ward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActsAsFriendable provides a Friendship model, relevent scopes, and many
+  instance methods to quickly and easily add Social Networking functionality to your
+  Rails application.
+email:
+- jrmy.ward@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_friendable.gemspec
+- lib/acts_as_friendable.rb
+- lib/acts_as_friendable/friendships.rb
+- lib/acts_as_friendable/model_additions.rb
+- lib/acts_as_friendable/version.rb
+- lib/generators/acts_as_friendable/install/install_generator.rb
+- lib/generators/acts_as_friendable/install/templates/migration.rb
+- rails/init.rb
+- spec/acts_as_friendable/friendships_spec.rb
+- spec/acts_as_friendable/model_additions_spec.rb
+- spec/config/database.yml.sample
+- spec/config/models.rb
+- spec/config/schema.rb
+- spec/generators/install_generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jrmyward/acts_as_friendable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A drop-in solution to add Friendship functionality to a Rails application.
+test_files:
+- spec/acts_as_friendable/friendships_spec.rb
+- spec/acts_as_friendable/model_additions_spec.rb
+- spec/config/database.yml.sample
+- spec/config/models.rb
+- spec/config/schema.rb
+- spec/generators/install_generator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: