puree 0.20.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e8e3d618d4573ec565f88c56bdcc6c26db76a0d
-  data.tar.gz: 469f6ac49d1b8359f5199fb5f5d1c77c7f61ba78
+  metadata.gz: 0fcfce1e04c1a07280ef3792f67c7bb4b7fea7e9
+  data.tar.gz: ed700b052232a17ccb11b3337eca880d71e00541
 SHA512:
-  metadata.gz: d2bd320fcca56cd78069f2c22eead8284aa71bf5d25f573d2aaf92a9a36eb5fce2f70bd4a9e6cd3e0a0f743d8c642d1b14768529713316e36e9a8478edaa5511
-  data.tar.gz: 9e1c28522ee527b73127349f0fb8224e65583604b0d56750849a36e3ec30ab2e5d8d774a756b6866437ad09855de307b89d40a3178bba94b2da00302bece4b78
+  metadata.gz: 1087979e95515396a9eceb0a7db3e32dd87130d4505fc95626043f48e657767b762f8861787ce652597098019db2b20a6b365831705a8f633dac89eb27e187cd
+  data.tar.gz: 1fe7778084eecac9c214a354a999825b089e5b4c417ceb3b03cc8db8dc39e7a57d8b1fd1debe87af9dd4170f6d56a948e97b5fbccca93290fc878618cf030f89

data/CHANGELOG.md

@@ -4,8 +4,22 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 - Metadata: activity?, clipping?, externalPerson?
-- Factory to make resource objects?
-- Make ALL dates ISO 8601 YYYY-MM-DD, rather than mirror varying formats from Pure?
+
+## 1.0.0 - 2017-03-15
+### Added
+- Dataset - legal conditions.
+- Collection - random resource.
+
+### Changed
+- Simplified authentication.
+- Hash data structures converted to model classes.
+- All dates in Time format.
+
+### Removed
+- Global configuration.
+
+### Fixed
+- Event - end date extraction.
 
 ## 0.20.0 - 2017-02-03
 ### Added

data/PITCHME.md

@@ -56,53 +56,75 @@ Ingesting research data management data from the Current Research Information Sy
 #VSLIDE
 
 - Consumes the Pure API.
-- Metadata available in simple data structures. <!-- .element: class="fragment" -->
+- Metadata available as Ruby data models. <!-- .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...
+## Resource
+
+Configure an extractor to retrieve data from a Pure host.
+
+```ruby
+dataset_extractor = Puree::Extractor::Dataset.new config
+```
+
+Fetch the metadata for a resource with a particular identifier.
 
 ```ruby
-d = Puree::Dataset.new
-metadata = d.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+dataset = dataset_extractor.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+# =>
+#<Puree::Model::Dataset:0x987f7a4>
 ```
-...and get the data from a hash...
+
+Access specific metadata e.g. an internal person's name.
 
 ```ruby
-metadata['doi']
+dataset.persons_internal[0].name
+# =>
+#<Puree::Model::PersonName:0x9add67c @first="Foo", @last="Bar">
 ```
 
-...or using a method...
+Select a formatting style for a person's name.
 
 ```ruby
-d.doi
+dataset.persons_internal[0].name.last_initial
+# =>
+# "Bar, F."
 ```
 
 #VSLIDE
 
-## Collection of resources
-Tell Pur&#233;e what you are looking for...
+## Collection
+
+Configure a collection extractor to retrieve data from a Pure host.
 
 ```ruby
-c = Puree::Collection.new resource: :dataset
-metadata = c.find limit: 50
+collection_extractor = Puree::Extractor::Collection.new config:   config,
+                                                        resource: :dataset
 ```
-...and get the data from an array of hashes or from an array of instances.
 
-#VSLIDE
+Fetch a bunch of resources.
 
-## Location
+```ruby
+dataset_collection = collection_extractor.find limit: 2
+# =>
+#<Puree::Model::Dataset:0xa62fd90>
+#<Puree::Model::Dataset:0xa5e8c24>
+```
 
-<a href="https://rubygems.org/gems/puree" target="_blank">RubyGems</a>
+Fetch a random resource from the entire collection.
 
-<a href="https://github.com/lulibrary/puree" target="_blank">GitHub</a>
+```ruby
+random_dataset = collection_extractor.random_resource
+# =>
+#<Puree::Model::Dataset:0x97998bc>
+```
 
 #VSLIDE
 
-## Documentation
+## Location
 
-<a href="http://www.rubydoc.info/gems/puree" target="_blank">API in YARD</a>
+<a href="https://rubygems.org/gems/puree" target="_blank">RubyGems</a>
 
-<a href="https://aalbinclark.gitbooks.io/puree" target="_blank">Detailed usage in GitBook</a>
+<a href="https://github.com/lulibrary/puree" target="_blank">GitHub</a>

data/README.md

@@ -1,5 +1,14 @@
-# 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.
+# Purée
+
+Metadata extraction from the Pure Research Information System.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/puree.svg)](https://badge.fury.io/rb/puree)
+[![Build Status](https://semaphoreci.com/api/v1/aalbinclark/puree/branches/master/badge.svg)](https://semaphoreci.com/aalbinclark/puree)
+[![Code Climate](https://codeclimate.com/github/lulibrary/puree/badges/gpa.svg)](https://codeclimate.com/github/lulibrary/puree)
+[![Dependency Status](https://www.versioneye.com/user/projects/5899d253a86053003f389e1f/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/5899d253a86053003f389e1f)
+[![GitPitch](https://gitpitch.com/assets/badge.svg)](https://gitpitch.com/lulibrary/puree)
 
 ## Installation
 
@@ -19,35 +28,80 @@ Or install it yourself as:
 ## Usage
 The following examples are for the Dataset resource type.
 
-### Single resource
-Tell Purée what you are looking for...
+### Configuration
+
+Create a hash for passing to an extractor.
+
+```ruby
+# Pure host with authentication.
+config = {
+  url:      ENV['PURE_URL'],
+  username: ENV['PURE_USERNAME'],
+  password: ENV['PURE_PASSWORD']
+}
+```
 
 ```ruby
-d = Puree::Dataset.new
-metadata = d.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+# Pure host without authentication.
+config = {
+  url: ENV['PURE_URL']
+}
 ```
-...and get the data from a hash...
+
+### Resource
+
+Configure an extractor to retrieve data from a Pure host.
 
 ```ruby
-metadata['doi']
+dataset_extractor = Puree::Extractor::Dataset.new config
 ```
 
-...or using a method...
+Fetch the metadata for a resource with a particular identifier.
 
 ```ruby
-d.doi
+dataset = dataset_extractor.find uuid: 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+# =>
+#<Puree::Model::Dataset:0x987f7a4>
 ```
 
-### Collection of resources
-Tell Pur&#233;e what you are looking for...
+Access specific metadata e.g. an internal person's name.
 
 ```ruby
-c = Puree::Collection.new resource: :dataset
-metadata = c.find limit: 50
+dataset.persons_internal[0].name
+# =>
+#<Puree::Model::PersonName:0x9add67c @first="Foo", @last="Bar">
 ```
-...and get the data from an array of hashes or from an array of instances.
 
-## Documentation
-[API in YARD](http://www.rubydoc.info/gems/puree)
+Select a formatting style for a person's name.
+
+```ruby
+dataset.persons_internal[0].name.last_initial
+# =>
+# "Bar, F."
+```
 
-[Detailed usage in GitBook](https://aalbinclark.gitbooks.io/puree)
+### Collection
+
+Configure a collection extractor to retrieve data from a Pure host.
+
+```ruby
+collection_extractor = Puree::Extractor::Collection.new config:   config,
+                                                        resource: :dataset
+```
+
+Fetch a bunch of resources.
+
+```ruby
+dataset_collection = collection_extractor.find limit: 2
+# =>
+#<Puree::Model::Dataset:0xa62fd90>
+#<Puree::Model::Dataset:0xa5e8c24>
+```
+
+Fetch a random resource from the entire collection.
+
+```ruby
+random_dataset = collection_extractor.random_resource
+# =>
+#<Puree::Model::Dataset:0x97998bc>
+```

data/lib/puree.rb

@@ -1,30 +1,75 @@
 require 'http'
 require 'nokogiri'
-require 'puree/configuration'
-require 'puree/date'
-require 'puree/map'
-require 'puree/resource'
-require 'puree/dataset'
-require 'puree/event'
-require 'puree/journal'
-require 'puree/organisation'
-require 'puree/person'
-require 'puree/project'
-require 'puree/publication'
-require 'puree/publisher'
-require 'puree/collection'
-require 'puree/download'
-require 'puree/server'
+
 require 'puree/version'
 
-# Top level namespace
-#
-module Puree
+require 'puree/util/date'
+
+require 'puree/xml_extractor/shared'
+require 'puree/xml_extractor/base'
+require 'puree/xml_extractor/collection'
+require 'puree/xml_extractor/resource'
+require 'puree/xml_extractor/dataset'
+require 'puree/xml_extractor/download'
+require 'puree/xml_extractor/event'
+require 'puree/xml_extractor/journal'
+require 'puree/xml_extractor/organisation'
+require 'puree/xml_extractor/person'
+require 'puree/xml_extractor/project'
+require 'puree/xml_extractor/publication'
+require 'puree/xml_extractor/publisher'
+require 'puree/xml_extractor/server'
+
+require 'puree/api/map'
+require 'puree/api/request'
+require 'puree/api/configuration'
+require 'puree/api/authentication'
 
-  class << self
+require 'puree/model/helper/validation'
+require 'puree/model/structure'
 
-    include Puree::Configuration
+require 'puree/model/resource'
+require 'puree/model/dataset'
+require 'puree/model/download_header'
+require 'puree/model/event'
+require 'puree/model/event_header'
+require 'puree/model/journal'
+require 'puree/model/link'
+require 'puree/model/organisation'
+require 'puree/model/person'
+require 'puree/model/project'
+require 'puree/model/publication'
+require 'puree/model/publisher'
+require 'puree/model/related_content_header'
+require 'puree/model/spatial_point'
 
-  end
+require 'puree/model/address'
+require 'puree/model/copyright_license'
+require 'puree/model/event_header'
+require 'puree/model/file'
+require 'puree/model/legal_condition'
+require 'puree/model/organisation_header'
+require 'puree/model/endeavour_person'
+require 'puree/model/person_name'
+require 'puree/model/publication_status'
+require 'puree/model/server'
+require 'puree/model/temporal_range'
+
+require 'puree/extractor/resource'
+require 'puree/extractor/dataset'
+require 'puree/extractor/event'
+require 'puree/extractor/journal'
+require 'puree/extractor/organisation'
+require 'puree/extractor/person'
+require 'puree/extractor/project'
+require 'puree/extractor/publication'
+require 'puree/extractor/publisher'
+require 'puree/extractor/collection'
+require 'puree/extractor/download'
+require 'puree/extractor/server'
+
+# Metadata extraction from the Pure Research Information System.
+#
+module Puree
 
 end

data/lib/puree/api/api.rb

@@ -0,0 +1,9 @@
+module Puree
+
+  # Pure-specific details concerning requests and responses.
+  #
+  module API
+
+  end
+
+end

data/lib/puree/api/authentication.rb

@@ -0,0 +1,33 @@
+module Puree
+
+  module API
+
+    # Mixin to configure authentication.
+    #
+    module Authentication
+
+      private
+
+      # Configure a Pure host for API access.
+      #
+      # @param config [Hash]
+      # @option config [String] :url The URL of the Pure host.
+      # @option config [String] :username The username of the Pure host account.
+      # @option config [String] :password The password of the Pure host account.
+      def configure_api(config)
+        @config = Puree::API::Configuration.new url: config[:url]
+        @config.basic_auth username: config[:username],
+                           password: config[:password]
+
+        @request = Puree::API::Request.new url: @config.url
+        if @config.basic_auth?
+          @request.basic_auth username: @config.username,
+                              password: @config.password
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/api/configuration.rb

@@ -0,0 +1,43 @@
+module Puree
+
+  module API
+
+    # Configuration for Pure host and credentials.
+    #
+    class Configuration
+
+      # @return [String]
+      attr_reader :url
+
+      # @return [String, nil]
+      attr_reader :username
+
+      # @return [String, nil]
+      attr_reader :password
+
+      def initialize(url:)
+        raise 'Missing URL in configuration' if !url
+        @url = url
+      end
+
+      # Provide Basic Authentication credentials if required
+      #
+      # @param username [String]
+      # @param password [String]
+      def basic_auth(username:, password:)
+        @username = username
+        @password = password
+        msg = 'Credentials incomplete in configuration'
+        raise msg if username && !password
+        raise msg if password && !username
+      end
+
+      def basic_auth?
+        @username && @password
+      end
+
+    end
+
+  end
+
+end

data/lib/puree/api/map.rb

@@ -0,0 +1,76 @@
+module Puree
+
+  module API
+
+    # Pure endpoints and corresponding XML root element in response.
+    #
+    class Map
+
+      def initialize
+        @convention = %w(
+          event
+          journal
+          organisation
+          person
+          project
+          publication
+          publisher
+        )
+
+        @api_map = {
+          resource_type: {
+            dataset: {
+              service: 'datasets',
+              response: 'GetDataSetsResponse',
+              family: 'dk.atira.pure.modules.datasets.external.model.dataset.DataSet'
+            },
+            download: {
+              service: 'downloadcount',
+              response: 'GetDownloadCountResponse'
+            },
+            server: {
+              service: 'servermeta',
+              response: 'GetServerMetaResponse'
+            }
+          }
+        }
+
+        add_convention
+        # add_family
+      end
+
+      # Gets endpoints with their corresponding XML response names.
+      #
+      # @return [Hash]
+      def get
+        @api_map
+      end
+
+      # Endpoint for resource type.
+      #
+      # @param resource_type [Symbol]
+      # @return [String, nil]
+      def service_name(resource_type)
+        @api_map[:resource_type][resource_type][:service]
+      end
+
+      private
+
+      def add_convention
+        @convention.each do |c|
+          resource_type = {}
+          resource_type[:service] = c
+          resource_type[:response] = 'Get' + c.capitalize + 'Response'
+          @api_map[:resource_type][c.to_sym] = resource_type
+        end
+      end
+
+      # def add_family
+      #   @api_map[:resource_type][:event][:family] = 'dk.atira.pure.api.shared.model.event.Event'
+      # end
+
+    end
+
+  end
+
+end