puree 0.15.0 → 0.16.0

data/lib/puree/download.rb

@@ -5,17 +5,17 @@ module Puree
   class Download
     attr_reader :response
 
-    # @param endpoint [String]
-    # @param optional username [String]
-    # @param optional password [String]
-    # @param optional basic_auth [Boolean]
-    def initialize(endpoint: nil,
+    # @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
-      @endpoint = endpoint.nil? ? Puree.endpoint : endpoint
+      @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
@@ -25,9 +25,9 @@ module Puree
 
     # Get
     #
-    # @param optional limit [Integer]
-    # @param optional offset [Integer]
-    # @param optional resource [Symbol]
+    # @param limit [Integer]
+    # @param offset [Integer]
+    # @param resource [Symbol]
     # @return [Array<Hash>]
     def get(limit: 20,
             offset: 0,
@@ -41,7 +41,7 @@ module Puree
       end
 
       # strip any trailing slash
-      @endpoint = @endpoint.sub(/(\/)+$/, '')
+      @base_url = @base_url.sub(/(\/)+$/, '')
       @auth = Base64::strict_encode64(@username + ':' + @password)
 
       @options = {
@@ -85,7 +85,7 @@ module Puree
         puts 'HTTP::Error '+ e.message
       end
 
-      get_data? ? metadata : []
+      get_data? ? combine_metadata : []
     end
 
 
@@ -95,12 +95,17 @@ module Puree
     #
     # @return [Array<Hash>]
     def metadata
-      statistic
+      @metadata
     end
 
 
     private
 
+
+    def combine_metadata
+      @metadata = extract_statistic
+    end
+
     # Is there any data after get?
     #
     # @return [Boolean]
@@ -114,7 +119,7 @@ module Puree
     # Statistic
     #
     # @return [Array<Hash>]
-    def statistic
+    def extract_statistic
       path = service_response_name + '/downloadCount'
       xpath_result =  xpath_query path
       data_arr = []
@@ -154,7 +159,7 @@ module Puree
       else
         service_api_mode = service + '.current'
       end
-      @endpoint + '/' + service_api_mode
+      @base_url + '/' + service_api_mode
     end
 
     def xpath_query(path)
@@ -166,8 +171,8 @@ module Puree
 
     def missing_credentials
       missing = []
-      if @endpoint.nil?
-        missing << 'endpoint'
+      if @base_url.nil?
+        missing << 'base_url'
       end
       if @username.nil?
         missing << 'username'

data/lib/puree/event.rb

@@ -4,94 +4,128 @@ module Puree
   #
   class Event < Resource
 
-    # @param endpoint [String]
-    # @param optional username [String]
-    # @param optional password [String]
-    # @param optional basic_auth [Boolean]
-    def initialize(endpoint: nil, username: nil, password: nil, basic_auth: nil)
+    # @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,
-            endpoint: endpoint,
+            base_url: base_url,
             username: username,
             password: password,
             basic_auth: basic_auth)
     end
 
 
-
-
     # City
     #
     # @return [String]
     def city
-      path = '/city'
-      xpath_query(path).text.strip
+      @metadata['city']
     end
 
     # Country
     #
     # @return [String]
     def country
-      path = '/country/term/localizedString'
-      xpath_query(path).text.strip
+      @metadata['country']
     end
 
     # Date
     #
     # @return [Hash]
     def date
-      data = {}
-      path = '/dateRange'
-      range = xpath_query path
-      data['start'] = range.xpath('startDate').text.strip
-      data['end'] = range.xpath('startDate').text.strip
-      data
+      @metadata['date']
     end
 
     # Description
     #
     # @return [String]
     def description
-      path = '/description'
-      xpath_query(path).text.strip
+      @metadata['description']
     end
 
     # Location
     #
     # @return [String]
     def location
-      path = '/location'
-      xpath_query(path).text.strip
+      @metadata['location']
     end
 
     # Title
     #
     # @return [String]
     def title
-      path = '/title/localizedString'
-      xpath_query_for_single_value path
+      @metadata['title']
     end
 
     # Type
     #
     # @return [String]
     def type
-      path = '//typeClassification/term/localizedString'
-      xpath_query_for_single_value path
+      @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'] = city
-      o['country'] = country
-      o['date'] = date
-      o['description'] = description
-      o['location'] = location
-      o['title'] = title
-      o['type'] = type
-      o
+      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

data/lib/puree/journal.rb

@@ -4,13 +4,13 @@ module Puree
   #
   class Journal < Resource
 
-    # @param endpoint [String]
-    # @param optional username [String]
-    # @param optional password [String]
-    # @param optional basic_auth [Boolean]
-    def initialize(endpoint: nil, username: nil, password: nil, basic_auth: nil)
+    # @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,
-            endpoint: endpoint,
+            base_url: base_url,
             username: username,
             password: password,
             basic_auth: basic_auth)
@@ -21,7 +21,15 @@ module Puree
     #
     # @return [Hash]
     def metadata
-      super
+      @metadata
+    end
+
+
+    private
+
+    def combine_metadata
+      o = super
+      @metadata = o
     end
 
   end

data/lib/puree/organisation.rb

@@ -4,123 +4,116 @@ module Puree
   #
   class Organisation < Resource
 
-    # @param endpoint [String]
-    # @param optional username [String]
-    # @param optional password [String]
-    # @param optional basic_auth [Boolean]
-    def initialize(endpoint: nil, username: nil, password: nil, basic_auth: nil)
+    # @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: :organisation,
-            endpoint: endpoint,
+            base_url: base_url,
             username: username,
             password: password,
             basic_auth: basic_auth)
     end
 
-
-
     # Address
     #
     # @return [Array<Hash>]
     def address
-      path = '/addresses/classifiedAddress'
-      xpath_result = xpath_query path
-
-      data = []
-
-      xpath_result.each do |d|
-        o = {}
-        o['street'] = d.xpath('street').text.strip
-        o['building'] = d.xpath('building').text.strip
-        o['postcode'] = d.xpath('postalCode').text.strip
-        o['city'] = d.xpath('city').text.strip
-        o['country'] = d.xpath('country/term/localizedString').text.strip
-        data << o
-      end
-      data.uniq
+      @metadata['address']
     end
 
     # Email
     #
     # @return [Array<String>]
     def email
-      path = '/emails/classificationDefinedStringFieldExtension/value'
-      xpath_result =  xpath_query path
-      arr = []
-      xpath_result.each { |i| arr << i.text.strip }
-      arr.uniq
+      @metadata['email']
     end
 
     # Name
     #
     # @return [String]
     def name
-      path = '/name/localizedString'
-      xpath_query_for_single_value path
+      @metadata['name']
+    end
+
+    # Organisation
+    #
+    # @return [Array<Hash>]
+    def organisation
+      @metadata['organisation']
     end
 
     # Parent
     #
     # @return [Hash]
     def parent
-      data = organisation
-      o = {}
-      if !data.empty?
-        o = data.first
-      end
-      o
+      @metadata['parent']
     end
 
     # Phone
     #
     # @return [Array<String>]
     def phone
-      path = '/phoneNumbers/classificationDefinedStringFieldExtension/value'
-      xpath_result =  xpath_query path
-      arr = []
-      xpath_result.each { |i| arr << i.text.strip }
-      arr.uniq
+      @metadata['phone']
     end
 
     # Type
     #
     # @return [String]
     def type
-      path = '/typeClassification/term/localizedString'
-      xpath_query_for_single_value path
+      @metadata['type']
     end
 
     # URL
     #
     # @return [Array<String>]
     def url
-      path = '/webAddresses/classificationDefinedFieldExtension/value/localizedString'
-      xpath_result = xpath_query path
-      arr = []
-      xpath_result.each { |i| arr << i.text.strip }
-      arr.uniq
+      @metadata['url']
     end
 
     # All metadata
     #
     # @return [Hash]
     def metadata
-      o = super
-      o['address'] = address
-      o['email'] = email
-      o['name'] = name
-      o['parent'] = parent
-      o['phone'] = phone
-      o['type'] = type
-      o['url'] = url
-      o
+      @metadata
     end
 
 
+    private
 
-    # Organisation
-    #
-    # @return [Array<Hash>]
-    def organisation
+    def extract_address
+      path = '/addresses/classifiedAddress'
+      xpath_result = xpath_query path
+
+      data = []
+
+      xpath_result.each do |d|
+        o = {}
+        o['street'] = d.xpath('street').text.strip
+        o['building'] = d.xpath('building').text.strip
+        o['postcode'] = d.xpath('postalCode').text.strip
+        o['city'] = d.xpath('city').text.strip
+        o['country'] = d.xpath('country/term/localizedString').text.strip
+        data << o
+      end
+      data.uniq
+    end
+
+    def extract_email
+      path = '/emails/classificationDefinedStringFieldExtension/value'
+      xpath_result =  xpath_query path
+      arr = []
+      xpath_result.each { |i| arr << i.text.strip }
+      arr.uniq
+    end
+
+    def extract_name
+      path = '/name/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    def extract_organisation
       path = '/organisations/organisation'
       xpath_result =  xpath_query path
 
@@ -136,6 +129,47 @@ module Puree
       data.uniq
     end
 
+    def extract_parent
+      data = extract_organisation
+      o = {}
+      if !data.empty?
+        o = data.first
+      end
+      o
+    end
+
+    def extract_phone
+      path = '/phoneNumbers/classificationDefinedStringFieldExtension/value'
+      xpath_result =  xpath_query path
+      arr = []
+      xpath_result.each { |i| arr << i.text.strip }
+      arr.uniq
+    end
+
+    def extract_type
+      path = '/typeClassification/term/localizedString'
+      xpath_query_for_single_value path
+    end
+
+    def extract_url
+      path = '/webAddresses/classificationDefinedFieldExtension/value/localizedString'
+      xpath_result = xpath_query path
+      arr = []
+      xpath_result.each { |i| arr << i.text.strip }
+      arr.uniq
+    end
+
+    def combine_metadata
+      o = super
+      o['address'] = extract_address
+      o['email'] = extract_email
+      o['name'] = extract_name
+      o['parent'] = extract_parent
+      o['phone'] = extract_phone
+      o['type'] = extract_type
+      o['url'] = extract_url
+      @metadata = o
+    end
 
   end