algolia 2.0.0.pre.alpha.2

data/lib/algolia/iterators/base_iterator.rb

@@ -0,0 +1,19 @@
+module Algolia
+  class BaseIterator
+    include Helpers
+    include Enumerable
+
+    attr_reader :transporter, :index_name, :opts
+
+    # @param transporter    [Transport::Transport]  transporter used for requests
+    # @param index_name    [String]  Name of the index
+    # @param opts [Hash] contains extra parameters to send with your query
+    #
+    def initialize(transporter, index_name, opts)
+      @transporter = transporter
+      @index_name  = index_name
+      @opts        = opts
+      @response    = nil
+    end
+  end
+end

data/lib/algolia/iterators/object_iterator.rb

@@ -0,0 +1,27 @@
+module Algolia
+  class ObjectIterator < BaseIterator
+    # Custom each function to iterate through the objects
+    #
+    def each
+      loop do
+        data = {}
+
+        if @response
+          if @response[:hits].length
+            @response[:hits].each do |hit|
+              yield hit
+            end
+
+            if @response[:cursor].nil?
+              @response = nil
+              raise StopIteration
+            else
+              data[:cursor] = @response[:cursor]
+            end
+          end
+        end
+        @response = @transporter.read(:POST, path_encode('1/indexes/%s/browse', @index_name), data, @opts)
+      end
+    end
+  end
+end

data/lib/algolia/iterators/paginator_iterator.rb

@@ -0,0 +1,44 @@
+module Algolia
+  class PaginatorIterator < BaseIterator
+    # @param transporter    [Transport::Transport]  transporter used for requests
+    # @param index_name    [String]  Name of the index
+    # @param opts [Hash] contains extra parameters to send with your query
+    #
+    def initialize(transporter, index_name, opts)
+      super(transporter, index_name, opts)
+
+      @data = {
+        hitsPerPage: 1000,
+        page: 0
+      }
+    end
+
+    def each
+      loop do
+        if @response
+          if @response[:hits].length
+            @response[:hits].each do |hit|
+              hit.delete(:_highlightResult)
+              yield hit
+            end
+
+            if @response[:nbHits] < @data[:hitsPerPage]
+              @response = nil
+              @data     = {
+                hitsPerPage: 1000,
+                page: 0
+              }
+              raise StopIteration
+            end
+          end
+        end
+        @response     = @transporter.read(:POST, get_endpoint, @data, @opts)
+        @data[:page] += 1
+      end
+    end
+
+    def get_endpoint
+      raise AlgoliaError, 'Method must be implemented'
+    end
+  end
+end

data/lib/algolia/iterators/rule_iterator.rb

@@ -0,0 +1,9 @@
+module Algolia
+  class RuleIterator < PaginatorIterator
+    # Creates the endpoint on which to fetch rules
+    #
+    def get_endpoint
+      path_encode('1/indexes/%s/rules/search', @index_name)
+    end
+  end
+end

data/lib/algolia/iterators/synonym_iterator.rb

@@ -0,0 +1,9 @@
+module Algolia
+  class SynonymIterator < PaginatorIterator
+    # Creates the endpoint on which to fetch synonyms
+    #
+    def get_endpoint
+      path_encode('1/indexes/%s/synonyms/search', @index_name)
+    end
+  end
+end

data/lib/algolia/logger_helper.rb

@@ -0,0 +1,14 @@
+require 'logger'
+
+module Algolia
+  class LoggerHelper
+    # @param debug_file [nil|String] file used to output the logs
+    #
+    def self.create(debug_file = nil)
+      file              = debug_file || File.new('debug.log')
+      instance          = ::Logger.new file
+      instance.progname = 'algolia'
+      instance
+    end
+  end
+end

data/lib/algolia/recommendation_client.rb

@@ -0,0 +1,60 @@
+module Algolia
+  module Recommendation
+    class Client
+      # Initializes the Recommendation client
+      #
+      # @param recommendation_config [Recommendation::Config] a Recommendation::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(recommendation_config, opts = {})
+        @config      = recommendation_config
+        adapter      = opts[:adapter] || Defaults::ADAPTER
+        logger       = opts[:logger] || LoggerHelper.create('debug.log')
+        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 = Recommendation::Config.new(app_id: app_id, api_key: api_key)
+        create_with_config(config)
+      end
+
+      # Create a new client providing only an Recommendation::Config object
+      #
+      # @param config [Recommendation::Config]
+      #
+      # @return self
+      #
+      def self.create_with_config(config)
+        new(config)
+      end
+
+      # Set the personalization strategy.
+      #
+      # @param personalization_strategy [Hash] A strategy object.
+      #
+      # @return [Hash]
+      #
+      def set_personalization_strategy(personalization_strategy, opts = {})
+        @transporter.write(:POST, '1/strategies/personalization', personalization_strategy, opts)
+      end
+
+      # Get the personalization strategy.
+      #
+      # @return [Hash]
+      #
+      def get_personalization_strategy(opts = {})
+        @transporter.read(:GET, '1/strategies/personalization', {}, opts)
+      end
+    end
+  end
+end

data/lib/algolia/responses/add_api_key_response.rb

@@ -0,0 +1,38 @@
+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 / 1000)
+        end
+      end
+
+      self
+    end
+  end
+end

data/lib/algolia/responses/base_response.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,40 @@
+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 / 1000)
+          end
+        end
+      end
+
+      self
+    end
+  end
+end

data/lib/algolia/responses/indexing_response.rb

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,45 @@
+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

@@ -0,0 +1,36 @@
+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 / 1000)
+        end
+      end
+
+      self
+    end
+  end
+end

data/lib/algolia/responses/update_api_key_response.rb

@@ -0,0 +1,39 @@
+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 / 1000)
+        end
+      end
+
+      self
+    end
+  end
+end