fracas 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f086a0443ad8fe5746e5d5edd7deaf57e4e78549
+  data.tar.gz: 17e24bf030ba8a4fea76f886466258b28fdcf3d8
+SHA512:
+  metadata.gz: 6dfea9b77028a28531cb2c5de2618bcb4738d39726b3bd097a61bafe590c762974f43bc3eccdc3d912b84389623beb38c09b0947a205e19e218b3ece1b7fbdfb
+  data.tar.gz: 0bf9e802f598f9d022b9c7ebe3f5981c4a581739e8cc851b08ebddf7df144a0497378a1da6cc31d00547c3e23a5ac52ba8a5e8e5268e93f05dc2e098276baca3

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Hanks
+
+MIT License
+
+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,29 @@
+# Fracas
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fracas'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fracas
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fracas/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/fracas.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fracas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fracas'
+  spec.version       = Fracas::VERSION
+  spec.authors       = ["Chris Hanks"]
+  spec.email         = ['christopher.m.hanks@gmail.com']
+  spec.summary       = %q{Write a short summary. Required.}
+  spec.description   = %q{Write a longer description. Optional.}
+  spec.homepage      = 'https://github.com/chanks/fracas'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'elasticsearch'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'pry'
+end

data/lib/fracas.rb

@@ -0,0 +1,12 @@
+require 'elasticsearch'
+
+require 'fracas/dataset'
+require 'fracas/version'
+
+module Fracas
+  class << self
+    def connect(url = nil)
+      Dataset.new(url)
+    end
+  end
+end

data/lib/fracas/dataset.rb

@@ -0,0 +1,119 @@
+module Fracas
+  class Dataset
+    include Enumerable
+
+    attr_reader :client, :query, :results
+
+    def initialize(url)
+      @query = {
+        indices: [],
+        types:   [],
+        filters: []
+      }
+
+      @client = Elasticsearch::Client.new(url: url)
+    end
+
+    def refresh
+      @client.indices.refresh index: indices
+    end
+
+    def from_indices(*indices)
+      merge(indices: indices)
+    end
+    alias :from_index :from_indices
+
+    def from_types(*types)
+      merge(types: types)
+    end
+    alias :from_type :from_types
+
+    def each(&block)
+      with_loaded_results { |ds| ds.all.each(&block) }
+    end
+
+    def all
+      with_loaded_results { |ds| ds.results['hits']['hits'].map { |hit| hit['_source'] } }
+    end
+
+    def count
+      with_loaded_results { |ds| ds.results['hits']['total'] }
+    end
+
+    def filter(condition = {})
+      merge filters: condition
+    end
+
+    def to_query
+      query = {
+        index: indices,
+        type: types,
+        body: {
+          query: queries,
+          filter: filters
+        }
+      }
+    end
+
+    def merge(query)
+      clone.tap { |clone| clone.merge!(query) }
+    end
+
+    def merge!(query)
+      @query = @query.merge(query) do |key, oldval, newval|
+        case key
+        when :indices, :types then oldval + newval
+        when :filters         then oldval + [newval]
+        else raise "Unrecognized key! #{key.inspect}"
+        end
+      end
+    end
+
+    def load
+      clone.tap(&:load!)
+    end
+
+    def load!
+      @results = @client.search(to_query)
+    end
+
+    private
+
+    def with_loaded_results
+      yield results ? self : load
+    end
+
+    def indices
+      indices = @query[:indices]
+      indices.count.zero? ? '_all' : indices.join(',')
+    end
+
+    def types
+      types = @query[:types]
+      types.join(',') unless types.count.zero?
+    end
+
+    def queries
+      {
+        match_all: {}
+      }
+    end
+
+    def filters
+      filters = @query[:filters]
+      if filters.count.zero?
+        {
+          match_all: {}
+        }
+      else
+        {
+          and: filters.map { |w|
+            {
+              term: w
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/fracas/version.rb

@@ -0,0 +1,3 @@
+module Fracas
+  VERSION = '0.0.1'
+end

data/spec/fracas/connect_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Fracas, '.connect' do
+  it "should instantiate a Fracas::Dataset instance" do
+    Fracas.connect.should be_an_instance_of Fracas::Dataset
+  end
+end

data/spec/fracas/dataset/client_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Fracas::Dataset, '#client' do
+  it "should return the ElasticSearch client object used by that Dataset object" do
+    FTS.client.should be_an_instance_of Elasticsearch::Transport::Client
+    proc { FTS.client.info }.should_not raise_error
+  end
+end

data/spec/fracas/dataset/filter_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Fracas::Dataset, '#filter' do
+  it "should add a filter to the search" do
+    store body: {title: "Title 1", comments_count: 5}
+    store body: {title: "Title 2", comments_count: 9}
+    FTS.refresh
+
+    titles = []
+    FTS.filter(comments_count: 5).each do |doc|
+      titles << doc['title']
+    end
+    titles.sort.should == ["Title 1"]
+  end
+
+  it "should return a new copy of the dataset" do
+    ds1 = FTS.filter(comments_count: 5)
+    ds1.query[:filters].should == [{comments_count: 5}]
+
+    ds2 = ds1.filter(title: "The Joy of Ferrets")
+    ds2.query[:filters].should == [{comments_count: 5}, {title: "The Joy of Ferrets"}]
+
+    ds1.query[:filters].should == [{comments_count: 5}]
+  end
+end

data/spec/fracas/dataset/from_indices_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Fracas::Dataset, '#from_indices' do
+  it "should specify the index(es) to be covered by the search" do
+    store index: 'index1', body: {title: "Title 1", comments_count: 1}
+    store index: 'index1', body: {title: "Title 2", comments_count: 2}
+    store index: 'index2', body: {title: "Title 3", comments_count: 3}
+    store index: 'index3', body: {title: "Title 4", comments_count: 4}
+    FTS.refresh
+
+    FTS.from_indices('index1').map{|d| d['comments_count']}.sort.should == [1, 2]
+    FTS.from_indices('index1', 'index2').map{|d| d['comments_count']}.sort.should == [1, 2, 3]
+    FTS.from_indices('index1', 'index3').map{|d| d['comments_count']}.sort.should == [1, 2, 4]
+    FTS.from_indices('index1').from_indices('index3').map{|d| d['comments_count']}.sort.should == [1, 2, 4]
+  end
+end

data/spec/fracas/dataset/from_types_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Fracas::Dataset, '#from_types' do
+  it "should specify the type(s) to be returned by the search" do
+    store type: 'type1', body: {title: "Title 1", comments_count: 1}
+    store type: 'type1', body: {title: "Title 2", comments_count: 2}
+    store type: 'type2', body: {title: "Title 3", comments_count: 3}
+    store type: 'type3', body: {title: "Title 4", comments_count: 4}
+    FTS.refresh
+
+    FTS.from_types('type1').map{|d| d['comments_count']}.sort.should == [1, 2]
+    FTS.from_types('type1', 'type2').map{|d| d['comments_count']}.sort.should == [1, 2, 3]
+    FTS.from_types('type1', 'type3').map{|d| d['comments_count']}.sort.should == [1, 2, 4]
+    FTS.from_types('type1').from_types('type3').map{|d| d['comments_count']}.sort.should == [1, 2, 4]
+  end
+end

data/spec/fracas/dataset/results_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Fracas::Dataset do
+  context "#each" do
+    it "should iterate over the JSON documents matching the search" do
+      store body: {title: "Title 1"}
+      store body: {title: "Title 2"}
+      FTS.refresh
+
+      titles = []
+      FTS.each do |doc|
+        titles << doc['title']
+      end
+      titles.sort.should == ["Title 1", "Title 2"]
+
+      FTS.each{|d| d}.should == FTS.all
+    end
+
+    it "should not load the results into the dataset on which it is called" do
+      store body: {title: "Title 1", comments_count: 5}
+      store body: {title: "Title 2", comments_count: 9}
+      store body: {title: "Title 3", comments_count: 5}
+      FTS.refresh
+      ds = FTS.filter(comments_count: 5)
+      ds.results.should be_nil
+
+      titles = []
+      ds.each { |doc| titles << doc['title'] }
+      titles.sort.should == ["Title 1", "Title 3"]
+
+      ds.results.should be_nil
+    end
+
+    it "should allow for the use of Enumerable methods" do
+      store body: {title: "Title 1", comments_count: 5}
+      store body: {title: "Title 2", comments_count: 9}
+      store body: {title: "Title 3", comments_count: 5}
+      FTS.refresh
+      ds = FTS.filter(comments_count: 5)
+      ds.results.should be_nil
+      ds.inject(0){|number, doc| number + doc['comments_count']}.should == 10
+      ds.results.should be_nil
+    end
+  end
+
+  context "#all" do
+    it "should return an array of matching documents without mutating the dataset" do
+      store body: {title: "Title 1", comments_count: 5}
+      store body: {title: "Title 2", comments_count: 9}
+      store body: {title: "Title 3", comments_count: 5}
+      FTS.refresh
+      ds = FTS.filter(comments_count: 5)
+      ds.results.should be_nil
+      all = ds.all
+      all.length.should == 2
+      all.map{|d| d['title']}.sort.should == ["Title 1", "Title 3"]
+      ds.results.should be_nil
+    end
+  end
+
+  context "#count" do
+    it "should return a count of matching documents without mutating the dataset" do
+      store body: {title: "Title 1", comments_count: 5}
+      store body: {title: "Title 2", comments_count: 9}
+      store body: {title: "Title 3", comments_count: 5}
+      FTS.refresh
+
+      ds = FTS.filter(comments_count: 5)
+      ds.results.should be_nil
+      ds.count.should == 2
+      ds.results.should be_nil
+    end
+  end
+
+  context "#load" do
+    it "should copy the dataset and load the results into it" do
+      store body: {title: "Title 1", comments_count: 5}
+      store body: {title: "Title 2", comments_count: 9}
+      store body: {title: "Title 3", comments_count: 5}
+      FTS.refresh
+      ds1 = FTS.filter(comments_count: 5)
+      ds1.results.should be_nil
+
+      ds2 = ds1.load
+      ds2.results.should_not be_nil
+
+      ds2.count.should == 2
+      ds2.all.length.should == 2
+
+      ds1.results.should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'fracas'
+require 'faker'
+require 'pry'
+
+FTS = Fracas.connect
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = [:expect, :should] }
+
+  config.before do
+    FTS.client.indices.delete index: '_all'
+  end
+end
+
+def store(index: 'fracas_test', type: 'fracas_test', body: {})
+  FTS.client.index index: index,
+                   type: type,
+                   body: {
+                     title: Faker::Lorem.sentence,
+                     body: Faker::Lorem.paragraph,
+                     tags: Faker::Lorem.words(3),
+                     published: rand > 0.5,
+                     comments_count: rand(50)
+                   }.merge(body)
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: fracas
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Hanks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  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'
+description: Write a longer description. Optional.
+email:
+- christopher.m.hanks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fracas.gemspec
+- lib/fracas.rb
+- lib/fracas/dataset.rb
+- lib/fracas/version.rb
+- spec/fracas/connect_spec.rb
+- spec/fracas/dataset/client_spec.rb
+- spec/fracas/dataset/filter_spec.rb
+- spec/fracas/dataset/from_indices_spec.rb
+- spec/fracas/dataset/from_types_spec.rb
+- spec/fracas/dataset/results_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chanks/fracas
+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: Write a short summary. Required.
+test_files:
+- spec/fracas/connect_spec.rb
+- spec/fracas/dataset/client_spec.rb
+- spec/fracas/dataset/filter_spec.rb
+- spec/fracas/dataset/from_indices_spec.rb
+- spec/fracas/dataset/from_types_spec.rb
+- spec/fracas/dataset/results_spec.rb
+- spec/spec_helper.rb