moxiworks_platform 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a2a814339155946906d80974370d8e8335aff15
-  data.tar.gz: b6db5eb3132f59317c65c6fe68566065ff8ac80f
+  metadata.gz: f4d49576abd1c15d64e80f9ee278c1171da8b910
+  data.tar.gz: adfd70c2e4854f001666b920378e9e1893f50057
 SHA512:
-  metadata.gz: 8d0886cc1acd4a873a14fec8cc96f129072f052fc0e86159e8416b4c7d43e1eaafedff48db1b88bfa33c0142bd0afbef9b6c25f1ae5140d28d7ac61629323bdd
-  data.tar.gz: 22f5ee37d8b37bc527d1d3c62ab377197cc409d913467448d274ef8587389de5b8f8a4c8029d2b55af7242b45e6a6d36e16649091b743c1e4ace8495845eb759
+  metadata.gz: 1a6b7ae51c1e053bf30c5b99a7747de63690752688495b3ab88d857c334a4aaeeaf36c59ceb3b81705f8af26b14a503ed5925c0b3380cb069e893eec2dde8dfd
+  data.tar.gz: de0bba221f202a21ddd0857b10bec85c3fa99bd3fbb186b0619cf4f547def204f0b190f7d99548417ce70cbef44c5a2f4c5076015ddfecd14ae1d13cc649cea7

data/lib/moxiworks_platform.rb

@@ -5,9 +5,10 @@ require 'moxiworks_platform/resource'
 require 'moxiworks_platform/credentials'
 require 'moxiworks_platform/contact'
 require 'moxiworks_platform/agent'
+require 'moxiworks_platform/event'
 
 
 
 module MoxiworksPlatform
-  # Your code goes here...
+
 end

data/lib/moxiworks_platform/contact.rb

@@ -425,7 +425,7 @@ module MoxiworksPlatform
 
     # 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]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is associated
     # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for this contact.
     #
     # @return [MoxiworksPlatform::Contact]
@@ -440,7 +440,7 @@ module MoxiworksPlatform
 
     # 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
+    # @option opts [String]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this contact is associated
     #
     #     optional Search parameters
     #
@@ -691,7 +691,7 @@ module MoxiworksPlatform
       MoxiworksPlatform::Contact.update(self.to_hash)
     end
 
-    # Delete an instance of MoxiWorksPlatform::Contact from Moxi Works Platform
+    # Delete an instance of MoxiWorksPlatform::Contact from Moxi Works Platform that your system has previously created
     #
     # @return [Boolean] -- success of the delete action
     #
@@ -704,39 +704,16 @@ module MoxiworksPlatform
     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)
+
+    def float_attrs
+      [:property_baths, :search_min_baths]
     end
 
-    def numeric_value_for(attr_name, opts={})
-      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
-      val.gsub!(/[^[:digit:]|\.]/, '') if val.is_a? String
-      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
+    def 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]
     end
 
   end

data/lib/moxiworks_platform/event.rb

@@ -0,0 +1,334 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Event
+  class Event < MoxiworksPlatform::Resource
+    # @!attribute moxi_works_agent_id
+    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which a event 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_event_id
+    # your system's event ID for the event
+    #
+    # @return [String] representing the ID of the event in your system
+    attr_accessor :partner_event_id
+
+    # @!attribute event_subject
+    # a short description of the event
+    #
+    # @return [String]
+    attr_accessor :event_subject
+
+    # @!attribute location
+    # a short description of the location of the event
+    #
+    # @return [String]
+    attr_accessor :event_location
+
+    # @!attribute note
+    # a more detailed description of the event
+    #
+    # @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)
+    #
+    # @return [Integer]
+    attr_writer :remind_minutes_before
+
+    # @!attribute is_meeting
+    # whether this event is a meeting
+    #
+    # @return [Boolean]
+    attr_accessor :is_meeting
+
+    # @!attribute event_start
+    # a unix timestamp representing the start time of the event
+    #
+    # @return [Integer]
+    attr_writer :event_start
+
+    # @!attribute event_end
+    # a unix timestamp representing the end time of the event
+    #
+    # @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
+    #
+    # @return [Boolean]
+    attr_accessor :all_day
+
+
+    # Creates a new Event 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 to be associated
+    # @option opts [String]  :partner_event_id *REQUIRED* Your system's unique ID for this event.
+    #
+    #     optional Event parameters
+    #
+    # @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 [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]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #   MoxiworksPlatform::Event.create(
+    #         partner_event_id: 'mySystemsUniqueEventID',
+    #         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
+    #     )
+    #
+    def self.create(opts={})
+       self.send_request(:post, opts)
+     end
+
+    # 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 [String]  :partner_event_id *REQUIRED* Your system's unique ID for this event.
+    #
+    # @return [MoxiworksPlatform::Event]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.find(opts={})
+      url = "#{MoxiworksPlatform::Config.url}/api/events/#{opts[:partner_event_id]}"
+      self.send_request(:get, opts, url)
+    end
+
+
+    # Search an Agent's Events 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]  :date_start *REQUIRED* The Unix timestamp representing the date after which to search
+    # @option opts [Integer]  :date_end *REQUIRED* The Unix timestamp representing the date before which to search
+    #
+    # @return [Array] containing Hash objects formatted as follows:
+    #   {   "date" => "MM/DD/YY",
+    #       "events" => [ MoxiworkPlatform::Event, MoxiworkPlatform::Event ]
+    #   }
+     #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Contact.search(
+    #     moxi_works_agent_id: '123abc',
+    #     date_start: Time.now - 60 * 60 * 24 * 7, # 1 week
+    #     date_end: Time.now
+    #       )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/events"
+      required_opts = [:moxi_works_agent_id, :date_start, :date_end]
+      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 |events_for_date|
+          events = []
+          events_for_date.each do |date, event_array|
+            event_array.each do |r|
+              events << MoxiworksPlatform::Event.new(r) unless r.nil? or r.empty?
+            end
+            results << {date: date, events: events}
+          end
+        end
+      end
+      results
+    end
+
+    # Updates a new Event 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 to be associated
+    # @option opts [String]  :partner_event_id *REQUIRED* Your system's unique ID for this event.
+    #
+    #     optional Event parameters
+    #
+    # @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 [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]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #   MoxiworksPlatform::Event.update(
+    #         partner_event_id: 'mySystemsUniqueEventID',
+    #         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
+    #     )
+    #
+    def self.update(opts={})
+       opts[:event_id] = opts[:partner_event_id]
+       url = "#{MoxiworksPlatform::Config.url}/api/events/#{opts[:partner_event_id]}"
+       self.send_request(:put, opts, url)
+     end
+
+    # Delete an Event 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 event is associated
+    # @option opts [String]  :partner_event_id *REQUIRED* Your system's unique ID for this event.
+    #
+    # @return [Boolean] -- success of the delete action
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #   success = MoxiWorksPlatform::Event.delete(moxi_works_agent_id: '123abcd', partner_event_id: 'myUniqueEventId' )
+    #
+    def self.delete(opts={})
+      url = "#{MoxiworksPlatform::Config.url}/api/events/#{opts[:partner_event_id]}"
+      required_opts = [:moxi_works_agent_id, :partner_event_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].empty?
+      end
+      RestClient::Request.execute(method: :delete,
+                                  url: url,
+                                  payload: opts, headers: self.headers) do |response|
+        puts response if MoxiworksPlatform::Config.debug
+        json = JSON.parse(response)
+        raise ::MoxiworksPlatform::Exception::RemoteRequestFailure,
+              'unable to delete' if json['status'] == 'error'
+        json['status'] == 'success'
+      end
+    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 event is associated
+    # @option opts [String]  :partner_event_id *REQUIRED* Your system's unique ID for this event.
+    #
+    #     optional Event parameters
+    #
+    # @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 [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]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.send_request(method, opts={}, url=nil)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/events"
+      required_opts = [:moxi_works_agent_id, :partner_event_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].empty?
+      end
+      opts[:event_id] = opts[:partner_event_id]
+      super(method, opts, url)
+    end
+
+    # Save an instance of MoxiWorksPlatform::Event to Moxi Works Platform
+    #
+    # @return [MoxiWorksPlatform:Event]
+    #
+    # @example
+    #   event = MoxiWorksPlatform::Event.new()
+    #   event.moxi_works_agent_id = '123abcd'
+    #   event.partner_event_id = 'myUniqueEventdentifier'
+    #   event.event_start =  Time.now.to_i
+    #   event.save
+    def save
+      MoxiworksPlatform::Event.update(self.to_hash)
+    end
+
+    # Delete an instance of MoxiWorksPlatform::Event from Moxi Works Platform that your system has previously created
+    #
+    # @return [Boolean] -- success of the delete action
+    #
+    # @example
+    #   event = MoxiWorksPlatform::Event.find(moxi_works_agent_id: '123abcd', partner_event_id: 'myUniqueEventtId' )
+    #   success = event.delete
+    #
+    def delete
+      MoxiworksPlatform::Event.delete(self.to_hash)
+    end
+
+    private
+
+    def int_attrs
+      [:remind_minutes_before, :event_start, :event_end]
+    end
+
+
+  end
+end

data/lib/moxiworks_platform/resource.rb

@@ -83,6 +83,15 @@ module MoxiworksPlatform
       end
     end
 
+    def method_missing(meth, *args, &block)
+      name = meth.to_sym
+      if numeric_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
+
     # all available accessors defined in this class
     #
     # @return [Array][String] all defined accessors of this class
@@ -111,6 +120,42 @@ module MoxiworksPlatform
       end
     end
 
+    def numeric_value_for(attr_name, opts={})
+      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
+      val.gsub!(/[^[:digit:]|\.]/, '') if val.is_a? String
+      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
+
+    # used by method_missing to ensure that a number is the type we expect it to be
+    def numeric_attrs
+      int_attrs + float_attrs
+    end
+
+    # used by method_missing to ensure that a number is the type we expect it to be
+    # this should be overridden if we have any int values we want to return as ints
+    def int_attrs
+      []
+    end
+
+    # used by method_missing to ensure that a number is the type we expect it to be
+    # this should be overridden if we have any float values we want to return as floats
+    def float_attrs
+      []
+    end
+
   end
 
 end

data/lib/moxiworks_platform/version.rb

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

metadata

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