rixml 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25f629105503be64d6300105901129fcb5255c85
-  data.tar.gz: 53141679e00fee5e8f7aa363e1d67958e4dddb8e
+  metadata.gz: ef1a6d79daadb500b55c10fcb4e88efa1449ddd2
+  data.tar.gz: 13963adef0e74d8e131f3ea7ceb2d73134f8ff07
 SHA512:
-  metadata.gz: d7e3ba7ae9511506b9fe3085faed86d7aadf6fc906c6bfc134595b38d88e63db5fdd1edf6680e19df48836aaeacd7bba764e1c68bc8e4b82a400fd9c9e43397c
-  data.tar.gz: 68da09018210d6f6b27613c8b15c3d9191603e6ae64700face8366f0868e0a61f9a08315086a05f70b444262d1de73a6f9f0cdcb455d2a2501eafd8962d81bff
+  metadata.gz: 79fc5901cb630c28b1e557d4d79a32dbf4511e460e71f48d70ae5688c767b2c91c9df5c43b4892312e2fb37dd6522c5b8b05e1ec72a042e09ce04112555ebfb8
+  data.tar.gz: 967df4ef556a4795cca31207ce1d0431b2ff1c6ad7dae788711c9e24f0d6013429e6661dd050c943bdc6a9a12c28c81862b2e042b0d2ee51884d38472280e15b

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -11,5 +11,6 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   Exclude:
+    - 'spec/**/*'
     - 'test/**/*'
     - 'vendor/**/*'

data/Gemfile.lock

@@ -4,11 +4,12 @@ PATH
     rixml (0.0.0)
       activesupport (>= 4.0.0)
       nokogiri (~> 1.5)
+      nokogiri-happymapper (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.2)
+    activesupport (5.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -16,17 +17,33 @@ GEM
     ast (2.3.0)
     byebug (9.0.6)
     concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
     i18n (0.8.6)
-    mini_portile2 (2.2.0)
+    mini_portile2 (2.3.0)
     minitest (5.10.1)
-    nokogiri (1.8.0)
-      mini_portile2 (~> 2.2.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    nokogiri-happymapper (0.6.0)
+      nokogiri (~> 1.5)
     parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
     rainbow (2.2.2)
       rake
     rake (11.3.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     rubocop (0.45.0)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
@@ -48,6 +65,7 @@ DEPENDENCIES
   minitest (~> 5.1)
   rake (~> 11.3)
   rixml!
+  rspec (~> 3.6)
   rubocop (~> 0.45.0)
 
 BUNDLED WITH

data/circle.yml

@@ -4,5 +4,6 @@ machine:
 test:
   override:
     - bundle exec rake
+    - bundle exec rspec
   post:
     - bundle exec rubocop

data/lib/rixml.rb

@@ -3,6 +3,7 @@ require 'nokogiri'
 require 'date'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/inflector/inflections'
+require_relative './rixml_document'
 
 # rubocop:disable Metrics/ClassLength
 class RIXML
@@ -13,11 +14,16 @@ class RIXML
   end
 
   def initialize(data)
+    @data = data
     @document = Nokogiri::XML(data)
     @attrs = Hash.from_xml(@document.root.to_s)
     @document.remove_namespaces!
   end
 
+  def research
+    @rixml_document ||= RixmlDocument.parse(@data)
+  end
+
   def product_id
     @attrs.dig('Research', 'Product', 'productID')
   end

data/lib/rixml_document.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require_relative './rixml_document/research'
+
+module RixmlDocument
+  def self.parse(xml)
+    RixmlDocument::Research.parse(xml)
+  end
+
+  def self.parse_from_file(filename)
+    xml = File.read(filename)
+    parse(xml)
+  end
+end

data/lib/rixml_document/asset_class.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './rixml_type/normalized_string'
+
+module RixmlDocument
+  class AssetClass < Node
+    include HappyMapper
+    tag 'AssetClass'
+
+    attribute :asset_class, RixmlType::NormalizedString, tag: 'assetClass'
+  end
+end

data/lib/rixml_document/context.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './issuer'
+require_relative './rixml_type/yes_no_boolean'
+
+module RixmlDocument
+  class IssuerDetails < Node
+    include HappyMapper
+    tag 'IssuerDetails'
+    has_many :issuers, Issuer, tag: 'Issuer', xpath: './'
+  end
+
+  class Context < Node
+    include HappyMapper
+    tag 'Context'
+
+    has_one :issuer_details, IssuerDetails, xpath: './'
+
+    attribute :external, RixmlType::YesNoBoolean
+
+    def issuers
+      issuer_details.issuers
+    end
+  end
+end

data/lib/rixml_document/issuer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './security'
+require_relative './rixml_type/normalized_string'
+require_relative './rixml_type/upcase_string'
+require_relative './rixml_type/yes_no_boolean'
+
+module RixmlDocument
+  class SecurityDetails < Node
+    include HappyMapper
+    has_many :securities, Security, tag: 'Security', xpath: './'
+  end
+
+  class Issuer < Node
+    include HappyMapper
+    tag 'Issuer'
+
+    has_one :security_details, SecurityDetails, tag: 'SecurityDetails', xpath: './'
+
+    attribute :primary_indicator, RixmlType::YesNoBoolean, tag: 'primaryIndicator'
+    attribute :issuer_type, RixmlType::NormalizedString, tag: 'issuerType'
+    attribute :domicile_country_code, RixmlType::UpcaseString, tag: 'domicileCountryCode'
+
+    def securities
+      security_details.securities
+    end
+  end
+end

data/lib/rixml_document/node.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module RixmlDocument
+  class Node
+    def to_hash
+      hash = {}
+      attributes = self.class.instance_variable_get(:@attributes)
+      elements = self.class.instance_variable_get(:@elements)
+      (attributes.to_a + elements.to_a).each do |k, _|
+        value = send(k)
+        hash[k] = serialize_attribute(value)
+      end
+      hash
+    end
+
+    private
+
+    def serialize_attribute(attribute)
+      if attribute.is_a?(Array)
+        attribute.map { |a| serialize_attribute(a) }
+      elsif attribute.respond_to?(:to_hash)
+        attribute.to_hash
+      else
+        attribute
+      end
+    end
+  end
+end

data/lib/rixml_document/product.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './context'
+require_relative './rixml_type/yes_no_boolean'
+
+module RixmlDocument
+  class Product < Node
+    include HappyMapper
+    tag 'Product'
+
+    has_one :context, Context, tag: 'Context', xpath: './'
+
+    attribute :product_id, String, tag: 'productID'
+    attribute :event_indicator, RixmlType::YesNoBoolean, tag: 'eventIndicator'
+  end
+end

data/lib/rixml_document/research.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './product'
+require_relative './rixml_type/normalized_string'
+
+module RixmlDocument
+  class Research < Node
+    include HappyMapper
+    tag 'Research'
+
+    has_one :product, Product, tag: 'Product', xpath: './'
+
+    attribute :research_id, String, tag: 'researchID'
+    attribute :created_date_time, Time, tag: 'createDateTime'
+    attribute :language, RixmlType::NormalizedString
+  end
+end

data/lib/rixml_document/rixml_type/normalized_string.rb

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

data/lib/rixml_document/rixml_type/upcase_string.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'happymapper'
+
+module RixmlDocument
+  module RixmlType
+    class UpcaseString
+      def self.parse(value)
+        value.to_s.upcase
+      end
+    end
+  end
+end
+
+HappyMapper::SupportedTypes.register_type(RixmlDocument::RixmlType::UpcaseString) do |value|
+  RixmlDocument::RixmlType::UpcaseString.parse(value)
+end

data/lib/rixml_document/rixml_type/yes_no_boolean.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'happymapper'
+
+module RixmlDocument
+  module RixmlType
+    class YesNoBoolean
+      def self.parse(value)
+        value.to_s.casecmp('yes').zero?
+      end
+    end
+  end
+end
+
+HappyMapper::SupportedTypes.register_type(RixmlDocument::RixmlType::YesNoBoolean) do |value|
+  RixmlDocument::RixmlType::YesNoBoolean.parse(value)
+end

data/lib/rixml_document/security.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './security_id'
+require_relative './asset_class'
+require_relative './security_type'
+require_relative './rixml_type/yes_no_boolean'
+
+module RixmlDocument
+  class Security < Node
+    include HappyMapper
+    tag 'Security'
+
+    has_many :security_ids, SecurityId, tag: 'SecurityID', xpath: './'
+    has_one :asset_class, AssetClass, tag: 'AssetClass', xpath: './'
+    has_one :security_type, SecurityType, tag: 'SecurityType', xpath: './'
+
+    element :security_name, String, tag: 'SecurityName'
+
+    attribute :primary_indicator, RixmlType::YesNoBoolean, tag: 'primaryIndicator'
+  end
+end

data/lib/rixml_document/security_id.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './rixml_type/normalized_string'
+require_relative './rixml_type/upcase_string'
+
+module RixmlDocument
+  class SecurityId < Node
+    include HappyMapper
+    tag 'SecurityID'
+
+    attribute :id_type, RixmlType::NormalizedString, tag: 'idType'
+    attribute :id_value, String, tag: 'idValue'
+    attribute :trading_country_code, RixmlType::UpcaseString, tag: 'tradingCountryCode'
+  end
+end

data/lib/rixml_document/security_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require 'happymapper'
+require_relative './node'
+require_relative './rixml_type/normalized_string'
+
+module RixmlDocument
+  class SecurityType < Node
+    include HappyMapper
+    tag 'SecurityType'
+
+    attribute :security_type, RixmlType::NormalizedString, tag: 'securityType'
+  end
+end

data/rixml.gemspec

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 Gem::Specification.new do |s|
   s.name          = 'rixml'
-  s.version       = '0.4.9'
-  s.date          = '2017-09-29'
+  s.version       = '0.5.0'
+  s.date          = '2017-10-06'
   s.summary       = 'RIXML Parser'
   s.description   = 'Parse RIXML files'
   s.homepage      = 'https://github.com/AlphaExchange/rixml'
@@ -16,10 +16,12 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler', '~> 1.12'
   s.add_development_dependency 'minitest', '~> 5.1'
+  s.add_development_dependency 'rspec', '~> 3.6'
   s.add_development_dependency 'rake', '~> 11.3'
   s.add_development_dependency 'rubocop', '~> 0.45.0'
   s.add_development_dependency 'byebug'
 
   s.add_runtime_dependency 'nokogiri', '~> 1.5'
   s.add_runtime_dependency 'activesupport', '>= 4.0.0'
+  s.add_runtime_dependency 'nokogiri-happymapper', '~> 0.6.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rixml
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Alex Correia Santos
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-29 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri-happymapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Parse RIXML files
 email:
 - alex@alpha-exchange.com
@@ -118,6 +146,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
@@ -125,6 +154,19 @@ files:
 - Rakefile
 - circle.yml
 - lib/rixml.rb
+- lib/rixml_document.rb
+- lib/rixml_document/asset_class.rb
+- lib/rixml_document/context.rb
+- lib/rixml_document/issuer.rb
+- lib/rixml_document/node.rb
+- lib/rixml_document/product.rb
+- lib/rixml_document/research.rb
+- lib/rixml_document/rixml_type/normalized_string.rb
+- lib/rixml_document/rixml_type/upcase_string.rb
+- lib/rixml_document/rixml_type/yes_no_boolean.rb
+- lib/rixml_document/security.rb
+- lib/rixml_document/security_id.rb
+- lib/rixml_document/security_type.rb
 - release
 - rixml.gemspec
 homepage: https://github.com/AlphaExchange/rixml