tops_connect 0.4.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb05758fdcdd83dc6d3725967b6434e9803da78c
-  data.tar.gz: cc16acf78a5ea7cec0e14019faad1efe3e3f1b40
+SHA256:
+  metadata.gz: e693e4f20693b51e9ef1729c307abae6e8e49cd0d92a04fa8f79a9c83ab43c60
+  data.tar.gz: cc1f4bcc3c10588236114facebba06c693eafa5a20f930a109510ce6c2fd2828
 SHA512:
-  metadata.gz: 78f8612c3baffacf861dcf6146e2fb2022eb165ebeb74991d30458a58fe0c9acbebf61d23dfe743311acc187333137cfd622fceb94c0c1dd1df0c0e0a0db8280
-  data.tar.gz: 1a7906c8abdeec9cb18cbd99eb59c4b013b91b05f86f641675214ab14ee29a1319d54448910d600dec37086dfbb23eb0b7039f09417bc751c0f7458cd49252c2
+  metadata.gz: 8d27cd2cfbfc12ca9e3199fb2893ce1540e5f0c6de448306d346b93a053879e8b7621811fadf0de1ba6541f8d2c80cc507e9a642857251d66c099ef16476b1ea
+  data.tar.gz: 90b74c5944b310533fc7b521340712c550c3369c74f42fd3dc6afe6e181d6bae41df4288ee7f192165126c0adf32eb93035eb554bd1b2fb5f1bbb4db9513d726

data/.rubocop.yml

@@ -2,7 +2,7 @@ AllCops:
   Include:
     - Gemfile
     - Rakefile
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
 
 Metrics/AbcSize:
   Enabled: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Steven Hoffman
+Copyright (c) 2018 Steven Hoffman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/tops_connect.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+
 require 'base64'
 require 'httparty'
 require 'json'
+require 'time'
 
 require 'tops_connect/errors'
 

data/lib/tops_connect/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
   class Base
     attr_reader :data

data/lib/tops_connect/client.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
   class Client
     include HTTParty
@@ -9,9 +10,8 @@ module TopsConnect
     attr_reader :community_id, :community_api_key
 
     headers 'Content-Type' => 'application/json'
-    headers 'api-version' => '1'
 
-    base_uri 'https://topsconnectapi.azure-api.net'
+    base_uri 'https://topsconnectapi.azure-api.net/v2'
 
     def initialize(community_id, community_api_key)
       authorization = Base64.strict_encode64 [
@@ -22,6 +22,11 @@ module TopsConnect
       self.class.headers('authorization' => "Basic #{authorization}")
 
       @subscription_key = TopsConnect.configuration.subscription_key
+
+      switch_community(community_id, community_api_key)
+    end
+
+    def switch_community(community_id, community_api_key)
       @community_id = community_id
       @community_api_key = community_api_key
     end
@@ -38,6 +43,32 @@ module TopsConnect
       response.parsed_response
     end
 
+    def put(endpoint, body: {}, headers: {}, query: {})
+      response = self.class.put(
+        "/#{TopsConnect.configuration.zone}/api#{endpoint}",
+        query: query.merge('subscription-key' => @subscription_key),
+        headers: headers.merge('community-api-key' => @community_api_key),
+        body: body
+      )
+
+      raise_exception(response) unless response.code == 204
+
+      response.parsed_response
+    end
+
+    def post(endpoint, body: {}, headers: {}, query: {})
+      response = self.class.post(
+        "/#{TopsConnect.configuration.zone}/api#{endpoint}",
+        query: query.merge('subscription-key' => @subscription_key),
+        headers: headers.merge('community-api-key' => @community_api_key),
+        body: body
+      )
+
+      raise_exception(response) unless response.code == 200
+
+      response.parsed_response
+    end
+
     protected
 
     def raise_exception(response)
@@ -54,7 +85,7 @@ module TopsConnect
 
         raise TopsConnect::InternalError, response
       else
-        # As far as I'm aware, Tops does not return 100 - 199 or 201 - 399.
+        # As far as I'm aware, Tops does not return 100 - 199 or 205 - 399.
         raise TopsConnect::ApiError, response
       end
     end

data/lib/tops_connect/communities.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
   module Communities
     # Method: GET

data/lib/tops_connect/community.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
   class Community < Base
     def community_key
@@ -28,13 +29,13 @@ module TopsConnect
     end
 
     def last_synced_at
-      DateTime.parse data['LastSyncTime'] if data['LastSyncTime']
+      Time.parse data['LastSyncTime'] if data['LastSyncTime']
     end
 
     def modified_date
       return unless data['Metadata']['ModifiedDate']
 
-      DateTime.parse data['Metadata']['ModifiedDate']
+      Time.parse data['Metadata']['ModifiedDate']
     end
     alias updated_at modified_date
   end

data/lib/tops_connect/configuration.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
+
 module TopsConnect
   class Configuration
     attr_reader :subscription_key, :client_id, :software_key, :zone
 
     def subscription_key=(key)
-      unless key =~ /\A\h{32}\z/i
+      unless key.match?(/\A\h{32}\z/i)
         raise 'Invalid TOPS Subscription Key. Expected 32 hex characters.'
       end
 
@@ -12,7 +13,7 @@ module TopsConnect
     end
 
     def client_id=(key)
-      unless key =~ /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/
+      unless key.match?(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
         raise 'Invalid TOPS Client ID. Expected a GUID.'
       end
 
@@ -20,7 +21,7 @@ module TopsConnect
     end
 
     def software_key=(key)
-      unless key =~ /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/
+      unless key.match?(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
         raise 'Invalid TOPS Software Key. Expected a GUID.'
       end
 
@@ -28,7 +29,7 @@ module TopsConnect
     end
 
     def zone=(new_zone)
-      unless %i(broad limited sandbox).include?(new_zone.to_sym)
+      unless %i[broad limited sandbox].include?(new_zone.to_sym)
         raise 'Invalid TOPS Zone. Accepted values are broad, limited, sandbox.'
       end
 

data/lib/tops_connect/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
   class ApiError < ::RuntimeError
     def initialize(response)
@@ -7,7 +8,7 @@ module TopsConnect
 
     def to_s
       format(
-        '%{code}: %{message} (%{uri})',
+        '%<code>s: %<message>s (%<uri>s)',
         code: @response.code,
         message: @response.parsed_response&.dig('Message'),
         uri: @response.request.last_uri.to_s

data/lib/tops_connect/owner.rb

@@ -1,32 +1,31 @@
 # frozen_string_literal: true
+
 module TopsConnect
   class Owner < Base
     def owner_key
-      data['OwnerKey']
+      data['Key']
     end
     alias id owner_key
 
     def alternate_mailing_addresses
-      [1, 2].map do |n|
+      data['Addresses'].map do |row|
+        next unless row['Type']['Name'] == 'Alternate'
+
         lines = []
 
-        if data["AltMailing#{n}AddressLine1"] =~ /[[:graph:]]/
-          lines << data["AltMailing#{n}AddressLine1"].strip
+        if row['AddressLine1'].match?(/[[:graph:]]/)
+          lines << row['AddressLine1']
         end
 
-        if data["AltMailing#{n}AddressLine2"] =~ /[[:graph:]]/
-          lines << data["AltMailing#{n}AddressLine2"].strip
+        if row['AddressLine2'].match?(/[[:graph:]]/)
+          lines << row['AddressLine2']
         end
 
         next if lines.empty?
 
-        city = data["AltMailing#{n}City"]
-        state = data["AltMailing#{n}State"]
-        zip = data["AltMailing#{n}Zip"]
-
-        lines << "#{city}, #{state} #{zip}".strip
+        lines << "#{row['City']}, #{row['State']} #{row['Zip']}"
 
-        lines.join("\n")
+        lines.map(&:strip).join("\n")
       end.compact
     end
 
@@ -47,25 +46,33 @@ module TopsConnect
     end
 
     def home_phone
-      data['PhoneHome']
+      phone = data['Phones'].find { |row| row['Type']['Name'] == 'Home' }
+
+      phone['PhoneNumber'] if phone
     end
 
     def alternate_phone
-      data['PhoneAlt']
+      phone = data['Phones'].find { |row| row['Type']['Name'] == 'Alternate' }
+
+      phone['PhoneNumber'] if phone
     end
 
     def fax
-      data['PhoneFax']
+      phone = data['Phones'].find { |row| row['Type']['Name'] == 'Fax' }
+
+      phone['PhoneNumber'] if phone
     end
 
     def work_phone
-      data['PhoneWork']
+      phone = data['Phones'].find { |row| row['Type']['Name'] == 'Work' }
+
+      phone['PhoneNumber'] if phone
     end
 
     def updated_at
       return unless data['Metadata']['ModifiedDate']
 
-      DateTime.parse data['Metadata']['ModifiedDate']
+      Time.parse data['Metadata']['ModifiedDate']
     end
 
     def owner?
@@ -79,19 +86,23 @@ module TopsConnect
     def move_out_date
       return unless data['MoveOutDate']
 
-      DateTime.parse data['MoveOutDate']
+      Time.parse data['MoveOutDate']
     end
 
     def settlement_date
       return unless data['SettlementDate']
 
-      DateTime.parse data['SettlementDate']
+      Time.parse data['SettlementDate']
     end
 
     def hold_payment?
       data['Metadata']['HoldPayment']
     end
 
+    def hold_collection?
+      data['Metadata']['HoldCollection']
+    end
+
     # The internal key used by Tops Pro - property number, homeowner type,
     # owner number in the format PPPPPPTOOO.
     def tops_id

data/lib/tops_connect/owners.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
   module Owners
     # Method: GET
@@ -24,7 +25,7 @@ module TopsConnect
     # Endpoint: Balance_Get
     # Returns: Hash
     def balance(owner_key)
-      get "/balance/#{owner_key}"
+      get "/owner/#{owner_key}/balance"
     end
 
     # Method: GET

data/lib/tops_connect/properties.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
   module Properties
     # Method: GET

data/lib/tops_connect/property.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+
 module TopsConnect
   class Property < Base
     def property_key
-      data['PropertyKey']
+      data['Key']
     end
     alias id property_key
 
@@ -11,42 +12,30 @@ module TopsConnect
     end
 
     def address
-      ["#{address_number} #{street}", unit_number].compact.join(' #')
-    end
-
-    def city
-      data['City']
-    end
-
-    def state
-      data['State']
-    end
+      property = data['Addresses']
+        .find { |row| row['Type']['Name'] == 'Property' }
 
-    def address_number
-      data['AddressNumber']
-    end
-
-    def unit_number
-      data['AptNumber'] unless data['AptNumber'].blank?
-    end
-
-    def street
-      data['Street']
-    end
+      lines = [
+        property['AddressLine1'],
+        property['AddressLine2'],
+        "#{property['City']}, #{property['State']} #{property['Zip']}"
+      ]
 
-    def zip
-      data['Zip']
+      lines
+        .map(&:strip)
+        .select { |line| line.match?(/[[:graph:]]/) }
+        .join("\n")
     end
 
     def community_key
       data['CommunityKey']
     end
 
-    def updated_at
+    def modified_date
       return unless data['Metadata']['ModifiedDate']
 
-      DateTime.parse data['Metadata']['ModifiedDate']
+      Time.parse data['Metadata']['ModifiedDate']
     end
-    alias modified_date updated_at
+    alias updated_at modified_date
   end
 end

data/lib/tops_connect/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module TopsConnect
-  VERSION = '0.4.3.2'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tops_connect
 version: !ruby/object:Gem::Version
-  version: 0.4.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Steven Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2018-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Make use of the Tops Connect API