social_nets_db 0.0.1

data/lib/social_nets_db/db.yml

@@ -0,0 +1,525 @@
+behance:
+  name: Behance
+  icons:
+    font_awesome: behance
+  color: "#1769ff"
+  domain: behance.com
+  tags:
+    - art
+    - design
+    - recruiting
+  profile_url:
+    by_username: "https://${domain}/${uid}"
+    by_account_id: "https://${domain}/${uid}"
+
+bitchute:
+  name: Bitchute
+  icons:
+  color: "#ef4137"
+  domain: bitchute.com
+  tags:
+    - video-hosting
+    - anti-censorship
+  profile_url:
+    by_username: https://${domain}/profile/${uid}
+
+bitclout:
+  name: Bitclout
+  icons:
+  color: "#ef4137"
+  domain: bitclout.com
+  tags:
+    - social net
+    - crypto
+  profile_url:
+    by_username: https://${domain}/u/${uid}
+
+blogger:
+  name: Blogger
+  icons:
+    font_awesome: "link"
+  color: "#ff8000"
+  domain: blogger.com
+  tags:
+    - obsolete
+  profile_url:
+    by_username: https://${uid}.blogspot.com
+
+discord:
+  name: Discord
+  icons:
+  color: "#7289da"
+  domain: discord.com
+  tags:
+    - gaming
+  profile_url:
+    by_account_id: "https://discord.gg/${uid}"
+
+dribble:
+  name: Dribble
+  icons:
+    font_awesome: "dribble"
+  color: "#ea4c89"
+  domain: dribble.com
+  tags:
+    - art
+    - design
+    - portfolio
+  profile_url:
+    by_username: https://${domain}/${uid}
+    by_account_id: "https://${domain}/${uid}"
+
+email:
+  name: E-mail
+  icons:
+    font_awesome: "at"
+  color: "#ea4c89"
+  domain: gmail.com
+  tags:
+    - protocols
+  profile_url:
+    by_username: ${uid}
+
+ens:
+  name: Ethereum namespace
+  icons:
+  color: "#5284ff"
+  domain: ens.domains
+  tags:
+    -
+  profile_url:
+    by_username: https://${uid}.eth
+
+facebook:
+  name: Facebook
+  icons:
+    font_awesome: "facebook"
+  color: "#3C5A99"
+  domain: facebook.com
+  tags:
+    - social net
+  profile_url:
+    by_username: https://${domain}/${uid}
+    by_account_id: "https://${domain}/${uid}"
+
+fl.ru:
+  name: FL
+  icons:
+  color: "#4ea828"
+  domain: fl.ru
+  tags:
+    - free-lance
+    - design
+    - programming
+  profile_url:
+    by_username: https://${domain}/users/${uid}/
+
+flote:
+  name: Flote
+  icons:
+  color: "#01f"
+  domain: flote.app
+  tags:
+    - anti-censorship
+    - social net
+  profile_url:
+    by_username: https://${domain}/user/${uid}/
+
+freelansim:
+  name: Фрилансим
+  icons:
+  color: "#4abfb4"
+  domain: freelansim.ru
+  tags:
+    - free-lance
+    - design
+    - programming
+  profile_url:
+    by_username: https://${domain}/freelancers/${uid}
+
+gab:
+  name: Gab
+  icons:
+  color: "#21cf7a"
+  domain: gab.com
+  tags:
+    - anti-censorship
+    - social net
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+gettr:
+  name: Gettr
+  icons:
+  color: "#ff0013"
+  domain: gettr.com
+  tags:
+    - anti-censorship
+    - social net
+  profile_url:
+    by_username: https://${domain}/user/${uid}
+
+habr:
+  name: Habrahabr
+  icons:
+  color: "#65a3be"
+  domain: habr.com
+  tags:
+    - recruiting
+    - programming
+    - blog
+  profile_url:
+    by_username: https://${domain}/ru/users/${uid}/
+
+habr-career:
+  name: Хабр Карьера
+  icons:
+  color: "#64c178"
+  domain: career.habr.com
+  tags:
+    - recruiting
+    - programming
+  profile_url:
+    by_username: https://${domain}/${uid}/
+
+hh:
+  name: HeadHunter
+  icons:
+  color: "#D6001C"
+  domain: hh.ru
+  tags:
+    - recruiting
+  profile_url:
+    by_account_id: "https://${domain}/resume/${uid}"
+
+github:
+  name: GitHub
+  icons:
+    font_awesome: "github"
+  color: "#333333"
+  domain: github.com
+  tags:
+    - programming
+    - recruiting
+  profile_url:
+    by_username: https://${domain}/${uid}
+    by_account_id: "https://${domain}/${uid}"
+
+gitlab:
+  name: GitLab
+  icons:
+    font_awesome: "gitlab"
+  color: "#fa7035"
+  domain: gitlab.com
+  tags:
+    - programming
+    - recruiting
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+instagram:
+  name: Instagram
+  icons:
+    font_awesome: "instagram"
+  color: "#e1306c"
+  domain: instagram.com
+  tags:
+    - social net
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+lbry:
+  name: LBRY
+  icons:
+  color: "#38d9a9"
+  domain: lbry.tv
+  tags:
+    - video-hosting
+  profile_url:
+    by_username: https://${domain}/@${uid}
+
+linkedin:
+  name: LinkedIn
+  icons:
+    font_awesome: "linkedin"
+  color: "#0077b5"
+  domain: linkedin.com
+  tags:
+    - recruiting
+    - social net
+  profile_url:
+    by_username: https://${domain}/in/${uid}
+
+livejournal:
+  name: LiveJournal
+  icons:
+    font_awesome: "livejournal"
+  color: "#00A3D9"
+  domain: livejournal.com
+  tags:
+    - blog
+    - obsolete
+  profile_url:
+    by_username: https://${uid}.${domain}
+
+locals:
+  name: Locals
+  icons:
+  color: "#e73348"
+  domain: locals.com
+  tags:
+    - anti-censorship
+    - paywall
+  profile_url:
+    by_username: https://${uid}.${domain}
+
+manosphere:
+  name: Manosphere
+  icons:
+  color: "#d84c47"
+  domain: manosphere.tv
+  tags:
+    - anti-censorship
+    - paywall
+  profile_url:
+    by_username: https://${domain}/@${uid}
+
+medium:
+  name: Medium
+  icons:
+    font_awesome: "medium"
+  color: "#00ab6c"
+  domain: medium.com
+  tags:
+    - blog
+    - paywall
+  profile_url:
+    by_username: https://${uid}.${domain}
+
+minds:
+  name: Minds
+  icons:
+  color: "#ffdd63"
+  domain: minds.com
+  tags:
+    - anti-censorship
+    - crypto
+    - social net
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+my.mail.ru:
+  name: Мой мир
+  icons:
+  color: "#005FF9"
+  domain: my.mail.ru
+  tags:
+    - obsolete
+    - social net
+  profile_url:
+    by_username: https://${domain}/mail/${uid}/
+
+odysee:
+  name: Odysee
+  icons:
+  color: "#000000"
+  domain: odysee.com
+  tags:
+    - anti-censorship
+    - crypto
+    - video-hosting
+  profile_url:
+    by_username: https://${domain}/@${uid}/
+
+odnoklassniki:
+  name: Одноклассники
+  icons:
+    font_awesome: "odnoklassniki"
+  color: "#e47d08"
+  domain: ok.ru
+  tags:
+    - obsolete
+    - social net
+  profile_url:
+    by_username: https://${domain}/${uid}/
+
+paypal:
+  name: PayPal
+  icons:
+    font_awesome: "paypal"
+  color: "#0070ba"
+  domain: paypal.com
+  tags:
+    - payment service
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+patreon:
+  name: Patreon
+  icons:
+  color: "#ff424d"
+  domain: patreon.com
+  tags:
+    - paywall
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+remoteok:
+  name: RemoteOK
+  icons:
+  color: "#ff4742"
+  domain: remoteok.io
+  tags:
+    - design
+    - programming
+    - recruiting
+  profile_url:
+    by_username: https://${domain}/@${uid}
+
+rokfin:
+  name: Rokfin
+  icons:
+  color: "#08AD9F"
+  domain: rokfin.com
+  tags:
+    - anti-censorship
+    - video-hosting
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+rumble:
+  name: Rumble
+  icons:
+    font_awesome: "play-circle"
+  color: "#74a441"
+  domain: rumble.com
+  tags:
+    - anti-censorship
+    - video-hosting
+  profile_url:
+    by_username: https://${domain}/c/${uid}
+
+stackoverflow:
+  name: StackOverflow
+  icons:
+    font_awesome: "stackoverflow"
+  color: "#F48024"
+  domain: stackoverflow.com
+  tags:
+    - recruiting
+    - programming
+  profile_url:
+    by_account_id: "https://${domain}/users/${uid}?tab=profile"
+
+subscribestar:
+  name: SubscribeStar
+  icons:
+  color: "#ff4081"
+  domain: subscribestar.com
+  tags:
+    - paywall
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+substack:
+  name: SubStack
+  icons:
+  color: "#ff4081"
+  domain: substack.com
+  tags:
+    - paywall
+    - blog
+  profile_url:
+    by_username: https://${uid}.${domain}
+
+telegram:
+  name: Telegram
+  icons:
+    font_awesome: "telegram"
+  color: "#0088cc"
+  domain: telegram.com
+  tags:
+    - anti-censorship
+    - blog
+    - messenger
+  profile_url:
+    by_username: https://t.me/${uid}
+
+tiktok:
+  name: TikTok
+  icons:
+  color: "#fe2c55"
+  domain: tiktok.com
+  tags:
+    - video-hosting
+  profile_url:
+    by_username: https://${domain}/@${uid}
+
+twitter:
+  name: Twitter
+  icons:
+    font_awesome: "twitter"
+  color: "#1da1f2"
+  domain: twitter.com
+  tags:
+    - social net
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+upwork:
+  name: UpWork
+  icons:
+  color: "#37A000"
+  domain: upwork.com
+  tags:
+    - design
+    - freelancers
+    - programming
+  profile_url:
+    by_account_id: "https://${domain}/freelancers/~${uid}"
+
+vkontakte:
+  name: Вконтакте
+  icons:
+    font_awesome: "vk"
+  color: "#45668e"
+  domain: vkontakte.com
+  tags:
+    - social net
+  profile_url:
+    by_username: https://${domain}/${uid}
+    by_account_id: "https://${domain}/id${uid}"
+
+youtube:
+  name: YouTube
+  icons:
+    font_awesome: "youtube"
+  color: "#ff0000"
+  domain: youtube.com
+  tags:
+    - video-hosting
+  profile_url:
+    by_username: https://${domain}/c/${uid}
+    by_account_id: "https://${domain}/channel/${uid}"
+
+youtube_profile:
+  name: YouTube
+  icons:
+    font_awesome: "youtube"
+  color: "#ff0000"
+  domain: youtube.com
+  tags:
+    - video-hosting
+  profile_url:
+    by_username: https://${domain}/${uid}
+
+website:
+  name: Web site
+  icons:
+    font_awesome: "link"
+  color: "#ff0000"
+  domain:
+  tags:
+    - protocols
+  profile_url:
+    by_username: ${uid}

data/lib/social_nets_db/fn_validations.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module FnValidations
+
+  module_function
+
+  def validate_argument_type! argument, permitted_types
+    types      = Array(permitted_types)
+    type_names = types.map { |klass| "`#{klass}`" }.join(" or ")
+    valid      = types.any? { |type| argument.is_a? type }
+    message    = "#{type_names} is expected, you pass a `#{argument.class}` (#{argument})"
+    fail TypeError, message unless valid
+    argument
+  end
+
+  def validate_collection_item_types! collection, permitted_types
+    types      = Array(permitted_types)
+    type_names = types.map { |name| "`#{name}`" }.join(" or ")
+    valid      = collection.all? { |item| types.include?(item.class) }
+    message    = "#{type_names} is expected, one the items you pass is of incorrect type"
+    fail TypeError, message unless valid
+    collection
+  end
+
+  def validate_argument_boolean! argument
+    validate_argument_type! argument, [TrueClass, FalseClass]
+  end
+
+  def validate_argument_presence! argument
+    validate_argument_type! argument, [String, Symbol]
+    return argument if argument.is_a?(Symbol)
+    message = "You must pass a non-empty String, you are passing #{argument.inspect}"
+    fail ArgumentError, message unless argument.is_a?(String) && argument != ""
+    argument
+  end
+
+  def validate_argument_positive! argument
+    validate_argument_type! argument, Numeric
+    message = "You must pass a positive value, you pass #{argument.inspect}"
+    fail ArgumentError, message unless argument.positive?
+    argument
+  end
+
+end
+
+# RSpec.describe FnValidations do
+
+#   include described_class
+
+#   context "invalid input" do
+#     it do expect { validate_argument_type! 1, String         }.to raise_exception(ArgumentError) end
+#     it do expect { validate_argument_type! 1, [String]       }.to raise_exception(ArgumentError) end
+#     it do expect { validate_argument_type! 1, [Hash, String] }.to raise_exception(ArgumentError) end
+#   end
+
+#   context "valid input" do
+#     it do expect { validate_argument_type! 1, Integer         }.not_to raise_exception(ArgumentError) end
+#     it do expect { validate_argument_type! 1, [Integer]       }.not_to raise_exception(ArgumentError) end
+#     it do expect { validate_argument_type! 1, [Integer, Hash] }.not_to raise_exception(ArgumentError) end
+#   end
+
+#   context "valid by ancestory" do
+#     it do expect { validate_argument_type! 1, Numeric     }.not_to raise_exception(ArgumentError) end
+#     it do expect { validate_argument_type! [], Enumerable }.not_to raise_exception(ArgumentError) end
+#   end
+
+# end

data/lib/social_nets_db/social_net.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+class SocialNetsDB
+	class SocialNet
+
+		# To have methods both on class & instance
+		extend  Support
+		include Support
+		extend  FnValidations
+		include FnValidations
+
+		def initialize(uid, data)
+			validate_argument_type! data, Hash
+			validate_argument_type! uid, [String, Symbol]
+			@data, @uid = data, uid
+		end
+
+		attr_accessor :uid
+
+		[:color, :domain, :icons, :name].each do |method_symbol|
+			define_method(method_symbol) do
+				to_h[method_symbol.to_s]
+			end
+		end
+
+		def to_h
+			self.class.send :raw_data_for, @uid
+		end
+
+		def url
+			"https://#{domain}"
+		end
+
+		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).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).sub("${uid}", account_id)
+			end
+		end
+
+		def user_page_methods
+			["account_id", "username"].select { |key| present_str? to_h.dig("profile_url", "by_#{key}") }
+		end
+
+
+		# Class methods
+
+		class << self
+
+			# TODO this must be transofrmed into array of structs
+			def all
+				RECORDS
+			end
+
+			# @param [String] name Social network name
+			# @param [String, Symbol] uid Social network UID
+			#
+			def find_by(name: nil, uid: nil)
+				return find_by_uid(uid)   if present_str?(uid)
+				return find_by_name(name) if present_str?(name)
+				fail ArgumentError, "`name:` or `uid:` must be provided. You are passing name: #{name.inspect}, uid: #{uid.inspect}"
+			end
+
+			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
+			#
+			def find_by_uid(uid)
+				validate_argument_type! uid, String
+				validate_argument_presence! uid
+
+				# unless uids.include?(@uid = uid)
+				#   fail ArgumentError, "Social net with UID #{uid} is not recognized. Currently supported UIDs are: #{uids.join(", ")}. To add a new social net, send us a PR."
+				# end
+				return unless data = raw_data_for(uid)
+				self.new(uid, data)
+			end
+
+			private def raw_data_for(uid)
+				RECORDS[uid.to_s]
+			end
+
+			def names
+				RECORDS.map { |uid, data| data[:name] }
+			end
+
+			def uids
+				RECORDS.map { |uid, data| data[:uid].to_s }
+			end
+
+			def values_for_select
+				RECORDS.map { |uid, data| [data[:name], uid] }
+			end
+
+			alias_method :find, :find_by_uid
+
+		end
+
+	end
+end