rentlinx 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d19f3bb23c3ab1ca16eebdb00ec239267df0722
-  data.tar.gz: 2ef514311063b7ab1f28e7ce1e4f6afc9b74f460
+  metadata.gz: 19357d100a6d1f9831a34874d338e756b6e85750
+  data.tar.gz: ae7d1c3cba03207c61fb12dc74497aeb227419c3
 SHA512:
-  metadata.gz: a89c42aeb4127cbf48554f51dfdc4c3e663141c665bcf7139f54bab5590eed5cd4ae3c594e5a020a502cf43d6808042a898bb7c62f2e9d7528159a282a90d4ee
-  data.tar.gz: 1101bd08295be7edb2149f4753da148ee0b8681e742fcac8d9a99dd7ea4a34b7f9a6f0be06dc5e5d528a6bb01282835da3b2dbc988b3e35ba14c3f03b2e3be39
+  metadata.gz: db9dc683bd829ca60ffa8d73078824591503cc06ceba242c5b0c252fd5edb1f49bb170ea6febb4c706a0372453ee3418d599734465b4c62bce6a5c4f49001990
+  data.tar.gz: 8764af15461fd1d0311ddaa14e878cfc0c045222f6e82c0bfef42078d921d21dd3da0c937afff59eb2ccc09b78ebd68bdbb37e7876f406492ef53e5ca72292c2

data/lib/rentlinx.rb

@@ -4,6 +4,10 @@ require 'rentlinx/errors'
 require 'rentlinx/models/base'
 require 'rentlinx/models/property'
 require 'rentlinx/models/unit'
+require 'rentlinx/models/property_photo'
+require 'rentlinx/models/unit_photo'
+require 'rentlinx/models/property_amenity'
+require 'rentlinx/models/unit_amenity'
 
 module Rentlinx
   @username = nil

data/lib/rentlinx/client.rb

@@ -2,9 +2,18 @@ require 'httpclient'
 require 'json'
 require 'uri'
 require 'rentlinx/default'
+require 'rentlinx/modules/property_client_methods'
+require 'rentlinx/modules/unit_client_methods'
+require 'rentlinx/modules/photo_client_methods'
+require 'rentlinx/modules/amenity_client_methods'
 
 module Rentlinx
   class Client
+    include Rentlinx::PropertyClientMethods
+    include Rentlinx::UnitClientMethods
+    include Rentlinx::PhotoClientMethods
+    include Rentlinx::AmenityClientMethods
+
     def initialize
       raise Rentlinx::NotConfigured if Rentlinx.username.nil? ||
                                        Rentlinx.password.nil? ||
@@ -49,13 +58,6 @@ module Rentlinx
       end
     end
 
-    def get_units_for_property_id(id)
-      data = request('GET', "properties/#{id}/units")['data']
-      data.map do |unit_data|
-        Unit.new(symbolize_data(unit_data))
-      end
-    end
-
     private
 
     def process_get(route)
@@ -72,24 +74,6 @@ module Rentlinx
       data
     end
 
-    def post_property(prop)
-      return false unless prop.valid?
-      request('PUT', "properties/#{prop.propertyID}", prop.to_hash)
-    end
-
-    def post_unit(unit)
-      return false unless unit.valid?
-      request('PUT', "units/#{unit.unitID}", unit.to_hash)
-    end
-
-    def unpost_property(id)
-      request('DELETE', "properties/#{id}")
-    end
-
-    def unpost_unit(id)
-      request('DELETE', "units/#{id}")
-    end
-
     def authenticate(username, password)
       data = { username: username, password: password }
       response = request('POST', 'authentication/login', data)

data/lib/rentlinx/models/base.rb

@@ -20,10 +20,6 @@ module Rentlinx
       self.class::REQUIRED_ATTRIBUTES
     end
 
-    def required_attributes_for_post
-      self.class::REQUIRED_ATTRIBUTES_FOR_POST
-    end
-
     def post
       Rentlinx.client.post(self)
     end
@@ -40,10 +36,6 @@ module Rentlinx
       Rentlinx.client.get(type.to_sym, id)
     end
 
-    def get_units_for_property_id(id)
-      Rentlinx.client.get_units_for_property_id(id)
-    end
-
     def to_hash
       {}.tap do |hash|
         attributes.each do |at|
@@ -56,10 +48,6 @@ module Rentlinx
       error_messages.empty?
     end
 
-    def valid_for_post?
-      required_attributes_for_post.none? { |at| blank?(send(at)) }
-    end
-
     def error_messages
       @processor = AttributeProcessor.new(to_hash)
       @processor.process

data/lib/rentlinx/models/property.rb

@@ -1,3 +1,5 @@
+require 'rentlinx/modules/photoable'
+
 module Rentlinx
   class Property < Base
     ATTRIBUTES = [:companyID, :propertyID, :description, :address, :city, :state,
@@ -9,8 +11,6 @@ module Rentlinx
     REQUIRED_ATTRIBUTES = [:propertyID, :address, :city, :state, :zip,
                            :phoneNumber, :emailAddress]
 
-    REQUIRED_ATTRIBUTES_FOR_POST = REQUIRED_ATTRIBUTES + [:companyID, :companyName]
-
     attr_accessor(*ATTRIBUTES)
 
     def post_with_units
@@ -32,5 +32,16 @@ module Rentlinx
     def self.from_id(id)
       get_from_id(:property, id)
     end
+
+    include Rentlinx::Photoable
+    def photo_class
+      Rentlinx::PropertyPhoto
+    end
+
+    private
+
+    def get_units_for_property_id(id)
+      Rentlinx.client.get_units_for_property_id(id)
+    end
   end
 end

data/lib/rentlinx/models/property_amenity.rb

@@ -0,0 +1,13 @@
+module Rentlinx
+  class PropertyAmenity < Base
+    ATTRIBUTES = [:details, :name, :propertyID]
+
+    REQUIRED_ATTRIBUTES = [:name, :propertyID]
+
+    attr_accessor(*ATTRIBUTES)
+
+    def to_hash
+      { details: details, name: name }
+    end
+  end
+end

data/lib/rentlinx/models/property_photo.rb

@@ -0,0 +1,13 @@
+module Rentlinx
+  class PropertyPhoto < Base
+    ATTRIBUTES = [:url, :caption, :position, :propertyID, :unitID]
+
+    REQUIRED_ATTRIBUTES = [:url, :propertyID]
+
+    attr_accessor(*ATTRIBUTES)
+
+    def to_hash
+      { url: url, caption: caption }
+    end
+  end
+end

data/lib/rentlinx/models/unit.rb

@@ -1,3 +1,5 @@
+require 'rentlinx/modules/photoable'
+
 module Rentlinx
   class Unit < Base
     ATTRIBUTES = [:unitID, :propertyID, :name, :description, :rent, :maxRent,
@@ -9,10 +11,17 @@ module Rentlinx
 
     REQUIRED_ATTRIBUTES = [:unitID]
 
-    REQUIRED_ATTRIBUTES_FOR_POST = REQUIRED_ATTRIBUTES + [:propertyID]
-
     attr_accessor(*ATTRIBUTES)
 
+    include Rentlinx::Photoable
+    def photo_class
+      Rentlinx::UnitPhoto
+    end
+
+    def photos
+      super.select { |p| p.unitID == unitID }
+    end
+
     def self.from_id(id)
       get_from_id(:unit, id)
     end

data/lib/rentlinx/models/unit_amenity.rb

@@ -0,0 +1,9 @@
+module Rentlinx
+  class UnitAmenity < PropertyAmenity
+    ATTRIBUTES += [:unitID]
+
+    REQUIRED_ATTRIBUTES += [:unitID]
+
+    attr_accessor(*ATTRIBUTES)
+  end
+end

data/lib/rentlinx/models/unit_photo.rb

@@ -0,0 +1,5 @@
+module Rentlinx
+  class UnitPhoto < PropertyPhoto
+    REQUIRED_ATTRIBUTES += [:unitID]
+  end
+end

data/lib/rentlinx/modules/amenity_client_methods.rb

@@ -0,0 +1,74 @@
+module Rentlinx
+  module AmenityClientMethods
+    def post_amenities(amenities)
+      raise Rentlinx::InvalidObject, amenities.find { |a| !a.valid? } unless amenities.all?(&:valid?)
+      raise Rentlinx::InvalidObject, amenities unless amenities.all? { |p| p.propertyID == amenities.first.propertyID }
+      property_amenities = amenities.select { |p| p.class == Rentlinx::PropertyAmenity }
+      unit_amenities = amenities - property_amenities
+
+      post_property_amenities(property_amenities) unless property_amenities.empty?
+      post_unit_amenities(unit_amenities) unless unit_amenities.empty?
+    end
+
+    def get_amenities_for_property_id(id)
+      data = request('GET', "properties/#{id}/amenities")['data']
+      data.map do |amenity_data|
+        if amenity_data['unitID'].nil? || amenity_data['unitID'] == ''
+          amenity_data.delete('unitID')
+          PropertyAmenity.new(symbolize_data(amenity_data))
+        else
+          UnitAmenity.new(symbolize_data(amenity_data))
+        end
+      end
+    rescue Rentlinx::NotFound
+      return []
+    end
+
+    def get_amenities_for_unit(unit)
+      amenities = get_amenities_for_property_id(unit.propertyID)
+      amenities.select { |a| defined? a.unitID && a.unitID == unit.unitID }
+    end
+
+    def unpost_amenity(amenity)
+      case amenity
+      when Rentlinx::UnitAmenity
+        unpost_unit_amenity(amenity.unitID, amenity.name)
+      when Rentlinx::PropertyAmenity
+        unpost_property_amenity(amenity.propertyID, amenity.name)
+      else
+        raise TypeError, "Invalid type: #{type}"
+      end
+    end
+
+    private
+
+    # post_amenities should only be called from property or unit, so we don't need
+    # to handle multiple properties
+    def post_property_amenities(amenities)
+      request('PUT', "properties/#{amenities.first.propertyID}/amenities", amenities.map(&:to_hash))
+    end
+
+    def post_unit_amenities(amenities)
+      hash = {}
+      amenities.each do |p|
+        if hash.keys.include?(p.unitID)
+          hash[p.unitID] << p
+        else
+          hash[p.unitID] = [p]
+        end
+      end
+
+      hash.each do |unitID, unit_amenities|
+        request('PUT', "units/#{unitID}/amenities", unit_amenities.map(&:to_hash))
+      end
+    end
+
+    def unpost_property_amenity(id, name)
+      request('DELETE', URI.encode("properties/#{id}/amenities/#{name}"))
+    end
+
+    def unpost_unit_amenity(id, name)
+      request('DELETE', URI.encode("units/#{id}/amenities/#{name}"))
+    end
+  end
+end

data/lib/rentlinx/modules/photo_client_methods.rb

@@ -0,0 +1,67 @@
+module Rentlinx
+  module PhotoClientMethods
+    def post_photos(photos)
+      return false unless photos.all?(&:valid?)
+      return false unless photos.all? { |p| p.propertyID == photos.first.propertyID }
+      property_photos = photos.select { |p| p.is_a? Rentlinx::PropertyPhoto }
+      unit_photos = photos - property_photos
+
+      post_property_photos(property_photos) unless property_photos.empty?
+      post_unit_photos(unit_photos) unless unit_photos.empty?
+    end
+
+    def get_photos_for_property_id(id)
+      data = request('GET', "properties/#{id}/photos")['data']
+      data.map do |photo_data|
+        if photo_data['unitID'].nil? || photo_data['unitID'] == ''
+          photo_data.delete('unitID')
+          PropertyPhoto.new(symbolize_data(photo_data))
+        else
+          UnitPhoto.new(symbolize_data(photo_data))
+        end
+      end
+    end
+
+    def unpost_photo(photo)
+      case photo
+      when Rentlinx::PropertyPhoto
+        unpost_property_photo(photo.propertyID, photo.url)
+      when Rentlinx::UnitPhoto
+        unpost_unit_photo(photo.unitID, photo.url)
+      else
+        raise TypeError, "Invalid type: #{type}"
+      end
+    end
+
+    private
+
+    # post_photos should only be called from property or unit, so we don't need
+    # to handle multiple properties
+    def post_property_photos(photos)
+      request('PUT', "properties/#{photos.first.propertyID}/photos", photos.map(&:to_hash))
+    end
+
+    def post_unit_photos(photos)
+      hash = {}
+      photos.each do |p|
+        if hash.keys.include?(p.unitID)
+          hash[p.unitID] << p
+        else
+          hash[p.unitID] = [p]
+        end
+      end
+
+      hash.each do |unitID, unit_photos|
+        request('PUT', "units/#{unitID}/photos", unit_photos.map(&:to_hash))
+      end
+    end
+
+    def unpost_property_photo(id, url)
+      request('DELETE', "properties/#{id}/photos", url: url)
+    end
+
+    def unpost_unit_photo(id, url)
+      request('DELETE', "units/#{id}/photos", url: url)
+    end
+  end
+end

data/lib/rentlinx/modules/photoable.rb

@@ -0,0 +1,33 @@
+module Rentlinx
+  module Photoable
+    def post_with_photos
+      post
+      Rentlinx.client.post_photos(@photos)
+    end
+
+    def photos
+      @photos ||= get_photos_for_property_id(propertyID)
+    end
+
+    def photos=(photo_list)
+      @photos = photo_list.map do |photo|
+        photo.propertyID = propertyID
+        photo.unitID = unitID if defined? unitID
+        photo
+      end
+    end
+
+    def add_photo(options)
+      options.merge!(propertyID: propertyID)
+      options.merge!(unitID: unitID) if defined? unitID
+      @photos ||= []
+      @photos << photo_class.new(options)
+    end
+
+    private
+
+    def get_photos_for_property_id(id)
+      Rentlinx.client.get_photos_for_property_id(id)
+    end
+  end
+end

data/lib/rentlinx/modules/property_client_methods.rb

@@ -0,0 +1,21 @@
+module Rentlinx
+  module PropertyClientMethods
+    def get_units_for_property_id(id)
+      data = request('GET', "properties/#{id}/units")['data']
+      data.map do |unit_data|
+        Unit.new(symbolize_data(unit_data))
+      end
+    end
+
+    private
+
+    def post_property(prop)
+      return false unless prop.valid?
+      request('PUT', "properties/#{prop.propertyID}", prop.to_hash)
+    end
+
+    def unpost_property(id)
+      request('DELETE', "properties/#{id}")
+    end
+  end
+end

data/lib/rentlinx/modules/unit_client_methods.rb

@@ -0,0 +1,14 @@
+module Rentlinx
+  module UnitClientMethods
+    private
+
+    def post_unit(unit)
+      return false unless unit.valid?
+      request('PUT', "units/#{unit.unitID}", unit.to_hash)
+    end
+
+    def unpost_unit(id)
+      request('DELETE', "units/#{id}")
+    end
+  end
+end

data/lib/rentlinx/version.rb

@@ -1,3 +1,3 @@
 module Rentlinx
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rentlinx
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - AppFolio, Inc.
@@ -66,7 +66,16 @@ files:
 - lib/rentlinx/errors.rb
 - lib/rentlinx/models/base.rb
 - lib/rentlinx/models/property.rb
+- lib/rentlinx/models/property_amenity.rb
+- lib/rentlinx/models/property_photo.rb
 - lib/rentlinx/models/unit.rb
+- lib/rentlinx/models/unit_amenity.rb
+- lib/rentlinx/models/unit_photo.rb
+- lib/rentlinx/modules/amenity_client_methods.rb
+- lib/rentlinx/modules/photo_client_methods.rb
+- lib/rentlinx/modules/photoable.rb
+- lib/rentlinx/modules/property_client_methods.rb
+- lib/rentlinx/modules/unit_client_methods.rb
 - lib/rentlinx/validators/attribute_processor_service.rb
 - lib/rentlinx/validators/base_validator.rb
 - lib/rentlinx/validators/phone_validator.rb