bfriend 0.7.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 622e58967a1a4efcec7f98f6e09d07b32870dca5
+  data.tar.gz: 7bf237f63837034e035fa657b49a8e1e55fe0519
+SHA512:
+  metadata.gz: 62ad98686710315b30cc7b1ba61519545cafc919251145af521e1e512b53d536a9e3cc680446671dc36f1ae9d4cae2240c868c69de50153b925972211bdeb7fb
+  data.tar.gz: 1be1b815d8930aff9056de13e4eb0f5e41d7c451aa692b2673a73400bedb5c5c23c403f077bb0453393dac7335d870bd244125986b1dc490d283c80a32de6465

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/XFinger/bfriend" }
+
+# Specify your gem's dependencies in bfriend.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 xfinger
+
+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,57 @@
+
+
+I often need friendship modeling for projects so I created a generator to get up and running quickly. 
+This is a simple generator for creating a Self-Referential Association for a friendship model. Heavily based on [Ryan Bates rails cast #163](http://railscasts.com/episodes/163-self-referential-association) with some help from [this guy on github](https://github.com/tobyond?tab=repositories). It isn't particularly sophisticated or polished and doesn't include any tests so use at your own risk. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bfriend'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install bfriend
+
+## Usage
+
+Run the bfriend generator `rails g bfriend -t --api`. This will generate a friendship model, a migration, add routes & associations to your user model and generate a friendship controller suitable for use in an API.
+
+If you are using  the gem for a ruby on rails project, run `rails g bfriend -t --ror` .
+
+Edit the migration to give the status a default of false 
+
+    t.boolean :accepted, default: false" 
+
+Run your migration 
+
+Now you can:
+
+    request friendship:          Friendship.create( user_id: id, friend_id: id )
+    accept friendship:           Friendship.update( status: true )
+    decline friendship:          Friendship.delete
+    end friendship:              Friendship.delete
+    all friends:                 user.friends
+    all requests:                user.pending
+    friend_requests:             user.pending_friends
+    requested_friends:           user.requested_friends
+    friendship by user:          user.current_friends
+    friendship by friend:        user.bfriended_friends
+    
+
+At this time no view templates are created and I will update this readme when and if I add them.
+ 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/XFinger/bfriend.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bfriend.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bfriend/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bfriend"
+  spec.version       = Bfriend::VERSION
+  spec.authors       = ["xfinger"]
+  spec.email         = ["xfinger@gmail.com"]
+
+  spec.summary       = %q{A simple friendship model}
+  spec.description   = %q{Based on Railscasts #163 Self-Referential Association}
+  spec.homepage      = "https://github.com/XFinger/bfriend"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bfriend"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bfriend.rb

@@ -0,0 +1,5 @@
+require "bfriend/version"
+
+module Bfriend
+
+end

data/lib/bfriend/version.rb

@@ -0,0 +1,5 @@
+require "bfriend/version"
+
+module Bfriend
+  VERSION = "0.7.3"
+end

data/lib/generators/bfriend/bfriend_generator.rb

@@ -0,0 +1,69 @@
+require 'rails/generators/base' 
+require 'rails/generators/migration'      
+require 'rails/generators/active_record'
+
+class BfriendGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  include Rails::Generators::Migration
+  class_option :controller_template, :type => :string, :aliases => "-t", :desc => "Template engine for the Controller. Available options are 'api' and 'ror'.", :default => "api"
+  class_option :ror, :type => :boolean, :default => false
+      
+      
+  # Implement the required interface for Rails::Generators::Migration
+  def self.next_migration_number(dirname)
+    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def add_route  
+    route "resources :friendships, only: [:create, :update, :destroy]"
+  end 
+
+
+  def add_to_user
+   inject_into_file 'app/models/user.rb', before: "end"  do  
+        "
+         has_many :friendships
+         has_many :bfriended_friendships, :class_name => \"Friendship\", :foreign_key => \"friend_id\"
+
+         # bfriended by user
+         has_many :current_friends,       -> { where(friendships: { status: true}) }, through: :friendships, source: :friend
+         # bfriended by friend
+	       has_many :bfriended_friends,     -> { where(friendships: { status: true}) }, through: :bfriended_friendships, source: :user
+         # requested by friend
+	       has_many :requested_friends, -> { where(friendships: { status: false}) }, through: :bfriended_friendships, source: :user 
+         # requested by user
+         has_many :pending_friends,       -> { where(friendships: { status: false}) }, through: :friendships, source: :friend
+         \n
+        
+         # combine the sets to see all your friends
+      	 def friends
+	          current_friends | bfriended_friends
+	       end
+
+         # combine the sets to see pending and requested friendships
+         def pending
+		       pending_friends | requested_friends
+	       end
+        
+         \n 
+        "
+       
+    end
+  end
+    
+  def copy_templates
+    template "model.rb", "app/models/friendship.rb"
+    if options[:controller_template].to_s == "ror"  or options[:ror]
+      template "ror_controller.rb", "app/controllers/friendships_controller.rb"
+    else 
+      template "api_controller.rb", "app/controllers/friendships_controller.rb"
+    end
+  end 
+
+  def generate_migration #after generating the migration, add 'default: false' to status
+    generate "migration", "create_friendships user_id:integer friend_id:integer status:boolean "
+  end
+   
+end

data/lib/generators/bfriend/templates/api_controller.rb

@@ -0,0 +1,46 @@
+class FriendshipsController < ApplicationController
+before_action :set_friendship, only: [:destroy]
+
+def create
+  @friendship = current_user.friendships.build(:friend_id => params[:friend_id])
+  if @bfriend.save
+      render json: @friend, status: :created, location: @friend
+  else
+      render json: @friend.errors, status: :unprocessable_entity
+  end
+end
+
+def destroy  
+    @friendship.destroy
+end
+
+def update
+	@friendship = Friendship.find_by(id: params[:id])
+	@friendship.update(status: "true")
+	  if @friendship.save
+	    render json: @friend, status: :updated, location: @friend
+	  else
+	    render json: @friend.errors, status: :unprocessable_entity
+	  end
+end
+
+  
+def destroy
+  @friendship = current_user.friendships.find(params[:id])
+  @friendship.destroy
+end
+
+private
+  # Use callbacks to share common setup or constraints between actions.
+  def set_friendship
+    @friend = friend.find(params[:id])
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  def friend_params
+    params.require(:friend).permit(:user_id)
+  end
+end
+
+
+ 

data/lib/generators/bfriend/templates/model.rb

@@ -0,0 +1,8 @@
+
+class Friendship < ApplicationRecord
+  
+  belongs_to :user
+  belongs_to :friend, :class_name => 'User'
+
+
+end

data/lib/generators/bfriend/templates/ror_controller.rb

@@ -0,0 +1,48 @@
+class FriendshipsController < ApplicationController
+  before_action :set_friendship, only: [:destroy]
+
+ def create
+	  @friendship = current_user.friendships.build(friend_id: params[:friend_id])
+	  if @friendship.save
+	    flash[:notice] = "Friend requested."
+	    redirect_to :back
+	  else
+	    flash[:error] = "Friend request didn't work"
+	    redirect_to :back
+	  end
+	end
+
+	def update
+	@friendship = Friendship.find_by(id: params[:id])
+	@friendship.update(status: "true")
+	  if @friendship.save
+	    redirect_to root_url, notice: "Friendship confirmed"
+	  else
+	    redirect_to root_url, notice: "Sorry! Could not confirm friendship!"
+	  end
+	end
+
+	def destroy
+	  @friendship = Friendship.find_by(id: params[:id])
+	  @friendship.destroy
+	  flash[:notice] = "Ended friendship."
+	  redirect_to :back
+	end
+
+  private
+  # Use callbacks to share common setup or constraints between actions.
+  def set_friendship
+    @friend = friend.find(params[:id])
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  def friend_params
+    params.require(:friend).permit(:user_id)
+  end
+
+end
+
+
+
+
+ 

data/lib/generators/bfriend/tmp.rb

@@ -0,0 +1,15 @@
+	has_many :friendships
+	has_many :received_friendships, class_name: "Friendship", foreign_key: "friend_id"
+
+	has_many :active_friends, -> { where(friendships: { accepted: true}) }, through: :friendships, source: :friend
+	has_many :received_friends, -> { where(friendships: { accepted: true}) }, through: :received_friendships, source: :user
+	has_many :pending_friends, -> { where(friendships: { accepted: false}) }, through: :friendships, source: :friend
+	has_many :requested_friendships, -> { where(friendships: { accepted: false}) }, through: :received_friendships, source: :user
+
+	def friends
+	  active_friends | received_friends
+	end
+
+	def pending
+		pending_friends | requested_friendships
+	end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: bfriend
+version: !ruby/object:Gem::Version
+  version: 0.7.3
+platform: ruby
+authors:
+- xfinger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'Based on Railscasts #163 Self-Referential Association'
+email:
+- xfinger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bfriend.gemspec
+- bin/console
+- bin/setup
+- lib/bfriend.rb
+- lib/bfriend/version.rb
+- lib/generators/bfriend/bfriend_generator.rb
+- lib/generators/bfriend/templates/api_controller.rb
+- lib/generators/bfriend/templates/model.rb
+- lib/generators/bfriend/templates/ror_controller.rb
+- lib/generators/bfriend/tmp.rb
+homepage: https://github.com/XFinger/bfriend
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.4
+signing_key: 
+specification_version: 4
+summary: A simple friendship model
+test_files: []