metrojobb 0.1.0

data/feed-example.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<ads>
+  <ad orderno="">
+    <externalApplication></externalApplication>
+    <heading></heading>
+    <jobTitle></jobTitle>
+    <summary></summary>
+    <description></description>
+    <location>
+      <city></city>
+    </location>
+    <contact>
+      <name></name>
+      <phone></phone>
+      <email></email>
+    </contact>
+    <category>
+      <name></name>
+    </category>
+    <employmentType>
+      <name></name>
+    </employmentType>
+    <employer></employer>
+    <employerHomePage></employerHomePage>
+    <opportunities></opportunities>
+    <region>
+      <name></name>
+    </region>
+    <fromdate></fromdate>
+    <todate></todate>
+    <externalLogoUrl></externalLogoUrl>
+    <applicationURL></applicationURL>
+  </ad>
+</ads>

data/feed-gem-default.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<ads>
+  <ad orderno=""><!-- ordno Required attribute -->
+    <externalApplication>true</externalApplication>
+    <heading></heading><!-- Required -->
+    <jobTitle></jobTitle><!-- Required -->
+    <summary></summary><!-- Required -->
+    <description></description><!-- Required -->
+    <location>
+      <city></city>
+    </location><!-- Required locationType -->
+    <contact>
+      <name></name>
+      <phone></phone>
+      <email></email>
+    </contact><!-- contactType (not required) -->
+    <category>
+      <name></name>
+    </category><!-- Required idOrTextAttributeType -->
+    <employmentType>
+      <name></name>
+    </employmentType>
+    <employer></employer>
+    <employerHomePage></employerHomePage>
+    <opportunities></opportunities>
+    <region>
+      <name></name>
+    </region>
+    <fromdate></fromdate>
+    <todate></todate>
+    <externalLogoUrl></externalLogoUrl>
+    <applicationURL></applicationURL><!-- Required -->
+  </ad>
+</ads>

data/feed-schema.xsd

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <!-- Schema used when importing job ads to the Metro Job site. -->
+  <xs:element name="ads">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element ref="ad" maxOccurs="unbounded"/>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+  <xs:element name="ad">
+    <xs:complexType>
+      <xs:all>
+        <xs:element name="externalApplication" type="xs:boolean" minOccurs="0"/>
+        <xs:element name="heading" type="xs:string" minOccurs="1"/>
+        <xs:element name="jobTitle" type="xs:string" minOccurs="1"/>
+        <xs:element name="summary" type="xs:string"/>
+        <xs:element name="description" type="xs:string" minOccurs="1"/>
+        <xs:element name="location" type="locationType"/>
+        <xs:element name="contact" type="contactType" minOccurs="0"/>
+        <xs:element name="category" type="idOrTextAttributeType"/>
+        <xs:element name="employmentType" type="idOrTextAttributeType"/>
+        <xs:element name="employer" type="xs:string" minOccurs="0"/>
+        <xs:element name="employerHomePage" type="xs:string"/>
+        <xs:element name="opportunities" type="xs:int" minOccurs="0"/>
+        <xs:element name="region" type="idOrTextAttributeType"/>
+        <xs:element name="fromdate" type="xs:string"/>
+        <xs:element name="todate" type="xs:string" minOccurs="0"/>
+        <xs:element name="logoFileName" type="xs:string" minOccurs="0"/>
+        <xs:element name="externalLogoUrl" type="xs:string" minOccurs="0"/>
+        <xs:element name="applicationURL" type="xs:string"/>
+        <xs:element name="videoUrl" type="xs:string" minOccurs="0"/>
+      </xs:all>
+      <xs:attribute name="orderno" type="xs:string" use="required"/>
+    </xs:complexType>
+  </xs:element>
+  <xs:complexType name="idOrTextAttributeType">
+    <xs:all>
+      <xs:element name="id" type="xs:string" minOccurs="0"/>
+      <xs:element name="name" type="xs:string" minOccurs="0"/>
+    </xs:all>
+  </xs:complexType>
+  <xs:complexType name="contactType">
+    <xs:all>
+      <xs:element name="name" minOccurs="0"/>
+      <xs:element name="phone" minOccurs="0"/>
+      <xs:element name="email" minOccurs="0"/>
+    </xs:all>
+  </xs:complexType>
+  <xs:complexType name="locationType">
+    <xs:all>
+      <xs:element name="street" minOccurs="0"/>
+      <xs:element name="postalCode" minOccurs="0"/>
+      <xs:element name="city" minOccurs="0"/>
+    </xs:all>
+  </xs:complexType>
+</xs:schema>

data/lib/metrojobb.rb

@@ -0,0 +1,23 @@
+require 'builder'
+
+require 'metrojobb/version'
+# models
+require 'metrojobb/model'
+require 'metrojobb/ad'
+require 'metrojobb/category'
+require 'metrojobb/contact'
+require 'metrojobb/employment_type'
+require 'metrojobb/location'
+require 'metrojobb/region'
+
+module Metrojobb
+  ORDER_NUMBER = '<<order_number>>'
+
+  def self.build_ad(data, order_number: ORDER_NUMBER)
+    builder = Builder::XmlMarkup.new(indent: 2)
+    builder.ads do |ad_node|
+      ad_node.ad(ordno: order_number)
+      ad_node.ad(ordno: order_number)
+    end
+  end
+end

data/lib/metrojobb/ad.rb

@@ -0,0 +1,150 @@
+require 'date'
+require 'active_model'
+
+module Metrojobb
+  class Ad < Model
+    YYYY_MM_DD_REGEX = /\d{4}-\d{2}-\d{2}/
+
+    INVALID_DATE_FORMAT_MSG = "must be in the following format: YYYY-MM-DD"
+    TYPE_ERROR_MSG = 'unknown type'
+
+    attr_accessor *[
+      :order_number,
+      :external_application,
+      :heading,
+      :job_title,
+      :summary,
+      :description,
+      :employer,
+      :employer_home_page,
+      :opportunities,
+      :from_date,
+      :to_date,
+      :external_logo_url,
+      :application_url,
+      # relations
+      :location,
+      :contact,
+      :employment_type,
+      :category,
+      :region
+    ]
+
+    validates :order_number, presence: true
+    validates :heading, presence: true
+    validates :job_title, presence: true
+    validates :summary, presence: true
+    validates :description, presence: true
+    validates :location, presence: true
+    validates :category, presence: true
+    validates :region, presence: true
+
+    validates_format_of :from_date, with: YYYY_MM_DD_REGEX, message: INVALID_DATE_FORMAT_MSG
+    validates_format_of :to_date, with: YYYY_MM_DD_REGEX, message: INVALID_DATE_FORMAT_MSG
+
+    validate :validate_location_type
+    validate :validate_contact_type
+    validate :validate_employment_type_type
+    validate :validate_category_type
+    validate :validate_region_type
+
+    validate :validate_location_valid
+    validate :validate_contact_valid
+    validate :validate_employment_type_valid
+    validate :validate_category_valid
+    validate :validate_region_valid
+
+    def to_xml(builder: Builder::XmlMarkup.new(indent: 2))
+      builder.ad(orderno: order_number) do |node|
+        node.externalApplication(external_application)
+        node.heading(heading)
+        node.jobTitle(job_title)
+        node.summary(summary)
+        node.description(description)
+        node.employer(employer)
+        node.employerHomePage(employer_home_page)
+        node.opportunities(opportunities)
+        node.fromdate(from_date)
+        node.todate(to_date)
+        node.externalLogoUrl(external_logo_url)
+        node.applicationURL(application_url)
+
+        location.to_xml(builder: node) if location
+        contact.to_xml(builder: node) if contact
+        employment_type.to_xml(builder: node) if employment_type
+        category.to_xml(builder: node) if category
+        region.to_xml(builder: node) if region
+      end
+    end
+
+    def validate_location_type
+     return unless location
+     return if location.is_a?(Location)
+
+     errors.add(:location, TYPE_ERROR_MSG)
+    end
+
+    def validate_contact_type
+     return unless contact
+     return if contact.is_a?(Contact)
+
+     errors.add(:contact, TYPE_ERROR_MSG)
+    end
+
+    def validate_employment_type_type
+     return unless employment_type
+     return if employment_type.is_a?(EmploymentType)
+
+     errors.add(:employment_type, TYPE_ERROR_MSG)
+    end
+
+    def validate_category_type
+     return unless category
+     return if category.is_a?(Category)
+
+     errors.add(:category, TYPE_ERROR_MSG)
+    end
+
+    def validate_region_type
+     return unless region
+     return if region.is_a?(Region)
+
+     errors.add(:region, TYPE_ERROR_MSG)
+    end
+
+    def validate_location_valid
+      return unless location.respond_to?(:valid?)
+      return if location.valid?
+
+      errors.add(:location, :invalid)
+    end
+
+    def validate_contact_valid
+      return unless contact.respond_to?(:valid?)
+      return if contact.valid?
+
+      errors.add(:contact, :invalid)
+    end
+
+    def validate_employment_type_valid
+      return unless employment_type.respond_to?(:valid?)
+      return if employment_type.valid?
+
+      errors.add(:employment_type, :invalid)
+    end
+
+    def validate_category_valid
+      return unless category.respond_to?(:valid?)
+      return if category.valid?
+
+      errors.add(:category, :invalid)
+    end
+
+    def validate_region_valid
+      return unless region.respond_to?(:valid?)
+      return if region.valid?
+
+      errors.add(:region, :invalid)
+    end
+  end
+end

data/lib/metrojobb/category.rb

@@ -0,0 +1,34 @@
+require 'csv'
+require 'active_model'
+
+module Metrojobb
+  class Category < Model
+    attr_accessor :id, :name
+
+    NAME_ID_MAP = CSV.read(
+      File.expand_path('../../../data/categories.csv', __FILE__)
+    ).to_h.invert.freeze
+
+    ID_NAME_MAP = NAME_ID_MAP.invert.freeze
+
+    validate :validate_known_category
+
+    def to_xml(builder: Builder::XmlMarkup.new(indent: 2))
+      builder.category do |node|
+        node.id(category_id)
+      end
+    end
+
+    def category_id
+      NAME_ID_MAP[name.presence || id.presence] ||
+        id.presence ||
+        name.presence
+    end
+
+    def validate_known_category
+      return if ID_NAME_MAP[category_id]
+
+      errors.add(:category_id, :inclusion)
+    end
+  end
+end

data/lib/metrojobb/contact.rb

@@ -0,0 +1,15 @@
+require 'active_model'
+
+module Metrojobb
+  class Contact < Model
+    attr_accessor :name, :phone, :email
+
+    def to_xml(builder: Builder::XmlMarkup.new(indent: 2))
+      builder.contact do |node|
+        node.name(name) if name.present?
+        node.phone(phone) if phone.present?
+        node.email(email) if email.present?
+      end
+    end
+  end
+end

data/lib/metrojobb/employment_type.rb

@@ -0,0 +1,33 @@
+require 'active_model'
+
+module Metrojobb
+  class EmploymentType < Model
+    attr_accessor :id, :name
+
+    NAME_ID_MAP = CSV.read(
+      File.expand_path('../../../data/employmenttypes.csv', __FILE__)
+    ).to_h.invert.freeze
+
+    ID_NAME_MAP = NAME_ID_MAP.invert.freeze
+
+    validate :validate_known_employment_type
+
+    def to_xml(builder: Builder::XmlMarkup.new(indent: 2))
+      builder.employmentType do |node|
+        node.id(metrojobb_id)
+      end
+    end
+
+    def metrojobb_id
+      NAME_ID_MAP[name.presence || id.presence] ||
+        id.presence ||
+        name.presence
+    end
+
+    def validate_known_employment_type
+      return if ID_NAME_MAP[metrojobb_id]
+
+      errors.add(:metrojobb_id, :inclusion)
+    end
+  end
+end

data/lib/metrojobb/location.rb

@@ -0,0 +1,15 @@
+require 'active_model'
+
+module Metrojobb
+  class Location < Model
+    attr_accessor :street, :postal_code, :city
+
+    def to_xml(builder: Builder::XmlMarkup.new(indent: 2))
+      builder.location do |node|
+        node.street(street) if street.present?
+        node.postalCode(postal_code) if postal_code.present?
+        node.city(city) if city.present?
+      end
+    end
+  end
+end

data/lib/metrojobb/model.rb

@@ -0,0 +1,16 @@
+require 'active_model'
+
+module Metrojobb
+  class Model
+    include ActiveModel::Model
+
+    InvalidError = Class.new(StandardError)
+
+    def to_xml!
+      return to_xml if valid?
+
+      error_message = "#{model_name} has errors on: #{self.errors.keys.join(', ')}"
+      raise(InvalidError, error_message)
+    end
+  end
+end

data/lib/metrojobb/region.rb

@@ -0,0 +1,33 @@
+require 'active_model'
+
+module Metrojobb
+  class Region < Model
+    attr_accessor :id, :name
+
+    NAME_ID_MAP = CSV.read(
+      File.expand_path('../../../data/regions.csv', __FILE__)
+    ).to_h.invert.freeze
+
+    ID_NAME_MAP = NAME_ID_MAP.invert.freeze
+
+    validate :validate_known_region
+
+    def to_xml(builder: Builder::XmlMarkup.new(indent: 2))
+      builder.region do |node|
+        node.id(region_id)
+      end
+    end
+
+    def region_id
+      NAME_ID_MAP[name.presence || id.presence] ||
+        id.presence ||
+        name.presence
+    end
+
+    def validate_known_region
+      return if ID_NAME_MAP[region_id]
+
+      errors.add(:region_id, :inclusion)
+    end
+  end
+end