solrbee 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca8f6d8f901268390057453075d0c39306b2362cb1216ec4dbcdb168b6d5bb18
-  data.tar.gz: b17d0b604e4276a47c2e54d17fc92f9b9cc173fb1c2b283cc4d15f6f506c99d8
+  metadata.gz: 77127390eb03bfbd53eec6916f7873fab49b6436f4acb94c528f2cec7ed5f76b
+  data.tar.gz: '08ab2300881e0fdacaafa0007d1a17031a2b11bebfe2ade9cbf533a02a7b2b42'
 SHA512:
-  metadata.gz: 3967982e1454c5659be6716eaf2e3a1a215046b6c3bfbe383c09810b519391017ddb4febedc861235d97b44253fd4950ad75f88dbcddc5378e33d5e37d822c59
-  data.tar.gz: 9cd90db400ec1a2ec23daa227e6e22afb23da39328fb66384bd2cf18c52a01ee4c5db1f2620079a4a63d19096edc706de5320be3e93e67f8da5c2fb600948c61
+  metadata.gz: 5642a45f1013a4ddf33f4a339f0990ec218d7c3ebce3e6b3e1a0811c81256a6c155df333d7894618de9cb4a8b9e7c9eac5f178237474e96cd2de5ec7193cee83
+  data.tar.gz: bba5257728a581433cf72dbd4dce18ab5f8f7baea95afca7dca75c16f5fc17b509110c9e8ecb9a87713960f3eccf951d0bf11a0afe8b4ba01de2f331fcefd095

data/Makefile

@@ -2,6 +2,13 @@ SHELL = /bin/bash
 
 .PHONY : test
 test:
-	docker run --rm -d --name solrbee-test solr:8 solr-precreate solrbee
 	bundle exec rake
+
+
+.PHONY : start-test-server
+start-test-server:
+	docker run --rm -d -p 8983:8983 --name solrbee-test solr:8 solr-precreate solrbee
+
+.PHONY : stop-test-server
+stop-test-server:
 	docker stop solrbee-test

data/README.md

@@ -1,8 +1,11 @@
 # Solrbee
 
+![Bee photo (c) David Chandek-Stark](https://raw.githubusercontent.com/dchandekstark/images/main/solrbee.jpg)
+
 Solrbee is intended as a lightweight library for interacting with a modern Solr instance
-using a managed schema.  Our intestest is primarily in using Solr as data store, for example,
-as an alterative to an RDBMS.
+as NoSQL data store.
+
+We are currently building on the JSON APIs (V1).
 
 ## Installation
 

data/lib/solrbee.rb

@@ -1,14 +1,12 @@
-require "net/http"
-require "uri"
-require "json"
-
 require "solrbee/version"
-require "solrbee/base"
 require "solrbee/response"
-require "solrbee/collection"
-require "solrbee/schema_api"
+require "solrbee/request_params"
+require "solrbee/query"
+require "solrbee/client"
+require "solrbee/cursor"
 
 module Solrbee
+
   class Error < StandardError; end
 
   # Single-valued field types
@@ -25,41 +23,9 @@ module Solrbee
   MDATE    = "pdates"
   MBOOLEAN = "booleans"
 
+  # Base URL
   def self.solr_url
-    ENV.fetch('SOLR_URL', 'http://localhost:8983/solr/')
-  end
-
-  def self.solr_uri
-    URI(solr_url)
-  end
-
-  def self.connection
-    Net::HTTP.new(solr_uri.host, solr_uri.port).tap do |http|
-      http.use_ssl = true if solr_uri.scheme == 'https'
-    end
-  end
-
-  def self.request_class(method)
-    Net::HTTP.const_get(method.to_s.downcase.capitalize)
-  end
-
-  def self.request(method, path)
-    u = URI.join(solr_url, path)
-    req = request_class(method).new(u, {'Accept'=>'application/json'})
-    yield req if block_given?
-    res = connection.request(req)
-    Response.handle(res)
-  end
-
-  def self.get(path)
-    request(:get, path)
-  end
-
-  def self.post(path, data)
-    request(:post, path) do |req|
-      req['Content-Type'] = 'application/json'
-      req.body = JSON.dump(data)
-    end
+    ENV.fetch('SOLR_URL', 'http://localhost:8983/solr').sub(/\/\z/, '')
   end
 
 end

data/lib/solrbee/api_methods.rb

@@ -0,0 +1,85 @@
+module Solrbee
+  module ApiMethods
+
+    def schema_name
+      response = get('/schema/name')
+      response.name
+    end
+
+    def schema_version
+      response = get('/schema/version')
+      response.version
+    end
+
+    def schema
+      response = get('/schema')
+      response.schema
+    end
+
+    def fields(**params)
+      response = get('/schema/fields', **params)
+      response.fields
+    end
+
+    def field(field_name, **params)
+      response = get('/schema/fields/%s' % field_name, **params)
+      response.field
+    end
+
+    def unique_key
+      @unique_key ||= get('/schema/uniquekey').uniqueKey
+    end
+
+    def field_types(**params)
+      response = get('/schema/fieldtypes', **params)
+      response.fieldTypes
+    end
+
+    def field_type(field_name, **params)
+      response = get('/schema/fieldtypes/%s' % field_name, **params)
+      response.fieldType
+    end
+
+    def field_names
+      fields.map(&:name)
+    end
+
+    def field_type_names
+      field_types.map(&:name)
+    end
+
+    def add_field(field)
+      post('/schema', {"add-field"=>field})
+    end
+
+    def delete_field(field)
+      post('/schema', {"delete-field"=>{"name"=>field.name}})
+    end
+
+    def replace_field(field)
+      post('/schema', {"replace-field"=>field})
+    end
+
+    # "real-time get"
+    # Note: Using POST here for simpler params.
+    def get_by_id(*ids)
+      response = post('/get', params: { id: ids })
+      response.doc || response.docs
+    end
+
+    def index(*docs, **params)
+      post('/update/json/docs', docs, **params)
+    end
+    alias_method :add, :index
+    alias_method :update, :index
+
+    def delete(*ids)
+      post('/update', delete: ids)
+    end
+
+    def query(params)
+      post('/query', Query.new(params))
+    end
+
+  end
+end

data/lib/solrbee/client.rb

@@ -0,0 +1,59 @@
+require "net/http"
+require "uri"
+require "json"
+
+require "solrbee/api_methods"
+
+module Solrbee
+  class Client
+    include ApiMethods
+
+    attr_reader :collection, :uri
+
+    def initialize(collection)
+      @collection = collection
+      @uri = URI(Solrbee.solr_url).tap do |u|
+        u.path += '/%s' % URI.encode_www_form_component(collection)
+      end
+    end
+
+    def connection
+      Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl = true if uri.scheme == 'https'
+      end
+    end
+
+    # :get -> Net::HTTP::Get
+    def request_class(method)
+      Net::HTTP.const_get(method.to_s.downcase.capitalize)
+    end
+
+    def request(method, path, **params)
+      req_uri = uri.dup
+      req_uri.path += path
+      unless params.empty?
+        req_uri.query = URI.encode_www_form RequestParams.new(params)
+      end
+      req = request_class(method).new(req_uri, {'Accept'=>'application/json'})
+      yield req if block_given?
+      res = connection.request(req)
+      Response.new JSON.parse(res.body)
+    end
+
+    def get(path, **params)
+      request(:get, path, **params)
+    end
+
+    def post(path, data, **params)
+      request(:post, path, **params) do |req|
+        req['Content-Type'] = 'application/json'
+        req.body = JSON.dump(data)
+      end
+    end
+
+    def cursor
+      Cursor.new(self)
+    end
+
+  end
+end

data/lib/solrbee/cursor.rb

@@ -0,0 +1,37 @@
+module Solrbee
+  #
+  # Summary
+  #
+  # > client = Solrbee::Client.new('mycollection'))
+  # > cursor = Solrbee::Cursor.new(client)
+  # > query = { query: 'foo:bar', sort: 'title ASC', limit: 10 }
+  # > results = cursor.execute(query)
+  # > results.each do |doc|
+  #   ...
+  # > end
+  #
+  class Cursor
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [Enumerator] an enumerator of query results
+    def execute(query)
+      Enumerator.new do |yielder|
+        q = Query.cursor(query, client.unique_key)
+
+        while true
+          response = client.query(q)
+          break if response.num_found == 0
+          break if response.nextCursorMark == q.params.cursorMark
+          response.docs.each { |doc| yielder << doc }
+          q.params.cursorMark = response.nextCursorMark
+        end
+      end
+    end
+
+  end
+end

data/lib/solrbee/query.rb

@@ -0,0 +1,36 @@
+require 'hashie'
+
+module Solrbee
+  #
+  # A query targeting the JSON Request API.
+  #
+  class Query < Hashie::Trash
+
+    property :query,  from: :q,     default: '*:*'
+    property :filter, from: :fq
+    property :limit,  from: :rows,  default: 10
+    property :fields, from: :fl
+    property :sort
+    property :offset, from: :start
+    property :facet
+    property :queries
+    property :params, default: {}
+
+    # Build a query for a Cursor
+    def self.cursor(params, unique_key)
+      Query.new(params).tap do |q|
+        q.delete(:offset)           # incompatible with cursor
+        q.params[:cursorMark] = '*' # initial cursor mark
+
+        # Sort on unique key is required for cursor
+        q.sort = "#{unique_key} ASC" unless q.sort
+        unless q.sort =~ /\b#{unique_key}\b/
+          clauses = q.sort.split(/,/)
+          clauses << "#{unique_key} ASC"
+          q.sort = clauses.join(',')
+        end
+      end
+    end
+
+  end
+end

data/lib/solrbee/request_params.rb

@@ -0,0 +1,13 @@
+require 'hashie'
+
+module Solrbee
+  #
+  # For marshalling various API request query parameters
+  #
+  class RequestParams < Hashie::Trash
+    property :showDefaults,   from: :show_defaults
+    property :includeDynamic, from: :include_dynamic
+    property :fl
+    property :commit
+  end
+end

data/lib/solrbee/response.rb

@@ -1,21 +1,24 @@
+require 'hashie'
+
 module Solrbee
-  class Response < Base
+  class Response < Hashie::Mash
+
+    disable_warnings
 
-    coerce_key :schema,         Schema
-    coerce_key :fields,         Array[Field]
-    coerce_key :field,          Field
-    coerce_key :responseHeader, Header
-    coerce_key :fieldTypes,     Array[FieldType]
-    coerce_key :fieldType,      FieldType
+    def header
+      responseHeader
+    end
+
+    def num_found
+      response.numFound
+    end
 
-    def self.handle(http_response)
-      http_response.value # raises Net::HTTPServerException
-      parsed = JSON.parse(http_response.body, symbolize_names: true, object_class: Solrbee::Base)
-      new(parsed)
+    def docs
+      response.docs
     end
 
-    def status
-      responseHeader.status
+    def doc
+      response.doc
     end
 
   end

data/lib/solrbee/version.rb

@@ -1,3 +1,3 @@
 module Solrbee
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solrbee
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -97,10 +97,12 @@ files:
 - bin/console
 - bin/setup
 - lib/solrbee.rb
-- lib/solrbee/base.rb
-- lib/solrbee/collection.rb
+- lib/solrbee/api_methods.rb
+- lib/solrbee/client.rb
+- lib/solrbee/cursor.rb
+- lib/solrbee/query.rb
+- lib/solrbee/request_params.rb
 - lib/solrbee/response.rb
-- lib/solrbee/schema_api.rb
 - lib/solrbee/version.rb
 - solrbee.gemspec
 homepage: https://github.com/dchandekstark/solrbee

data/lib/solrbee/base.rb

@@ -1,14 +0,0 @@
-require 'hashie'
-
-module Solrbee
-  class Base < Hashie::Hash
-    include Hashie::Extensions::Coercion
-    include Hashie::Extensions::MergeInitializer
-    include Hashie::Extensions::MethodAccess
-  end
-
-  Field     = Class.new(Base)
-  FieldType = Class.new(Base)
-  Header    = Class.new(Base)
-  Schema    = Class.new(Base)
-end

data/lib/solrbee/collection.rb

@@ -1,19 +0,0 @@
-module Solrbee
-  class Collection
-
-    attr_reader :name
-
-    def initialize(name)
-      @name = name
-    end
-
-    def to_s
-      name
-    end
-
-    def schema
-      @schema ||= SchemaApi.new(self)
-    end
-
-  end
-end

data/lib/solrbee/schema_api.rb

@@ -1,86 +0,0 @@
-module Solrbee
-  class SchemaApi
-
-    attr_reader :collection
-
-    def initialize(collection)
-      @collection = collection
-    end
-
-    def to_h
-      content
-    end
-
-    def name
-      response = Solrbee.get('%s/schema/name' % collection)
-      response.name
-    end
-
-    def version
-      response = Solrbee.get('%s/schema/version' % collection)
-      response.version
-    end
-
-    def content
-      response = Solrbee.get('%s/schema' % collection)
-      response.schema
-    end
-
-    def fields(show_defaults: true)
-      response = Solrbee.get('%s/schema/fields?showDefaults=%s' % [collection, show_defaults])
-      response.fields
-    end
-
-    def field(field_name, show_defaults: true)
-      response = Solrbee.get('%s/schema/fields/%s?showDefaults=%s' % [collection, field_name, show_defaults])
-      response.field
-    end
-
-    def unique_key
-      response = Solrbee.get('%s/schema/uniquekey' % collection)
-      response.uniqueKey
-    end
-
-    def field_types(show_defaults: true)
-      response = Solrbee.get('%s/schema/fieldtypes?showDefaults=%s' % [collection, show_defaults])
-      response.fieldTypes
-    end
-
-    def field_type(field_name, show_defaults: true)
-      response = Solrbee.get('%s/schema/fieldtypes/%s?showDefaults=%s' % [collection, field_name, show_defaults])
-      response.fieldType
-    end
-
-    def field_names
-      fields.map(&:name)
-    end
-
-    def field_type_names
-      field_types.map(&:name)
-    end
-
-    def index(*docs, commit: true)
-      Solrbee.post('%s/update/json/docs?commit=%s' % [collection, commit], docs)
-    end
-
-    def add_field(field)
-      data = { "add-field" => field }
-      Solrbee.post('%s/schema' % collection, data)
-    end
-
-    def delete_field(field)
-      data = {
-        "delete-field" => {
-          "name" => field.name
-        }
-      }
-      Solrbee.post('%s/schema' % collection, data)
-    end
-
-    def replace_field(field)
-      data = { "replace-field" => field }
-      Solrbee.post('%s/schema' % collection, data)
-    end
-
-  end
-end