dotloop 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c1546dd7b2d96ebbf6b21f0b74477923cb06e75
+  data.tar.gz: f9cfa01fbb2128a9c99fc322db081406a52ade98
+SHA512:
+  metadata.gz: 75e6026d6e94e1b2dee3e8dfe7e64368dd30c61a9c608e29f2b42f48014da1540456261c980643d2ca693254b7a818f1dfdfe926eff220c4362c255a169ca7a2
+  data.tar.gz: 026b931ceaef7577d21b535509c9c393a7e48bcb08810c29cfdeededa09c7117a283bea8ac19bb4e1feac6d90eb972f4a2cc8cd6b4e26f564ba4dc81124b7c40

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,44 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/*.opal'
+    - '**/config.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+    - '**/Berksfile'
+    - '**/Cheffile'
+    - '**/Vagabondfile'
+  Exclude:
+    - '**/Guardfile'
+    - 'db/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'log/**/*'
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15
+Style/RaiseArgs:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/MethodName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.0
+before_install: gem install bundler -v 1.12.0
+notifications:
+  slack:
+    secure: JabcnJlmrkhrrCtDTaqoylYn2dmyUP9h9SO/IyVKrIZ0YvTukaKzU2RSHP6PXjv1WC/9zfrmrWiODBZmg3HciOq4C6g+LdPEGtujx4ULSpztyIm8MlC+uODKtNLR7Q4j9cWTNOi6JKmBWJmo00i7OXLiB3njpEza3or3585vL9ffLJTG/9bi61u/ccuDXBKjqOg2Mxa5sWycgl/kAZ1qTgG76RARWFr6f2Cvxu9LG0BeUq0KpMHKToPjTllmYIKoXKStAX8bLnTU0M1JI5O4uc5W/QOaRhrNgSNyn2LVzHos/8+LO8I4kj+ptMYK037pM3ojByYmQOyE8WL/6kCAJbRN5njyENRUpXrGyWjfF7yDBGA5zMoYgC6MyUWiOj66p12tNTrUVkeFc53uYzlfAg8n331aHj+j+zWuT+oOrn0H9Nx1X4QtJleY6qkPHZO2aF9o7rZIeA7Fn9fGrECUvOQyskBHgHyyWnZ1SpZsRBXKCqlPMyf//RUO9Cx580VSTqgjTCcHa5gAhsoiTl5S9NjsTJCrshRxkj0t1tv2tiCbbTLJ9n309wsI2kj+53S4Q4lXgTV4SQEqrqoO7PldQKPiOZDF2ZOZO0Ou6EBEGcIqL54tWjoKXHpPxMuXW0UrXgl1wl+jhiQTzKBlW4raHLYfaL6u1Yjvo1ZKKTlLseg=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dotloop.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Loft 47
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# DotLoop API Library
+[![Build Status](https://travis-ci.org/Loft47/dotloop.svg?branch=master)](https://travis-ci.org/Loft47/dotloop)
+[![Coverage Status](https://coveralls.io/repos/github/Loft47/dotloop/badge.svg?branch=master&renew=true)](https://coveralls.io/github/Loft47/dotloop?branch=master)
+
+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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dotloop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dotloop
+
+## Usage
+
+Optional parameters are prefixed with a __'*'__'
+    client = Dotloop::Client.new(api_key: 'c4c26918-b2df-49a6-9bc2-9009274b23a7')
+
+    client.Profile.all                                                      #=> get list of profiles
+
+    client.Loop.all(
+      profile_id: '1234',
+      *batch_number: 1,
+      *batch_size: 50,
+      *statusIds: '1,2,3'
+      *complianceStatusIds: '1,2,3'
+      *tagIds: '1,2,3'
+      *sortBy: 'email'
+      *searchQuery: 'test@example.com'
+      *tagNames: 'tag'
+      *createdByMe: '1234567'
+    )                                                                       #=> get list of loops
+
+    client.Loop.all(profile_id: '1234', loop_view_id: '76046')              #=> get basic loop information
+
+    client.Loop.find(profile_id: '1234', loop_view_id: '76046')             #=> get loop details
+    client.LoopActivity.all(
+      profile_id: '1234',
+      loop_view_id: '76046',
+      *batch_number: 1,
+      *batch_size: 50
+    )                                                                       #=> get loop activity
+    client.Document.all(profile_id: '1234', loop_view_id: '76046')          #=> get loop document list
+
+    client.Participant.all(profile_id: '1234', loop_view_id: '76046')       #=> get a list of loop participants
+
+    client.Task.all(profile_id: '1234', loop_view_id: '76046')              #=> get a list of loop tasks
+
+    client.Folder.all(profile_id: '1234', loop_view_id: '76046')            #=> get a list of folders in a loop
+
+    client.Employee.all(
+      profile_id: '1234',
+      *batch_number: 1,
+      *batch_size: 50,
+      *show_admin: true,
+      *show_in_active: true,
+      *include_child: true
+    )                                                                       #=> get a list of users in a profile
+    client.DocumentActivity.all(
+      profile_id: '1234',
+      document_id: '561622',
+      *batch_number: 1,
+      *batch_size: 50
+    )                                                                       #=> get activity details for a document
+    client.Person.all(
+      profile_id: '1234',
+      *batch_number: 1,
+      *batch_size: 50
+    )                                                                       #=> get list of contacts
+    client.Person.find(profile_id: '1234', contact_id: '3603862')           #=> get details for a contact
+
+    client.Admin.all(
+      profile_id: '1234',
+      *batch_number: 1,
+      *batch_size: 50
+    )                                                                       #=> get list of admins for a profile
+
+    client.Document.get(
+      profile_id: '1234',
+      loop_view_id: '76046',
+      document_id: '561622',
+      document_name: 'My Offer'
+    )                                                                       #=> get a PDF document
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dotloop.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dotloop'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/certs/shanedavies.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MRAwDgYDVQQDDAdzZGF2
+aWVzMRYwFAYKCZImiZPyLGQBGRYGbG9mdDQ3MRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTE2MDgwODE5MzAzMloXDTE3MDgwODE5MzAzMlowPzEQMA4GA1UEAwwHc2Rh
+dmllczEWMBQGCgmSJomT8ixkARkWBmxvZnQ0NzETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANbdLELnhjHmoCxtvOy3
+mFcacIzle+eZa9n6a3D3S6mEGC/lO4WF8EePp94qwjMIQhyTWqF/yRwqFkpo+RVl
+QWg5zxfxCM1AOspzaj7zaSpeHyh4KosQVyART60HS0GkFIFOlnQcHqVpwGQcPd4Z
+uekgG0GAqgcj/+ioyDvgDhku5ANSBa4uYwH9OJVYCP5xXlcdxK8KbcxKgMorC2hx
+8hTQH+wTT5T/5j15p9bcOf/Tnm0EjtSoxfDWHJoQLIGNwfJOp/kFZaBxxy4oZq+j
+GzPJff8AZvbs9nTg1AJ/RaCWjM/YEwkjBAf7g/6dm9SMC162nyg4/Yjgze6z6Zt3
+w1cCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFH3o
+0f/0COUk9idtlFf1qCHIvMPRMB0GA1UdEQQWMBSBEnNkYXZpZXNAbG9mdDQ3LmNv
+bTAdBgNVHRIEFjAUgRJzZGF2aWVzQGxvZnQ0Ny5jb20wDQYJKoZIhvcNAQEFBQAD
+ggEBAE2ieglURsx6Rj0HQQw3TZUsurXTpoTfuajK7UjU/n4UatPSMDg663Zp2k+O
+7xv7cQlnn7I0uTpOKMVAiFxHbm01nSaIScyBed1SOsixCaRSjZTm5yq5Pabn4VmC
+y2h5HMXQ6MSbD8oD5cOly6PPo5lhXfPCZ8H7yPbl3Z8i3A4co82TF+5yJxPK7DBM
+WHXFKCoz2zIIOVblPHGnCVm0YVvO354ojsRsqh64WP7e5nT4QhSb+3iQkWuoBcbl
+L+ceZspJWVt3gj8EHk5CVnWGEh6Pk69eo8EuR38vWHXOExU+b14Umj8wjYGjDgmQ
+ULEgdaQHqkQV4C3edSFOUWTGehI=
+-----END CERTIFICATE-----

data/dotloop.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotloop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dotloop'
+  spec.version       = Dotloop::VERSION
+  spec.authors       = ['Loft47']
+  spec.email         = ['support@loft47.com']
+
+  spec.summary       = %(Dotloop library)
+  spec.description   = %(Ruby library for Dotloop API.)
+  spec.homepage      = %(http://github.com/Loft47/dotloop)
+  spec.license       = 'MIT'
+  spec.cert_chain    = ['certs/shanedavies.pem']
+  spec.signing_key   = File.expand_path('~/.ssh/dotloop-private_key.pem') if $0 =~ /gem\z/
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'simplecov', '~> 0.12'
+  spec.add_runtime_dependency 'coveralls', '~> 0.8'
+  spec.add_runtime_dependency 'httparty', '~> 0.13'
+  spec.add_runtime_dependency 'virtus', '~> 1.0'
+  spec.add_runtime_dependency 'plissken', '~> 0.2'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'travis', '~> 1.8'
+end

data/lib/dotloop.rb

@@ -0,0 +1,42 @@
+require 'plissken'
+require 'httparty'
+require 'virtus'
+
+require 'dotloop/version'
+require 'dotloop/client'
+require 'dotloop/query_param_helpers'
+require 'dotloop/profile'
+require 'dotloop/loop'
+require 'dotloop/admin'
+require 'dotloop/document'
+require 'dotloop/document_activity'
+require 'dotloop/employee'
+require 'dotloop/folder'
+require 'dotloop/loop_activity'
+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'
+require 'dotloop/models/employee'
+require 'dotloop/models/folder'
+require 'dotloop/models/loop'
+require 'dotloop/models/loop_activity'
+require 'dotloop/models/participant'
+require 'dotloop/models/person'
+require 'dotloop/models/profile'
+require 'dotloop/models/tag'
+require 'dotloop/models/task'
+
+module Dotloop
+  # Your code goes here...
+end

data/lib/dotloop/admin.rb

@@ -0,0 +1,24 @@
+module Dotloop
+  class Admin
+    include Dotloop::QueryParamHelpers
+    attr_accessor :client
+
+    def initialize(client:)
+      @client = client
+    end
+
+    def all(options = {})
+      admins = []
+      url = "/profile/#{profile_id(options)}/admin"
+      (1..MAX_LOOPS).each do |i|
+        options[:batch_number] = i
+        current_admin = @client.get(url, query_params(options)).map do |admin_attrs|
+          Dotloop::Models::Admin.new(admin_attrs)
+        end
+        admins += current_admin
+        break if current_admin.size < BATCH_SIZE
+      end
+      admins
+    end
+  end
+end

data/lib/dotloop/client.rb

@@ -0,0 +1,89 @@
+module Dotloop
+  class Client
+    include HTTParty
+
+    base_uri 'https://www.dotloop.com/my/api/v1_0/'
+
+    attr_accessor :api_key
+    attr_accessor :application
+
+    def initialize(api_key:, application: 'dotloop')
+      @api_key = api_key
+      @application = application
+      raise 'Please enter an API key' unless @api_key
+    end
+
+    def get(page, params = {})
+      response = raw(page, params)
+      self.class.snakify(response)
+    end
+
+    def raw(page, params = {})
+      response = self.class.get(page, query: params, headers: headers, timeout: 60)
+      raise "Error communicating: Response code #{response.code}" unless response.code == 200
+      response.parsed_response
+    end
+
+    def Profile
+      @profile ||= Dotloop::Profile.new(client: self)
+    end
+
+    def Loop
+      @loop ||= Dotloop::Loop.new(client: self)
+    end
+
+    def Document
+      @document ||= Dotloop::Document.new(client: self)
+    end
+
+    def Participant
+      @participant ||= Dotloop::Participant.new(client: self)
+    end
+
+    def LoopActivity
+      @loop_activity ||= Dotloop::LoopActivity.new(client: self)
+    end
+
+    def Task
+      @task ||= Dotloop::Task.new(client: self)
+    end
+
+    def Folder
+      @folder ||= Dotloop::Folder.new(client: self)
+    end
+
+    def Employee
+      @employee ||= Dotloop::Employee.new(client: self)
+    end
+
+    def DocumentActivity
+      @document_activity ||= Dotloop::DocumentActivity.new(client: self)
+    end
+
+    def Person
+      @person ||= Dotloop::Person.new(client: self)
+    end
+
+    def Admin
+      @admin ||= Dotloop::Admin.new(client: self)
+    end
+
+    def self.snakify(hash)
+      if hash.is_a? Array
+        hash.map(&:to_snake_keys)
+      else
+        hash.to_snake_keys
+      end
+    end
+
+    private
+
+    def headers
+      {
+        'Authorization' => "Bearer #{@api_key}",
+        'User-Agent' => @application,
+        'Accept' => '*/*'
+      }
+    end
+  end
+end