forward-calendar 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47a31c4f8f6e007dd7796067ce789b2eeea491a4
-  data.tar.gz: e8c43e64702112a9cfcc7d967495c6346096f363
+  metadata.gz: 862009b8848681c1e0194d4542a9d3e9c02d0ec5
+  data.tar.gz: 55be0c0aa4df8e86a278365f9955123e9564c48d
 SHA512:
-  metadata.gz: 44cd14f366051bdf097cbd0ebd5c96a35b0e6148437c5f20bc8322bd694c889efcfc934116e8e0b8a567713e68b0582c9d71d9bb34aa79dbdbbc13490c6c2a97
-  data.tar.gz: 734aea4380e54b1d61c7eb0d09c06888c5bc23bebdb0a4a725b90a2e1609440a30011070b53ee351daf9e999c5a3f7038443f08215e079bc5c88d7a472f1d8d6
+  metadata.gz: f42238e2c8f2edad3b68f61f44714045fac80474ab5a83cbd563c19f5b520e30ae1758317aeab5a029fadf59d42b1dcb150d8084063c731f692a65322afef9a3
+  data.tar.gz: 99a34126b47f19d2034e31613849899eb8c9316d0e40eb3794ceca4296d43808270f3906157fa5754b40ebef1898331905c1c05010a86f461eb3f4ab900bb562

data/forward-calendar.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name          = 'forward-calendar'
-  s.version       = '0.0.3'
-  s.date          = '2017-11-28'
+  s.version       = '0.1.0'
+  s.date          = '2017-12-07'
   s.summary       = 'Forward Calendar XML parser'
   s.description   = 'Parser for Forward Calendar XML files'
   s.homepage      = 'https://github.com/AlphaExchange/forward-calendar-rb'

data/lib/forward_calendar.rb

@@ -3,12 +3,12 @@
 require_relative './forward_calendar/forward_calendar'
 
 module ForwardCalendar
-  def self.parse(xml)
-    ForwardCalendar.parse(xml)
+  def self.parser(file_content)
+    ForwardCalendar.new(file_content)
   end
 
-  def self.parse_from_file(filename)
-    xml = File.read(filename)
-    parse(xml)
+  def self.parser_from_file(file_path)
+    xml = File.read(file_path)
+    parser(xml)
   end
 end

data/lib/forward_calendar/address.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'happymapper'
+require_relative 'node'
+
+module ForwardCalendar
+  class Address < Node
+    include HappyMapper
+    tag 'address'
+
+    element :city, String, tag: 'city'
+    element :state, String, tag: 'state'
+    element :country, String, tag: 'country'
+  end
+end

data/lib/forward_calendar/event.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'happymapper'
+require_relative 'node'
+require_relative './location'
+require_relative './helper/normalized_string'
+
+module ForwardCalendar
+  class Event < Node
+    include HappyMapper
+    tag 'event'
+
+    has_many :locations, Location, tag: 'eventLocation', xpath: './eventLocations'
+
+    element :id, Integer, tag: 'eventID'
+    element :type, Helper::NormalizedString, tag: 'eventType'
+    element :title, String, tag: 'eventTitle'
+    element :status, Helper::NormalizedString, tag: 'eventStatus'
+    element :broker, String, tag: 'broker'
+    element :description, String, tag: 'eventDescription'
+    element :start, Date, tag: 'start'
+    element :end, Date, tag: 'end'
+    element :url, String, tag: 'URL'
+  end
+end

data/lib/forward_calendar/forward_calendar.rb

@@ -1,19 +1,35 @@
 # frozen_string_literal: true
 
-require 'happymapper'
 require 'nokogiri'
-require_relative './node'
+require_relative './event'
 require_relative './updated'
 
 module ForwardCalendar
-  class ForwardCalendar < Node
-    include HappyMapper
-    tag 'forwardcalendar'
+  class ForwardCalendar
+    def initialize(file)
+      @file = file
+    end
 
-    with_nokogiri_config do |config|
-      config.options |= Nokogiri::XML::ParseOptions::HUGE
+    ##
+    # Immidiately returns the Updated element as soon as it gets parsed.
+    # (Avoids the complete traverse of the file if the Updated element is set
+    # at the beggining of the file)
+    #
+    def updated
+      Nokogiri::XML::Reader(@file).each do |node|
+        next unless node.name == 'updated' && node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT
+        return Updated.parse(Nokogiri::XML(node.outer_xml))
+      end
     end
 
-    has_one :updated, Updated, tag: 'updated', xpath: './'
+    ##
+    # Yields each Event from the Snapshot file being parsed.
+    #
+    def each_event
+      Nokogiri::XML::Reader(@file).each do |node|
+        next unless node.name == 'event' && node.node_type == Nokogiri::XML::Reader::TYPE_ELEMENT
+        yield Event.parse(Nokogiri::XML(node.outer_xml))
+      end
+    end
   end
 end

data/lib/forward_calendar/helper/normalized_string.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'happymapper'
+require 'active_support/core_ext/string'
+
+module ForwardCalendar
+  module Helper
+    class NormalizedString
+      def self.parse(value)
+        value.to_s.underscore.downcase
+      end
+    end
+  end
+end
+
+HappyMapper::SupportedTypes.register_type(ForwardCalendar::Helper::NormalizedString) do |value|
+  ForwardCalendar::Helper::NormalizedString.parse(value)
+end

data/lib/forward_calendar/location.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'happymapper'
+require_relative 'node'
+require_relative './location_start_time'
+require_relative './location_end_time'
+require_relative './address'
+require_relative './helper/normalized_string'
+
+module ForwardCalendar
+  class Location < Node
+    include HappyMapper
+    tag 'eventLocation'
+
+    has_one :start_time, LocationStartTime, tag: 'locationStartTime', xpath: './'
+    has_one :end_time, LocationEndTime, tag: 'locationEndTime', xpath: './'
+    has_one :address, Address, tag: 'address', xpath: './'
+
+    element :id, Integer, tag: 'locationID'
+    element :name, String, tag: 'locationEventName'
+    element :status, Helper::NormalizedString, tag: 'locationStatus'
+    element :start_date, Date, tag: 'locationStartDate'
+    element :end_date, Date, tag: 'locationEndDate'
+  end
+end

data/lib/forward_calendar/location_end_time.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'happymapper'
+require_relative './location_time'
+
+module ForwardCalendar
+  class LocationEndTime < LocationTime
+    include HappyMapper
+    tag 'locationEndTime'
+  end
+end

data/lib/forward_calendar/location_start_time.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'happymapper'
+require_relative './location_time'
+
+module ForwardCalendar
+  class LocationStartTime < LocationTime
+    include HappyMapper
+    tag 'locationStartTime'
+  end
+end

data/lib/forward_calendar/location_time.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'happymapper'
+require_relative 'node'
+
+module ForwardCalendar
+  class LocationTime < Node
+    include HappyMapper
+
+    element :datetime, Time, tag: 'datetime'
+    element :timezone, String, tag: 'timezone'
+  end
+end

data/lib/forward_calendar/updated.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'happymapper'
-require_relative './node'
+require_relative 'node'
 
 module ForwardCalendar
   class Updated < Node

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forward-calendar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - João Simões
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -182,7 +182,14 @@ files:
 - forward-calendar.gemspec
 - lib/forward-calendar.rb
 - lib/forward_calendar.rb
+- lib/forward_calendar/address.rb
+- lib/forward_calendar/event.rb
 - lib/forward_calendar/forward_calendar.rb
+- lib/forward_calendar/helper/normalized_string.rb
+- lib/forward_calendar/location.rb
+- lib/forward_calendar/location_end_time.rb
+- lib/forward_calendar/location_start_time.rb
+- lib/forward_calendar/location_time.rb
 - lib/forward_calendar/node.rb
 - lib/forward_calendar/updated.rb
 - release