similarweb_rapidapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5aff259cb85d5d4f076b938d313f57d842287e81e03c16bfca1fa881cad679bc
+  data.tar.gz: 00023662f13271721f9131fc110fe06a61850a83a16e5a92bfd07a25ad9f551e
+SHA512:
+  metadata.gz: 3dba9ea3ccb9756916dd70df4404be28d94134f7d94b47a645f26b8c517c4bb30edf98ea9f348ad3f9b68aa8c0887d4c7ecf5c0f9f9ae81c895b406fed6a68a2
+  data.tar.gz: 393b4e7a3d09b279824c027f07ba6e05ef80b5bfdf69733aa99dbc55cd481bbb08a6a7fd5e31c0cd1bb51126d44e9b61a48e8b1193f25705d04f37a4df88b2ae

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hello@letsscrape.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in similarweb_rapidapi.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem 'dry-types'
+gem 'dry-struct'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 LetsScrape
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# SimilarwebRapidapi
+
+Welcome to SimilarWeb RapidApi, a gem for easy integration and handling with our SimilarWeb API which is published on RapidAPI.
+
+This gem simplifies the process of integrating SimilarWeb's data into your Ruby applications, abstracting the direct API interaction through a set of user-friendly methods. We aim to let developers focus on what truly matters - creating innovative applications that make the most of the rich data provided by SimilarWeb.
+
+ Put your Ruby code in the file `lib/similarweb_rapidapi`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+Read more on [main project page](https://letsscrape.com/scrapers/similarweb-api/)
+See on [RapidAPI](https://rapidapi.com/letsscrape/api/similarweb-working-api)
+
+### How to get RAPID API key
+1. **Register** you account on RapidAPI https://rapidapi.com/auth/sign-up
+2. Go to https://bit.ly/3z3DInS and **Subscribe to test**
+3. After subscribing, please revisit https://bit.ly/3z3DInS to obtain your **X-RapidAPI-Key**.
+4. You will find **X-RapidAPI-Key** on the right side in the Code Snippets.
+
+## Installation
+
+To install this gem onto your system, run:
+
+```bash
+gem install similarweb_rapidapi
+```
+
+To add this gem to your application's Gemfile:
+
+```ruby
+gem 'similarweb_rapidapi'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+## Usage
+
+To start using this gem, you will first need to set up your API key:
+
+```ruby
+require 'similarweb_rapidapi'
+
+SimilarwebRapidapi.configure do |config|
+  config.api_key = 'YOUR_SIMILAR_WEB_API_KEY'
+end
+```
+
+Then, you can use the API methods like so:
+
+```ruby
+result = SimilarwebRapidapi.get_website_overview('example.com')
+puts result
+```
+
+More methods and usage examples will be available in our [Wiki](LINK_TO_YOUR_WIKI).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contact
+
+If you have any questions or need further guidance, please don't hesitate to contact us at [LetsScrape Support](hello@letsscrape.com)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/similarweb_rapidapi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimilarwebRapidapi
+  VERSION = "0.1.0"
+end

data/lib/similarweb_rapidapi.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require_relative "similarweb_rapidapi/version"
+require_relative "similarweb_rapidapi/logger_mock"
+require_relative "similarweb_rapidapi/task_status"
+
+require 'uri'
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+module SimilarwebRapidapi
+  class Error < StandardError; end
+  
+  class ApiClient
+
+    def initialize(rapidapi_key, logger = nil)
+      <<~DESC
+      To get rapid_api_key you just have to register here https://bit.ly/3Mz1U9n
+      :param rapidapi_host: X-RapidAPI-Host header & Base URL
+      :param rapidapi_key: X-RapidAPI-Key header
+      DESC
+
+      @rapidapi_host = 'similarweb-working-api.p.rapidapi.com'
+      @logger = logger.nil? ? SimilarwebRapidapi::LoggerMock.new : logger
+      @headers = {
+        'X-RapidAPI-Key': rapidapi_key,
+        'X-RapidAPI-Host': @rapidapi_host
+      }
+    end
+
+    def get_request(path)
+
+      url = URI.join("https://#{@rapidapi_host}", path).to_s
+
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      
+      session_timeout = 45.0
+      is_ok = false
+
+      while true
+        request = Net::HTTP::Get.new(uri.request_uri)
+  
+        request['X-RapidAPI-Key'] = @headers[:'X-RapidAPI-Key']
+        request['X-RapidAPI-Host'] = @headers[:'X-RapidAPI-Host']
+
+        response = http.request(request)
+        json_response = JSON.parse(response.body, object_class: OpenStruct)
+
+        if response.code == "200"
+          is_ok = true
+        end
+
+        break if is_ok
+
+        sleep(0.3)
+      end
+
+      json_response
+    end
+
+    def wait
+      sleep(1)
+    end
+
+    def get_basic_data_from_domain(domain)
+      path = "/similarweb/getdata?domain=#{domain}"
+      response = get_request(path)
+      response
+    end
+
+    def get_additional_data_form_domain(domain)
+      path = "/similarweb/GetAdditionalDomainData?domain=#{domain}"
+      response = get_request(path)
+      response
+    end
+
+    def get_complete_data_for_domain(domain, callback_url = "")
+      <<~DESC
+      Instead of using get_complete_data_task and then downloading get task result 
+      use this method. It'll do everything for you.
+      DESC
+      user_task = get_complete_data_task(domain, callback_url)
+      task_result = nil
+  
+      while true
+        wait
+        task_result = get_task_result(user_task.data.task_id)
+  
+        if task_result.is_finished
+          if !@logger.nil?
+            @logger.info("Task=#{user_task.data.task_id} domain=#{domain} has been completed.")
+          end
+          break
+        end
+  
+        if !@logger.nil?
+          @logger.info("Waiting for the task=#{user_task.data.task_id} domain=#{domain} to be completed.")
+        end
+      end
+  
+      task_result
+    end
+ 
+    def get_complete_data_for_domains(domains, callback_url = "", callback_success = nil, callback_error = nil)
+      result = []
+      max_tries = 3
+
+      domains.each do |domain|
+        last_exception = nil
+        max_tries.times do |i|
+          begin
+            r = get_complete_data_for_domain(domain, callback_url)
+            last_exception = nil
+            result.append(r)
+            if !callback_success.nil?
+              callback_success.call(r)
+            end
+            break
+          rescue => ex
+            last_exception = ex
+          end
+        end
+
+        if !last_exception.nil?
+          error_message = "Cannot get data for domain=#{domain}. Try again or contact us hello@letsscrape.com"
+          if !@logger.nil?
+            @logger.error(error_message, last_exception)
+          end
+          if !callback_error.nil?
+            callback_error.call(last_exception)
+          end
+        end
+      end
+
+      result
+    end
+
+
+    def get_my_tasks(task_status)
+      <<~DESC
+      Returns the list of you all tasks. 
+      DESC
+      ts = task_status == TaskStatus::ALL ? "" : task_status.to_s
+      path = "/similarweb/GetMyTasks?task_status=#{ts}"
+      response = get_request(path)
+      response
+    end
+
+    def cancel_task(task_id)
+      <<~DESC
+      Cancels created task.
+      DESC
+      path = "/similarweb/CancelTask?task_id=#{task_id}"
+      response = get_request(path)
+      response
+    end
+
+    def get_task_result(task_id)
+      <<~DESC
+      After calling get_complete_data_task just use this method to get the result.
+      DESC
+      path = "/similarweb/GetTaskResult?task_id=#{task_id}"
+      response = get_request(path)
+      response
+    end
+
+    def get_complete_data_task(domain, callback_url = "")
+      <<~DESC
+      Creates task in the system. The task takes a while to complete, so you can check its
+      status by calling get_task_result or set a callback_url where the result will be sent.
+      About callbacks you can read more here https://rapidapi.com/letsscrape/api/similarweb-working-api/tutorials/use-callbacks-when-using-async-endpoints!
+      :param domain: domain
+      :param callback_url: url where to send response (domain data)
+      DESC
+      path = "/similarweb/GetCompleteDataAsync?domain=#{domain}&callback_url=#{callback_url}"
+      response = get_request(path)
+      response
+    end
+
+
+  end
+end

data/sig/similarweb_rapidapi.rbs

@@ -0,0 +1,4 @@
+module SimilarwebRapidapi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/similarweb_rapidapi.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/similarweb_rapidapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "similarweb_rapidapi"
+  spec.version = SimilarwebRapidapi::VERSION
+  spec.authors = ["letsscrape"]
+  spec.email = ["hello@letsscrape.com"]
+
+  spec.summary = "Gem provides simple methods for communicating with the SimilarWeb API"
+  spec.description = "Integrating with the SimilarWeb API becomes fast and convenient, enabling Ruby programmers to easily consume valuable website traffic statistics, rankings, competitive analysis, and much more."
+  spec.homepage = "https://rapidapi.com/letsscrape/api/similarweb-working-api?src=ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/letsscrape/ruby_similarweb_rapidapi"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "dry-types"
+  spec.add_dependency "dry-struct"
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: similarweb_rapidapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- letsscrape
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integrating with the SimilarWeb API becomes fast and convenient, enabling
+  Ruby programmers to easily consume valuable website traffic statistics, rankings,
+  competitive analysis, and much more.
+email:
+- hello@letsscrape.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/similarweb_rapidapi.rb
+- lib/similarweb_rapidapi/version.rb
+- sig/similarweb_rapidapi.rbs
+- similarweb_rapidapi.gemspec
+homepage: https://rapidapi.com/letsscrape/api/similarweb-working-api?src=ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rapidapi.com/letsscrape/api/similarweb-working-api?src=ruby
+  source_code_uri: https://github.com/letsscrape/ruby_similarweb_rapidapi
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Gem provides simple methods for communicating with the SimilarWeb API
+test_files: []