dotloop_api 0.1.0

data/lib/dotloop_api/end_points/detail.rb

@@ -0,0 +1,28 @@
+module DotloopApi
+  module EndPoints
+    class Detail < DotloopApi::EndPoints::Base
+      attr_accessor :profile_id
+      attr_accessor :loop_id
+      undef_method :all
+      undef_method :create
+      undef_method :delete
+      def initialize(client:, profile_id: nil, loop_id: nil)
+        @profile_id = profile_id
+        @loop_id = loop_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::Loop::Detail)
+      end
+
+      def find
+        build_model(@client.get(path)[:data])
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop/#{@loop_id}/detail"
+      end
+
+      def build_model(attrs)
+        super(fix_hash(attrs))
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/document.rb

@@ -0,0 +1,25 @@
+module DotloopApi
+  module EndPoints
+    class Document < DotloopApi::EndPoints::Base
+      attr_accessor :profile_id
+      attr_accessor :loop_id
+      attr_accessor :folder_id
+      undef_method :create
+      undef_method :delete
+      def initialize(client:, profile_id: nil, loop_id: nil, folder_id: nil)
+        @profile_id = profile_id
+        @loop_id = loop_id
+        @folder_id = folder_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::Loop::Folder::Document)
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop/#{@loop_id}/folder/#{@folder_id}/document"
+      end
+
+      def download(id:)
+        @client.download(single_path(id))
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/folder.rb

@@ -0,0 +1,32 @@
+module DotloopApi
+  module EndPoints
+    class Folder < DotloopApi::EndPoints::Base
+      attr_accessor :profile_id
+      attr_accessor :loop_id
+      undef_method :delete
+
+      def initialize(client:, profile_id: nil, loop_id: nil)
+        @profile_id = profile_id
+        @loop_id = loop_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::Loop::Folder)
+      end
+
+      def all(options = {})
+        options_to_params(options)
+        @client.get(path, @params)[:data].map { |attrs| build_model(attrs) }
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop/#{@loop_id}/folder"
+      end
+
+      private
+
+      def options_to_params(options)
+        @params = {
+          include_documents: options.key?(:include_documents) ? options[:include_documents] : true
+        }
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/loop.rb

@@ -0,0 +1,17 @@
+module DotloopApi
+  module EndPoints
+    class Loop < DotloopApi::EndPoints::Batch
+      attr_accessor :profile_id
+      undef_method :delete
+
+      def initialize(client:, profile_id: nil)
+        @profile_id = profile_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::Loop)
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop"
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/loop_template.rb

@@ -0,0 +1,19 @@
+module DotloopApi
+  module EndPoints
+    class LoopTemplate < DotloopApi::EndPoints::Base
+      attr_accessor :profile_id
+      undef_method :save
+      undef_method :create
+      undef_method :delete
+
+      def initialize(client:, profile_id: nil)
+        @profile_id = profile_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::LoopTemplate)
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop-template"
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/model_builder.rb

@@ -0,0 +1,65 @@
+module DotloopApi
+  module EndPoints
+    module ModelBuilder
+      def build_model(attrs)
+        model = @type.new(fix_nested_attributes(attrs))
+        model.client = @client if model.respond_to?(:client)
+        model.profile_id = @profile_id if model.respond_to?(:profile_id)
+        model.loop_id = @loop_id if model.respond_to?(:loop_id)
+        model.folder_id = @folder_id if model.respond_to?(:folder_id)
+        model
+      end
+
+      def build_documents(attrs)
+        attrs['documents'].map do |doc_attrs|
+          doc = DotloopApi::Models::Profile::Loop::Folder::Document.new(doc_attrs)
+          doc.client = @client
+          doc.profile_id = @profile_id
+          doc.loop_id = @loop_id
+          doc.folder_id = attrs['id']
+          doc
+        end
+      end
+
+      def build_details(attrs)
+        data = fix_hash(attrs)
+        data.keys.each_with_object({}) do |key, memo|
+          memo[key] = detail_model(key).new(data[key])
+        end
+      end
+
+      private
+
+      def fix_nested_attributes(attrs)
+        attrs['details'] = build_details(attrs['details']) if attrs.key?('details')
+        attrs['documents'] = build_documents(attrs) if attrs.key?('documents')
+        attrs
+      end
+
+      def fix_hash(hash)
+        hash.each_with_object({}) do |(key, value), memo|
+          new_key = fix_key(key)
+          memo[new_key] = value.is_a?(Hash) ? fix_hash(value) : value
+        end
+      end
+
+      def fix_key(index)
+        index
+          .to_s
+          .delete("'")
+          .gsub('#', 'Number')
+          .gsub('%', 'Percent')
+          .gsub('$', 'Dollar')
+          .downcase
+          .gsub(/[^a-z]/, '_')
+          .squeeze('_')
+          .gsub(/^_*/, '')
+          .to_sym
+      end
+
+      def detail_model(key)
+        "DotloopApi::Models::Profile::Loop::Detail::#{key.to_s.camelize}".constantize
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/param_helper.rb

