moxiworks_platform 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f278e1a919743a23212ed85372496a5a0dbb1548
-  data.tar.gz: 09a94c3a6f1ff0781cafa1eed0da74b1f46954f0
+  metadata.gz: b5982efd3cf0e8359789a16eb2da72383ed3724d
+  data.tar.gz: 9afe87288ef28f30509d1ebd01c68950d2daf91c
 SHA512:
-  metadata.gz: 2d8359b4716ff34c27eb807f08eacd2c2b0c0c0224779ce8e23405c6eaa4c99f64710128f74d801e22d52831c67e508f3afa320a9d6cbf12fb5766d354eb791e
-  data.tar.gz: ea3eb6c0705395285192175c48824aa55eb58ee7d70194a7cb160f6429fb360a7584ba504d326aa4c42c45b00f013f84e7bcd71b205cdb7308069383172c1cd4
+  metadata.gz: c0003810df1a747a898f06abc2c3e52986ff014a46b7be4b41e9b3a904f48cb3baba4fd53151c6f21c4db0e94c148bb326fd14c54507c11d7ef086b88ac5e056
+  data.tar.gz: 74f2f0903418aa1078ecbea64b468a2bfd81a6d59ef7b907f975928484361098710f7e1e89fbb4ab2914abe50e16f42df5fc3db04196bb0412bf0af5fe9c0bfd

data/lib/moxiworks_platform.rb

@@ -10,6 +10,7 @@ require 'moxiworks_platform/group'
 require 'moxiworks_platform/action_log'
 require 'moxiworks_platform/task'
 require 'moxiworks_platform/email_campaign'
+require 'moxiworks_platform/company'
 
 
 

data/lib/moxiworks_platform/action_log.rb

@@ -58,7 +58,7 @@ module  MoxiworksPlatform
     # @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:
+    # @return [Array] containing MoxiworksPlatform::ActionLog objects
     #
     # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
     #     named parameters aren't included
@@ -69,6 +69,8 @@ module  MoxiworksPlatform
     #        )
     #
     def self.search(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/action_logs"
       required_opts = [:moxi_works_agent_id, :partner_contact_id]
       required_opts.each do |opt|
@@ -105,6 +107,8 @@ module  MoxiworksPlatform
     #     named parameters aren't included
     #
     def self.send_request(method, opts={}, url=nil)
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/action_logs"
       required_opts = [:moxi_works_agent_id, :partner_contact_id, :title, :body]
       required_opts.each do |opt|

data/lib/moxiworks_platform/agent.rb

@@ -168,6 +168,8 @@ module MoxiworksPlatform
     def self.send_request(method, opts={}, url=nil)
       url ||= "#{MoxiworksPlatform::Config.url}/api/agents"
       required_opts = [:moxi_works_agent_id]
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       required_opts.each do |opt|
         raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
             opts[opt].nil? or opts[opt].to_s.empty?
@@ -175,6 +177,57 @@ module MoxiworksPlatform
       super(method, opts, url)
     end
 
+    # Search For Agents in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_company_id *REQUIRED* The Moxi Works Company ID For the search (use Company.search to determine available moxi_works_company_id)
+    # @option opts [Integer] :updated_since  *REQUIRED*  Unix timestamp; Only Agents updated after this date will be returned
+    #
+    #
+    #     optional Search parameters
+    #
+    # @option opts [Integer] :page_number the page of results to return
+    #
+    # @return [Hash] with the format:
+    #   {
+    #     page_number: [Integer],
+    #     total_pages: [Integer],
+    #     agents:  [Array] containing MoxiworkPlatform::Agent objects
+    #   }
+    #
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Agent.search(
+    #     moxi_works_company_id: 'the_company',
+    #     updated_since:  Time.now.to_i - 1296000,
+    #     page_number: 2
+    #     )
+    #
+    def self.search(opts={})
+      url ||= "#{MoxiworksPlatform::Config.url}/api/agents"
+      required_opts = [:moxi_works_company_id, :updated_since]
+      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['agents'].each do |r|
+          results << MoxiworksPlatform::Agent.new(r) unless r.nil? or r.empty?
+        end
+        json['agents'] = results
+      end
+      json
+    end
+
 
   end
 

data/lib/moxiworks_platform/company.rb

@@ -0,0 +1,73 @@
+module MoxiworksPlatform
+  # = Moxi Works Platform Company
+  class Company < MoxiworksPlatform::Resource
+
+    # @!attribute moxi_works_company_id
+    #   moxi_works_company_id is the Moxi Works Platform ID of the company
+    #
+    #   @return [String] the Moxi Works Platform ID of the company
+    attr_accessor :moxi_works_company_id
+
+    # @!attribute name
+    #   the human readable name of this Company
+    #
+    #   @return [String] the human readable name of the company
+    attr_accessor :name
+
+    # Find a Company by ID in Moxi Works Platform
+    # @param [Hash] opts named parameter Hash
+    # @option opts [String]  :moxi_works_company_id *REQUIRED* The Moxi Works Company ID
+    #
+    # @return [MoxiworksPlatform::Company]
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    def self.find(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
+      required_opts = [:moxi_works_company_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/companies/#{opts[:moxi_works_company_id]}"
+      self.send_request(:get, opts, url)
+    end
+
+
+    # Show all my Companies in Moxi Works Platform
+    #
+    # @return [Array] containing MoxiworksPlatform::Companies objects
+    #
+    # @raise ::MoxiworksPlatform::Exception::ArgumentError if required
+    #     named parameters aren't included
+    #
+    # @example
+    #     results = MoxiworksPlatform::Companies.search
+    #
+    def self.search(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
+      url ||= "#{MoxiworksPlatform::Config.url}/api/companies"
+      required_opts = []
+      required_opts.each do |opt|
+        raise ::MoxiworksPlatform::Exception::ArgumentError, "#{opt} required" if
+            opts[opt].nil? or opts[opt].to_s.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::Company.new(r) unless r.nil? or r.empty?
+        end
+      end
+      results
+    end
+
+  end
+end

data/lib/moxiworks_platform/contact.rb

@@ -670,6 +670,8 @@ module MoxiworksPlatform
     # @return [MoxiworksPlatform::Contact]
     #
     def self.send_request(method, opts={}, url=nil)
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/contacts"
       required_opts = [:moxi_works_agent_id, :partner_contact_id]
       required_opts.each do |opt|

data/lib/moxiworks_platform/email_campaign.rb

@@ -77,6 +77,8 @@ module  MoxiworksPlatform
     #       )
     #
     def self.search(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/email_campaigns"
       required_opts = [:moxi_works_agent_id, :partner_contact_id]
       required_opts.each do |opt|

data/lib/moxiworks_platform/event.rb

@@ -154,6 +154,8 @@ module MoxiworksPlatform
     #       )
     #
     def self.search(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/events"
       required_opts = [:moxi_works_agent_id, :date_start, :date_end]
       required_opts.each do |opt|
@@ -239,6 +241,8 @@ module MoxiworksPlatform
     #   success = MoxiWorksPlatform::Event.delete(moxi_works_agent_id: '123abcd', partner_event_id: 'myUniqueEventId' )
     #
     def self.delete(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url = "#{MoxiworksPlatform::Config.url}/api/events/#{opts[:partner_event_id]}"
       required_opts = [:moxi_works_agent_id, :partner_event_id]
       required_opts.each do |opt|
@@ -283,6 +287,8 @@ module MoxiworksPlatform
     #     named parameters aren't included
     #
     def self.send_request(method, opts={}, url=nil)
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/events"
       required_opts = [:moxi_works_agent_id, :partner_event_id]
       required_opts.each do |opt|

data/lib/moxiworks_platform/group.rb

@@ -69,6 +69,8 @@ module MoxiworksPlatform
     #        )
     #
     def self.search(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/groups"
       required_opts = [:moxi_works_agent_id]
       required_opts.each do |opt|
@@ -103,6 +105,8 @@ module MoxiworksPlatform
 
     protected
     def self.send_request(method, opts={}, url=nil)
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/agents"
       required_opts = [:moxi_works_agent_id]
       required_opts.each do |opt|

data/lib/moxiworks_platform/resource.rb

@@ -1,5 +1,6 @@
 require 'rest-client'
 require 'base64'
+require 'json'
 
 module MoxiworksPlatform
   #  provides underlying logic for connecting to Moxi Works Platform over HTTPS

data/lib/moxiworks_platform/task.rb

@@ -172,6 +172,8 @@ module  MoxiworksPlatform
     #     )
     #
     def self.search(opts={})
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/tasks"
       required_opts = [:moxi_works_agent_id, :due_date_start, :due_date_end]
       required_opts.each do |opt|
@@ -260,6 +262,8 @@ module  MoxiworksPlatform
     #     named parameters aren't included
     #
     def self.send_request(method, opts={}, url=nil)
+      raise ::MoxiworksPlatform::Exception::ArgumentError,
+            'arguments must be passed as named parameters' unless opts.is_a? Hash
       url ||= "#{MoxiworksPlatform::Config.url}/api/tasks"
       required_opts = [:moxi_works_agent_id, :partner_task_id]
       required_opts.each do |opt|

data/lib/moxiworks_platform/version.rb

@@ -1,3 +1,3 @@
 module MoxiworksPlatform
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moxiworks_platform
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Tres Wong-Godfrey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - lib/moxiworks_platform.rb
 - lib/moxiworks_platform/action_log.rb
 - lib/moxiworks_platform/agent.rb
+- lib/moxiworks_platform/company.rb
 - lib/moxiworks_platform/config.rb
 - lib/moxiworks_platform/contact.rb
 - lib/moxiworks_platform/credentials.rb
@@ -120,4 +121,3 @@ signing_key:
 specification_version: 4
 summary: Ruby Moxi Works Platform Client
 test_files: []
-has_rdoc: