agnostic_backend 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adf6e64ff40d6984bf84ba08e14fcf459faffd46
-  data.tar.gz: eefee2944db74675056542c2b6a6b8e3d8ea6046
+  metadata.gz: 73a513561f2917abee7727c67df6cedba5e726fe
+  data.tar.gz: c55115526a99f35b449a71bf0c2cbdb217b5a110
 SHA512:
-  metadata.gz: 4fea2b3aab467cf814e51c7248d644dc4999822705a9d4f4fea019773fc47ce8c5a0d1c85ffec267740d8e60b121b523144e904a3f5b1312485dc2f6a984b353
-  data.tar.gz: 7ff9d05392720da4d45707a10ee956be56efdbda10b5006c6b137f322b71b5fe53f89d08ab4da946f17b3ddd89cde04d4f4010d6282ad34a9297225f1fba8116
+  metadata.gz: 0e0a967399f727fd7ed2146294cb6de0358039b136b2699f3ddec53e63211b12f52a36c7b6bf3bd15ed5e86925bf53f43cb87866619d132832811034181363ed
+  data.tar.gz: 2c08d23d1d45ca9c918e237c957907a53a3bae64fa8b1cfad93122e9f148e52c160314a1e017606d7da3dadac8d8e3097cdf220b2c3a23dfc994edebd80b53d9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    agnostic_backend (0.9.1)
+    agnostic_backend (0.9.2)
       activesupport (>= 3.2.22)
       aws-sdk (~> 2)
 

data/README.md

@@ -2,22 +2,25 @@
 Version](https://badge.fury.io/rb/agnostic_backend.svg)](https://badge.fury.io/rb/agnostic_backend)
 [![Travis Build Status](https://travis-ci.org/e-travel/agnostic_backend.svg?branch=master)](https://travis-ci.org/e-travel/agnostic_backend)
 [![Code Climate](https://codeclimate.com/github/e-travel/agnostic_backend/badges/gpa.svg)](https://codeclimate.com/github/e-travel/agnostic_backend)
+[![Dependency Status](https://gemnasium.com/e-travel/agnostic_backend.svg)](https://gemnasium.com/e-travel/agnostic_backend)
 
 # Agnostic Backend
 
-`agnostic_backend` is a gem that provides indexing and searching
-capabililities to Ruby objects by supplying two modules: `Indexable`
-and `Queryable`. `Indexable` provides indexing functionality by
-specifying a way to define which attributes of an object should be
-included in a document to be indexed to a remote backend
+`agnostic_backend` is a gem that adds indexing and searching
+capabilities to Ruby objects for various backends.
+
+It includes two modules: `Indexable` and `Queryable`.
+`Indexable` provides indexing functionality by
+specifying a way to define which object attributes should be
+transformed in order to be eventually indexed to a remote backend
 store. `Queryable` provides search and retrieval functionality by
 specifying a generic query language that seamlessly maps to specific
 backend languages.
 
 In addition to these two modules, `agnostic_backend` supplies
-additional classes (`Indexer` and `Index`) to support the
-configuration and functionality of remote backends (such as
-elasticsearch, AWS Cloudsearch etc.).
+additional classes (`Indexer` and `Index`) to support
+configuration and transformation functionality for remote backends (such as
+elasticsearch, AWS Cloudsearch etc).
 
 Although the motivation and use case for the gem relates to
 `ActiveRecord` models, no assumption is made as to the classes to
@@ -25,6 +28,10 @@ which `Indexable` and `Queryable` can be included. The objective is to
 maximize the flexibility of clients with respect to the use cases they
 need to address.
 
+## Supported backends
+
+* [AWS Cloudsearch](https://aws.amazon.com/cloudsearch/)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -51,19 +58,15 @@ for more info on dependencies.
 
 For the purposes of this document, we will focus on `ActiveRecord`
 examples. Let's assume we have two AR models, `Task` and `Workflow`,
-connected using an one-to-many relationship (i.e. a `Workflow` has
-many `Task`s) as follows:
+connected using an one-to-many relationship (i.e. a Workflow has
+many Tasks) as follows:
 
 ```ruby
 class Task < ActiveRecord::Base
-  include AgnosticBackend::Indexable
-
   belongs_to :workflow, class_name: 'Workflow'
 end
 
 class Workflow < ActiveRecord::Base
-  include AgnosticBackend::Indexable
-
   has_many :tasks, class_name: 'Task'
 end
 ```
@@ -217,7 +220,7 @@ AgnosticBackend::Indexable::Config.configure_index(
 ```
 
 More information about the use of `Indexable` can be found in
-[this document](src/master/doc/indexable.md).
+[this document](doc/indexable.md).
 
 ### Queryable
 
@@ -253,7 +256,7 @@ results = query.execute
 ```
 
 For more information about `Queryable` check out
-[this document](src/master/doc/queryable.md).
+[this document](doc/queryable.md).
 
 
 ### Backends

data/doc/indexable.md

@@ -289,4 +289,4 @@ end
 
 This gives access to the matchers `be_indexable` and
 `define_index_field`. For usage examples, check the
-[corresponding test file](matchers_spec.rb).
+[corresponding test file](https://github.com/e-travel/agnostic_backend/blob/master/spec/matchers_spec.rb).

data/doc/queryable.md

@@ -0,0 +1,3 @@
+# Queryable
+
+Content to appear here.

data/lib/agnostic_backend/queryable/cloudsearch/result_set.rb

@@ -8,7 +8,7 @@ module AgnosticBackend
           raw_results.hits.found
         end
 
-        def cursor
+        def scroll_cursor
           raw_results.hits.cursor
         end
 
@@ -24,4 +24,4 @@ module AgnosticBackend
       end
     end
   end
-end
+end

data/lib/agnostic_backend/version.rb

@@ -1,3 +1,3 @@
 module AgnosticBackend
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agnostic_backend
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Iasonas Gavriilidis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport