moxiworks_platform 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af96fed391f3936ebed6ede94c6f4b05d8ddf9d5
-  data.tar.gz: 1a4a034af70aad0fdbbe149a7d959d7ce0ed4150
+  metadata.gz: 4e8d7e2206d39d1362ad4ceefc7bf01bdfffef99
+  data.tar.gz: ebc93c1f26cd1dc020e9ed47a59c5f5509837c59
 SHA512:
-  metadata.gz: 5e37c415d0b7071b1a6fdd9913f6f79e33de27cd9e6659cc8e76b02f46785c7833c0332966048083cd4ca64d8154826468d39fc3f1326b898ac6e0908a152b01
-  data.tar.gz: 7b02fec0cc6fea7e4ae335748f9e9b22abfa27a96059f6b7b0b3d7b27c99eec6cc492c2ee3ebddf4bfffd690be8eb4e3c0774b38b2ec59433bd60f31d87dc8a4
+  metadata.gz: ab84414000cc684c9bde839040e497824255a19f46bb49757f8a55035c64754df3eb41e0e110da8afff2e3ee110dfc93e967e58a3fe379e7b70efd288a549e6b
+  data.tar.gz: 7231087fc9c00c494242aca80635f7d6dc14308d08c649713bc2c56222afcf2ffc4ce97268fb25f3d4d97a190ff8b14840f21e77bc1fe7d1e799c48e4996864e

data/README.md

@@ -19,10 +19,15 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+require 'moxiworks_platform'
+
+
 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')
 ```
 
@@ -34,5 +39,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/moxiworks_platform.
+Bug reports and pull requests are welcome on GitHub at https://github.com/moxiworks-platform/moxiworks-ruby
 

data/lib/moxiworks_platform/contact.rb

@@ -19,14 +19,6 @@ module MoxiworksPlatform
     #   @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 :moxi_works_contact_id
-
-
     # @!attribute business_website
     #   the full URL of the business website to be associated with this Contact
     #
@@ -404,6 +396,11 @@ module MoxiworksPlatform
     # @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]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
     # @example
     #   MoxiworksPlatform::Contact.create(
     #     moxi_works_agent_id: '123abc',
@@ -421,7 +418,7 @@ module MoxiworksPlatform
     #     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
@@ -431,11 +428,60 @@ module MoxiworksPlatform
     # @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]
+    # @return [MoxiworksPlatform::Contact]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
     def self.find(opts={})
-      self.send_request(:get, opts)
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{opts[:partner_contact_id]}"
+      self.send_request(:get, opts, url)
+    end
+
+    # Search an Agent's Contacts 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
+    #
+    #     optional Search parameters
+    #
+    # @option opts [String] :contact_name  full name of the contact
+    # @option opts [String] :email_address full email address of the contact
+    # @option opts [String] :phone_number  full phone number of the contact
+    #
+    # @return [Array] containing MoxiworkPlatform::Contact objects
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Contact.search(
+    #     moxi_works_agent_id: '123abc',
+    #     contact_name: 'george p warshington',
+    #       )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/contacts"
+      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
+      results = []
+      RestClient::Request.execute(method: :get,
+                                  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)
+        json.each do |r|
+          results << MoxiworksPlatform::Contact.new(r) unless r.nil? or r.empty?
+        end
+      end
+      results
     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
@@ -443,7 +489,6 @@ module MoxiworksPlatform
     #
     #     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"
@@ -497,6 +542,9 @@ module MoxiworksPlatform
     #
     # @return [MoxiworksPlatform::Contact]
     #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
     # @example
     #   MoxiworksPlatform::Contact.update(
     #     moxi_works_agent_id: '123abc',
@@ -514,9 +562,11 @@ module MoxiworksPlatform
     #     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]}"
+      opts[:contact_id] = opts[:partner_contact_id]
+      url = "#{MoxiworksPlatform::Config.url}/api/contacts/#{opts[:partner_contact_id]}"
       self.send_request(:put, opts, url)
     end
 
@@ -530,6 +580,9 @@ module MoxiworksPlatform
     #
     # @return [Boolean] -- success of the delete action
     #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
     # @example
     #   success = MoxiWorksPlatform::Contact.delete(moxi_works_agent_id: '123abcd', partner_contact_id: 'myUniqueContactId' )
     #
@@ -558,7 +611,6 @@ module MoxiworksPlatform
     #
     #     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"
@@ -612,15 +664,15 @@ module MoxiworksPlatform
     #
     # @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 = [:moxi_works_agent_id, :partner_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
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
             opts[opt].nil? or opts[opt].empty?
       end
+      opts[:contact_id] = opts[:partner_contact_id]
       contact = nil
       RestClient::Request.execute(method: method,
                                   url: url,
@@ -646,7 +698,7 @@ module MoxiworksPlatform
     #   contact.primary_email_address = 'j.jonah.jameson@househun.ter'
     #   contact.save
     def save
-      MoxiworksPlatform::Contact.create(self.to_hash)
+      MoxiworksPlatform::Contact.update(self.to_hash)
     end
 
     # Delete an instance of MoxiWorksPlatform::Contact from Moxi Works Platform
@@ -656,6 +708,7 @@ module MoxiworksPlatform
     # @example
     #   contact = MoxiWorksPlatform::Contact.find(moxi_works_agent_id: '123abcd', partner_contact_id: 'myUniqueContactId' )
     #   success = contact.delete
+    #
     def delete
       MoxiworksPlatform::Contact.delete(self.to_hash)
     end

data/lib/moxiworks_platform/resource.rb

@@ -63,6 +63,7 @@ module MoxiworksPlatform
     def self.check_for_error_in_response(response)
       begin
         json = JSON.parse(response)
+        return if json.is_a?(Array)
       rescue => e
         raise MoxiworksPlatform::Exception::RemoteRequestFailure, "unable to parse remote response #{e}\n response:\n  #{response}"
       end

data/lib/moxiworks_platform/version.rb

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

data/moxiworks_platform.gemspec

@@ -9,8 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tres Wong-Godfrey"]
   spec.email         = ["tres.wong-godfrey@moxiworks.com"]
 
+  spec.description    =  %q{Moxi Works Platform Client Library For Ruby. Partners can use the Moxi Works Platform Library to quickly integrate into the Moxi Works Platform}
   spec.summary       = %q{Ruby Moxi Works Platform Client}
-  spec.homepage      = 'https://github.io/moxiworks-platform/moxiworks-ruby'
+  spec.homepage      = 'https://github.com/moxiworks-platform/moxiworks-ruby'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Moxi Works Platform Client Library For Ruby. Partners can use the Moxi
+  Works Platform Library to quickly integrate into the Moxi Works Platform
 email:
 - tres.wong-godfrey@moxiworks.com
 executables: []
@@ -89,7 +90,7 @@ files:
 - lib/moxiworks_platform/resource.rb
 - lib/moxiworks_platform/version.rb
 - moxiworks_platform.gemspec
-homepage: https://github.io/moxiworks-platform/moxiworks-ruby
+homepage: https://github.com/moxiworks-platform/moxiworks-ruby
 licenses: []
 metadata: {}
 post_install_message: