moxiworks_platform 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b5c85cf1bfe190344e072b8d07a22f7e83e1ef
-  data.tar.gz: 169e7df98ab8afbcc2194a7fbbec5711abad3b5a
+  metadata.gz: 2c3a36316384942e54ebdc8a4bbe8a366646392d
+  data.tar.gz: a5f6651b3bda6dd6ce27424db1cb8fc7ab857cb6
 SHA512:
-  metadata.gz: 9e988313ba11d00ccea908ba028b5d9b8a43ca2363be9d3d3b6512b2442bea96bbfaadd66135bc4149e4e2bf90482951f73475e925da48a94ba85ec0559713a4
-  data.tar.gz: 844c67fbda0d00b1cf5a5728552063693822e3631edc034b37ab49d583fcbbe3953c60b322a3fe795d35d583b3eacddd3fc8444992d801ab3d62189dbafcc537
+  metadata.gz: 707c1d68ecf7f5ea97b456330f1504ef3b6d065378b0d9a106aca6ad611da912ae77af5609fc7638c1b166076a65cb4bf8c57995f22e0cb5a1ad7d3550baa83f
+  data.tar.gz: 2895bcc805bd0e6ed0377097c1ec00e8c2ff6303b592cb11b1183efb7839fc00b62d9f8da91380f3a02a704d125c24d6be4f594ea3fb3fb4c592635621014f78

data/lib/moxiworks_platform.rb

@@ -1,4 +1,5 @@
 require 'moxiworks_platform/version'
+require 'moxiworks_platform/session'
 require 'moxiworks_platform/config'
 require 'moxiworks_platform/exception'
 require 'moxiworks_platform/resource'

data/lib/moxiworks_platform/buyer_transaction.rb

@@ -56,7 +56,7 @@ module  MoxiworksPlatform
     #
     #  This will be a single digit integer that can be [1,2,3,4,5].
     #   For more information on BuyerTransaction stages see
-    #     <a href='https://moxiworks-platform.github.io/#buyertransaction-stages'>The Moxi Works Platform Documentation</a>
+    #     {https://moxiworks-platform.github.io/#buyertransaction-stages The Moxi Works Platform Documentation}
     #
     # @return [Integer] the stage the BuyerTransaction is in.
     attr_accessor :stage
@@ -71,7 +71,7 @@ module  MoxiworksPlatform
     #   This will be an enumerated string that can be can be
     #   'initialized', 'configured' , 'active' , 'pending'  or 'complete'
     #   For more information on BuyerTransaction stages see
-    #     <a href='https://moxiworks-platform.github.io/#buyertransaction-stages'>The Moxi Works Platform Documentation</a>
+    #     {https://moxiworks-platform.github.io/#buyertransaction-stages The Moxi Works Platform Documentation}
     #
     #
     # @return [String, enumerated] current state of BuyerTransaction
@@ -168,7 +168,7 @@ module  MoxiworksPlatform
 
     # @!attribute start_timestamp
     #
-    # **NON MLS TRANSACTIONS ONLY ** this is the Unix timestamp
+    #  this is the Unix timestamp
     #   representing the date the agent initiated transaction discussions
     #   with the client.
     #
@@ -256,7 +256,7 @@ module  MoxiworksPlatform
     #
     # In order to promote a BuyerTransaction to the next stage, set  the
     # promote_transaction attribute to true. For more information about
-    # BuyerTransaction stages, see <a href='https://moxiworks-platform.github.io/#promoting-buyertransaction-stage>The Moxi Works Platform Documentation</a>.
+    # BuyerTransaction stages, see {https://moxiworks-platform.github.io/#promoting-buyertransaction-stage The Moxi Works Platform Documentation}.
     # promote_transaction is only available for BuyerTransaction updates.
     # Newly created BuyerTransaction objects will automatically be created in
     # stage 3 (active)
@@ -290,9 +290,9 @@ module  MoxiworksPlatform
     # @option opts [String] :area_of_interest string representing a locality that the client has expressed interest in purchasing a property within
     # @option opts [Integer or Float] :min_baths minimum desired number of bathrooms in potential properties
     # @option opts [Integer or Float] :max_baths maximum desired number of bathrooms in potential properties
-    # @option opts [Boolean] :is_mls_transaction Whether the property being purchased is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS. If is_mls_transaction is false, then start_timestamp should be populated.
+    # @option opts [Boolean] :is_mls_transaction Whether the property being purchased is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS.
     # @option opts [String] :mls_number  mls number associated with the transaction -- mls_number should be populated only if is_mls_transaction is true.
-    # @option opts [Integer] :start_timestamp  Unix timestamp representing the date the property was put on sale -- start_timestamp should be populated only if is_mls_transaction is false.
+    # @option opts [Integer] :start_timestamp  Unix timestamp representing the date the agent initiated transaction discussions with the client.
     # @option opts [Float] :commission_percentage what percentage the commission is if percentage based -- A BuyerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :commission_flat_fee how much the commission is if flat fee -- A BuyerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :target_price  target price associated with the transaction if using a target price rather than price range
@@ -304,7 +304,7 @@ module  MoxiworksPlatform
     #        agent_identifier:'testis@testomatical.com',
     #        moxi_works_contact_id:'deadbeef-dead-beef-bad4-feedfacebad',
     #        notes: 'foo deeaz',
-    #        name: 'whateverz'
+    #        transaction_name: 'whateverz'
     #        address: '1234 there ave',
     #        city: 'cityville'
     #        state:  'provinceland',
@@ -440,9 +440,9 @@ module  MoxiworksPlatform
     # @option opts [String] :area_of_interest string representing a locality that the client has expressed interest in purchasing a property within
     # @option opts [Integer or Float] :min_baths minimum desired number of bathrooms in potential properties
     # @option opts [Integer or Float] :max_baths maximum desired number of bathrooms in potential properties
-    # @option opts [Boolean] :is_mls_transaction Whether the property being purchased is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS. If is_mls_transaction is false, then start_timestamp should be populated.
+    # @option opts [Boolean] :is_mls_transaction Whether the property being purchased is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS.
     # @option opts [String] :mls_number  mls number associated with the transaction -- mls_number should be populated only if is_mls_transaction is true.
-    # @option opts [Integer] :start_timestamp  Unix timestamp representing the date the property was put on sale -- start_timestamp should be populated only if is_mls_transaction is false.
+    # @option opts [Integer] :start_timestamp   Unix timestamp representing the date the agent initiated transaction discussions with the client.
     # @option opts [Float] :commission_percentage what percentage the commission is if percentage based -- A BuyerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :commission_flat_fee how much the commission is if flat fee -- A BuyerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :target_price  target price associated with the transaction if using a target price rather than price range
@@ -457,7 +457,7 @@ module  MoxiworksPlatform
     #        agent_identifier:'testis@testomatical.com',
     #        moxi_works_transaction_id:'deadbeef-dead-beef-bad4-feedfacebad',
     #        notes: 'foo deeaz',
-    #        name: 'whateverz'
+    #        transaction_name: 'whateverz'
     #        address: '1234 there ave',
     #        city: 'cityville'
     #        state:  'provinceland',

data/lib/moxiworks_platform/contact.rb

@@ -19,11 +19,23 @@ module MoxiworksPlatform
     #   @return [String] your system's unique ID for the contact
     attr_accessor :partner_contact_id
 
+    # @!attribute anniversary
+    #   the Contact's anniversary displayed as a Unix Timestamp. This will be empty if the data is unavailable
+    #
+    # @return [Integer or nil] -- Unix Timestamp
+    attr_accessor :anniversary
+
+    # @!attribute birthday
+    #   the Contact's birthday displayed as a Unix Timestamp. This will be empty if the data is unavailable
+    #
+    # @return [Integer or nil] -- Unix Timestamp
+    attr_accessor :birthday
+
     # @!attribute contact_name
     #   the full name of this Contact
     #
     #   @return [String] -- Default ''
-    attr_accessor :contact_name
+    attr_accessor :contact_namer
 
     # @!attribute gender
     #   the gender  of this Contact. the first initial of either gender type may
@@ -46,6 +58,12 @@ module MoxiworksPlatform
     #   @return [String] -- Default ''
     attr_accessor :home_city
 
+    # @!attribute home_purchase_anniversary
+    #   the anniversary of the purchase of contact's home displayed as a Unix Timestamp. This will be empty if the data is unavailable
+    #
+    # @return [Integer or nil] -- Unix Timestamp
+    attr_accessor :home_purchase_anniversary
+
     # @!attribute home_state
     #   the state in which the residence of this Contact is located
     #
@@ -74,6 +92,12 @@ module MoxiworksPlatform
     #   @return [String] -- Default ''
     attr_accessor :home_country
 
+    # @!attribute is_new_contact
+    # whether the Contact is considered new
+    #
+    # @return [Boolean]
+    attr_accessor :is_new_contact
+
     # @!attribute job_title
     #   the specific job title this contact has; ex: 'Senior VP of Operations'
     #

data/lib/moxiworks_platform/event.rb

@@ -1,26 +1,24 @@
 module MoxiworksPlatform
   # = Moxi Works Platform Event
   class Event < MoxiworksPlatform::Resource
-    # @!attribute moxi_works_agent_id
-    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which a event is
-    #   or is to be associated with.
-    #
-    #   this must be set for any Moxi Works Platform transaction
-    #
-    #   @return [String] the Moxi Works Platform ID of the agent
-    attr_accessor :moxi_works_agent_id
 
-    # @!attribute partner_event_id
-    # your system's event ID for the event
+    # @!attribute all_day
+    # whether the event is an all day event
     #
-    # @return [String] representing the ID of the event in your system
-    attr_accessor :partner_event_id
+    # @return [Boolean]
+    attr_accessor :all_day
 
-    # @!attribute event_subject
-    # a short description of the event
+    # @!attribute attendees
+    # a comma separated list of attendee IDs
     #
     # @return [String]
-    attr_accessor :event_subject
+    attr_accessor :attendees
+
+    # @!attribute event_end
+    # a unix timestamp representing the end time of the event
+    #
+    # @return [Integer]
+    attr_writer :event_end
 
     # @!attribute location
     # a short description of the location of the event
@@ -28,17 +26,17 @@ module MoxiworksPlatform
     # @return [String]
     attr_accessor :event_location
 
-    # @!attribute note
-    # a more detailed description of the event
+    # @!attribute event_start
+    # a unix timestamp representing the start time of the event
     #
-    # @return [String]
-    attr_accessor :note
+    # @return [Integer]
+    attr_writer :event_start
 
-    # @!attribute remind_minutes_before
-    # how many minutes before the event a reminder should be sent
+    # @!attribute event_subject
+    # a short description of the event
     #
-    # @return [Integer]
-    attr_writer :remind_minutes_before
+    # @return [String]
+    attr_accessor :event_subject
 
     # @!attribute is_meeting
     # whether this event is a meeting
@@ -46,35 +44,38 @@ module MoxiworksPlatform
     # @return [Boolean]
     attr_accessor :is_meeting
 
-    # @!attribute event_start
-    # a unix timestamp representing the start time of the event
+    # @!attribute moxi_works_agent_id
+    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which a event is
+    #   or is to be associated with.
     #
-    # @return [Integer]
-    attr_writer :event_start
+    #   this must be set for any Moxi Works Platform transaction
+    #
+    #   @return [String] the Moxi Works Platform ID of the agent
+    attr_accessor :moxi_works_agent_id
 
-    # @!attribute event_end
-    # a unix timestamp representing the end time of the event
+    # @!attribute note
+    # a more detailed description of the event
     #
-    # @return [Integer]
-    attr_writer :event_end
+    # @return [String]
+    attr_accessor :note
 
-    # @!attribute all_day
-    # whether the event is an all day event
+    # @!attribute partner_event_id
+    # your system's event ID for the event
     #
-    # @return [Boolean]
-    attr_accessor :all_day
+    # @return [String] representing the ID of the event in your system
+    attr_accessor :partner_event_id
 
-    # @!attribute required_attendees
-    # a comma separated list of attendee IDs
+    # @!attribute remind_minutes_before
+    # how many minutes before the event a reminder should be sent
     #
-    # @return [String]
-    attr_accessor :required_attendees
+    # @return [Integer]
+    attr_writer :remind_minutes_before
 
-    # @!attribute optional_attendees
-    # a comma separated list of attendee IDs
+    # @!attribute send_reminder
+    # whether to send a reminder to attendees
     #
-    # @return [String]
-    attr_accessor :optional_attendees
+    # @return [Boolean]
+    attr_accessor :send_reminder
 
     # Creates a new Event in Moxi Works Platform
     # @param [Hash] opts named parameter Hash

data/lib/moxiworks_platform/listing.rb

@@ -2,19 +2,6 @@ module MoxiworksPlatform
   # = Moxi Works Platform Listing
   class Listing < MoxiworksPlatform::Resource
 
-    # @!attribute moxi_works_listing_id
-    #   moxi_works_listing_id is the Moxi Works Platform ID of the listing
-    #
-    #   this must be set for any Moxi Works Platform transaction
-    #
-    #   @return [String] the Moxi Works Platform ID of the listing
-    attr_accessor :moxi_works_listing_id
-
-    # @!attribute lot_size_acres
-    #
-    # @return [float] the property acreage of the listing
-    attr_accessor :lot_size_acres
-
     # @!attribute address
     #
     # @return [String] street address of property
@@ -25,35 +12,15 @@ module MoxiworksPlatform
     # @return [String] a second line for street address if needed
     attr_accessor :address2
 
-    # @!attribute city
-    #
-    # @return [String] city of property address
-    attr_accessor :city
-
-    # @!attribute state
-    #
-    # @return [String] state of property address
-    attr_accessor :state_or_province
-
-    # @!attribute postal_code
-    #
-    # @return [String] zip code of property address
-    attr_accessor :postal_code
-
-    # @!attribute county_or_parish
+    # @!attribute agent_created_listing
     #
-    # @return [String] county of property address
-    attr_accessor :county_or_parish
+    # @return [Boolean] whether the agent created the listing
+    attr_accessor :agent_created_listing
 
-    # @!attribute latitude
-    #
-    # @return [String] latitude of the property
-    attr_accessor :latitude
-
-    # @!attribute longitude
+    # @!attribute association_fee
     #
-    # @return [String] longitude of the property
-    attr_accessor :longitude
+    # @return [Integer] HOA fees for property
+    attr_accessor :association_fee
 
     # @!attribute bathrooms_full
     #
@@ -95,36 +62,26 @@ module MoxiworksPlatform
     # @return [Integer] number of bedrooms
     attr_accessor :bedrooms_total
 
