algolia 2.3.3 → 3.0.0.alpha.2

data/lib/algolia/defaults.rb

@@ -1,35 +0,0 @@
-module Defaults
-  REQUESTER_CLASS = Algolia::Http::HttpRequester
-  ADAPTER         = 'net_http_persistent'
-  TTL             = 300
-  # The version of the REST API implemented by this module.
-  VERSION         = 1
-
-  # HTTP Headers
-  # ----------------------------------------
-
-  # The HTTP header used for passing your application ID to the Algolia API.
-  HEADER_APP_ID            = 'X-Algolia-Application-Id'.freeze
-
-  # The HTTP header used for passing your API key to the Algolia API.
-  HEADER_API_KEY           = 'X-Algolia-API-Key'.freeze
-
-  # HTTP ERROR CODES
-  # ----------------------------------------
-
-  ERROR_BAD_REQUEST = 400
-  ERROR_FORBIDDEN   = 403
-  ERROR_NOT_FOUND   = 404
-  ERROR_TIMED_OUT   = 408
-
-  BATCH_SIZE      = 1000
-  CONNECT_TIMEOUT = 2
-  READ_TIMEOUT    = 5
-  WRITE_TIMEOUT   = 30
-  USER_AGENT      = "Algolia for Ruby (#{Algolia::VERSION}), Ruby (#{RUBY_VERSION})"
-
-  WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY = 100
-
-  GZIP_ENCODING = 'gzip'
-  NONE_ENCODING = 'none'
-end

data/lib/algolia/helpers.rb

@@ -1,134 +0,0 @@
-require 'multi_json'
-
-module Helpers
-  # Convert an Hash to json
-  #
-  def to_json(body)
-    body.is_a?(String) ? body : MultiJson.dump(body)
-  end
-
-  # Converts each key of a hash to symbols
-  #
-  def symbolize_hash(hash)
-    hash.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-  end
-
-  # Convert params to a full query string
-  #
-  def handle_params(params)
-    params.nil? || params.empty? ? '' : "?#{to_query_string(params)}"
-  end
-
-  # Create a query string from params
-  #
-  def to_query_string(params)
-    params.map do |key, value|
-      "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
-    end.join('&')
-  end
-
-  # Convert a json object to an hash
-  #
-  def json_to_hash(json, symbolize_keys)
-    MultiJson.load(json, symbolize_keys: symbolize_keys)
-  end
-
-  # Retrieve the given value associated with a key, in string or symbol format
-  #
-  def get_option(hash, key)
-    hash[key.to_sym] || hash[key] || nil
-  end
-
-  # Build a path with the given arguments
-  #
-  def path_encode(path, *args)
-    arguments = []
-    args.each do |arg|
-      arguments.push(CGI.escape(CGI.unescape(arg.to_s)))
-    end
-
-    format(path, *arguments)
-  end
-
-  # Support to convert old settings to their new names
-  #
-  def deserialize_settings(data, symbolize_keys)
-    settings = data
-    keys     = {
-      attributesToIndex: 'searchableAttributes',
-      numericAttributesToIndex: 'numericAttributesForFiltering',
-      slaves: 'replicas'
-    }
-
-    keys.each do |deprecated_key, current_key|
-      deprecated_key = symbolize_keys ? deprecated_key : deprecated_key.to_s
-      if settings.has_key?(deprecated_key)
-        key           = symbolize_keys ? current_key.to_sym : current_key.to_s
-        settings[key] = settings.delete(deprecated_key)
-      end
-    end
-
-    settings
-  end
-
-  def self.included(base)
-    base.extend(Helpers)
-  end
-
-  def hash_includes_subset?(hash, subset)
-    res = true
-    subset.each do |k, v|
-      res &&= hash[k] == v
-    end
-    res
-  end
-
-  # Check the passed object to determine if it's an array
-  #
-  # @param object [Object]
-  #
-  def check_array(object)
-    raise Algolia::AlgoliaError, 'argument must be an array of objects' unless object.is_a?(Array)
-  end
-
-  # Check the passed object
-  #
-  # @param object [Object]
-  # @param in_array [Boolean] whether the object is an array or not
-  #
-  def check_object(object, in_array = false)
-    case object
-    when Array
-      raise Algolia::AlgoliaError, in_array ? 'argument must be an array of objects' : 'argument must not be an array'
-    when String, Integer, Float, TrueClass, FalseClass, NilClass
-      raise Algolia::AlgoliaError, "argument must be an #{'array of' if in_array} object, got: #{object.inspect}"
-    end
-  end
-
-  # Check if passed object has a objectID
-  #
-  # @param object [Object]
-  # @param object_id [String]
-  #
-  def get_object_id(object, object_id = nil)
-    check_object(object)
-    object_id ||= object[:objectID] || object['objectID']
-    raise Algolia::AlgoliaError, "Missing 'objectID'" if object_id.nil?
-    object_id
-  end
-
-  # Build a batch request
-  #
-  # @param action [String] action to perform on the engine
-  # @param objects [Array] objects on which build the action
-  # @param with_object_id [Boolean] if set to true, check if each object has an objectID set
-  #
-  def chunk(action, objects, with_object_id = false)
-    objects.map do |object|
-      check_object(object, true)
-      request            = { action: action, body: object }
-      request[:objectID] = get_object_id(object).to_s if with_object_id
-      request
-    end
-  end
-end

data/lib/algolia/insights_client.rb

@@ -1,238 +0,0 @@
-module Algolia
-  module Insights
-    class Client
-      include Helpers
-
-      # Initializes the Insights client
-      #
-      # @param insights_config [Insights::Config] an Insights::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(insights_config, opts = {})
-        @config      = insights_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 = Insights::Config.new(application_id: app_id, api_key: api_key)
-        create_with_config(config)
-      end
-
-      # Create a new client providing only an Analytics::Config object
-      #
-      # @param config [Insights::Config]
-      #
-      # @return self
-      #
-      def self.create_with_config(config)
-        new(config)
-      end
-
-      # Create a new Insight User Client
-      #
-      # @param user_token [String]
-      #
-      # @return [UserClient]
-      #
-      def user(user_token)
-        UserClient.new(self, user_token)
-      end
-
-      # Push an event to the Insights API.
-      #
-      # @param event [Hash]
-      #
-      # @return [Hash]
-      #
-      def send_event(event, opts = {})
-        send_events([event], opts)
-      end
-
-      # Push an array of events to the Insights API.
-      #
-      # @param events [Array]
-      #
-      # @return [Hash]
-      #
-      def send_events(events, opts = {})
-        @transporter.write(:POST, '/1/events', { events: events }, opts)
-      end
-    end
-
-    class UserClient
-      # Initializes the Insights userClient
-      #
-      # @param insights_client [Insights::Client] Insights Client used to make API calls
-      # @param user_token [String] user token used to build the client
-      #
-      def initialize(insights_client, user_token)
-        @insights_client = insights_client
-        @user_token      = user_token
-      end
-
-      # Send a click event to capture clicked items.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param object_ids [Array] A list of objectIDs (limited to 20)
-      #
-      # @return [Hash]
-      #
-      def clicked_object_ids(event_name, index_name, object_ids, opts = {})
-        @insights_client.send_event({
-          eventType: 'click',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          objectIds: object_ids
-        }, opts)
-      end
-
-      # Send a click event to capture a query and its clicked items and positions.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param object_ids [Array] A list of objectIDs (limited to 20)
-      # @param positions [Array] Position of the click in the list of Algolia search results.
-      # @param query_id [String] Algolia queryID that can be found in the search response when using clickAnalytics
-      #
-      # @return [Hash]
-      #
-      def clicked_object_ids_after_search(event_name, index_name,
-        object_ids, positions, query_id, opts = {})
-        @insights_client.send_event({
-          eventType: 'click',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          objectIds: object_ids,
-          positions: positions,
-          queryId: query_id
-        }, opts)
-      end
-
-      # Send a click event to capture the filters a user clicks on.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param filters [Array] A list of filters (limited to 10)
-      #
-      # @return [Hash]
-      #
-      def clicked_filters(event_name, index_name, filters, opts = {})
-        @insights_client.send_event({
-          eventType: 'click',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          filters: filters
-        }, opts)
-      end
-
-      # Send a conversion event to capture clicked items.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param object_ids [Array] A list of objectIDs (limited to 20)
-      #
-      # @return [Hash]
-      #
-      def converted_object_ids(event_name, index_name, object_ids, opts = {})
-        @insights_client.send_event({
-          eventType: 'conversion',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          objectIds: object_ids
-        }, opts)
-      end
-
-      # Send a conversion event to capture a query and its clicked items.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param object_ids [Array] A list of objectIDs (limited to 20)
-      # @param query_id [String] Algolia queryID, format: [a-z1-9]{32}.
-      #
-      # @return [Hash]
-      #
-      def converted_object_ids_after_search(event_name, index_name,
-        object_ids, query_id, opts = {})
-        @insights_client.send_event({
-          eventType: 'conversion',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          objectIds: object_ids,
-          queryId: query_id
-        }, opts)
-      end
-
-      # Send a conversion event to capture the filters a user uses when converting.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param filters [Array] A list of filters (limited to 10)
-      #
-      # @return [Hash]
-      #
-      def converted_filters(event_name, index_name, filters, opts = {})
-        @insights_client.send_event({
-          eventType: 'conversion',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          filters: filters
-        }, opts)
-      end
-
-      # Send a view event to capture clicked items.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param object_ids [Array] A list of objectIDs (limited to 20)
-      #
-      # @return [Hash]
-      #
-      def viewed_object_ids(event_name, index_name, object_ids, opts = {})
-        @insights_client.send_event({
-          eventType: 'view',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          objectIds: object_ids
-        }, opts)
-      end
-
-      # Send a view event to capture the filters a user uses when viewing.
-      #
-      # @param event_name [String] Name of the event.
-      # @param index_name [String] Name of the index related to the click.
-      # @param filters [Array] A list of filters (limited to 10)
-      #
-      # @return [Hash]
-      #
-      def viewed_filters(event_name, index_name, filters, opts = {})
-        @insights_client.send_event({
-          eventType: 'view',
-          eventName: event_name,
-          index: index_name,
-          userToken: @user_token,
-          filters: filters
-        }, opts)
-      end
-    end
-  end
-end

