friendis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80e47954eaed926ce7a99b5df712e2987fde5d3e
+  data.tar.gz: c31a0bbbd24c01eea567cee59838e2c686dee86b
+SHA512:
+  metadata.gz: 42192b191c3d689ddb376fc21c008abd3b17f0933f7b65f696e6f959f94c60f5671cd51a00130e172a82a29382958bffd7782f249642e9d54ccd5f2f12a78bbf
+  data.tar.gz: 8c1fd15605d81f5f1c0d3b3f844f016d7be6c6191a188c6bfd6ad965750417ae60e3dde64b973f1c09c0d730e3e3ff6401441a56462e0a11e725eeee80af4f05

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Elad Meidar
+
+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,110 @@
+# Friendis
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'friendis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install friendis
+
+## Usage
+
+### Configuration
+
+create an initializer in `config/initializers/friendis.rb`:
+
+    Friendis.configure do |c|
+      #...
+    end
+
+The following options exist:
+
+* redis_connection: an existing Redis connection, defaults to a `Redis.new` instance.
+
+### Adding to a Model
+
+All you need to do is to include the `Friendable` module:
+
+    include Friendis::Friendable
+
+and to choose which attributes or methods will be cached in Redis for that user:
+
+    friend_this track: [:name, :picture]
+
+Those fields will be changed in Redis after everytime you save the instance, note that
+your ORM needs to implement `after_save` and `after_destroy` since Friendis utilizes those callbacks to update and remove
+the cached data from Redis.
+
+The `id` attribute will automatically be cached.
+
+
+## Examples
+    
+    class User < ActiveRecord::Base
+      include Friendis::Friendable
+
+      friend_this track: [:name, :picture]
+    end 
+
+### Friend Requests
+
+    @user1 = User.create(name: "Elad Meidar", picture: "http://picturez.com/elad.jpg")
+    @user2 = User.create(name: "Miki Bergin", picture: "http://picturez.com/miki.jpg")
+
+    @user1.send_friend_request(@user2)
+
+### Pending Friend Request
+
+    @user2.pending_friend_requests
+
+`pending_friend_requests` will return the cached attributes for the pending friend requests, in this case
+
+    [{"name" => "Elad Meidar", "picture" => "http://picturez.com/elad.jpg", "id" => 1}]
+
+### Sent Friend Request
+
+    @user2.sent_friend_requests
+
+`sent_friend_requests` will return the cached attributes for the sent friend requests, in this case
+
+    [{"name" => "Miki Bergin", "picture" => "http://picturez.com/miki.jpg", "id" => 2}]
+
+### Approving Friend Requests
+
+    @user2.approve_friend_request(@user1)
+
+### Lisiting Friends
+    
+    @user1.friends
+
+`friends` will return the cached attributes of the currently approved friends, in this case
+
+    [{"name" => "Miki Bergin", "picture" => "http://picturez.com/miki.jpg", "id" => 2}] 
+
+
+### Check Friendship
+
+    @user1.is_friends_with?(@user2) #= true
+    @user1.is_friends_with?(@user3) #= false
+
+### Unfriend
+
+    @user1.unfriend(@user2)
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/friendis/fork )
+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 @@
+require "bundler/gem_tasks"

data/friendis.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'friendis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "friendis"
+  spec.version       = Friendis::VERSION
+  spec.authors       = ["Elad Meidar"]
+  spec.email         = ["elad@eizesus.com"]
+  spec.summary       = "Friendis implements friendship relationship between objects on Redis"
+  spec.description   = "Friendis keeps all your friends close by!"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency 'redis'
+end

data/lib/friendis/configuration.rb

@@ -0,0 +1,6 @@
+module Friendis
+  class Configuration
+    attr_accessor :redis_connection
+    
+  end
+end

data/lib/friendis/friendable.rb

@@ -0,0 +1,127 @@
+module Friendis
+  module Friendable
+    def self.included(base)
+      base.class_eval do
+
+        include InstanceMethods
+        extend  ClassMethods
+
+        after_save :_update_friendis_meta_data
+        after_destroy :clear_friendis_data
+
+        @friendis_fields
+      end
+
+    end
+
+    module ClassMethods
+      
+      # Mark the list of fields to track in redis for fast access.
+      def friend_this(options = {})
+        configuration = {
+          track: [:id]
+        }.merge(options)
+        configuration[:track] << :id
+        self.friendis_fields = configuration[:track]
+      end
+
+      # Set trackable fields
+      def friendis_fields=(new_field_list)
+        @friendis_fields = new_field_list
+      end
+
+      # Retrieve trackable fields
+      def friendis_fields
+        @friendis_fields ||= []
+      end
+
+    end
+
+    module InstanceMethods 
+
+      
+
+      def get_friendis_meta(uuid = nil)
+        Friendis.redis.hgetall friendis_meta_key(uuid)
+      end
+
+      def send_friend_request(friend)
+        Friendis.redis.multi do
+          Friendis.redis.sadd friendis_outgoing_friend_requests_key, friend.id.to_s
+          Friendis.redis.sadd friend.friendis_incoming_friend_requests_key, self.id.to_s
+        end
+      end
+
+      def approve_friend_request(friend)
+        if !(Friendis.redis.sismember(friendis_incoming_friend_requests_key, friend.id.to_s))
+          return false
+        else
+          Friendis.redis.multi do
+            Friendis.redis.srem friend.friendis_outgoing_friend_requests_key, self.id.to_s
+            Friendis.redis.srem friendis_incoming_friend_requests_key, friend.id.to_s
+            Friendis.redis.sadd friendis_my_friends_key, friend.id.to_s
+            Friendis.redis.sadd friend.friendis_my_friends_key, self.id.to_s
+          end
+          return true
+        end
+      end
+
+      def unfriend(friend)
+        Friendis.redis.multi do
+          Friendis.redis.srem friendis_my_friends_key, friend.id
+          Friendis.redis.srem friend.friendis_my_friends_key, self.id
+        end
+      end
+
+      def friends
+        Friendis.redis.smembers(friendis_my_friends_key).collect {|friend_id| get_friendis_meta(friend_id)}
+      end
+
+      def is_friends_with?(friend)
+        Friendis.redis.sismember friendis_my_friends_key, friend.id.to_s
+      end
+
+      def pending_friend_requests
+        Friendis.redis.smembers(friendis_incoming_friend_requests_key).collect {|friend_id| get_friendis_meta(friend_id)}
+      end
+
+      def sent_friend_requests
+        Friendis.redis.smembers(friendis_outgoing_friend_requests_key).collect {|friend_id| get_friendis_meta(friend_id)}
+      end
+
+      def clear_friendis_data
+        [friendis_meta_key, friendis_my_friends_key, friendis_incoming_friend_requests_key, friendis_outgoing_friend_requests_key].each do |friendis_key|
+          Friendis.redis.del friendis_key
+        end
+      end
+
+      def _update_friendis_meta_data
+        Friendis.redis.multi do
+          attr_hash = {}
+
+          self.class.friendis_fields.each do |field|
+            attr_hash[field] = self.send(field)
+          end
+          Friendis.redis.hmset friendis_meta_key, *attr_hash.to_a
+        end
+        true
+      end
+
+      def friendis_meta_key(uuid = nil)
+        "#{self.class.name.downcase}:#{uuid || self.id}:friendis_meta"
+      end
+
+      def friendis_my_friends_key
+        "#{self.class.name.downcase}:#{self.id}:friends"
+      end
+
+      def friendis_incoming_friend_requests_key
+        "#{self.class.name.downcase}:#{self.id}:friend_requests"
+      end
+
+      def friendis_outgoing_friend_requests_key
+        "#{self.class.name.downcase}:#{self.id}:requested_friendship"
+      end
+    end
+  end
+end

data/lib/friendis/version.rb

@@ -0,0 +1,3 @@
+module Friendis
+  VERSION = "0.0.1"
+end

data/lib/friendis.rb

@@ -0,0 +1,20 @@
+require 'redis'
+require "friendis/version"
+require 'friendis/configuration'
+require 'friendis/friendable'
+
+module Friendis
+
+  attr_reader :configuration
+
+  def self.configure(&block)
+    @configuration = Friendis::Configuration.new
+    yield(@configuration)
+  end
+
+  def self.redis
+    @configuration.redis_connection ||= Redis.new
+  end
+
+  # Your code goes here...
+end

data/spec/friendis_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Friendis do
+  
+  describe '#configure' do
+
+    it "should respond to #configure" do
+      Friendis.should respond_to(:configure)
+    end
+  end
+
+  describe "#redis" do
+    it "should return a default connection if no redis connection specified in configuration" do
+      Friendis.configure do |c|
+        c.redis_connection = nil
+      end
+      Friendis.redis.should_not be_nil
+    end
+
+  end
+
+end

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper.rb'
+
+describe Friendis::Configuration do
+
+  before(:each) do
+    @configuration = Friendis::Configuration.new
+  end
+
+  describe "#redis_connection" do
+    it "should have accessors for #redis_connection" do
+      @configuration.should respond_to(:redis_connection)
+      @configuration.should respond_to(:redis_connection=)
+    end
+  end
+
+end

data/spec/lib/friendable_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'models/user'
+
+describe Friendis::Friendable do
+
+  describe "#send_friend_request" do
+    before(:each) do 
+      @user1 = User.new(1)
+      @user2 = User.new(2)
+      @user1.clear_friendis_data
+      @user2.clear_friendis_data
+
+      @user1.save
+      @user2.save
+      @user1.send_friend_request(@user2)
+    end
+
+    it "should indicate a friend request was sent" do
+      @user1.sent_friend_requests.should_not be_empty
+      @user1.sent_friend_requests.first["name"].should eq(@user2.name)
+    end
+
+    it "should indicate an incoming friend request" do
+      @user2.pending_friend_requests.should_not be_empty
+    end
+  end
+
+  describe "#approve_friend_request" do
+    before(:each) do 
+      @user1 = User.new(1)
+      @user2 = User.new(2)
+      @user1.clear_friendis_data
+      @user2.clear_friendis_data
+
+      @user1.save
+      @user2.save
+      @user1.send_friend_request(@user2)
+    end
+
+    it "should show friend on friends list after approval" do
+      @user2.approve_friend_request(@user1).should be_truthy
+      @user2.friends.first["name"].should eq(@user1.name)
+      @user1.friends.first["name"].should eq(@user2.name)
+    end
+  end
+
+  describe "#unfriend" do
+    before(:each) do 
+      @user1 = User.new(1)
+      @user2 = User.new(2)
+      @user1.clear_friendis_data
+      @user2.clear_friendis_data
+
+      @user1.save
+      @user2.save
+      @user1.send_friend_request(@user2)
+      @user2.approve_friend_request(@user1)
+    end
+
+    it "should show friend on friends list after approval" do
+      @user1.unfriend(@user2).should be_truthy
+      @user1.friends.should be_empty
+      @user2.friends.should be_empty
+    end
+  end
+
+  describe "#is_friends_with?" do
+    before(:each) do 
+      @user1 = User.new(1)
+      @user2 = User.new(2)
+      @user3 = User.new(3)
+
+      @user1.clear_friendis_data
+      @user2.clear_friendis_data
+      @user3.clear_friendis_data
+
+      @user1.save
+      @user2.save
+      @user3.save
+
+      @user1.send_friend_request(@user2)
+      @user2.approve_friend_request(@user1)
+    end
+
+    it "should return true if users are friends" do
+      @user1.is_friends_with?(@user2).should be_truthy
+    end
+
+    it "should return false if users aren't friends" do
+      @user1.is_friends_with?(@user3).should be_falsy
+    end
+
+  end
+
+end

data/spec/models/user.rb

@@ -0,0 +1,39 @@
+class User
+
+  @after_save_method = nil
+
+  def User.after_save(method)
+    @after_save_method = method
+  end
+
+  def User.after_destroy(method)
+  end
+  
+  include Friendis::Friendable
+
+  attr_accessor :id, :name, :picture
+
+  
+
+  friend_this track: [:name, :picture]
+
+  
+
+  def User.after_save_method
+    @after_save_method
+  end
+
+  def initialize(id)
+    @id = id
+    @name = "Test #{rand(9000)+ 1000}"
+    @picture = "http:/picturez.com/user/#{id}.jpg"
+  end
+
+  def save
+    self.send(User.after_save_method)
+  end
+
+  def after_save(method)
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'friendis' # and any other gems you need
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: friendis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elad Meidar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Friendis keeps all your friends close by!
+email:
+- elad@eizesus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- friendis.gemspec
+- lib/friendis.rb
+- lib/friendis/configuration.rb
+- lib/friendis/friendable.rb
+- lib/friendis/version.rb
+- spec/friendis_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/friendable_spec.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Friendis implements friendship relationship between objects on Redis
+test_files:
+- spec/friendis_spec.rb
+- spec/lib/configuration_spec.rb
+- spec/lib/friendable_spec.rb
+- spec/models/user.rb
+- spec/spec_helper.rb