batchly_api 0.5.2 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 175821d2a864e68896b9fc66eccb3995d5e106fd
-  data.tar.gz: dc5ef3dcef932bbd798016487615862d685c56cd
+  metadata.gz: b510810d3ae5a01a8d316ddd2928dae4a7208664
+  data.tar.gz: 1f9f1ace1919879c530f986cb675e79456859db5
 SHA512:
-  metadata.gz: 634ac43cd255741a80125444b1212f39bc3bb1ba654843a53a787ab04cfd69eebdf274c2fa8f80da999caba94d65f41123a686a5756467363c0ab8a7065c456f
-  data.tar.gz: 6b7f36f47e97f29f10673c51b5bcaa1ba591ed81cd322206593ea84e73ab2c0020dc70100090937e0a56d0cb044a70ea15ccb19e3ca1c2d76bb71400463524ac
+  metadata.gz: 862b5a12534ef0c2241e16e046ce4668fab44cb29b7c36535e853f0567711e9639cdd5189872689e81db720a1c2d0d1931414edaaf8af5c96a0676798ca10d65
+  data.tar.gz: 779124184c8fde645263fc08cb6362f547813840ca3a61aa657ee5c2733927a75ee72d6557795346c6dba5bcbf96fd3f26f1948e75e5b8af4512ba33cf467531

data/lib/batchly_api.rb

@@ -1,10 +1,7 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 require 'openssl'
 require 'json'
 require 'unirest'
-require 'uri'
-require 'cgi'
-require 'base64'
 
 # APIMATIC Helper Files
 require 'batchly_api/api_helper.rb'
@@ -20,11 +17,11 @@ require 'batchly_api/controllers/project_controller.rb'
 require 'batchly_api/controllers/run_controller.rb'
 
 # Models
-require 'batchly_api/models/execute_job_request.rb'
-require 'batchly_api/models/add_aws_account_request.rb'
 require 'batchly_api/models/add_s_3_data_source_request.rb'
-require 'batchly_api/models/create_job_request.rb'
 require 'batchly_api/models/job_schedule.rb'
 require 'batchly_api/models/create_project_request.rb'
 require 'batchly_api/models/vpc_details.rb'
 require 'batchly_api/models/update_project_request.rb'
+require 'batchly_api/models/execute_job_request.rb'
+require 'batchly_api/models/add_aws_account_request.rb'
+require 'batchly_api/models/create_job_request.rb'

data/lib/batchly_api/api_exception.rb

@@ -1,4 +1,4 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class APIException < StandardError

data/lib/batchly_api/api_helper.rb

@@ -1,4 +1,4 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi 
   class APIHelper

data/lib/batchly_api/configuration.rb

@@ -1,22 +1,16 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
-module BatchlyApi
+module BatchlyApi 
   class Configuration
 
     # The base Uri for API calls
-    @BASE_URI = "http://api.corrs.batchly.net"
+    @BASE_URI = "http://localhost:14913"
 
-    # The access key for batchly
-    @API_KEY = "UPDATE YOUR GENERATED API KEY HERE"
-
-    # The access key for batchly
-    @API_SECRET = "UPDATE YOUR GENERATED API SECRET HERE"
 
     # create the getters and setters
     class << self
       attr_accessor :BASE_URI
-      attr_accessor :API_KEY
-      attr_accessor :API_SECRET
+
     end
   end
 end

data/lib/batchly_api/controllers/account_controller.rb

@@ -1,17 +1,17 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class AccountController
 
     # Lists all active projects in the given account identifier.
-    # @param [String] id Required parameter: TODO: type description here
+    # @param [String] id Required parameter: Account ID
     # @return Array<ProjectModel> response from the API call
     def list_projects id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Account/{id}/Projects"
+      query_builder << "/api/account/{id}/Projects"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -23,7 +23,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json"
       }
 
@@ -41,105 +41,105 @@ module BatchlyApi
       response.body
     end
 
-    # Add a new AWS account.  The credentials should have IAMFullAccess Permissions.  The keys are used to only create a new Batchly role in AWS IAM. The keys are not saved in batchly servers. Future calls are made using the newly created Batchly Role.
-    # @param [AddAWSAccountRequest] model Required parameter: TODO: type description here
-    # @return AccountModel response from the API call
-    def add_aws_cloud_account model
+    # Deactivates the account and all associated jobs.
+    # @param [String] id Required parameter: Account Identifier.
+    # @return void response from the API call
+    def delete id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Account/AWS"
+      query_builder << "/api/Account/{id}"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
+        "id" => id,
+      }
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
-        "accept" => "application/json",
-        "content-type" => "application/json; charset=utf-8"
+        "user-agent" => "batchly/0.5.3"
       }
 
       # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
+      CustomAuthUtility.append_custom_auth_params query_url, "DELETE", headers
 
       # invoke the API call request to fetch the response
-      response = Unirest.post query_url, headers:headers, parameters:model.to_json
+      response = Unirest.delete query_url, headers:headers
 
       # Error handling using HTTP status codes
-      if response.code == 400
-        raise APIException.new "BadRequest", 400, response.raw_body
+      if response.code == 404
+        raise APIException.new "NotFound", 404, response.raw_body
       elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK
         raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
       end
-
-      response.body
     end
 
-    # Deactivates the account and all associated jobs.
-    # @param [String] id Required parameter: TODO: type description here
-    # @return void response from the API call
-    def delete_account id
+    # Lists all active accounts associated with the batchly account
+    # @return Array<AccountModel> response from the API call
+    def list_accounts
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Account/{id}"
-
-      # process optional query parameters
-      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
-        "id" => id,
-      }
+      query_builder << "/api/Account"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1"
+        "user-agent" => "batchly/0.5.3",
+        "accept" => "application/json"
       }
 
       # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "DELETE", headers
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
 
       # invoke the API call request to fetch the response
-      response = Unirest.delete query_url, headers:headers
+      response = Unirest.get query_url, headers:headers
 
-      # Error handling using HTTP status codes
-      if response.code == 404
-        raise APIException.new "NotFound", 404, response.raw_body
-      elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
         raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
       end
+
+      response.body
     end
 
-    # Lists all active accounts associated with the batchly account
-    # @return Array<AccountModel> response from the API call
-    def list_accounts
+    # Add a new AWS account.  The credentials should have IAMFullAccess Permissions.  The keys are used to only create a new Batchly role in AWS IAM. The keys are not saved in batchly servers. Future calls are made using the newly created Batchly Role.
+    # @param [AddAWSAccountRequest] model Required parameter: Request model for adding AWS account
+    # @return AccountModel response from the API call
+    def add_aws_cloud_account model
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Account"
+      query_builder << "/api/account/AWS"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
-        "accept" => "application/json"
+        "user-agent" => "batchly/0.5.3",
+        "accept" => "application/json",
+        "content-type" => "application/json; charset=utf-8"
       }
 
       # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
+      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
 
       # invoke the API call request to fetch the response
-      response = Unirest.get query_url, headers:headers
+      response = Unirest.post query_url, headers:headers, parameters:model.to_json
 
-      #Error handling using HTTP status codes
-      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+      # Error handling using HTTP status codes
+      if response.code == 400
+        raise APIException.new "BadRequest", 400, response.raw_body
+      elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK
         raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
       end
 

data/lib/batchly_api/controllers/data_source_controller.rb

@@ -1,24 +1,24 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class DataSourceController
 
     # Registers a new s3 endpoint with batchly.  This endpoint can be used as either a source or destination for your job.
-    # @param [AddS3DataSourceRequest] model Required parameter: TODO: type description here
+    # @param [AddS3DataSourceRequest] model Required parameter: Add S3 DataSource request
     # @return String response from the API call
     def add_s_3 model
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/DataSource/S3"
+      query_builder << "/api/datasources/S3"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "content-type" => "application/json; charset=utf-8"
       }
 

data/lib/batchly_api/controllers/job_controller.rb

@@ -1,23 +1,23 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class JobController
 
-    # TODO: type endpoint description here
+    # Lists all active jobs in batchly
     # @return Array<JobModel> response from the API call
     def list_jobs
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Job"
+      query_builder << "/api/Job"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json"
       }
 
@@ -36,21 +36,21 @@ module BatchlyApi
     end
 
     # Adds a new job.  Job can be created after registering source and destination as data sources and uploading new processor.   Job brings your processors and data endpoints together.
-    # @param [CreateJobRequest] request Required parameter: TODO: type description here
+    # @param [CreateJobRequest] request Required parameter: Create Job Request
     # @return JobModel response from the API call
     def add_job request
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Job"
+      query_builder << "/api/Job"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json",
         "content-type" => "application/json; charset=utf-8"
       }
@@ -71,15 +71,15 @@ module BatchlyApi
       response.body
     end
 
-    # TODO: type endpoint description here
-    # @param [String] id Required parameter: TODO: type description here
+    # Describes the Job
+    # @param [String] id Required parameter: Job Identifier
     # @return JobModel response from the API call
     def describe_job id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Job/{id}"
+      query_builder << "/api/Job/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -91,7 +91,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json"
       }
 
@@ -112,14 +112,14 @@ module BatchlyApi
     end
 
     # Deletes the jobs and removes all schedules
-    # @param [String] id Required parameter: TODO: type description here
+    # @param [String] id Required parameter: Job Identifier
     # @return void response from the API call
     def delete_job id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Job/{id}"
+      query_builder << "/api/Job/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -131,7 +131,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1"
+        "user-agent" => "batchly/0.5.3"
       }
 
       # append custom auth authorization

data/lib/batchly_api/controllers/project_controller.rb

@@ -1,56 +1,24 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class ProjectController
 
-    # TODO: type endpoint description here
-    # @return Array<ProjectModel> response from the API call
-    def list_projects
-      # the base uri for api requests
-      query_builder = Configuration.BASE_URI.dup
-
-      # prepare query string for API call
-      query_builder << "/Project"
-
-      # validate and preprocess url
-      query_url = APIHelper.clean_url query_builder
-
-      # prepare headers
-      headers = {
-        "user-agent" => "batchly/0.5.1",
-        "accept" => "application/json"
-      }
-
-      # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
-
-      # invoke the API call request to fetch the response
-      response = Unirest.get query_url, headers:headers
-
-      #Error handling using HTTP status codes
-      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
-        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
-      end
-
-      response.body
-    end
-
-    # TODO: type endpoint description here
-    # @param [CreateProjectRequest] request Required parameter: TODO: type description here
+    # Add a new Project and associate with a cloud VPC
+    # @param [CreateProjectRequest] request Required parameter: Create Project Request
     # @return ProjectModel response from the API call
     def add_project request
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Project"
+      query_builder << "/api/Project"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json",
         "content-type" => "application/json; charset=utf-8"
       }
@@ -71,15 +39,15 @@ module BatchlyApi
       response.body
     end
 
-    # TODO: type endpoint description here
-    # @param [String] id Required parameter: TODO: type description here
+    # Describes the Project in detail
+    # @param [String] id Required parameter: Project Identifier
     # @return ProjectModel response from the API call
     def describe_project id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Project/{id}"
+      query_builder << "/api/Project/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -91,7 +59,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json"
       }
 
@@ -111,16 +79,16 @@ module BatchlyApi
       response.body
     end
 
-    # TODO: type endpoint description here
-    # @param [String] id Required parameter: TODO: type description here
-    # @param [UpdateProjectRequest] request Required parameter: TODO: type description here
+    # Update the project with new information
+    # @param [String] id Required parameter: Project Identifier
+    # @param [UpdateProjectRequest] request Required parameter: Update Project Request
     # @return ProjectModel response from the API call
     def update_project id, request
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Project/{id}"
+      query_builder << "/api/Project/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -132,7 +100,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json",
         "content-type" => "application/json; charset=utf-8"
       }
@@ -155,15 +123,15 @@ module BatchlyApi
       response.body
     end
 
-    # TODO: type endpoint description here
-    # @param [String] id Required parameter: TODO: type description here
+    # Deletes the project & deactivates all existing jobs in the project
+    # @param [String] id Required parameter: Project Identifier
     # @return void response from the API call
     def delete_project id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Project/{id}"
+      query_builder << "/api/Project/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -175,7 +143,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1"
+        "user-agent" => "batchly/0.5.3"
       }
 
       # append custom auth authorization
@@ -192,5 +160,37 @@ module BatchlyApi
       end
     end
 
+    # Lists all active projects in batchly
+    # @return Array<ProjectModel> response from the API call
+    def list_projects
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Project"
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/0.5.3",
+        "accept" => "application/json"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.get query_url, headers:headers
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
   end
 end

data/lib/batchly_api/controllers/run_controller.rb

@@ -1,56 +1,24 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class RunController
 
-    # TODO: type endpoint description here
-    # @return Array<RunModel> response from the API call
-    def list_runs
-      # the base uri for api requests
-      query_builder = Configuration.BASE_URI.dup
-
-      # prepare query string for API call
-      query_builder << "/Run"
-
-      # validate and preprocess url
-      query_url = APIHelper.clean_url query_builder
-
-      # prepare headers
-      headers = {
-        "user-agent" => "batchly/0.5.1",
-        "accept" => "application/json"
-      }
-
-      # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
-
-      # invoke the API call request to fetch the response
-      response = Unirest.get query_url, headers:headers
-
-      #Error handling using HTTP status codes
-      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
-        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
-      end
-
-      response.body
-    end
-
-    # TODO: type endpoint description here
-    # @param [ExecuteJobRequest] request Required parameter: TODO: type description here
+    # Executes the job and creates a new run for tracking
+    # @param [ExecuteJobRequest] request Required parameter: Execute Job Request
     # @return RunModel response from the API call
-    def add_run request
+    def start_run request
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Run"
+      query_builder << "/api/Run"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json",
         "content-type" => "application/json; charset=utf-8"
       }
@@ -73,15 +41,15 @@ module BatchlyApi
       response.body
     end
 
-    # TODO: type endpoint description here
-    # @param [String] id Required parameter: TODO: type description here
+    # Describes the run
+    # @param [String] id Required parameter: Run Identifier
     # @return RunModel response from the API call
     def describe_run id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Run/{id}"
+      query_builder << "/api/Run/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -93,7 +61,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1",
+        "user-agent" => "batchly/0.5.3",
         "accept" => "application/json"
       }
 
@@ -113,15 +81,15 @@ module BatchlyApi
       response.body
     end
 
-    # TODO: type endpoint description here
-    # @param [String] id Required parameter: TODO: type description here
-    # @return void response from the API call
+    # Stops the execution of job
+    # @param [String] id Required parameter: Run Identifier
+    # @return Boolean response from the API call
     def stop_run id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Run/{id}"
+      query_builder << "/api/Run/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -133,7 +101,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1"
+        "user-agent" => "batchly/0.5.3"
       }
 
       # append custom auth authorization
@@ -148,17 +116,19 @@ module BatchlyApi
       elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK
         raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
       end
+
+      response.body
     end
 
-    # TODO: type endpoint description here
-    # @param [String] id Required parameter: TODO: type description here
+    # Delete the run
+    # @param [String] id Required parameter: Run Identifier
     # @return void response from the API call
     def delete_run id
       # the base uri for api requests
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/Run/{id}"
+      query_builder << "/api/Run/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -170,7 +140,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.1"
+        "user-agent" => "batchly/0.5.3"
       }
 
       # append custom auth authorization
@@ -187,5 +157,37 @@ module BatchlyApi
       end
     end
 
+    # Lists all the active runs in batchly
+    # @return Array<RunModel> response from the API call
+    def list_runs
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Run"
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/0.5.3",
+        "accept" => "application/json"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "GET", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.get query_url, headers:headers
+
+      #Error handling using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+
+      response.body
+    end
+
   end
 end

data/lib/batchly_api/custom_auth_utility.rb

@@ -28,7 +28,14 @@ module BatchlyApi
       apiKey = Configuration.API_KEY.dup
       apiSecret = Configuration.API_SECRET.dup
 
