mozenda 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df5e788b9aa9cdd973c584fa647f7bb582a5407e
-  data.tar.gz: 1c568fb8b970edf536f9f09baa0ba8799515c6d5
+  metadata.gz: 7f39bbe0114d3b3d16c066170bba5124c557edd2
+  data.tar.gz: 1a8499ba06d039538c98af718226c496f2d0c374
 SHA512:
-  metadata.gz: 4300329d58e69be4fe6e0b76689f312f4fae8206b737cc457bebb349f57b455b9d5bf1ab23d330433f8c2fe5de14d1d59f1644b01458081b2886ce864a5a7368
-  data.tar.gz: 2344923a865c406118416d9371b30b01c51a720d43fc3cd597027e284f30a1833d4eb455508dec1b537f987ec9d093b029945ccd4a18df235cd5c09202c66c5d
+  metadata.gz: 5fdba3960cc916bd56227b01d426ed4fa7df6f62f87b453065039f19f2d56074efcaa67f19eba1b64e6d5b0ece7a2b6e8aa629e7a00fe61aa1fa49ff6de9ef04
+  data.tar.gz: 6e84a481900419d23fc4f301e6dbe22d4a66dd4e8c45bba42cf80a068c8453462d6b31db39d45a7369d320fe2e6e8a448baf8ece9c760e29e5d9d217d89cb93e

data/README.md

@@ -50,7 +50,7 @@ collection = Mozenda::Model::Collection.new(collection_id)
 collection.clear
 ```
 
-To run Agent:
+To simple run Agent:
 ```ruby
 agent_id = 1050
 agent = Mozenda::Model::Agent.new(agent_id)
@@ -71,17 +71,70 @@ To run Agent with Job.StatusUrl:
 ```ruby
 agent_id = 1050
 agent = Mozenda::Model::Agent.new(agent_id)
-optional_params = {}
+optional_params = {:foo => 123, :bar => "xyz"}
 agent.run(optional_params, {
   :status_url => "http://localhost:3000/some/path",
-  :replacement_values => {
-    :job_id => Mozenda::ReplacementValues::JOB_ID,
-    :job_status => Mozenda::ReplacementValues::JOB_STATUS,
-    :job_ended => Mozenda::ReplacementValues::JOB_ENDED
-  }
+  :replacement_values => [:job_id, :job_status, :job_ended]
 })
 ```
   
+To get Agent info:
+```ruby
+agent_id = 1050
+agent = Mozenda::Model::Agent.new(agent_id)
+agent_get_response = agent.get
+agent_get_response.to_h
+agent_get_response.to_xml
+```
+
+To get Agent Jobs list info:
+```ruby
+agent_id = 1050
+agent = Mozenda::Model::Agent.new(agent_id)
+agent_get_jobs_response = agent.get_jobs
+agent_get_jobs_response.to_h
+agent_get_jobs_response.to_xml
+agent_get_jobs_response.jobs_list
+```
+
+To simple publish Collection:
+```ruby
+collection_id = 1055
+collection = Mozenda::Model::Collection.new(collection_id)
+collection_publish_response = collection.publish
+collection_publish_response.to_h
+collection_publish_response.to_xml
+```
+
+To publish Collection with some status URL & replacement values:
+```ruby
+collection_id = 1055
+collection = Mozenda::Model::Collection.new(collection_id)
+params = {
+  :status_url => "http://my-app.com/-mozen-on-publish-url?my_param=123&other_param=foo",
+  :replacement_values => [:job_id, :job_status, :job_created, :job_ended]
+}
+collection_publish_response = collection.publish(params)
+collection_publish_response.to_h
+collection_publish_response.to_xml
+```
+
+Replacement values (defined in Mozenda::REPLACEMENT_VALUES) for Collection.Publish and/or Agent.Run:
+```ruby
+Mozenda::REPLACEMENT_VALUES = {
+  agent_id: "AgentID",
+  agent_name: "Agent.Name",
+  agent_description: "Agent.Description",
+  agent_domain: "Agent.Domain",
+  job_id: "JobID",
+  job_status: "Job.Status",
+  job_created: "Job.Created",
+  job_ended: "Job.Ended",
+  job_name: "Job.Name",
+  job_description: "Job.Description"
+}
+```
+
 To generate XML file for bulk Collection.AddItem:
 ```ruby
 data = [
@@ -130,6 +183,14 @@ job_get_response.state # => "Done"
 job_get_response.error? # => false
 ```
 
