rentlinx 0.9.3 → 0.9.4.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0551c6f33a75e1776a0bb4d932c0a4b4e09f5591
-  data.tar.gz: 9354d52fbf2bd6f1cc3757332ca92ca8e10893a2
+  metadata.gz: 8b77a1746107aeea8c8af74a2c59244c46d2cac1
+  data.tar.gz: 72a3b7cbcdf9868fee1186720a1accce03bde5c4
 SHA512:
-  metadata.gz: becc388be2bcfe16eeff36740e784671a624d940e06badbe9f6a205e92132b249b3f0c74440538c2a40b6e474207bcb6a9751a47071a7a6f862dc41d310af4e0
-  data.tar.gz: fd6a4aee865dd53a85dc43dd34e4c4dcef0359cd1aa34c4a02e8b927fb0e3c3d44150590021ae89aab06fc5b81f954493a1732db846bd6ce9827fc75ecc409c4
+  metadata.gz: cfc3bf598922af2b45d7d194349b9063be2d3fb3592aaf943946cc60c3f946e23125767907bf566aeda63d783733519377a9512c75886a693d2dd7e9a3bffabe
+  data.tar.gz: 2a7c3ef5972f5783b2440a31eb1d73f12ffe5e3cb1e6901d40878be9b0ea4a567fc4d7c16cd8ca0a800acb341f41fc8443f34cf50912cfe8f338e6d078561281

data/lib/rentlinx.rb

@@ -2,6 +2,7 @@ require 'logging'
 require 'rentlinx/client'
 require 'rentlinx/errors'
 require 'rentlinx/models/base'
+require 'rentlinx/models/company'
 require 'rentlinx/models/property'
 require 'rentlinx/models/unit'
 require 'rentlinx/models/property_photo'

data/lib/rentlinx/client.rb

@@ -2,6 +2,7 @@ require 'httpclient'
 require 'json'
 require 'uri'
 require 'rentlinx/default'
+require 'rentlinx/modules/company_client_methods'
 require 'rentlinx/modules/property_client_methods'
 require 'rentlinx/modules/unit_client_methods'
 require 'rentlinx/modules/photo_client_methods'
@@ -15,6 +16,7 @@ module Rentlinx
   # It should not be interacted with, the objects provide
   # all the functionality necessary to work with Rentlinx.
   class Client
+    include Rentlinx::CompanyClientMethods
     include Rentlinx::PropertyClientMethods
     include Rentlinx::UnitClientMethods
     include Rentlinx::PhotoClientMethods
@@ -38,11 +40,27 @@ module Rentlinx
       @api_token ||= authenticate(Rentlinx.username, Rentlinx.password)
     end
 
+    # Pushes an object's attributes out to Rentlinx
+    #
+    # @param object [Rentlinx::Base] the object to be patched
+    def patch(object)
+      case object
+      when Rentlinx::Property
+        raise Rentlinx::InvalidObject, object unless object.patch_valid?
+        patch_property(object)
+      else
+        raise TypeError, "Type not permitted: #{object.class}"
+      end
+    end
+
     # Pushes an object's attributes out to Rentlinx
     #
     # @param object [Rentlinx::Base] the object to be posted
     def post(object)
       case object
+      when Rentlinx::Company
+        raise Rentlinx::InvalidObject, object unless object.valid?
+        post_company(object)
       when Rentlinx::Property
         raise Rentlinx::InvalidObject, object unless object.valid?
         post_property(object)
@@ -60,6 +78,8 @@ module Rentlinx
     # @param id [String] the rentlinx id of the object to be unposted
     def unpost(type, id)
       case type
+      when :company
+        unpost_company(id)
       when :property
         unpost_property(id)
       when :unit
@@ -75,6 +95,8 @@ module Rentlinx
     # @param id [String] the rentlinx id of the object to be fetched
     def get(type, id)
       case type
+      when :company
+        Company.new(process_get("companies/#{id}"))
       when :property
         Property.new(process_get("properties/#{id}"))
       when :unit

data/lib/rentlinx/errors.rb

@@ -28,7 +28,7 @@ module Rentlinx
   # to post or update
   class InvalidObject < RentlinxError
     def initialize(object)
-      super("#{object.class} is invalid: #{object.error_messages}")
+      super("#{object.class} is invalid: #{object.validate}")
     end
   end
 

data/lib/rentlinx/models/base.rb

@@ -16,6 +16,7 @@ module Rentlinx
     #
     # @param attrs [Hash] a hash of attributes to save.
     def initialize(attrs)
+      @original_attrs = attrs.dup
       @processor = AttributeProcessor.new(attrs.dup)
       attrs = @processor.process
       attributes.each do |at|
@@ -39,6 +40,15 @@ module Rentlinx
       self.class::REQUIRED_ATTRIBUTES
     end
 
+    # Sends the object to Rentlinx
+    #
+    # @example
+    #     prop = Rentlinx::Property.new(attrs)
+    #     prop.patch
+    def patch
+      Rentlinx.client.patch(self)
+    end
+
     # Sends the object to Rentlinx
     #
     # @example
@@ -54,7 +64,7 @@ module Rentlinx
     #     prop = Rentlinx::Property.new(attrs)
     #     prop.unpost
     def unpost
-      Rentlinx.client.unpost(type, send(type.to_s + 'ID'))
+      Rentlinx.client.unpost(type, send(identity))
     end
 
     # Converts the object to a hash
@@ -62,30 +72,44 @@ module Rentlinx
     # @return a hash including the attributes and values
     def to_hash
       {}.tap do |hash|
-        attributes.each do |at|
+        @original_attrs.keys.each do |at|
           hash[at] = send(at)
         end
       end
     end
 
-    # Determines the validity of the object
+    # Determines the validity of the object for post
     #
     # @return true if valid, false if invalid
     def valid?
-      error_messages.empty?
+      validate.empty?
+    end
+
+    # Determines the validity of the object for patch
+    #
+    # @return true if valid, false if invalid
+    def patch_valid?
+      validate(false).empty?
     end
 
     # Provides error messages on invalid objects
     #
+    # @param check_required_attributes whether to check for required attributes
     # @return a hash of error messages
-    def error_messages
+    def validate(check_required_attributes = true)
       @processor = AttributeProcessor.new(to_hash)
       @processor.process
 
-      missing_attrs = required_attributes.select { |at| blank?(send(at)) }
+      # object identity is always required, even for patches
+      missing_errors = {}
+      missing_errors[identity.to_sym] = 'is missing' if self.class.method_defined?(identity) && blank?(send(identity))
+
+      if check_required_attributes
+        missing_attrs = required_attributes.select { |at| blank?(send(at)) }
 
-      missing_errors = missing_attrs.each_with_object({}) do |at, obj|
-        obj[at] = 'is missing'
+        missing_attrs.each do |at|
+          missing_errors[at] = 'is missing'
+        end
       end
 
       @processor.errors.merge(missing_errors)
@@ -109,6 +133,10 @@ module Rentlinx
       name.split('::').last.downcase.to_sym
     end
 
+    def identity
+      type.to_s + 'ID'
+    end
+
     def blank?(str)
       str.nil? || str == ''
     end

data/lib/rentlinx/models/company.rb

@@ -0,0 +1,21 @@
+module Rentlinx
+  # An object that represents a Rentlinx company.
+  class Company < Base
+    ATTRIBUTES = [:companyID, :companyCapAmount]
+
+    REQUIRED_ATTRIBUTES = [:companyID]
+
+    attr_accessor(*ATTRIBUTES)
+
+    # Queries Rentlinx and builds a company with the given ID
+    #
+    # The returned company will have all the attributes Rentlinx
+    # has for the company on their end.
+    #
+    # @param id [String] the Rentlinx id of the company
+    # @return a Rentlinx::Company that is up to date with the remote one
+    def self.from_id(id)
+      get_from_id(:company, id)
+    end
+  end
+end

data/lib/rentlinx/models/property.rb

@@ -9,7 +9,8 @@ module Rentlinx
                   :zip, :marketingName, :hideAddress, :latitude, :longitude,
                   :website, :yearBuilt, :numUnits, :phoneNumber, :extension,
                   :faxNumber, :emailAddress, :acceptsHcv, :propertyType,
-                  :activeURL, :companyName, :leadsURL]
+                  :activeURL, :companyName, :leadsURL,
+                  :premium, :capAmount]
 
     REQUIRED_ATTRIBUTES = [:propertyID, :address, :city, :state, :zip,
                            :phoneNumber, :emailAddress]

data/lib/rentlinx/modules/company_client_methods.rb

@@ -0,0 +1,15 @@
+module Rentlinx
+  # Client methods for companies. No public methods.
+  module CompanyClientMethods
+    private
+
+    def post_company(company)
+      return false unless company.valid?
+      request('PUT', "companies/#{company.companyID}", company.to_hash)
+    end
+
+    def unpost_company(id)
+      request('DELETE', "companies/#{id}")
+    end
+  end
+end

data/lib/rentlinx/modules/property_client_methods.rb

@@ -14,6 +14,12 @@ module Rentlinx
 
     private
 
+    def patch_property(prop)
+      return false unless prop.patch_valid?
+      # TODO: change to 'PATCH' once Rentlinx supports it
+      request('PUT', "properties/#{prop.propertyID}", prop.to_hash)
+    end
+
     def post_property(prop)
       return false unless prop.valid?
       request('PUT', "properties/#{prop.propertyID}", prop.to_hash)

data/lib/rentlinx/validators/amount_validator.rb

@@ -0,0 +1,14 @@
+module Rentlinx
+  # Validator for money amounts.
+  # Must be positive amounts.
+  # Cannot be cleared once set.
+  class AmountValidator < BaseValidator
+    private
+
+    def validate
+      @value.sub!(/^0+/, '') unless @value.nil?
+      return if @value.to_s =~ /[1-9]\d*(\.\d{1,2})?/
+      @error = "'#{@value}' is not a valid amount."
+    end
+  end
+end

data/lib/rentlinx/validators/attribute_processor_service.rb

@@ -1,5 +1,6 @@
 require 'rentlinx/validators/base_validator'
 require 'rentlinx/validators/address_validator'
+require 'rentlinx/validators/amount_validator'
 require 'rentlinx/validators/city_validator'
 require 'rentlinx/validators/phone_validator'
 require 'rentlinx/validators/state_validator'
@@ -37,7 +38,9 @@ module Rentlinx
                      zip: ZipValidator,
                      leadsURL: UrlValidator,
                      city: CityValidator,
-                     address: AddressValidator }
+                     address: AddressValidator,
+                     capAmount: AmountValidator,
+                     companyCapAmount: AmountValidator }
 
       @attrs.each do |field, val|
         next unless validators.keys.include?(field)

data/lib/rentlinx/version.rb

@@ -1,5 +1,5 @@
 # This is the main rentlinx module. All Rentlinx objects
 # and methods are namespaced under this module.
 module Rentlinx
-  VERSION = '0.9.3'
+  VERSION = '0.9.4.pre'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rentlinx
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4.pre
 platform: ruby
 authors:
 - AppFolio, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -65,6 +65,7 @@ files:
 - lib/rentlinx/default.rb
 - lib/rentlinx/errors.rb
 - lib/rentlinx/models/base.rb
+- lib/rentlinx/models/company.rb
 - lib/rentlinx/models/property.rb
 - lib/rentlinx/models/property_amenity.rb
 - lib/rentlinx/models/property_link.rb
@@ -75,6 +76,7 @@ files:
 - lib/rentlinx/models/unit_photo.rb
 - lib/rentlinx/modules/amenity_client_methods.rb
 - lib/rentlinx/modules/amenityable.rb
+- lib/rentlinx/modules/company_client_methods.rb
 - lib/rentlinx/modules/link_client_methods.rb
 - lib/rentlinx/modules/linkable.rb
 - lib/rentlinx/modules/photo_client_methods.rb
@@ -82,6 +84,7 @@ files:
 - lib/rentlinx/modules/property_client_methods.rb
 - lib/rentlinx/modules/unit_client_methods.rb
 - lib/rentlinx/validators/address_validator.rb
+- lib/rentlinx/validators/amount_validator.rb
 - lib/rentlinx/validators/attribute_processor_service.rb
 - lib/rentlinx/validators/base_validator.rb
 - lib/rentlinx/validators/city_validator.rb
@@ -105,14 +108,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: API Wrapper for the Rentlinx API
 test_files: []
-has_rdoc: