moxiworks_platform 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 475dc2ec6d0129c5c8b8bf0ac055deaf0322d5e1
+  data.tar.gz: 2e45e81432029a487bce5ca73145df7b16b54113
+SHA512:
+  metadata.gz: 9ddb57edd8cd6f0c68f3f38aef503b118ce2470167f94f6f1930875db8c769f21e959a6f2a25bb9532d18ea756a9ed06a766eec3a8deefe5f902ba610461364f
+  data.tar.gz: 16a8f1f862e5c7632bdf9f632d5695cdfdf601fb44fab0339bfb4263ad91c37813f3e8c9a51d99ae29aed3329fd90907fffc7ebb3e3687ba72d9c1af23b3ee4c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,38 @@
+# MoxiworksPlatform
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'moxiworks_platform'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moxiworks_platform
+
+## Usage
+
+```ruby
+platform_identifier = 'abc1234'
+platform_secret = 'secretkey'
+require 'moxiworks_platform'
+MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
+contact = MoxiworksPlatform::Contact.create(moxi_works_agent_id: '123abcd', partner_contact_id: 'my_unique_id')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/moxiworks_platform.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "moxiworks_platform"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/moxiworks_platform.rb

@@ -0,0 +1,12 @@
+require 'moxiworks_platform/version'
+require 'moxiworks_platform/config'
+require 'moxiworks_platform/exception'
+require 'moxiworks_platform/resource'
+require 'moxiworks_platform/credentials'
+require 'moxiworks_platform/contact'
+
+
+
+module MoxiworksPlatform
+  # Your code goes here...
+end

data/lib/moxiworks_platform/config.rb

@@ -0,0 +1,39 @@
+module MoxiworksPlatform
+  # moxiworks_platform SDK configurable attributes
+  #
+  # adjustment of these should not be required unless you are debugging an issue
+  # or are using an alternate configuration for connecting to Moxi Works Platform
+  class Config
+
+    class << self
+
+      # @!attribute url
+      #
+      #   The Moxi Works Platform base URL. default is 'https://api.moxiworks.com'
+      #
+      #   Modification of this attribute should not be needed unless you are debugging or developing for Moxi Works Platform Ruby SDK
+      #
+      #   @return [String]
+      attr_accessor :url
+
+      # @!attribute debug
+      #
+      #   whether to print debugging info about Moxi Works Platform requests to the console
+      #
+      #   Modification of this attribute should not be needed unless you are debugging or developing for Moxi Works Platform Ruby SDK
+      #
+      #   @return [Boolean]
+      attr_accessor :debug
+    end
+
+    def self.url=(url)
+      @@url = url
+    end
+
+    def self.url
+      @@url ||= 'https://api.moxiworks.com'
+    end
+
+
+  end
+end

data/lib/moxiworks_platform/contact.rb

@@ -0,0 +1,685 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Contact
+  class Contact < MoxiworksPlatform::Resource
+
+    # @!attribute moxi_works_agent_id
+    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which a contact 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_contact_id
+    #   *your system's* unique ID for the Contact
+    #
+    #   this must be set for any Moxi Works Platform transaction
+    #
+    #   @return [String] your system's unique ID for the contact
+    attr_accessor :partner_contact_id
+
+
+    # @!attribute moxi_works_contact_id
+    #   Moxi Works Platform ID for the Contact
+    #
+    #   @return [String] Moxi Works Platform ID for the contact
+    attr_accessor :partner_contact_id
+
+
+    # @!attribute business_website
+    #   the full URL of the business website to be associated with this Contact
+    #
+    #   @return [String]-- Default ''
+    attr_accessor :business_website
+
+    # @!attribute contact_name
+    #   the full name of this Contact
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :contact_name
+
+    # @!attribute gender
+    #   the gender  of this Contact. the first initial of either gender type may
+    #   be used or the full word 'male' or 'female.'
+    #
+    #   @note The single character representation will be used after saving to Moxi Works Platform  no matter whether the word or single character representation is passed in.
+    #
+    #   @return [String, Enumerated] -- a single character 'm' or 'f' or -- Default ''
+    attr_accessor :gender
+
+    # @!attribute home_street_address
+    #   the street address of the residence of this Contact
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :home_street_address
+
+    # @!attribute home_city
+    #   the city of the residence of this Contact
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :home_city
+
+    # @!attribute home_state
+    #   the state in which the residence of this Contact is located
+    #
+    #   this can either be the state's abbreviation or the full name of the state
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :home_state
+
+    # @!attribute home_zip
+    #   the zip code of the residence of this Contact
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :home_zip
+
+    # @!attribute home_neighborhood
+    #   the neighborhood of the residence of this Contact
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :home_neighborhood
+
+    # @!attribute home_country
+    #   the country of the residence of this Contact
+    #
+    #   this can either be the country's abbreviation or the full name of the country
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :home_country
+
+    # @!attribute job_title
+    #   the specific job title this contact has; ex: 'Senior VP of Operations'
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :job_title
+
+    # @!attribute occupation
+    #   the general occupation of this contact; ex: 'Software Developer'
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :occupation
+
+    # @!attribute partner_agent_id
+    #   your system's unique identifier for the agent that this contact will be associated with
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :partner_agent_id
+
+    # @!attribute primary_email_address
+    #   the email address the contact would want to be contacted via first
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :primary_email_address
+
+    # @!attribute primary_phone_number
+    #   the phone number the contact would want to be contacted via first
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :primary_phone_number
+
+    # @!attribute secondary_email_address
+    #   an additional email address the contact would want to be contacted by
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :secondary_email_address
+
+    # @!attribute secondary_phone_number
+    #   an additional phone number the contact would want to be contacted by
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :secondary_phone_number
+
+    # @!attribute property_baths
+    #
+    #   the number of bathrooms in the listing the contact has expressed interest in
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [Float] -- Default nil
+    attr_writer :property_baths
+
+    # @!attribute property_beds
+    #
+    #   the number of bedrooms in the listing the contact has expressed interest in
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :property_beds
+
+    # @!attribute property_city
+    #
+    #   the city in which the listing the contact has expressed interest in is located
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_city
+
+    # @!attribute property_list_price
+    #
+    #   the list_price of the property the contact has expressed interest in
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :property_list_price
+
+    # @!attribute property_listing_status
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   the status of the listing of  the Property of Interest; ex: 'Active' or 'Sold'
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_listing_status
+
+    # @!attribute property_mls_id
+    #
+    #   the MLS ID of the listing that of the Property of Interest
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_mls_id
+
+    # @!attribute property_photo_url
+    #
+    #   a full URL to a photo of the Property of Interest
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_photo_url
+
+    # @!attribute property_state
+    #
+    #   the state in which the listing the contact has expressed interest in is located
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_state
+
+    # @!attribute property_street_address
+    #
+    #   the street address of the listing the contact has expressed interest in is located
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_street_address
+
+    # @!attribute property_url
+    #
+    #   a URL referencing a HTTP(S) location which has information about the listing
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_url
+
+    # @!attribute property_zip
+    #
+    #   the zip code in which the listing the contact has expressed interest in is located
+    #
+    #   Property of Interest (POI) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :property_zip
+
+    # @!attribute search_city
+    #
+    #   the city which the contact has searched for listings in
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :search_city
+
+    # @!attribute search_state
+    #
+    #   the state which the contact has searched for listings in
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :search_state
+
+    # @!attribute search_zip
+    #
+    #   the zip code which the contact has searched for listings in
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :search_zip
+
+    # @!attribute search_max_lot_size
+    #
+    #   the maximum lot size used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_max_lot_size
+
+    # @!attribute search_max_price
+    #
+    #   the maximum price value used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_max_price
+
+    # @!attribute search_max_sq_ft
+    #
+    #   the maximum listing square footage used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_max_sq_ft
+
+    # @!attribute search_max_year_built
+    #
+    #   the maximum year built used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_max_year_built
+
+    # @!attribute search_min_baths
+    #
+    #   Property Search (PS) attribute
+    #
+    #   the minimum number of bathrooms used by the contact when searching for listings
+    #
+    #   @return [Float] -- Default nil
+    attr_writer :search_min_baths
+
+    # @!attribute search_min_beds
+    #
+    #   the minimum number of bedrooms used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_min_beds
+
+    # @!attribute search_min_price
+    #
+    #   the minimum price used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_min_price
+
+    # @!attribute search_min_sq_ft
+    #
+    #   the minimum square footage used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_min_sq_ft
+
+    # @!attribute search_min_year_built
+    #
+    #   the minimum year built used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_min_year_built
+
+    # @!attribute search_property_types
+    #
+    #   the property types used by the contact when searching for listings; ex: 'Condo' 'Single-Family' 'Townhouse'
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [String] -- Default nil
+    attr_accessor :search_property_types
+
+    # Creates a new Contact in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is to be associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for this contact.
+    #
+    #     optional Contact parameters
+    #
+    # @option opts [String] :business_website  full url of a website associated with this contact
+    # @option opts [String] :contact_name full name of this contact in format "Firstname Middlename Lastname"
+    # @option opts [String, Enumerated] :gender can be "male" or "female" or "m" or "f"
+    # @option opts [String] :home_street_address the street address and street on which the contact lives
+    # @option opts [String] :home_city city or township in which this contact lives
+    # @option opts [String] :home_state state in which this contact lives; can be abbreviation or full name
+    # @option opts [String] :home_zip zip code in which this contact lives
+    # @option opts [String] :home_neighborhood neighborhood in which this contact lives
+    # @option opts [String] :home_country country in which this contact lives; can be abbreviation or full name
+    # @option opts [String] :job_title the specific job title this contact has; ex: 'Senior VP of Operations'
+    # @option opts [String] :occupation the general occupation of this contact; ex: 'Software Developer'
+    # @option opts [String] :partner_agent_id your system's unique ID for the agent this contact is to be associated with
+    # @option opts [String] :primary_email_address the primary email address for this contact
+    # @option opts [String] :primary_phone_number the primary phone number for this contact
+    # @option opts [String] :secondary_email_address the secondary email address for this contact
+    # @option opts [String] :secondary_phone_number the secondary phone number for this contact
+    #
+    #     optional Property of Interest (POI) parameters:
+    #       The POI is a property that the contact has shown interest in.
+    #
+    # @option opts [Float] :property_baths the number of baths in the Property of Interest
+    # @option opts [Integer] :property_beds the number of bedrooms in the Property of Interest
+    # @option opts [String] :property_city the city in which the Property of Interest is located
+    # @option opts [Integer] :property_list_price the list price of the Property of Interest
+    # @option opts [String] :property_listing_status the status of the Property of Interest; ex: 'Active' or 'Sold'
+    # @option opts [String] :property_mls_id the MLS ID of the listing
+    # @option opts [String] :property_photo_url a full URL of an image of the Property of Interest
+    # @option opts [String] :property_state the state which the Property of Interest is in
+    # @option opts [String] :property_street_address the street address that the Property of Interest is on
+    # @option opts [String] :property_url a URL to a page with more information about the Property of Interest
+    # @option opts [String] :property_zip the zip code which the Property of Interest is in
+    #
+    #     optional Search Reference parameters:
+    #       The Search Reference parameters reflect search criteria that the contact
+    #         has used while searching for a listing
+    #
+    # @option opts [String] :search_city the city or locality which this contact has searched for a listing
+    # @option opts [String] :search_state the state in which this contact has searched for a listing
+    # @option opts [String] :search_zip the zip code or postal code in which this contact has searched for a listing
+    # @option opts [Integer] :search_max_lot_size the maximum lot size that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_price the maximum price that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_sq_ft the maximum square feet that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_year_built the maximum year built this contact has used as criteria when searching for a listing
+    # @option opts [Float] :search_min_baths the minimum number of baths this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_beds the minimum number of bedrooms this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_lot_size the minimum lot size this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_price the minimum price this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_sq_ft the minimum number of square feet this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_year_built the minimum year built this contact has used as criteria when searching for a listing
+    # @option opts [String] :search_property_types property types this contact has searched for; ex: 'Single Family, Condo, Townhouse'
+    #
+    # @example
+    #   MoxiworksPlatform::Contact.create(
+    #     moxi_works_agent_id: '123abc',
+    #     partner_contact_id: '1234',
+    #     contact_name: 'george p warshington',
+    #     home_street: '123 this way',
+    #     home_city: 'cittyvile',
+    #     home_state: 'HI',
+    #     home_country: 'USA',
+    #     home_neighborhood: 'my hood',
+    #     job_title: 'junior bacon burner',
+    #     occupation: 'chef',
+    #     business_website: 'http://bear.wrass.ler',
+    #     primary_email_address: 'goo@goo.goo',
+    #     primary_phone_number: '123213',
+    #     property_mls_id: '1232312abcv',
+    #     secondary_phone_number: '1234567890')
+    # @return [MoxiworksPlatform::Contact]
+    def self.create(opts={})
+      self.send_request(:post, opts)
+    end
+
+    # Find a Contact  your system has previously created in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is to be associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for this contact.
+    #
+    #   returns [MoxiworksPlatform::Contact]
+    def self.find(opts={})
+      self.send_request(:get, opts)
+    end
+
+    # Updates a previously created Contact in Moxi Works Platform
+    # @param [Hash] opts
+    # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is to be associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for this contact.
+    #
+    #     optional Contact parameters
+    #
+    # @option opts [String] :moxi_works_contact_id Moxi Works Platform contact ID
+    # @option opts [String] :business_website  full url of a website associated with this contact
+    # @option opts [String] :contact_name full name of this contact in format "Firstname Middlename Lastname"
+    # @option opts [String, Enumerated] :gender can be "male" or "female" or "m" or "f"
+    # @option opts [String] :home_street_address the street address and street on which the contact lives
+    # @option opts [String] :home_city city or township in which this contact lives
+    # @option opts [String] :home_state state in which this contact lives; can be abbreviation or full name
+    # @option opts [String] :home_zip zip code in which this contact lives
+    # @option opts [String] :home_neighborhood neighborhood in which this contact lives
+    # @option opts [String] :home_country country in which this contact lives; can be abbreviation or full name
+    # @option opts [String] :job_title the specific job title this contact has; ex: 'Senior VP of Operations'
+    # @option opts [String] :occupation the general occupation of this contact; ex: 'Software Developer'
+    # @option opts [String] :partner_agent_id your system's unique ID for the agent this contact is to be associated with
+    # @option opts [String] :primary_email_address the primary email address for this contact
+    # @option opts [String] :primary_phone_number the primary phone number for this contact
+    # @option opts [String] :secondary_email_address the secondary email address for this contact
+    # @option opts [String] :secondary_phone_number the secondary phone number for this contact
+    #
+    #     optional Property of Interest (POI) parameters:
+    #       The POI is a property that the contact has shown interest in.
+    #
+    # @option opts [Float] :property_baths the number of baths in the Property of Interest
+    # @option opts [Integer] :property_beds the number of bedrooms in the Property of Interest
+    # @option opts [String] :property_city the city in which the Property of Interest is located
+    # @option opts [Integer] :property_list_price the list price of the Property of Interest
+    # @option opts [String] :property_listing_status the status of the Property of Interest; ex: 'Active' or 'Sold'
+    # @option opts [String] :property_mls_id the MLS ID of the listing
+    # @option opts [String] :property_photo_url a full URL of an image of the Property of Interest
+    # @option opts [String] :property_state the state which the Property of Interest is in
+    # @option opts [String] :property_street_address the street address that the Property of Interest is on
+    # @option opts [String] :property_url a URL to a page with more information about the Property of Interest
+    # @option opts [String] :property_zip the zip code which the Property of Interest is in
+    #
+    #     optional Search Reference parameters:
+    #       The Search Reference parameters reflect search criteria that the contact
+    #         has used while searching for a listing
+    #
+    # @option opts [String] :search_city the city or locality which this contact has searched for a listing
+    # @option opts [String] :search_state the state in which this contact has searched for a listing
+    # @option opts [String] :search_zip the zip code or postal code in which this contact has searched for a listing
+    # @option opts [Integer] :search_max_lot_size the maximum lot size that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_price the maximum price that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_sq_ft the maximum square feet that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_year_built the maximum year built this contact has used as criteria when searching for a listing
+    # @option opts [Float] :search_min_baths the minimum number of baths this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_beds the minimum number of bedrooms this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_lot_size the minimum lot size this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_price the minimum price this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_sq_ft the minimum number of square feet this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_year_built the minimum year built this contact has used as criteria when searching for a listing
+    # @option opts [String] :search_property_types property types this contact has searched for; ex: 'Single Family, Condo, Townhouse'
+    #
+    # @return [MoxiworksPlatform::Contact]
+    #
+    # @example
+    #   MoxiworksPlatform::Contact.update(
+    #     moxi_works_agent_id: '123abc',
+    #     partner_contact_id: '1234',
+    #     contact_name: 'george p warshington',
+    #     home_street: '123 this way',
+    #     home_city: 'cittyvile',
+    #     home_state: 'HI',
+    #     home_country: 'USA',
+    #     home_neighborhood: 'my hood',
+    #     job_title: 'junior bacon burner',
+    #     occupation: 'chef',
+    #     business_website: 'http://bear.wrass.ler',
+    #     primary_email_address: 'goo@goo.goo',
+    #     primary_phone_number: '123213',
+    #     property_mls_id: '1232312abcv',
+    #     secondary_phone_number: '1234567890')
+    def self.update(opts={})
+      opts[:contact_id] = opts[:partner_contact_id] || opts[:moxi_works_contact_id]
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{opts[:contact_id]}"
+      self.send_request(:put, opts, url)
+    end
+
+    # Delete a Contact your system has previously created in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    #
+    #     required parameters
+    #
+    # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is to be associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for this contact.
+    #
+    # @return [Boolean] -- success of the delete action
+    #
+    # @example
+    #   success = MoxiWorksPlatform::Contact.delete(moxi_works_agent_id: '123abcd', partner_contact_id: 'myUniqueContactId' )
+    #
+    def self.delete(opts={})
+      self.send_request(:delete, opts)
+    end
+
+    # Send our remote request to the Moxi Works Platform
+    #
+    # @param [String] method The HTTP method to be used when connecting; ex: :put, :post, :get
+    # @param [Hash] opts
+    # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is to be associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for this contact.
+    #
+    #     optional Contact parameters
+    #
+    # @option opts [String] :moxi_works_contact_id Moxi Works Platform contact ID
+    # @option opts [String] :business_website  full url of a website associated with this contact
+    # @option opts [String] :contact_name full name of this contact in format "Firstname Middlename Lastname"
+    # @option opts [String, Enumerated] :gender can be "male" or "female" or "m" or "f"
+    # @option opts [String] :home_street_address the street address and street on which the contact lives
+    # @option opts [String] :home_city city or township in which this contact lives
+    # @option opts [String] :home_state state in which this contact lives; can be abbreviation or full name
+    # @option opts [String] :home_zip zip code in which this contact lives
+    # @option opts [String] :home_neighborhood neighborhood in which this contact lives
+    # @option opts [String] :home_country country in which this contact lives; can be abbreviation or full name
+    # @option opts [String] :job_title the specific job title this contact has; ex: 'Senior VP of Operations'
+    # @option opts [String] :occupation the general occupation of this contact; ex: 'Software Developer'
+    # @option opts [String] :partner_agent_id your system's unique ID for the agent this contact is to be associated with
+    # @option opts [String] :primary_email_address the primary email address for this contact
+    # @option opts [String] :primary_phone_number the primary phone number for this contact
+    # @option opts [String] :secondary_email_address the secondary email address for this contact
+    # @option opts [String] :secondary_phone_number the secondary phone number for this contact
+    #
+    #     optional Property of Interest (POI) parameters:
+    #       The POI is a property that the contact has shown interest in.
+    #
+    # @option opts [Float] :property_baths the number of baths in the Property of Interest
+    # @option opts [Integer] :property_beds the number of bedrooms in the Property of Interest
+    # @option opts [String] :property_city the city in which the Property of Interest is located
+    # @option opts [Integer] :property_list_price the list price of the Property of Interest
+    # @option opts [String] :property_listing_status the status of the Property of Interest; ex: 'Active' or 'Sold'
+    # @option opts [String] :property_mls_id the MLS ID of the listing
+    # @option opts [String] :property_photo_url a full URL of an image of the Property of Interest
+    # @option opts [String] :property_state the state which the Property of Interest is in
+    # @option opts [String] :property_street_address the street address that the Property of Interest is on
+    # @option opts [String] :property_url a URL to a page with more information about the Property of Interest
+    # @option opts [String] :property_zip the zip code which the Property of Interest is in
+    #
+    #     optional Search Reference parameters:
+    #       The Search Reference parameters reflect search criteria that the contact
+    #         has used while searching for a listing
+    #
+    # @option opts [String] :search_city the city or locality which this contact has searched for a listing
+    # @option opts [String] :search_state the state in which this contact has searched for a listing
+    # @option opts [String] :search_zip the zip code or postal code in which this contact has searched for a listing
+    # @option opts [Integer] :search_max_lot_size the maximum lot size that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_price the maximum price that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_sq_ft the maximum square feet that this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_max_year_built the maximum year built this contact has used as criteria when searching for a listing
+    # @option opts [Float] :search_min_baths the minimum number of baths this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_beds the minimum number of bedrooms this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_lot_size the minimum lot size this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_price the minimum price this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_sq_ft the minimum number of square feet this contact has used as criteria when searching for a listing
+    # @option opts [Integer] :search_min_year_built the minimum year built this contact has used as criteria when searching for a listing
+    # @option opts [String] :search_property_types property types this contact has searched for; ex: 'Single Family, Condo, Townhouse'
+    #
+    # @param [String] url The full URLto connect to
+    # @return [MoxiworksPlatform::Contact]
+    def self.send_request(method, opts={}, url=nil)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/contacts"
+      opts[:contact_id] = opts[:partner_contact_id] || opts[:moxi_works_contact_id]
+      required_opts = [:moxi_works_agent_id, :contact_id]
+      required_opts.each do |opt|
+        message = opt == :contact_id ? 'partner_contact_id or moxi_works_contact_id required' : "#{opt} required"
+        raise ::MoxiworksPlatform::Exception::ArgumentError, message if
+            opts[opt].nil? or opts[opt].empty?
+      end
+      contact = nil
+      RestClient::Request.execute(method: method,
+                                  url: url,
+                                  payload: opts, headers: self.headers) do |response|
+        puts response if MoxiworksPlatform::Config.debug
+        json = JSON.parse(response)
+        contact = MoxiworksPlatform::Contact.new(json) unless json.nil? or json.empty?
+      end
+      contact
+    end
+
+    # Save an instance of MoxiWorksPlatform::Contact to Moxi Works Platform
+    #
+    # @return [MoxiWorksPlatform::Contact]
+    #
+    # @example
+    #   contact = MoxiWorksPlatform::Contact.new()
+    #   contact.moxi_works_agent_id = '123abcd'
+    #   contact.partner_contact_id = 'myUniqueContactIdentifier'
+    #   contact.contact_name = 'J Jonah Jameson'
+    #   contact.primary_email_address = 'j.jonah.jameson@househun.ter'
+    #   contact.save
+    def save
+      MoxiworksPlatform::Contact.create(self.to_hash)
+    end
+
+    # Delete an instance of MoxiWorksPlatform::Contact from Moxi Works Platform
+    #
+    # @return [Boolean] -- success of the delete action
+    #
+    # @example
+    #   contact = MoxiWorksPlatform::Contact.find(moxi_works_agent_id: '123abcd', partner_contact_id: 'myUniqueContactId' )
+    #   success = contact.delete
+    def delete(opts={})
+      MoxiworksPlatform::Contact.delete(opts)
+    end
+
+    private
+    def method_missing(meth, *args, &block)
+      float_attrs = [:property_baths, :search_min_baths]
+      int_attrs = [:property_beds, :property_list_price, :search_min_year_built,
+                   :search_min_sq_ft, :search_min_price, :search_min_beds,
+                   :search_max_year_built, :search_max_sq_ft, :search_max_price,
+                   :search_max_lot_size]
+      all_attrs = float_attrs + int_attrs
+
+      name = meth.to_sym
+      if all_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
+
+    def numeric_value_for(attr_name, opts={})
+      val = self.instance_variable_get("@#{attr_name}")
+      return val if val.is_a? Numeric
+      case opts[:type]
+        when :integer
+          instance_variable_set("@#{attr_name}", (val.nil? or val.empty?) ? nil : val.to_i)
+        when :float
+          instance_variable_set("@#{attr_name}", (val.nil? or val.empty?) ? nil : val.to_f)
+        else
+          instance_variable_set("@#{attr_name}", nil)
+      end
+      self.instance_variable_get("@#{attr_name}")
+    rescue => e
+      puts "problem with auto conversion: #{e.message} #{e.backtrace}"
+      nil
+    end
+
+  end
+
+end

data/lib/moxiworks_platform/credentials.rb

@@ -0,0 +1,108 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Credentials
+  #
+  # A Singleton class used for authorization on the Moxi Works Platform
+  #
+  class Credentials
+
+    class << self
+      # @!attribute instance
+      #
+      #    Singleton instance of MoxiworksPlatform::Credentials
+      #
+      #   @return [MoxiworksPlatform::Credentials]
+      attr_accessor :instance
+
+      # @!attribute platform_identifier
+      #
+      #   The Moxi Works Platform Identifier associated with the MoxiworksPlatform::Credentials instance
+      #
+      #   This should be set when MoxiworksPlafform::Credentials is instantiated
+      #
+      #   @return [String]
+      attr_accessor :platform_identifier
+
+      # @!attribute platform_secret
+      #
+      #   The Moxi Works Platform Secret associated with the MoxiworksPlatform::Credentials instance
+      #
+      #   This should be set when MoxiworksPlafform::Credentials is instantiated
+      #
+      #   @return [String]
+      attr_accessor :platform_secret
+    end
+
+
+    # @param [String] platform_id Your provided Moxi Works Platform Identifier
+    # @param [String] platform_secret Your provided Moxi Works Platform Secret
+    #
+    # @return [MoxiWorksPlatform::Credentials]
+    #
+    # @example
+    #   platform_identifier = 'abc1234'
+    #   platform_secret = 'secret'
+    #   MoxiworksPlatform::Credentials.new(platform_identifier, platform_secret)
+    def self.new(*args, &block)
+      pid = args[0]
+      ps = args[1]
+      return MoxiworksPlatform::Credentials.instance if
+          MoxiworksPlatform::Credentials.instance and
+              (pid == MoxiworksPlatform::Credentials.platform_identifier and
+              ps == MoxiworksPlatform::Credentials.platform_secret)
+
+      super(*args, &block)
+    end
+
+    # whether the required values for authorization have been set in the Singleton instance of MoxiworksPlatform::Credentials
+    #
+    # @return [Boolean] Returns `true` if the access key id and secret access key are both set.
+    def self.set?
+      not ((platform_identifier.nil? or
+          platform_identifier.empty?) or
+          (platform_secret.nil? or
+              platform_secret.empty?))
+    end
+
+    # @param [String] platform_id Your provided Moxi Works Platform Identifier
+    # @param [String] platform_secret Your provided Moxi Works Platform Secret
+    #
+    def initialize(platform_identifier, platform_secret)
+      return if MoxiworksPlatform::Credentials.instance
+      MoxiworksPlatform::Credentials.platform_identifier = platform_identifier
+      MoxiworksPlatform::Credentials.platform_secret = platform_secret
+      MoxiworksPlatform::Credentials.instance = self
+    end
+
+    # The Moxi Works Platform Identifier associated with the MoxiworksPlatform::Credentials instance
+    #
+    # This should be set when MoxiworksPlafform::Credentials is instantiated
+    #
+    # @return [String]
+    def platform_identifier
+      MoxiworksPlatform::Credentials.platform_identifier
+    end
+
+    # The Moxi Works Platform Secret associated with the MoxiworksPlatform::Credentials instance
+    #
+    # This should be set when MoxiworksPlafform::Credentials is instantiated
+    #
+    # @return [String]
+    def platform_secret
+      MoxiworksPlatform::Credentials.platform_secret
+    end
+
+    # whether the required values for authorization have been set in the Singleton instance of MoxiworksPlatform::Credentials
+    #
+    # @return [Boolean] Returns `true` if the access key id and secret access key are both set.
+    def set?
+      MoxiworksPlatform::Credentials.set?
+    end
+
+    # Removing the secret access key from the default inspect string.
+    # @api private
+    def inspect
+      "#<#{self.class.name} access_key_id=#{platform_identifier.inspect}>"
+    end
+
+  end
+end

data/lib/moxiworks_platform/exception.rb

@@ -0,0 +1,10 @@
+module MoxiworksPlatform
+  module Exception
+    # general error for moxi_works_platform all other errors are children of
+    class PlatformError < StandardError; end
+
+    # an expected argument is not defined, or the argument is in an unexpected form
+    class ArgumentError < PlatformError; end
+
+  end
+end

data/lib/moxiworks_platform/resource.rb

@@ -0,0 +1,89 @@
+require 'rest-client'
+require 'base64'
+
+module MoxiworksPlatform
+  #  provides underlying logic for connecting to Moxi Works Platform over HTTPS
+  class Resource
+
+    # keep a list of attr_accessors defined in this class
+    #
+    # used to convert Resource child object into parameters required for saving
+    # in Moxi Works Platform
+    #
+    def self.attr_accessor(*vars)
+      @attributes ||= []
+      @attributes.concat vars
+      super(*vars)
+    end
+
+    # all available accessors defined in this class
+    #
+    # @return [Array][String] all defined accessors of this class
+    def self.attributes
+      @attributes
+    end
+
+    # HTTP headers required to connect to Moxi Works Platform
+    #
+    # @return [Hash] formatted headers suitable for a RestClient connection
+    def self.headers
+      {
+          Authorization: auth_header,
+          Accept: accept_header,
+          'Content-Type' =>  content_type
+      }
+    end
+
+    # formatted Authorization header content
+    #
+    # @return [String] Authorization header content
+    def self.auth_header
+      raise 'MoxiworksPlatform::Credentials must be set before using' unless
+          MoxiworksPlatform::Credentials.set?
+      identifier = MoxiworksPlatform::Credentials.platform_identifier
+      secret = MoxiworksPlatform::Credentials.platform_secret
+      'Basic ' + Base64.encode64("#{identifier}:#{secret}").gsub(/\n/, '')
+    end
+
+    # formatted Accept header content
+    #
+    # @return [String] Accept header content
+    def self.accept_header
+      'application/vnd.moxi-platform+json;version=1'
+    end
+
+    # formatted Content-Type header
+    #
+    # @return [String] Content-Type header content
+    def self.content_type
+      'application/x-www-form-urlencoded'
+    end
+
+    # maps Hash values to Instance variables for mapping JSON object values to our Class attributes
+    #
+    def initialize(hash={})
+      hash.each do |key,val|
+        instance_variable_set("@#{key}", val)
+      end
+    end
+
+    # all available accessors defined in this class
+    #
+    # @return [Array][String] all defined accessors of this class
+    def attributes
+      self.class.attributes
+    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
+
+
+  end
+
+end

data/lib/moxiworks_platform/version.rb

@@ -0,0 +1,3 @@
+module MoxiworksPlatform
+  VERSION = '0.0.1'
+end

data/moxiworks_platform.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'moxiworks_platform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "moxiworks_platform"
+  spec.version       = MoxiworksPlatform::VERSION
+  spec.authors       = ["Tres Wong-Godfrey"]
+  spec.email         = ["tres.wong-godfrey@moxiworks.com"]
+
+  spec.summary       = %q{Ruby Moxi Works Platform Client}
+  spec.homepage      = 'http://github.io/moxiworks-platform/moxiworks-platform-ruby'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rest-client'
+  spec.add_dependency 'hashie'
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: moxiworks_platform
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tres Wong-Godfrey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tres.wong-godfrey@moxiworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/moxiworks_platform.rb
+- lib/moxiworks_platform/config.rb
+- lib/moxiworks_platform/contact.rb
+- lib/moxiworks_platform/credentials.rb
+- lib/moxiworks_platform/exception.rb
+- lib/moxiworks_platform/resource.rb
+- lib/moxiworks_platform/version.rb
+- moxiworks_platform.gemspec
+homepage: http://github.io/moxiworks-platform/moxiworks-platform-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Moxi Works Platform Client
+test_files: []
+has_rdoc: