rentlinx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e982c2be41722f9f4d073747e2e1b62c65a7e6c
-  data.tar.gz: 7f402610e2f22b453b6824d8049898be05db4325
+  metadata.gz: 720fea912d43966d463f3a33bccd817bd48ff08c
+  data.tar.gz: 509098fd3d69076b2f49614b5cdea935f8e64899
 SHA512:
-  metadata.gz: e9456965acfd7fa9d0f36201fd836db98803029fbbf10e81a44fc3d68908ef712922d4426c31920c457b182d83b483fea964a1fd982b496acf02de5919e037e5
-  data.tar.gz: 75d49028469c3b1948f9659701a25a1cfaefe66de95731a74b7f7c87fe2181b5f102b55706899b5af8ea9e21a94ff77e158fdeaa925137e7d1d928d62fdcfb8b
+  metadata.gz: da9a9b33b4926c3089f5825624170ab79213eb7e439149f3b87ee2e634c9e31ea5d3018899a40a574470f37b906628bfa7bc4de5f33255af46dd2add9791821a
+  data.tar.gz: 391d5f7b9f102ac645c1c10db3b2fe4157b37c9e9515007ad2ac31101541eb4ab32ad47d07b0d794eff388e26aedbea385f217b4fb21830be78ce2cf37f4ab15

data/README.md

@@ -49,6 +49,21 @@ test files can be executed via:
     ruby -Ilib:test test/FILENAME.rb
 
 
+### Usage
+
+For all endpoints, attributes are defined by the API: https://www.rentlinx.com/mongoose/help
+
+Properties can be created, updated, and fetched from Rentlinx like so:
+
+    prop = Property.new(attributes)
+    prop.post # creates
+
+    prop.website = 'http://example.com'
+    prop.post # updates
+
+    prop = Property.from_id('property-id') # fetches
+
+
 ## Copyright and license
 
 Source released under the Simplified BSD License.

data/lib/rentlinx.rb

@@ -1,4 +1,7 @@
 require 'rentlinx/client'
+require 'rentlinx/errors'
+require 'rentlinx/models/base'
+require 'rentlinx/models/property'
 
 module Rentlinx
   @username = nil

data/lib/rentlinx/client.rb

@@ -10,8 +10,39 @@ module Rentlinx
       @api_token ||= authenticate(Rentlinx.username, Rentlinx.password)
     end
 
+    def post(object)
+      case object
+      when Rentlinx::Property
+        post_property(object)
+      else
+        raise TypeError, "Invalid object: #{object.class}"
+      end
+    end
+
+    def get(type, id)
+      case type
+      when :property
+        data = request('GET', "properties/#{id}")['data']
+        data = data.each_with_object({}) do |(k, v), memo|
+          memo[k.to_sym] = v
+          memo
+        end
+        data.delete(:type)
+        Property.new(data)
+      when :unit
+        # todo
+      else
+        raise InvalidTypeParam, "Type not recognized: #{type}"
+      end
+    end
+
     private
 
+    def post_property(prop)
+      return false unless prop.valid?
+      request('PUT', "properties/#{prop.propertyID}", prop.to_hash)
+    end
+
     def authenticate(username, password)
       data = { username: username, password: password }
       response = request('POST', 'authentication/login', data)
@@ -19,11 +50,17 @@ module Rentlinx
     end
 
     def request(method, path, data = nil)
-      options = { body: data.to_json, header: Rentlinx::Default.headers }
+      options = { body: data.to_json, header: authenticated_headers }
       response = session.request(method, URI.join(@url_prefix, path), options)
       JSON.parse(response.body)
     end
 
+    def authenticated_headers
+      Rentlinx::Default.headers.tap do |headers|
+        headers['Authentication-Token'] = @api_token unless @api_token.nil?
+      end
+    end
+
     def session
       @session ||= HTTPClient.new
     end

data/lib/rentlinx/errors.rb

@@ -0,0 +1,10 @@
+module Rentlinx
+  class RentlinxError < StandardError
+  end
+
+  class UnexpectedAttributes < RentlinxError
+  end
+
+  class InvalidTypeParam < RentlinxError
+  end
+end

data/lib/rentlinx/models/base.rb

@@ -0,0 +1,11 @@
+module Rentlinx
+  class Base
+    def post
+      Rentlinx.client.post(self)
+    end
+
+    def self.get_from_id(type, id)
+      Rentlinx.client.get(type.to_sym, id)
+    end
+  end
+end

data/lib/rentlinx/models/property.rb

@@ -0,0 +1,48 @@
+module Rentlinx
+  class Property < Base
+    ATTRIBUTES = [:companyID, :propertyID, :description, :address, :city, :state,
+                  :zip, :marketingName, :hideAddress, :latitude, :longitude,
+                  :website, :yearBuilt, :numUnits, :phoneNumber, :extension,
+                  :faxNumber, :emailAddress, :acceptsHcv, :propertyType,
+                  :activeURL, :companyName]
+
+    REQUIRED_ATTRIBUTES = [:propertyID, :address, :city, :state, :zip,
+                           :phoneNumber, :emailAddress]
+
+    REQUIRED_FOR_POST = REQUIRED_ATTRIBUTES + [:companyID, :companyName]
+
+    attr_accessor(*ATTRIBUTES)
+
+    def initialize(attrs)
+      ATTRIBUTES.each do |at|
+        send("#{at}=", attrs[at])
+      end
+      remaining_attrs = attrs.keys - ATTRIBUTES
+      raise UnexpectedAttributes, "Unexpected Attributes: #{remaining_attrs.join(', ')}" if remaining_attrs.size > 0
+    end
+
+    def self.from_id(id)
+      get_from_id(:property, id)
+    end
+
+    def valid?
+      REQUIRED_ATTRIBUTES.all? do |at|
+        !send(at).nil? && send(at) != ''
+      end
+    end
+
+    def valid_for_post?
+      REQUIRED_FOR_POST.all? do |at|
+        !send(at).nil? && send(at) != ''
+      end
+    end
+
+    def to_hash
+      {}.tap do |hash|
+        ATTRIBUTES.each do |at|
+          hash[at] = send(at)
+        end
+      end
+    end
+  end
+end

data/lib/rentlinx/version.rb

@@ -1,3 +1,3 @@
 module Rentlinx
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rentlinx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - AppFolio, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -49,6 +49,9 @@ files:
 - lib/rentlinx.rb
 - lib/rentlinx/client.rb
 - lib/rentlinx/default.rb
+- lib/rentlinx/errors.rb
+- lib/rentlinx/models/base.rb
+- lib/rentlinx/models/property.rb
 - lib/rentlinx/version.rb
 homepage: https://github.com/appfolio/rentlinx_client
 licenses: