rentlinx 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e3eba7e898a937ec5f358abcdb172ae207a1586
-  data.tar.gz: 57cc34bb4131f160deac0b107fe24f8d870e3987
+  metadata.gz: 3819098a7b8edb089697d87f6302b298b3529f56
+  data.tar.gz: 5c392001f17b5c750ad0cd3c81cf336363bd070b
 SHA512:
-  metadata.gz: 18bc2f16c329de3b9ad5c9462f623ebdee7a58b3e337a80eb6046238f98c45b6ff904c4c259a5cadcf434a5bcc027af40a0339d4dca8ba822cb75f0a08a3732e
-  data.tar.gz: 9964b42866d070ac37ee9293ed34c057f90e904c0a0eb15c0886693d6cbc898ed66eafad92062972971a57bbc87859a8d0a8a7d167ebe506ddf1581e785671d4
+  metadata.gz: 529234a86df627dd0beea23cd00e49d921b1594bc160fcf362f3e98de4a84615c5592df1a948c8eeb02b01b1ac2b4ee4ec3d9ee761cf5333ff8f313ddaaa2126
+  data.tar.gz: a75cd39c0fa79d5fd8e52c98deb04c17b3c1442a62cc309b77da6f2d43925fa97cd7d230e82f7a20f05abd26ec640126e28da1c7d3b78517d132391210eeee78

data/lib/rentlinx.rb

@@ -1,3 +1,4 @@
+require 'logging'
 require 'rentlinx/client'
 require 'rentlinx/errors'
 require 'rentlinx/models/base'
@@ -38,8 +39,22 @@ module Rentlinx
       end
     end
 
+    def log_level(*args)
+      if args.empty?
+        @log_level
+      else
+        @log_level = args.first
+      end
+    end
+
     def client
       @client ||= Rentlinx::Client.new
     end
+
+    def logger
+      lgr = Logging.logger(STDOUT)
+      lgr.level = (@log_level || :error)
+      lgr
+    end
   end
 end

data/lib/rentlinx/client.rb

@@ -6,6 +6,10 @@ require 'rentlinx/default'
 module Rentlinx
   class Client
     def initialize
+      raise Rentlinx::NotConfigured if Rentlinx.username.nil? ||
+                                       Rentlinx.password.nil? ||
+                                       Rentlinx.api_url_prefix.nil?
+
       @url_prefix = (Rentlinx.api_url_prefix + '/').freeze  # Extra slashes are fine
       @api_token ||= authenticate(Rentlinx.username, Rentlinx.password)
     end
@@ -13,11 +17,24 @@ module Rentlinx
     def post(object)
       case object
       when Rentlinx::Property
+        raise Rentlinx::InvalidObject, object unless object.valid?
         post_property(object)
       when Rentlinx::Unit
+        raise Rentlinx::InvalidObject, object unless object.valid?
         post_unit(object)
       else
-        raise TypeError, "Invalid object: #{object.class}"
+        raise TypeError, "Type not permitted: #{object.class}"
+      end
+    end
+
+    def unpost(type, id)
+      case type
+      when :property
+        unpost_property(id)
+      when :unit
+        unpost_unit(id)
+      else
+        raise TypeError, "Invalid type: #{type}"
       end
     end
 
@@ -65,6 +82,14 @@ module Rentlinx
       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)
@@ -73,8 +98,29 @@ module Rentlinx
 
     def request(method, path, data = nil)
       options = { body: data.to_json, header: authenticated_headers }
+      Rentlinx.logger.debug "#{method} Request to #{path}\n#{options.inspect}"
       response = session.request(method, URI.join(@url_prefix, path), options)
-      JSON.parse(response.body)
+      response_handler(response)
+    end
+
+    def response_handler(response)
+      case response.status
+      when 200, 201, 202
+        JSON.parse(response.body)
+      when 204
+        nil # don't attempt to JSON parse emptystring
+      when 400
+        body = JSON.parse(response.body)
+        raise Rentlinx::BadRequest, body['details']
+      when 403
+        raise Rentlinx::Forbidden, response
+      when 404
+        raise Rentlinx::NotFound, response
+      when 500, 501, 502, 503, 504, 505
+        raise Rentlinx::ServerError, response
+      else
+        raise Rentlinx::HTTPError, response
+      end
     end
 
     def authenticated_headers

data/lib/rentlinx/errors.rb

@@ -7,4 +7,49 @@ module Rentlinx
 
   class InvalidTypeParam < RentlinxError
   end
+
+  class NotConfigured < RentlinxError
+    def initialize
+      super('Rentlinx is not configured.')
+    end
+  end
+
+  class InvalidObject < RentlinxError
+    def initialize(object)
+      super("#{object.class} is invalid: #{object.missing_attributes}")
+    end
+  end
+
+  class HTTPError < RentlinxError
+    attr_reader :response
+
+    def initialize(response, msg = nil)
+      @response = response
+      super(msg.nil? ? 'Received an unexpected response from the server' : msg)
+    end
+  end
+
+  class BadRequest < HTTPError
+    def initialize(response)
+      super(response, 'The request sent to the server was invalid.')
+    end
+  end
+
+  class NotFound < HTTPError
+    def initialize(response)
+      super(response, 'The item you requested could not be found on the remote server.')
+    end
+  end
+
+  class Forbidden < HTTPError
+    def initialize(response)
+      super(response, 'You are not permitted to access the item you requested.')
+    end
+  end
+
+  class ServerError < HTTPError
+    def initialize(response)
+      super(response, 'The remote server has experienced an error.')
+    end
+  end
 end

data/lib/rentlinx/models/base.rb

@@ -24,6 +24,14 @@ module Rentlinx
       Rentlinx.client.post(self)
     end
 
+    def unpost
+      Rentlinx.client.unpost(type, send(type.to_s + 'ID'))
+    end
+
+    def self.unpost(id)
+      Rentlinx.client.unpost(type, id)
+    end
+
     def self.get_from_id(type, id)
       Rentlinx.client.get(type.to_sym, id)
     end
@@ -51,5 +59,23 @@ module Rentlinx
         !send(at).nil? && send(at) != ''
       end
     end
+
+    def missing_attributes
+      missing = required_attributes.select do |at|
+        send(at).nil? || send(at) == ''
+      end
+
+      "Missing required attributes: #{missing.join(', ')}"
+    end
+
+    private
+
+    def type
+      self.class.type
+    end
+
+    def self.type
+      name.split('::').last.downcase.to_sym
+    end
   end
 end

data/lib/rentlinx/version.rb

@@ -1,3 +1,3 @@
 module Rentlinx
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rentlinx
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - AppFolio, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -58,7 +58,7 @@ homepage: https://github.com/appfolio/rentlinx_client
 licenses:
 - Simplified BSD
 metadata: {}
-post_install_message: Thanks for installing!
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -77,5 +77,5 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: API Wrapper for
+summary: API Wrapper for the Rentlinx API
 test_files: []