social_nets_db 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b16ceb6656a59c747798848c9a99d8fd53c5db5fa903b1d2df388534a122cdc3
-  data.tar.gz: 4f2f515a1e9bf204a33cd01d274df52953db1d24e2a951cf70cbe7c7c4ad50a6
+  metadata.gz: 16056e32bc256d743a1b7fa14d16d714d242ee3a3d4ee106d71d51e6bed03c58
+  data.tar.gz: e91524ea8abd15b0f24584645605398ffb6026039fa082a240d04e719850f7df
 SHA512:
-  metadata.gz: 3441ffff109b6b15a45a85be1100b235422f3dbd3ded19e099a7b3e18811a94226d06393e239052edbb7023b716b1c06c26063dc66ce4e5701f6f048e5f5cea1
-  data.tar.gz: 76791b05f97311c578435150d61c1780c3980ead21ac60c2cc938a22135bbeef36778f18120759ff2e51283568c783b1fe1897e3b1928a045460ef65dda161a7
+  metadata.gz: 72bdf3a625923ec900dcc76d98dd2e01932848b003b51dfcc3fc0589484086a5a2bafb6f71c9a9120e33b410c180dc53837a681b79030879a01016d3d6bb3285
+  data.tar.gz: a2fa51dad61a848b70cc82e923ab19b4c41b435487cff99f5620e4ff3c25e0f41d845513bfaffcd0df60ba60c7d7cd0246c36fc9979455846d620ce9fc4786a9

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # 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

data/Gemfile.lock

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

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]
@@ -24,28 +27,39 @@ class SocialNetsDB
       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
@@ -56,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)
@@ -69,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

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.6".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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social_nets_db
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Sergey Pedan