moxiworks_platform 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e8d7e2206d39d1362ad4ceefc7bf01bdfffef99
-  data.tar.gz: ebc93c1f26cd1dc020e9ed47a59c5f5509837c59
+  metadata.gz: 32404d8f1d742f39d698b13b966b4e6a525ce384
+  data.tar.gz: 5b2814778679c1a238d97e1bdf2f0703086a3b7d
 SHA512:
-  metadata.gz: ab84414000cc684c9bde839040e497824255a19f46bb49757f8a55035c64754df3eb41e0e110da8afff2e3ee110dfc93e967e58a3fe379e7b70efd288a549e6b
-  data.tar.gz: 7231087fc9c00c494242aca80635f7d6dc14308d08c649713bc2c56222afcf2ffc4ce97268fb25f3d4d97a190ff8b14840f21e77bc1fe7d1e799c48e4996864e
+  metadata.gz: 0779ade05d1df3da5ffa77d749d94a6561a0a2a6ebf72460207a766dbd767c757e745497394390233d743a2244fbe13a535b2b19d2d5d6773f2051afb53da8ac
+  data.tar.gz: a23ad782dc32483bf36eb8a35920bd667429f12e506ad5d73846090869c278541b4b06a71a974028d5a6be29562400bd7478557bc6903f1a36c7e37da9916810

data/lib/moxiworks_platform.rb

@@ -4,6 +4,7 @@ require 'moxiworks_platform/exception'
 require 'moxiworks_platform/resource'
 require 'moxiworks_platform/credentials'
 require 'moxiworks_platform/contact'
+require 'moxiworks_platform/agent'
 
 
 

data/lib/moxiworks_platform/agent.rb

@@ -0,0 +1,89 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Agent
+  class Agent < MoxiworksPlatform::Resource
+
+    attr_accessor :moxi_works_agent_id
+
+    attr_accessor :mls
+
+    attr_accessor :accreditation
+
+    attr_accessor :address_street
+
+    attr_accessor :address_city
+
+    attr_accessor :address_state
+
+    attr_accessor :address_zip
+
+    attr_accessor :office_address_street
+
+    attr_accessor :office_address_city
+
+    attr_accessor :office_address_state
+
+    attr_accessor :office_address_zip
+
+    attr_accessor :name
+
+    attr_accessor :license
+
+    attr_accessor :mobile_phone_number
+
+    attr_accessor :home_phone_number
+
+    attr_accessor :fax_phone_number
+
+    attr_accessor :main_phone_number
+
+    attr_accessor :primary_email_address
+
+    attr_accessor :secondary_email_address
+
+    attr_accessor :languages
+
+    attr_accessor :twitter
+
+    attr_accessor :google_plus
+
+    attr_accessor :facebook
+
+    attr_accessor :home_page
+
+    attr_accessor :birth_date
+
+    attr_accessor :title
+
+    attr_accessor :profile_image_url
+
+    attr_accessor :profile_thumb_url
+
+    # Find an Agent on the  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
+    #
+    # @return [MoxiworksPlatform::Contact]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.find(opts={})
+      url = "#{MoxiworksPlatform::Config.url}/api/agents/#{self.safe_id(opts[:moxi_works_agent_id])}"
+      self.send_request(:get, opts, url)
+    end
+
+    def self.send_request(method, opts={}, url=nil)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/agents"
+      required_opts = [:moxi_works_agent_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].empty?
+      end
+      super(method, opts, url)
+    end
+
+
+  end
+
+
+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/#{opts[:partner_contact_id]}"
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{self.safe_id(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/#{opts[:partner_contact_id]}"
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{self.safe_id(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/#{opts[:partner_contact_id]}"
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{self.safe_id(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
@@ -673,17 +673,7 @@ module MoxiworksPlatform
             opts[opt].nil? or opts[opt].empty?
       end
       opts[:contact_id] = opts[:partner_contact_id]
-      contact = nil
-      RestClient::Request.execute(method: method,
-                                  url: url,
-                                  payload: opts, headers: self.headers) do |response|
-        puts response if MoxiworksPlatform::Config.debug
-        self.check_for_error_in_response(response)
-        json = JSON.parse(response)
-        return false if not json['status'].nil? and json['status'] =='fail'
-        contact = MoxiworksPlatform::Contact.new(json) unless json.nil? or json.empty?
-      end
-      contact
+      super(method, opts, url)
     end
 
     # Save an instance of MoxiWorksPlatform::Contact to Moxi Works Platform

data/lib/moxiworks_platform/resource.rb

@@ -74,6 +74,20 @@ 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
     #
     def initialize(hash={})
@@ -98,6 +112,18 @@ module MoxiworksPlatform
       hash
     end
 
+    def self.send_request(method, opts={}, url=nil)
+      RestClient::Request.execute(method: method,
+                                  url: url,
+                                  payload: opts, headers: self.headers) do |response|
+        puts response if MoxiworksPlatform::Config.debug
+        self.check_for_error_in_response(response)
+        json = JSON.parse(response)
+        return false if not json['status'].nil? and json['status'] =='fail'
+        self.new(json) unless json.nil? or json.empty?
+      end
+    end
+
   end
 
 end

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,7 @@ files:
 - bin/console
 - bin/setup
 - lib/moxiworks_platform.rb
+- lib/moxiworks_platform/agent.rb
 - lib/moxiworks_platform/config.rb
 - lib/moxiworks_platform/contact.rb
 - lib/moxiworks_platform/credentials.rb