rentvine 0.1.0

data/lib/rentvine/client/portfolios.rb

@@ -0,0 +1,19 @@
+module Rentvine
+  class Client
+    module Portfolios
+      def portfolios(args = {})
+        results = process_request(:get, 'portfolios/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Portfolio.new(result[:portfolio])
+          rvobj.statement_setting = result[:statement_setting]
+          rvobj.last_statement = result[:last_statement]
+          rvobj.meta = { appends: [:statement_setting, :last_statement] }
+          rvobj
+        end
+      end
+      alias list_portfolios portfolios
+    end
+  end
+end

data/lib/rentvine/client/properties.rb

@@ -0,0 +1,49 @@
+module Rentvine
+  class Client
+    module Properties
+      def properties(args = {})
+        results = process_request(:get, 'properties', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Property.new(result[:property]) }
+      end
+      alias list_properties properties
+
+      def property(property_id)
+        result = process_request(:get, "properties/#{property_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Property.new(result[:property])
+      end
+
+      def save_property(property_model)
+        url_to_use = property_model.property_id.nil? ? 'properties' : "properties/#{property_model.property_id}"
+        result = process_request(:post, url_to_use, body: property_model.to_rentvine_hash)
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Property.new(result[:property])
+      end
+
+      def delete_property(property_id)
+        result = process_request(:delete, "properties/#{property_id}")
+        return result if result.is_a?(RentvineError)
+
+        true
+      end
+
+      def activate_property(property_id)
+        result = process_request(:post, "properties/#{property_id}/activate")
+        return result if result.is_a?(RentvineError)
+
+        true
+      end
+
+      def deactivate_property(property_id)
+        result = process_request(:post, "properties/#{property_id}/deactivate")
+        return result if result.is_a?(RentvineError)
+
+        true
+      end
+    end
+  end
+end

data/lib/rentvine/client/tenants.rb

@@ -0,0 +1,13 @@
+module Rentvine
+  class Client
+    module Tenants
+      def tenants(args = {})
+        results = process_request(:get, 'tenants/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Tenant.new(result[:contact]) }
+      end
+      alias list_tenants tenants
+    end
+  end
+end

data/lib/rentvine/client/transaction_entries.rb

@@ -0,0 +1,25 @@
+module Rentvine
+  class Client
+    module TransactionEntries
+      def transaction_entries(args = {})
+        results = process_request(:get, 'accounting/transactions/entries/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::TransactionEntry.new(result[:transaction_entry]) }
+
+        results.map do |result|
+          rvobj = Rentvine::TransactionEntry.new(result[:transaction_entry])
+          rvobj.ledger = Rentvine::Ledger.new(result[:ledger])
+          rvobj.portfolio = Rentvine::Portfolio.new(result[:portfolio])
+          rvobj.primary_ledger = Rentvine::Ledger.new(result[:primary_ledger])
+          rvobj.property = Rentvine::Property.new(result[:property])
+          rvobj.transaction = Rentvine::Transaction.new(result[:transaction])
+          rvobj.unit = Rentvine::Unit.new(result[:unit])
+          rvobj.meta = { appends: [:ledger, :portfolio, :primary_ledger, :property, :transaction, :unit] }
+          rvobj
+        end
+      end
+      alias list_transaction_entries transaction_entries
+    end
+  end
+end

data/lib/rentvine/client/transactions.rb

@@ -0,0 +1,21 @@
+module Rentvine
+  class Client
+    module Transactions
+      def transactions(args = {})
+        results = process_request(:get, 'accounting/transactions/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Transaction.new(result[:transaction])
+          rvobj.ledger = Rentvine::Ledger.new(result[:ledger])
+          rvobj.portfolio = Rentvine::Portfolio.new(result[:portfolio])
+          rvobj.unit = Rentvine::Unit.new(result[:unit])
+          rvobj.transaction_entries = Rentvine::TransactionEntry.new(result[:transaction_entries])
+          rvobj.meta = { appends: [:ledger, :portfolio, :unit, :transaction_entries] }
+          rvobj
+        end
+      end
+      alias list_transactions transactions
+    end
+  end
+end

data/lib/rentvine/client/units.rb

@@ -0,0 +1,20 @@
+module Rentvine
+  class Client
+    module Units
+      def units(property_id, args = {})
+        results = process_request(:get, "properties/#{property_id}/units", params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Unit.new(result[:unit]) }
+      end
+      alias list_units units
+
+      def unit(property_id, unit_id)
+        result = process_request(:get, "properties/#{property_id}/units/#{unit_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::Unit.new(result[:unit])
+      end
+    end
+  end
+end

data/lib/rentvine/client/vendor_trades.rb

@@ -0,0 +1,27 @@
+module Rentvine
+  class Client
+    module VendorTrades
+      def vendor_trades(args = {})
+        results = process_request(:get, 'maintenance/vendor-trades', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::VendorTrade.new(result[:vendor_trade]) }
+      end
+      alias list_vendor_trades vendor_trades
+
+      def vendor_trade(vendor_trade_id)
+        result = process_request(:get, "maintenance/vendor-trades/#{vendor_trade_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::VendorTrade.new(result[:vendor_trade])
+      end
+
+      def save_vendor_trade(vendor_trade_model)
+        result = process_request(:post, '/maintenance/vendor-trades', body: vendor_trade_model.to_rentvine_hash)
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::VendorTrade.new(result[:vendor_trade])
+      end
+    end
+  end
+end

data/lib/rentvine/client/vendors.rb

@@ -0,0 +1,13 @@
+module Rentvine
+  class Client
+    module Vendors
+      def vendors(args = {})
+        results = process_request(:get, 'vendors/search', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::Vendor.new(result[:contact]) }
+      end
+      alias list_vendors vendors
+    end
+  end
+end

data/lib/rentvine/client/work_order_statuses.rb

@@ -0,0 +1,30 @@
+module Rentvine
+  class Client
+    module WorkOrderStatuses
+      def work_order_statuses(args = {})
+        results = process_request(:get, 'maintenance/work-order/statuses', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::WorkOrderStatus.new(result[:work_order_status]) }
+      end
+      alias list_work_order_statuses work_order_statuses
+
+      def work_order_status(work_order_status_id)
+        result = process_request(:get, "maintenance/work-order/statuses/#{work_order_status_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::WorkOrderStatus.new(result[:work_order_status])
+      end
+
+      def save_work_order_status(work_order_status_model)
+        result = process_request(
+          :post, '/maintenance/work-order/statuses',
+          body: work_order_status_model.to_rentvine_hash
+        )
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::WorkOrderStatus.new(result[:work_order_status])
+      end
+    end
+  end
+end

data/lib/rentvine/client/work_orders.rb

@@ -0,0 +1,27 @@
+module Rentvine
+  class Client
+    module WorkOrders
+      def work_orders(args = {})
+        results = process_request(:get, 'maintenance/work-orders', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map { |result| Rentvine::WorkOrder.new(result[:work_order]) }
+      end
+      alias list_work_orders work_orders
+
+      def work_order(work_order_id)
+        result = process_request(:get, "maintenance/work-orders/#{work_order_id}")
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::WorkOrder.new(result[:work_order])
+      end
+
+      def save_work_order(work_order_model)
+        result = process_request(:post, '/maintenance/work-orders', body: work_order_model.to_rentvine_hash)
+        return result if result.is_a?(RentvineError)
+
+        Rentvine::WorkOrder.new(result[:work_order])
+      end
+    end
+  end
+end

data/lib/rentvine/client.rb

@@ -0,0 +1,149 @@
+require_relative 'client/accounts'
+require_relative 'client/applications'
+require_relative 'client/associations'
+require_relative 'client/bills'
+require_relative 'client/diagnostics'
+require_relative 'client/files'
+require_relative 'client/inspections'
+require_relative 'client/leases'
+require_relative 'client/ledgers'
+require_relative 'client/owners'
+require_relative 'client/portfolios'
+require_relative 'client/properties'
+require_relative 'client/tenants'
+require_relative 'client/transaction_entries'
+require_relative 'client/transactions'
+require_relative 'client/units'
+require_relative 'client/vendor_trades'
+require_relative 'client/vendors'
+require_relative 'client/work_order_statuses'
+require_relative 'client/work_orders'
+
+require_relative 'model/rentvine_model'
+require_relative 'model/account'
+require_relative 'model/application'
+require_relative 'model/association'
+require_relative 'model/bill'
+require_relative 'model/diagnostic'
+require_relative 'model/file'
+require_relative 'model/inspection'
+require_relative 'model/lease'
+require_relative 'model/ledger'
+require_relative 'model/owner'
+require_relative 'model/portfolio'
+require_relative 'model/property'
+require_relative 'model/tenant'
+require_relative 'model/transaction_entry'
+require_relative 'model/transaction'
+require_relative 'model/unit'
+require_relative 'model/vendor_trade'
+require_relative 'model/vendor'
+require_relative 'model/work_order_status'
+require_relative 'model/work_order'
+
+module Rentvine
+  class Client
+    include Rentvine::Client::Accounts
+    include Rentvine::Client::Applications
+    include Rentvine::Client::Associations
+    include Rentvine::Client::Bills
+    include Rentvine::Client::Diagnostics
+    include Rentvine::Client::Files
+    include Rentvine::Client::Inspections
+    include Rentvine::Client::Leases
+    include Rentvine::Client::Ledgers
+    include Rentvine::Client::Owners
+    include Rentvine::Client::Portfolios
+    include Rentvine::Client::Properties
+    include Rentvine::Client::Tenants
+    include Rentvine::Client::TransactionEntries
+    include Rentvine::Client::Transactions
+    include Rentvine::Client::Units
+    include Rentvine::Client::VendorTrades
+    include Rentvine::Client::Vendors
+    include Rentvine::Client::WorkOrderStatuses
+    include Rentvine::Client::WorkOrders
+
+    def initialize(auth = nil)
+      @auth = auth || load_from_environment
+
+      if @auth.nil?
+        raise RentvineError, 'API authentication incomplete! You need the account code, api key and api secret.'
+      end
+    end
+
+    private
+
+    def load_from_environment
+      return if ENV['RENTVINE_ACCOUNT_CODE'].nil? || ENV['RENTVINE_API_KEY'].nil? || ENV['RENTVINE_API_SECRET'].nil?
+
+      {
+        account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+        api_key: ENV['RENTVINE_API_KEY'],
+        api_secret: ENV['RENTVINE_API_SECRET']
+      }
+    end
+
+    def process_file(file_path, params)
+      request_params = {
+        method: :post,
+        params: params.to_camelback_keys,
+        headers: {
+          "Content-Type" => "multipart/form-data",
+          'Authorization' => "Basic #{rentvine_basic_auth}"
+        },
+        body: { file: File.open(file_path) }
+      }
+
+      proxy = @auth[:proxy] || ENV['PROXY']
+      request_params[:proxy] = proxy unless proxy.nil?
+
+      response = Typhoeus::Request.new(
+        "https://#{@auth[:account_code]}.rentvine.com/api/manager/files",
+        request_params
+      ).run
+      return RentvineError.new(response) unless response.success?
+
+      process_rentvine_response(response)
+    end
+
+    def process_rentvine_response(response)
+      JSON.parse(response.body, symbolize_names: true).to_snake_keys
+    rescue
+      response.body
+    end
+
+    def process_request(request_type, url_path, options = {})
+      options_params = options[:params] || {}
+      request_params = {
+        method: request_type,
+        params: options_params.to_camelback_keys,
+        headers: rentvine_auth_headers,
+        body: options[:body]&.to_json
+      }
+
+      proxy = @auth[:proxy] || ENV['PROXY']
+      request_params[:proxy] = proxy unless proxy.nil?
+
+      response = Typhoeus::Request.new(
+        "https://#{@auth[:account_code]}.rentvine.com/api/manager/#{url_path}",
+        request_params
+      ).run
+      return RentvineError.new(response) unless response.success?
+
+      process_rentvine_response(response)
+    end
+
+    def rentvine_auth_headers
+      {
+        'Content-Type' => 'application/json',
+        'charset' => 'utf-8',
+        'Authorization' => "Basic #{rentvine_basic_auth}"
+      }
+    end
+
+    def rentvine_basic_auth
+      Base64.strict_encode64("#{@auth[:api_key]}:#{@auth[:api_secret]}")
+    end
+  end
+end

data/lib/rentvine/model/account.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Account < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/application.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Application < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/association.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Association < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/bill.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Bill < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/diagnostic.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Diagnostic < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/file.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class File < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/inspection.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Inspection < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/lease.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Lease < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/ledger.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Ledger < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/owner.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Owner < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/portfolio.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Portfolio < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/property.rb

@@ -0,0 +1,16 @@
+module Rentvine
+  class Property < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+
+    def to_rentvine_hash
+      retval = super()
+      unit = retval.delete(:unit)
+      {
+        property: retval,
+        unit: unit
+      }
+    end
+  end
+end

data/lib/rentvine/model/rentvine_model.rb

@@ -0,0 +1,26 @@
+module Rentvine
+  class RentvineModel < OpenStruct
+    def initialize(data = {})
+      super(data)
+    end
+
+    def to_rentvine_hash
+      data_hash = to_h
+
+      # Remove custom appends from the hash
+      meta&.dig(:appends)&.each { |key| data_hash.delete(key) }
+      data_hash.delete(:meta)
+
+      data_hash = data_hash.to_camelback_keys
+
+      data_hash.keys.each do |key|
+        next if (key.to_s =~ /Id$/).nil?
+
+        new_key = key.to_s.gsub(/Id$/, 'ID')
+        data_hash[new_key.to_sym] = data_hash.delete(key)
+      end
+
+      data_hash.to_camelback_keys
+    end
+  end
+end

data/lib/rentvine/model/tenant.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Tenant < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/transaction.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Transaction < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/transaction_entry.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class TransactionEntry < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/unit.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Unit < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/vendor.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class Vendor < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/vendor_trade.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class VendorTrade < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/work_order.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class WorkOrder < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/model/work_order_status.rb

@@ -0,0 +1,7 @@
+module Rentvine
+  class WorkOrderStatus < RentvineModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/rentvine/rentvine_error.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Rentvine
+  class RentvineError < StandardError
+    attr_reader :error
+    attr_reader :raw
+    attr_reader :response_code
+
+    def initialize(http_response)
+      @raw = http_response
+      @response_code = @raw.response_code
+
+      data = process_response_body
+      if data.nil?
+        set_default_error_message
+      else
+        @error = data
+      end
+    end
+
+    def error?
+      true
+    end
+
+    def to_s
+      return remove_extra_quotes(@error) if @error.is_a?(String)
+
+      retval = @error.each_with_object([]) do |(key, value), str|
+        str_value = value.is_a?(Array) ? value.join(', ') : value
+        str_value = remove_extra_quotes(str_value)
+        str << "#{key}: #{str_value}"
+      end
+      retval.join(', ')
+    end
+    alias message to_s
+
+    private
+
+    def remove_extra_quotes(str)
+      str.tr('"', '')
+    end
+
+    def process_response_body
+      JSON.parse(@raw.body, symbolize_names: true).to_snake_keys unless @raw.body.empty?
+    rescue StandardError
+      @raw.body.strip
+    end
+
+    def set_default_error_message
+      require 'uri'
+      api_path = URI.parse(@raw.effective_url).path
+      @error = "Rentvine API returned an error for #{api_path}."
+
+      if @response_code == 401
+        @error += ' Please check your credentials.'
+      elsif @response_code == 404
+        @error += ' Please check your API path.'
+      end
+    end
+  end
+end