puree 0.20.0 → 1.0.0

data/lib/puree/publication.rb

@@ -1,258 +0,0 @@
-module Puree
-
-  # Publication resource
-  #
-  class Publication < Resource
-
-    # @param base_url [String]
-    # @param username [String]
-    # @param password [String]
-    # @param basic_auth [Boolean]
-    def initialize(base_url: nil, username: nil, password: nil, basic_auth: nil)
-      super(api: :publication,
-            base_url: base_url,
-            username: username,
-            password: password,
-            basic_auth: basic_auth)
-    end
-
-    # Category
-    #
-    # @return [String]
-    def category
-      @metadata['category']
-    end
-
-    # Description
-    #
-    # @return [String]
-    def description
-      @metadata['description']
-    end
-
-    # Event
-    #
-    # @return [Hash]
-    def event
-      @metadata['event']
-    end
-
-    # Digital Object Identifier
-    #
-    # @return [String]
-    def doi
-      @metadata['doi']
-    end
-
-    # Supporting file
-    #
-    # @return [Array<Hash>]
-    def file
-      @metadata['file']
-    end
-
-    # Organisation
-    #
-    # @return [Array<Hash>]
-    def organisation
-      @metadata['organisation']
-    end
-
-    # Page
-    #
-    # @return [String]
-    def page
-      @metadata['page']
-    end
-
-    # Person (internal, external, other)
-    #
-    # @return [Hash<Array,Array,Array>]
-    def person
-      @metadata['person']
-    end
-
-    # Status
-    #
-    # @return [Array<Hash>]
-    def status
-      @metadata['status']
-    end
-
-    # Title
-    #
-    # @return [String]
-    def title
-      @metadata['title']
-    end
-
-    # Subtitle
-    #
-    # @return [String]
-    def subtitle
-      @metadata['subtitle']
-    end
-
-    # Type
-    #
-    # @return [String]
-    def type
-      @metadata['type']
-    end
-
-    # All metadata
-    #
-    # @return [Hash]
-    def metadata
-      @metadata
-    end
-
-
-    private
-
-    def extract_category
-      path = '/publicationCategory/publicationCategory/term/localizedString'
-      xpath_query_for_single_value path
-    end
-
-    def extract_description
-      path = '/abstract/localizedString'
-      xpath_query_for_single_value path
-    end
-
-    def extract_event
-      path = '/event'
-      xpath_result = xpath_query path
-      o = {}
-      o['uuid'] = xpath_result.xpath('@uuid').text.strip
-      o['title'] = xpath_result.xpath('title/localizedString').text.strip
-      o
-    end
-
-    def extract_doi
-      path = '//doi'
-      xpath_query_for_single_value path
-    end
-
-    def extract_file
-      path = '/electronicVersionAssociations/electronicVersionFileAssociations/electronicVersionFileAssociation/file'
-      xpath_result = xpath_query path
-      docs = []
-      xpath_result.each do |d|
-        doc = {}
-        # doc['id'] = d.xpath('id').text
-        doc['name'] = d.xpath('fileName').text.strip
-        doc['mime'] = d.xpath('mimeType').text.strip
-        doc['size'] = d.xpath('size').text.strip
-        doc['url'] = d.xpath('url').text.strip
-        docs << doc
-      end
-      docs.uniq
-    end
-
-    def extract_organisation
-      path = '/organisations/association/organisation'
-      xpath_result = xpath_query path
-      data = []
-      xpath_result.each do |i|
-        o = {}
-        o['uuid'] = i.xpath('@uuid').text.strip
-        o['name'] = i.xpath('name/localizedString').text.strip
-        o['type'] = i.xpath('typeClassification/term/localizedString').text.strip
-        data << o
-      end
-      data
-    end
-
-    def extract_page
-      path = '/numberOfPages'
-      xpath_query_for_single_value path
-    end
-
-    def extract_person
-      data = {}
-      path = '/persons/personAssociation'
-      xpath_result = xpath_query path
-      internal = []
-      external = []
-      other = []
-
-      xpath_result.each do |i|
-        o = {}
-        name = {}
-        name['first'] = i.xpath('name/firstName').text.strip
-        name['last'] = i.xpath('name/lastName').text.strip
-        o['name'] = name
-        o['role'] = 'Author'
-
-        uuid_internal = i.at_xpath('person/@uuid')
-        uuid_external = i.at_xpath('externalPerson/@uuid')
-        if uuid_internal
-          o['uuid'] = uuid_internal.text.strip
-          internal << o
-        elsif uuid_external
-          o['uuid'] = uuid_external.text.strip
-          external << o
-        else
-          other << o
-          o['uuid'] = ''
-        end
-      end
-      data['internal'] = internal
-      data['external'] = external
-      data['other'] = other
-      data
-    end
-
-    def extract_status
-      path = '/publicationStatuses/publicationStatus'
-      xpath_result = xpath_query path
-      data = []
-      xpath_result.each do |i|
-        o = {}
-        o['stage'] = i.xpath('publicationStatus/term/localizedString').text.strip
-        ymd = {}
-        ymd['year'] = i.xpath('publicationDate/year').text.strip
-        ymd['month'] = i.xpath('publicationDate/month').text.strip
-        ymd['day'] = i.xpath('publicationDate/day').text.strip
-        o['date'] = Puree::Date.normalise(ymd)
-        data << o
-      end
-      data
-    end
-
-    def extract_title
-      path = '/title'
-      xpath_query_for_single_value path
-    end
-
-    def extract_subtitle
-      path = '/subtitle'
-      xpath_query_for_single_value path
-    end
-
-    def extract_type
-      path = '/typeClassification/term/localizedString'
-      xpath_query_for_single_value path
-    end
-
-    def combine_metadata
-      o = super
-      o['category'] = extract_category
-      o['description'] = extract_description
-      o['doi'] = extract_doi
-      o['event'] = extract_event
-      o['file'] = extract_file
-      o['organisation'] = extract_organisation
-      o['page'] = extract_page
-      o['person'] = extract_person
-      o['status'] = extract_status
-      o['subtitle'] = extract_subtitle
-      o['title'] = extract_title
-      o['type'] = extract_type
-      @metadata = o
-    end
-
-  end
-
-end

data/lib/puree/publisher.rb

@@ -1,64 +0,0 @@
-module Puree
-
-  # Publisher resource
-  #
-  class Publisher < Resource
-
-    # @param base_url [String]
-    # @param username [String]
-    # @param password [String]
-    # @param basic_auth [Boolean]
-    def initialize(base_url: nil, username: nil, password: nil, basic_auth: nil)
-      super(api: :publisher,
-            base_url: base_url,
-            username: username,
-            password: password,
-            basic_auth: basic_auth)
-    end
-
-    # Name
-    #
-    # @return [String]
-    def name
-      @metadata['name']
-    end
-
-    # Adds no value as value is Publisher
-    # Type
-    #
-    # @return [String]
-    # def type
-    #   @metadata['type']
-    # end
-
-    # All metadata
-    #
-    # @return [Hash]
-    def metadata
-      @metadata
-    end
-
-
-    private
-
-    def extract_name
-      path = '/name'
-      xpath_query_for_single_value path
-    end
-
-    # Adds no value as value is Publisher
-    # def extract_type
-    #   path = '/typeClassification/term/localizedString'
-    #   xpath_query_for_single_value path
-    # end
-
-    def combine_metadata
-      o = super
-      o['name'] = extract_name
-      # o['type'] = extract_type
-      @metadata = o
-    end
-
-  end
-
-end

data/lib/puree/resource.rb

@@ -1,261 +0,0 @@
-module Puree
-
-  # Abstract base class for resources.
-  #
-  class Resource
-
-    attr_reader :response
-
-    # @param api [Symbol]
-    # @param base_url [String]
-    # @param username [String]
-    # @param password [String]
-    # @param bleeding [Boolean]
-    # @param basic_auth [Boolean]
-    def initialize( api: nil,
-                    base_url: nil,
-                    username: nil,
-                    password: nil,
-                    bleeding: true,
-                    basic_auth: nil)
-      @resource_type = api
-      @api_map = Puree::Map.new.get
-      @base_url = base_url.nil? ? Puree.base_url : base_url
-      @latest_api = bleeding
-      @basic_auth = basic_auth.nil? ? Puree.basic_auth : basic_auth
-      if @basic_auth === true
-        @username = username.nil? ? Puree.username : username
-        @password = password.nil? ? Puree.password : password
-      end
-      @metadata = {}
-      @options = {
-          basic_auth:     @basic_auth,
-          latest_api:     @latest_api,
-          resource_type:  @resource_type.to_sym
-      }
-    end
-
-    # Get
-    #
-    # @param uuid [String]
-    # @param id [String]
-    # @return [Hash]
-    def get(uuid: nil, id: nil, rendering: :xml_long)
-      reset
-
-      @options[:rendering] = rendering
-      @options[:uuid] = uuid
-      @options[:id] = id
-
-      missing = missing_credentials
-      if !missing.empty?
-        missing.each do |m|
-          puts "#{self.class.name}" + '#' + "#{__method__} missing #{m}"
-        end
-        exit
-      end
-
-      # strip any trailing slash
-      @base_url = @base_url.sub(/(\/)+$/, '')
-
-      headers = {}
-      headers['Accept'] = 'application/xml'
-
-      if @options[:basic_auth] === true
-        @auth = Base64::strict_encode64(@username + ':' + @password)
-        headers['Authorization'] = 'Basic ' + @auth
-      end
-
-      query = {}
-      query['rendering'] = @options[:rendering]
-
-      if @options[:uuid]
-        query['uuids.uuid'] = @options[:uuid]
-      else
-        if @options[:id]
-          query['pureInternalIds.id'] = @options[:id]
-        end
-      end
-
-      if @options[:rendering]
-        query['rendering'] = @options[:rendering]
-      end
-
-      begin
-        url = build_url
-        req = HTTP.headers accept: headers['Accept']
-        if @options[:basic_auth]
-          req = req.auth headers['Authorization']
-        end
-        @response = req.get(url, params: query)
-        make_doc @response.body
-
-      rescue HTTP::Error => e
-        puts 'HTTP::Error '+ e.message
-      end
-
-      get_data? ? combine_metadata : {}
-
-    end
-
-    # UUID
-    #
-    # @return [String]
-    def uuid
-      @metadata['uuid']
-    end
-
-    # Created (UTC datetime)
-    #
-    # @return [String]
-    def created
-      @metadata['created']
-    end
-
-    # Modified (UTC datetime)
-    #
-    # @return [String]
-    def modified
-      @metadata['modified']
-    end
-
-    # Locale (e.g. en-GB)
-    #
-    # @return [String]
-    def locale
-      @metadata['locale']
-    end
-
-    # Set content from XML. In order for metadata extraction to work, the XML must have
-    # been retrieved using the .current version of the Pure API endpoints
-    #
-    # @param xml [String]
-    def set_content(xml)
-      if xml
-        make_doc xml
-        if get_data?
-          combine_metadata
-        end
-      end
-    end
-
-    private
-
-    def make_doc(xml)
-      @doc = Nokogiri::XML xml
-      @doc.remove_namespaces!
-    end
-
-    def extract_created
-      path = '/created'
-      xpath_query_for_single_value path
-    end
-
-    def extract_modified
-      path = '/modified'
-      xpath_query_for_single_value path
-    end
-
-    def extract_uuid
-      path = '/@uuid'
-      xpath_query_for_single_value path
-    end
-
-    def extract_locale
-      path = '/@locale'
-      str = xpath_query_for_single_value path
-      str.gsub('_','-')
-    end
-
-    # All metadata
-    #
-    # @return [Hash]
-    def combine_metadata
-      o = {}
-      o['uuid'] = extract_uuid
-      o['created'] = extract_created
-      o['modified'] = extract_modified
-      o['locale'] = extract_locale
-      o
-    end
-
-    # Is there any data after get? For a response that provides a count of the results.
-    #
-    # @return [Boolean]
-    def get_data?
-      path = service_xpath_count
-      xpath_result = @doc.xpath path
-      xpath_result.text.strip === '1' ? true : false
-    end
-
-    def service_name
-      resource_type = @options[:resource_type]
-      @api_map[:resource_type][resource_type][:service]
-    end
-
-    def service_response_name
-      resource_type = @options[:resource_type]
-      @api_map[:resource_type][resource_type][:response]
-    end
-
-    def service_xpath_base
-      service_response_name + '/result/content'
-    end
-
-    def service_xpath_count
-      service_response_name + '/count'
-    end
-
-    def service_xpath(str_to_find)
-      service_xpath_base + str_to_find
-    end
-
-    def build_url
-      service = service_name
-      if @options[:latest_api] === false
-        service_api_mode = service
-      else
-        service_api_mode = service + '.current'
-      end
-      @base_url + '/' + service_api_mode
-    end
-
-    # content based
-    def xpath_query(path)
-      path_from_root = service_xpath path
-      @doc.xpath path_from_root
-    end
-
-    def xpath_query_for_single_value(path)
-      xpath_result = xpath_query path
-      xpath_result ? xpath_result.text.strip : ''
-    end
-
-
-    def missing_credentials
-      missing = []
-      if @base_url.nil?
-        missing << 'base_url'
-      end
-
-      if @options[:basic_auth] === true
-        if @username.nil?
-          missing << 'username'
-        end
-        if @password.nil?
-          missing << 'password'
-        end
-      end
-
-      missing
-    end
-
-    def reset
-      @response = nil
-    end
-
-    alias :find :get
-
-
-  end
-end