moxiworks_platform 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af1ad18e3aa537868efdc6515c282e8eb114f01
-  data.tar.gz: 3cfdc524bfb1e218f72eb4481feea165822d7a99
+  metadata.gz: 072579124ac364093cd09aa3d4f38f51c9e989f3
+  data.tar.gz: df8c6f749772c71cea209cfb680e383f816541fa
 SHA512:
-  metadata.gz: 6a5c8a0965120c82411b8b40e1f68167b98daad3902701ba67d3c9fcc76d09796b391b4dfaee322b955caf0d41d604652d749c2f411e27e115b0fb0f928ade04
-  data.tar.gz: 271e1aee47e887a83830a58297b84de20844a5299e5e29756afa4cfcdae7fdea63119842f489034dd5989f0bc1e2dcf9c5d8f18c9dd78956e211de08fef0cdb0
+  metadata.gz: 92e57d0bb040aaf014780ec238c2ab823276151d01cf8f178eef3af957e0b6e80df4062a0b2955ad0ab49d8c28bf02b105a20498415ee8b5c72f3378f9ce3d5a
+  data.tar.gz: ccb695f90ae5533724c320871a6803eb9f81040e234ec9287d039c6220924a0fa9ca6911d2b919f47b721c3d14c07969d942604eb13010e69db0b9d4dc18bc3d

data/lib/moxiworks_platform.rb

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

data/lib/moxiworks_platform/action_log.rb

@@ -0,0 +1,117 @@
+module  MoxiworksPlatform
+  class ActionLog < MoxiworksPlatform::Resource
+    # @!attribute moxi_works_agent_id
+    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which an ActionLog entry 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_contact_id
+    #   *your system's* unique ID for the Contact
+    #
+    #   this must be set for any Moxi Works Platform transaction
+    #
+    #   @return [String] your system's unique ID for the contact
+    attr_accessor :partner_contact_id
+
+    # @!attribute title
+    #   the title to be displayed for this ActionLog Entry
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :title
+
+    # @!attribute body
+    #   the body of the log entry to be displayed for this ActionLog Entry
+    #
+    #   @return [String] -- Default ''
+    attr_accessor :body
+
+    # Creates a new ActionLog entry 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 ActionLog entry is to be associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the contact for whom the ActionLog entry is being created.
+    # @option opts [String]  :title *REQUIRED*  A brief title for this ActionLog entry (85 characters or less)
+    # @option opts [String]  :body *REQUIRED*  The body of this ActionLog entry (255 characters or less)
+    #
+    # @return [MoxiworksPlatform::ActionLog]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #   MoxiworksPlatform::ActionLog.create(
+    #         moxi_works_agent_id: 'abc123',
+    #         partner_contact_id: 'mySystemsUniqueContactID',
+    #         title: 'New home keys were delivered to Firstname Lastname',
+    #         body: 'Firstname Lastname were delivered their keys to1234 there ave',
+    #     )
+    #
+    def self.create(opts={})
+       self.send_request(:post, opts)
+    end
+
+    # Search an Agent's ActionLog entries 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 ActionLog is associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the contact for whom the ActionLog entry is being created.
+    #
+    # @return [Array] containing MoxiworksPlatform::ActionLog objects formatted as follows:
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::ActionLog.search(
+    #     moxi_works_agent_id: '123abc',
+    #        )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/action_logs"
+      required_opts = [:moxi_works_agent_id, :partner_contact_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['actions'].each do |r|
+          results << MoxiworksPlatform::ActionLog.new(r) unless r.nil? or r.empty?
+        end
+      end
+      results
+    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 ActionLog entry is associated
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the contact for whom the ActionLog entry is being created.
+    # @option opts [String]  :title *REQUIRED*  A brief title for this ActionLog entry (85 characters or less)
+    # @option opts [String]  :body *REQUIRED*  The body of this ActionLog entry (255 characters or less)
+    #
+    #
+    # @return [MoxiworksPlatform::ActionLog]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.send_request(method, opts={}, url=nil)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/action_logs"
+      required_opts = [:moxi_works_agent_id, :partner_contact_id, :title, :body]
+      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/group.rb

@@ -1,5 +1,5 @@
 module MoxiworksPlatform
-  # = Moxi Works Platform Event
+  # = Moxi Works Platform Group
   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
@@ -11,7 +11,7 @@ module MoxiworksPlatform
     attr_accessor :moxi_works_agent_id
 
     # @!attribute moxi_works_group_id
-    # your system's event ID for the event
+    # your system's group ID for the group
     #
     # @return [String] representing the name of the group on the Moxi Works Platform
     attr_accessor :moxi_works_group_name
@@ -22,9 +22,9 @@ module MoxiworksPlatform
     # @return [Array] of MoxiworksPlatform::Contact objects
     attr_reader :contacts
 
-    # Find an Event  your system has previously created in Moxi Works Platform
+    # Find a Group  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]  :moxi_works_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this group is associated
     # @option opts [Integer]  :moxi_works_group_id *REQUIRED* The Moxi Works Group ID for this group.
     #
     # @return [MoxiworksPlatform::Group]
@@ -43,12 +43,19 @@ module MoxiworksPlatform
     #
     def self.find(opts={})
       url = "#{MoxiworksPlatform::Config.url}/api/groups/#{opts[:moxi_works_group_name]}"
-      self.send_request(:get, opts, url)
+      contacts = []
+      response = self.send_request(:get, opts, url)
+
+      response.contacts.each do |c|
+        contacts << MoxiworksPlatform::Contact.new(c) unless c.nil? or c.empty?
+      end
+      response.contacts = contacts
+      response
     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_agent_id *REQUIRED* The Moxi Works Agent ID for the agent to which this group is associated
     # @option opts [String]  :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:

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-07-11 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/action_log.rb
 - lib/moxiworks_platform/agent.rb
 - lib/moxiworks_platform/config.rb
 - lib/moxiworks_platform/contact.rb