google_reviews 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 231e90d72dc86d146d4984725b9860fa6fe711a981cab4b1243c71e4ef432b93
-  data.tar.gz: d1bbf7d14bd4e7cfc696b259df887846fe4307a7c699542271045e8764c80979
+  metadata.gz: 18e5a9dff07ce24f915090ed258356c3652f70aadb44942115d14b8e49504373
+  data.tar.gz: 28a08e8dee6488b27985aee1239646fd4625444db814638305e57f083e19831a
 SHA512:
-  metadata.gz: 2f0ec4a36b6fbfd5ede619e3ec9d1720d69f3a95f7df799533a4953cde8a3d265e8d3437d5782816e5e4307e04f25d74d1f79d53ad42bb73901062d1a0c18065
-  data.tar.gz: 37b030b38eacee137834924955f92616b13db1f903269e471d55c725ee684d174f16c26ee655d8926f8741c7f3db99b7bacbafb27c6e176ad6d5932760f3b67f
+  metadata.gz: 99ebab61a5641a91e3994cba74e10efb991646624e9ed0d1151c83b1fe51b25369134328ab1e2a3aaf3e70573f48c108c0e5db979ccd58b647ecfcc5cdc55d66
+  data.tar.gz: 619febead0a09e3cede3bbbffef2270b6b86316e1a41700511d00b9977e21354bfd76dbaf0079961e25df8f88d46361fb005ef2420d7f63bf3e83f03c8db2d9c

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    google_reviews (0.1.0)
+    google_reviews (1.0.1)
       i18n
 
 GEM

data/README.md

@@ -54,9 +54,13 @@ You can rescue and handle these errors to provide appropriate error handling in
 ## 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).
+## Submitting a Pull Request
 
-## Contributing
+[Fork](https://help.github.com/articles/fork-a-repo/) the [official repository](https://github.com/TheArtOfCoding/google_reviews).
+[Create a topic branch.](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/)
+Implement your feature or bug fix.
+Add, commit, and push your changes.
+[Submit a pull request.](https://help.github.com/articles/using-pull-requests/)
 
-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).
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/google_reviews/response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GoogleReviews
+  # Response Object
+  class Response
+    attr_reader :status, :data, :error_message
+
+    def initialize(data: [], status: "OK", error: "")
+      @data = data
+      @status = status
+      @error = error
+    end
+
+    def success?
+      status == "OK"
+    end
+  end
+end

data/lib/google_reviews/review.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GoogleReviews
+  # Google Review Object
+  class Review
+    attr_accessor :text, :time, :rating, :language, :author_url, :translated, :author_name,
+                  :original_language, :profile_photo_url, :relative_time_description
+
+    def initialize(data)
+      @text = data["text"]
+      @time = data["time"]
+      @rating = data["rating"]
+      @language = data["language"]
+      @author_url = data["author_url"]
+      @translated = data["translated"]
+      @author_name = data["author_name"]
+      @original_language = data["original_language"]
+      @profile_photo_url = data["profile_photo_url"]
+      @relative_time_description = data["relative_time_description"]
+    end
+  end
+end

data/lib/google_reviews/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "google_reviews/review"
+
 # GoogleReviews module
 module GoogleReviews
   # Various utility methods
@@ -13,21 +15,40 @@ module GoogleReviews
     end
 
     def formatted_reviews_data(reviews)
+      return [] if reviews.nil? || reviews.empty?
+
       reviews.map do |review|
-        {
-          author_name: review["author_name"],
-          rating: review["rating"],
-          text: review["text"]
-        }
+        Review.new(review)
       end
     end
 
+    def execute_place_name_request(url)
+      data = ApiRequest.execute(url)
+
+      raise ApiError, I18n.t("messages.search_place_api_error", exception: data["status"]) unless data["status"] == "OK"
+
+      data["results"]
+    end
+
+    def execute_place_id_request(url)
+      data = ApiRequest.execute(url)
+
+      error = I18n.t("messages.search_id_api_error", exception: data["status"])
+      return GoogleReviews::Response.new(status: data["status"], error: error) unless data["status"] == "OK"
+
+      reviews = data["result"]["reviews"]
+      return GoogleReviews::Response.new if reviews.nil? || reviews.empty?
+
+      GoogleReviews::Response.new(data: formatted_reviews_data(reviews))
+    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
+    module_function :request_uri, :formatted_reviews_data, :encoded_place_name, :execute_place_id_request,
+                    :execute_place_name_request
   end
 end

data/lib/google_reviews/version.rb

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

data/lib/google_reviews.rb

@@ -5,6 +5,7 @@ require "json"
 require "net/http"
 require "google_reviews/error"
 require "google_reviews/utils"
+require "google_reviews/response"
 require "google_reviews/constants"
 require "google_reviews/api_request"
 require "google_reviews/translations"
@@ -16,25 +17,24 @@ module GoogleReviews
     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)
+      begin
+        data = Utils.execute_place_name_request(url)
+        return GoogleReviews::Response.new unless data
 
-      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)
+        fetch_reviews_by_place_id(api_key, data.first["place_id"])
+      rescue ApiError => e
+        GoogleReviews::Response.new(status: "409", error: e)
+      end
     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)
+      begin
+        Utils.execute_place_id_request(url)
+      rescue ApiError => e
+        GoogleReviews::Response.new(status: "409", error: e)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_reviews
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - gullariz12
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -61,6 +61,8 @@ files:
 - lib/google_reviews/api_request.rb
 - lib/google_reviews/constants.rb
 - lib/google_reviews/error.rb
+- lib/google_reviews/response.rb
+- lib/google_reviews/review.rb
 - lib/google_reviews/translations.rb
 - lib/google_reviews/utils.rb
 - lib/google_reviews/version.rb