social_nets_db 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62d4c75398e3ad3aa5de120fb8d6712a7d993589a5d41770cbcc69bb2b292f6b
-  data.tar.gz: 9c13c27ba2d6d261b80cdb869f04940e4075a4d0ad07683f39f939e910598002
+  metadata.gz: b16ceb6656a59c747798848c9a99d8fd53c5db5fa903b1d2df388534a122cdc3
+  data.tar.gz: 4f2f515a1e9bf204a33cd01d274df52953db1d24e2a951cf70cbe7c7c4ad50a6
 SHA512:
-  metadata.gz: 49de6dc8f10faa23a5d78e8df0adc2b4f477d4dbbe0ffcab568810237a238466ce6ddcf5032348671a29bdd865e16cc2c09dcb87699b3d070290e15f4012fcbf
-  data.tar.gz: 37d1d959e60762d7b9f1fba82615443e71f12ab801516c149e0b1bce701e00bbb46a85ff744db56f443e16e7bf970c1404ea2d09d29cc74159ded0bf530f6ffa
+  metadata.gz: 3441ffff109b6b15a45a85be1100b235422f3dbd3ded19e099a7b3e18811a94226d06393e239052edbb7023b716b1c06c26063dc66ce4e5701f6f048e5f5cea1
+  data.tar.gz: 76791b05f97311c578435150d61c1780c3980ead21ac60c2cc938a22135bbeef36778f18120759ff2e51283568c783b1fe1897e3b1928a045460ef65dda161a7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.0.6] - 2021-12-03
+
+- Corrects data source of accessor methods
+
 ## [0.0.5] - 2021-12-03
 
 - Corrects an error in `uids`

data/README.md

@@ -1,5 +1,7 @@
 # Social nets DB
 
+[![Gem Version](https://badge.fury.io/rb/social_nets_db.svg)](https://badge.fury.io/rb/social_nets_db)
+
 ## Installation
 
 ```ruby
@@ -9,27 +11,24 @@ gem "social_nets_db"
 
 ## Internals
 
-It stores data about social nets in a Ruby hash like so:
+It stores data about popular social nets, video hostings etc. in a YAML file [`db.yml`](https://github.com/sergeypedan/social-nets-db/blob/master/lib/social_nets_db/db.yml):
 
 ```yaml
--
+behance:
   name: Behance
-  uid: behance
   icons:
-    font_awesome_4: "behance"
+    font_awesome_4: behance
   color: "#1769ff"
-  url: behance.com
+  domain: behance.com
   tags:
-    - recruiting
     - art
     - design
+    - recruiting
   profile_url:
-    by_username: https://behance.com/${username}
-    by_account_id: "https://behance.com/${account_id}"
+    by_username: "https://${domain}/${uid}"
+    by_account_id: "https://${domain}/${uid}"
 ```
 
-[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.
 
 
@@ -47,18 +46,20 @@ ruby:
     { 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" }
+    { net_uid: "upwork",    account_id: "401298374012374" },
+    { net_uid: "email",     username: "elon@musk.io" },
+    { net_uid: "website",   username: "musk.io" }
   ]
 
 ul
   - accounts.each do |account|
-    - net = SocialNetsDB.find account[:net_uid]
+    - net = SocialNetsDB::SocialNet.find account[:net_uid]
     li
-      = fa_icon net.icons["font_awesome_4"], style: "color: #{net.color}"
+      - fa_icon_uid = net.icons["font_awesome_4"] || "link"
+      = fa_icon fa_icon_uid, class: "fw", style: "color: #{net.color}"
       =< link_to net.name, \
                  net.user_page(username: account[:username], account_id: account[:account_id]), \
-                 target: "_blank", \
-                 rel: "noopener noreferrer"
+                 target: "_blank", rel: "noopener noreferrer"
 ```
 
 Here the gem:
@@ -66,15 +67,13 @@ Here the gem:
 - builds the URL to user page
 
 	```ruby
-	net.user_page(username: account[:username])
-	# "https://facebook.com/dhh"
+	net.user_page(username: account[:username]) #=> "https://facebook.com/dhh"
 	```
 
 - gives you the correct name of the social net
 
 	```ruby
-	net.name
-	# "Facebook"
+	net.name #=> "Facebook"
 	```
 
 ### 2. To help building a `<select>` with social nets when storing user's account link
@@ -84,7 +83,7 @@ Here the gem:
   = 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"
+      = sna.select :social_net_uid, SocialNetsDB::SocialNet.values_for_select, {}, class: "form-control"
 ```
 
 which produces
@@ -109,12 +108,14 @@ See section “[Using with Rails](#use-with-rails)” below for more details.
 
 ## API
 
-### Instance of `SocialNetsDB` class
+### Find a social net record
 
-Initialize an instance with social net UID.
+Use either one:
 
 ```ruby
-social_net = SocialNetsDB.find("facebook")
+social_net = SocialNetsDB::SocialNet.find("facebook")
+social_net = SocialNetsDB::SocialNet.find_by(uid: "facebook")
+social_net = SocialNetsDB::SocialNet.find_by_uid("facebook")
 # => #<SocialNetsDB:0x00007fddc0041b40 @uid="facebook">
 ```
 
@@ -131,97 +132,45 @@ SocialNetsDB.uids
 #    "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]
-#      }
-#    }
+social_net.to_h #=>
+# {
+#   "name"   => "Facebook",
+#   "icons"  => { "font_awesome_4" => "facebook" },
+#   "color"  => "#3C5A99",
+#   "domain" => "facebook.com",
+#   "tags"   => ["social net"],
+#   "profile_url" => {
+#     "by_username"   => "https://${domain}/${uid}",
+#     "by_account_id" => "https://${domain}/${uid}"
+#   }
+# }
 ```
 
 ### 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"
+social_net.color  #=> "#3C5A99"
+social_net.name   #=> "Facebook"
+social_net.uid    #=> "facebook"
+social_net.domain #=> "facebook.com"
+social_net.url    #=> "https://facebook.com"
+social_net.icons  #=> { "font_awesome_4" => "facebook" }
 ```
 
 ### 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>
+social_net.icons["font_awesome_4"] #=> "facebook"
 ```
 
-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>
-```
+Currently, only FontAwesome v4 icons are store. I plan adding newer version of FA, maybe other icon providers, and also SVGs.
 
 ### User's page URL
 
@@ -230,7 +179,7 @@ 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`.
+If you pass a username, while the `SocialNet` supports user page URLs only via account ids, the method call will return `nil`.
 
 You can check which is supported
 
@@ -250,13 +199,13 @@ This gem is Rails-agnostic, but you can use it in Rails like so:
   = 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"
+      = sna.select :social_net_uid, SocialNetsDB::SocialNet.values_for_select, {}, class: "form-control"
 ```
 
 because
 
 ```ruby
-SocialNetsDB.values_for_select
+SocialNetsDB::SocialNet.values_for_select
 #=> [
 #     ["Behance",       "behance"],
 #     ["Dribble",       "dribble"],
@@ -284,6 +233,21 @@ model User < ApplicationRecord
 end
 ```
 
+This would be a standard approach:
+
+```ruby
+# model SocialNet < ApplicationRecord
+#   has_many :social_net_accounts
+# end
+```
+
+but instead we will use `SocialNetsDB::SocialNet` class instead of an ActiveRecord class:
+
+```ruby
+SocialNetsDB::SocialNet.find("facebook")
+SocialNetsDB::SocialNet.find_by(uid: "facebook")
+```
+
 ```ruby
 model SocialNetAccount < ApplicationRecord
   belongs_to :user
@@ -293,7 +257,7 @@ model SocialNetAccount < ApplicationRecord
   validates :username,       presence: true, if: Proc.new { |record| record.account_id.blank? }
 
   def social_net
-    @social_net ||= SocialNetsDB.find(self.social_net_uid)
+    @social_net ||= SocialNetsDB::SocialNet.find(self.social_net_uid)
   end
 
   def user_page

data/lib/social_nets_db/social_net.rb

@@ -17,11 +17,12 @@ class SocialNetsDB
 
 		attr_accessor :uid
 
-		[:color, :domain, :icons, :name].each do |method_symbol|
-			define_method(method_symbol) do
-				to_h[method_symbol.to_s]
-			end
-		end
+    [:color, :domain, :icons, :name, :tags].each do |method_symbol|
+      define_method(method_symbol) do
+        fallback_value = method_symbol == :tags ? [] : nil
+        @data.fetch(method_symbol.to_s, fallback_value)
+      end
+    end
 
 		def to_h
 			self.class.send :raw_data_for, @uid

data/lib/social_nets_db/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class SocialNetsDB
-  VERSION = "0.0.5".freeze
+  VERSION = "0.0.6".freeze
 end

data/social_nets_db.gemspec

@@ -8,19 +8,20 @@
 require_relative "lib/social_nets_db/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "social_nets_db"
-  spec.version       = SocialNetsDB::VERSION
-  spec.authors       = ["Sergey Pedan"]
-  spec.email         = ["sergey.pedan@gmail.com"]
-  spec.license       = "MIT"
-
-  spec.summary       = "A non-comprehensive database of social nets packed in a Ruby gem"
-  spec.description   = "#{spec.summary}. We have helpers for color, user page URL, FontAwesome icon, social net domain, some tags for grouping social nets, etc."
-
-  spec.homepage      = "https://github.com/sergeypedan/social-nets-db"
-  spec.metadata      = { "changelog_uri"     => "https://github.com/sergeypedan/social-nets-db/blob/master/CHANGELOG.md",
-                         "homepage_uri"      => spec.homepage,
-                         "source_code_uri"   => "https://github.com/sergeypedan/social-nets-db.git"}
+  spec.name             = "social_nets_db"
+  spec.version          = SocialNetsDB::VERSION
+  spec.authors          = ["Sergey Pedan"]
+  spec.email            = ["sergey.pedan@gmail.com"]
+  spec.license          = "MIT"
+
+  spec.summary          = "A non-comprehensive database of social nets packed in a Ruby gem"
+  spec.description      = "#{spec.summary}. We have helpers for color, user page URL, FontAwesome icon, social net domain, some tags for grouping social nets, etc."
+
+  spec.homepage         =  "https://sergeypedan.ru/open_source_projects/social-nets-db"
+  spec.metadata         = { "changelog_uri"     => "https://github.com/sergeypedan/social-nets-db/blob/master/CHANGELOG.md",
+                            "documentation_uri" => "https://www.rubydoc.info/gems/#{spec.name}",
+                            "homepage_uri"      => spec.homepage,
+                            "source_code_uri"   => "https://github.com/sergeypedan/social-nets-db" }
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
   spec.rdoc_options     = ["--charset=UTF-8"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_nets_db
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Sergey Pedan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-02 00:00:00.000000000 Z
+date: 2021-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,13 +146,14 @@ files:
 - lib/social_nets_db/tag_helper.rb
 - lib/social_nets_db/version.rb
 - social_nets_db.gemspec
-homepage: https://github.com/sergeypedan/social-nets-db
+homepage: https://sergeypedan.ru/open_source_projects/social-nets-db
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/sergeypedan/social-nets-db/blob/master/CHANGELOG.md
-  homepage_uri: https://github.com/sergeypedan/social-nets-db
-  source_code_uri: https://github.com/sergeypedan/social-nets-db.git
+  documentation_uri: https://www.rubydoc.info/gems/social_nets_db
+  homepage_uri: https://sergeypedan.ru/open_source_projects/social-nets-db
+  source_code_uri: https://github.com/sergeypedan/social-nets-db
 post_install_message:
 rdoc_options:
 - "--charset=UTF-8"