solrb 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a466479c836a5cc67ee81a755af60a635419bd7323adfd7ffe684762907abfe0
-  data.tar.gz: 2914f312a755836fd60c4b363f077a6a5ea9861b80f9acdc1208606d81890152
+  metadata.gz: afb9302df9f0a348f4d80a007a7e3da0df0fed4ff012e814788c6b610fdfb642
+  data.tar.gz: 4001463e4a3c13b487180336e9cb0d949de06beb377b24caf7b8f7d579cffc84
 SHA512:
-  metadata.gz: 561939f9974533d48c2ffd9c6cb6a07945d5d91b3dfd88e06aa1f79d92a5d8981c2efa54ade457a24885956f2c0a372ad51d7ee703a42319b497b7b59400e884
-  data.tar.gz: b24e4229b0ba854c91cb277413967a96fe33d19bf17cc2f5e5bcfa0e05aa26e29b8b5155d6a26f771eba8521891a925c3b38024d162f165ad39b95d921895fe1
+  metadata.gz: 54f453cedf22c49924b2e959356029e3079d28498213ec4ef890da46caee815552554ba9dbc5ec48c476ff1089090fac0699c1f801d58e3095ac6f8810327d39
+  data.tar.gz: 76b252a3b999c546fab15c0f7e421179ea081c0d0a31b3a4f64950f29fce12f0d36d3762b05ac8a2bfb99b7911eb5294010a0947ac3975d2b0b6838be5792d56

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    solrb (0.1.4)
+    solrb (0.1.3)
       addressable
       faraday
 

data/README.md

@@ -1,19 +1,41 @@
 [![CircleCI](https://circleci.com/gh/machinio/solrb/tree/master.svg?style=svg)](https://circleci.com/gh/machinio/solrb/tree/master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/81e84c1c42f10f9da801/maintainability)](https://codeclimate.com/github/machinio/solrb/maintainability)
 
-# Solrb
+Solrb
+======
 
 Object-Oriented approach to Solr in Ruby.
 
-## Installation
+Installation: `gem install solrb`
 
-Add this line to your application's Gemfile:
+## Table of contents
 
-```ruby
-gem 'solrb', require: 'solr'
-```
 
-## Configuration
+* [Configuration](#configuration)
+  * [Setting Solr URL via environment variable](#setting-solr-url-via-environment-variable)
+  * [Single core configuration](#single-core-configuration)
+  * [Multiple core configuration](#multiple-core-configuration)
+* [Indexing](#indexing)
+* [Querying](#querying)
+  * [Simple Query](#simple-query)
+  * [Querying multiple cores](#querying-multiple-cores)
+  * [Query with field boost](#query-with-field-boost)
+  * [Query with filtering](#query-with-filtering)
+  * [Query with sorting](#query-with-sorting)
+  * [Query with grouping](#query-with-grouping)
+  * [Query with facets](#query-with-facets)
+  * [Query with boosting functions](#query-with-boosting-functions)
+    * [Dictionary boosting function](#dictionary-boosting-function)
+  * [Field list](#field-list)
+* [Deleting documents](#deleting-documents)
+* [Active Support instrumentation](#active-support-instrumentation)
+* [Running specs](#running-specs)
+
+
+
+# Configuration
+
+## Setting Solr URL via environment variable
 
 The simplest way to use Solrb is `SORL_URL` environment variable (that has a core name in it):
 
@@ -21,19 +43,23 @@ The simplest way to use Solrb is `SORL_URL` environment variable (that has a cor
   ENV['SOLR_URL'] = 'http://localhost:8983/solr/demo'
 ```
 
-or through `Solr.configure` to specify the solr URL:
+
+You can also use `Solr.configure` to specify the solr URL explicitly:
 
 ```ruby
-# Single core configuration
 Solr.configure do |config|
   config.url = 'http://localhost:8983/solr/demo'
 end
 ```
 
+It's important to note that those fields that are not configured, will be passed as-is to solr.
+*So you only need to specify fields in configuration if you want Solrb to modify them at runtime*.
+
+## Single core configuration
+
 Use `Solr.configure` for an additional configuration:
 
 ```ruby
-# Single core configuration
 Solr.configure do |config|
   config.url = 'http://localhost:8983/solr/demo'
 
@@ -50,8 +76,9 @@ Solr.configure do |config|
 end
 ```
 
+## Multiple core configuration
+
 ```ruby
-# Multiple core configuration
 Solr.configure do |config|
   config.url = 'http://localhost:8983/solr'
 
@@ -79,10 +106,6 @@ Solr.configure do |config|
 end
 ```
 
-It's important to note that those fields that are not configured, will be passed as-is to solr.
-*So you only need to specify fields in configuration if you want Solrb to modify them at runtime*.
-
-
 Warning: Solrb doesn't support fields with the same name. If you have two fields with the same name mapping
 to a single solr field,  you'll have to rename one of the fields.
 
@@ -97,9 +120,8 @@ end
 ...
 ```
 
-## Usage
 
-### Indexing
+# Indexing
 
 ```ruby
 # creates a single document and commits it to index
@@ -117,9 +139,9 @@ You can also create indexing document directly from attributes:
 doc = Solr::Indexing::Document.new(id: 5, name: 'John')
 ```
 
-### Querying
+# Querying
 
-#### Simple Query
+## Simple Query
 
 ```ruby
   field = Solr::Query::Request::FieldWithBoost.new(field: :name)
@@ -127,8 +149,19 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
   request = Solr::Query::Request.new(search_term: 'term', fields: [field])
   request.run(page: 1, page_size: 10)
 ```
+## Querying multiple cores
 
-#### Query with field boost
+For multi-core configuration use `Solr.with_core` block:
+
+```ruby
+Solr.with_core(:models) do
+  Solr.delete_by_id(3242343)
+  Solr::Query::Request.new(search_term: 'term', fields: fields)
+  Solr::Indexing::Request.new(documents: [doc])
+end
+```
+
+## Query with field boost
 
 ```ruby
   fields = [
@@ -140,7 +173,7 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
   request.run(page: 1, page_size: 10)
 ```
 
-#### Query with filters
+## Query with filtering
 
 ```ruby
   fields = [
@@ -153,7 +186,7 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
 ```
 
 
-#### Query with sorting
+## Query with sorting
 
 ```ruby
   fields = [
@@ -166,7 +199,7 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
   request.run(page: 1, page_size: 10)
 ```
 
-#### Query with grouping
+## Query with grouping
 
 ```ruby
   fields = [
@@ -178,7 +211,7 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
   request.run(page: 1, page_size: 10)
 ```
 
-#### Query with facets
+## Query with facets
 
 ```ruby
   fields = [
@@ -190,7 +223,7 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
   request.run(page: 1, page_size: 10)
 ```
 
-#### Query with boosting functions
+## Query with boosting functions
 
 ```ruby
   fields = [
@@ -204,8 +237,34 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
   )
   request.run(page: 1, page_size: 10)
 ```
+### Dictionary boosting function
+Sometimes you want to do a dictionary-style boosting
+example: given a hash (dictionary)
+
+```ruby
+{3025 => 2.0, 3024 => 1.5, 3023 => 1.2}
+```
 
-#### Field list
+and a field of `category_id`
+the resulting boosting function will be:
+```
+if(eq(category_id_it, 3025), 2.0, if(eq(category_id_it, 3024), 1.5, if(eq(category_id_it, 3023), 1.2, 1)))
+```
+note that I added spaces for readability, real Solr query functions must always be w/out spaces
+
+Example of usage:
+
+```ruby
+  category_id_boosts = {3025 => 2.0, 3024 => 1.5, 3023 => 1.2}
+  request.boosting = Solr::Query::Request::Boosting.new(
+    multiplicative_boost_functions: [
+      Solr::Query::Request::Boosting::DictionaryBoostFunction.new(field: :category_id, 
+        dictionary: category_id_boosts)
+    ]
+  )
+```
+
+## Field list
 
 
 ```ruby
@@ -220,7 +279,7 @@ doc = Solr::Indexing::Document.new(id: 5, name: 'John')
   request.run(page: 1, page_size: 10)
 ```
 
-### Deleting documents
+# Deleting documents
 
 ```ruby
 Solr.delete_by_id(3242343)
@@ -229,19 +288,26 @@ Solr.delete_by_query('*:*')
 Solr.delete_by_query('*:*', commit: true)
 ```
 
-### Using multi-core configuration
+# Active Support instrumentation
 
-For multi-core configuration use `Solr.with_core` block:
+This gem publishes events via [Active Support Instrumentation](https://edgeguides.rubyonrails.org/active_support_instrumentation.html)
+
+To subscribe to solrb events, you can add this code to initializer:
 
 ```ruby
-Solr.with_core(:models) do
-  Solr.delete_by_id(3242343)
-  Solr::Query::Request.new(search_term: 'term', fields: fields)
-  Solr::Indexing::Request.new(documents: [doc])
+ActiveSupport::Notifications.subscribe('request.solrb')  do |*args|
+  event = ActiveSupport::Notifications::Event.new(*args)
+  if Logger::INFO == Rails.logger.level
+    Rails.logger.info("Solrb #{event.duration.round(1)}ms")
+  elsif Logger::DEBUG == Rails.logger.level && Rails.env.development?
+    Pry::ColorPrinter.pp(event.payload)
+  end
 end
 ```
 
-## Running specs
+
+
+# Running specs
 
 This project is setup to use CI to run all specs agains a real solr.
 

data/lib/solr/connection.rb

@@ -1,7 +1,7 @@
 module Solr
   # low-level connection that can do network requests to Solr
   class Connection
-    INSTRUMENT_KEY = 'solrb.request'.freeze
+    INSTRUMENT_KEY = 'request.solrb'.freeze
 
     def initialize(url, faraday_options: Solr.configuration.faraday_options)
       # Allow mock the connection for testing

data/lib/solr/query/request/runner.rb

@@ -22,10 +22,7 @@ module Solr
 
         def run
           raw_response = connection(PATH).post_as_json(request_params)
-          response = Solr::Response.from_raw_response(raw_response)
-          Solr.instrument(name: 'solrb.request_response_cycle',
-                          data: { request: request_params, response: raw_response })
-          response
+          Solr::Response.from_raw_response(raw_response)
         end
 
         private

data/lib/solr/version.rb

@@ -1,3 +1,3 @@
 module Solr
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.1.5'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solrb
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Adriano Luz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable