social_nets_db 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ab9cf4043cbcf478b953642ac43a17ac0d9c629031195b83a86261567dff36
-  data.tar.gz: 39c106fa105f86275155f9673994ab92a4dcd9a51426191044bcc8b01ba01c6e
+  metadata.gz: 16056e32bc256d743a1b7fa14d16d714d242ee3a3d4ee106d71d51e6bed03c58
+  data.tar.gz: e91524ea8abd15b0f24584645605398ffb6026039fa082a240d04e719850f7df
 SHA512:
-  metadata.gz: a1df5f62af4545f80b59830cd1720ce907eba907df990788290f73bbb5697d85d310eb5bc7e0e817ecae466ceebd4df0aea7af42fc1555ba203d9b21aa26bacb
-  data.tar.gz: 340aa65a98823f0d72da7f5dd12c9de6d613a678e9b65493d13bc2512fcc064eef5a5c8a5ff1987fb696b248ea8d065dd6cf99978f00ccd252fc488fd6fd4247
+  metadata.gz: 72bdf3a625923ec900dcc76d98dd2e01932848b003b51dfcc3fc0589484086a5a2bafb6f71c9a9120e33b410c180dc53837a681b79030879a01016d3d6bb3285
+  data.tar.gz: a2fa51dad61a848b70cc82e923ab19b4c41b435487cff99f5620e4ff3c25e0f41d845513bfaffcd0df60ba60c7d7cd0246c36fc9979455846d620ce9fc4786a9

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.0.7] - 2021-12-03
+
+- Improves and corrects user page method
+- Corrects .all method
+- More documentation
+
+## [0.0.6] - 2021-12-03
+
+- Corrects data source of accessor methods
+
+## [0.0.5] - 2021-12-03
+
+- Corrects an error in `uids`
+
+## [0.0.4] - 2021-12-03
+
+- Corrects an error in `values_for_select`
+
 ## [0.0.3] - 2021-12-03
 
 - Corrects an error with email / website

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    social_nets_db (0.0.2)
+    social_nets_db (0.0.7)
 
 GEM
   remote: https://rubygems.org/

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/db.yml

@@ -503,7 +503,7 @@ youtube:
     by_account_id: "https://${domain}/channel/${uid}"
 
 youtube_profile:
-  name: YouTube
+  name: YouTube profile
   icons:
     font_awesome_4: "youtube"
   color: "#ff0000"

data/lib/social_nets_db/social_net.rb

@@ -9,6 +9,9 @@ class SocialNetsDB
 		extend  FnValidations
 		include FnValidations
 
+    # @param [String, Symbol] uid Social net UID (which must be among the top-level keys in db.yml)
+    # @param [Hash] data
+    #
 		def initialize(uid, data)
 			validate_argument_type! data, Hash
 			validate_argument_type! uid, [String, Symbol]
@@ -17,34 +20,46 @@ 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
 
+    # @return [Hash] Raw data we have on the initialized social net
+    #
 		def to_h
 			self.class.send :raw_data_for, @uid
 		end
 
+    # @return [String] full URL of the social net
+    #
 		def url
 			"https://#{domain}"
 		end
 
+    # @return [String] full URL of user’s page in the social net
+    # @param [String, Symbol, Integer] username
+    # @param [String, Symbol, Integer] username
+    # @example
+    #   SocialNetsDB::SocialNet.find("facebook").user_page(username: "dhh")
+    #   #=> "https://facebook.com/dhh"
+    #
 		def user_page(username: nil, account_id: nil)
 			return unless page = to_h["profile_url"]
-			return unless template = page["by_username"] || page["by_account_id"]
-			uid = [username, account_id].select { present_str? _1 }.first or fail(ArgumentError, "Either a username or an account id must be provided")
-
-			if    username && page["by_username"]
-				fail ArgumentError, "Either a username or an account id must be provided" unless present_str?(username)
-				template.sub("${domain}", domain.to_s).sub("${uid}", username)
-			elsif account_id && page["by_account_id"]
-				fail ArgumentError, "Either a username or an account id must be provided" unless present_str?(account_id)
-				template.sub("${domain}", domain.to_s).sub("${uid}", account_id)
-			end
+      fail(ArgumentError, "Either a username or an account id must be provided") if [username, account_id].none?
+      if    username   &&  page["by_username"]
+          validate_argument_type! username, [String, Symbol, Integer]
+  				page["by_username"].sub("${domain}", domain.to_s).sub("${uid}", username.to_s)
+      elsif account_id &&  page["by_account_id"]
+          validate_argument_type! account_id, [String, Symbol, Integer]
+  				page["by_account_id"].sub("${domain}", domain.to_s).sub("${uid}", account_id.to_s)
+      end
 		end
 
+    # @return [Array] available methods for bilding user page URL
+    #
 		def user_page_methods
 			["account_id", "username"].select { |key| present_str? to_h.dig("profile_url", "by_#{key}") }
 		end
@@ -55,12 +70,15 @@ class SocialNetsDB
 		class << self
 
 			# TODO this must be transofrmed into array of structs
+      # @return [Array<SocialNetsDB::SocialNet>] a list of all social nets initialized as objects
 			def all
-				RECORDS
+				RECORDS.map { |uid, data| new(uid, data) }
 			end
 
+
 			# @param [String] name Social network name
 			# @param [String, Symbol] uid Social network UID
+      # @return [SocialNetsDB::SocialNet, nil]
 			#
 			def find_by(name: nil, uid: nil)
 				return find_by_uid(uid)   if present_str?(uid)
@@ -68,13 +86,19 @@ class SocialNetsDB
 				fail ArgumentError, "`name:` or `uid:` must be provided. You are passing name: #{name.inspect}, uid: #{uid.inspect}"
 			end
 
+
+      # @param [String] name Social network name
+      # @return [SocialNetsDB::SocialNet, nil]
+      #
 			def find_by_name(name)
 				validate_argument_presence! name
 				return unless record = RECORDS.select { |uid, data| data["name"] == name }.first
 				find_by_uid record[0]
 			end
 
+
 			# @param [String, Symbol] uid Social network UID
+      # @return [SocialNetsDB::SocialNet, nil]
 			#
 			def find_by_uid(uid)
 				validate_argument_type! uid, String
@@ -92,15 +116,15 @@ class SocialNetsDB
 			end
 
 			def names
-				RECORDS.map { |uid, data| data[:name] }
+				RECORDS.map { |uid, data| data["name"] }
 			end
 
 			def uids
-				RECORDS.map { |uid, data| data[:uid].to_s }
+				RECORDS.keys.map(&:to_s)
 			end
 
 			def values_for_select
-				RECORDS.map { |uid, data| [data[:name], uid] }
+				RECORDS.map { |uid, data| [data["name"], uid] }
 			end
 
 			alias_method :find, :find_by_uid

data/lib/social_nets_db/support.rb

@@ -13,24 +13,4 @@ module Support
     arg.is_a?(String) && arg != ""
   end
 
-  # From https://avdi.codes/recursively-symbolize-keys/
-  #
-  def recursively_symbolize_keys(hash)
-    validate_argument_type! hash, Hash
-    hash.inject({}) { |result, (key, value)|
-      new_key   = case key
-                  when String then key.to_sym
-                  else key
-                  end
-
-      new_value = case value
-                  when Hash then symbolize_keys(value)
-                  else value
-                  end
-
-      result[new_key] = new_value
-      result
-    }
-  end
-
 end

data/lib/social_nets_db/version.rb

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

data/lib/social_nets_db.rb

@@ -10,8 +10,6 @@ require_relative "social_nets_db/social_net"
 
 class SocialNetsDB
 
-  # RECORDS = recursively_symbolize_keys(YAML.load_file(File.expand_path("social_nets_db/db.yml", __dir__))).freeze
-  # RECORDS = YAML.load_file(File.expand_path("social_nets_db/db.yml", __dir__)).map { _1.transform_keys(&:to_sym) }.freeze
   RECORDS = YAML.load_file(File.expand_path("social_nets_db/db.yml", __dir__)).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.3
+  version: 0.0.7
 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"