-    # @!attribute public_remarks
+    # @!attribute city
     #
-    # @return [String] agent generated comments regarding the property
-    attr_accessor :public_remarks
+    # @return [String] city of property address
+    attr_accessor :city
 
-    # @!attribute modification_timestamp
+    # @!attribute county_or_parish
     #
-    # @return [String] string representing date in format 'MM/DD/YYYY'
-    attr_accessor :modification_timestamp
+    # @return [String] county of property address
+    attr_accessor :county_or_parish
 
-    # @!attribute internet_address_display_yn
+    # @!attribute created_date
     #
-    # @return [Boolean] whether to display the address publicly
-    attr_accessor :internet_address_display_yn
+    # @return [String] string representing date in format 'MM/DD/YYYY'
+    attr_accessor :created_date
 
     # @!attribute days_on_market
     #
     # @return [Integer] days listing has been on market
     attr_accessor :days_on_market
 
-    # @!attribute listing_contract_date
-    #
-    # @return [String] string representing date in format 'MM/DD/YYYY'
-    attr_accessor :listing_contract_date
-
-    # @!attribute created_date
-    #
-    # @return [String] string representing date in format 'MM/DD/YYYY'
-    attr_accessor :created_date
-
     # @!attribute elementary_school
     #
     # @return [String] elementary school for the property
@@ -135,20 +92,30 @@ module MoxiworksPlatform
     # @return [Integer] garage spaces for the property
     attr_accessor :garage_spaces
 
-    # @!attribute waterfront_yn
-    #
-    # @return [Boolean] whether the property has waterfront acreage
-    attr_accessor :waterfront_yn
-
     # @!attribute high_school
     #
     # @return [String] High school for property
     attr_accessor :high_school
 
-    # @!attribute association_fee
+    # @!attribute internet_address_display_yn
     #
-    # @return [Integer] HOA fees for property
-    attr_accessor :association_fee
+    # @return [Boolean] whether to display the address publicly
+    attr_accessor :internet_address_display_yn
+
+    # @!attribute internet_entire_listing_display_yn
+    #
+    # @return [Boolean] whether to display listing on internet
+    attr_accessor :internet_entire_listing_display_yn
+
+    # @!attribute latitude
+    #
+    # @return [String] latitude of the property
+    attr_accessor :latitude
+
+    # @!attribute list_agent_full_name
+    #
+    # @return [String] name of listing agent
+    attr_accessor :list_agent_full_name
 
     # @!attribute list_office_name
     #
@@ -160,15 +127,47 @@ module MoxiworksPlatform
     # @return [Integer] listed price
     attr_accessor :list_price
 
+    # @!attribute list_office_aor
+    #
+    # @return [String] MLS the listing is listed with
+    attr_accessor :list_office_aor
+
+    # @!attribute listing_contract_date
+    #
+    # @return [String] string representing date in format 'MM/DD/YYYY'
+    attr_accessor :listing_contract_date
+
     # @!attribute listing_id
     #
     # @return [String] the mls number associated with the listing
     attr_accessor :listing_id
 
-    # @!attribute list_agent_full_name
+    # @!attribute listing_images
     #
-    # @return [String] name of listing agent
-    attr_accessor :list_agent_full_name
+    # @return [Array] array of image Hashes in the format
+    #  {
+    #     image_thumb_url: [String] url to thumbail size image (smallest),
+    #     image_small_url: [String] url to small size image (small),
+    #     image_full_url: [String] url to full size image (medium),
+    #     image_gallery_url: [String] url to gallery size image (large),
+    #     image_raw_url: [String] url to raw image (largest)
+    #  }
+    attr_accessor :listing_images
+
+    # @!attribute living_area
+    #
+    # @return [Integer] square footage of the building
+    attr_accessor :living_area
+
+    # @!attribute longitude
+    #
+    # @return [String] longitude of the property
+    attr_accessor :longitude
+
+    # @!attribute lot_size_acres
+    #
+    # @return [float] the property acreage of the listing
+    attr_accessor :lot_size_acres
 
     # @!attribute lot_size_square_feet
     #
@@ -180,15 +179,18 @@ module MoxiworksPlatform
     # @return [String] Middle school for property
     attr_accessor :middle_or_junior_school
 
-    # @!attribute list_office_aor
+    # @!attribute moxi_works_listing_id
+    #   moxi_works_listing_id is the Moxi Works Platform ID of the listing
     #
-    # @return [String] MLS the listing is listed with
-    attr_accessor :list_office_aor
+    #   this must be set for any Moxi Works Platform transaction
+    #
+    #   @return [String] the Moxi Works Platform ID of the listing
+    attr_accessor :moxi_works_listing_id
 
-    # @!attribute internet_entire_listing_display_yn
+    # @!attribute modification_timestamp
     #
-    # @return [Boolean] whether to display listing on internet
-    attr_accessor :internet_entire_listing_display_yn
+    # @return [String] string representing date in format 'MM/DD/YYYY'
+    attr_accessor :modification_timestamp
 
     # @!attribute on_market
     #
@@ -200,11 +202,36 @@ module MoxiworksPlatform
     # @return [Boolean] whether there is a pool
     attr_accessor :pool_yn
 
+    # @!attribute postal_code
+    #
+    # @return [String] zip code of property address
+    attr_accessor :postal_code
+
+    # @!attribute property_features
+    #
+    # @return [Hash] property features associated with this listing
+    attr_accessor :property_features
+
     # @!attribute property_type
     #
     # @return [String] type of property, could be 'Rental' 'Residential' 'Condo-Coop' 'Townhouse' 'Land' 'Multifamily'
     attr_accessor :property_type
 
+    # @!attribute public_remarks
+    #
+    # @return [String] agent generated comments regarding the property
+    attr_accessor :public_remarks
+
+    # @!attribute single_story
+    #
+    # @return [Boolean] whether the building is single story
+    attr_accessor :single_story
+
+    # @!attribute state
+    #
+    # @return [String] state of property address
+    attr_accessor :state_or_province
+
     # @!attribute tax_annual_amount
     #
     # @return [Integer] Annual property tax for the property
@@ -215,38 +242,21 @@ module MoxiworksPlatform
     # @return [Integer] assessment year that property_tax reflects
     attr_accessor :tax_year
 
-    # @!attribute single_story
-    #
-    # @return [Boolean] whether the building is single story
-    attr_accessor :single_story
-
-    # @!attribute living_area
-    #
-    # @return [Integer] square footage of the building
-    attr_accessor :living_area
-
     # @!attribute view_yn
     #
     # @return [Boolean] whether the property has a view
     attr_accessor :view_yn
 
+    # @!attribute waterfront_yn
+    #
+    # @return [Boolean|nil] whether the property has waterfront acreage
+    attr_accessor :waterfront_yn
+
     # @!attribute year_built
     #
     # @return [Integer] year the building was built
     attr_accessor :year_built
 
-    # @!attribute listing_images
-    #
-    # @return [Array] array of image Hashes in the format
-    #  {
-    #     image_thumb_url: [String] url to thumbail size image (smallest),
-    #     image_small_url: [String] url to small size image (small),
-    #     image_full_url: [String] url to full size image (medium),
-    #     image_gallery_url: [String] url to gallery size image (large),
-    #     image_raw_url: [String] url to raw image (largest)
-    #  }
-    attr_accessor :listing_images
-
 
 
     # Find a listing on the  Moxi Works Platform
@@ -295,12 +305,12 @@ module MoxiworksPlatform
     #
     #     optional Search parameters
     #
-    # @option opts [Integer] :page_number the page of results to return
+    # @option opts [String] :last_moxi_works_listing_id For multi-page responses (where the response value 'last_page' is false), send the listing ID of the last Listing in the previous page.
+    # @option opts [Hash] :previous_page For multi-page responses (where the response value 'last_page' is false), send the listing ID of the last Listing in the previous page.
     #
     # @return [Hash] with the format:
     #   {
-    #     page_number: [Integer],
-    #     total_pages: [Integer],
+    #     last_page: [Boolean],
     #     listings:  [Array] containing MoxiworkPlatform::Listing objects
     #   }
     #
@@ -327,12 +337,24 @@ module MoxiworksPlatform
     def self.search(opts={}, &block)
       url ||= "#{MoxiworksPlatform::Config.url}/api/listings"
       required_opts = [:moxi_works_company_id, :updated_since]
+
       required_opts.each do |opt|
         raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
             opts[opt].nil? or opts[opt].to_s.empty?
       end
+
+      prev_page = opts[:previous_page] || opts['previous_page']
+      unless(prev_page.nil? or
+          prev_page.empty? or
+          not prev_page.is_a?(Hash) or
+          prev_page['listings'].nil? or
+          prev_page['listings'].empty? or
+          not prev_page['listings'].is_a?(Array))
+        opts[:last_moxi_works_listing_id] ||= prev_page['listings'].last.moxi_works_listing_id
+      end
+
       results = []
-      json = {'listings': [], 'last_page': true}
+      json = {'listings' => [], 'last_page' => true}
       RestClient::Request.execute(method: :get,
                                   url: url,
                                   payload: opts, headers: self.headers) do |response|
@@ -356,23 +378,5 @@ module MoxiworksPlatform
       json
     end
 
-    def self.underscore_attribute_names(hash)
-      hash.keys.each do |key|
-        hash[key] = self.underscore_attribute_names hash[key] if hash[key].is_a? Hash
-        if hash[key].is_a? Array
-          array = hash[key]
-          new_array = []
-          array.each do |member|
-            new_array << self.underscore_attribute_names(member)
-          end
-          hash[key] = new_array
-        end
-        underscored = Resource.underscore(key)
-        hash[underscored] = hash.delete(key)
-      end
-      hash
-    end
-
-
   end
 end

data/lib/moxiworks_platform/office.rb

@@ -149,6 +149,7 @@ module MoxiworksPlatform
                                   payload: opts, headers: self.headers) do |response|
         puts response if MoxiworksPlatform::Config.debug
         self.check_for_error_in_response(response)
+        
         json = JSON.parse(response)
         json['offices'].each do |r|
           results << MoxiworksPlatform::Office.new(r) unless r.nil? or r.empty?

data/lib/moxiworks_platform/resource.rb

@@ -6,6 +6,8 @@ module MoxiworksPlatform
   #  provides underlying logic for connecting to Moxi Works Platform over HTTPS
   class Resource
 
+    # class methods
+
     # keep a list of attr_accessors defined in this class
     #
     # used to convert Resource child object into parameters required for saving
@@ -31,7 +33,8 @@ module MoxiworksPlatform
       {
           Authorization: auth_header,
           Accept: accept_header,
-          'Content-Type' =>  content_type_header
+          'Content-Type' =>  content_type_header,
+          Cookie: Session.instance.cookie
       }
     end
 
@@ -64,9 +67,10 @@ module MoxiworksPlatform
     def self.check_for_error_in_response(response)
       begin
         json = JSON.parse(response)
+        MoxiworksPlatform::Session.instance.cookie = response.headers[:set_cookie].first rescue nil
         return if json.is_a?(Array)
-      rescue => e
-        raise MoxiworksPlatform::Exception::RemoteRequestFailure, "unable to parse remote response #{e}\n response:\n  #{response}"
+        # rescue => e
+        # raise MoxiworksPlatform::Exception::RemoteRequestFailure, "unable to parse remote response #{e}\n response:\n  #{response}"
       end
       message = "unable to perform remote action on Moxi Works platform\n"
       message << json['messages'].join(',') unless json['messages'].nil?
@@ -75,44 +79,6 @@ module MoxiworksPlatform
           not json['status'].nil? and (%w(error fail).include?(json['status']))
     end
 
-
-    # maps Hash values to Instance variables for mapping JSON object values to our Class attributes
-    #
-    def initialize(hash={})
-      self.init_attrs_from_hash(hash)
-    end
-
-    def init_attrs_from_hash(hash={})
-      hash.each do |key,val|
-        instance_variable_set("@#{key}", val)
-      end
-    end
-
-    def method_missing(meth, *args, &block)
-      name = meth.to_sym
-      if numeric_attrs.include? name
-        return numeric_value_for(name, type: :integer) if int_attrs.include? name
-        return numeric_value_for(name, type: :float) if float_attrs.include? name
-      end
-      super(meth, *args, &block)
-    end
-
-    # all available accessors defined in this class
-    #
-    # @return [Array][String] all defined accessors of this class
-    def attributes
-      self.class.attributes + numeric_attrs
-    end
-
-    # convert this class into a Hash structure where attributes are Hash key names and attribute values are Hash values
-    #
-    # @return [Hash] with keys mapped to class attribute names
-    def to_hash
-      hash = {}
-      self.attributes.each {|attr| hash[attr.to_sym] = self.send(attr)}
-      hash
-    end
-
     def self.send_request(method, opts={}, url=nil)
       RestClient::Request.execute(method: method,
                                   url: url,
@@ -145,9 +111,62 @@ module MoxiworksPlatform
       nil
     end
 
+    def self.underscore_attribute_names(thing)
+      case thing
+        when Array
+          new_thing = self.underscore_array(thing)
+        when Hash
+          new_thing = self.underscore_hash(thing)
+        else
+          new_thing = thing
+      end
+      new_thing
+    end
+
+    def self.underscore_array(array)
+      new_array = []
+      array.each do |member|
+        new_array << self.underscore_attribute_names(member)
+      end
+      new_array
+    end
+
+    def self.underscore_hash(hash)
+      hash.keys.each do |key|
+        hash[key] = self.underscore_attribute_names hash[key]
+        underscored = Resource.underscore(key)
+        hash[underscored] = hash.delete(key)
+      end
+      hash
+    end
+
+    def self.underscore(attr)
+      attr.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+    end
+
+    # instance methods
+
+    # maps Hash values to Instance variables for mapping JSON object values to our Class attributes
+    #
+    def initialize(hash={})
+      self.init_attrs_from_hash(hash)
+    end
+
+    # all available accessors defined in this class
+    #
+    # @return [Array][String] all defined accessors of this class
+    def attributes
+      self.class.attributes + numeric_attrs
+    end
+
     # used by method_missing to ensure that a number is the type we expect it to be
-    def numeric_attrs
-      int_attrs + float_attrs
+    # this should be overridden if we have any float values we want to return as floats
+    def float_attrs
+      []
     end
 
     # used by method_missing to ensure that a number is the type we expect it to be
@@ -156,18 +175,33 @@ module MoxiworksPlatform
       []
     end
 
+    def init_attrs_from_hash(hash={})
+      hash.each do |key,val|
+        instance_variable_set("@#{key}", val)
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      name = meth.to_sym
+      if numeric_attrs.include? name
+        return numeric_value_for(name, type: :integer) if int_attrs.include? name
+        return numeric_value_for(name, type: :float) if float_attrs.include? name
+      end
+      super(meth, *args, &block)
+    end
+
     # used by method_missing to ensure that a number is the type we expect it to be
-    # this should be overridden if we have any float values we want to return as floats
-    def float_attrs
-      []
+    def numeric_attrs
+      int_attrs + float_attrs
     end
 
-    def self.underscore(attr)
-      attr.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr("-", "_").
-      downcase
+    # convert this class into a Hash structure where attributes are Hash key names and attribute values are Hash values
+    #
+    # @return [Hash] with keys mapped to class attribute names
+    def to_hash
+      hash = {}
+      self.attributes.each {|attr| hash[attr.to_sym] = self.send(attr)}
+      hash
     end
 
   end

data/lib/moxiworks_platform/seller_transaction.rb

@@ -56,7 +56,7 @@ module  MoxiworksPlatform
     #
     #  This will be a single digit integer that can be [1,2,3,4,5].
     #   For more information on SellerTransaction stages see
-    #     <a href='https://moxiworks-platform.github.io/#sellertransaction-stages'>The Moxi Works Platform Documentation</a>
+    #     {https://moxiworks-platform.github.io/#sellertransaction-stages The Moxi Works Platform Documentation}
     #
     # @return [Integer] the stage the SellerTransaction is in.
     attr_accessor :stage
@@ -71,7 +71,7 @@ module  MoxiworksPlatform
     #   This will be an enumerated string that can be can be
     #   'initialized', 'configured' , 'active' , 'pending'  or 'complete'
     #   For more information on SellerTransaction stages see
-    #     <a href='https://moxiworks-platform.github.io/#sellertransaction-stages'>The Moxi Works Platform Documentation</a>
+    #     {https://moxiworks-platform.github.io/#sellertransaction-stages The Moxi Works Platform Documentation}
     #
     #
     # @return [String, enumerated] current state of SellerTransaction
@@ -119,7 +119,7 @@ module  MoxiworksPlatform
     # @return [Float] number of bathrooms in property being sold
     attr_accessor :baths
 
-        # @!attribute is_mls_transaction
+    # @!attribute is_mls_transaction
     #
     #
     # @return [Boolean] Whether the property being sold is being listed on an MLS.
@@ -138,7 +138,7 @@ module  MoxiworksPlatform
 
     # @!attribute start_timestamp
     #
-    # **NON MLS TRANSACTIONS ONLY ** this is the Unix timestamp
+    #  this is the Unix timestamp
     #   representing the date the agent initiated transaction discussions
     #   with the client.
     #
@@ -226,7 +226,7 @@ module  MoxiworksPlatform
     #
     # In order to promote a SellerTransaction to the next stage, set  the
     # promote_transaction attribute to true. For more information about
-    # SellerTransaction stages, see <a href='https://moxiworks-platform.github.io/#promoting-sellertransaction-stage>The Moxi Works Platform Documentation</a>.
+    # SellerTransaction stages, see {https://moxiworks-platform.github.io/#promoting-sellertransaction-stageThe Moxi Works Platform Documentation}.
     # promote_transaction is only available for SellerTransaction updates.
     # Newly created SellerTransaction objects will automatically be created in
     # stage 3 (active)
@@ -241,13 +241,13 @@ module  MoxiworksPlatform
     # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this transaction is to be associated
     # @option opts [String]  :moxi_works_contact_id *REQUIRED* The unique identifier for the Contact on the Moxi Works Platform. Either moxi_works_contact_id or partner_contact_id is required when creating SellerTransaction objects
     # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique id for associated contact. should already have been created in Moxi Works Platform. If the Contact was not created by your system, use the moxi_works_contact_id attribute. Either moxi_works_contact_id or partner_contact_id is required when creating SellerTransaction objects
+    # @option opts [String] :transaction_name *REQUIRED* short description of the transaction meaningful to the agent
     #
     # -- Either moxi_works_contact_id or partner_contact_id must be
     #      populated; however, you should only populate one of these attributes.
     #
     #     optional SellerTransaction parameters
     #
-    # @option opts [String] :transaction_name short description of the transaction meaningful to the agent
     # @option opts [String] :notes human readable notes associated with the transaction meaningful to the agent
     # @option opts [String] :address street address of the property associated with the transaction
     # @option opts [String] :city city of the property associated with the transaction
@@ -256,9 +256,9 @@ module  MoxiworksPlatform
     # @option opts [Integer] :sqft square feet of living area in the property being sold
     # @option opts [Integer] :beds number of bedrooms in the property being sold
     # @option opts [Integer or Float] :baths number of bathrooms in the property being sold
-    # @option opts [Boolean] :is_mls_transaction Whether the property being sold is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS. If is_mls_transaction is false, then start_timestamp should be populated.
+    # @option opts [Boolean] :is_mls_transaction Whether the property being sold is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS.
     # @option opts [String] :mls_number  mls number associated with the transaction -- mls_number should be populated only if is_mls_transaction is true.
-    # @option opts [Integer] :start_timestamp  Unix timestamp representing the date the property was put on sale -- start_timestamp should be populated only if is_mls_transaction is false.
+    # @option opts [Integer] :start_timestamp  Unix timestamp representing the date the agent initiated transaction discussions with the client.
     # @option opts [Float] :commission_percentage what percentage the commission is if percentage based -- A SellerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :commission_flat_fee how much the commission is if flat fee -- A SellerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :target_price  target price associated with the transaction if using a target price rather than price range
@@ -270,7 +270,7 @@ module  MoxiworksPlatform
     #        agent_identifier:'testis@testomatical.com',
     #        moxi_works_contact_id:'deadbeef-dead-beef-bad4-feedfacebad',
     #        notes: 'foo deeaz',
-    #        name: 'whateverz'
+    #        transaction_name: 'whateverz'
     #        address: '1234 there ave',
     #        city: 'cityville'
     #        state:  'provinceland',
@@ -398,9 +398,9 @@ module  MoxiworksPlatform
     # @option opts [Integer] :sqft square feet of living area in the property being sold
     # @option opts [Integer] :beds number of bedrooms in the property being sold
     # @option opts [Integer or Float] :baths number of bathrooms in the property being sold
-    # @option opts [Boolean] :is_mls_transaction Whether the property being sold is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS. If is_mls_transaction is false, then start_timestamp should be populated.
+    # @option opts [Boolean] :is_mls_transaction Whether the property being sold is being listed on an MLS. This should be false for paperwork-only, for sale by owner, off-market, or pocket listing type transactions or any transactions that will not be tracked through an MLS.
     # @option opts [String] :mls_number  mls number associated with the transaction -- mls_number should be populated only if is_mls_transaction is true.
-    # @option opts [Integer] :start_timestamp  Unix timestamp representing the date the property was put on sale -- start_timestamp should be populated only if is_mls_transaction is false.
+    # @option opts [Integer] :start_timestamp   Unix timestamp representing the date the agent initiated transaction discussions with the client.
     # @option opts [Float] :commission_percentage what percentage the commission is if percentage based -- A SellerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :commission_flat_fee how much the commission is if flat fee -- A SellerTransaction can only have either commission_percentage or commission_flat_fee populated. Both can not be populated.
     # @option opts [Integer] :target_price  target price associated with the transaction if using a target price rather than price range
@@ -416,7 +416,7 @@ module  MoxiworksPlatform
     #        agent_identifier:'testis@testomatical.com',
     #        moxi_works_transaction_id:'deadbeef-dead-beef-bad4-feedfacebad',
     #        notes: 'foo deeaz',
-    #        name: 'whateverz'
+    #        transaction_name: 'whateverz'
     #        address: '1234 there ave',
     #        city: 'cityville'
     #        state:  'provinceland',
@@ -460,10 +460,10 @@ module  MoxiworksPlatform
     # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this transaction is to be associated
     # @option opts [String]  :moxi_works_transaction_id *REQUIRED* The Moxi Works Platform unique ID for this transaction.
     # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the Contact for whom this SellerTransaction is to be associated.
-    # @option opts [String] :transaction_name *REQUIRED* short description of the transaction meaningful to the agent
     #
     #     optional SellerTransaction parameters
     #
+    # @option opts [String] :transaction_name short description of the transaction meaningful to the agent
     # @option opts [String] :description longer description of the transaction
     # @option opts [Integer] :due_at Unix timestamp representing the due date
     # @option opts [Integer] :duration Length of time in minutes that the transaction should take

data/lib/moxiworks_platform/session.rb

@@ -0,0 +1,9 @@
+require 'singleton'
+module  MoxiworksPlatform
+  class Session
+    include Singleton
+
+    attr_accessor :cookie
+
+  end
+end

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.10.1'
+  VERSION = '0.10.2'
 end

data/publish_docs.sh

@@ -4,6 +4,8 @@ mv doc /tmp/doc/
 
 git checkout master
 
+git commit -a -m "Documentation Update"
+
 yard doc
 
 git checkout gh-pages
@@ -21,6 +23,9 @@ git add MoxiworksPlatform
 
 git commit -a -m "Documentation Update"
 
+git push origin gh-pages
+git push upstream gh-pages
+
 git checkout master
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,7 @@ files:
 - lib/moxiworks_platform/office.rb
 - lib/moxiworks_platform/resource.rb
 - lib/moxiworks_platform/seller_transaction.rb
+- lib/moxiworks_platform/session.rb
 - lib/moxiworks_platform/task.rb
 - lib/moxiworks_platform/version.rb
 - moxiworks_platform.gemspec