mits 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d505939145db141c682033bbf5d3fd1ef8062be3
-  data.tar.gz: f130e83001a8be5634087fec84f6063ed6fa547d
+  metadata.gz: 9e3d066755e4fd3763ed195996832b597c6c559e
+  data.tar.gz: b9ad8637001201a6b12713c373971461c23cba9f
 SHA512:
-  metadata.gz: baa3aa9da9b2b316eb3cd9ff74592c00e67499029bcffc153bd4193944aae24ddfd2df47bdeb8d1e337813ecebcdc032a5963229e518d22dbf8a07d15757b73c
-  data.tar.gz: 004c18108965e715d0eeecaa1b6aee85d3e7ca25426c593ebf0cf008babca1e19a2ecffd7c705b4c1e880886f6594caa750540302ce83f414515e05eee7840ee
+  metadata.gz: 97d002c90c6ada433bf6a5bb5049ae129ecfa394c86036833f258aacc4bf3f5c3ed92f7c1d945d63801fddf04a7c5c04aec8079e88cfef17548f3fc6e1ce24b9
+  data.tar.gz: e917486f219ab2a63e3bdf52d5c77574bcbc6ee4021931295e5178281a8e34fe59d7037f35dbc1b0f7952fe683f81e8481b83d08c1c51f260958040a2c481bac

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - ruby-head
+script: bundle exec rspec
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/README.md

@@ -1,31 +1,49 @@
-# Mits
+# MITS
 
-TODO: Write a gem description
+A SAX powered reader for [Multifamily Information and Transactions Standard \(MITS\)](http://www.mitsproject.org/) compatible documents.
+
+Currently supporting MITS __4.1__.
+
+[![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)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+	gem install mits
+
+## Getting Started
+
+Create a `MITS::Document` with a local filepath or URL:
 
 ```ruby
-gem 'mits'
+document = MITS::Document.new('/example/path/mits_compatible_feed.xml')
 ```
 
-And then execute:
+Iterating over properties is easy:
 
-    $ bundle
-
-Or install it yourself as:
+```ruby
+document.properties do |property|
+  puts "#{property.name} now available online at #{property.website}"
+end
+```
 
-    $ gem install mits
+The `#properties` method returns a `Enumerator` if no block is provided:
 
-## Usage
+```ruby
 
-TODO: Write usage instructions here
+document.properties.each_with_object([]) do |property, arr|
+  # Only include properties with 2 or more units
+  arr.push(property) if property.units.size > 2
+end
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/mits/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+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.
+
+## Author
+
+MITS is written and maintained by [@doomspork](http://github.com/doomspork) as part of [CityLeash](https://cityleash.com).
+
+## License
+
+Please see [LICENSE](https://github.com/doomspork/mits/blob/master/LICENSE) for licensing details.

data/lib/mits/document.rb

@@ -0,0 +1,35 @@
+module MITS
+  class Document
+    attr_reader :parser
+
+    def initialize(url)
+      @parser = ::Saxerator.parser(open(url)) do |c|
+        c.put_attributes_in_hash!
+        c.symbolize_keys!
+      end
+    end
+
+    def properties
+      return enum_for(:properties) unless block_given?
+
+      physical_property.for_tag(:Property).each do |tag|
+        yield Mapper.property(tag)
+      end
+    end
+
+    def companies
+      return enum_for(:companies) unless block_given?
+
+      physical_property.within(:Management).within(:PropertyContacts).each do |tag|
+        yield Mapper.company(tag)
+      end
+    end
+
+    private
+
+    def physical_property
+      parser.within(:PhysicalProperty)
+    end
+
+  end
+end

data/lib/mits/entities/address.rb

@@ -0,0 +1,16 @@
+module MITS
+  class Address
+    include SimpleObjects::Base
+
+    attribute :address1
+    attribute :address2
+    attribute :city
+    attribute :country
+    attribute :description
+    attribute :latitude
+    attribute :longitude
+    attribute :postal_code
+    attribute :state
+    attribute :type
+  end
+end

data/lib/mits/entities/amenity.rb

@@ -0,0 +1,8 @@
+module MITS
+  class Amenity
+    include SimpleObjects::Base
+
+    attribute :description
+    attribute :type
+  end
+end

data/lib/mits/entities/company.rb

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

data/lib/mits/entities/deposit.rb

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

data/lib/mits/entities/fees.rb

@@ -0,0 +1,15 @@
+module MITS
+  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

data/lib/mits/entities/file.rb

@@ -0,0 +1,16 @@
+module MITS
+  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

data/lib/mits/entities/pet.rb

@@ -0,0 +1,11 @@
+module MITS
+  class Pet
+    include SimpleObjects::Base
+
+    attribute :count
+    attribute :description
+    attribute :size
+    attribute :type
+    attribute :weight
+  end
+end

data/lib/mits/entities/pet_policy.rb

@@ -0,0 +1,15 @@
+module MITS
+  class PetPolicy
+    include SimpleObjects::Base
+
+    attribute :allowed
+    attribute :care
+    attribute :deposit
+    attribute :fee
+    attribute :pets
+    attribute :rent
+    attribute :restrictions
+
+    alias_method :allowed?, :allowed
+  end
+end

data/lib/mits/entities/property.rb

@@ -0,0 +1,20 @@
+module MITS
+  class Property
+    include SimpleObjects::Base
+
+    attribute :address
+    attribute :amenities
+    attribute :company_id
+    attribute :deposit
+    attribute :description
+    attribute :fees
+    attribute :files
+    attribute :id
+    attribute :name
+    attribute :pet_policy
+    attribute :summary
+    attribute :type
+    attribute :units
+    attribute :website
+  end
+end

data/lib/mits/entities/unit.rb

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

data/lib/mits/mapper.rb

@@ -0,0 +1,48 @@
+require 'mits/entities/address'
+require 'mits/entities/amenity'
+require 'mits/entities/company'
+require 'mits/entities/deposit'
+require 'mits/entities/fees'
+require 'mits/entities/file'
+require 'mits/entities/pet'
+require 'mits/entities/pet_policy'
+require 'mits/entities/property'
+require 'mits/entities/unit'
+
+require 'mits/mappers/address_mapper'
+require 'mits/mappers/amenities_mapper'
+require 'mits/mappers/company_mapper'
+require 'mits/mappers/deposit_mapper'
+require 'mits/mappers/fees_mapper'
+require 'mits/mappers/files_mapper'
+require 'mits/mappers/pet_policy_mapper'
+require 'mits/mappers/property_mapper'
+require 'mits/mappers/units_mapper'
+
+module MITS
+  module Mapper
+    extend AddressMapper
+    extend AmenitiesMapper
+    extend CompanyMapper
+    extend DepositMapper
+    extend FeesMapper
+    extend FilesMapper
+    extend PetPolicyMapper
+    extend PropertyMapper
+    extend UnitsMapper
+
+    extend self
+
+    protected
+
+    def bool(value)
+      value == 'true'
+    end
+
+    def try(value, method)
+      return nil unless value
+      value.send(method)
+    end
+
+  end
+end

data/lib/mits/mappers/address_mapper.rb

@@ -0,0 +1,29 @@
+module MITS
+  module AddressMapper
+    def address(tag, secondary_tag = nil)
+      attrs = address_attributes(tag)
+
+      if secondary_tag
+        attrs[:latitude] = try(secondary_tag[:Latitude], :to_f)
+        attrs[:longitude] = try(secondary_tag[:Longitude], :to_f)
+      end
+
+      Address.new(attrs)
+    end
+
+    private
+
+    def address_attributes(tag)
+      {
+        type:        tag[:AddressType],
+        description: tag[:Description],
+        address1:    tag[:AddressLine1],
+        address2:    tag[:AddressLine2],
+        city:        tag[:City],
+        state:       tag[:State],
+        postal_code: tag[:PostalCode],
+        country:     tag[:Country],
+      }
+    end
+  end
+end

data/lib/mits/mappers/amenities_mapper.rb

@@ -0,0 +1,14 @@
+module MITS
+  module AmenitiesMapper
+    def amenities(tags)
+      if tags
+        tags = [tags] unless tags.is_a? Array
+        tags.map { |tag| amenity(tag) }
+      end
+    end
+
+    def amenity(tag)
+      Amenity.new(description: tag[:Description], type: tag[:AmenityType])
+    end
+  end
+end

data/lib/mits/mappers/company_mapper.rb

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

data/lib/mits/mappers/deposit_mapper.rb

@@ -0,0 +1,24 @@
+module MITS
+  module DepositMapper
+    def deposit(tag)
+      Deposit.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

data/lib/mits/mappers/fees_mapper.rb

@@ -0,0 +1,15 @@
+module MITS
+  module FeesMapper
+    def fees(tag)
+      Fees.new(admin_fee:               try(tag[:AdminFee], :to_f),
+               application_fee:         try(tag[:ApplicationFee], :to_f),
+               broker_fee:              try(tag[:BrokerFee], :to_f),
+               late_fee_per_day:        try(tag[:LateFeePerDay], :to_f),
+               late_min_fee:            try(tag[:LateMinFee], :to_f),
+               late_percent:            try(tag[:LatePercent], :to_f),
+               late_type:               tag[:LateType],
+               non_refundable_hold_fee: try(tag[:NonRefundableHoldFee], :to_f),
+               prorate_type:            tag[:ProrateType])
+    end
+  end
+end

data/lib/mits/mappers/files_mapper.rb

@@ -0,0 +1,19 @@
+module MITS
+  module FilesMapper
+    def files(tags)
+      tags = [tags] unless tags.is_a? Array
+      tags.map do |tag|
+        File.new(active:      bool(tag[:Active]),
+                 caption:     tag[:Caption],
+                 description: tag[:Description],
+                 format:      tag[:Format],
+                 height:      try(tag[:Height], :to_i),
+                 id:          tag[:FileID],
+                 name:        tag[:Name],
+                 rank:        tag[:Rank],
+                 source:      tag[:Src],
+                 width:       tag[:Width])
+      end
+    end
+  end
+end

data/lib/mits/mappers/pet_policy_mapper.rb

@@ -0,0 +1,28 @@
+module MITS
+  module PetPolicyMapper
+    def pet_policy(tag)
+      if bool(tag[:Allowed])
+        PetPolicy.new(allowed:      true,
+                      care:         bool(tag[:PetCare]),
+                      deposit:      try(tag[:Deposit], :to_f),
+                      fee:          try(tag[:Fee], :to_f),
+                      pets:         pets(tag[:Pets]),
+                      rent:         try(tag[:Rent], :to_f),
+                      restrictions: tag[:Restrictions])
+      else
+        PetPolicy.new(allowed: false)
+      end
+    end
+
+    def pets(tags)
+      tags = [tags] unless tags.is_a? Array
+      tags.map do |tag|
+        Pet.new(count:       tag[:Count].to_i,
+                description: tag[:Description],
+                size:        tag[:Size],
+                weight:      tag[:Weight],
+                type:        tag[:PetType])
+      end
+    end
+  end
+end

data/lib/mits/mappers/property_mapper.rb

@@ -0,0 +1,41 @@
+module MITS
+  module PropertyMapper
+    def property(tag)
+      basics  = property_basics(tag)
+      details = property_details(tag)
+      Property.new(basics.merge(details))
+    end
+
+    private
+
+    def property_basics(tag)
+      propId = tag[:PropertyID]
+      {
+        company_id:  company_id(propId[:Identification]),
+        description: tag[:Information][:LongDescription],
+        id:          tag[:IDValue],
+        name:        propId[:MarketingName],
+        summary:     tag[:Information][:ShortDescription],
+        type:        tag[:ILS_Identification][:ILS_IdentificationType],
+        website:     propId[:WebSite]
+      }
+    end
+
+    def property_details(tag)
+      {
+        address:     address(tag[:PropertyID][:Address], tag[:ILS_Identification]),
+        amenities:   amenities(tag[:ILS_Unit][:Amenity]),
+        deposit:     deposit(tag[:Deposit]),
+        fees:        fees(tag[:Fee]),
+        files:       files(tag[:File]),
+        pet_policy:  pet_policy(tag[:Policy][:Pet]),
+        units:       units(tag[:ILS_Unit][:Units][:Unit])
+      }
+    end
+
+    def company_id(tags)
+      tag = tags.find { |t| t[:IDType].downcase == 'company' }
+      tag[:IDValue] if tag
+    end
+  end
+end

data/lib/mits/mappers/units_mapper.rb

@@ -0,0 +1,22 @@
+module MITS
+  module UnitsMapper
+    def units(tags)
+      tags = [tags] unless tags.is_a? Array
+      tags.map do |tag|
+        Unit.new(bathrooms: try(tag[:UnitBathrooms], :to_f),
+                 bedrooms:  try(tag[:UnitBedrooms], :to_f),
+                 name:      tag[:MarketingName],
+                 rent:      try(tag[:UnitRent], :to_f),
+                 sqft:      unit_sqft(tag))
+      end
+    end
+
+    private
+
+    def unit_sqft(tag)
+      min = tag[:MinSquareFeet]
+      max = tag[:MaxSquareFeet]
+      Range.new(min.to_i, max.to_i)
+    end
+  end
+end

data/lib/mits/saxerator_ext.rb

@@ -0,0 +1,29 @@
+module Saxerator
+  module Builder
+    class HashElement < Hash
+      def deep_hash
+        self.reduce({}) do |memo, (key, value)|
+          as_hash = if value.is_a? Array
+                      value.map { |v| try_hash(v) }
+                    else
+                      try_hash(value)
+                    end
+          memo[key] = as_hash
+          memo
+        end
+      end
+
+      def try_hash(val)
+        if val.is_a? EmptyElement
+          nil
+        elsif val.respond_to? :deep_hash
+          val.deep_hash
+        elsif val.respond_to? :to_h
+          val.to_h
+        else
+          val
+        end
+      end
+    end
+  end
+end

data/lib/mits/version.rb

@@ -1,3 +1,3 @@
-module Mits
-  VERSION = "0.0.1"
+module MITS
+  VERSION = '0.1.0'
 end

data/lib/mits.rb

@@ -1,5 +1,11 @@
-require "mits/version"
+require 'open-uri'
+require 'saxerator'
+require 'simple_objects'
 
-module Mits
-  # Your code goes here...
+require 'mits/document'
+require 'mits/mapper'
+require 'mits/saxerator_ext'
+require 'mits/version'
+
+module MITS
 end

data/mits.gemspec

@@ -5,11 +5,11 @@ require 'mits/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'mits'
-  spec.version       = Mits::VERSION
+  spec.version       = MITS::VERSION
   spec.authors       = ['Sean Callan']
   spec.email         = ['seancallan@gmail.com']
-  spec.summary       = 'A SAX powered MITS reader.' 
-  spec.description   = ''
+  spec.summary       = 'A SAX powered MITS reader for Ruby.' 
+  spec.description   = 'A SAX powered Multifamily Information and Transactions Standard (MITS) reader for Ruby.'
   spec.homepage      = 'https://github.com/doomspork/mits'
   spec.license       = 'MIT'
 
@@ -18,7 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'simple_objects', '~> 0.1'
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'simple_objects', '~> 1.1'
+  spec.add_dependency 'saxerator', '~> 0.9.5'
+
+  spec.add_development_dependency 'bundler',     '~> 1.7'
+  spec.add_development_dependency 'coveralls',   '~> 0.7'
+  spec.add_development_dependency 'pry',         '~> 0.10'
+  spec.add_development_dependency 'pry-byebug',  '~> 2.0'
+  spec.add_development_dependency 'rake',        '~> 10.0'
+  spec.add_development_dependency 'rspec',       '~> 3.1'
+  spec.add_development_dependency 'simplecov',   '~> 0.9'
 end