social_nets_db 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0f34a54ddd600c3eca0d252f6268ccbf1e1218a759cd6e45480e9ec0a861739
+  data.tar.gz: c710e00c6e326708c27e635328bf31716c74dbe21e7b29f4b66dd0d40ff03ee0
+SHA512:
+  metadata.gz: 528c882f2b6e55a309493fd44577b3e0fa4629035b9cf9cb582d84f7a1ac9ce58d023e9ba9f481cb958022bcb446d71ab206d78a9fbaf96f5ff5b90fc4a69c1f
+  data.tar.gz: bcf8336c308bd6f60b3702380d2c059f360c9ade03fcea818c4e27855172c2ae1f0a45191258ae7084e426745a57d9e1590815379aadc79b57a339206b82a4f5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    social_nets_db (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bundler-audit (0.9.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.0.3.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.14.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-17
+
+DEPENDENCIES
+  bundler (>= 2, < 3)
+  bundler-audit (>= 0.9, < 1)
+  pry (< 1)
+  pry-byebug (~> 3)
+  rake (~> 13)
+  rspec (~> 3)
+  rubocop (~> 1)
+  social_nets_db!
+
+BUNDLED WITH
+   2.2.27

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Sergey Pedan
+
+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,325 @@
+# Social nets DB
+
+## Installation
+
+```ruby
+gem "social_nets_db"
+```
+
+
+## Internals
+
+It stores data about social nets in a Ruby hash like so:
+
+```yaml
+-
+  name: Behance
+  uid: behance
+  icons:
+    font_awesome: "behance"
+  color: "#1769ff"
+  url: behance.com
+  tags:
+    - recruiting
+    - art
+    - design
+  profile_url:
+    by_username: https://behance.com/${username}
+    by_account_id: "https://behance.com/${account_id}"
+```
+
+[Peek into the source](https://github.com/sergeypedan/social-nets-db/blob/master/lib/social_net_db/db.yml).
+
+Everything else is just helpers around this simple DB: finders, accessors & view helpers.
+
+
+## Usage
+
+There are 2 primary use cases for this gem:
+
+### 1. To help create lists of links to social net accounts
+
+Like in the footer of a website:
+
+```ruby
+ruby:
+  accounts = [
+    { net_uid: "instagram", username: "dhh" },
+    { net_uid: "facebook",  username: "d-h-h" },
+    { net_uid: "twitter",   username: "d_h_h" },
+    { net_uid: "upwork",    account_id: "401298374012374" }
+  ]
+
+ul
+  - accounts.each do |account|
+    - net = SocialNetsDB.find account[:net_uid]
+    li
+      = fa_icon net.icons["font_awesome"], style: "color: #{net.color}"
+      =< link_to net.name, \
+                 net.user_page(username: account[:username], account_id: account[:account_id]), \
+                 target: "_blank", \
+                 rel: "noopener noreferrer"
+```
+
+Here the gem:
+
+- builds the URL to user page
+
+	```ruby
+	net.user_page(username: account[:username])
+	# "https://facebook.com/dhh"
+	```
+
+- gives you the correct name of the social net
+
+	```ruby
+	net.name
+	# "Facebook"
+	```
+
+### 2. To help building a `<select>` with social nets when storing user's account link
+
+```ruby
+= form_for @user do |f|
+  = f.fields_for :social_net_accounts do |sna|
+    .form-group
+      = sna.label  :social_net_uid, class: "control-label"
+      = sna.select :social_net_uid, SocialNetsDB.values_for_select, {}, class: "form-control"
+```
+
+which produces
+
+```html
+<form action="/users" method="POST">
+  <div class="form-group">
+    <label for="user_social_net_accounts_attributes_123_social_net_uid">Social net UID</label>
+    <select required="required" class="form-control" name="user[social_net_accounts_attributes][123][social_net_uid]">
+      <option value="">Choose a social net:</option>
+      <option value="behance">Behance</option>
+      <option value="dribble">Dribble</option>
+      <option value="facebook">Facebook</option>
+      <!-- ... -->
+    </select>
+  </div>
+</form>
+```
+
+See section “[Using with Rails](#use-with-rails)” below for more details.
+
+
+## API
+
+### Instance of `SocialNetsDB` class
+
+Initialize an instance with social net UID.
+
+```ruby
+social_net = SocialNetsDB.find("facebook")
+# => #<SocialNetsDB:0x00007fddc0041b40 @uid="facebook">
+```
+
+Which are supported UIDs?
+
+```ruby
+SocialNetsDB.uids
+#=> [
+#    "behance",
+#    "dribble",
+#    "facebook",
+#    "fl.ru",
+#    "freelansim",
+#    "habr",
+#    "github",
+#    "instagram",
+#    "livejournal",
+#    "linkedin",
+#    "medium",
+#    "my.mail.ru",
+#    "odnoklassniki",
+#    "stackoverflow",
+#    "telegram",
+#    "twitter",
+#    "upwork",
+#    "vkontakte",
+#    "youtube"
+#  ]
+```
+
+If you try to initialize with an unsupported UID, and you will also get the list along with an Exception:
+
+```ruby
+SocialNetsDB.find("diaspora")
+# ArgumentError (Social net with UID test is not supported.
+#
+# Currently supported UIDs are: behance, dribble, facebook, github, instagram, livejournal, linkedin, medium, my.mail.ru, odnoklassniki, stackoverflow, telegram, twitter, vkontakte, youtube)
+```
+
+### find_by
+
+If you don't want to rescue exceptions while initializing, you can use `find_by(uid:)` instead.
+
+It returns an instance:
+
+```ruby
+SocialNetsDB.find_by(uid: "facebook")
+# => #<SocialNetsDB:0x00007fddc0041b40 @uid="facebook">
+```
+
+or `nil`:
+
+```ruby
+SocialNetsDB.find_by(uid: "blabla")
+# => nil
+```
+
+### Data
+
+```ruby
+social_net.to_h
+# => {
+#      name:  "Facebook",
+#      uid:   "facebook",
+#      fa_id: "facebook",
+#      color: "crimson",
+#      url:  "https://facebook.com",
+#      user_page: {
+#        by_username:   "https://facebook.com/${username}",
+#        by_account_id: "https://facebook.com/${account_id}",
+#        methods:       [:account_id, :username]
+#      }
+#    }
+```
+
+### Property accessors
+
+```ruby
+social_net.color       #=> "#3C5A99"
+social_net.fa_icon_id  #=> "facebook"
+social_net.name        #=> "Facebook"
+social_net.uid         #=> "facebook"
+social_net.url         #=> "https://facebook.com"
+```
+
+### FontAwesome icon
+
+Assumes you have [FontAwesome](https://fontawesome.com/v4.7.0/) installed. Just builds the HTML tag.
+
+```ruby
+social_net.fa_icon
+#=> <span class="fa fa-facebook" style="color: #3C5A99"></span>
+```
+
+It accepts a Hash with attributes, like Rails `tag_helper` (but not for `data: {}` — maybe later):
+
+```ruby
+social_net.fa_icon(class: "fa-fw", id: "my-id", style: "margin-top: 10px")
+#=> <span class="fa fa-facebook fa-fw" style="color: #3C5A99; margin-top: 10px;" id="my-id"></span>
+```
+
+Exporting social net brand color to `styles` attribute can be turned off by passing `color: false` Hash pair among others:
+
+```ruby
+social_net.fa_icon(color: false, class: "fa-fw", id: "my-id", style: "margin-top: 10px")
+#=> <span class="fa fa-facebook fa-fw" style="cmargin-top: 10px;" id="my-id"></span>
+```
+
+### User's page URL
+
+```ruby
+social_net.user_page(username: "dhh")              #=> "https://facebook.com/dhh"
+social_net.user_page(account_id: "id1234566789")   #=> "https://facebook.com/account/id1234566789"
+```
+
+If you pass a username, whild the `SocialNet` supports user page URLs only via account ids, the method call will return `nil`.
+
+You can check which is supported
+
+```ruby
+social_net.user_page_methods  #=> [:account_id, :username]
+```
+
+
+## Use with Rails
+
+This gem is Rails-agnostic, but you can use it in Rails like so:
+
+### Forms
+
+```ruby
+= form_for @user do |f|
+  = f.fields_for :social_net_accounts do |sna|
+    .form-group
+      = sna.label  :social_net_uid, class: "control-label"
+      = sna.select :social_net_uid, SocialNetsDB.values_for_select, {}, class: "form-control"
+```
+
+because
+
+```ruby
+SocialNetsDB.values_for_select
+#=> [
+#     ["Behance",       "behance"],
+#     ["Dribble",       "dribble"],
+#     ["Facebook",      "facebook"],
+#     ["GitHub",        "github"],
+#     ["Instagram",     "instagram"],
+#     ["LiveJournal",   "livejournal"],
+#     ["LinkedIn",      "linkedin"],
+#     ["Medium",        "medium"],
+#     ["Мой мир",       "my.mail.ru"],
+#     ["Одноклассники", "odnoklassniki"],
+#     ["StackOverflow", "stackoverflow"],
+#     ["Telegram",      "telegram"],
+#     ["Twitter",       "twitter"],
+#     ["Вконтакте",     "vkontakte"],
+#     ["YouTube",       "youtube"]
+#  ]
+```
+
+### Models
+
+```ruby
+model User < ApplicationRecord
+  has_many :social_net_accounts
+end
+```
+
+```ruby
+model SocialNetAccount < ApplicationRecord
+  belongs_to :user
+
+  validates :account_id,     presence: true, if: Proc.new { |record| record.username.blank? }
+  validates :social_net_uid, presence: true, inclusion: { in: SocialNetsDB.uids }
+  validates :username,       presence: true, if: Proc.new { |record| record.account_id.blank? }
+
+  def social_net
+    @social_net ||= SocialNetsDB.find(self.social_net_uid)
+  end
+
+  def user_page
+    social_net.user_page(username: self.username, account_id: self.account_number)
+  end
+
+  #  id              :bigint  not null, primary key
+  #  user_id         :bigint  not null
+  #  account_id      :string            example: `id1230948712034871`
+  #  social_net_uid  :string  not null  example: `facebook`, `vkontakte`
+  #  username        :string            example, `tenderlove`
+  #  userpic_url     :string
+end
+```
+
+It's probably better to move those 2 methods into a decorator — here they are in the model just for brevity.
+
+```ruby
+SocialNetAccount.create(user_id: User.first.id, social_net_uid: "facebook", username: "tenderlobe")
+```
+
+```ruby
+@user.social_net_accounts.first.user_page  #=> "https://facebook.com/tenderlove"
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/audit/task"
+  require "rspec/core/rake_task"
+  require "rubocop/rake_task"
+
+  Bundler::Audit::Task.new
+  RSpec::Core::RakeTask.new(:spec)
+  RuboCop::RakeTask.new
+rescue LoadError => e
+  puts e.message
+end
+
+desc "Run code quality checks"
+task code_quality: %i[bundle:audit rubocop]
+
+task default: %i[code_quality spec]