@@ -0,0 +1,60 @@
+module DotloopApi
+  module EndPoints
+    class ParamHelper
+      include Virtus.model
+      attribute :batch_number, Integer, default: 1
+      attribute :batch_size, Integer, default: 100
+      attribute :filter
+      attribute :include_details, Boolean, default: false
+      attribute :sort_key
+      attribute :sort_direction, String, default: 'asc'
+
+      MAX_BATCH_SIZE = 100
+      FILTER_OPTIONS = %w[
+        updated_min created_min transaction_type transaction_status
+      ].freeze
+
+      def params
+        {
+          batch_number: @batch_number.to_i,
+          batch_size: size,
+          filter: filter_hash,
+          include_details: @include_details,
+          sort: sort
+        }.delete_if { |_, v| should_delete(v) }
+      end
+
+      private
+
+      def size
+        [@batch_size.to_i, MAX_BATCH_SIZE].min
+      end
+
+      def sort
+        return unless sort_key_valid?
+        "#{@sort_key}:#{direction}"
+      end
+
+      def direction
+        @sort_direction == 'asc' ? :asc : :desc
+      end
+
+      def sort_key_valid?
+        %w[
+          address closing_date created default expiration_date
+          listing_date purchase_price review_submission_date updated
+        ].include? @sort_key
+      end
+
+      def should_delete(value)
+        value.nil? ||
+          (value.is_a?(Integer) && value.zero?) ||
+          ((value.is_a?(String) || value.is_a?(Hash)) && value.empty?)
+      end
+
+      def filter_hash
+        (@filter.to_s.split('&').map { |var| var.split('=') }).to_h.slice(*FILTER_OPTIONS)
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/participant.rb

@@ -0,0 +1,22 @@
+module DotloopApi
+  module EndPoints
+    class Participant < DotloopApi::EndPoints::Base
+      attr_accessor :profile_id
+      attr_accessor :loop_id
+
+      def initialize(client:, profile_id: nil, loop_id: nil)
+        @profile_id = profile_id
+        @loop_id = loop_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::Loop::Participant)
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop/#{@loop_id}/participant"
+      end
+
+      def build_model(attrs)
+        super(fix_hash(attrs))
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/profile.rb

@@ -0,0 +1,10 @@
+module DotloopApi
+  module EndPoints
+    class Profile < DotloopApi::EndPoints::Base
+      undef_method :delete
+      def initialize(client:)
+        super(client: client, path: '/profile', type: DotloopApi::Models::Profile)
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/task.rb

@@ -0,0 +1,23 @@
+module DotloopApi
+  module EndPoints
+    class Task < DotloopApi::EndPoints::Base
+      attr_accessor :profile_id
+      attr_accessor :loop_id
+      attr_accessor :task_list_id
+      undef_method :save
+      undef_method :create
+      undef_method :delete
+
+      def initialize(client:, profile_id: nil, loop_id: nil, task_list_id: nil)
+        @profile_id = profile_id
+        @loop_id = loop_id
+        @task_list_id = task_list_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::Loop::TaskList::Task)
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop/#{@loop_id}/tasklist/#{@task_list_id}/task"
+      end
+    end
+  end
+end

data/lib/dotloop_api/end_points/task_list.rb

@@ -0,0 +1,21 @@
+module DotloopApi
+  module EndPoints
+    class TaskList < DotloopApi::EndPoints::Base
+      attr_accessor :profile_id
+      attr_accessor :loop_id
+      undef_method :save
+      undef_method :create
+      undef_method :delete
+
+      def initialize(client:, profile_id: nil, loop_id: nil)
+        @profile_id = profile_id
+        @loop_id = loop_id
+        super(client: client, path: path, type: DotloopApi::Models::Profile::Loop::TaskList)
+      end
+
+      def path
+        "/profile/#{@profile_id}/loop/#{@loop_id}/tasklist"
+      end
+    end
+  end
+end

data/lib/dotloop_api/exceptions.rb

