clusterpoint 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9341eb8053765e973c79fac55a79cf86e560d114
-  data.tar.gz: 8e04fd53420b5cf8d395548ea1c2d0289d898d6b
+  metadata.gz: 13d4d1ff1b7c87171be7c76a357d8bf80a6a8f1f
+  data.tar.gz: ca9701eaf8731a1625582902340662db4aa4b845
 SHA512:
-  metadata.gz: 832658e7085d3f7349efbb195967e00f0b56619d74811a1d27bc26bb8405e9eed58bcae161c7c6684580298092d4eba710c9ffc44ed0ad23b5284955f93e891c
-  data.tar.gz: 4248a008564f749a5c78979013a27fe5daab6e8acc182c4a2d39691f35c0996eb8674c291a5191fab1c2b256b3e94da39da0e329c873fdf2f42502cb9f3c1d0b
+  metadata.gz: e77a0bcdc9c43e6e6a15aa0480dae90d2e915c3f867895adedc2b926f0af9d07c47edc12d85753afd270ed54534ae7198ade2a07da63f27fc751d940fd61c8f7
+  data.tar.gz: 739ff0c7de2f454b146fe9df85ae37d459b7b0c53e180415d7296637a205c59d2c97ebab0b93f93c8d121d68a1421cc2a78d23a71c44e35ec2256069aece8555

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Overview
+
+## 0.2.3
+
+### New Features
+
+* Exposed where method
+* Added Clusterpoint order support (default order by ID ascending)
+  - `Item.where(query_hash, order_hash, record_count, start_offset)`
+  - `Item.where({code: "A*"}, {string: {code: :ascending}})`
+  - More about query syntax:
+    - http://docs.clusterpoint.com/wiki/Search_query_syntax
+    - http://docs.clusterpoint.com/wiki/Alphabetic_Ordering
+* Moved HTTP request debug setting to configuration file
+  debug_output: $stdout

data/README.md

@@ -28,38 +28,48 @@ Add railtie require to your application.rb file:
 ### Database connection
 Add cluster_point.yml file under config directory. Following format;
 
-    development:
-      url: https://api.clusterpoint.com
-      account_id: [Clusterpoint cloud api account ID]
-      database: [Database to use]
-      username: [Clusterpoint cloud username]
-      password: [Clusterpoint cloud password]
+```
+development:
+    url: https://api.clusterpoint.com
+    account_id: [Clusterpoint cloud api account ID]
+    database: [Database to use]
+    username: [Clusterpoint cloud username]
+    password: [Clusterpoint cloud password]
+    [debug_output: $stdout]
+```
 
 ### Framework usage
 To make model as Clusterpoint document innerhit it from `ClusterPoint::Document`
 
 To define subdocuments you can use one of two options - `contains` (if contains single subdocument) or `contains_many` (if contains more than one subdocument):
 
-    contains_many :translations
-    contains :author
+```ruby
+contains_many :translations
+contains :author
+```
 
 Example:
 
-    class Item < ClusterPoint::Document
-      contains_many :translations
-      contains_many :locations
-      contains :author
-    end
+```ruby
+class Item < ClusterPoint::Document
+  contains_many :translations
+  contains_many :locations
+  contains :author
+end
+```
 
 ### Basic operations
-* Item.all - retrieve all documents with type Item (models are divided with document attribute `type`)
-* Item.find(id) - retrieve document with ID = id
-* Item.new_from_hash(item_params.to_h) - create new document from hash
-* @item.save - save document
-* @item.update(item_params.to_h) - update document and save changes
-* @item.destroy - delete document
-* .where({type: "ITEM"}) - custom query - not yet exposed for easy use
-
+* `Item.all` - retrieve all documents with type Item (models are divided with document attribute `type`)
+* `Item.find(id)` - retrieve document with ID = id
+* `Item.new_from_hash(item_params.to_h)` - create new document from hash
+* `@item.save` - save document
+* `@item.update(item_params.to_h)` - update document and save changes
+* `@item.destroy `- delete document
+* `Item.where(query_hash, order_hash, record_count, start_offset)` - custom query.
+  * `Item.where({code: "A*"}, {string: {code: :ascending}})`
+  - More about query syntax:
+    - http://docs.clusterpoint.com/wiki/Search_query_syntax
+    - http://docs.clusterpoint.com/wiki/Alphabetic_Ordering
 
 ## Development
 

data/lib/cluster_point/cluster_point_adapter.rb

@@ -5,7 +5,6 @@ module ClusterPoint
 
   class ClusterPointAdapter
     include HTTParty
-    debug_output $stdout
     include ClusterPoint::Configuration
 
     def initialize
@@ -62,10 +61,12 @@ module ClusterPoint
       end
     end
 
-    def where(hash={}, docs=20, offset=0)
-      xml = hash.to_xml(skip_instruct: true, :indent => 1)
-      options = { body: [{ query: xml.lines.to_a[1..-2].join, 
-                           docs: docs, 
+    def where(conditions={}, ordering={string: {id: :ascending}}, docs=20, offset=0)
+      query_xml = conditions.to_xml(skip_instruct: true, skip_types: true, indent: 1)
+      ordering_xml = ordering.to_xml(skip_instruct: true, skip_types: true, indent: 1)
+      options = { body: [{ query: query_xml.lines.to_a[1..-2].join,
+                           ordering: ordering_xml.lines.to_a[1..-2].join,
+                           docs: docs,
                            offset: offset
                         }].to_json,
                   basic_auth: @auth,

data/lib/cluster_point/configuration.rb

@@ -19,6 +19,9 @@ module ClusterPoint
       @config = data[@env]
 
       self.class.base_uri get_base_uri(@config)
+      if @config["debug_output"]
+        self.class.debug_output $stdout
+      end
     end
 
     def get_base_uri(config)

data/lib/cluster_point/finder_methods.rb

@@ -2,8 +2,13 @@ require 'json'
 module ClusterPoint
   module FinderMethods
       
-    def all()
-      respToArray(JSON.parse(get_cp.where({type: self.to_s.upcase})))
+    def all(ordering={string: {id: :ascending}})
+      respToArray(JSON.parse(get_cp.where({type: self.to_s.upcase}, ordering)))
+    end
+
+    def where(conditions={}, ordering={string: {id: :ascending}}, docs=20, offset=0)
+      conditions.merge!({type: self.to_s.upcase})
+      respToArray(JSON.parse(get_cp.where(conditions, ordering, docs, offset)))
     end
 
     def find(*ids)
@@ -36,7 +41,7 @@ module ClusterPoint
     protected
 
     def get_some(ids)
-      items = respToArray(JSON.parse(get_cp.where({type: self.to_s.upcase, id: "{" + ids.join(" ") + "}"}, ids.size, 0)))
+      items = respToArray(JSON.parse(get_cp.where({type: self.to_s.upcase, id: "{" + ids.join(" ") + "}"}, docs: ids.size)))
       if items.size != ids.size
         raise RecordNotFound
       end

data/lib/cluster_point/version.rb

@@ -1,3 +1,3 @@
 module ClusterPoint
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clusterpoint
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Janis Baiza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,6 +147,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md