moxiworks_platform 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4d49576abd1c15d64e80f9ee278c1171da8b910
-  data.tar.gz: adfd70c2e4854f001666b920378e9e1893f50057
+  metadata.gz: 42c31e2e96f745d28cce316626e3952b28fa05ac
+  data.tar.gz: 86041d7a7ad42aec57dae357c05a8206f6eaeddd
 SHA512:
-  metadata.gz: 1a6b7ae51c1e053bf30c5b99a7747de63690752688495b3ab88d857c334a4aaeeaf36c59ceb3b81705f8af26b14a503ed5925c0b3380cb069e893eec2dde8dfd
-  data.tar.gz: de0bba221f202a21ddd0857b10bec85c3fa99bd3fbb186b0619cf4f547def204f0b190f7d99548417ce70cbef44c5a2f4c5076015ddfecd14ae1d13cc649cea7
+  metadata.gz: a0175f05701d31299c62a6cf340440890547955e00254cf738667e797a1cf52fa259aea4128dca404b823b6d475fcd7b7d68dd08c45fd5ce23863dad2369d776
+  data.tar.gz: c3312668276b3cf23fa639aa6f773a891bfdf5508f6c9195c1dbebeb155c9e218388b954e99fcb007f14d6bfb45bab0a930c5c0406476471f077f677afa394a2

data/lib/moxiworks_platform/contact.rb

@@ -86,6 +86,12 @@ module MoxiworksPlatform
     #   @return [String] -- Default ''
     attr_accessor :job_title
 
+    # @!attribute note
+    #   more detailed information about the Contact
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :note
+
     # @!attribute occupation
     #   the general occupation of this contact; ex: 'Software Developer'
     #
@@ -302,6 +308,15 @@ module MoxiworksPlatform
     #   @return [Integer] -- Default nil
     attr_writer :search_min_beds
 
+    # @!attribute search_min_lot_size
+    #
+    #   the minimum lot size used by the contact when searching for listings
+    #
+    #   Property Search (PS) attribute
+    #
+    #   @return [Integer] -- Default nil
+    attr_writer :search_min_lot_size
+
     # @!attribute search_min_price
     #
     #   the minimum price used by the contact when searching for listings
@@ -713,7 +728,7 @@ module MoxiworksPlatform
       [: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]
+                         :search_min_lot_size, :search_max_lot_size]
     end
 
   end

data/lib/moxiworks_platform/event.rb

@@ -34,14 +34,8 @@ module MoxiworksPlatform
     # @return [String]
     attr_accessor :note
 
-    # @!attribute send_reminder
-    # whether a reminder should be sent to the agent
-    #
-    # @return [Boolean]
-    attr_accessor :send_reminder
-
     # @!attribute remind_minutes_before
-    # how many minutes before the event a reminder should be sent (if send_reminder is true)
+    # how many minutes before the event a reminder should be sent
     #
     # @return [Integer]
     attr_writer :remind_minutes_before
@@ -64,12 +58,6 @@ module MoxiworksPlatform
     # @return [Integer]
     attr_writer :event_end
 
-    # @!attribute recurring
-    # whether the event is recurring
-    #
-    # @return [Boolean]
-    attr_accessor :recurring
-
     # @!attribute all_day
     # whether the event is an all day event
     #
@@ -87,12 +75,10 @@ module MoxiworksPlatform
     # @option opts [String] :event_subject  a brief human-readable description of the event
     # @option opts [String] :event_location human-readable description of the event's location
     # @option opts [String] :note human-readable details regarding the event
-    # @option opts [Boolean] :send_reminder whether a reminder should be sent beforehand
-    # @option opts [Integer] :remind_minutes_before how many minutes before the event the reminder should be sent (if send_reminder is true)
+    # @option opts [Integer] :remind_minutes_before how many minutes before the event the reminder should be sent
     # @option opts [Boolean] :is_meeting whether the event is a meeting
     # @option opts [Integer] :event_start Unix timestamp representing the start time of the event
     # @option opts [Integer] :event_end Unix timestamp representing the end time of the event
-    # @option opts [Boolean] :recurring whether the event is a recurring event
     # @option opts [Boolean] :all_day whether the event is an all day event
     #
     # @return [MoxiworksPlatform::Event]
@@ -106,12 +92,10 @@ module MoxiworksPlatform
     #         event_subject: 'foo deeaz',
     #         event_location: '1234 there ave',
     #         note: 'yo, whatup?',
-    #         send_reminder: true,
     #         remind_minutes_before: 10,
     #         is_meeting: true,
     #         event_start: Time.now.to_i,
     #         event_end: Time.now.to_i + 86400,
-    #         recurring: false,
     #         all_day: false
     #     )
     #
@@ -145,7 +129,7 @@ module MoxiworksPlatform
     #   {   "date" => "MM/DD/YY",
     #       "events" => [ MoxiworkPlatform::Event, MoxiworkPlatform::Event ]
     #   }
-     #
+    #
     # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
     #     named parameters aren't included
     #
@@ -193,12 +177,10 @@ module MoxiworksPlatform
     # @option opts [String] :event_subject  a brief human-readable description of the event
     # @option opts [String] :event_location human-readable description of the event's location
     # @option opts [String] :note human-readable details regarding the event
-    # @option opts [Boolean] :send_reminder whether a reminder should be sent beforehand
-    # @option opts [Integer] :remind_minutes_before how many minutes before the event the reminder should be sent (if send_reminder is true)
+    # @option opts [Integer] :remind_minutes_before how many minutes before the event the reminder should be sent
     # @option opts [Boolean] :is_meeting whether the event is a meeting
     # @option opts [Integer] :event_start Unix timestamp representing the start time of the event
     # @option opts [Integer] :event_end Unix timestamp representing the end time of the event
-    # @option opts [Boolean] :recurring whether the event is a recurring event
     # @option opts [Boolean] :all_day whether the event is an all day event
     #
     # @return [MoxiworksPlatform::Event]
@@ -212,12 +194,10 @@ module MoxiworksPlatform
     #         event_subject: 'foo deeaz',
     #         event_location: '1234 there ave',
     #         note: 'yo, whatup?',
-    #         send_reminder: true,
     #         remind_minutes_before: 10,
     #         is_meeting: true,
     #         event_start: Time.now.to_i,
     #         event_end: Time.now.to_i + 86400,
-    #         recurring: false,
     #         all_day: false
     #     )
     #
@@ -273,8 +253,7 @@ module MoxiworksPlatform
     # @option opts [String] :event_subject  a brief human-readable description of the event
     # @option opts [String] :event_location human-readable description of the event's location
     # @option opts [String] :note human-readable details regarding the event
-    # @option opts [Boolean] :send_reminder whether a reminder should be sent beforehand
-    # @option opts [Integer] :remind_minutes_before how many minutes before the event the reminder should be sent (if send_reminder is true)
+    # @option opts [Integer] :remind_minutes_before how many minutes before the event the reminder should be sent
     # @option opts [Boolean] :is_meeting whether the event is a meeting
     # @option opts [Integer] :event_start Unix timestamp representing the start time of the event
     # @option opts [Integer] :event_end Unix timestamp representing the end time of the event

data/lib/moxiworks_platform/group.rb

@@ -0,0 +1,113 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Event
+  class Group < MoxiworksPlatform::Resource
+    # @!attribute moxi_works_agent_id
+    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which the group is
+    #   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 moxi_works_group_id
+    # your system's event ID for the event
+    #
+    # @return [String] representing the name of the group on the Moxi Works Platform
+    attr_accessor :moxi_works_group_name
+
+    # @!attribute contacts
+    # the contacts in the group
+    #
+    # @return [Array] of MoxiworksPlatform::Contact objects
+    attr_reader :contacts
+
+    # Find an Event  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 event is associated
+    # @option opts [Integer]  :moxi_works_group_id *REQUIRED* The Moxi Works Group ID for this group.
+    #
+    # @return [MoxiworksPlatform::Group]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if moxi_works_group_id
+    #   is not an Integer or an integer as a String
+    #
+    # @example
+    #     results = MoxiworksPlatform::Group.find(
+    #     moxi_works_agent_id: '123abc',
+    #     moxi_works_group_name: 'foobar'
+    #       )
+    #
+    def self.find(opts={})
+      required_opts = [:moxi_works_agent_id, :moxi_works_group_name]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].empty?
+      end
+      url = "#{MoxiworksPlatform::Config.url}/api/groups/#{opts[:moxi_works_group_name]}"
+      group = nil
+      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)
+        return false if not json['status'].nil? and json['status'] =='fail'
+        group = MoxiworksPlatform::Group.new(json) unless json.nil? or json.empty?
+      end
+      group
+    end
+
+
+    # Search an Agent's Groups 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 event is associated
+    # @option opts [String]  :moxi_works_group_name optional name to search for. If no name is provided, all of the Agent's Groups will be returned
+    #
+    # @return [Array] containing MoxiworksPlatform::Group objects formatted as follows:
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Group.search(
+    #     moxi_works_agent_id: '123abc',
+    #        )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/groups"
+      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::Group.new(r) unless r.nil? or r.empty?
+        end
+      end
+      results
+    end
+
+    # @return [Array] of MoxiworksPlatform::Contact objects
+    def contacts=(contacts)
+      new_contacts = []
+      unless contacts.nil? or contacts.empty?
+        contacts.each do |c|
+          new_contacts << MoxiworksPlatform::Contact.new(c)
+        end
+        @contacts = new_contacts
+      end
+      new_contacts
+    end
+  end
+end

data/lib/moxiworks_platform/resource.rb

@@ -124,6 +124,7 @@ module MoxiworksPlatform
       val = self.instance_variable_get("@#{attr_name}")
       return val.to_i if val.is_a? Numeric and opts[:type] == :integer
       return val if val.is_a? Numeric
+      return 0 if val.nil? or val.empty?
       val.gsub!(/[^[:digit:]|\.]/, '') if val.is_a? String
       case opts[:type]
         when :integer

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/moxiworks_platform.rb

@@ -6,6 +6,7 @@ require 'moxiworks_platform/credentials'
 require 'moxiworks_platform/contact'
 require 'moxiworks_platform/agent'
 require 'moxiworks_platform/event'
+require 'moxiworks_platform/group'
 
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/moxiworks_platform/credentials.rb
 - lib/moxiworks_platform/event.rb
 - lib/moxiworks_platform/exception.rb
+- lib/moxiworks_platform/group.rb
 - lib/moxiworks_platform/resource.rb
 - lib/moxiworks_platform/version.rb
 - moxiworks_platform.gemspec