moriarty 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d816d4f5bcb90be480cc9492a0210ed80ba5051a34f8b6c02a8298c91e8993b
-  data.tar.gz: f3d332015fd300b78eee116bc8602089c8e0a3d82c3c87f0ed913b49ddf1fc3d
+  metadata.gz: 6561598fba3167762d21e7979989bc7d4b940a18b0d013d640ecf8aa7ad13d40
+  data.tar.gz: 20d9650e00de4c95531f3b447f20260c52e2fa06cc163d0e6ee0ef361a2fde93
 SHA512:
-  metadata.gz: 8c9c99e0685f0437ca15bf5b226dafe3c9c4c920b47392c644351d236758c7df25fa5a9f377cbcae51f76413134a51963024c06d77ca31fa9d1bd6e12f5ffce7
-  data.tar.gz: 168c0d3bb3b4d6e42428e45b07dd2ac096fe6126b431a5a69ec22cac2d63eec8ebd9e12a101573d250b657b1f6ad511d73adcddf091c611a4ea3bd0f538dd675
+  metadata.gz: c119afe3b98a4d5ac724a142f17981d8cc6aea61e6a62d257b28feaa6f6b9c7fdcbfbe0a76cf0c84616922bc47ad270430e3a9d4bab7a0b4844fa4c145707db9
+  data.tar.gz: ff1cd49aaca53a39196f16ab7c67d243932803ab3b6cda766e74fdbfb61d3798c0155640e75b72f2ccd4dc91ef6b3e5b5dc2251ea8868ea1aa9a9f4e62f5c72d

data/README.md

@@ -1,9 +1,17 @@
+ - _GIF preview v-0.2.0 - without latest changes'_
+
+![Moriarty Preview](docs/moriarty.gif)
+
+Gem is still in alpha, many things will be added (like scrapping info from social networks).
+Breaking changes are highly possible, so I do not suggest use of this gem except for development and test.
+That means, do not use it in production services, otherwise feel free to play with it.
+
+
 # Moriarty
 
 Tool to check social networks for available username.  
-_Idea from python tool - sherlock_
+Idea from python tool - sherlock
 
----
 
 # What it do
 
@@ -11,25 +19,33 @@ Search multiple social networks for free username.
 It's reverse from Sherlock, so not-found username is success.
 Argument `--hunt` will run search like _sherlock_ would, looking for valid users.
 
----
 
 # How to install
 
-Clone repo and enter directory:
+Clone repo and install dependencies:
 
-```
-git clone https://github.com/decentralizuj/moriarty.git && cd moriarty
-```
+```bash
+# Moriarty use rest-client, nokogiri and colorize gems
+ git clone https://github.com/decentralizuj/moriarty.git && cd moriarty && bundle install
+```  
 
-Install gem and it's dependecies:
+Or install from rubygems:
 
-```
-bundle install
-```
+> DISCLAIMER:
+GitHub repository is updated before Rubygems.
+Before v-1.0.0 is released, recommended way is to clone repo, or install with bundler from git.
 
-Moriarty depend on gems: _Rest-Client, Nokogiri and Colorize._
+```ruby
+# local
+ gem install moriarty
+
+# bundler
+ gem 'moriarty', '~> 0.2.0'
+
+# bundler from github
+ gem 'moriarty', git: 'https://github.com/decentralizuj/moriarty'
+```
 
----
 
 # How to use
 
@@ -38,62 +54,115 @@ To search for registered user, execute with `--hunt` as argument.
 
 Read source-code, each method is explained with examples.
 
-```
-# if run without arguments, or with `-h || --help`, help banner is printed
+```ruby
+# if installed localy, you can run 'moriarty' without 'ruby bin/'
+#  > $ torify moriarty decentalizuj --hunt
 
-ruby bin/moriarty
-# => print usage instructions
+ ruby bin/moriarty
+ # => print usage instructions
 
-ruby bin/moriarty USERNAME1 USERNAME2 USERNAME3
-# => search for free usernames ... ... ...
+ ruby bin/moriarty USERNAME1 USERNAME2 USERNAME3
+ # => search for free usernames ... ... ...
 
-ruby bin/moriarty --hunt USERNAME1 USERNAME2 USERNAME3
-# => hunt registered usernames ... ... ...
+ ruby bin/moriarty --hunt USERNAME1 USERNAME2 USERNAME3
+ # => hunt registered usernames ... ... ...
 ```
 
-To use *Moriarty* in your own project, available methods are:
+To use *Moriarty* in your own project, available methods are:  
 
 ```ruby
-@jim = Moriarty.new( 'somename', 'facebook.com' )
-# => prepare request for 'https://facebook.com/somename'
+ @jim = Moriarty.new( 'somename', 'facebook.com' )
+ # => prepare request for 'https://facebook.com/somename'
 
-@jim.go
-# => check facebook for username 'somename', return true/false
+ @jim.go
+ # => check facebook for username 'somename', return true/false
 
-@jim.go site: 'github.com'
-# => search github.com, but do not change default :url
+ @jim.go site: 'github.com'
+ # => search github.com, but do not change default :url
 
-@jim.go site: 'github.com', user: 'decentralizuj'
-# => search new user and site without changing defaults
+ @jim.go site: 'github.com', user: 'decentralizuj'
+ # => search new user and site without changing defaults
 
-@jim.url
-# => 'https://facebook.com/' -> get url
+ @jim.url
+ # => 'https://facebook.com/' -> get url
 
-@jim.user
-# => 'somename' -> get user
+ @jim.user
+ # => 'somename' -> get user
 
-@jim.url = 'instagram.com'
-# => 'https://instagram.com/' -> set url
+ @jim.url = 'instagram.com'
+ # => 'https://instagram.com/' -> set url
 
-@jim.user = 'moriarty'
-# => 'moriarti' -> set user
+ @jim.user = 'moriarty'
+ # => 'moriarti' -> set user
 
-@jim.search 
-# => alias for #go
+ @jim.search 
+ # => alias for #go
 ```
 
-`CLI` is created to test main `class Moriarty` in terminal.
-Accept 3 self methods, #find!, #hunt! and #print_url
+**CLI** is there to test main `class Moriarty` in terminal.  
+It's created from self methods: #find!, #hunt!, #print_url and #print_name
+Methods with bang (#find!) run on self, while #find run on instance.
 
 ```ruby
-Moriarty.find! 'somename', 'instagram.com'
-# => execute search and print colorized output
+ Moriarty.find! 'somename', 'instagram.com'
+ # => execute search and print colorized output
 
-Moriarty.find! 'somename', 'github.com', :hunt
-or
-Moriarty.hunt! 'somename', 'github.com'
-# => execute hunt and print colorized output
-
-Moriarty.print_url 'https://www.github.com/'
-# => 'github'
+ Moriarty.find! 'somename', 'github.com', :hunt
+ or
+ Moriarty.hunt! 'somename', 'github.com'
+ # => execute hunt and print colorized output
 ```
+
+Methods `#print_url` and `#print_name` are there to construct data for print.  
+We have url and name as instance variables, so this is self method.
+
+```ruby
+# remove all extensions, if there's any (http(s), .www, .com)
+# first look for 'http(s)', then 'www.', remove if found
+# if domain have more routes (rubygems.org/profiles), remove it
+# this way subdomains are accepted and part of site-name
+
+ Moriarty.print_url 'https://www.github.com/'
+ # => 'github'
+
+# Remove symbols from username ('@, #, /u/')
+# this will be changed in future
+
+ Moriarty.print_name '/u/moriarty'
+ Moriarty.print_name '@moriarty'
+ Moriarty.print_name '#moriarty'
+  # => 'moriarty'
+```  
+
+Methods `#p1` and `#p2` are there to print colorized output
+
+```ruby
+# p1 wrap string with braces, bold by default
+ Moriarty.p1('mystring', :green, :white, :regular)
+ # => '[mystring]' -> string is green, bracelets are white
+
+# p2 only print string colorized, and/or bold
+ Moriarty.p2('mystring', :red, :bold)
+ # => 'mystring' -> red and bold
+```  
+
+
+# Latest Changes
+
+Last push, will be compiled into gem V-0.3.0 when ready
+ - Add methods for smart printing
+ - changed colors in cli
+ - added youtube as source
+ - bold username and site in cli, site is capitalized
+
+V-0.2.0
+ - Moriarty#print_name added to remove '@, #, /u/' from username when printing in cli.
+ - Added 'rubygems.org' as source to search
+ - Added '[+]' and '[-]' to cli output
+
+
+# Contribution
+
+At the moment I do not need any contribution on this project, but that will change after v1.
+That will be in about 1 month, so you can watch repository to stay updated with latest changes.
+Github is always updated before rubygems. And again, after v1, that will be automated.

data/bin/moriarty

@@ -6,15 +6,16 @@ require_relative '../lib/moriarty'
   # accept '--hunt' as argument
 
   hunt = ARGV.include?('--hunt') ? :hunt : :search
+  message = hunt == :hunt ? "Starting hunt on user -> " : "Starting search for free username -> "
 
   # If no args, or include '-h' or '--help', print banner
   # If use '--hunt', do not search for '--hunt' username
 
   if ARGV.empty? or ARGV.include? '-h' or ARGV.include? '--help'
 
-    puts "\nSearch social networks for free username".yellow
+    puts "\nSearch social networks for free username".cyan
     puts " $ ".white + "ruby bin/moriarty sherlock watson".green
-    puts "\nRun with --hunt to search for registered users".yellow
+    puts "\nRun with --hunt to search for registered users".cyan
     puts " $ ".white + "ruby bin/moriarty sherlock watson --hunt\n".green
     exit(1)
 
@@ -26,24 +27,31 @@ require_relative '../lib/moriarty'
     ARGV.each do |user|
       next if user == '--hunt'
 
-      print "\nStarting #{hunt} for username -> ".white.bold
-      puts "[".green + user.yellow + "]".green; puts ""
+      puts
+      Moriarty.p2(message, :cyan, :bold)
+      Moriarty.p1(user)
+      puts; puts
 
       Moriarty.find! user,         'github.com',            hunt
       Moriarty.find! user,         'rubygems.org/profiles', hunt
       Moriarty.find! "@#{user}",   'dev.to',                hunt
       Moriarty.find! "@#{user}",   'medium.com',            hunt
       Moriarty.find! "/u/#{user}", 'reddit.com',            hunt
+      Moriarty.find! user,	   'youtube.com',           hunt
       Moriarty.find! user,         'facebook.com',          hunt
       Moriarty.find! user,         'instagram.com',         hunt
       Moriarty.find! "@#{user}",   'tiktok.com',            hunt
     end
 
     end_time = Time.now.to_i
+    counter  = end_time - start_time
 
-    print "\nFinished in -> ".white.bold
-    print "[".green + "#{count = end_time - start_time}".yellow + "]".green
-    print " second".white
-    puts "s".white unless count.to_s.end_with?('1')
-    puts ""
+    sec = ' second'
+    sec += 's' unless (counter.to_s.end_with?('1') or counter.to_s.end_with?('11'))
+
+    puts
+    Moriarty.p2('Finished in ->', :cyan, :bold)
+    Moriarty.p1(counter)
+    Moriarty.p2(sec, :cyan, :bold)
+    puts; puts
   end

data/lib/moriarty/cli.rb

@@ -12,20 +12,35 @@ class Moriarty
   # Moriarty.find! :stupiduser, 'facebook.com', :hunt
   #  => [FREE!] if user 'stupiduser' is registered on facebook
 
-  def self.find!( name, site = 'github.com', type = :search )
+  def self.find!( username, web = 'github.com', type = :search )
 
-    @jim = Moriarty.new name.to_s, site.to_s
+    @jim = Moriarty.new username.to_s, web.to_s
     @jim.go
 
+    name = print_name(username).to_s
+    site = print_url(web).to_s
+
     case    
     when type.to_sym == :hunt && @jim.success?
-      puts " [+] [FOUND!]".white + " #{ print_name(name)} found on #{ print_url(site) }".yellow
+      p1('+')
+      p1('FOUND!')
+      p2(" #{name}", :cyan, :bold)
+      p2(" found on >> ") 
+      puts p2(site, :cyan, :bold)
     when type.to_sym == :hunt && !@jim.success?
-      puts " [-] #{ print_name(name) } not found on #{ print_url(site) }".red
-    when @jim.success?
-      puts " [-] #{ print_name(name) } is taken on #{ print_url(site) }".red
+      p1('-', :red, :red)
+      p2(" #{name} fail on ", :red)
+      puts p2(site, :red)
+   when @jim.success?
+      p1('-', :red, :red)
+      p2(" #{name} is taken on ", :red)
+      puts p2(site, :red)
     else
-      puts " [+] [FREE!]".white + " #{ print_name(name) } is free on #{ print_url(site) }".yellow
+      p1('+')
+      p1('FREE!')
+      p2(" #{name}", :cyan, :bold)
+      p2(" is free on >> ")
+      puts p2(site, :cyan, :bold)
     end
   end
 
@@ -50,7 +65,7 @@ class Moriarty
     ext = site.to_s.split('.').last
     name = site.gsub(".#{ext}", '')
     name = name.split('/').first if ext.size < 5
-    return name
+    return name.capitalize
   end
 
   # Remove extensions from username
@@ -63,4 +78,16 @@ class Moriarty
     name.gsub!('/u/','') if name.to_s.start_with?('/u/')
     return name
   end
+
+  def self.p1( title, color1 = :'light_green', color2 = :cyan, type = :bold )
+    str = ' ['.colorize(color2) + title.to_s.colorize(color1) + ']'.colorize(color2)
+    str = str.bold if type == :bold
+    print str
+  end
+
+  def self.p2( title, color = :cyan, type = :regular)
+    str = title.colorize(color)
+    str = str.bold if type == :bold
+    print str
+  end
 end

data/moriarty.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'moriarty'
-  s.version     = '0.2.0'
+  s.version     = '0.2.2'
   s.summary     = 'Moriarty - Check social networks for available username.'
   s.description = <<~DESC
     Check social networks for username, and find out is it taken.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moriarty
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - decentralizuj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize