google_reviews 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 231e90d72dc86d146d4984725b9860fa6fe711a981cab4b1243c71e4ef432b93
+  data.tar.gz: d1bbf7d14bd4e7cfc696b259df887846fe4307a7c699542271045e8764c80979
+SHA512:
+  metadata.gz: 2f0ec4a36b6fbfd5ede619e3ec9d1720d69f3a95f7df799533a4953cde8a3d265e8d3437d5782816e5e4307e04f25d74d1f79d53ad42bb73901062d1a0c18065
+  data.tar.gz: 37b030b38eacee137834924955f92616b13db1f903269e471d55c725ee684d174f16c26ee655d8926f8741c7f3db99b7bacbafb27c6e176ad6d5932760f3b67f

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/LineLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-03
+
+- Initial release

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 gullariz82@gmail.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,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in google_reviews.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    google_reviews (0.1.0)
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.1)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.54.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  google_reviews!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock (~> 2.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 gullariz12
+
+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,62 @@
+# Google Reviews Gem
+
+The Google Reviews gem is a Ruby library that provides a service to fetch reviews from Google based on a place name or place ID. It utilizes the Google Places API to retrieve the reviews and provides a convenient interface for accessing the review data.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```
+gem 'google_reviews'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it directly:
+
+```
+$ gem install google_reviews
+```
+## Usage
+To fetch reviews based on a place name or place ID, you can use the `GoogleReviews::Reviews` class provided by the gem. Here's an example of how to use it:
+
+```
+require 'google_reviews'
+
+api_key = 'YOUR_API_KEY'
+place_id = 'PLACE_ID'
+
+reviews = GoogleReviews::Reviews.fetch_reviews_by_place_id(api_key, place_id)
+
+reviews.each do |review|
+  puts "Author: #{review[:author_name]}"
+  puts "Rating: #{review[:rating]}"
+  puts "Review Text: #{review[:text]}"
+  puts "---"
+end
+```
+
+Make sure to replace `YOUR_API_KEY` with your actual Google Places API key.
+
+## Error Handling
+
+The gem provides custom error classes that you can handle to deal with specific error scenarios. Here are the error classes available:
+
+- `GoogleReviews::ApiError:` Represents general API-related errors.
+- `GoogleReviews::InvalidApiKeyError:` Indicates an invalid API key error.
+- `GoogleReviews::InvalidPlaceIdError:` Indicates an invalid place ID error.
+You can rescue and handle these errors to provide appropriate error handling in your application.
+
+## Configuration
+The gem doesn't require any additional configuration. However, it's recommended to configure the locale for translations. By default, the gem uses English (`:en`) as the locale. If you want to use a different locale, you can modify the `lib/google_reviews/translations.rb file`.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gullariz12/google_reviews. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/gullariz12/google_reviews/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/google_reviews/api_request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# GoogleReviews module
+module GoogleReviews
+  # Make API request to fetch google reviews
+  module ApiRequest
+    def execute(url)
+      http_request = build_request(url)
+      request_client = build_http_client(url)
+
+      response = request_client.request(http_request)
+
+      raise ApiError, error_message unless response.is_a?(Net::HTTPSuccess)
+
+      parsed_response(response)
+    rescue StandardError => e
+      raise ApiError, I18n.t("messages.api_request_error", exception: e)
+    end
+
+    private
+
+    def build_http_client(url)
+      uri = URI(url)
+      https = Net::HTTP.new(uri.host, uri.port)
+      https.use_ssl = true
+
+      https
+    end
+
+    def build_request(url)
+      uri = URI(url)
+
+      Net::HTTP::Get.new(uri.request_uri)
+    end
+
+    def parsed_response(response)
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      raise ApiError, I18n.t("messages.parser_error")
+    end
+
+    def error_message(response)
+      I18n.t("messages.failed_request", code: response.code, message: response.message)
+    end
+
+    module_function :execute, :build_request, :build_http_client, :parsed_response, :error_message
+  end
+end

data/lib/google_reviews/constants.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+PLACE_ID_SEARCH_BASE_URI = "https://maps.googleapis.com/maps/api/place/details/json"
+PLACE_TEXT_SEARCH_BASE_URI = "https://maps.googleapis.com/maps/api/place/textsearch/json"

data/lib/google_reviews/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module GoogleReviews
+  class Error < StandardError; end
+
+  class ApiError < Error; end
+  class InvalidApiKeyError < ApiError; end
+  class InvalidPlaceIdError < ApiError; end
+end

data/lib/google_reviews/translations.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+# Load Translations
+module Translations
+  translations_file = File.expand_path("../../locales/en.yml", __dir__)
+  I18n.load_path << translations_file
+  I18n.backend.load_translations
+  I18n.locale = :en
+end

data/lib/google_reviews/utils.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# GoogleReviews module
+module GoogleReviews
+  # Various utility methods
+  module Utils
+    def request_uri(api_key, place_id: nil, place_name: nil)
+      if place_id
+        "#{PLACE_ID_SEARCH_BASE_URI}?place_id=#{place_id}&fields=reviews&key=#{api_key}"
+      elsif place_name
+        "#{PLACE_TEXT_SEARCH_BASE_URI}?query=#{encoded_place_name(place_name)}&key=#{api_key}"
+      end
+    end
+
+    def formatted_reviews_data(reviews)
+      reviews.map do |review|
+        {
+          author_name: review["author_name"],
+          rating: review["rating"],
+          text: review["text"]
+        }
+      end
+    end
+
+    private
+
+    def encoded_place_name(place_name)
+      URI.encode_www_form_component(place_name)
+    end
+
+    module_function :request_uri, :formatted_reviews_data, :encoded_place_name
+  end
+end

data/lib/google_reviews/version.rb

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

data/lib/google_reviews.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "uri"
+require "json"
+require "net/http"
+require "google_reviews/error"
+require "google_reviews/utils"
+require "google_reviews/constants"
+require "google_reviews/api_request"
+require "google_reviews/translations"
+require_relative "google_reviews/version"
+
+module GoogleReviews
+  # Service to fetch reviews based on place_name or place_id
+  class Reviews
+    def self.fetch_reviews_by_place_name(api_key, place_name)
+      url = Utils.request_uri(api_key, place_name: place_name)
+
+      data = ApiRequest.execute(url)
+
+      raise ApiError, I18n.t("messages.search_place_api_error", exception: data["status"]) unless data["status"] == "OK"
+
+      place_id = data["results"].first["place_id"]
+      fetch_reviews_by_place_id(api_key, place_id)
+    end
+
+    def self.fetch_reviews_by_place_id(api_key, place_id)
+      url = Utils.request_uri(api_key, place_id: place_id)
+
+      data = ApiRequest.execute(url)
+
+      raise ApiError, I18n.t("messages.search_id_api_error", exception: data["status"]) unless data["status"] == "OK"
+
+      reviews = data["result"]["reviews"]
+      return [] if reviews.nil? || reviews.empty?
+
+      Utils.formatted_reviews_data(reviews)
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  messages:
+    parser_error: "Failed to parse the API response"
+    failed_request: "API request failed: %{code} %{message}"
+    api_request_error: "An error occurred while making the API request: %{exception}"
+    search_place_api_error: "An error occurred while searching for the place: %{exception}"
+    search_id_api_error: "An error occurred while retrieving reviews from the Google Places API: %{exception}"

data/sig/google_reviews.rbs

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: google_reviews
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- gullariz12
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: "  Google Reviews Gem is a Ruby gem that provides an easy-to-use interface
+  for fetching reviews for a specific location from the Google Places API. It allows
+  you to retrieve reviews written by users for a given place and provides useful information
+  such as the author's name, rating, and review text.\n"
+email:
+- gullariz82@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/google_reviews.rb
+- lib/google_reviews/api_request.rb
+- lib/google_reviews/constants.rb
+- lib/google_reviews/error.rb
+- lib/google_reviews/translations.rb
+- lib/google_reviews/utils.rb
+- lib/google_reviews/version.rb
+- locales/en.yml
+- sig/google_reviews.rbs
+homepage: https://github.com/gullariz12/google_reviews
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gullariz12/google_reviews
+  source_code_uri: https://github.com/gullariz12/google_reviews
+  changelog_uri: https://github.com/gullariz12/google_reviews/blob/main/CHANGELOG.md
+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.3.7
+signing_key:
+specification_version: 4
+summary: A gem for retrieving reviews for a specific location from the Google Places
+  API
+test_files: []