searchr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 000949f105a868a2f6e78e31ff582b1c37e08d8f
+  data.tar.gz: 91a95ee98d16e7401a891f6e50ddd7a957d05aee
+SHA512:
+  metadata.gz: fae7f6d37acf030b967592ad7c0de6cfe9deb8f0f73686d0652f50752c45e2c34066649143de29c3cb3b5b04ed4d8fbb5f888d8b7a641b2c94da70edc107fbf6
+  data.tar.gz: dd6608f95993537d2d12a6cd7371b1b34109db4ab72583766847a82578c7c0ee9dd86ca5dea06d867b8df7c2a1549a9887617718f85d6fb767f883d663c03f59

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in searchr.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 bmd
+
+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/README.md

@@ -0,0 +1,41 @@
+# Searchr
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/searchr`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'searchr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install searchr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/searchr.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+namespace :solr do
+  desc "Start my enron solr instance."
+  task :server do
+    system 'cd ~/Documents/git/underTheHood-student-Solr-2013-11-03-0100/solr-4.5.1/example && java -jar start.jar'
+  end
+
+  desc "Load enron data (only run once as it is retained between restarts)"
+  task :load do
+    system 'cd ~/Documents/git/underTheHood-student-Solr-2013-11-03-0100/Activities && java -jar post.jar Enron/*.xml'
+  end
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "searchr"
+
+# 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

data/bin/setup

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

data/lib/searchr.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+require 'json'
+
+require "searchr/version"
+require 'searchr/query'
+require 'searchr/solr_query'
+require 'searchr/result'
+require 'searchr/solr_result'
+
+module Searchr
+  # Your code goes here...
+end

data/lib/searchr/query.rb

@@ -0,0 +1,101 @@
+require 'addressable/uri'
+
+module Searchr
+  class Query
+    attr_writer :query, :fields_to_query, :start_row, :num_rows
+
+    def search
+      result_with http_response
+    end
+
+    def result_with
+      subclass_responsibility
+    end
+
+    def http_response
+      Net::HTTP.get_response url
+    end
+
+    def query
+      @query ||= default_query
+    end
+
+    def query_type
+      @query_type ||= default_query_type
+    end
+
+    def base_query_url
+      @base_query_url ||= default_base_query_url
+    end
+
+    def fields_to_query
+      @fields_to_query ||= default_fields_to_query
+    end
+
+    def start_row
+      @start_row ||= 0
+    end
+
+    def num_rows
+      @num_rows ||= default_num_rows
+    end
+
+    def indent?
+      @do_indent ||= default_indent?
+    end
+
+    def debug_query?
+      @do_debug_query ||= default_debug_query?
+    end
+
+    def return_type
+      @return_type ||= default_return_type
+    end
+
+    def query_parameters
+      subclass_responsibility
+    end
+
+    def url
+      uri = URI(base_query_url)
+
+      query_uri = Addressable::URI.new
+      query_uri.query_values = query_parameters
+
+      uri.query = query_uri.query
+      uri
+    end
+
+    protected
+
+    def default_query
+      subclass_responsibility
+    end
+
+    def default_query_type
+      subclass_responsibility
+    end
+
+    def default_fields_to_query
+      subclass_responsibility
+    end
+
+    def default_num_rows
+      10
+    end
+
+    def default_indent?
+      # purely cosmetic to make it easier to read.
+      true
+    end
+
+    def default_debug_query?
+      # true required to diagnose result weights
+      true
+    end
+
+    def default_return_type
+      'json'
+    end
+  end
+end

data/lib/searchr/result.rb

@@ -0,0 +1,20 @@
+module Searchr
+  class Result
+    def initialize(http_response)
+      @http_response = http_response
+      raise 'Http response for search did not succeed' if code!=200
+    end
+
+    def body
+      @body ||= JSON.parse(http_response.body)
+    end
+
+    def code
+      @http_response.code.to_i
+    end
+
+    def body_str
+      @http_response.body
+    end
+  end
+end

data/lib/searchr/solr_query.rb

@@ -0,0 +1,30 @@
+module Searchr
+  class SolrQuery < Query
+    def result_with(http_response)
+      SolrResult.new http_response
+    end
+
+    def query_parameters
+      {
+          start: start_row,
+          rows: num_rows,
+          q: query,
+          qf: fields_to_query,
+          wt: return_type,
+          indent: indent?,
+          debugQuery: debug_query?,
+          defType: query_type,
+      }
+    end
+
+    protected
+
+    def default_query
+      '*.*'
+    end
+
+    def default_query_type
+      'edismax'
+    end
+  end
+end

data/lib/searchr/solr_result.rb

@@ -0,0 +1,4 @@
+module Searchr
+  class SolrResult < Result
+  end
+end

data/lib/searchr/version.rb

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

data/searchr.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'searchr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "searchr"
+  spec.version       = Searchr::VERSION
+  spec.authors       = ["Brian Murphy-Dye"]
+  spec.email         = ["brian@murphydye.com"]
+
+  spec.summary       = %q{Diagnose search result weights. Currently supports solr. To be used with searchr-rails.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'addressable'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: searchr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Murphy-Dye
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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-nc
+  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: guard
+  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: guard-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: pry
+  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: pry-remote
+  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: pry-nav
+  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:
+- brian@murphydye.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/searchr.rb
+- lib/searchr/query.rb
+- lib/searchr/result.rb
+- lib/searchr/solr_query.rb
+- lib/searchr/solr_result.rb
+- lib/searchr/version.rb
+- searchr.gemspec
+homepage: ''
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Diagnose search result weights. Currently supports solr. To be used with
+  searchr-rails.
+test_files: []