propertysolutions 0.0.14

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+<h1>Property Solutions</h1>
+<p>A gem to help consume the API for propertysolutions.com.</p>

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ProperySolutions'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/models/property_solutions/address.rb

@@ -0,0 +1,27 @@
+
+module PropertySolutions
+  class Address
+    
+    attr_accessor :address, :city, :state, :zip, :country  
+    
+    def initialize(arr = nil)
+      if (arr.nil?)
+        @address  = "" 
+        @city     = "" 
+        @state    = "" 
+        @zip      = "" 
+        @country  = ""
+      else
+        parse(arr)
+      end
+    end
+    
+    def parse(arr)
+      @address  = arr['Address']      || "" 
+      @city     = arr['City']         || ""
+      @state    = arr['State']        || ""
+      @zip      = arr['PostalCode']   || ""
+      @country  = arr['Country']      || ""
+    end
+  end
+end

data/app/models/property_solutions/api_consumer.rb

@@ -0,0 +1,41 @@
+
+class PropertySolutions::ApiConsumer
+  
+  @@field_order = 'id'
+  @@base = ''
+  
+  def self.request(method, data = nil)
+
+    data = {} if data.nil?
+    data.delete_if { |k,v| v.nil? }
+    
+    data = {
+      'auth' => {
+        'type'     => "basic",
+        'username' => PropertySolutions::username,
+        'password' => PropertySolutions::password,
+      },
+      'method' => {
+        'name'   => method, # required_service_name
+        'params' => data # parameters required for the web service
+      }
+    }
+
+    resp = Typhoeus::Request.new(
+        "https://#{PropertySolutions::domain}.propertysolutions.com/api/#{@@base}",
+        method:   :post,
+        headers:  { 'Content-type' => 'application/json, charset: utf-8' },
+        body:     data.to_json       
+      ).run
+    resp = JSON.parse(resp.response_body)
+    if (resp['response'].nil? || !resp['response']['error'].nil? || resp['response']['result'].nil?)
+      return false
+    end
+    return resp = resp['response']['result']
+  end
+  
+  def self.sort(arr)
+    return arr.sort { |x,y| x.send(@@field_order.to_sym) <=> y.send(@@field_order.to_sym) }
+  end
+
+end

data/app/models/property_solutions/phone.rb

@@ -0,0 +1,20 @@
+
+module PropertySolutions
+  class Phone
+    
+    attr_accessor :number, :description
+    
+    def initialize(arr = nil)
+      if (arr.nil?)
+        @number = ""
+        @description = ""
+      end
+    end
+    
+    def parse(arr)
+      @number       = arr["PhoneNumber"]      || ""
+      @description  = arr["PhoneDescription"] || ""
+    end
+  
+  end
+end

data/app/models/property_solutions/properties.rb

@@ -0,0 +1,75 @@
+
+module PropertySolutions
+  class Properties < PropertySolutions::ApiConsumer
+    
+    @@field_order = 'id'
+    @@base = 'properties' 
+  
+    # Find a property given a property ID
+    def self.find(property_id)
+      resp = self.request('getProperties', {
+        'propertyIds' => [property_id]
+      })
+      return nil if !resp || resp['PhysicalProperty'].nil? || resp['PhysicalProperty']['Property'].nil?
+      prop = Property.new(resp['PhysicalProperty']['Property'][0]) 
+      return prop
+    end
+    
+    # Reorder the properties that will be returned based on the given field
+    def self.reorder(field)
+      @@field_order = field 
+      return self
+    end
+    
+    # Return all the properties
+    def self.all
+      return self.properties
+    end
+    
+    # Return all the properties
+    def self.properties(property_ids = nil)
+      resp = self.request('getProperties', {
+        'propertyIds' => property_ids
+      })
+      return [] if !resp || resp['PhysicalProperty'].nil? || resp['PhysicalProperty']['Property'].nil?
+      props = resp['PhysicalProperty']['Property'].collect { |p| Property.new(p) }
+      props.sort! { |x,y| 
+        x.send(@@field_order.to_sym) <=> y.send(@@field_order.to_sym) 
+      }
+      return props
+    end
+    
+    #def self.floor_plans(property_id, property_floor_plan_ids = nil)
+    #  return self.request('getFloorPlans', { 
+    #    'propertyId' => property_id,
+    #    'propertyFloorPlanIds' => property_floor_plan_ids
+    #  })
+    #end
+    #
+    #def self.pet_types(property_ids)
+    #  return self.request('getGetTypes', { 
+    #    'propertyIds' => property_ids 
+    #  })
+    #end
+    #
+    #def self.rentable_items(property_id)
+    #  return self.request('getRentableItems', { 
+    #    'propertyId' => property_id 
+    #  })
+    #end
+    #
+    #def self.property_pick_lists(property_ids)
+    #  return self.request('getPropertyPickLists', { 
+    #    'propertyIds' => property_ids 
+    #  })
+    #end
+    #
+    #def self.property_preferences(property_id, keys = nil)
+    #  return self.request('getPropertyPreferences', { 
+    #    'property_id' => property_id,
+    #    'keys' => keys
+    #  })
+    #end
+  
+  end
+end

data/app/models/property_solutions/property.rb

@@ -0,0 +1,36 @@
+
+module PropertySolutions  
+  class Property
+    
+    attr_accessor :id, :name, :type, :short_desc, :long_desc, :website, :address, :phone, :disabled
+    
+    def initialize(arr)
+      if (arr.nil?)
+        @id          = ""
+        @name        = ""
+        @type        = ""
+        @short_desc  = ""
+        @long_desc   = ""
+        @website     = ""
+        @address     = Address.new
+        @phone       = Phone.new
+        @disabled    = false
+      else
+        parse(arr)
+      end
+    end
+  
+    def parse(arr)
+      @id          = arr['PropertyID']        || "" 
+      @name        = arr['MarketingName']     || ""
+      @type        = arr['Apartment']         || ""
+      @short_desc  = arr['ShortDescription']  || ""
+      @long_desc   = arr['LongDescription']   || ""
+      @website     = arr['webSite']           || ""
+      @address     = Address.new(arr['Address'])
+      @phone       = Phone.new(arr['Phone'])
+      @disabled    = arr['IsDisabled']        || ""
+    end
+        
+  end
+end

data/app/models/property_solutions/unit.rb

@@ -0,0 +1,100 @@
+
+module PropertySolutions  
+  class Unit
+    
+    attr_accessor :id, :name, :type, :short_desc, :long_desc, :website, :address, :phone, :disabled
+    
+    def initialize(arr)
+      if (arr.nil?)
+        @id          = ""
+        @name        = ""
+        @type        = ""
+        @short_desc  = ""
+        @long_desc   = ""
+        @website     = ""
+        @address     = Address.new
+        @phone       = Phone.new
+        @disabled    = false
+      else
+        parse(arr)
+      end
+    end
+  
+    def parse(arr)        
+      @number           = arr["@attributes"]["UnitNumber"]      || ""
+      @unit_id          = arr["@attributes"]["PropertyUnitId"]  || ""
+      @unit_type_id     = arr["@attributes"]["UnitTypeId"]      || ""
+      @floor_plan_id    = arr["@attributes"]["FloorplanId"]     || ""
+      @floor_plan_name  = arr["@attributes"]["FloorPlanName"]   || ""
+      @availability     = arr["@attributes"]["Availability"]    || ""
+      
+#      arr["Rent"]
+#      
+#        },
+#        "Rent"=>{
+#          "TermRent"=>[
+#            {"@attributes"=>{"LeaseTerm"=>6, "Rent"=>"0.00"}},
+#            {"@attributes"=>{"LeaseTerm"=>12, "Rent"=>"0.00"}},
+#            {"@attributes"=>{"LeaseTerm"=>18, "Rent"=>"0.00"}}
+#          ],
+#         "@attributes"=>{"MinRent"=>"0.00", "MaxRent"=>"0.00"}
+#        },
+#        "Deposit"=>{
+#          "@attributes"=>{"MinDeposit"=>"0.00", "MaxDeposit"=>"200.00"}
+#        }
+#      },
+
+    end
+  end
+end
+
+#{
+#  "ILS_Units"=> {
+#    "Unit"=> [
+#      {
+#        "@attributes"=>{
+#          "UnitNumber"=>"123-A", 
+#          "FloorPlanName"=>"Two Bed/ Two Bath",
+#          "Availability"=>"Not Available",
+#          "FloorplanId"=>137634,
+#          "UnitTypeId"=>"153497",
+#          "PropertyUnitId"=>2422769
+#        },
+#        "Rent"=>{
+#          "TermRent"=>[
+#            {"@attributes"=>{"LeaseTerm"=>6, "Rent"=>"0.00"}},
+#            {"@attributes"=>{"LeaseTerm"=>12, "Rent"=>"0.00"}},
+#            {"@attributes"=>{"LeaseTerm"=>18, "Rent"=>"0.00"}}
+#          ],
+#         "@attributes"=>{"MinRent"=>"0.00", "MaxRent"=>"0.00"}
+#        },
+#        "Deposit"=>{
+#          "@attributes"=>{"MinDeposit"=>"0.00", "MaxDeposit"=>"200.00"}
+#        }
+#      },
+#      {
+#        "@attributes"=>{
+#          "UnitNumber"=>"123-B",
+#          "FloorPlanName"=>"Two Bed/ Two Bath",
+#          "Availability"=>"Not Available", 
+#          "FloorplanId"=>137634, 
+#          "UnitTypeId"=>"153497", 
+#          "PropertyUnitId"=>2422769
+#        },
+#        "Rent"=>{
+#          "TermRent"=>[
+#            {"@attributes"=>{"LeaseTerm"=>6, "Rent"=>"0.00"}},
+#            {"@attributes"=>{"LeaseTerm"=>12, "Rent"=>"0.00"}},
+#            {"@attributes"=>{"LeaseTerm"=>18, "Rent"=>"0.00"}}
+#          ],
+#          "@attributes"=>{"MinRent"=>"0.00", "MaxRent"=>"0.00"}
+#        },
+#        "Deposit"=>{
+#          "@attributes"=>{
+#            "MinDeposit"=>"0.00", "MaxDeposit"=>"200.00"
+#          }
+#        }
+#      }
+#    ]
+#  }
+#}

data/app/models/property_solutions/units.rb

@@ -0,0 +1,47 @@
+
+module PropertySolutions
+  class Units < PropertySolutions::ApiConsumer
+  
+    @@field_order = 'id'
+    @@base = 'propertyunits'
+    
+ 	  ## Returns a list of unit types for a given property id
+ 	  #def self.unit_types(property_id)
+ 	  #  return self.request('getUnitTypes', {
+ 	  #    'propertyId' => property_id
+ 	  #  })
+ 	  #end
+ 	  #
+ 	  ## Pulls a Specials/Concessions for the propertyId passed.
+ 	  #def self.specials(property_id)
+ 	  #  return self.request('getSpecials', {
+ 	  #    'propertyId' => property_id
+ 	  #  })
+ 	  #end
+ 	  
+ 	  # Pulls a list of Unit availability and their pricing
+ 	  def self.where(options)
+ 	    resp = self.request('getUnitsAvailabilityAndPricing', {
+ 	      'propertyId'         => options['property_id'],   # [Integer] required
+ 	      'floorplanId'        => options['floor_plan_id'], # [Integer] optional
+ 	      'unitTypeId'         => options['unit_type_id'],  # [Integer] optional
+ 	      'propertyUnitId'     => options['unit_id'],       # [Integer] optional
+ 	      'availableUnitsOnly' => options['available']      # [Boolean] optional
+ 	    })
+ 	    return resp
+ 	    #return [] if !resp || resp['PhysicalProperty'].nil? || resp['PhysicalProperty']['Property'].nil?
+      #units = resp['PhysicalProperty']['Property'].collect { |p| Property.new(p) }
+      #units = self.sort(units)
+      #return units
+ 	  end
+    
+    ## Pulls a list of Amenities
+    #def self.amenities(property_id, unit_number = nil)
+    #  return self.request('getAmenities', {      
+    #    'propertyId' => property_id,
+    #    'unitNumber' => unit_number
+    #  })
+    #end
+    
+  end
+end

data/bin/propertysolutions

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'rails/all'
+require 'propertysolutions'
+require 'propertysolutions/engine'
+require 'propertysolutions/version'
+require 'propertysolutions/ps_helper'
+require 'trollop'
+
+#puts "Usage:"
+#puts "Create a new propertysolutions app:"
+#puts "  propertysolutions new <app_path>"
+#puts "Initialize an existing rails app as a new propertysolutions app:"
+#puts "  propertysolutions init [<app_path>]\n\n"
+#exit
+  
+#global_opts = Trollop::options do
+#  banner <<-EOS
+#--------------------------------------------------------------------------------  
+#Property Solutions
+#A gem to consume the Property Solutions API
+#--------------------------------------------------------------------------------
+#Usage:
+#propertysolutions new <path>
+#propertysolutions init [--force] [<path>]
+#--------------------------------------------------------------------------------
+#EOS
+#  version "Caboose CMS Version #{Caboose::VERSION}\n\n"
+#  stop_on ['version', 'new', 'init']
+#end
+#
+#cmd = ARGV.shift
+#case cmd
+#
+#when 'new'
+#  
+#  path = ARGV.shift
+#  if (path.nil?)
+#    puts "Error: path for new app is required.\n\n"
+#    global_opts.help
+#    exit
+#  end
+#  
+#  puts "Creating the new rails app..."
+#  `rails new #{path} -d=mysql`  
+#  helper = CabooseHelper.new(path, true)
+#  helper.init_all
+#  
+#when 'init'
+#  
+#  opts = Trollop::options do
+#    opt :force, 'Force re-installation of all propertysolutions files.', :default => false
+#  end
+#  
+#  path = ARGV.shift
+#  path = Dir.pwd if path.nil?  
+#  is_rails_app = File.exists?(File.join(path, 'config', 'environment.rb'))  
+#  if (!is_rails_app)
+#    puts "Error: Not a rails app.\n\n"
+#    global_opts.help
+#    exit
+#  end
+#  
+#  helper = CabooseHelper.new(path, opts.force)
+#  helper.init_all
+#  
+#else
+#end
+#

data/config/routes.rb

@@ -0,0 +1,3 @@
+
+PropertySolutions::Engine.routes.draw do
+end

data/lib/property_solutions/engine.rb

@@ -0,0 +1,23 @@
+require 'typhoeus'
+require 'json'
+
+module PropertySolutions
+  
+  def PropertySolutions.log(message, title = nil)
+    if (Rails.logger.nil?)
+      puts "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+      puts title.to_s unless title.nil?
+      puts message
+      puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
+    else
+      Rails.logger.debug("\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
+      Rails.logger.debug(title.to_s) unless title.nil?
+      Rails.logger.debug(message)
+      Rails.logger.debug(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n")
+    end
+  end
+   
+  class Engine < ::Rails::Engine
+    isolate_namespace PropertySolutions
+  end
+end

data/lib/property_solutions/version.rb

@@ -0,0 +1,3 @@
+module PropertySolutions
+  VERSION = '0.0.14'
+end

data/lib/propertysolutions.rb

@@ -0,0 +1,14 @@
+require "property_solutions/engine"
+
+module PropertySolutions
+      
+  mattr_accessor :domain
+  @@domain = ''
+  
+  mattr_accessor :username
+  @@username = ''
+
+  mattr_accessor :password
+  @@password = ''
+  
+end

data/lib/tasks/propertysolutions.rake

@@ -0,0 +1,27 @@
+require "property_solutions/version"
+
+namespace :property_solutions do
+
+  desc "Initializes the database for a caboose installation"
+  task :db => :environment do
+    drop_tables
+    create_tables
+    load_data
+  end
+  desc "Drops all caboose tables"
+  task :drop_tables => :environment do drop_tables end
+  desc "Creates all caboose tables"
+  task :create_tables => :environment do create_tables end
+  desc "Loads data into caboose tables"
+  task :load_data => :environment do load_data end
+  
+  def drop_tables
+  end
+  
+  def create_tables
+  end
+  
+  def load_data
+  end
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: propertysolutions
+version: !ruby/object:Gem::Version
+  version: 0.0.14
+  prerelease: 
+platform: ruby
+authors:
+- William Barry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that interacts with the property management site propertysolutions.com
+email:
+- william@nine.is
+executables:
+- propertysolutions
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/property_solutions/address.rb
+- app/models/property_solutions/api_consumer.rb
+- app/models/property_solutions/phone.rb
+- app/models/property_solutions/properties.rb
+- app/models/property_solutions/property.rb
+- app/models/property_solutions/unit.rb
+- app/models/property_solutions/units.rb
+- bin/propertysolutions
+- config/routes.rb
+- lib/property_solutions/engine.rb
+- lib/property_solutions/version.rb
+- lib/propertysolutions.rb
+- lib/tasks/propertysolutions.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/williambarry007/propertysolutions
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A gem to help consume the API for propertysolutions.com
+test_files: []