soc_med 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9e72d4977e041a7094a05d9159bdc904a2d962f69cbf4488c8e1deb3affca9a
+  data.tar.gz: 69fa2e2a15ccab49f551997505d5613d971227bea7fe78d9f025d86e9d9b2902
+SHA512:
+  metadata.gz: 46b00d2074041e967eedb6cd6fdf21ffe1c98bac9f7bcf2a95c53aa623445daf32bfcf2000a8b678969e07fbaf4ef1acde5f36273e82ab675b4ae1d72a0225c9
+  data.tar.gz: eab8bf92c6315a2e6a73c75e98482158f8b4b18be80c4387ab5678f885f39b6f8fb777af8cf0bb070743caa476c6fa2c1ce143ab83b0ef6d4313a05e5b6d511b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Mike Heft
+
+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,148 @@
+# SocMed
+![Gem](https://img.shields.io/gem/dt/soc_med?style=plastic)
+![Gem](https://img.shields.io/gem/v/soc_med?style=plastic)
+
+SocMed adds SOCial MEDia functionality such as liking, following, reporting, and blocking to your Rails application.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soc_med'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install soc_med
+```
+
+After installing the gem in your application, you need to copy the migrations from the gem to your application:
+```bash
+$ rails soc_med:install:migrations
+```
+
+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.
+
+
+## Usage
+
+#### Mount the gem
+```ruby
+# 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.
+
+#### Include the relevant modules
+
+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.
+
+```ruby
+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.
+
+#### Creating SocMed Objects
+
+Simply send `POST` or `DELETE` requests with the the relevant top level key, ie:
+
+```json
+{
+  "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
+    
+```json
+{
+    "message": null,
+    "like": {
+        "owner_id": 1,
+        "owner_type": "user",
+        "target_type": "item",
+        "target_id": 1
+    }
+}
+```
+
+For errors, the return will be formatted as:
+```json
+{
+  "message": "Error message/object"
+}
+``` 
+
+
+
+
+
+## Contributing
+Coming Soon
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=4MFMTB9YYQFR8)

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SocMed'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/soc_med_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/soc_med .css

data/app/assets/stylesheets/soc_med/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/blueprints/base_blueprint.rb

@@ -0,0 +1,6 @@
+require 'blueprinter'
+
+class BaseBlueprint < Blueprinter::Base
+  identifier :id
+  fields :owner_id, :owner_type, :target_id, :target_type
+end

data/app/blueprints/blocks/overview_blueprint.rb

@@ -0,0 +1,7 @@
+require_relative '../base_blueprint'
+
+module Blocks
+  class OverviewBlueprint < BaseBlueprint
+
+  end
+end

data/app/blueprints/follows/overview_blueprint.rb

@@ -0,0 +1,7 @@
+require_relative '../base_blueprint'
+
+module Follows
+  class OverviewBlueprint < BaseBlueprint
+
+  end
+end

data/app/blueprints/likes/overview_blueprint.rb

@@ -0,0 +1,7 @@
+require_relative '../base_blueprint'
+
+module Likes
+  class OverviewBlueprint < BaseBlueprint
+
+  end
+end

data/app/blueprints/reports/overview_blueprint.rb

@@ -0,0 +1,7 @@
+require_relative '../base_blueprint'
+
+module Reports
+  class OverviewBlueprint < BaseBlueprint
+
+  end
+end

data/app/controllers/soc_med/application_controller.rb

@@ -0,0 +1,24 @@
+require 'dry_serialization/blueprinter'
+
+module SocMed
+  class ApplicationController < ActionController::Base
+    include DrySerialization::Blueprinter
+    protect_from_forgery unless: -> { request.format.json? }
+
+    def error_response(error)
+      default_response = default_response(error)
+      render json: default_response
+    end
+
+    def success_response(data, message = nil)
+      default_response = default_response(message, data)
+      render json: default_response
+    end
+
+    private
+
+    def default_response(message, data = {})
+      { message: message }.merge(data)
+    end
+  end
+end

data/app/controllers/soc_med/blocks_controller.rb

@@ -0,0 +1,28 @@
+require 'soc_med/services/blocks/create'
+require 'soc_med/services/blocks/destroy'
+require_relative '../../blueprints/blocks/overview_blueprint'
+
+module SocMed
+  class BlocksController < ApplicationController
+    def create
+      block_service::Create.call(params) do |success, failure|
+        success.call { |object| success_response(block: serialized_resource(object, ::Blocks::OverviewBlueprint)) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    def destroy
+      block_service::Destroy.call(params) do |success, failure|
+        success.call { success_response(block: { destroyed: true }) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    private
+
+    def block_service
+      SocMed::Services::Blocks
+    end
+
+  end
+end

data/app/controllers/soc_med/follows_controller.rb

@@ -0,0 +1,28 @@
+require 'soc_med/services/follows/create'
+require 'soc_med/services/follows/destroy'
+require_relative '../../blueprints/follows/overview_blueprint'
+
+module SocMed
+  class FollowsController < ApplicationController
+    def create
+      follow_service::Create.call(params) do |success, failure|
+        success.call { |object| success_response(follow: serialized_resource(object, ::Follows::OverviewBlueprint)) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    def destroy
+      follow_service::Destroy.call(params) do |success, failure|
+        success.call { success_response(follow: { destroyed: true }) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    private
+
+    def follow_service
+      SocMed::Services::Follows
+    end
+
+  end
+end

data/app/controllers/soc_med/likes_controller.rb

@@ -0,0 +1,28 @@
+require 'soc_med/services/likes/create'
+require 'soc_med/services/likes/destroy'
+require_relative '../../blueprints/likes/overview_blueprint'
+
+module SocMed
+  class LikesController < ApplicationController
+    def create
+      like_service::Create.call(params) do |success, failure|
+        success.call { |object| success_response(like: serialized_resource(object, ::Likes::OverviewBlueprint)) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    def destroy
+      like_service::Destroy.call(params) do |success, failure|
+        success.call { success_response(like: { destroyed: true }) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    private
+
+    def like_service
+      SocMed::Services::Likes
+    end
+
+  end
+end

data/app/controllers/soc_med/reports_controller.rb

@@ -0,0 +1,29 @@
+require 'soc_med/services/reports/create'
+require 'soc_med/services/reports/destroy'
+require_relative '../../blueprints/reports/overview_blueprint'
+
+
+module SocMed
+  class ReportsController < ApplicationController
+    def create
+      report_service::Create.call(params) do |success, failure|
+        success.call { |object| success_response(report: serialized_resource(object, ::Reports::OverviewBlueprint)) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    def destroy
+      report_service::Destroy.call(params) do |success, failure|
+        success.call { success_response(report: { destroyed: true }) }
+        failure.call(&method(:error_response))
+      end
+    end
+
+    private
+
+    def report_service
+      SocMed::Services::Reports
+    end
+
+  end
+end

data/app/errors/soc_med/base.rb

@@ -0,0 +1,4 @@
+module SocMed
+  class Base < StandardError
+  end
+end

data/app/errors/soc_med/blocks/already_exists_error.rb

@@ -0,0 +1,7 @@
+module SocMed
+  module Follows
+    class AlreadyExistsError < Base
+    end
+
+  end
+end

data/app/errors/soc_med/follows/already_exists_error.rb

@@ -0,0 +1,7 @@
+module SocMed
+  module Follows
+    class AlreadyExistsError < Base
+    end
+
+  end
+end

data/app/errors/soc_med/likes/already_exists_error.rb

@@ -0,0 +1,7 @@
+module SocMed
+  module Likes
+    class AlreadyExistsError < Base
+    end
+
+  end
+end