data/lib/algolia/iterators/base_iterator.rb

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

@@ -1,28 +0,0 @@
-module Algolia
-  class ObjectIterator < BaseIterator
-    # Custom each function to iterate through the objects
-    #
-    def each
-      loop do
-        data = {}
-
-        if @response
-          parsed_response = symbolize_hash(@response)
-          if parsed_response[:hits].length
-            parsed_response[:hits].each do |hit|
-              yield hit
-            end
-
-            if parsed_response[:cursor].nil?
-              @response = nil
-              raise StopIteration
-            else
-              data[:cursor] = parsed_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

@@ -1,46 +0,0 @@
-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
-          parsed_response = symbolize_hash(@response)
-          parsed_data     = symbolize_hash(@data)
-          if parsed_response[:hits].length
-            parsed_response[:hits].each do |hit|
-              hit.delete(:_highlightResult)
-              yield hit
-            end
-
-            if parsed_response[:nbHits] < parsed_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

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

@@ -1,9 +0,0 @@
-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/personalization_client.rb

@@ -1,60 +0,0 @@
-module Algolia
-  module Personalization
-    class Client
-      # Initializes the Personalization client
-      #
-      # @param personalization_config [Personalization::Config] a Personalization::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(personalization_config, opts = {})
-        @config      = personalization_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 = Personalization::Config.new(application_id: app_id, api_key: api_key)
-        create_with_config(config)
-      end
-
-      # Create a new client providing only an Personalization::Config object
-      #
-      # @param config [Personalization::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