seo-keywords-generator-ruby 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 052c7c699617cde9c463a1e9c2dc8c04e8c3529ac0e6398dce3f9b416007607a
-  data.tar.gz: 00ac688665e5e523d3d50df0b60498944f93eafaabf00f836cf6cfc3602d77b7
+  metadata.gz: ba00429335627c318934caaddac8347ee4adf954b505b396d1583115a74e52ba
+  data.tar.gz: c0abc437864432b813c61436f967e80d56b55ca0b17c10ff199d1cac57798b85
 SHA512:
-  metadata.gz: c023cb016e1a0bd88e0e9536273e287c1a1f71777b3258282844c8ea09558c68392935ed69bdd11e1f68cf0b751190b2c1d9ae8a36719b0ffe909a472d6f6932
-  data.tar.gz: e4431b150850a7d37c99dcbb754c62e6ecc500e01dc50eeb692a772e4f2af5af31b3ee181a49a76ef4f1a1537c408cbeef881e81f34235da684d69601591414e
+  metadata.gz: 9f528c4ab7723b974f1bea5fc71263e65b1070509487f9b54780b2e2ed0fa81bc07ff1b9b604a636981b6dbe79e2ace48a46202502f7958248d7ada267c8a3a3
+  data.tar.gz: 0fe0797a7dcd5aaaeab2090968076b782770028f994511e422859948406eaddb6f265a9fdc907e151367b455fd1433431d8cceabc23fb0e30d3ab4ee8acf0474

data/lib/seo-keywords-generator-ruby.rb

@@ -0,0 +1,222 @@
+require 'google_search_results'
+require 'optparse'
+require 'json'
+require 'csv'
+
+module SeoKeywordsGenerator
+    class CLI
+        def initialize(argv)
+            @argv = argv
+        end
+
+        def run
+            options = {
+                engines: ['ac', 'rs', 'rq'],
+                depth_limit: 0,
+                save_to: 'CSV',
+                api_key: '5868ece26d41221f5e19ae8b3e355d22db23df1712da675d144760fc30d57988',
+                domain: 'google.com',
+                country: 'us',
+                lang: 'en',
+            }
+
+            OptionParser.new do |opts|
+                opts.banner = 'Usage: seo [options]'
+
+                opts.on('-q', '--query QUERY', String, 'Search query (required)') do |q|
+                    options[:query] = q
+                end
+
+                opts.on('-e', '--engines ENGINES', Array, 'Choices of engines to extract: Autocomplete (ac), Related Searches (rs), People Also Ask (rq). You can select multiple engines by separating them with a comma: ac,rs. All engines are selected by default.') do |e|
+                    options[:engines] = e
+                end
+
+                opts.on('-d', '--depth-limit LIMIT', Integer, 'Depth limit for People Also Ask. Default is 0, first 2-4 results.') do |dl|
+                    options[:depth_limit] = dl
+                end
+
+                opts.on('-s', '--save-to SAVE', String, 'Saves the results in the current directory in the selected format (CSV, JSON, TXT). Default CSV.') do |st|
+                    options[:save_to] = st
+                end
+
+                opts.on('-k', '--api-key KEY', String, 'Your SerpApi API key: https://serpapi.com/manage-api-key. Default is a test API key to test CLI.') do |ak|
+                    options[:api_key] = ak
+                end
+
+                opts.on('-g', '--domain DOMAIN', String, 'Google domain: https://serpapi.com/google-domains. Default google.com.') do |gd|
+                    options[:domain] = gd
+                end
+
+                opts.on('-c', '--country COUNTRY', String, 'Country of the search: https://serpapi.com/google-countries. Default us.') do |gl|
+                    options[:country] = gl
+                end
+
+                opts.on('-l', '--language LANGUAGE', String, 'Language of the search: https://serpapi.com/google-languages. Default en.') do |hl|
+                    options[:lang] = hl
+                end
+            end.parse!(@argv)
+
+            keyword_research = SeoKeywordsGenerator::Scraper.new(
+                query=options[:query],
+                api_key=options[:api_key],
+                lang=options[:lang],
+                country=options[:country],
+                domain=options[:domain]
+            )
+
+            data = {}
+
+            options[:engines]&.each do |engine|
+                case engine.downcase
+                when 'ac'
+                    data['auto_complete'] = keyword_research.get_auto_complete()
+                when 'rs'
+                    data['related_searches'] = keyword_research.get_related_searches()
+                when 'rq'
+                    data['related_questions'] = keyword_research.get_related_questions(options[:depth_limit])
+                end
+            end
+
+            if !data.empty?
+                keyword_research.print_data(data)
+                puts "Saving data in #{options[:save_to].upcase} format..."
+
+                case options[:save_to].upcase
+                when 'CSV'
+                    keyword_research.save_to_csv(data)
+                when 'JSON'
+                    keyword_research.save_to_json(data)
+                when 'TXT'
+                    keyword_research.save_to_txt(data)
+                end
+
+                puts "Data successfully saved to #{options[:query].gsub(' ', '_')}.#{options[:save_to].downcase} file"
+            end
+        end
+    end
+
+    class Scraper
+        attr_accessor :query, :api_key, :lang, :country, :domain
+        
+        def initialize(query, api_key, lang = 'en', country = 'us', domain = 'google.com')
+            @query = query
+            @api_key = api_key
+            @lang = lang
+            @country = country
+            @domain = domain
+            @related_questions_results = []
+        end
+        
+        def get_auto_complete
+            params = {
+                api_key: @api_key,                # https://serpapi.com/manage-api-key
+                engine: 'google_autocomplete',    # search engine
+                q: @query,                        # search query
+                gl: @country,                     # country of the search
+                hl: @lang                         # language of the search
+            }
+            
+            search = GoogleSearch.new(params)     # data extraction on the SerpApi backend
+            results = search.get_hash             # JSON -> Ruby hash
+            
+            results[:suggestions].map{ |result| result[:value] }.compact
+        end
+        
+        def get_related_searches
+            params = {
+                api_key: @api_key,                # https://serpapi.com/manage-api-key
+                engine: 'google',                 # search engine
+                q: @query,                        # search query
+                google_domain: @domain,           # Google domain to use
+                gl: @country,                     # country of the search
+                hl: @lang                         # language of the search
+            }
+            
+            search = GoogleSearch.new(params)     # data extraction on the SerpApi backend
+            results = search.get_hash             # JSON -> Ruby hash
+            
+            results[:related_searches].map{ |result| result[:query] }.compact
+        end
+
+        def get_depth_results(token, depth)
+            depth_params = {
+                q: @query,
+                api_key: @api_key,
+                engine: 'google_related_questions',
+                next_page_token: token
+            }
+            
+            depth_search = GoogleSearch.new(depth_params)
+            depth_results = depth_search.get_hash
+            
+            @related_questions_results += depth_results[:related_questions]&.map{ |result| result[:question] }
+            
+            if depth > 1
+                depth_results[:related_questions]&.each do |question|
+                    if question[:next_page_token]
+                        get_depth_results(question[:next_page_token], depth - 1)
+                    end
+                end
+            end
+        end
+        
+        def get_related_questions(depth_limit = 0)
+            params = {
+                api_key: @api_key,                # https://serpapi.com/manage-api-key
+                engine: 'google',                 # search engine
+                q: @query,                        # search query
+                google_domain: @domain,           # Google domain to use
+                gl: @country,                     # country of the search
+                hl: @lang                         # language of the search
+            }
+            
+            search = GoogleSearch.new(params)     # data extraction on the SerpApi backend
+            results = search.get_hash             # JSON -> Ruby hash
+            
+            @related_questions_results = results[:related_questions]&.map{ |result| result[:question] }
+            
+            depth_limit = 4 if depth_limit > 4
+            
+            if depth_limit > 0
+                results[:related_questions]&.each do |question|
+                    if question[:next_page_token]
+                        get_depth_results(question[:next_page_token], depth_limit)
+                    end
+                end
+            end
+        
+            @related_questions_results
+        end
+        
+        def save_to_csv(data)
+            CSV.open("#{@query.gsub(' ', '_')}.csv", 'w') do |csv_file|
+                csv_file << data.keys
+                max_length = data.values.map(&:length).max
+                (0...max_length).each do |index|
+                    csv_file << data.values.map { |value| value[index] }
+                end
+            end
+        end
+        
+        def save_to_json(data)
+            File.open("#{@query.gsub(' ', '_')}.json", 'w') do |json_file|
+                json_file.write(JSON.pretty_generate(data))
+            end
+        end
+        
+        def save_to_txt(data)
+            File.open("#{@query.gsub(' ', '_')}.txt", "w") do |txt_file|
+                data.each do |key, values|
+                    txt_file.puts("#{key}:")
+                    values.each do |value|
+                        txt_file.puts("  #{value}")
+                    end
+                end
+            end
+        end
+            
+        def print_data(data)
+            puts JSON.pretty_generate(data)
+        end
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seo-keywords-generator-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.12
 platform: ruby
 authors:
 - Artur Chukhrai
@@ -36,6 +36,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/seo
+- lib/seo-keywords-generator-ruby.rb
 homepage: https://github.com/chukhraiartur/seo-keywords-generator-ruby
 licenses:
 - MIT