doorloop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a9ac995291e0df7e8b3e3ada12ec0823d5371667ffd79639218058bd2816954
+  data.tar.gz: 8793a7c08b2d83d84e81c6dc0a363d76be981ec6a40bc8f6919773c7f9d2605d
+SHA512:
+  metadata.gz: ca8cab8bca74f9c3f6f0ecb996996d7595be0da911e5ad44c47596fa27c380e1ffa605f27da9ddcb4d3432601f5727593a6593476cbcb6286710bfffeb83b92d
+  data.tar.gz: 0fd1a0b37a43ecf046ec970f8be50ffde32bce40efc6071cb62142685be2b0c56b1054aaa63ef7e4636be2dc2365f66fd4a9b470686aaa9d2a01545e0120572e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 3.1.2
+before_install: gem install bundler -v 2.5.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mezbahalam26@gmai.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in doorloop.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    doorloop (0.1.0)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    domain_name (0.6.20240107)
+    hashdiff (1.1.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    mime-types (3.5.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.1205)
+    netrc (0.11.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.9.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+
+DEPENDENCIES
+  doorloop!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.0)
+  webmock (~> 3.19.1)
+
+BUNDLED WITH
+   2.5.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 MezbahAlam
+
+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,54 @@
+# Doorloop
+
+Welcome to Doorloop, an API wrapper gem for the Doorloop API. This gem allows you to easily interact with Doorloop’s API using Ruby, providing a simple and intuitive interface for managing your property management needs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doorloop'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install doorloop
+
+## Usage
+
+To use the Doorloop gem, you need to configure it with your Doorloop API key. You can set it up directly in your code:
+    
+```ruby
+    require 'doorloop'
+    
+    client = DoorLoop::Client.new('your_api_token')
+    
+    # Example: List all accounts
+    response = client.accounts.list
+    puts response
+```
+For detailed usage and API documentation, please refer to the Doorloop API [documentation](https://api.doorloop.com/reference/get-accounts).
+
+
+## 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/mezbahalam/doorloop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/doorloop/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Doorloop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/doorloop/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "doorloop"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/doorloop.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/doorloop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'doorloop'
+  spec.version       = Doorloop::VERSION
+  spec.authors       = ['MezbahAlam']
+  spec.email         = ['mezbahalam26@gmail.com']
+
+  spec.summary       = 'A simple wrapper for the DoorLoop API'
+  spec.description   = 'A Ruby client for the DoorLoop API, allowing easy access to its resources.'
+  spec.homepage      = 'https://github.com/mezbahalam/doorloop'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mezbahalam/doorloop'
+  spec.metadata['changelog_uri'] = 'https://github.com/mezbahalam/doorloop/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client', '~> 2.0'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'webmock', '~> 3.19.1'
+end

data/lib/doorloop/accounts.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DoorLoop
+  class Accounts
+    def initialize(client)
+      @client = client
+    end
+
+
+    def list(options = {})
+      @client.get('accounts', options)
+    end
+
+    def create(params)
+      @client.post('accounts', params)
+    end
+
+    def retrieve(id)
+      @client.get("accounts/#{id}")
+    end
+
+    def update(id, params)
+      @client.put("accounts/#{id}", params)
+    end
+
+    def delete(id)
+      @client.delete("accounts/#{id}")
+    end
+  end
+end
+
+# Example usage
+# client = DoorLoop::Client.new('your_api_token')
+# response = client.accounts.create({ name: 'New Account', active: true, type: 'ASSET_ACCOUNT' })
+# puts response
+# doorloop.accounts.create("active"=>true,  "name"=>"Cable & Internet & Wifi Wifi",  "id"=>"658ef10a55e60d0de105d7c9", "type"=>"EXPENSE_EXPENSE", "description"=> "string")
+# "667ab65df65d881f0bef54fb"
+# >> doorloop.accounts.update("667ab65df65d881f0bef54fb",{"name"=>"Cable & Internet & Wifi", "active" => true,"type"=>"EXPENSE_EXPENSE" })
+#

data/lib/doorloop/client.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'json'
+require 'logger'
+require_relative 'error_handler'
+require_relative 'accounts'
+require_relative 'properties'
+require_relative 'units'
+require_relative 'users'
+require_relative 'leases'
+require_relative 'tenants'
+require_relative 'lease_payments'
+require_relative 'lease_charges'
+require_relative 'lease_returned_payments'
+require_relative 'lease_credits'
+require_relative 'portfolios'
+require_relative 'tasks'
+require_relative 'owners'
+require_relative 'vendors'
+require_relative 'expenses'
+require_relative 'vendor_bills'
+require_relative 'vendor_credits'
+require_relative 'reports'
+require_relative 'communication_logs'
+require_relative 'notes'
+require_relative 'files'
+
+
+module DoorLoop
+  class Client
+    attr_accessor :api_token, :api_base_url, :retry_on_rate_limit, :logger
+
+    def initialize(api_token, api_base_url: 'https://app.doorloop.com/api/', retry_on_rate_limit: false)
+      @api_token = api_token
+      @api_base_url = api_base_url
+      @retry_on_rate_limit = retry_on_rate_limit
+      @logger = Logger.new($stdout)
+      @error_handler = DoorLoop::ErrorHandler.new(@logger, self)
+    end
+
+    def accounts
+      Accounts.new(self)
+    end
+
+    def properties
+      Properties.new(self)
+    end
+
+    def units
+      Units.new(self)
+    end
+
+    def users
+      Users.new(self)
+    end
+
+    def leases
+      Leases.new(self)
+    end
+
+    def tenants
+      Tenants.new(self)
+    end
+
+    def lease_payments
+      LeasePayments.new(self)
+    end
+
+    def lease_returned_payments
+      LeaseReturnedPayments.new(self)
+    end
+
+    def lease_charges
+      LeaseCharges.new(self)
+    end
+
+    def lease_credits
+      LeaseCredits.new(self)
+    end
+
+    def portfolios
+      Portfolios.new(self)
+    end
+
+    def tasks
+      Tasks.new(self)
+    end
+
+    def owners
+      Owners.new(self)
+    end
+
+    def vendors
+      Vendors.new(self)
+    end
+
+    def expenses
+      Expenses.new(self)
+    end
+
+    def vender_bills
+      VendorBills.new(self)
+    end
+
+    def vendor_credits
+      VendorCredits.new(self)
+    end
+
+    def reports
+      Reports.new(self)
+    end
+
+    def notes
+      Notes.new(self)
+    end
+
+    def files
+      Files.new(self)
+    end
+
+    def communication_logs
+      CommunicationLogs.new(self)
+    end
+
+    def get(path, options = {})
+      url = build_url(path, options)
+      response = make_request(url)
+      parse_response(response)
+    end
+
+    def post(path, payload)
+      url = build_url(path)
+      response = make_post_request(url, payload)
+      parse_response(response)
+    end
+
+    def put(path, payload)
+      url = build_url(path)
+      response = make_put_request(url, payload)
+      parse_response(response)
+    end
+
+    def delete(path)
+      url = build_url(path)
+      response = make_delete_request(url)
+      parse_response(response)
+    end
+
+
+    private
+
+    def headers
+      {
+        'Accept' => 'application/json',
+        'Authorization' => "Bearer #{@api_token}",
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def build_url(path, options = {})
+      defaults = { page_number: 1, page_size: 50, sort_by: nil, sort_descending: false }
+      options = defaults.merge(options)
+
+      options.delete(:sort_by) if options[:sort_by].nil?
+      options.delete(:sort_descending) if options[:sort_descending] == false
+
+      uri = URI.join(@api_base_url, path)
+      uri.query = URI.encode_www_form(options) if options.any?
+      uri.to_s
+    rescue StandardError => e
+      @logger.error("Error building URL: #{e.message}")
+      raise DoorLoop::Error, "Error building URL: #{e.message}"
+    end
+
+    def parse_response(response)
+      JSON.parse(response.body)
+    end
+
+    def make_request(url)
+      RestClient.get(url, headers)
+    rescue RestClient::ExceptionWithResponse => e
+      @error_handler.handle(e)
+    end
+
+    def make_post_request(url, payload)
+      RestClient.post(url, payload.to_json, headers)
+    rescue RestClient::ExceptionWithResponse => e
+      @error_handler.handle(e)
+    end
+
+    def make_put_request(url, payload)
+      RestClient.put(url, payload.to_json, headers)
+    rescue RestClient::ExceptionWithResponse => e
+      @logger.error("PUT request failed: #{e.response}")
+      @error_handler.handle(e)
+    end
+
+    def make_delete_request(url)
+      RestClient.delete(url, headers)
+    rescue RestClient::ExceptionWithResponse => e
+      @error_handler.handle(e)
+    end
+  end
+end

data/lib/doorloop/communication_logs.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DoorLoop
+  class CommunicationLogs
+    def initialize(client)
+      @client = client
+    end
+
+    def list(options = {})
+      @client.get('communications', options)
+    end
+
+    def create(params)
+      @client.post('communications', params)
+    end
+
+    def retrieve(id)
+      @client.get("communications/#{id}")
+    end
+
+    def update(id, params)
+      @client.put("communications/#{id}", params)
+    end
+
+    def delete(id)
+      @client.delete("communications/#{id}")
+    end
+  end
+end

data/lib/doorloop/error_handler.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DoorLoop
+  class ErrorHandler
+    def initialize(logger, client)
+      @logger = logger
+      @client = client
+    end
+
+    def handle(exception)
+      case exception.http_code
+      when 401
+        @logger.error('Unauthorized access')
+        raise DoorLoop::UnauthorizedError, 'Unauthorized access'
+      when 403
+        @logger.error('Forbidden access')
+        raise DoorLoop::ForbiddenError, 'Forbidden access'
+      when 404
+        @logger.error('Resource not found')
+        raise DoorLoop::NotFoundError, 'Resource not found'
+      when 429
+        handle_rate_limit(exception)
+      else
+        @logger.error("Unexpected error: #{exception}")
+        raise DoorLoop::Error, "Unexpected error: #{exception}"
+      end
+    end
+
+    def handle_rate_limit(exception)
+      retry_after = exception.response.headers[:retry_after].to_i
+      if @client.retry_on_rate_limit
+        begin
+          @logger.warn("Rate limit exceeded, retrying in #{retry_after} seconds...")
+          sleep(retry_after)
+        rescue DoorLoop::TooManyRequestsError
+          retry
+        end
+      else
+        @logger.warn("Rate limit exceeded, retry after #{retry_after} seconds.")
+        raise DoorLoop::TooManyRequestsError, 'Rate limit exceeded'
+      end
+    end
+  end
+end