puree 0.20.0 → 1.0.0

data/lib/puree/date.rb

@@ -1,63 +0,0 @@
-module Puree
-
-  # Date utilities
-  #
-  module Date
-
-    # Converts a date with three components (year, month, day) to ISO 8601 date format
-    #
-    # @param data [Hash]
-    # @return [String]
-    def self.iso(data)
-      iso_date = ''
-      year =  data['year']
-      month = data['month']
-      day = data['day']
-      if !year.empty?
-        iso_date << year
-      else
-        iso_date
-      end
-      if !month.empty?
-        # Add leading zero to convert to ISO 8601 date component
-        if month.length < 2
-          month.insert(0, '0')
-        end
-        iso_date << '-' + month
-      else
-        iso_date
-      end
-      if !day.empty?
-        # Add leading zero to convert to ISO 8601 date component
-        if day.length < 2
-          day.insert(0, '0')
-        end
-        iso_date << '-' + day
-      end
-      iso_date
-    end
-
-    private
-
-    # Forces a date to have three components (year, month, day)
-    #
-    # @param data [Hash]
-    # @return [Hash]
-    def self.normalise(data)
-      if !data.nil? && !data.empty?
-        date = {}
-        year =  data['year']
-        month = data['month']
-        day = data['day']
-        date['year'] = year ? year : ''
-        date['month'] = month ? month : ''
-        date['day'] = day ? day : ''
-        date
-      else
-        {}
-      end
-    end
-
-  end
-
-end

data/lib/puree/download.rb

@@ -1,189 +0,0 @@
-module Puree
-
-  # Download
-  #
-  class Download
-    attr_reader :response
-
-    # @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)
-      @resource_type = :download
-      @api_map = Puree::Map.new.get
-      @base_url = base_url.nil? ? Puree.base_url : base_url
-      @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
-    end
-
-    # Get
-    #
-    # @param limit [Integer]
-    # @param offset [Integer]
-    # @param resource [Symbol]
-    # @return [Array<Hash>]
-    def get(limit: 20,
-            offset: 0,
-            resource: nil)
-      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(/(\/)+$/, '')
-      @auth = Base64::strict_encode64(@username + ':' + @password)
-
-      @options = {
-          basic_auth:     @basic_auth,
-          latest_api:     true,
-          resource_type:  @resource_type.to_sym,
-          rendering:      :system,
-          limit:          limit,
-          offset:         offset,
-          resource:       resource.to_sym
-      }
-      headers = {
-          'Accept' => 'application/xml',
-          'Authorization' => 'Basic ' + @auth
-      }
-      query = {}
-      query['rendering'] = @options[:rendering]
-
-      if @options[:limit]
-        query['window.size'] = @options[:limit]
-      end
-
-      if @options[:offset]
-        query['window.offset'] = @options[:offset]
-      end
-
-      if @options[:resource]
-        query['contentType'] = service_family
-      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)
-        @doc = Nokogiri::XML @response.body
-        @doc.remove_namespaces!
-      rescue HTTP::Error => e
-        puts 'HTTP::Error '+ e.message
-      end
-
-      get_data? ? combine_metadata : []
-    end
-
-
-
-
-    # All metadata
-    #
-    # @return [Array<Hash>]
-    def metadata
-      @metadata
-    end
-
-
-    private
-
-
-    def combine_metadata
-      @metadata = extract_statistic
-    end
-
-    # Is there any data after get?
-    #
-    # @return [Boolean]
-    def get_data?
-      # n.b. arbitrary element existence check
-      path = service_response_name + '/downloadCount'
-      xpath_result = @doc.xpath path
-      xpath_result.size ? true : false
-    end
-
-    # Statistic
-    #
-    # @return [Array<Hash>]
-    def extract_statistic
-      path = service_response_name + '/downloadCount'
-      xpath_result =  xpath_query path
-      data_arr = []
-      xpath_result.each { |i|
-        data = {}
-        data['uuid'] = i.attr('uuid').strip
-        data['download'] = i.attr('downloads').strip
-        data_arr << data
-      }
-      data_arr.uniq
-    end
-
-    def service_family
-      resource_type = @options[:resource]
-      if @api_map[:resource_type].has_key? resource_type
-        @api_map[:resource_type][resource_type][:family]
-      else
-        puts "#{resource_type} is an unrecognised resource type"
-        exit
-      end
-    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 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
-
-    def xpath_query(path)
-      xml = @response.body
-      doc = Nokogiri::XML xml
-      doc.remove_namespaces!
-      doc.xpath path
-    end
-
-    def missing_credentials
-      missing = []
-      if @base_url.nil?
-        missing << 'base_url'
-      end
-      if @username.nil?
-        missing << 'username'
-      end
-      if @password.nil?
-        missing << 'password'
-      end
-      missing
-    end
-
-    alias :find :get
-
-  end
-end

data/lib/puree/event.rb

@@ -1,133 +0,0 @@
-module Puree
-
-  # Event resource
-  #
-  class Event < 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: :event,
-            base_url: base_url,
-            username: username,
-            password: password,
-            basic_auth: basic_auth)
-    end
-
-
-    # City
-    #
-    # @return [String]
-    def city
-      @metadata['city']
-    end
-
-    # Country
-    #
-    # @return [String]
-    def country
-      @metadata['country']
-    end
-
-    # Date
-    #
-    # @return [Hash]
-    def date
-      @metadata['date']
-    end
-
-    # Description
-    #
-    # @return [String]
-    def description
-      @metadata['description']
-    end
-
-    # Location
-    #
-    # @return [String]
-    def location
-      @metadata['location']
-    end
-
-    # Title
-    #
-    # @return [String]
-    def title
-      @metadata['title']
-    end
-
-    # Type
-    #
-    # @return [String]
-    def type
-      @metadata['type']
-    end
-
-    # All metadata
-    #
-    # @return [Hash]
-    def metadata
-      @metadata
-    end
-
-
-
-    private
-
-    def extract_city
-      path = '/city'
-      xpath_query(path).text.strip
-    end
-
-    def extract_country
-      path = '/country/term/localizedString'
-      xpath_query(path).text.strip
-    end
-
-    def extract_date
-      data = {}
-      path = '/dateRange'
-      range = xpath_query path
-      data['start'] = range.xpath('startDate').text.strip
-      data['end'] = range.xpath('startDate').text.strip
-      data
-    end
-
-    def extract_description
-      path = '/description'
-      xpath_query(path).text.strip
-    end
-
-    def extract_location
-      path = '/location'
-      xpath_query(path).text.strip
-    end
-
-    def extract_title
-      path = '/title/localizedString'
-      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['city'] = extract_city
-      o['country'] = extract_country
-      o['date'] = extract_date
-      o['description'] = extract_description
-      o['location'] = extract_location
-      o['title'] = extract_title
-      o['type'] = extract_type
-      @metadata = o
-    end
-
-  end
-
-end

data/lib/puree/journal.rb

@@ -1,75 +0,0 @@
-module Puree
-
-  # Journal resource
-  #
-  class Journal < 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: :journal,
-            base_url: base_url,
-            username: username,
-            password: password,
-            basic_auth: basic_auth)
-    end
-
-    # ISSN
-    #
-    # @return [String]
-    def issn
-      @metadata['issn']
-    end
-
-    # Publisher
-    #
-    # @return [String]
-    def publisher
-      @metadata['publisher']
-    end
-
-    # Title
-    #
-    # @return [String]
-    def title
-      @metadata['title']
-    end
-
-    # All metadata
-    #
-    # @return [Hash]
-    def metadata
-      @metadata
-    end
-
-
-    private
-
-    def extract_issn
-      path = '/issns/issn/string'
-      xpath_query_for_single_value path
-    end
-
-    def extract_publisher
-      path = '/publisher/name'
-      xpath_query_for_single_value path
-    end
-
-    def extract_title
-      path = '/titles/title/string'
-      xpath_query_for_single_value path
-    end
-
-    def combine_metadata
-      o = super
-      o['issn'] = extract_issn
-      o['publisher'] = extract_publisher
-      o['title'] = extract_title
-      @metadata = o
-    end
-
-  end
-
-end