seo-keywords-generator-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee75c64d14f6d9ba266c24e5e3827e734ee29ae1307fa4b3de68bcd76a74daac
+  data.tar.gz: 6e7fb88acc00304a75a9132a5568cbc122287b7ea4aefcc5202e54113d7b4cd3
+SHA512:
+  metadata.gz: 62a676454f8197cdca3ba232a4adbb2fe2679d62a2eb04d22d35ef2575c9ae09e0694edff7ca7f1356b2dba614499d6532f98679b013b0a3af019f654608077f
+  data.tar.gz: 88076f3fcfd8daffe59cd16e5b645c5366ada0af7c394e4b3e88cd50d5a0f18905ef46c4704dc75c71c7058e57c0aafceb89f4dd86637e67fe2d294fb83e6925

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

@@ -0,0 +1,129 @@
+require 'google_search_results'
+require 'json'
+require 'csv'
+
+
+class SeoKeywordsGenerator
+    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

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: seo-keywords-generator-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artur Chukhrai
+- Dmitiry Zub
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-02 00:00:00.000000000 Z
+dependencies: []
+description: Ruby SEO keywords suggestion tool. Google Autocomplete, People Also Ask
+  and Related Searches.
+email:
+- chukhraiartur@gmail.com
+- dimitryzub@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/seo-keywords-generator-ruby.rb
+homepage: https://github.com/chukhraiartur/seo-keywords-generator-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Ruby SEO Keywords Generator
+test_files: []