puree 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2057afc22f318c041a9ae6e2f38f45d6bf178896
-  data.tar.gz: dbd57196335d0291d3a3e8afcae5ce3185a56a9b
+  metadata.gz: c2678f284947384cb88da1511bbdedf6cbc00314
+  data.tar.gz: 7d8435e7e07d5e98aa8240e1e736456503457a7f
 SHA512:
-  metadata.gz: b6d2f693ac2abefbb753d43f183e25d1d89cc6dd44f5bab659002c2b7f9e6aeb5499ad9dc668e19a2891854a2c095c5f0fe1bbcaf4d6b55dcce43668740aa6b3
-  data.tar.gz: 969daf19da9bfd0eafb5cb20bc73bbe6930f145d565b5f57c76a9559d144486f854acffe27bbc1a4eb9c89a9c2f91879fef82ded23df08c6f05d5a2e36145841
+  metadata.gz: fe6494c3ac14f9f20811268c5b3c65b2cd5b5f888a94113cf2f887729c3ea1998d73883193bdc0db740659f8f099f354f6767e30a0c75b00c182496cba18b13a
+  data.tar.gz: 1d9cf4abce07487bcf45881ebec3bbf7f6c1ab241002e1c91c0891cee3220dfccf1f82f2c65eac2e3cd19b7bc3eff6eccca0b9aa806b049d198a1bd496df39a8

data/CHANGELOG.md

@@ -7,6 +7,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Factory to make resource objects?
 - Make ALL dates ISO 8601 YYYY-MM-DD, rather than mirror varying formats from Pure?
 
+## 0.18.0 - 2016-09-20
+### Added
+- Collection - count of records available.
+
 ## 0.17.1 - 2016-09-08
 ### Fixed
 - Dataset - available extraction.

data/PITCHME.md

@@ -0,0 +1,108 @@
+#HSLIDE
+
+## Rationale
+
+Projects revealed challenges getting specific data from the Pure Research Information System API.
+
+#VSLIDE
+
+## DOI minting
+
+Transforming metadata to the DataCite XML schema and minting Digital Object Identifiers.
+
+<a href="https://github.com/lulibrary/doi" target="_blank">GitHub</a>
+
+#VSLIDE
+
+## Fedora repository
+
+Transforming metadata to RDF and ingesting via REST API.
+
+#VSLIDE
+
+## Linked open data
+
+Transforming metadata to RDF and publishing in Fuseki triple store.
+
+#VSLIDE
+
+## Primo
+
+Enriching author metadata.
+
+#VSLIDE
+
+## DMAOnline
+
+Ingesting research data management data from the Current Research Information System (CRIS) of multiple institutions.
+
+<a href="http://dmao.info/" target="_blank">Project website</a>
+
+#HSLIDE
+
+## Pure API challenges
+
+#VSLIDE
+
+- Metadata at resource level e.g. dataset.
+- Only XML available. <!-- .element: class="fragment" -->
+- XML needs processing to extract specific metadata. <!-- .element: class="fragment" -->
+- Local web services consuming the Pure API are not useful when contributing FOSS. <!-- .element: class="fragment" -->
+
+#HSLIDE
+
+## Pur&#233;e: an answer to the challenges
+
+#VSLIDE
+
+- Consumes the Pure API.
+- Metadata available in simple data structures. <!-- .element: class="fragment" -->
+- No XML processing needed in any code. <!-- .element: class="fragment" -->
+
+#VSLIDE
+
+## Single resource
+Tell Pur&#233;e what you are looking for...
+
+```ruby
+d = Puree::Dataset.new
+metadata = d.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+```
+...and get the data from a hash...
+
+```ruby
+metadata['doi']
+```
+
+...or using a method...
+
+```ruby
+d.doi
+```
+
+#VSLIDE
+
+## Collection of resources
+Tell Pur&#233;e what you are looking for...
+
+```ruby
+c = Puree::Collection.new resource: :dataset
+metadata = c.find limit: 50
+```
+...and get the data from an array of hashes or from an array of instances.
+
+#VSLIDE
+
+## Location
+
+<a href="https://rubygems.org/gems/puree" target="_blank">RubyGems</a>
+
+<a href="https://github.com/lulibrary/puree" target="_blank">GitHub</a>
+
+#VSLIDE
+
+## Documentation
+
+<a href="http://www.rubydoc.info/gems/puree" target="_blank">API in YARD</a>
+
+<a href="https://aalbinclark.gitbooks.io/puree" target="_blank">Detailed usage in GitBook</a>

data/README.md

@@ -1,4 +1,4 @@
-# Purée [![Gem Version](https://badge.fury.io/rb/puree.svg)](https://badge.fury.io/rb/puree)
+# Purée [![Gem Version](https://badge.fury.io/rb/puree.svg)](https://badge.fury.io/rb/puree) [![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/lulibrary/puree)
 Consumes the Pure Research Information System API and puts the metadata into simple data structures.
 
 ## Installation

data/lib/puree/collection.rb

@@ -65,6 +65,8 @@ module Puree
           record_rendering: rendering
       }
 
+      reset
+
       missing = missing_credentials
       if !missing.empty?
         missing.each do |m|
@@ -88,7 +90,7 @@ module Puree
 
       query['rendering'] = @options[:rendering]
 
-      if @options[:limit]
+      if @options[:limit] >= 0
         query['window.size'] = @options[:limit]
       end
 
@@ -133,6 +135,7 @@ module Puree
         @doc = Nokogiri::XML @response.body
         @doc.remove_namespaces!
 
+        @count = extract_count
         # code = @response.code
         # body = @response.body
         # puts "#{self.class.name} #{code}"
@@ -157,8 +160,20 @@ module Puree
     end
 
 
+    # Count of records available for a resource type
+    #
+    # @return [Integer]
+    def count
+      @count
+    end
+
     private
 
+    def extract_count
+      path = '//count'
+      xpath_query_for_single_value(path).to_i
+    end
+
 
     # Array of UUIDs
     #
@@ -233,6 +248,11 @@ module Puree
       @doc.xpath path
     end
 
+    def xpath_query_for_single_value(path)
+      xpath_result = xpath_query path
+      xpath_result ? xpath_result.text.strip : ''
+    end
+
 
     def missing_credentials
       missing = []
@@ -252,6 +272,11 @@ module Puree
       missing
     end
 
+    def reset
+      @response = nil
+      @count = nil
+    end
+
     alias :find :get
 
   end

data/lib/puree/version.rb

@@ -1,5 +1,5 @@
 module Puree
   # Semantic version number
   #
-  VERSION = "0.17.1"
+  VERSION = "0.18.0"
 end

data/spec/collection.rb

@@ -47,4 +47,16 @@ describe 'Collection' do
 
   end
 
+  describe 'data retrieval count' do
+    before(:all) do
+      new
+      @p.find limit: 0
+    end
+
+    it '#count' do
+      expect(@p.count).to be_an_instance_of(Fixnum)
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puree
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Adrian Albin-Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -50,6 +50,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
+- PITCHME.md
 - README.md
 - Rakefile
 - lib/puree.rb