moxiworks_platform 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 764880d71560cbc0927d992da4d082bc6c6d88f1
-  data.tar.gz: dc9f876b160b7dde211e77ee9804992bd618da8f
+  metadata.gz: 5a2a814339155946906d80974370d8e8335aff15
+  data.tar.gz: b6db5eb3132f59317c65c6fe68566065ff8ac80f
 SHA512:
-  metadata.gz: ba0ecf17a6e5464d6d494245e1dd9c940de89c97f6f49ebc6e1b049c8e2eabc35c8ccf3e4ad5e6a8922f829c9972ad3a73acc80297e4c733ec0b946ee0652bd6
-  data.tar.gz: 62755cce2afbb8b80760ad8218af6776238526a6fdb9ce5157b59f75203b86173a7d4379ef61e4de7d03f0544fcf86b05dca5124233e57075a625f9aad656f47
+  metadata.gz: 8d0886cc1acd4a873a14fec8cc96f129072f052fc0e86159e8416b4c7d43e1eaafedff48db1b88bfa33c0142bd0afbef9b6c25f1ae5140d28d7ac61629323bdd
+  data.tar.gz: 22f5ee37d8b37bc527d1d3c62ab377197cc409d913467448d274ef8587389de5b8f8a4c8029d2b55af7242b45e6a6d36e16649091b743c1e4ace8495845eb759

data/lib/moxiworks_platform/agent.rb

@@ -2,60 +2,153 @@ module MoxiworksPlatform
   # = Moxi Works Platform Agent
   class Agent < 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 mls
+    #
+    # @return [Array] containing strings representing the MLSs the agent is a member of
     attr_accessor :mls
 
+    # @!attribute accreditation
+    #
+    # @return [String] containing any accreditation the agent has
     attr_accessor :accreditation
 
+    # @!attribute address_street
+    #
+    # @return [String] the agent's address, street and number
     attr_accessor :address_street
 
+    # @!attribute address_city
+    #
+    # @return [String] the agent's address, city
     attr_accessor :address_city
 
+    # @!attribute address_state
+    #
+    # @return [String] the agent's address, state
     attr_accessor :address_state
 
+    # @!attribute address_zip
+    #
+    # @return [String] the agent's address, zip code
     attr_accessor :address_zip
 
+    # @!attribute office_address_street
+    #
+    # @return [String] the agent's office address, street and number
     attr_accessor :office_address_street
 
+    # @!attribute office_address_city
+    #
+    # @return [String] the agent's office address, city
     attr_accessor :office_address_city
 
+    # @!attribute office_address_state
+    #
+    # @return [String] the agent's office address, state
     attr_accessor :office_address_state
 
+    # @!attribute office_address_zip
+    #
+    # @return [String] the agent's office address, zip code
     attr_accessor :office_address_zip
 
+    # @!attribute name
+    #
+    # @return [String] the agent's full name
     attr_accessor :name
 
+    # @!attribute license
+    #
+    # @return [String] the agent's license number
     attr_accessor :license
 
+    # @!attribute mobile_phone_number
+    #
+    # @return [String] the agent's mobile phone number
     attr_accessor :mobile_phone_number
 
+    # @!attribute home_phone_number
+    #
+    # @return [String] the agent's home phone number
     attr_accessor :home_phone_number
 
+    # @!attribute mobile_phone_number
+    #
+    # @return [String] the agent's fax phone number
     attr_accessor :fax_phone_number
 
+    # @!attribute main_phone_number
+    #
+    # @return [String] the agent's main phone number
     attr_accessor :main_phone_number
 
+    # @!attribute office_phone_number
+    #
+    # @return [String] the agent's office_phone number
+    attr_accessor :office_phone_number
+
+    # @!attribute primary_email_address
+    #
+    # @return [String] the agent's primary email address
     attr_accessor :primary_email_address
 
+    # @!attribute secondary_email_address
+    #
+    # @return [String] the agent's secondary email address
     attr_accessor :secondary_email_address
 
+    # @!attribute languages
+    #
+    # @return [Array] an array of strings representing any languages the agent speaks
     attr_accessor :languages
 
+    # @!attribute twitter
+    #
+    # @return [String] the agent's twitter handle
     attr_accessor :twitter
 
+    # @!attribute google_plus
+    #
+    # @return [String] the agent's google plus acount
     attr_accessor :google_plus
 
+    # @!attribute facebook
+    #
+    # @return [String] the agent's facebook page
     attr_accessor :facebook
 
+    # @!attribute home_page
+    #
+    # @return [String] the agent's home page url
     attr_accessor :home_page
 
+    # @!attribute primary_email_address
+    #
+    # @return [String] the agent's date of birth
     attr_accessor :birth_date
 
+    # @!attribute title
+    #
+    # @return [String] the agent's title
     attr_accessor :title
 
+    # @!attribute profile_image_url
+    #
+    # @return [String] url to a full size image of the agent
     attr_accessor :profile_image_url
 
+    # @!attribute profile_thumb_url
+    #
+    # @return [String] url to a thumb size image of the agent
     attr_accessor :profile_thumb_url
 
     # Find an Agent on the  Moxi Works Platform
@@ -68,7 +161,7 @@ module MoxiworksPlatform
     #     named parameters aren't included
     #
     def self.find(opts={})
-      url = "#{MoxiworksPlatform::Config.url}/api/agents/#{self.safe_id(opts[:moxi_works_agent_id])}"
+      url = "#{MoxiworksPlatform::Config.url}/api/agents/#{opts[:moxi_works_agent_id]}"
       self.send_request(:get, opts, url)
     end
 

data/lib/moxiworks_platform/contact.rb

@@ -434,7 +434,7 @@ module MoxiworksPlatform
     #     named parameters aren't included
     #
     def self.find(opts={})
-      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{self.safe_id(opts[:partner_contact_id])}"
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{opts[:partner_contact_id]}"
       self.send_request(:get, opts, url)
     end
 
@@ -566,7 +566,7 @@ module MoxiworksPlatform
     #
     def self.update(opts={})
       opts[:contact_id] = opts[:partner_contact_id]
-      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{self.safe_id(opts[:partner_contact_id])}"
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{opts[:partner_contact_id]}"
       self.send_request(:put, opts, url)
     end
 
@@ -587,7 +587,7 @@ module MoxiworksPlatform
     #   success = MoxiWorksPlatform::Contact.delete(moxi_works_agent_id: '123abcd', partner_contact_id: 'myUniqueContactId' )
     #
     def self.delete(opts={})
-      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{self.safe_id(opts[:partner_contact_id])}"
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{opts[:partner_contact_id]}"
       required_opts = [:moxi_works_agent_id, :partner_contact_id]
       required_opts.each do |opt|
         raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if

data/lib/moxiworks_platform/resource.rb

@@ -74,19 +74,6 @@ module MoxiworksPlatform
           not json['status'].nil? and (%w(error fail).include?(json['status']))
     end
 
-    # modify an external ID so that it's fetchable via URL.
-    #
-    # IDs that contain things like dots cause problems when attempting to fetch resources
-    # that use those IDs as primary keys when fetching via RESTful routes
-    # this method converts stuff that isn't handled well, ensuring that we have a uniform
-    # ID and ensuring that those IDs are usable via URL.
-    #
-    # @param [String] an ID to be converted into a URL ready ID
-    #
-    # @return [String] the ID with all the bad stuff converted into URL ready stuff
-    def self.safe_id(id)
-      Base64.urlsafe_encode64(id)
-    end
 
     # maps Hash values to Instance variables for mapping JSON object values to our Class attributes
     #

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-30 00:00:00.000000000 Z
+date: 2016-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler