rentvine 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f46b3c038f078ae2b3f258e6dbc823a83e1dadedf69abc468d5ac01c2efdaa0f
-  data.tar.gz: 7eb3580fd56d9ec05aaabeb877b7e26fc100180701292682b662064bf46ae556
+  metadata.gz: a22391298dd007527b72afe3a5ec88163944eb9e539c6f060a0a016f26a586b7
+  data.tar.gz: 82d4c9ce93ac414e3efefb6aff99e385322bef0fd66e20818e61c83e39c7a22b
 SHA512:
-  metadata.gz: 0526fb377f7c87906394a044dafa1dc78c8e32b7899a64536f3415bb1bbc881469e49acac8c20872b395845c77b3e89499c6949e1a2722a3a6d98c0bf22380fe
-  data.tar.gz: 981d03241bf3826b09fc7e83949d97f00ec3c2729ea8bd12f8a1e371548a3dad1646480571b68f5a7b96eb0685233fc2ed489fcb5f9628aa77d8d4afa3b43b16
+  metadata.gz: d55139eee0a55924cc34cd4f793d02b54f23a65bd466d79aa8f347f399742465491107726e18cc1f7ce0072d85118b474cd9fe88b98b09068e28dc4250d76de8
+  data.tar.gz: a96da0ce3459339f1db75fe238d0d965e1a121783bd5939a1c7bc51b18eb8d1042a05b79eca872d948908df0cb25b01124669e79136b2ad6fe0c799a48ccf15c

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-09-19
+
+- Added model for parsing the owner distributions on the portfolio response.
+
+## [0.2.0] - 2024-09-15
+
+- Added export endpoints for properties, units, and leases.
+- Updated examples to show export usage for properties, units, and leases.
+- Added model for lease balances.
+- Added example for lease balances.
+
 ## [0.1.0] - 2024-09-01
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rentvine (0.1.0)
+    rentvine (0.3.0)
       awrence (~> 3.0)
       json (~> 2.7)
       plissken (~> 3.0)

data/examples/balances.rb

@@ -0,0 +1,17 @@
+require 'pry-byebug'
+require_relative '../lib/rentvine'
+
+auth = {
+  account_code: ENV['RENTVINE_ACCOUNT_CODE'],
+  api_key: ENV['RENTVINE_API_KEY'],
+  api_secret: ENV['RENTVINE_API_SECRET']
+}
+rv_client = Rentvine::Client.new(auth)
+
+# =========================================
+# Assocation Examples
+# =========================================
+
+rv_client.export_leaeses.each do |lease_info|
+  puts lease_info.balance.past_due_total_amount
+end

data/examples/owners.rb

@@ -15,3 +15,7 @@ rv_client = Rentvine::Client.new(auth)
 rv_client.owners.each do |owner|
   puts owner.name
 end
+
+rv_client.owners(page: 1, page_size: 5).each do |owner|
+  puts owner.name
+end

data/examples/portfolios.rb

@@ -13,5 +13,5 @@ rv_client = Rentvine::Client.new(auth)
 # =========================================
 
 rv_client.portfolios.each do |portfolio|
-  puts portfolio.name
+  puts [portfolio.portfolio_id, portfolio.name].join(' :: ')
 end

data/examples/properties.rb

@@ -55,21 +55,27 @@ else
   puts new_property_saved_or_rentvine_error.address
 end
 
-puts '---------------------------------'
+# ===========================
 
 property_id = 13
 rv_client.activate_property(13)
 puts 'Property 13 activated'
 
-puts '---------------------------------'
+# ===========================
 
 property_id = 13
 rv_client.deactivate_property(13)
 puts 'Property 13 deactivated'
 
-puts '---------------------------------'
+# ===========================
 
 property_id = new_property_saved_or_rentvine_error.property_id
 rv_client.delete_property(property_id)
 
-puts '---------------------------------'
+# ===========================
+
+rv_client.export_properties.each do |property|
+  puts property.address
+end
+
+# ===========================

data/examples/units.rb

@@ -27,3 +27,9 @@ rvu = rv_client.unit(property_id, unit_id)
 puts rvu.address
 
 # ===========================
+
+rv_client.export_units.each do |unit|
+  puts unit.address
+end
+
+# ===========================

data/lib/rentvine/client/leases.rb

@@ -15,6 +15,23 @@ module Rentvine
 
         Rentvine::Lease.new(result[:lease])
       end
+
+      def export_leaeses(args = {})
+        results = process_request(:get, 'leases/export', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Lease.new(result[:lease])
+          rvobj.balance = Rentvine::Balance.new(result[:balances])
+          rvobj.balances = rvobj.balance
+          rvobj.tenants = result[:lease][:tenants].map { |tenant| Rentvine::Tenant.new(tenant) }
+          rvobj.property = Rentvine::Property.new(result[:property])
+          rvobj.unit = Rentvine::Unit.new(result[:unit])
+          rvobj.portfolio = Rentvine::Unit.new(result[:portfolio])
+          rvobj.meta = { appends: [:balances, :balance, :tenants, :property, :unit, :portfolio] }
+          rvobj
+        end
+      end
     end
   end
 end

data/lib/rentvine/client/portfolios.rb

@@ -6,10 +6,20 @@ module Rentvine
         return results if results.is_a?(RentvineError)
 
         results.map do |result|
+          contacts_str = result[:portfolio].delete(:contacts)
           rvobj = Rentvine::Portfolio.new(result[:portfolio])
+
+          begin
+            rvobj.owner_distributions = process_rentvine_response(contacts_str).map do |owner|
+              Rentvine::OwnerDistribution.new(owner)
+            end
+          rescue
+            rvobj.owner_distributions = contacts_str
+          end
+
           rvobj.statement_setting = result[:statement_setting]
           rvobj.last_statement = result[:last_statement]
-          rvobj.meta = { appends: [:statement_setting, :last_statement] }
+          rvobj.meta = { appends: [:owner_distributions, :statement_setting, :last_statement] }
           rvobj
         end
       end

data/lib/rentvine/client/properties.rb

@@ -44,6 +44,18 @@ module Rentvine
 
         true
       end
+
+      def export_properties(args = {})
+        results = process_request(:get, 'properties/export', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Property.new(result[:property])
+          rvobj.portfolio = Rentvine::Portfolio.new(result[:portfolio])
+          rvobj.meta = { appends: [:portfolio] }
+          rvobj
+        end
+      end
     end
   end
 end

data/lib/rentvine/client/units.rb

@@ -15,6 +15,18 @@ module Rentvine
 
         Rentvine::Unit.new(result[:unit])
       end
+
+      def export_units(args = {})
+        results = process_request(:get, 'properties/units/export', params: args)
+        return results if results.is_a?(RentvineError)
+
+        results.map do |result|
+          rvobj = Rentvine::Unit.new(result[:unit])
+          rvobj.property = Rentvine::Property.new(result[:property])
+          rvobj.meta = { appends: [:property] }
+          rvobj
+        end
+      end
     end
   end
 end

data/lib/rentvine/client.rb

@@ -23,6 +23,7 @@ require_relative 'model/rentvine_model'
 require_relative 'model/account'
 require_relative 'model/application'
 require_relative 'model/association'
+require_relative 'model/balance'
 require_relative 'model/bill'
 require_relative 'model/diagnostic'
 require_relative 'model/file'
@@ -30,6 +31,7 @@ require_relative 'model/inspection'
 require_relative 'model/lease'
 require_relative 'model/ledger'
 require_relative 'model/owner'
+require_relative 'model/owner_distribution'
 require_relative 'model/portfolio'
 require_relative 'model/property'
 require_relative 'model/tenant'
@@ -104,13 +106,13 @@ module Rentvine
       ).run
       return RentvineError.new(response) unless response.success?
 
-      process_rentvine_response(response)
+      process_rentvine_response(response.body)
     end
 
-    def process_rentvine_response(response)
-      JSON.parse(response.body, symbolize_names: true).to_snake_keys
+    def process_rentvine_response(response_body)
+      JSON.parse(response_body, symbolize_names: true).to_snake_keys
     rescue
-      response.body
+      response_body
     end
 
     def process_request(request_type, url_path, options = {})
@@ -131,7 +133,7 @@ module Rentvine
       ).run
       return RentvineError.new(response) unless response.success?
 
-      process_rentvine_response(response)
+      process_rentvine_response(response.body)
     end
 
     def rentvine_auth_headers

data/lib/rentvine/model/balance.rb

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

data/lib/rentvine/model/owner_distribution.rb

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

data/lib/rentvine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rentvine
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rentvine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Wes Hays
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -90,6 +90,7 @@ files:
 - examples/accounts.rb
 - examples/applications.rb
 - examples/associations.rb
+- examples/balances.rb
 - examples/bills.rb
 - examples/diagnostics.rb
 - examples/files.rb
@@ -133,6 +134,7 @@ files:
 - lib/rentvine/model/account.rb
 - lib/rentvine/model/application.rb
 - lib/rentvine/model/association.rb
+- lib/rentvine/model/balance.rb
 - lib/rentvine/model/bill.rb
 - lib/rentvine/model/diagnostic.rb
 - lib/rentvine/model/file.rb
@@ -140,6 +142,7 @@ files:
 - lib/rentvine/model/lease.rb
 - lib/rentvine/model/ledger.rb
 - lib/rentvine/model/owner.rb
+- lib/rentvine/model/owner_distribution.rb
 - lib/rentvine/model/portfolio.rb
 - lib/rentvine/model/property.rb
 - lib/rentvine/model/rentvine_model.rb