-      req_url = parsed_url.scheme + '://' + parsed_url.host + parsed_url.path
+      req_url = parsed_url.to_s
+
+      if parsed_url.port == 80 || parsed_url.port == 443
+        req_url = parsed_url.scheme + '://' + parsed_url.host + parsed_url.path
+      else
+        req_url = parsed_url.scheme + '://' + parsed_url.host + ":" + parsed_url.port.to_s + parsed_url.path
+      end
+
       hmacHeaders = {
         HEADER_NONCE => Array.new( 5 ) { rand(256) }.pack('C*').unpack('H*').first,
         HEADER_TIMESTAMP => Time.now.to_i,

data/lib/batchly_api/models/add_aws_account_request.rb

@@ -1,21 +1,22 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class AddAwsAccountRequest
 
-    # TODO: Write general description for this method
+    # A name to identify the account
     # @return [String]
     attr_accessor :name
 
-    # TODO: Write general description for this method
+    # AWS Access key with "IAMFullAccess" permissions
     # @return [String]
     attr_accessor :access_key
 
-    # TODO: Write general description for this method
+    # AWS Secret key of the corresponding Access Key
     # @return [String]
     attr_accessor :secret_key
 
-    # TODO: Write general description for this method
+    # Default aws region for storing configuration and processors
+    #                 Value should equal aws region identifier. e.g. us-east-1, ap-southeast-2
     # @return [String]
     attr_accessor :base_region
 

data/lib/batchly_api/models/add_s_3_data_source_request.rb

@@ -1,13 +1,13 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class AddS3DataSourceRequest
 
-    # TODO: Write general description for this method
+    # Name of the S3 bucket
     # @return [String]
     attr_accessor :bucket
 
-    # TODO: Write general description for this method
+    # Folder within the S3 bucket
     # @return [String]
     attr_accessor :folder
 

data/lib/batchly_api/models/create_job_request.rb

@@ -1,41 +1,41 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class CreateJobRequest
 
-    # TODO: Write general description for this method
+    # Name of the job
     # @return [String]
     attr_accessor :name
 
-    # TODO: Write general description for this method
+    # Identifier of the Project under which the job should execute
     # @return [String]
     attr_accessor :project_id
 
-    # TODO: Write general description for this method
+    # Identifier of the Processor that processes the data
     # @return [String]
     attr_accessor :processor_id
 
-    # TODO: Write general description for this method
+    # Identifier of the DataSource from which data is extracted for processing
     # @return [String]
     attr_accessor :data_source_id
 
-    # TODO: Write general description for this method
+    # Identifier fo the DataSource into which processed data is sent
     # @return [String]
     attr_accessor :destination_id
 
-    # TODO: Write general description for this method
+    # Schedule information of Job if it should be managed by Scheduler
     # @return [JobSchedule]
     attr_accessor :schedule
 
-    # TODO: Write general description for this method
+    # Default Region in which the job should execute.  You can change region for each run when calling "Execute" endpoint.
     # @return [String]
     attr_accessor :region
 
-    # TODO: Write general description for this method
+    # Default SLA for the job execution. You can change SLA for each run when calling the "Execute" endpoint.
     # @return [Double]
     attr_accessor :sla
 
-    # TODO: Write general description for this method
+    # Parameter name and values that should be sent to the processor. The values can be changed for each run when calling the "Execute" endpoint.
     # @return [mixed]
     attr_accessor :parameters
 

data/lib/batchly_api/models/create_project_request.rb

@@ -1,17 +1,17 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class CreateProjectRequest
 
-    # TODO: Write general description for this method
+    # Identifier of the Account in which the project resides
     # @return [String]
     attr_accessor :account_id
 
-    # TODO: Write general description for this method
+    # Name of the project
     # @return [String]
     attr_accessor :name
 
-    # TODO: Write general description for this method
+    # VPC Information for projects which are restricted to use a given infrastructure zone
     # @return [VpcDetails]
     attr_accessor :vpc
 

data/lib/batchly_api/models/execute_job_request.rb

@@ -1,17 +1,17 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class ExecuteJobRequest
 
-    # TODO: Write general description for this method
+    # Job Identifier
     # @return [String]
     attr_accessor :job_id
 
-    # TODO: Write general description for this method
+    # SLA for the run
     # @return [Double]
     attr_accessor :sla
 
-    # TODO: Write general description for this method
+    # Region in which the job should execute
     # @return [String]
     attr_accessor :region
 

data/lib/batchly_api/models/job_schedule.rb

@@ -1,13 +1,15 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class JobSchedule
 
-    # TODO: Write general description for this method
+    # Time Schedule for the Job in CRON notation format.  
+    #                 http://www.nncron.ru/help/EN/working/cron-format.htm
     # @return [String]
     attr_accessor :cron
 
-    # TODO: Write general description for this method
+    # Timezone Identifier for the Scheduled Job. Identifier should be a valid value in the standard timezone list published by Microsoft.
+    #                 https://msdn.microsoft.com/en-us/library/gg154758.aspx
     # @return [String]
     attr_accessor :timezone
 

data/lib/batchly_api/models/update_project_request.rb

@@ -1,13 +1,13 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class UpdateProjectRequest
 
-    # TODO: Write general description for this method
+    # Name of the project
     # @return [String]
     attr_accessor :name
 
-    # TODO: Write general description for this method
+    # VPC Information for projects which are restricted to use a given infrastructure zone
     # @return [VpcDetails]
     attr_accessor :vpc
 

data/lib/batchly_api/models/vpc_details.rb

@@ -1,17 +1,18 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
 
 module BatchlyApi
   class VpcDetails
 
-    # TODO: Write general description for this method
+    # Identifier information of the VPC from cloud service
     # @return [String]
     attr_accessor :vpc_id
 
-    # TODO: Write general description for this method
+    # List of subnets within VPC which are assigned for batchly usage. 
+    #                 Minimum Subnets required for High Availability: 2
     # @return [Array<String>]
     attr_accessor :subnet_ids
 
-    # TODO: Write general description for this method
+    # Cloud Region in which the VPC is setup
     # @return [String]
     attr_accessor :region
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batchly_api
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.2
 platform: ruby
 authors:
 - batchly api support
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest