puree 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a22ff7fedfd49fa3ae29510a7aa3fd532e3c9838
-  data.tar.gz: c879d11f1bf415b156e4959be2dde9119574d962
+  metadata.gz: 539976142cda876c73eb0caf03ae4b2eca425775
+  data.tar.gz: f5896f3afb50cbc67bca6d20124fef8d85ae4052
 SHA512:
-  metadata.gz: e3ca6c455e0773a642bd5ad0bc513dc2a940ddc7c081be05deb0bc6ccd63e11789374a0ad70a12ad4caf8eaacff3d3ececb12fcedebe966880fa01cb6a176289
-  data.tar.gz: cc3a510f29157231b12cb3f47b4b9790638d721583769358b236b45854b98f9d9a9f1ab895d855fd21233494b06520f3c09e7e07ebea9c79fd3223adc763daef
+  metadata.gz: a6f35ad8908b500f03ff30f00b38621bf8d570fc5b3c9f53be7e24ef1b7eb024e342fe3d56e8f99b7b8d23cdeaed466e2e3c372cb73b09a0f24e47c17d9a1ed6
+  data.tar.gz: 1b6b644bbb9157f345b29a03428805cee300a2982ac44378b5c3aa873fd8487a964bce711bb6f7553eaab3cf426c3c2e1f1abca0a0051738165d3024c67c304a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.13.0 - 2016-05-20
+### Added
+- Collection server-side search by date range (created, modified) and paging.
+
 ## 0.12.0 - 2016-05-20
 ### Added
 - Resource (created, modified, uuid).

data/README.md

@@ -75,11 +75,16 @@ Collection.
 ```ruby
 c = Puree::Collection.new(resource_type: :dataset)
 
-# Get minimal datasets, optionally specifying a quantity (default is 20)
-c.get endpoint: endpoint,
-      username: username,
-      password: password,
-      qty:      100000
+# Get three minimal datasets, starting at record ten, created and modified in January 2016.
+c.get endpoint:       endpoint,
+      username:       username,
+      password:       password,
+      limit:          3,  # optional, default 20
+      offset:         10, # optional, default 0
+      created_start:  '2016-01-01', # optional
+      created_end:    '2016-01-31', # optional
+      modified_start: '2016-01-01', # optional
+      modified_end:   '2016-01-31'  # optional
 
 # Get UUIDs for datasets
 uuids = c.uuid
@@ -160,12 +165,14 @@ Contains an array of internal persons, an array of external persons and an array
   "external"=>[
   ],
   "other"=>[
+    {
       "name"=>{
         "first"=>"Hal",
         "last"=>"Roach"
       },
       "role"=>"Contributor",
       "uuid"=>""
+    },
   ]
 }
 ```
@@ -216,7 +223,7 @@ An array of research outputs associated with the dataset.
     "type": "Chapter",
     "title": "An interesting chapter title",
     "uuid": "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx"
-  }
+  },
 ]
 ```
 
@@ -251,7 +258,7 @@ An array of addresses.
     "postcode"=>"LA1 4YN",
     "city"=>"Lancaster",
     "country"=>"United Kingdom"
-  }
+  },
 ]
 ```
 

data/lib/puree/collection.rb

@@ -16,25 +16,60 @@ module Puree
     # @param password [String]
     # @param qty [Integer]
     # @return [HTTParty::Response]
-    def get(endpoint:nil, username:nil, password:nil, qty:nil)
+    def get(endpoint:         nil,
+            username:         nil,
+            password:         nil,
+            limit:            20,
+            offset:           0,
+            created_start:    nil,
+            created_end:      nil,
+            modified_start:   nil,
+            modified_end:     nil)
       # strip any trailing slash
       @endpoint = endpoint.sub(/(\/)+$/, '')
       @auth = Base64::strict_encode64(username + ':' + password)
 
       @options = {
-          latest_api: true,
-          resource_type: @resource_type.to_sym,
-          rendering: :system,
-          qty: qty
+          latest_api:       true,
+          resource_type:    @resource_type.to_sym,
+          rendering:        :system,
+          limit:            limit,
+          offset:           offset,
+          created_start:    created_start,
+          created_end:      created_end,
+          modified_start:   modified_start,
+          modified_end:     modified_end
       }
       headers = {
           'Accept' => 'application/xml',
           'Authorization' => 'Basic ' + @auth
       }
       query = {}
+
       query['rendering'] = @options[:rendering]
-      if @options[:qty]
-        query['window.size'] = @options[:qty]
+
+      if @options[:limit]
+        query['window.size'] = @options[:limit]
+      end
+
+      if @options[:offset]
+        query['window.offset'] = @options[:offset]
+      end
+
+      if @options[:created_start]
+        query['createdDate.fromDate'] = @options[:created_start]
+      end
+
+      if @options[:created_end]
+        query['createdDate.toDate'] = @options[:created_end]
+      end
+
+      if @options[:modified_start]
+        query['modifiedDate.fromDate'] = @options[:modified_start]
+      end
+
+      if @options[:modified_end]
+        query['modifiedDate.toDate'] = @options[:modified_end]
       end
 
       @response = HTTParty.get(build_url, query: query, headers: headers)
@@ -55,23 +90,9 @@ module Puree
 
 
     def collect_uuid
-      response_name = service_response_name
-      resp = @response[response_name]['result']['renderedItem']
-      arr = []
-      if resp.is_a?(Array)
-        arr = resp
-      else
-        arr << resp
-      end
-      arr.each do |a|
-        tableRows = a['div']['table']['tbody']['tr']
-        tableRows.each do |row|
-          if row['th'] === 'UUID'
-            uuid = row['td']
-            @uuids << uuid
-          end
-        end
-      end
+      path = '//renderedItem/@renderedContentUUID'
+      xpath_result = xpath_query path
+      xpath_result.each { |i| @uuids << i.text.strip }
     end
 
 

data/lib/puree/resource.rb

@@ -17,17 +17,22 @@ module Puree
     # @param uuid [String]
     # @param id [String]
     # @return [HTTParty::Response]
-    def get(endpoint:nil, username:nil, password:nil, uuid:nil, id:nil)
+    def get(endpoint:       nil,
+            username:       nil,
+            password:       nil,
+            uuid:           nil,
+            id:             nil
+    )
       # strip any trailing slash
       @endpoint = endpoint.sub(/(\/)+$/, '')
       @auth = Base64::strict_encode64(username + ':' + password)
 
       @options = {
-          latest_api: true,
+          latest_api:     true,
           resource_type: @resource_type.to_sym,
-          rendering: :xml_long,
-          uuid: uuid,
-          id: id,
+          rendering:      :xml_long,
+          uuid:           uuid,
+          id:             id
       }
       headers = {
           'Accept' => 'application/xml',
@@ -35,6 +40,7 @@ module Puree
       }
       query = {}
       query['rendering'] = @options[:rendering]
+
       if @options[:uuid]
         query['uuids.uuid'] = @options[:uuid]
       else

data/lib/puree/version.rb

@@ -1,3 +1,3 @@
 module Puree
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Adrian Albin-Clark