@@ -0,0 +1,25 @@
+module DotloopApi
+  class BadRequest < StandardError; end
+  class Forbidden < StandardError; end
+  class MissingRefreshToken < StandardError; end
+  class MissingRevokeToken < StandardError; end
+  class NotFound < StandardError; end
+  class NotImplemented < StandardError; end
+  class TooManyRequests < StandardError; end
+  class Unauthorized < StandardError; end
+  class UnmatchState < StandardError; end
+  class UnprocessableEntity < StandardError; end
+  class CodeMap
+    def self.call(code)
+      return if code == 200
+      {
+        400 => DotloopApi::BadRequest,
+        401 => DotloopApi::Unauthorized,
+        403 => DotloopApi::Forbidden,
+        404 => DotloopApi::NotFound,
+        422 => DotloopApi::UnprocessableEntity,
+        429 => DotloopApi::TooManyRequests
+      }.fetch(code, StandardError)
+    end
+  end
+end

data/lib/dotloop_api/models/config.rb

@@ -0,0 +1,18 @@
+module DotloopApi
+  module Models
+    class Config
+      include Virtus.model
+      attribute :access_token
+      attribute :application, String, default: 'dotloop'
+      attribute :client_id, String, required: true
+      attribute :client_secret, String, required: true
+      attribute :expires_in
+      attribute :redirect_on_deny, Boolean, default: true
+      attribute :redirect_uri, String
+      attribute :refresh_token
+      attribute :scope, String
+      attribute :state, String
+      attribute :token_type, String
+    end
+  end
+end

data/lib/dotloop_api/models/contact.rb

@@ -0,0 +1,38 @@
+module DotloopApi
+  module Models
+    class Contact
+      ROLE_TYPES = %w[
+        ADMIN APPRAISER BUYER BUYER_ATTORNEY BUYING_AGENT BUYING_BROKER
+        ESCROW_TITLE_REP HOME_IMPROVEMENT_SPECIALIST HOME_INSPECTOR
+        HOME_SECURITY_PROVIDER HOME_WARRANTY_REP INSPECTOR INSURANCE_REP
+        LANDLORD LISTING_AGENT LISTING_BROKER LOAN_OFFICER LOAN_PROCESSOR
+        MANAGING_BROKER MOVING_STORAGE OTHER PROPERTY_MANAGER SELLER
+        SELLER_ATTORNEY TENANT TENANT_AGENT TRANSACTION_COORDINATOR
+        UTILITIES_PROVIDER
+      ].freeze
+      include Virtus.model
+      attribute :address
+      attribute :cell_phone
+      attribute :city
+      attribute :company_name
+      attribute :country
+      attribute :email
+      attribute :fax
+      attribute :first_name
+      attribute :home
+      attribute :id, Integer
+      attribute :last_name
+      attribute :license_number
+      attribute :office
+      attribute :phone
+      attribute :role
+      attribute :state
+      attribute :state_prov
+      attribute :street_name
+      attribute :street_number
+      attribute :updated, Time
+      attribute :zip_code
+      attribute :zip_postal_code
+    end
+  end
+end

data/lib/dotloop_api/models/profile/loop/activity.rb

@@ -0,0 +1,13 @@
+module DotloopApi
+  module Models
+    class Profile
+      class Loop
+        class Activity
+          include Virtus.model
+          attribute :date, Time
+          attribute :message
+        end
+      end
+    end
+  end
+end

data/lib/dotloop_api/models/profile/loop/detail.rb

@@ -0,0 +1,129 @@
+module DotloopApi
+  module Models
+    class Profile
+      class Loop
+        class Detail
+          include Virtus.model
+          attribute :contract_dates, DotloopApi::Models::Profile::Loop::Detail::ContractDates
+          attribute :contract_info, DotloopApi::Models::Profile::Loop::Detail::ContractInfo
+          attribute :financials, DotloopApi::Models::Profile::Loop::Detail::Financials
+          attribute :geographic_description, DotloopApi::Models::Profile::Loop::Detail::GeographicDescription
+          attribute :listing_information, DotloopApi::Models::Profile::Loop::Detail::ListingInformation
+          attribute :offer_dates, DotloopApi::Models::Profile::Loop::Detail::OfferDates
+          attribute :property_address, DotloopApi::Models::Profile::Loop::Detail::PropertyAddress
+          attribute :property, DotloopApi::Models::Profile::Loop::Detail::Property
+          attribute :referral, DotloopApi::Models::Profile::Loop::Detail::Referral
+          attr_accessor :client
+          attr_accessor :profile_id
+          attr_accessor :loop_id
+
+          def save
+            DotloopApi::EndPoints::Detail.new(
+              client: client, profile_id: profile_id, loop_id: loop_id
+            ).save(self)
+          end
+
+          class ContractDates
+            include Virtus.model
+            attribute :contract_agreement_date
+            attribute :closing_date
+          end
+
+          class ContractInfo
+            include Virtus.model
+            attribute :transaction_number
+            attribute :start_date
+            attribute :end_date
+          end
+
+          class Financials
+            include Virtus.model
+            attribute :earnest_money_amount
+            attribute :earnest_money_held_by
+            attribute :purchase_sale_price
+            attribute :sale_commission_rate
+            attribute :sale_commission_split_dollar_buy_side
+            attribute :sale_commission_split_dollar_sell_side
+            attribute :sale_commission_split_percent_buy_side
+            attribute :sale_commission_split_percent_sell_side
+            attribute :sale_commission_total
+          end
+
+          class GeographicDescription
+            include Virtus.model
+            attribute :addition
+            attribute :block
+            attribute :deed_book
+            attribute :deed_page
+            attribute :lot
+            attribute :map_grid
+            attribute :mls_area
+            attribute :legal_description
+            attribute :section
+            attribute :subdivision
+          end
+
+          class ListingInformation
+            include Virtus.model
+            attribute :current_price
+            attribute :description_of_other_liens
+            attribute :expiration_date
+            attribute :first_mortgage_balance
+            attribute :homeowner_association
+            attribute :homeowner_association_dues
+            attribute :listing_date
+            attribute :original_price
+            attribute :other_liens
+            attribute :property_excludes
+            attribute :property_includes
+            attribute :remarks
+            attribute :second_mortgage_balance
+            attribute :total_encumbrances
+          end
+
+          class Participant < DotloopApi::Models::Contact; end
+
+          class OfferDates
+            include Virtus.model
+            attribute :offer_date
+            attribute :inspection_date
+            attribute :occupancy_date
+            attribute :offer_expiration_date
+          end
+
+          class Property
+            include Virtus.model
+            attribute :bathrooms
+            attribute :bedrooms
+            attribute :lot_size
+            attribute :school_d
+            attribute :square_footage
+            attribute :type
+            attribute :year_built
+          end
+
+          class PropertyAddress
+            include Virtus.model
+            attribute :city
+            attribute :country
+            attribute :county
+            attribute :mls_number
+            attribute :parcel_tax_id
+            attribute :postal_code
+            attribute :property_address_country
+            attribute :state_or_province
+            attribute :street_name
+            attribute :street_number
+            attribute :unit_number
+          end
+
+          class Referral
+            include Virtus.model
+            attribute :referral_source
+            attribute :referral_percentage
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dotloop_api/models/profile/loop/folder/document.rb

@@ -0,0 +1,27 @@
+module DotloopApi
+  module Models
+    class Profile
+      class Loop
+        class Folder
+          class Document
+            include Virtus.model
+            attribute :created, Time
+            attribute :id, Integer
+            attribute :name
+            attribute :updated, Time
+            attr_accessor :client
+            attr_accessor :profile_id
+            attr_accessor :loop_id
+            attr_accessor :folder_id
+
+            def download
+              DotloopApi::EndPoints::Document.new(
+                client: client, profile_id: profile_id, loop_id: loop_id, folder_id: folder_id
+              ).download(id: @id)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dotloop_api/models/profile/loop/folder.rb

@@ -0,0 +1,25 @@
+module DotloopApi
+  module Models
+    class Profile
+      class Loop
+        class Folder
+          include Virtus.model
+          attribute :name
+          attribute :id, Integer
+          attribute :created, Time
+          attribute :updated, Time
+          attribute :documents, Array[DotloopApi::Models::Profile::Loop::Folder::Document]
+          attr_accessor :client
+          attr_accessor :profile_id
+          attr_accessor :loop_id
+
+          def document_list
+            @docuements = DotloopApi::EndPoints::Document.new(
+              client: client, profile_id: profile_id, loop_id: loop_id, folder_id: id
+            ).all
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dotloop_api/models/profile/loop/participant.rb

@@ -0,0 +1,9 @@
+# module DotloopApi
+#   module Models
+#     class Profile
+#       class Loop
+#         class Participant; end
+#       end
+#     end
+#   end
+# end

data/lib/dotloop_api/models/profile/loop/tasklist/task.rb

@@ -0,0 +1,16 @@
+module DotloopApi
+  module Models
+    class Profile
+      class Loop
+        class TaskList
+          class Task
+            include Virtus.model
+            attribute :due, Time
+            attribute :id, Integer
+            attribute :name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dotloop_api/models/profile/loop/tasklist.rb

@@ -0,0 +1,22 @@
+module DotloopApi
+  module Models
+    class Profile
+      class Loop
+        class TaskList
+          include Virtus.model
+          attribute :id, Integer
+          attribute :name
+          attr_accessor :client
+          attr_accessor :loop_id
+          attr_accessor :profile_id
+
+          def tasks
+            DotloopApi::EndPoints::Task.new(
+              client: client, profile_id: profile_id, loop_id: loop_id, task_list_id: id
+            ).all
+          end
+        end
+      end
+    end
+  end
+end