datashake-ruby-sdk 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e9bef7b0a5f2b6c4722b987796279e4699aa1f9e6fdf1eabf26bfde0fa65963
-  data.tar.gz: 28126f4e94e3cde865901dbaa0dd0edd6cc71c110e1ca0f22b8ae680758ecfda
+  metadata.gz: 4f0df80b56b9b5f976b62f206111490edef96fd7b77a564745467fabc37e7b15
+  data.tar.gz: 5f117c1c58754f37ceaa60eb8a595a603050d5217ae521bdc7ff59c472bd80f2
 SHA512:
-  metadata.gz: f3332643deab9ec63978d325db02d3584d3de04589b12b3b442dddf6edeffd1073349edcfd6c095bf6845c63cdb6905d5e27e0e4380b0756c1c5dbbe9ce73fc2
-  data.tar.gz: d71f31d8b30f75f22571bd47249617540b9c1a54954ba34e6cdb7da24be8583c39babaf9b39e52b09351ce40700085387595fd3ba2a81655eeac7f5117234dba
+  metadata.gz: b0ed0de9d0cfa2336b34d3c2e0817647eb95d17d72cf42084aa1c4b85f26f28a4409db9cde566d9ca49abca31bd25115dbc3da0e250506bb37cac9409cdf57b8
+  data.tar.gz: c48aa5f0cf6a1a6fef42a673a5fab41a8fb66505f2a2e9c74e178edc193cd5dbd6f950489c7c1ada7c626605f0beb56478e8336806def459f35b87675d6f3e3e

data/README.md

@@ -1,4 +1,4 @@
-# datashake-ruby-sdk
+# Datashake Ruby SDK ![Build status](https://github.com/reviewshake/datashake-ruby-sdk/actions/workflows/main.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/datashake-ruby-sdk.svg)](https://badge.fury.io/rb/datashake-ruby-sdk)
 
 An API wrapper written in ruby for Datashake API
 https://docs.datashake.com/
@@ -39,6 +39,22 @@ client.info.job_id(346998013).fetch # Fetch job details
 client.reviews.job_id(346998013).page(2).per_page(10).fetch # Fetch reviews for the given job
   ```
 
+```ruby
+client = Datashake::ReviewIndex::Client.new(token: 'your-api-token')
+
+response = client # Get reviews from RIAPI
+  .reviews
+  .callback("https://myserver.com/callbacks/reviews")
+  .name("McDonalds")
+  .city("Tbilisi")
+  .fetch
+
+response.success => true
+response.request_id => "1665992737596342636-004fd578-fd32-41"
+response.status => 201
+response.message => "Your task was successfully submitted."
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -54,6 +70,10 @@ To release a new version, update the version number in `version.rb`, and then ru
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/reviewshake/datashake-ruby-sdk.
 
+## Release
+
+Bump the version number in https://github.com/reviewshake/datashake-ruby-sdk/blob/main/lib/datashake-ruby-sdk/version.rb, create a release with github and a tag from the new version number. After doing the github release, build the gem (`gem build`) from your terminal and push (`gem push`) the new version rubygems https://rubygems.org/gems/datashake-ruby-sdk. You need to be a gem owner in order to do this.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/datashake-ruby-sdk/review_index/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Datashake
+  module ReviewIndex
+    class Client
+      BASE_URL = "https://reviewindexapi.datashake.com"
+
+      attr_reader :token
+
+      def initialize(token:, adapter: Faraday.default_adapter, timeout: 30, open_timeout: 30)
+        @token = token
+        @adapter = adapter
+        @timeout = timeout
+        @open_timeout = open_timeout
+      end
+
+      def connection
+        @connection ||= Faraday.new do |conn|
+          conn.url_prefix = BASE_URL
+          conn.request(:json)
+          conn.response(:json, content_type: "application/json")
+          conn.options.timeout = timeout
+          conn.options.open_timeout = open_timeout
+          conn.adapter(adapter)
+        end
+      end
+
+      def v1
+        @v1 ||= V1.new(self)
+      end
+
+      def profiles
+        v1.profiles
+      end
+
+      def reviews
+        v1.reviews
+      end
+
+      def update_status
+        v1.update_status
+      end
+
+      private
+
+      attr_reader :adapter, :timeout, :open_timeout
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1/base_endpoint.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Datashake
+  module ReviewIndex
+    class V1
+      class BaseEndpoint
+        def self.request_parameters(request_parameters)
+          request_parameters.each do |param_name|
+            define_method(param_name) do |value|
+              @params[param_name] = value
+
+              self
+            end
+          end
+        end
+
+        def initialize(version)
+          @version = version
+          @params = {}
+        end
+
+        def fetch
+          response = version.fetch(method: :get, path: endpoint_path, params: params)
+
+          response_class.new(response)
+        end
+
+        def response_class
+          raise NotImplementedError, "Implement it in a successor class"
+        end
+
+        def endpoint_path
+          raise NotImplementedError, "Implement it in a successor class"
+        end
+
+        private
+
+        attr_reader :version, :params
+      end
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1/error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Datashake
+  module ReviewIndex
+    class V1
+      class Error < StandardError
+        attr_reader :status
+
+        def initialize(msg, status)
+          @status = status
+
+          super(msg)
+        end
+      end
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1/profiles.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Datashake
+  module ReviewIndex
+    class V1
+      class Profiles < BaseEndpoint
+        PATH = "profiles"
+
+        request_parameters %i[
+          address
+          callback
+          city
+          country
+          domain
+          external_identifier
+          name
+          page_number
+          per_page
+          phone_number
+          state
+          street
+          ticker_symbol
+          update
+          zip_code
+        ]
+
+        def response_class
+          Datashake::ReviewIndex::V1::Response
+        end
+
+        def endpoint_path
+          PATH
+        end
+      end
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1/response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+module Datashake
+  module ReviewIndex
+    class V1
+      class Response < ::Dry::Struct
+        transform_keys(&:to_sym)
+
+        attribute :success, Datashake::Types::Strict::Bool
+        attribute? :request_id, Datashake::Types::Strict::String
+        attribute :http_status, Datashake::Types::Strict::Integer
+        attribute :message, Datashake::Types::Strict::String
+        attribute? :credits_used, Datashake::Types::Strict::Integer
+        attribute? :details, Datashake::Types::Strict::String
+      end
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1/reviews.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Datashake
+  module ReviewIndex
+    class V1
+      class Reviews < BaseEndpoint
+        PATH = "reviews"
+
+        request_parameters %i[
+          address
+          callback
+          city
+          country
+          diff
+          domain
+          external_identifier
+          from_date
+          name
+          page_number
+          per_page
+          phone_number
+          review_site
+          state
+          street
+          ticker_symbol
+          timeseries
+          to_date
+          update
+          zip_code
+        ]
+
+        def response_class
+          Datashake::ReviewIndex::V1::Response
+        end
+
+        def endpoint_path
+          PATH
+        end
+      end
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1/status_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+module Datashake
+  module ReviewIndex
+    class V1
+      class StatusResponse < ::Dry::Struct
+        transform_keys(&:to_sym)
+
+        attribute :request_id, Datashake::Types::Strict::String
+        attribute :http_status, Datashake::Types::Strict::Integer
+        attribute :status, Datashake::Types::Strict::String
+        attribute :created_at, Datashake::Types::Strict::String
+        attribute :completeness_rate, Datashake::Types::Strict::Float
+        attribute :success_rate, Datashake::Types::Strict::Float
+        attribute :size, Datashake::Types::Strict::Integer
+      end
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1/update_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datashake
+  module ReviewIndex
+    class V1
+      class UpdateStatus < BaseEndpoint
+        PATH = "update/status"
+
+        request_parameters [:request_id]
+
+        def response_class
+          Datashake::ReviewIndex::V1::StatusResponse
+        end
+
+        def endpoint_path
+          PATH
+        end
+      end
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index/v1.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Datashake
+  module ReviewIndex
+    class V1
+      autoload :BaseEndpoint, "datashake-ruby-sdk/review_index/v1/base_endpoint"
+      autoload :Error, "datashake-ruby-sdk/review_index/v1/error"
+      autoload :Profiles, "datashake-ruby-sdk/review_index/v1/profiles"
+      autoload :Response, "datashake-ruby-sdk/review_index/v1/response"
+      autoload :StatusResponse, "datashake-ruby-sdk/review_index/v1/status_response"
+      autoload :Reviews, "datashake-ruby-sdk/review_index/v1/reviews"
+      autoload :UpdateStatus, "datashake-ruby-sdk/review_index/v1/update_status"
+
+      def initialize(client)
+        @client = client
+      end
+
+      def profiles
+        @profiles ||= Profiles.new(self)
+      end
+
+      def reviews
+        @reviews ||= Reviews.new(self)
+      end
+
+      def update_status
+        @update_status ||= UpdateStatus.new(self)
+      end
+
+      def connection
+        client.connection
+      end
+
+      def fetch(method:, path:, params: {}, body: {})
+        response = connection.public_send(method, path) do |request|
+          request.params = params
+          request.params[:api_key] = client.token
+          request.body = body.to_json
+        end
+
+        body = response.body
+        body["http_status"] = response.status
+
+        return body if body["success"] || success_status?(response.status)
+
+        raise Datashake::ReviewIndex::V1::Error.new(
+          body["message"],
+          body["http_status"]
+        )
+      end
+
+      def success_status?(status)
+        [200, 201].include?(status)
+      end
+
+      private
+
+      attr_reader :client
+    end
+  end
+end

data/lib/datashake-ruby-sdk/review_index.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Datashake
+  module ReviewIndex
+    autoload :Client, "datashake-ruby-sdk/review_index/client"
+    autoload :V1, "datashake-ruby-sdk/review_index/v1"
+  end
+end

data/lib/datashake-ruby-sdk/review_scraper/v2/profile_instance.rb

@@ -15,13 +15,13 @@ module Datashake
         attribute :source_name, Datashake::Types::Strict::String
         attribute :place_id, Datashake::Types::Strict::String.optional
         attribute :external_identifier, Datashake::Types::Strict::String.optional
-        attribute :meta_data, Datashake::Types::Metadata
+        attribute :meta_data, Datashake::Types::Metadata.optional
         attribute :unique_id, Datashake::Types::Strict::String.optional
-        attribute :review_count, Datashake::Types::Strict::Integer
-        attribute :average_rating, Datashake::Types::Strict::Float
-        attribute :last_crawl, Datashake::Types::Params::Date
+        attribute :review_count, Datashake::Types::Strict::Integer.optional
+        attribute :average_rating, Datashake::Types::Strict::Float.optional
+        attribute :last_crawl, Datashake::Types::Params::Date.optional
         attribute :crawl_status, Datashake::Types::Strict::String
-        attribute :percentage_complete, Datashake::Types::Strict::Integer
+        attribute :percentage_complete, Datashake::Types::Coercible::Integer
         attribute :result_count, Datashake::Types::Strict::Integer
         attribute :credits_used, Datashake::Types::Strict::Integer
         attribute :from_date, Datashake::Types::Params::Date.optional

data/lib/datashake-ruby-sdk/version.rb

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

data/lib/datashake-ruby-sdk.rb

@@ -3,6 +3,7 @@
 require_relative "datashake-ruby-sdk/version"
 
 module Datashake
+  autoload :ReviewIndex, "datashake-ruby-sdk/review_index"
   autoload :ReviewScraper, "datashake-ruby-sdk/review_scraper"
   autoload :Types, "datashake-ruby-sdk/types"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datashake-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Reviewshake <3 Datashake
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-08 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-description:
+description: 
 email:
 - dev@shake.io
 executables: []
@@ -52,6 +52,16 @@ files:
 - README.md
 - Rakefile
 - lib/datashake-ruby-sdk.rb
+- lib/datashake-ruby-sdk/review_index.rb
+- lib/datashake-ruby-sdk/review_index/client.rb
+- lib/datashake-ruby-sdk/review_index/v1.rb
+- lib/datashake-ruby-sdk/review_index/v1/base_endpoint.rb
+- lib/datashake-ruby-sdk/review_index/v1/error.rb
+- lib/datashake-ruby-sdk/review_index/v1/profiles.rb
+- lib/datashake-ruby-sdk/review_index/v1/response.rb
+- lib/datashake-ruby-sdk/review_index/v1/reviews.rb
+- lib/datashake-ruby-sdk/review_index/v1/status_response.rb
+- lib/datashake-ruby-sdk/review_index/v1/update_status.rb
 - lib/datashake-ruby-sdk/review_scraper.rb
 - lib/datashake-ruby-sdk/review_scraper/client.rb
 - lib/datashake-ruby-sdk/review_scraper/v2.rb
@@ -79,7 +89,7 @@ licenses:
 metadata:
   homepage_uri: https://docs.datashake.com
   source_code_uri: https://github.com/reviewshake/datashake-ruby-sdk
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -94,8 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: An API wrapper for Datashake API
 test_files: []