+To pause running Job:
+```ruby
+job_id = "E656D634-C63F-46D9-AFB5-C9AE1F1F2A9E"
+job_pause_response = Mozenda::Model::Job.pause(job_id)
+job_pause_response.to_xml
+job_resume_response.to_h
+```
+
 To resume Job that is in a Paused or Error state:
 ```ruby
 job_id = "7E08EB1F-DDA6-4459-BBDA-3F88B4AB7B7C"
@@ -138,6 +199,14 @@ job_resume_response.to_xml
 job_resume_response.to_h
 ```
 
+To cancel Job that is in a Paused or Error state:
+```ruby
+job_id = "7E08EB1F-DDA6-4459-BBDA-3F88B4AB7B7C"
+job_cancel_response = Mozenda::Model::Job.cancel(job_id)
+job_resume_response.to_xml
+job_resume_response.to_h
+```
+
 
 ## TODO
 * Implement requests-per-minute limit.

data/lib/mozenda/model/agent.rb

@@ -19,5 +19,10 @@ module Mozenda::Model
       request.send!
     end
 
+    def get_jobs
+      request = Mozenda::Request::AgentGetJobs.new(:agent_id => @id)
+      request.send!
+    end
+
   end
 end

data/lib/mozenda/request.rb

@@ -5,6 +5,7 @@ end
 
 require 'mozenda/request/base'
 require 'mozenda/request/agent_get'
+require 'mozenda/request/agent_get_jobs'
 require 'mozenda/request/agent_run'
 require 'mozenda/request/collection_add_item'
 require 'mozenda/request/collection_add_item_bulk'

data/lib/mozenda/request/agent_get_jobs.rb

@@ -0,0 +1,15 @@
+module Mozenda::Request
+  class AgentGetJobs < Mozenda::Request::Base
+
+    def initialize options
+      super
+      put_additional_param("AgentID", options[:agent_id])
+    end
+
+    private
+
+    OPERATION = "Agent.GetJobs"
+    REQUIRED_PARAMS = ["AgentID", "Operation"].freeze
+
+  end
+end

data/lib/mozenda/response.rb

@@ -5,6 +5,7 @@ end
 
 require 'mozenda/response/base'
 require 'mozenda/response/agent_get'
+require 'mozenda/response/agent_get_jobs'
 require 'mozenda/response/agent_run'
 require 'mozenda/response/collection_add_item'
 require 'mozenda/response/collection_clear'

data/lib/mozenda/response/agent_get_jobs.rb

@@ -0,0 +1,13 @@
+module Mozenda::Response
+  class AgentGetJobs < Mozenda::Response::Base
+
+    def job_list
+      body_hash["JobList"]["Job"]
+    end
+
+    private
+
+    NAME = "AgentGetJobsResponse"
+
+  end
+end

data/lib/mozenda/version.rb

@@ -1,5 +1,5 @@
 module Mozenda
 
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mozenda
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Piotr Woloszun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-28 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - lib/mozenda/model/job.rb
 - lib/mozenda/request.rb
 - lib/mozenda/request/agent_get.rb
+- lib/mozenda/request/agent_get_jobs.rb
 - lib/mozenda/request/agent_run.rb
 - lib/mozenda/request/base.rb
 - lib/mozenda/request/collection_add_item.rb
@@ -131,6 +132,7 @@ files:
 - lib/mozenda/request/job_resume.rb
 - lib/mozenda/response.rb
 - lib/mozenda/response/agent_get.rb
+- lib/mozenda/response/agent_get_jobs.rb
 - lib/mozenda/response/agent_run.rb
 - lib/mozenda/response/base.rb
 - lib/mozenda/response/collection_add_item.rb