SocMed

SocMed adds SOCial MEDia functionality such as liking, following, reporting, and blocking to your Rails application.

Add this line to your application's Gemfile:

gem 'soc_med'

And then execute:

$ bundle

Or install it yourself as:

$ gem install soc_med

After installing the gem in your application, you need to copy the migrations from the gem to your application:

$ rails g soc_med:install

Once the migrations are copied, you can delete any that you do not currently need in your application. If you later decide that you want those models/functionality, you can simply rerun the above command to recopy the missing migrations.

# config/routes.rb

Rails.application.routes.draw do
  mount SocMed::Engine => '/soc_med'
end

• The Services used to create the social media objects, are available if you do not wish to use the engine's controllers through the mount method.

To use the relationships in your models, you must include the modules in the owner and target classes. For example, a User is able to 'follow' other users and 'like' an Item.

class User < ApplicationRecord
  include SocMed::Concerns::Likeable
  include SocMed::Concerns::Follwable
  include SocMed::Concerns::Blockable
  include SocMed::Concerns::Reportable

  likeable :items
  followable :users
  follower :users
  reportable :users, :items
  ...
end

class Item < ApplicationRecord
  include SocMed::Concerns::Likeable
  include SocMed::Concerns::Follwable
  include SocMed::Concerns::Blockable
  include SocMed::Concerns::Reportable
  
  liker :users
  reporter :users
  ...
end 

You can omit any module that you do not want in the respective model. The class methods called in the models provide the required relationships, ie:

• A User is able to 'like' an Item and Post
  • likeable :items, :posts
  • This provides the following relationships to differentiate the liked models if required. Otherwise, you may just use the likeable_objects relationship.
    • has_many :liked_items
    • has_many :liked_posts
• An Item is able to be 'liked' by a user
  • liker :users, :admins
  • This provides the following relationships like above to separate the collection types or you may use the likes relationship
    • has_many :liked_by_users
    • has_many :liked_by_admins
• The liked_ and liked_by_ relationships are an example. With the other available modules, the respective names will be interpolated if and when you provide the symbols as arguments to the class methods.

Simply send POST or DELETE requests with the the relevant top level key, ie:

{
  "like": {
    "owner_id": 1,
    "owner_type": "user",
    "target_id": 1,
    "target_type": "item"
  }
}

With "like" being substituted for the relevant SocMed module: like, follow, block, report

• Routes for each are:
  • Like
    • /likes
  • Follow
    • follows
  • Block
    • /blocks
  • Report
    • /reports
• The return for each is serialized json, with the top level kep changing depending on the object you're creating

{
    "message": null,
    "like": {
        "owner_id": 1,
        "owner_type": "user",
        "target_type": "item",
        "target_id": 1
    }
}

For errors, the return will be formatted as:

{
  "message": "Error message/object"
}

Coming Soon

The gem is available as open source under the terms of the MIT License.