mits 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e3d066755e4fd3763ed195996832b597c6c559e
-  data.tar.gz: b9ad8637001201a6b12713c373971461c23cba9f
+  metadata.gz: bbed76e9f570ddc78b834b3bd6b26afc0044c8e8
+  data.tar.gz: 4f5122214d0e595df65971b65966c1c78ba6575e
 SHA512:
-  metadata.gz: 97d002c90c6ada433bf6a5bb5049ae129ecfa394c86036833f258aacc4bf3f5c3ed92f7c1d945d63801fddf04a7c5c04aec8079e88cfef17548f3fc6e1ce24b9
-  data.tar.gz: e917486f219ab2a63e3bdf52d5c77574bcbc6ee4021931295e5178281a8e34fe59d7037f35dbc1b0f7952fe683f81e8481b83d08c1c51f260958040a2c481bac
+  metadata.gz: 12b04c823773fb1917f4fac79739a74c4f955a93e1cc16fa279a89331070f0c06ba651a53cb9b88324cc589afef949f8b8bae4ace94162b2c88b34e43f92c90a
+  data.tar.gz: 9a6eac1e8f0b43a2bb35df3b891f8e8de40a49302872647207aa2f87308dbed867b3918c81f6c5085e56bb06e95f4e9d7e862d9912c3dbdb0862f37abe9fc55c

data/.gitignore

@@ -25,7 +25,7 @@
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 .ruby-version
 .ruby-gemset
 

data/README.md

@@ -2,7 +2,7 @@
 
 A SAX powered reader for [Multifamily Information and Transactions Standard \(MITS\)](http://www.mitsproject.org/) compatible documents.
 
-Currently supporting MITS __4.1__.
+Currently supporting MITS __3.0__ & __4.1__ (default).
 
 [![Gem Version](https://badge.fury.io/rb/mits.png)](https://rubygems.org/gems/mits) [![Build Status](https://travis-ci.org/doomspork/mits.svg?branch=master)](https://travis-ci.org/doomspork/mits) [![Code Climate](https://codeclimate.com/github/doomspork/mits/badges/gpa.svg)](https://codeclimate.com/github/doomspork/mits) [![Coverage Status](https://coveralls.io/repos/doomspork/mits/badge.png?branch=master)](https://coveralls.io/r/doomspork/mits?branch=master) [![Dependency Status](https://gemnasium.com/doomspork/mits.svg)](https://gemnasium.com/doomspork/mits)
 
@@ -15,7 +15,7 @@ Currently supporting MITS __4.1__.
 Create a `MITS::Document` with a local filepath or URL:
 
 ```ruby
-document = MITS::Document.new('/example/path/mits_compatible_feed.xml')
+document = MITS::Document.new('/example/path/mits_compatible_feed.xml', version: 3.0)
 ```
 
 Iterating over properties is easy:
@@ -38,11 +38,11 @@ end
 
 ## Contributing
 
-Feedback, feature requests, and fixes are welcome.  Please make appropriate use of [Issues](https://github.com/doomspork/mits/issues) and [Pull Requests](https://github.com/doomspork/mits/pulls).  All code should have accompanying tests.
+Feedback, feature requests, and fixes are welcomed and encouraged.  Please make appropriate use of [Issues](https://github.com/doomspork/mits/issues) and [Pull Requests](https://github.com/doomspork/mits/pulls).  All code should have accompanying tests.
 
 ## Author
 
-MITS is written and maintained by [@doomspork](http://github.com/doomspork) as part of [CityLeash](https://cityleash.com).
+MITS is written and maintained by [@doomspork](http://github.com/doomspork) as part of [CityLeash.com](https://cityleash.com).
 
 ## License
 

data/lib/mits.rb

@@ -1,11 +1,14 @@
 require 'open-uri'
 require 'saxerator'
 require 'simple_objects'
+require 'versions'
 
+require 'mits/base_mapper'
 require 'mits/document'
-require 'mits/mapper'
 require 'mits/saxerator_ext'
 require 'mits/version'
 
 module MITS
+  Versions.config.base_dir = File.join(File.realpath(__dir__), 'mits')
+  Versions.config.class_prefix = 'MITS::V'
 end

data/lib/mits/base_mapper.rb

@@ -0,0 +1,20 @@
+module MITS
+  module BaseMapper
+    protected
+
+    def bool(value)
+      value == 'true'
+    end
+
+    def try(*values, method)
+      value, *args = values
+      return nil unless value
+      if value.respond_to?(method)
+        value.send(method)
+      elsif self.respond_to?(method)
+        args = [args] unless args.is_a? Array
+        self.send(method, value, *args)
+      end
+    end
+  end
+end

data/lib/mits/document.rb

@@ -1,9 +1,12 @@
 module MITS
   class Document
-    attr_reader :parser
+    attr_reader :parser, :version
 
-    def initialize(url)
-      @parser = ::Saxerator.parser(open(url)) do |c|
+    DEFAULT_VERSION = '4.1'
+
+    def initialize(url, opts = {})
+      @version = (opts[:version] || DEFAULT_VERSION).to_s
+      @parser  = ::Saxerator.parser(open(url)) do |c|
         c.put_attributes_in_hash!
         c.symbolize_keys!
       end
@@ -13,7 +16,7 @@ module MITS
       return enum_for(:properties) unless block_given?
 
       physical_property.for_tag(:Property).each do |tag|
-        yield Mapper.property(tag)
+        yield mapper.property(tag)
       end
     end
 
@@ -21,15 +24,23 @@ module MITS
       return enum_for(:companies) unless block_given?
 
       physical_property.within(:Management).within(:PropertyContacts).each do |tag|
-        yield Mapper.company(tag)
+        yield mapper.company(tag, company_entity)
       end
     end
 
     private
 
+    def company_entity
+      Versions.for(:company).select(version)
+    end
+
     def physical_property
       parser.within(:PhysicalProperty)
     end
 
+    def mapper
+      @mapper ||= Versions.for(:mapper).select(version)
+    end
+
   end
 end

data/lib/mits/saxerator_ext.rb

@@ -2,7 +2,7 @@ module Saxerator
   module Builder
     class HashElement < Hash
       def deep_hash
-        self.reduce({}) do |memo, (key, value)|
+        reduce({}) do |memo, (key, value)|
           as_hash = if value.is_a? Array
                       value.map { |v| try_hash(v) }
                     else
@@ -25,5 +25,12 @@ module Saxerator
         end
       end
     end
+
+    class StringElement
+      def to_h
+        to_s
+      end
+    end
+
   end
 end

data/lib/mits/v3.0/address.rb

@@ -0,0 +1,20 @@
+module MITS
+  module V3_0
+    class Address
+      include SimpleObjects::Base
+
+      attribute :address
+      attribute :city
+      attribute :country
+      attribute :county_name
+      attribute :description
+      attribute :latitude
+      attribute :longitude
+      attribute :postal_code
+      attribute :province
+      attribute :state
+      attribute :type
+      attribute :unparsed_address
+    end
+  end
+end

data/lib/mits/v3.0/amenity.rb

@@ -0,0 +1,12 @@
+module MITS
+  module V3_0
+    class Amenity
+      include SimpleObjects::Base
+
+      attribute :description
+      attribute :rank
+      attribute :subtype
+      attribute :type
+    end
+  end
+end

data/lib/mits/v3.0/company.rb

@@ -0,0 +1,13 @@
+module MITS
+  module V3_0
+    class Company
+      include SimpleObjects::Base
+
+      attribute :id
+      attribute :name
+      attribute :address
+      attribute :website
+      attribute :logo
+    end
+  end
+end

data/lib/mits/v3.0/deposit.rb

@@ -0,0 +1,13 @@
+module MITS
+  module V3_0
+    class Deposit
+      include SimpleObjects::Base
+
+      attribute :amount
+      attribute :description
+      attribute :percent_refundable
+      attribute :portion_refundable
+      attribute :type
+    end
+  end
+end

data/lib/mits/v3.0/fees.rb

@@ -0,0 +1,17 @@
+module MITS
+  module V3_0
+    class Fees
+      include SimpleObjects::Base
+
+      attribute :admin_fee
+      attribute :application_fee
+      attribute :broker_fee
+      attribute :late_fee_per_day
+      attribute :late_min_fee
+      attribute :late_percent
+      attribute :late_type
+      attribute :non_refundable_hold_fee
+      attribute :prorate_type
+    end
+  end
+end

data/lib/mits/v3.0/file.rb

@@ -0,0 +1,18 @@
+module MITS
+  module V3_0
+    class File
+      include SimpleObjects::Base
+
+      attribute :active
+      attribute :caption
+      attribute :description
+      attribute :format
+      attribute :height
+      attribute :id
+      attribute :name
+      attribute :rank
+      attribute :source
+      attribute :width
+    end
+  end
+end

data/lib/mits/v3.0/floorplan.rb

@@ -0,0 +1,13 @@
+module MITS
+  module V3_0
+    class Floorplan
+      include SimpleObjects::Base
+
+      attribute :bathrooms
+      attribute :bedrooms
+      attribute :name
+      attribute :rent
+      attribute :sqft
+    end
+  end
+end

data/lib/mits/v3.0/mapper.rb

@@ -0,0 +1,50 @@
+require_relative 'address'
+require_relative 'amenity'
+require_relative 'company'
+require_relative 'deposit'
+require_relative 'fees'
+require_relative 'file'
+require_relative 'floorplan'
+require_relative 'pet'
+require_relative 'pet_policy'
+require_relative 'policy'
+require_relative 'property'
+
+require_relative 'mapper/address_mapper'
+require_relative 'mapper/amenities_mapper'
+require_relative 'mapper/company_mapper'
+require_relative 'mapper/deposit_mapper'
+require_relative 'mapper/fees_mapper'
+require_relative 'mapper/files_mapper'
+require_relative 'mapper/floorplan_mapper'
+require_relative 'mapper/pet_policy_mapper'
+require_relative 'mapper/policy_mapper'
+require_relative 'mapper/property_mapper'
+
+module MITS
+  module V3_0
+    module Mapper
+      extend BaseMapper
+
+      extend AddressMapper
+      extend AmenitiesMapper
+      extend CompanyMapper
+      extend DepositMapper
+      extend FeesMapper
+      extend FilesMapper
+      extend FloorplanMapper
+      extend PetPolicyMapper
+      extend PolicyMapper
+      extend PropertyMapper
+
+      def range_tag(tag)
+        min = tag[:Min]
+        max = tag[:Max]
+        Range.new(min.to_i, max.to_i)
+      end
+
+      extend self
+    end
+  end
+end
+

data/lib/mits/v3.0/mapper/address_mapper.rb

@@ -0,0 +1,35 @@
+module MITS
+  module V3_0
+    module Mapper
+      module AddressMapper
+        def address(tag, secondary_tag = nil, entity = Address)
+          attrs = address_attributes(tag)
+
+          if secondary_tag
+            attrs[:latitude]  = try(secondary_tag[:Latitude], :to_f)
+            attrs[:longitude] = try(secondary_tag[:Longitude], :to_f)
+          end
+
+          entity.new(attrs)
+        end
+
+        private
+
+        def address_attributes(tag)
+          {
+            address:          tag[:Address],
+            city:             tag[:City],
+            country:          tag[:Country],
+            country_name:     tag[:CountyName],
+            description:      tag[:Description],
+            postal_code:      tag[:PostalCode],
+            province:         tag[:Province],
+            state:            tag[:State],
+            type:             tag[:AddressType],
+            unparsed_address: tag[:UnparsedAddress]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mits/v3.0/mapper/amenities_mapper.rb

@@ -0,0 +1,19 @@
+module MITS
+  module V3_0
+    module Mapper
+      module AmenitiesMapper
+        def amenities(tags, entity = Amenity)
+          tags = [tags] unless tags.is_a? Array
+          tags.map { |tag| amenity(tag, entity) }
+        end
+
+        def amenity(tag, entity = Amenity)
+          entity.new(description: tag[:Description],
+                     rank:        tag[:Rank],
+                     subtype:     tag[:AmenitySubType],
+                     type:        tag[:AmenityType])
+        end
+      end
+    end
+  end
+end

data/lib/mits/v3.0/mapper/company_mapper.rb

@@ -0,0 +1,15 @@
+module MITS
+  module V3_0
+    module Mapper
+      module CompanyMapper
+        def company(tag, entity = Company)
+          entity.new(address:  address(tag[:Address]),
+                      id:      tag[:Identification][:IDValue],
+                      logo:    tag[:Logo],
+                      name:    tag[:CompanyName],
+                      website: tag[:Website])
+        end
+      end
+    end
+  end
+end

data/lib/mits/v3.0/mapper/deposit_mapper.rb

@@ -0,0 +1,32 @@
+module MITS
+  module V3_0
+    module Mapper
+      module DepositMapper
+        def deposits(tags, entity = Deposit)
+          tags = [tags] unless tags.is_a? Array
+          tags.map { |tag| deposit(tag, entity) }
+        end
+
+        def deposit(tag, entity = Deposit)
+          entity.new(amount:             deposit_amount(tag[:Amount][:ValueRange]),
+                     description:        tag[:Description],
+                     percent_refundable: try(tag[:PercentRefundable], :to_f),
+                     portion_refundable: try(tag[:PortionRefundable], :to_f),
+                     type:               tag[:DepositType])
+        end
+        private
+
+        def deposit_amount(tag)
+          if tag[:Exact]
+            amount = tag[:Exact].to_f
+          else
+            min = tag[:Min].to_f
+            max = tag[:Max].to_f
+            amount = Range.new(min, max)
+          end
+          amount
+        end
+      end
+    end
+  end
+end