algolia 2.3.4 → 3.0.0.alpha.2

data/lib/algolia/recommend_client.rb

@@ -1,134 +0,0 @@
-module Algolia
-  module Recommend
-    class Model
-      BOUGHT_TOGETHER  = 'bought-together'
-      RELATED_PRODUCTS = 'related-products'
-    end
-
-    class Client
-      include Helpers
-
-      # Initializes the Recommend client
-      #
-      # @param recommend_config [Recommend::Config] a Recommend::Config object which contains your APP_ID and API_KEY
-      # @option adapter [Object] adapter object used for the connection
-      # @option logger [Object]
-      # @option http_requester [Object] http_requester object used for the connection
-      #
-      def initialize(recommend_config, opts = {})
-        @config      = recommend_config
-        adapter      = opts[:adapter] || Defaults::ADAPTER
-        logger       = opts[:logger] || LoggerHelper.create
-        requester    = opts[:http_requester] || Defaults::REQUESTER_CLASS.new(adapter, logger)
-        @transporter = Transport::Transport.new(@config, requester)
-      end
-
-      # Create a new client providing only app ID and API key
-      #
-      # @param app_id [String] Algolia application ID
-      # @param api_key [String] Algolia API key
-      #
-      # @return self
-      #
-      def self.create(app_id, api_key)
-        config = Recommend::Config.new(application_id: app_id, api_key: api_key)
-        create_with_config(config)
-      end
-
-      # Create a new client providing only an Recommend::Config object
-      #
-      # @param config [Recommend::Config]
-      #
-      # @return self
-      #
-      def self.create_with_config(config)
-        new(config)
-      end
-
-      # Get recommendation for the given queries
-      #
-      # @param requests [Array<Hash>] the queries to retrieve recommendations for
-      # @param opts [Hash] extra parameters to send with your request
-      #
-      # @return [Hash]
-      #
-      def get_recommendations(requests, opts = {})
-        @transporter.write(
-          :POST,
-          '/1/indexes/*/recommendations',
-          { requests: format_recommendation_requests(symbolize_all(requests)) },
-          opts
-        )
-      end
-
-      # Get related products for the given requests
-      #
-      # @param requests [Array<Hash>] the requests to get related products for
-      # @param opts [Hash] extra parameters to send with your request
-      #
-      # @return [Hash]
-      #
-      def get_related_products(requests, opts = {})
-        get_recommendations(
-          set_request_models(symbolize_all(requests), Model::RELATED_PRODUCTS),
-          opts
-        )
-      end
-
-      # Get frequently bought together items for the given requests
-      #
-      # @param requests [Array<Hash>] the requests to get frequently bought together items for
-      # @param opts [Hash] extra parameters to send with your request
-      #
-      # @return [Hash]
-      #
-      def get_frequently_bought_together(requests, opts = {})
-        get_recommendations(
-          set_request_models(symbolize_all(requests), Model::BOUGHT_TOGETHER),
-          opts
-        )
-      end
-
-      private
-
-      # Symbolize all hashes in an array
-      #
-      # @param hash_array [Array<Hash<String|Symbol, any>>] the hashes to symbolize
-      #
-      # @return [Array<Hash<Symbol, any>>]
-      #
-      def symbolize_all(hash_array)
-        hash_array.map { |q| symbolize_hash(q) }
-      end
-
-      # Format the recommendation requests
-      #
-      # @param requests [Array<Hash>] the requests to retrieve recommendations for
-      #
-      # @return [Array<Hash>]
-      #
-      def format_recommendation_requests(requests)
-        requests.map do |request|
-          request[:threshold] = 0 unless request[:threshold].is_a? Numeric
-          request.delete(:fallbackParameters) if request[:model] == Model::BOUGHT_TOGETHER
-
-          request
-        end
-      end
-
-      # Force the requests to target a specific model
-      #
-      # @param requests [Array<Hash>] the requests to change
-      # @param model [String] the model to enforce
-      #
-      # @return [Array<Hash>]
-      #
-      def set_request_models(requests, model)
-        requests.map do |query|
-          query[:model] = model
-          query
-        end
-      end
-    end
-  end
-end

data/lib/algolia/recommendation_client.rb

@@ -1,7 +0,0 @@
-module Algolia
-  module Recommendation
-    # <b>DEPRECATED:</b> Please use <tt>Algolia::Personalization::Client</tt> instead.
-    class Client < Algolia::Personalization::Client
-    end
-  end
-end

data/lib/algolia/responses/add_api_key_response.rb

@@ -1,38 +0,0 @@
-module Algolia
-  class AddApiKeyResponse < BaseResponse
-    attr_reader :raw_response
-
-    # @param client [Search::Client] Algolia Search Client used for verification
-    # @param response [Hash] Raw response from the client
-    #
-    def initialize(client, response)
-      @client       = client
-      @raw_response = response
-      @done         = false
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(opts = {})
-      retries_count = 1
-
-      until @done
-        begin
-          @client.get_api_key(@raw_response[:key], opts)
-          @done = true
-        rescue AlgoliaError => e
-          if e.code != 404
-            raise e
-          end
-          retries_count    += 1
-          time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-          sleep(time_before_retry.to_f / 1000)
-        end
-      end
-
-      self
-    end
-  end
-end

data/lib/algolia/responses/base_response.rb

@@ -1,9 +0,0 @@
-module Algolia
-  class BaseResponse
-    include Helpers
-
-    def wait
-      raise StandardError, 'This method should be implemented'
-    end
-  end
-end

data/lib/algolia/responses/delete_api_key_response.rb

@@ -1,40 +0,0 @@
-module Algolia
-  class DeleteApiKeyResponse < BaseResponse
-    attr_reader :raw_response
-
-    # @param client [Search::Client] Algolia Search Client used for verification
-    # @param response [Hash] Raw response from the client
-    # @param key [String] the key to check
-    #
-    def initialize(client, response, key)
-      @client       = client
-      @raw_response = response
-      @key          = key
-      @done         = false
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(opts = {})
-      retries_count = 1
-
-      until @done
-        begin
-          @client.get_api_key(@key, opts)
-        rescue AlgoliaError => e
-          @done = e.code == 404
-
-          unless @done
-            retries_count    += 1
-            time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-            sleep(time_before_retry.to_f / 1000)
-          end
-        end
-      end
-
-      self
-    end
-  end
-end

data/lib/algolia/responses/dictionary_response.rb

@@ -1,33 +0,0 @@
-module Algolia
-  class DictionaryResponse < BaseResponse
-    include CallType
-
-    attr_reader :raw_response
-
-    # @param client [Search::Client] Algolia Search Client used for verification
-    # @param response [Hash] Raw response from the client
-    #
-    def initialize(client, response)
-      @client       = client
-      @raw_response = response
-      @done         = false
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(_opts = {})
-      until @done
-        res    = @client.custom_request({}, path_encode('/1/task/%s', @raw_response[:taskID]), :GET, READ)
-        status = get_option(res, 'status')
-        if status == 'published'
-          @done = true
-        end
-        sleep(Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY / 1000)
-      end
-
-      self
-    end
-  end
-end

data/lib/algolia/responses/indexing_response.rb

@@ -1,28 +0,0 @@
-module Algolia
-  class IndexingResponse < BaseResponse
-    attr_reader :raw_response
-
-    # @param index [Search::Index] Algolia Search Index used for verification
-    # @param response [Hash] Raw response from the client
-    #
-    def initialize(index, response)
-      @index        = index
-      @raw_response = response
-      @done         = false
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(opts = {})
-      unless @done
-        task_id = get_option(@raw_response, 'taskID')
-        @index.wait_task(task_id, Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, opts)
-      end
-
-      @done = true
-      self
-    end
-  end
-end

data/lib/algolia/responses/multiple_batch_indexing_response.rb

@@ -1,29 +0,0 @@
-module Algolia
-  class MultipleIndexBatchIndexingResponse < BaseResponse
-    attr_reader :raw_response
-
-    # @param client [Search::Client] Algolia Search Client used for verification
-    # @param response [Hash] Raw response from the client
-    #
-    def initialize(client, response)
-      @client       = client
-      @raw_response = response
-      @done         = false
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(opts = {})
-      unless @done
-        @raw_response[:taskID].each do |index_name, task_id|
-          @client.wait_task(index_name, task_id, Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, opts)
-        end
-      end
-
-      @done = true
-      self
-    end
-  end
-end

data/lib/algolia/responses/multiple_response.rb

@@ -1,45 +0,0 @@
-module Algolia
-  class MultipleResponse < BaseResponse
-    include Enumerable
-
-    # @param responses [nil|Array] array of raw responses, when provided
-    #
-    def initialize(responses = nil)
-      @raw_responses = responses || []
-    end
-
-    # Fetch the last element of the responses
-    #
-    def last
-      @raw_responses[@raw_responses.length - 1]
-    end
-
-    # Add a new response to responses
-    #
-    def push(response)
-      @raw_responses.push(response)
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(opts = {})
-      @raw_responses.each do |response|
-        response.wait(opts)
-      end
-
-      @raw_responses = []
-
-      self
-    end
-
-    # Iterates through the responses
-    #
-    def each
-      @raw_responses.each do |response|
-        yield response
-      end
-    end
-  end
-end

data/lib/algolia/responses/restore_api_key_response.rb

@@ -1,36 +0,0 @@
-module Algolia
-  class RestoreApiKeyResponse < BaseResponse
-    # @param index [Search::Index] Algolia Search Index used for verification
-    # @param key [String] the key to check
-    #
-    def initialize(client, key)
-      @client = client
-      @key    = key
-      @done   = false
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(opts = {})
-      retries_count = 1
-
-      until @done
-        begin
-          @client.get_api_key(@key, opts)
-          @done = true
-        rescue AlgoliaError => e
-          if e.code != 404
-            raise e
-          end
-          retries_count    += 1
-          time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-          sleep(time_before_retry.to_f / 1000)
-        end
-      end
-
-      self
-    end
-  end
-end

data/lib/algolia/responses/update_api_key_response.rb

@@ -1,39 +0,0 @@
-module Algolia
-  class UpdateApiKeyResponse < BaseResponse
-    include Helpers
-    attr_reader :raw_response
-
-    # @param client [Search::Client] Algolia Search Client used for verification
-    # @param response [Hash] Raw response from the client
-    # @param request_options [Hash] request_options used to find the api key
-    #
-    def initialize(client, response, request_options)
-      @client          = client
-      @raw_response    = response
-      @request_options = request_options
-      @done            = false
-    end
-
-    # Wait for the task to complete
-    #
-    # @param opts [Hash] contains extra parameters to send with your query
-    #
-    def wait(opts = {})
-      retries_count = 1
-
-      until @done
-        begin
-          api_key = @client.get_api_key(@raw_response[:key], opts)
-          @done   = hash_includes_subset?(api_key, @request_options)
-        rescue AlgoliaError => e
-          raise e unless e.code == 404
-          retries_count    += 1
-          time_before_retry = retries_count * Defaults::WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY
-          sleep(time_before_retry.to_f / 1000)
-        end
-      end
-
-      self
-    end
-  end
-end