dotloop 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c213b9e2cec3531161964f13642bdd2b2321b5b
-  data.tar.gz: 4538cc1d29e37cd2575df00891ea0a746517f5bc
+  metadata.gz: 5b1e7e084caa1e8f18b46dbc62a1015b48b5d8ca
+  data.tar.gz: 3d4ace3f1e2a64ce791ba677e43ee374161e362b
 SHA512:
-  metadata.gz: 00224b520d72684deb986e1fdf9f614e9dd2a01ec3371b03c130aacd319a6979e017ec67c78939fabdcf35b0e6b0ef76915b5d9db50eb60a9fca5cb4b9588f66
-  data.tar.gz: 55fcf4b2f8dd2a927dcc61e63e6338350f6c50516c1bd4b18e96f1f88bbb69a56fbef9f9cd9c002da72f1abbdb49bce9059b76ee41a95f3d4809802f760c4110
+  metadata.gz: 58389e753693271ff12968baf219771f0d702ba2b15fee7bc4745f03b8aed601a19399866ebb3b0ddbb5cbce44021af0eaa77c21e3cafc52fc38b9f375d9e876
+  data.tar.gz: f2652b4fcddeb990c0bef88a3b643bd8a9f01c9a73101196a7e9e2a735cd7ff12e3622490251a0e9828b46c0cfbde148f7084c43ce2d623bbe01ef95edfe0603

data/.rubocop.yml

@@ -23,6 +23,7 @@ AllCops:
     - 'vendor/**/*'
     - 'bin/**/*'
     - 'log/**/*'
+    - 'dotloop.gemspec'
 Documentation:
   Enabled: false
 Metrics/LineLength:

data/README.md

@@ -4,7 +4,7 @@
 
 This library is designed to help ruby applications consume the DotLoop API.
 
-You can read more about the api the the official documentation at [https://support.dotloop.com](https://support.dotloop.com/hc/en-us/articles/204407013-Dotloop-REST-API-Developer-s-Guide)
+You can read more about the api from the official documentation at [https://support.dotloop.com](https://support.dotloop.com/hc/en-us/articles/204407013-Dotloop-REST-API-Developer-s-Guide)
 
 ## Installation
 
@@ -25,6 +25,8 @@ Or install it yourself as:
 ## Usage
 
 Optional parameters are prefixed with a __'*'__'
+
+```ruby
     client = Dotloop::Client.new(api_key: 'c4c26918-b2df-49a6-9bc2-9009274b23a7')
 
     client.Profile.all                                                      #=> get list of profiles
@@ -92,6 +94,7 @@ Optional parameters are prefixed with a __'*'__'
       document_id: '561622',
       document_name: 'My Offer'
     )                                                                       #=> get a PDF document
+```
 
 ## Development
 

data/lib/dotloop.rb

@@ -6,6 +6,7 @@ require 'dotloop/version'
 require 'dotloop/client'
 require 'dotloop/query_param_helpers'
 require 'dotloop/profile'
+require 'dotloop/section'
 require 'dotloop/loop'
 require 'dotloop/admin'
 require 'dotloop/document'
@@ -17,13 +18,6 @@ require 'dotloop/participant'
 require 'dotloop/person'
 require 'dotloop/task'
 
-require 'dotloop/models/property_address'
-require 'dotloop/models/buying_brokerage'
-require 'dotloop/models/listing_brokerage'
-require 'dotloop/models/financials'
-require 'dotloop/models/section'
-require 'dotloop/models/loop_detail'
-
 require 'dotloop/models/admin'
 require 'dotloop/models/document'
 require 'dotloop/models/document_activity'
@@ -37,6 +31,19 @@ require 'dotloop/models/profile'
 require 'dotloop/models/tag'
 require 'dotloop/models/task'
 
+require 'dotloop/models/sections/contact'
+require 'dotloop/models/sections/contract_dates'
+require 'dotloop/models/sections/contract_info'
+require 'dotloop/models/sections/financials'
+require 'dotloop/models/sections/geographic_description'
+require 'dotloop/models/sections/listing_information'
+require 'dotloop/models/sections/offer_dates'
+require 'dotloop/models/sections/property_address'
+require 'dotloop/models/sections/property'
+require 'dotloop/models/sections/referral'
+require 'dotloop/models/section'
+require 'dotloop/models/loop_detail'
+
 module Dotloop
   # Your code goes here...
 end

data/lib/dotloop/document.rb

@@ -16,11 +16,16 @@ module Dotloop
 
     def get(profile_id:, loop_view_id:, document_id:, document_name:)
       document_name = CGI.escape(document_name.delete('/'))
-      StringIO.new(
+      sio = StringIO.new
+      sio.set_encoding(Encoding::ASCII_8BIT)
+      sio.write(
         @client.raw(
           "/profile/#{profile_id.to_i}/loop/#{loop_view_id.to_i}/document/#{document_id}/#{document_name}.pdf"
         )
       )
+      sio.flush
+      sio.close
+      sio
     end
   end
 end

data/lib/dotloop/loop.rb

@@ -32,19 +32,12 @@ module Dotloop
 
     def detail(profile_id:, loop_view_id:)
       loop_detail = @client.get("/profile/#{profile_id.to_i}/loop/#{loop_view_id.to_i}/detail")
-      loop_detail[:sections] = fixed_sections(loop_detail[:sections])
+      loop_detail[:sections] = Dotloop::Section.new(loop_detail[:sections]).sections if loop_detail[:sections]
       Dotloop::Models::LoopDetail.new(loop_detail)
     end
 
     private
 
-    def fixed_sections(sections)
-      return unless sections
-      sections.each_with_object({}) do |item, memo|
-        memo[item[0].to_s.downcase.tr(' ', '_')] = item[1]
-      end
-    end
-
     def query_params(options)
       {
         batchNumber:         batch_number(options),

data/lib/dotloop/models/section.rb

@@ -2,10 +2,16 @@ module Dotloop
   module Models
     class Section
       include Virtus.model
-      attribute :buying_brokerage, Dotloop::Models::BuyingBrokerage
-      attribute :financials, Dotloop::Models::Financials
-      attribute :listing_brokerage, Dotloop::Models::ListingBrokerage
-      attribute :property_address, Dotloop::Models::PropertyAddress
+      attribute :contract_dates,         Dotloop::Models::Sections::ContractDates
+      attribute :contract_info,          Dotloop::Models::Sections::ContractInfo
+      attribute :financials,             Dotloop::Models::Sections::Financials
+      attribute :geographic_description, Dotloop::Models::Sections::GeographicDescription
+      attribute :listing_information,    Dotloop::Models::Sections::ListingInformation
+      attribute :offer_dates,            Dotloop::Models::Sections::OfferDates
+      attribute :property_address,       Dotloop::Models::Sections::PropertyAddress
+      attribute :property,               Dotloop::Models::Sections::Property
+      attribute :referral,               Dotloop::Models::Sections::Referral
+      attribute :contacts,               Array[Dotloop::Models::Sections::Contact]
     end
   end
 end

data/lib/dotloop/models/sections/contact.rb

@@ -0,0 +1,42 @@
+module Dotloop
+  module Models
+    module Sections
+      class Contact
+        include Virtus.model
+        attribute :role
+        attribute :cell_phone
+        attribute :city
+        attribute :company_name
+        attribute :country
+        attribute :email
+        attribute :fax
+        attribute :id
+        attribute :license
+        attribute :marital_status
+        attribute :name
+        attribute :phone
+        attribute :state_prov
+        attribute :street_name
+        attribute :street_number
+        attribute :unit_number
+        attribute :zip_or_postal_code
+
+        alias_method :home_warranty_company, :company_name
+        alias_method :home_warranty_email, :email
+        alias_method :home_warranty_rep, :name
+        alias_method :inspection_company, :company_name
+        alias_method :inspection_company_rep, :name
+        alias_method :mortgage_company, :company_name
+        alias_method :mortgage_company_email, :email
+        alias_method :mortgage_company_rep, :name
+        alias_method :office_phone, :phone
+        alias_method :postal_code, :zip_or_postal_code
+        alias_method :state_or_province, :state_prov
+        alias_method :suite, :unit_number
+        alias_method :title_company_email, :email
+        alias_method :title_company_rep, :name
+        alias_method :zip_postal_code, :zip_or_postal_code
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/contract_dates.rb

@@ -0,0 +1,11 @@
+module Dotloop
+  module Models
+    module Sections
+      class ContractDates
+        include Virtus.model
+        attribute :contract_date
+        attribute :closing_date
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/contract_info.rb

@@ -0,0 +1,11 @@
+module Dotloop
+  module Models
+    module Sections
+      class ContractInfo
+        include Virtus.model
+        attribute :transaction_number
+        attribute :type
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/financials.rb

@@ -0,0 +1,19 @@
+module Dotloop
+  module Models
+    module Sections
+      class Financials
+        include Virtus.model
+
+        attribute :comission_rate
+        attribute :earnest_money_held_by
+        attribute :purchase_price
+        attribute :earnest_money_amount
+        attribute :sale_commission_total
+        attribute :buy_side_sale_commission_split
+        attribute :sale_commission_split_sell_side
+        attribute :sell_side_sale_commission_split
+        attribute :sale_commission_split_buy_side
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/geographic_description.rb

@@ -0,0 +1,19 @@
+module Dotloop
+  module Models
+    module Sections
+      class GeographicDescription
+        include Virtus.model
+        attribute :addition
+        attribute :block
+        attribute :deed_book
+        attribute :deed_page
+        attribute :lot
+        attribute :map_grid
+        attribute :mls_area
+        attribute :mls_legal_description
+        attribute :section
+        attribute :subdivision
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/listing_information.rb

@@ -0,0 +1,23 @@
+module Dotloop
+  module Models
+    module Sections
+      class ListingInformation
+        include Virtus.model
+        attribute :property_excludes
+        attribute :description_of_other_liens
+        attribute :expiration_date
+        attribute :listing_date
+        attribute :total_encumbrances
+        attribute :property_includes
+        attribute :remarks
+        attribute :current_price
+        attribute :first_mortgage_balance
+        attribute :homeowner_association
+        attribute :second_mortgage_balance
+        attribute :original_listing_price
+        attribute :other_liens
+        attribute :homeowner_association_dues
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/offer_dates.rb

@@ -0,0 +1,13 @@
+module Dotloop
+  module Models
+    module Sections
+      class OfferDates
+        include Virtus.model
+        attribute :offer_date
+        attribute :inspection_date
+        attribute :occupancy_date
+        attribute :offer_expiration_date
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/property.rb

@@ -0,0 +1,16 @@
+module Dotloop
+  module Models
+    module Sections
+      class Property
+        include Virtus.model
+        attribute :bedrooms
+        attribute :year_built
+        attribute :square_footage
+        attribute :type
+        attribute :bathrooms
+        attribute :school_district
+        attribute :lot_size
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/property_address.rb

@@ -0,0 +1,20 @@
+module Dotloop
+  module Models
+    module Sections
+      class PropertyAddress
+        include Virtus.model
+
+        attribute :city
+        attribute :county
+        attribute :unit_number
+        attribute :parcel_tax_id
+        attribute :mls_number
+        attribute :postal_code
+        attribute :property_address_country
+        attribute :state_or_province
+        attribute :street_name
+        attribute :street_number
+      end
+    end
+  end
+end

data/lib/dotloop/models/sections/referral.rb

@@ -0,0 +1,11 @@
+module Dotloop
+  module Models
+    module Sections
+      class Referral
+        include Virtus.model
+        attribute :referral_source
+        attribute :referral_percentage
+      end
+    end
+  end
+end

data/lib/dotloop/section.rb

@@ -0,0 +1,60 @@
+module Dotloop
+  class Section
+    attr_accessor :sections
+    FIXED_SECTIONS = %i(
+      contract_dates contract_info financials geographic_description listing_information
+      offer_dates property_address property referral
+    ).freeze
+
+    def initialize(data)
+      @sections = FIXED_SECTIONS.each_with_object({}) { |key, memo| memo[key] = {} }.merge(contacts: [])
+      parse_data(data)
+    end
+
+    def parse_data(data)
+      fix_hash_keys(data).each { |item| build_section(item[0], item[1]) }
+    end
+
+    private
+
+    def build_section(key, section_data)
+      values = fix_hash_keys(section_data)
+      if FIXED_SECTIONS.include?(key)
+        @sections[key] = values
+      else
+        @sections[:contacts] << build_contact(key, map_contact_keys(values))
+      end
+    end
+
+    def build_contact(key, values)
+      Dotloop::Models::Sections::Contact.new(values.merge(role: key.to_s))
+    end
+
+    def index_to_key(index)
+      index.to_s.downcase.delete(%(')).gsub(/[^a-z]/, '_').squeeze('_').gsub(/^_*/, '').gsub(/_*$/, '').to_sym
+    end
+
+    def fix_hash_keys(bad_hash)
+      bad_hash.each_with_object({}) do |item, memo|
+        memo[index_to_key(item[0])] = item[1]
+      end
+    end
+
+    def map_contact_keys(contact_data)
+      contact_data.each_with_object({}) do |item, memo|
+        key = contact_key_map[item[0].to_sym] || item[0]
+        memo[key] = item[1]
+      end
+    end
+
+    def contact_key_map
+      {
+        home_warranty_company: :company_name, home_warranty_email: :email, home_warranty_rep: :name,
+        inspection_company: :company_name, inspection_company_rep: :name, mortgage_company: :company_name,
+        mortgage_company_email: :email, mortgage_company_rep: :name, office_phone: :phone,
+        postal_code: :zip_or_postal_code, state_or_province: :state_prov, suite: :unit_number,
+        title_company_email: :email, title_company_rep: :name, zip_postal_code: :zip_or_postal_code
+      }
+    end
+  end
+end

data/lib/dotloop/version.rb

@@ -1,3 +1,3 @@
 module Dotloop
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotloop
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Loft47
@@ -30,7 +30,7 @@ cert_chain:
   L+ceZspJWVt3gj8EHk5CVnWGEh6Pk69eo8EuR38vWHXOExU+b14Umj8wjYGjDgmQ
   ULEgdaQHqkQV4C3edSFOUWTGehI=
   -----END CERTIFICATE-----
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -243,27 +243,34 @@ files:
 - lib/dotloop/loop.rb
 - lib/dotloop/loop_activity.rb
 - lib/dotloop/models/admin.rb
-- lib/dotloop/models/buying_brokerage.rb
 - lib/dotloop/models/document.rb
 - lib/dotloop/models/document_activity.rb
 - lib/dotloop/models/employee.rb
-- lib/dotloop/models/financials.rb
 - lib/dotloop/models/folder.rb
-- lib/dotloop/models/listing_brokerage.rb
 - lib/dotloop/models/loop.rb
 - lib/dotloop/models/loop_activity.rb
 - lib/dotloop/models/loop_detail.rb
 - lib/dotloop/models/participant.rb
 - lib/dotloop/models/person.rb
 - lib/dotloop/models/profile.rb
-- lib/dotloop/models/property_address.rb
 - lib/dotloop/models/section.rb
+- lib/dotloop/models/sections/contact.rb
+- lib/dotloop/models/sections/contract_dates.rb
+- lib/dotloop/models/sections/contract_info.rb
+- lib/dotloop/models/sections/financials.rb
+- lib/dotloop/models/sections/geographic_description.rb
+- lib/dotloop/models/sections/listing_information.rb
+- lib/dotloop/models/sections/offer_dates.rb
+- lib/dotloop/models/sections/property.rb
+- lib/dotloop/models/sections/property_address.rb
+- lib/dotloop/models/sections/referral.rb
 - lib/dotloop/models/tag.rb
 - lib/dotloop/models/task.rb
 - lib/dotloop/participant.rb
 - lib/dotloop/person.rb
 - lib/dotloop/profile.rb
 - lib/dotloop/query_param_helpers.rb
+- lib/dotloop/section.rb
 - lib/dotloop/task.rb
 - lib/dotloop/version.rb
 homepage: http://github.com/Loft47/dotloop

data/lib/dotloop/models/buying_brokerage.rb

@@ -1,15 +0,0 @@
-module Dotloop
-  module Models
-    class BuyingBrokerage
-      include Virtus.model
-
-      attribute :city
-      attribute :name
-      attribute :postal_code
-      attribute :state_or_province
-      attribute :street_name
-      attribute :street_number
-      attribute :suite
-    end
-  end
-end

data/lib/dotloop/models/financials.rb

@@ -1,13 +0,0 @@
-module Dotloop
-  module Models
-    class Financials
-      include Virtus.model
-
-      attribute :comission_rate
-      attribute :current_price
-      attribute :earnest_money_held_by
-      attribute :original_listing_price
-      attribute :purchase_price
-    end
-  end
-end

data/lib/dotloop/models/listing_brokerage.rb

@@ -1,15 +0,0 @@
-module Dotloop
-  module Models
-    class ListingBrokerage
-      include Virtus.model
-
-      attribute :city
-      attribute :name
-      attribute :office_phone
-      attribute :postal_code
-      attribute :state_or_province
-      attribute :street_name
-      attribute :street_number
-    end
-  end
-end

data/lib/dotloop/models/property_address.rb

@@ -1,16 +0,0 @@
-module Dotloop
-  module Models
-    class PropertyAddress
-      include Virtus.model
-
-      attribute :city
-      attribute :country
-      attribute :mls_number
-      attribute :postal_code
-      attribute :property_address_country
-      attribute :state_or_province
-      attribute :street_name
-      attribute :street_number
-    end
-  end
-end