vs_client 0.8.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf492a23cc489321334dca187cee0dca6ea6935647960daea046d5d40c4e701a
+  data.tar.gz: 0fe00a98dc3c6712dfcc107ac42d7f736fa01b0532e4222173a2fb98a34d8ac5
+SHA512:
+  metadata.gz: 8ddba1f4b25484bd0a47760daeceec17b2d4bda05db0beed33e9ee6244712c3f41be208b5e6dc0d617ed88c0b8e6840a61fdcfd21855e17201069f93d2cc0d09
+  data.tar.gz: f4a4532720404b8e0152c695495da0ae372d573e21e1e395c111076184c36228df92fa32d226ac4acf62031fd0ff9699ad165107cd53c76bdb71a0aa962ecdc7

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,34 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vs_client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    vs_client (0.8.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    faker (2.18.0)
+      i18n (>= 1.6, < 2)
+    hashdiff (1.0.1)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  faker
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vs_client!
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,75 @@
+# VsClient
+
+Provides a seamless integration with vendor search service for ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vs_client', git: 'https://github.com/HungerStation/vs-client-rb.git'
+```
+
+And then execute:
+
+    $ bundle update --source vs_client
+
+Or install it yourself as:
+
+    $ gem install vs_client
+## Setup
+```ruby
+# if you are on Rails this block should be in:
+# /config/initializers/vs_client.rb
+VsClient.configure do |config|
+  config.url = 'service url goes here' # it should be the vendor search service host.
+  config.api_version = 'version path'  # like '/api/v2'.
+  config.enable_http_debug_mode = true # helps you to see the request lifecycle, should be false over production.
+  config.use_ssl = true                # enable connection over https.
+  config.keep_alive_timeout = 0        # for how long (in seconds) should the server keep tcp connection to be reused.
+  config.timeout = 60                  # how long the client will wait till it gets a response.
+end
+```
+
+## Usage
+
+```ruby
+# GET /filters
+query = {
+  latitude: 24.828453624665187,
+  longitude: 46.640109869734395,
+  home_module_id: 10,
+}
+
+VsClient.get_filters(
+  query: payload,
+  headers: {
+    "Device-Uid" => "008FA000-0000-0000-0000-006E5B1A0000",
+    "App-Version" => "2570",
+    "Accept-Language" => "en"
+  },
+  fallback: -> () { fallback }
+)
+
+def fallback
+  # your logic to handle remote failures for consistency
+  # whenever the client failed to gets data this block will be executed as plan B.
+end
+```
+For practical example check this [Filters Example](https://github.com/HungerStation/vs-client-rb/tree/master/examples/filters.rb)
+## Run Test
+
+    $ rspec spec
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/HungerStation/vs-client-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vs_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/filters.rb

@@ -0,0 +1,101 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+
+require 'vs_client'
+
+VsClient.configure do |config|
+  config.url = 'https://hs-staging.com'
+  config.api_version = '/api/v2'
+  config.enable_http_debug_mode = true
+  config.use_ssl = true
+  config.keep_alive_timeout = 0
+  config.open_timeout = 60
+  config.timeout = 60
+end
+
+payload = {
+  latitude: 24.828453624665187,
+  longitude: 46.640109869734395,
+  home_module_id: 10,
+}
+
+class FiltersService
+  def initialize(payload)
+    @payload = payload
+    init_in_memory_db
+    seed_data
+  end
+
+  def run
+    VsClient.get_filters(
+      query: @payload,
+      headers: {
+        "User-Agent" => 'HungerStation/1576 iPhone/12,3 iOS/14.0 CFNetwork/1197 Darwin/20.0.0',
+        "device-uid" => '008FA000-0000-0000-0000-006E5B1A0000',
+        "app-version" => '1576',
+        "Accept-Language" => 'en',
+      },
+      fallback: -> () { fallback }
+    )
+  end
+
+  private
+
+  def fallback
+    {
+      title: "Kitchens",
+      type: "kitchen_ids",
+      multi_selection: false,
+      filters: @in_memory_db[:filters][:kitchens].map do |kitchen|
+        {
+          id: kitchen[:id],
+          value: kitchen[:name],
+          icon_url: "https://assest.com/#{kitchen[:id]}/#{kitchen[:name]}.png",
+        }
+      end
+    }
+  end
+
+  def init_in_memory_db
+    @in_memory_db = {filters: {kitchens: []}}
+  end
+
+  def seed_data
+    @in_memory_db[:filters][:kitchens] = [
+      {
+        id: 1, 
+        name: "Fast Food"
+      },
+      {
+        id: 2, 
+        name: "Sandwiches"
+      },
+      {
+        id: 3, 
+        name: "Asian"
+      },
+      {
+        id: 4, 
+        name: "Italian"
+      },
+      {
+        id: 5,
+        name: "Dessert"
+      }
+    ]
+  end
+end
+
+response = if ENV["FAIL"]
+              payload.delete(:latitude)
+              FiltersService.new(payload).run
+           else
+              FiltersService.new(payload).run
+           end
+
+
+puts "****************"
+puts "*              *"
+puts "*   RESPONSE   *"
+puts "*              *"
+puts "****************"
+puts response

data/lib/vs_client/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module VsClient
+  class Configuration
+    # url => represent remote service (vendor search url).
+    # use_ssl => must be true if the url start with "https".
+    # enable_http_debug_mode => enable tracing the request phases for debug use only.
+    # logger => represent Custom HSLogger we use in platform.
+    #   we can use different logger that has the same .log implementation.
+    # keep_alive_timeout => represent the time in seconds to keep the current
+    #   tcp session opened for reusing the same tcp connection later.
+    # open_timeout => time taken to open a connection with remote server.
+    # timeout => represent the time in seconds to read the data from remote server.
+    attr_accessor :url, :use_ssl, :enable_http_debug_mode, 
+                  :logger, :keep_alive_timeout, :open_timeout,
+                  :ssl_timeout, :timeout, :api_version
+
+    # Set default values
+    def initialize
+      @logger = nil
+      @use_ssl = true
+      @enable_http_debug_mode = false
+      @keep_alive_timeout = 60
+      @open_timeout = 5
+      @timeout = 5
+      @api_version = ''
+    end
+  end
+end

data/lib/vs_client/net_http.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module VsClient
+  class NetHttp
+    CONTENT_TYPE = 'application/json'
+
+    def initialize(config: VsClient::Configuration.new)
+      @uri = URI(config.url)
+      @enabled_debug_mode = config.enable_http_debug_mode
+      @use_ssl = config.use_ssl
+      @keep_alive_timeout = config.keep_alive_timeout
+      @read_timeout = config.timeout
+      @open_timeout = config.open_timeout
+      @default_api_version = config.api_version
+    end
+
+    # Establish a connection with remote server
+    # @return [Net::HTTP] with opened tcp connection
+    def start_session
+      return session if session&.started?
+
+      session.start
+    end
+
+    # Execute GET requests
+    # @param path[String] represent remote resource
+    # @param payload[Hash] represent params if get request have body
+    # Raise error incase of failure (exceptions, 3xx, 4xx, 5xx)
+    # @return [Hash] represent response after parsing the json (res body)
+    def get(path:, query: nil, payload: nil, headers: {}, desired_api_version: nil)
+      @uri.path = full_path(path: path, desired_api_version: desired_api_version)
+      @uri.query = URI.encode_www_form(query) if query
+
+      @request = Net::HTTP::Get.new(@uri)
+      @request.body = payload.to_json if payload
+
+      inject_headers!(headers)
+      execute
+    end
+
+    # Execute POST requests
+    def post(path:, payload: {}, headers: {}, desired_api_version: nil)
+      @uri.path = full_path(path: path, desired_api_version: desired_api_version)
+      @uri.query = nil
+
+      @request = Net::HTTP::Post.new(@uri)
+      @request.body = payload.to_json
+
+      inject_headers!(headers)
+      execute
+    end
+
+    # Execute DELETE requests
+    def delete(path:, headers: {}, desired_api_version: nil)
+      @uri.path = full_path(path: path, desired_api_version: desired_api_version)
+      @uri.query = nil
+
+      @request = Net::HTTP::Delete.new(@uri)
+      inject_headers!(headers)
+      execute
+    end
+
+    private
+
+    # Represent HTTP session over tcp connection
+    # with the remote server.
+    # @return [Net::HTTP]
+    def session
+      return @session if @session
+
+      @session = Net::HTTP.new(@uri.hostname, @uri.port)
+      @session.set_debug_output(STDOUT) if @enabled_debug_mode
+      @session.use_ssl = @use_ssl
+      @session.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      @session.keep_alive_timeout = @keep_alive_timeout
+      @session.read_timeout = @read_timeout
+      @session.open_timeout = @open_timeout
+      @session
+    end
+
+    def inject_headers!(headers)
+      headers.each do |key, value|
+        @request[key] = value
+      end
+    end
+
+    # Conduct the request over the established tcp connection
+    # throught Net::HTTP (session).
+    # Net::HTTP handle gzip compress/uncompress automatically.
+    # Raise error incase of failure (exceptions, 3xx, 4xx, 5xx)
+    # @return [Hash] represent response after parsing the json (res body)
+    def execute
+      @response = @session.request(@request)
+      @response.body = JSON.parse(@response.body) if json_content? && @response.body
+
+      VsClient::Response.new(@response)
+    end
+
+    # Check if the body is in json format
+    # @return [Boolean]
+    def json_content?
+      @response&.header['Content-Type']&.include?(CONTENT_TYPE)
+    end
+
+    def full_path(path:, desired_api_version: nil)
+      "#{desired_api_version || @default_api_version}#{path}"
+    end
+  end
+end

data/lib/vs_client/response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module VsClient
+  class Response
+    attr_reader :klass, :message, :code, :body
+
+    def initialize(net_http_response)
+      @klass = net_http_response.class.name
+      @message = net_http_response.message
+      @code = net_http_response.code
+      @body = net_http_response.body
+      @success = net_http_response.kind_of?(Net::HTTPSuccess)
+    end
+
+    def succeeded?
+      @success
+    end
+
+    def failed?
+      !succeeded?
+    end
+
+    def klass_name
+      @klass.name
+    end
+  end
+end

data/lib/vs_client/version.rb

@@ -0,0 +1,3 @@
+module VsClient
+  VERSION = "0.8.8"
+end

data/lib/vs_client.rb

@@ -0,0 +1,409 @@
+# frozen_string_literal: true
+
+require 'vs_client/version'
+require 'vs_client/configuration'
+require 'vs_client/response'
+require 'vs_client/net_http'
+
+module VsClient
+  class << self
+    CLIENT_ERROR = 'client'
+    REMOTE_ERROR = 'remote'
+
+    # @return [VsClient::Configuration]
+    def configuration
+      @configuration ||= VsClient::Configuration.new
+    end
+
+    # Override the default configurations
+    def configure
+      yield configuration
+      setup_http_client
+    end
+
+    # GET /filters:
+    # @param query [Hash] keys:
+    #   latitude, float, required
+    #   longitude, float, required
+    #   home_module_id, Integer
+    # @param headers [Hash] represent custom http headers.
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator. 
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_filters(query:, headers: {}, fallback: nil)
+      path = '/filters'
+      @http_client.start_session
+      response = @http_client.get(path: path, query: query, headers: headers)
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, query, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, query, e, headers])
+    end
+
+    # POST /search/recent:
+    # @param payload [Hash] keys:
+    #   home_module_id, integer, required
+    #   search_query, string, required
+    # @param headers [Hash] represent custom http headers.
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator. 
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def create_recent_search(payload:, headers: {}, fallback: nil)
+      path = '/search/recent'
+      @http_client.start_session
+      response = @http_client.post(path: path, payload: payload, headers: headers)
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, payload, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, payload, e, headers])
+    end
+
+    # GET /search/suggestions:
+    # @param query [Hash] keys:
+    #   home_module_id, integer, optional
+    #   latitude, float, required
+    #   longitude, float, required
+    # @param headers [Hash] represent custom http headers.
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator.
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_search_suggestions(query:, headers: {}, fallback: nil)
+      path = '/search/suggestions'
+      @http_client.start_session
+      response = @http_client.get(path: path, query: query, headers: headers)
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, query, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, query, e, headers])
+    end
+
+    # GET /search/autocomplete:
+    # @param query [Hash] keys:
+    #   home_module_id, integer, optional
+    #   latitude, float, required
+    #   longitude, float, required
+    #   search_query, string, required
+    # @param headers [Hash] represent custom http headers.
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator.
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_search_autocomplete(query:, headers: {}, fallback: nil)
+      path = '/search/autocomplete'
+      @http_client.start_session
+      response = @http_client.get(path: path, query: query, headers: headers)
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, query, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, query, e, headers])
+    end
+
+    # POST /swimlanes:
+    # @param payload [Hash] keys:
+    #   home_module_id, integer, optional
+    #   config, string, required
+    #   placement_screen, string, required
+    #   location[:longitude], float, required
+    #   location[:latitude], float, required
+    # @param headers [Hash] represent custom http headers:
+    #   hs-email, string, optional
+    #   hs-user-id, integer, optional
+    #   perseus-client-id, string, required
+    #   perseus-session-id, string, required
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator.
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_swimlanes(payload:, headers: {}, fallback: nil)
+      path = '/swimlanes'
+      @http_client.start_session
+      response = @http_client.post(path: path, payload: payload, headers: headers, desired_api_version: '/api/v3')
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, payload, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, payload, e, headers])
+    end
+
+    # POST /vendors/search:
+    # @param payload [Hash] keys:
+    #   home_module_id, integer, optional
+    #   config, string, required
+    #   search_query, string, required
+    #   location[:longitude], float, required
+    #   location[:latitude], float, required]
+    #   pagination[:page], int, required
+    #   pagination[:limit], int, required
+    #
+    # @param headers [Hash] represent custom http headers:
+    #   hs-email, string, optional
+    #   hs-user-id, integer, optional
+    #   hs-device-uid, string, required
+    #   user-agent, string, required
+    #   hs-is-new-customer, bool, optional
+    #   hs-email-is-verified, bool, optional
+    #   accept-language, string, optional
+    #   perseus-client-id, string, required
+    #   perseus-session-id, string, required
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator.
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_vendors_search(payload:, headers: {}, fallback: nil)
+      path = '/vendors/search'
+      @http_client.start_session
+      response = @http_client.post(path: path, payload: payload, headers: headers, desired_api_version: '/api/v2')
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, payload, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, payload, e, headers])
+    end
+
+    # POST /vendors:
+    # @param payload [Hash] keys:
+    #   home_module_id, integer, optional
+    #   config, string, required
+    #   search_query, string, required
+    #   location[:longitude], float, required
+    #   location[:latitude], float, required
+    #   pagination[:page], int, required
+    #   pagination[:limit], int, required
+    #   filters[][:type, :ids], slice, optional
+    # @param headers [Hash] represent custom http headers:
+    #   hs-email, string, optional
+    #   hs-user-id, integer, optional
+    #   hs-device-uid, string, required
+    #   user-agent, string, required
+    #   hs-is-new-customer, bool, optional
+    #   hs-email-is-verified, bool, optional
+    #   accept-language, string, optional
+    #   perseus-client-id, string, required
+    #   perseus-session-id, string, required
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator.
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_vendors_listing(payload:, headers: {}, fallback: nil)
+      path = '/vendors'
+      @http_client.start_session
+      response = @http_client.post(path: path, payload: payload, headers: headers, desired_api_version: '/api/v2')
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, payload, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, payload, e, headers])
+    end
+
+    # DELETE /search/recent:
+    # @param headers [Hash] represent custom http headers.
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator.
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def delete_recent_search(headers: {}, fallback: nil)
+      path = "/search/recent"
+      @http_client.start_session
+      response = @http_client.delete(path: path, headers: headers)
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, nil, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, nil, e, headers])
+    end
+
+    # DELETE /search/recent/home_modules/{id}:
+    # @param home_module_id [Integer] represent ID.
+    # @param headers [Hash] represent custom http headers.
+    # @param fallback [Lambda] executed on failure
+    #   It should be provided by the initiator.
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def delete_recent_search_by_home_module_id(home_module_id:, headers: {}, fallback: nil)
+      path = "/search/recent/home_modules/#{home_module_id}"
+      @http_client.start_session
+      response = @http_client.delete(path: path, headers: headers)
+      return response.body if response.succeeded?
+
+      handle_failure(fallback, REMOTE_ERROR, [path, nil, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, nil, e, headers])
+    end
+
+    # POST /vendors/premium:
+    # @param payload [Hash] keys:
+    #   home_module_id, integer, optional
+    #   campaign_id, integer, optional
+    #   location[:longitude], float, required
+    #   location[:latitude], float, required
+    #   placement[:screen], string, required
+    #   placement[:place], string, required
+    #   placement[:type], string, required
+    #   filters[:filter_type], string, optional
+    #   filters[:ids], slice, optional
+    # @param headers [Hash] represent custom http headers:
+    #   hs-email, string, optional
+    #   hs-user-id, integer, optional
+    #   hs-device-uid, string, required
+    #   user-agent, string, required
+    #   hs-is-new-customer, bool, optional
+    #   hs-email-is-verified, bool, optional
+    #   accept-language, string, optional
+    #   perseus-client-id, string, required
+    #   perseus-session-id, string, required
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_premium_vendors(payload:, headers: {}, fallback: nil)
+      path = '/vendors/premium'
+      @http_client.start_session
+      response = @http_client.post(path: path, payload: payload, headers: headers, desired_api_version: '/api/v2')
+      return response.body if response.succeeded?
+      handle_failure(fallback, REMOTE_ERROR, [path, payload, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, payload, e, headers])
+    end
+
+    # GET /vendor-coverage/vendors:
+    # @param query [Hash] keys:
+    #   filter[location][lat], float, required
+    #   filter[location][long], float, required
+    #   filter[status][], Array{string}, optional # must be in ["OPEN", "CLOSED", "BUSY", "SOON"]
+    #   filter[vertical_ids][], Array{int}, optional
+    # @param headers [Hash] represent custom http headers:
+    #   Content-Type, string, required # must be application/vnd.api+json
+    #   Accept, string, required # must be application/vnd.api+json
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_vendors_coverage(query:, headers: {}, fallback: nil)
+      path = '/vendor-coverage/vendors'
+      @http_client.start_session
+      headers.merge!(json_api_headers)
+      response = @http_client.get(path: path, query: query, headers: headers)
+      return response.body if response.succeeded?
+      handle_failure(fallback, REMOTE_ERROR, [path, query, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, query, e, headers])
+    end
+
+    # GET /vendor-coverage/{vendor_id}:
+    # @param query [Hash] keys:
+    #   filter[location][lat], float, required
+    #   filter[location][long], float, required
+    # @param headers [Hash] represent custom http headers:
+    #   Content-Type, string, required # must be application/vnd.api+json
+    #   Accept, string, required # must be application/vnd.api+json
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_vendor_coverage(vendor_id:, query:, headers: {}, fallback: nil)
+      path = "/vendor-coverage/#{vendor_id}"
+      @http_client.start_session
+      headers.merge!(json_api_headers)
+      response = @http_client.get(path: path, query: query, headers: headers)
+      return response.body if response.succeeded?
+      handle_failure(fallback, REMOTE_ERROR, [path, query, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, query, e, headers])
+    end
+
+    # GET /campaigns/{id}/vendors:
+    # @param id, integer represent campaign id
+    # @param query [Hash] keys:
+    #   latitude, float, required
+    #   longitude, float, required
+    #   home_module_id, integer, optional
+    #   pagination[page], integer
+    #   pagination[limit], integer
+    # @param headers [Hash] represent custom http headers:
+    #   hs-email, string, optional
+    #   hs-user-id, integer, optional
+    #   hs-device-uid, string, required
+    #   user-agent, string, required
+    #   hs-is-new-customer, bool, optional
+    #   hs-email-is-verified, bool, optional
+    #   accept-language, string, optional
+    #   perseus-client-id, string, required
+    #   perseus-session-id, string, required
+    # @return [Hash] on success
+    # @return [NilClass] if fallback is nil
+    def get_vendors_by_campaign_id(id:, query:, headers: {}, fallback: nil)
+      path = "/campaigns/#{id}/vendors"
+      @http_client.start_session
+      response = @http_client.get(path: path, query: query, headers: headers)
+      return response.body if response.succeeded?
+      handle_failure(fallback, REMOTE_ERROR, [path, query, response, headers])
+    rescue => e
+      handle_failure(fallback, CLIENT_ERROR, [path, query, e, headers])
+    end
+
+    private
+
+    # Initialize the http client
+    def setup_http_client
+      @http_client = VsClient::NetHttp.new(config: configuration)
+    end
+
+    # Static JSONAPI headers
+    def json_api_headers
+      {
+        "Content-Type" => "application/vnd.api+json",
+        "Accept" => "application/vnd.api+json"
+      }
+    end
+    
+    # If the client has been initialized with no logger at all
+    # will not push any logs.
+    # Execute any given fallback
+    # @param fallback [proc/lambda]
+    # @param type [Constant] represent type of the error (client/remote).
+    # @param args [Array] represent the arguments
+    #  of the log function will be executed, based on the type.
+    def handle_failure(fallback, type, args)
+      send("log_#{type}_error", *args) if logger
+      return fallback.call if fallback
+    end
+
+    # Represent the injected logger (Custom::HsLogger)
+    def logger
+      @logger ||= configuration.logger
+    end
+
+    # Log remote errors based on endpoints
+    # @param endpoint [String] represent path of the resource.
+    # @param response [VsClient::Response]
+    def log_remote_error(endpoint, payload, response, headers)
+      logger.log(
+        severity: 'ERROR',
+        title: '[Vendor Search Service]: Remote Failed',
+        custom_headers: headers,
+        endpoint: endpoint,
+        payload: payload,
+        error: response.klass,
+        error_msg: response.message,
+        error_code: response.code,
+        error_body: response.body,
+      )
+    end
+
+    # Log client errors based on endpoints
+    # @param endpoint [String] represent path of the resource.
+    # @param error [Exception]
+    def log_client_error(endpoint, payload, error, headers)
+      logger.log(
+        severity: 'ERROR',
+        title: '[Vendor Search Service]: Client Failed',
+        custom_headers: headers,
+        endpoint: endpoint,
+        payload: payload,
+        error: error.class.name,
+        error_msg: error.message,
+      )
+    end
+  end
+end

data/vs_client.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vs_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vs_client"
+  spec.version       = VsClient::VERSION
+  spec.authors       = ["Rudy Zidan"]
+  spec.email         = ["rudy.zidan@hungerstation.com"]
+
+  spec.summary       = "Vendor search service client for ruby"
+  spec.license       = "MIT"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "faker"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: vs_client
+version: !ruby/object:Gem::Version
+  version: 0.8.8
+platform: ruby
+authors:
+- Rudy Zidan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- rudy.zidan@hungerstation.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/codeql-analysis.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/filters.rb
+- lib/vs_client.rb
+- lib/vs_client/configuration.rb
+- lib/vs_client/net_http.rb
+- lib/vs_client/response.rb
+- lib/vs_client/version.rb
+- vs_client.gemspec
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Vendor search service client for ruby
+test_files: []