solrbee 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca8f6d8f901268390057453075d0c39306b2362cb1216ec4dbcdb168b6d5bb18
+  data.tar.gz: b17d0b604e4276a47c2e54d17fc92f9b9cc173fb1c2b283cc4d15f6f506c99d8
+SHA512:
+  metadata.gz: 3967982e1454c5659be6716eaf2e3a1a215046b6c3bfbe383c09810b519391017ddb4febedc861235d97b44253fd4950ad75f88dbcddc5378e33d5e37d822c59
+  data.tar.gz: 9cd90db400ec1a2ec23daa227e6e22afb23da39328fb66384bd2cf18c52a01ee4c5db1f2620079a4a63d19096edc706de5320be3e93e67f8da5c2fb600948c61

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/Gemfile.lock
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 David Chandek-Stark
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,7 @@
+SHELL = /bin/bash
+
+.PHONY : test
+test:
+	docker run --rm -d --name solrbee-test solr:8 solr-precreate solrbee
+	bundle exec rake
+	docker stop solrbee-test

data/README.md

@@ -0,0 +1,39 @@
+# Solrbee
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solrbee'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solrbee
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/solrbee.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "solrbee"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/solrbee.rb

@@ -0,0 +1,65 @@
+require "net/http"
+require "uri"
+require "json"
+
+require "solrbee/version"
+require "solrbee/base"
+require "solrbee/response"
+require "solrbee/collection"
+require "solrbee/schema_api"
+
+module Solrbee
+  class Error < StandardError; end
+
+  # Single-valued field types
+  STRING  = "string"
+  LONG    = "plong"
+  INT     = "pint"
+  DATE    = "pdate"
+  BOOLEAN = "boolean"
+
+  # Multi-valued field types
+  MSTRING  = "strings"
+  MLONG    = "plongs"
+  MINT     = "pints"
+  MDATE    = "pdates"
+  MBOOLEAN = "booleans"
+
+  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
+  end
+
+end

data/lib/solrbee/base.rb

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

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

@@ -0,0 +1,22 @@
+module Solrbee
+  class Response < Base
+
+    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 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)
+    end
+
+    def status
+      responseHeader.status
+    end
+
+  end
+end

data/lib/solrbee/schema_api.rb

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

data/lib/solrbee/version.rb

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

data/solrbee.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "solrbee/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "solrbee"
+  spec.version       = Solrbee::VERSION
+  spec.authors       = ["David Chandek-Stark"]
+  spec.email         = ["david.chandek.stark@duke.edu"]
+
+  spec.summary       = "Solr buzz"
+  spec.homepage      = "https://github.com/dchandekstark/solrbee"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: solrbee
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Chandek-Stark
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- david.chandek.stark@duke.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/solrbee.rb
+- lib/solrbee/base.rb
+- lib/solrbee/collection.rb
+- lib/solrbee/response.rb
+- lib/solrbee/schema_api.rb
+- lib/solrbee/version.rb
+- solrbee.gemspec
+homepage: https://github.com/dchandekstark/solrbee
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Solr buzz
+test_files: []