rpx 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+spec/spec.yml
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rpx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 gregory
+
+MIT License
+
+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,54 @@
+# Rpx
+
+Ruby Client to talk with the RealPage Exchange SOAP API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rpx'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rpx
+
+## Usage
+
+	Rpx.configure do |config|
+		config.api_url     = API_URL
+		config.licensekey = KEY
+    	config.username    = USERNAME
+      	config.password    = PASSWORD
+	end
+
+	payload={
+		fromdate: '2014-05-10',
+		todate: '2014-06-10',
+		events: ['moveout']
+	}
+	residents = Rpx::Resident.with_events(payload) #You'll have residents with their leases
+	residents.count => 10
+	resident = residents.first
+
+	resident.firstname
+	resident.email
+	resident.leases.count => 3
+	lease = resident.leases.last
+
+	lease.unitid
+
+  resident = Rpx::Residend.find(resident_id: resident_id, siteid: sid, pmcid: pmcid) #=> Resident
+  residents = Resident.current_residents(siteid: sid, pmcid: pmcid)
+	etc (check the code, it's pretty straight forward!)
+
+## Contributing
+
+1. Fork it ( http://github.com/gregory/rpx/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rpx.rb

@@ -0,0 +1,13 @@
+require 'savon'
+require 'hashie'
+Dir[File.dirname(__FILE__) + '/rpx/**/*.rb'].each{ |file| require file }
+
+module Rpx
+  extend self
+
+  attr_accessor :config
+
+  def configure
+    @config = Configuration.new.tap{ |configuration| yield(configuration) }
+  end
+end

data/lib/rpx/client.rb

@@ -0,0 +1,59 @@
+module Rpx
+  class Client
+    NAMESPACES = {
+      "xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/",
+      "xmlns:tem"=>"http://tempuri.org/"
+    }
+
+    def initialize(options={})
+      @read_timeout = options.delete(:read_timeout){ Rpx.config.read_timeout || 120 }
+      @debug = options.delete(:debug){false}
+    end
+
+    def add_attributes_if_present(xml, options, attributes)
+      return add_attributes_if_present(xml, options, [attributes]) unless attributes.is_a? Array
+
+      attributes.each{ |attribute|  xml.tem(attribute, options[attribute]) if options[attribute] }
+    end
+
+    def api_call(action_name, options)
+      raw_response = client.request action_name do
+        soap.xml do |xml|
+          xml.soapenv :Envelope, NAMESPACES do |xml|
+            xml.soapenv :Header
+            xml.soapenv :Body do |xml|
+              xml.tem action_name do |xml|
+                xml.tem :auth do |xml|
+                  xml.tem :siteid, options.fetch(:siteid)
+                  xml.tem :pmcid, options.fetch(:pmcid)
+                  xml.tem :username, Rpx.config.username
+                  xml.tem :password, Rpx.config.password
+                  xml.tem :licensekey, Rpx.config.licensekey
+                end
+                yield(xml)
+              end
+            end
+          end
+        end
+      end
+
+      resident_list_from_raw({ action_name: action_name, raw_response: raw_response })
+    end
+
+    private
+
+    def client
+      @client ||= Savon::Client.new(log: @debug, pretty_print_xml: true) do
+        wsdl.document = Rpx.config.api_url
+        http.read_timeout = @read_timeout
+      end
+    end
+
+    def resident_list_from_raw(params)
+      action_name  = params.fetch(:action_name)
+      raw_response = params.fetch(:raw_response)
+
+      raw_response[:"#{action_name}_response"][:"#{action_name}_result"][:residentlist][:resident]
+    end
+  end
+end

data/lib/rpx/configuration.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+module Rpx
+  class Configuration < OpenStruct;
+    #TODO: be more restrictive with the options
+  end
+end

data/lib/rpx/lease.rb

@@ -0,0 +1,55 @@
+module Rpx
+  class Lease < Hashie::Trash
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :leaseid
+
+    property :leasestatus
+    property :residentrelationship
+
+    property :datesigned
+    property :datebegin
+    property :dateend
+    property :moveindate
+    property :moveoutdate
+
+    property :noticegivendate
+    property :noticefordate
+
+    property :unitid
+    property :unitnumber
+    property :buildingid
+    property :buildingnumber
+
+    property :renewaloffersavailable
+    property :acceptpayments
+    property :acceptcheck
+
+    property :aspets
+    property :inevict
+    property :incollection
+    property :guarantorbit
+    property :signerbit
+    property :hohbit
+    property :activebit
+
+    class Boolean
+      def self.coerce(value)
+        value.is_a?(String) ? (value.downcase == 'true') : value
+      end
+    end
+
+    coerce_key :activebit, :hohbit, :signerbit, :guarantorbit, :inevict, :acceptpayments, :acceptcheck, Boolean
+
+    def self.coerce(list_of_hash)
+      return self.coerce([list_of_hash]) unless list_of_hash.is_a?(Array)
+
+      list_of_hash.map{ |h| self.new(h) }
+    end
+
+    def moved_out?
+      self.moveoutdate != nil
+    end
+  end
+end

data/lib/rpx/resident.rb

@@ -0,0 +1,92 @@
+module Rpx
+  class Resident < Hashie::Trash
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :resident_id, from: :residentmemberid
+    property :residenthouseholdid
+    property :leaseid
+
+    property :unitid
+    property :buildingnumber
+    property :unitnumber
+
+    property :firstname
+    property :lastname
+    property :billingname
+
+    property :homephone
+    property :workphone
+    property :email
+    property :faxnumber
+    property :cellphone
+
+    property :inevict
+    property :nochk
+    property :incollection
+    property :inpaymentplan
+    property :pendingbalance
+    property :balance
+    property :estfutchgs
+    property :curlateamt
+    property :leasestatus
+    property :leasetype
+    property :residenttype, with: ->(value){ value == 'H' ? 'Head of Household' : 'Other'}
+
+    property :siteid
+    property :pmcid
+
+    def residenttype
+      self[:residenttype] == 'H' ? 'Head of Household' : 'Other'
+    end
+
+    def self.where(options, client=Client.new(options))
+      resident_hashs = client.api_call :getresidentlist, options do |xml|
+        xml.tem :residentsearch do |xml|
+          xml.tem :extensionData
+          client.add_attributes_if_present(xml, options, Resident.properties.to_a)
+        end
+      end
+
+      site_properties = {siteid: options.fetch(:siteid), pmcid: options.fetch(:pmcid)}
+      [resident_hashs].flatten.map{ |resident_hash| Resident.new(resident_hash.merge(site_properties)) }
+    end
+
+    def leases
+      @leases ||= ResidentWithLease.find({resident_id: self.resident_id, siteid: siteid, pmcid: pmcid}).leases
+    end
+
+    def current_lease
+      @current_lease ||= leases.sort_by{ |lease| lease.dateend }.last
+    end
+
+    def status
+      current_lease.leasestatus
+    end
+
+    def moved_out?
+      return false if current_resident?
+
+      current_lease.moved_out?
+    end
+
+    def minor?
+      current_lease.residentrelationship.downcase[/minor/]
+    end
+    def self.current_residents(options, client=Client.new(options))
+      self.where(options, client).select{|resident| resident.current_resident? }
+    end
+
+    def current_resident?
+      self.leasestatus == "Current"
+    end
+
+    def fullname
+      "#{firstname} #{lastname}".strip #TODO: ask them to add middleman saluration and generation in the api
+    end
+
+    def status
+      leasestatus
+    end
+  end
+end

data/lib/rpx/resident_with_lease.rb

@@ -0,0 +1,81 @@
+module Rpx
+  class ResidentWithLease < Resident
+    VALID_EVENTS = ['moveout', 'movein']
+
+    property :residentid
+    property :namesalutation
+    property :middlename
+    property :namegeneration
+
+    property :residentagestatus
+
+    property :email, from: :emailaddress
+    property :leases, from: :leaseslist, with: ->(v){ binding.pry if v.nil?; v[:leases]}
+    coerce_key :leases, Rpx::Lease
+
+    def self.where(options, client=Client.new(options))
+      resident_hashs = client.api_call :residentsearchbyinfo, options do |xml|
+        xml.tem :residentsearch do |xml|
+          xml.tem :extensionData
+          client.add_attributes_if_present(xml, options, ResidentWithLease.properties.to_a)
+
+          if options[:leaselist]
+            xml.tem :leaselist do |xml|
+              xml.tem :leases do |xml|
+                client.add_attributes_if_present(xml, options, options.fetch(:leaselist).keys)
+              end
+            end
+          end
+        end
+      end
+
+      site_properties = {siteid: options.fetch(:siteid), pmcid: options.fetch(:pmcid)}
+      [resident_hashs].flatten.map{ |resident_hash| ResidentWithLease.new(resident_hash.merge(site_properties))  }
+    end
+
+
+    def current_resident?
+      current_lease.leasestatus == "Current Resident"
+    end
+
+    def moved_out?
+      current_lease.moved_out?
+    end
+
+    def self.find(options, client=Client.new(options))
+      resident_hash = client.api_call :getresidentbyresidentid, options do |xml|
+        xml.tem :residentid, options.fetch(:resident_id)
+      end
+
+      site_properties = {siteid: options.fetch(:siteid), pmcid: options.fetch(:pmcid)}
+      new(resident_hash.merge(site_properties))
+    end
+
+    def self.with_events(options, client=Client.new(options))
+      events = [*options.fetch(:events)]
+      raise InvalidArgument.new(":events must be included in #{VALID_EVENTS.join(', ')}") unless !events.blank? && events.all?{|event| VALID_EVENTS.include? event}
+
+      resident_hashs = client.api_call :residentsearchbydate, options do |xml|
+        xml.tem :residentsearch do |xml|
+          xml.tem :extensionData
+          xml.tem :startdate, options.fetch(:startdate) #start date to retrieve active residents
+          xml.tem :enddate, options.fetch(:enddate) #end date to retrieve active residents
+          xml.tem :events do |xml|
+            events.each{|event| xml.tem :string, event}
+          end
+          client.add_attributes_if_present(xml, options, :headofhousehold)
+        end
+      end
+      site_properties = {siteid: options.fetch(:siteid), pmcid: options.fetch(:pmcid)}
+      [resident_hashs].flatten.map{ |resident_hash| new(resident_hash.merge(site_properties)) }
+    end
+
+    def fullname
+      "#{namesalutation} #{firstname} #{middlename} #{lastname} #{namegeneration}".strip
+    end
+
+    def residenttype
+      residentagestatus
+    end
+  end
+end

data/lib/rpx/version.rb

@@ -0,0 +1,3 @@
+module Rpx
+  VERSION = "0.0.2"
+end

data/rpx.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rpx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rpx"
+  spec.version       = Rpx::VERSION
+  spec.authors       = ["gregory"]
+  spec.email         = ["greg2502@gmail.com"]
+  spec.summary       = %q{RealPage Exchange Ruby Wrapper}
+  spec.description   = %q{ruby client for the RealPageExchange SOAP API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-stack_explorer"
+  spec.add_development_dependency "pry-rescue"
+
+  spec.add_dependency "savon", "~> 0.9.14"
+  spec.add_dependency "hashie", '~>2.1.1'
+end

data/spec/lib/rpx/client_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Rpx do
+  describe 'test' do
+    it 'test' do
+    end
+  end
+end

data/spec/lib/rpx_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Rpx do
+  subject{ described_class }
+
+  describe '.configure' do
+    let(:api_url){"foo_url"}
+    let(:license_key){"foo_license"}
+    let(:username){"foo_username"}
+    let(:password){"foo_password"}
+
+    before do
+      subject.configure do |config|
+        config.api_url = api_url
+        config.license_key = license_key
+        config.username = username
+        config.password = password
+      end
+    end
+
+    it "has the credential parameters" do
+      subject.config.api_url.should eq api_url
+      subject.config.api_url.should eq  api_url
+      subject.config.license_key.should eq  license_key
+      subject.config.username.should eq  username
+      subject.config.password.should eq  password
+    end
+  end
+end

data/spec/spec.yml.sample

@@ -0,0 +1,5 @@
+configure:
+  username: USERNAME
+  password: PASSWORD
+  licensekey: LICENSE
+  api_url: "https://qagateway.rpx.realpage.com/rpxgateway/partner/RentMineOnline/RentMineOnline.svc?wsdl"

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require 'yaml'
+require 'pry'
+Bundler.setup(:default, :development)
+
+require_relative '../lib/rpx'
+$LOAD_PATH <<  File.dirname(__FILE__)
+RSpec.configure do |config|
+  config.before :suite do
+    Rpx.configure do |config|
+      configure          = settings["configure"]
+      config.api_url     = configure["api_url"]
+      config.licensekey = configure["licensekey"]
+      config.username    = configure["username"]
+      config.password    = configure["password"]
+    end
+  end
+
+  def settings
+    @settings ||= YAML::load_file(File.join(File.dirname(File.expand_path(__FILE__)), 'spec.yml'))
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: rpx
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- gregory
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.14
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: ruby client for the RealPageExchange SOAP API
+email:
+- greg2502@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rpx.rb
+- lib/rpx/client.rb
+- lib/rpx/configuration.rb
+- lib/rpx/lease.rb
+- lib/rpx/resident.rb
+- lib/rpx/resident_with_lease.rb
+- lib/rpx/version.rb
+- rpx.gemspec
+- spec/lib/rpx/client_spec.rb
+- spec/lib/rpx_spec.rb
+- spec/spec.yml.sample
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: RealPage Exchange Ruby Wrapper
+test_files:
+- spec/lib/rpx/client_spec.rb
+- spec/lib/rpx_spec.rb
+- spec/spec.yml.sample
+- spec/spec_helper.rb
+has_rdoc: