moxiworks_platform 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072579124ac364093cd09aa3d4f38f51c9e989f3
-  data.tar.gz: df8c6f749772c71cea209cfb680e383f816541fa
+  metadata.gz: 3d70046f5068c47a6d9178766c79098202ace1c2
+  data.tar.gz: a1415726e2d739f552748550414726b00e4c4fd3
 SHA512:
-  metadata.gz: 92e57d0bb040aaf014780ec238c2ab823276151d01cf8f178eef3af957e0b6e80df4062a0b2955ad0ab49d8c28bf02b105a20498415ee8b5c72f3378f9ce3d5a
-  data.tar.gz: ccb695f90ae5533724c320871a6803eb9f81040e234ec9287d039c6220924a0fa9ca6911d2b919f47b721c3d14c07969d942604eb13010e69db0b9d4dc18bc3d
+  metadata.gz: fb909fa1c8e6bf010df56b355778ca45075ab1b55efb1593163a0843a154b9798ba45b09b10a2063f5211d4c866466156166eb3acb1792a231ec1909d0c4fca0
+  data.tar.gz: 2c5196daa5c8dee9fec32fd2a271c71d9ed7e9069c13cf2c4a86077d9c4078b5120b64acb8ddad3af63f0ffdca2ee576768c910e1b3f6e298b3d965ac6872c59

data/lib/moxiworks_platform.rb

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

data/lib/moxiworks_platform/action_log.rb

@@ -20,13 +20,13 @@ module  MoxiworksPlatform
     # @!attribute title
     #   the title to be displayed for this ActionLog Entry
     #
-    #   @return [String] -- Default ''
+    #   @return [String]
     attr_accessor :title
 
     # @!attribute body
     #   the body of the log entry to be displayed for this ActionLog Entry
     #
-    #   @return [String] -- Default ''
+    #   @return [String]
     attr_accessor :body
 
     # Creates a new ActionLog entry in Moxi Works Platform
@@ -73,7 +73,7 @@ module  MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       results = []
       RestClient::Request.execute(method: :get,
@@ -109,7 +109,7 @@ module  MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       super(method, opts, url)
     end

data/lib/moxiworks_platform/agent.rb

@@ -170,7 +170,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       super(method, opts, url)
     end

data/lib/moxiworks_platform/contact.rb

@@ -471,7 +471,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       results = []
       RestClient::Request.execute(method: :get,
@@ -596,7 +596,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       RestClient::Request.execute(method: :delete,
                                   url: url,
@@ -674,7 +674,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       opts[:contact_id] = opts[:partner_contact_id]
       super(method, opts, url)

data/lib/moxiworks_platform/event.rb

@@ -158,7 +158,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       results = []
       RestClient::Request.execute(method: :get,
@@ -243,7 +243,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       RestClient::Request.execute(method: :delete,
                                   url: url,
@@ -287,7 +287,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       opts[:event_id] = opts[:partner_event_id]
       super(method, opts, url)

data/lib/moxiworks_platform/group.rb

@@ -73,7 +73,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       results = []
       RestClient::Request.execute(method: :get,
@@ -107,7 +107,7 @@ module MoxiworksPlatform
       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?
+            opts[opt].nil? or opts[opt].to_s.empty?
       end
       super(method, opts, url)
     end

data/lib/moxiworks_platform/resource.rb

@@ -96,7 +96,7 @@ module MoxiworksPlatform
     #
     # @return [Array][String] all defined accessors of this class
     def attributes
-      self.class.attributes
+      self.class.attributes + numeric_attrs
     end
 
     # convert this class into a Hash structure where attributes are Hash key names and attribute values are Hash values

data/lib/moxiworks_platform/task.rb

@@ -0,0 +1,299 @@
+module  MoxiworksPlatform
+  class Task < MoxiworksPlatform::Resource
+    # @!attribute moxi_works_agent_id
+    #   moxi_works_agent_id is the Moxi Works Platform ID of the agent which a Task 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 partner_task_id
+    #
+    # @return [String] your system's unique identifier for the Task
+    attr_accessor :partner_task_id
+
+    # @!attribute name
+    #   the title to be displayed to the agent for this Task
+    #
+    #   @return [String]
+    attr_accessor :name
+
+    # @!attribute description
+    #   a detailed description to be displayed to the agent for this Task
+    #
+    #   @return [String]
+    attr_accessor :description
+
+    # @!attribute due_at
+    #   the Unix timestamp representing the due date of this Task
+    #
+    #   @return [Integer]
+    attr_writer :due_at
+
+    # @!attribute duration
+    #   the length (in minutes) estimated to complete this Task
+    #
+    #   @return [Integer]
+    attr_writer :duration
+
+    # @!attribute status
+    #   an enumerated string representing the state of this Task
+    #
+    #   allowed values:
+    #     active
+    #     completed
+    #     [nil]
+    #
+    #   When creating a new task, the assumed state is 'active;' this attribute does
+    #   not need to be populated when creating or updating a Task unless the
+    #   status is 'completed.'
+    #
+    #
+    #   @return [String, enumerated] -- Default: 'active'
+    attr_accessor :status
+
+    # @!attribute created_at
+    #   the Unix timestamp representing the Date/Time this Task was created
+    #
+    # Read Only Attribute
+    #
+    #   @return [Integer]
+    attr_writer :created_at
+
+    # @!attribute completed_at
+    #   the Unix timestamp representing the Date/Time this task was completed.
+    #
+    #   When the task is not in a 'completed' state, this attribute will be nil.
+    #
+    #   When updating the *completed_at* attribute, the *status* attribute must
+    #   be set to 'completed'
+    #
+    #   @return [Integer|nil] -- Default nil
+    attr_writer :completed_at
+
+    # Creates a new Task 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 task is to be associated
+    # @option opts [String]  :partner_task_id *REQUIRED* Your system's unique ID for this task.
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the Contact for whom this Task is to be associated.
+    #
+    #     optional Task parameters
+    #
+    # @option opts [String] :name short description of the task
+    # @option opts [String] :description longer description of the task
+    # @option opts [Integer] :due_at Unix timestamp representing the due date
+    # @option opts [Integer] :duration Length of time in minutes that the task should take
+    #
+    # @return [MoxiworksPlatform::Task]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #   MoxiworksPlatform::Task.create(
+    #         moxi_works_agent_id: '123abc',
+    #         partner_contact_id: '1234',
+    #         partner_task_id: 'mySystemsUniqueTaskID',
+    #         name: 'pick up client keys',
+    #         description: 'pick up client keys from1234 there ave',
+    #         due_at: Time.now.to_i + 86400,
+    #         duration: 30
+    #     )
+    #
+    def self.create(opts={})
+      required_opts = [:moxi_works_agent_id, :partner_task_id, :partner_contact_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+      self.send_request(:post, opts)
+     end
+
+    # Find an Task  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 task is associated
+    # @option opts [String]  :partner_task_id *REQUIRED* Your system's unique ID for this task.
+    #
+    # @return [MoxiworksPlatform::Task]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.find(opts={})
+      required_opts = [:moxi_works_agent_id, :partner_task_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+      url = "#{MoxiworksPlatform::Config.url}/api/tasks/#{opts[:partner_task_id]}"
+      self.send_request(:get, opts, url)
+    end
+
+
+    # Search Agent's Tasks 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 associated
+    # @option opts [Integer] :due_date_start  *REQUIRED*  Tasks due after specified date
+    # @options opts [Integer] :due_date_end  *REQUIRED*  tasks due before specified date
+    #
+    #
+    #     optional Search parameters
+    #
+    # @option opts [String]  :partner_contact_id The partner's ID for the contact whose tasks they are looking for
+    # @option opts [Integer] :page_number the page of results to return
+    #
+    # @return [Hash] with the format:
+    #   {
+    #     page_number: [Integer],
+    #     total_pages: [Integer],
+    #     tasks:  [Array] containing MoxiworkPlatform::Task objects
+    #   }
+    #
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Contact.search(
+    #     moxi_works_agent_id: '123abc',
+    #     due_date_start:  Time.now.to_i - 1296000,
+    #     due_date_end: Time.now.to_i,
+    #     page_number: 2
+    #     )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/tasks"
+      required_opts = [:moxi_works_agent_id, :due_date_start, :due_date_end]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+      results = []
+      json = { 'page_number': 1, 'total_pages': 0, 'tasks':[]}
+      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['tasks'].each do |r|
+          results << MoxiworksPlatform::Task.new(r) unless r.nil? or r.empty?
+        end
+        json['tasks'] = results
+      end
+      json
+    end
+
+    # Updates an existing Task 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 task is to be associated
+    # @option opts [String]  :partner_task_id *REQUIRED* Your system's unique ID for this task.
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the Contact for whom this Task is to be associated.
+    #
+    #     optional Task parameters
+    #
+    # @option opts [String] :name short description of the task
+    # @option opts [String] :description longer description of the task
+    # @option opts [Integer] :due_at Unix timestamp representing the due date
+    # @option opts [Integer] :duration Length of time in minutes that the task should take
+    # @option opts [Integer] :completed_at Unix timestamp representing the date the task was completed
+    # @option opts [String] :status enumerated string representing task status
+    #
+    # @return [MoxiworksPlatform::Task]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #   MoxiworksPlatform::Task.create(
+    #         moxi_works_agent_id: '123abc',
+    #         partner_contact_id: '1234',
+    #         partner_task_id: 'mySystemsUniqueTaskID',
+    #         name: 'pick up client keys',
+    #         description: 'pick up client keys from1234 there ave',
+    #         due_at: Time.now.to_i + 86400,
+    #         duration: 30,
+    #         status: 'completed',
+    #         completed_at: Time.now.to_i,
+    #     )
+    #
+    def self.update(opts={})
+      required_opts = [:moxi_works_agent_id, :partner_task_id, :partner_contact_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+       url = "#{MoxiworksPlatform::Config.url}/api/tasks/#{opts[:partner_task_id]}"
+       self.send_request(:put, opts, url)
+    end
+    
+    
+    # Send our remote request to 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 task is to be associated
+    # @option opts [String]  :partner_task_id *REQUIRED* Your system's unique ID for this task.
+    # @option opts [String]  :partner_contact_id *REQUIRED* Your system's unique ID for the Contact for whom this Task is to be associated.
+    #
+    #     optional Task parameters
+    #
+    # @option opts [String] :name short description of the task
+    # @option opts [String] :description longer description of the task
+    # @option opts [Integer] :due_at Unix timestamp representing the due date
+    # @option opts [Integer] :duration Length of time in minutes that the task should take
+    # @option opts [Integer] :completed_at Unix timestamp representing the date the task was completed
+    # @option opts [String] :status enumerated string representing task status
+    #
+    # @return [MoxiworksPlatform::Task]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.send_request(method, opts={}, url=nil)
+      url ||= "#{MoxiworksPlatform::Config.url}/api/tasks"
+      required_opts = [:moxi_works_agent_id, :partner_task_id]
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.empty?
+      end
+      super(method, opts, url)
+    end
+
+    # Save an instance of MoxiWorksPlatform::Task to Moxi Works Platform
+    #
+    # @return [MoxiWorksPlatform:Task]
+    #
+    # @example
+    #   task = MoxiWorksPlatform::Task.new()
+    #   task.moxi_works_agent_id = '123abcd'
+    #   task.partner_task_id = 'myUniqueTaskdentifier'
+    #   task.status = 'completed'
+    #   task.completed_at =  Time.now.to_i
+    #   task.save
+    def save
+      MoxiworksPlatform::Task.update(self.to_hash)
+    end
+
+    def created_at=(w)
+      raise  ::MoxiworksPlatform::Exception::ArgumentError, 'created_at is a read-only attribute'
+    end
+      
+    private
+ 
+     def int_attrs
+       [:due_at, :duration, :completed_at, :created_at]
+     end
+    
+
+  end
+end

data/lib/moxiworks_platform/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,7 @@ files:
 - lib/moxiworks_platform/exception.rb
 - lib/moxiworks_platform/group.rb
 - lib/moxiworks_platform/resource.rb
+- lib/moxiworks_platform/task.rb
 - lib/moxiworks_platform/version.rb
 - moxiworks_platform.gemspec
 homepage: https://github.com/moxiworks-platform/moxiworks-ruby