batchly_api 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7baaa65b46f69edcb1633296304b085b90f7c033
-  data.tar.gz: 5321d2b9ac9b2c236e1fa2af9096d97e37f5fc55
+  metadata.gz: aab2cec960422d708b58ecb4ac1b75224d945c06
+  data.tar.gz: 9392e58f33f28fc44f356f82b9891d826ef6e2f3
 SHA512:
-  metadata.gz: 5436ebb13e4fb5c026ea6b79154e4767dbf17cc708b05506ccbd910d071eb35647958312d80f549441448a53684818d737ab96ba0bc00c291305ebd00ceaf741
-  data.tar.gz: 17716513f3200fe7f8921d19cc98160ab821d6691f51601cce8af61d0296482bad7120cc7fd61f0f8883ba1df34c3ce14f1294a8f180134ce182a01d0b6c3e82
+  metadata.gz: b2c37529bcf0163a239a4da549d7217d752fc7c70f7144729392b93cc9bc34e9f4ce9a96179898877b4972f6fba048bc9b19a21f33631ac7f3177b9ec86b35ab
+  data.tar.gz: 65e33373da0d9b30bdd00934bd7239016b8da520416842df81bc3b4e1ed4e2b48d4f91838fa340ecb21501c5f0d3f556bde33b4628bd8d8799c38f366aea9349

data/README.md

@@ -0,0 +1,44 @@
+BatchlyApi
+=================
+This API SDK can be used to connect to the Batchly rest endpoint. To generate the access key and secret key for authentication,
+please use the batchly web console.
+
+How To Configure:
+=================
+The generated code might need to be configured with your API credentials. To do that,
+provide the credentials and configuration values as a constructor parameters for the controllers
+
+How To Build:
+=============
+The generated code uses a Ruby gem namely 'unirest'. The reference to this gem is
+already added in the gemspec. Therefore, you will need internet access to resolve
+this dependency.
+
+How To Use:
+===========
+The generated code can be used to build gem, which can then be distributed online.
+Otherwise, you can include the generated code in your project to use directly.
+
+Use the following steps to build a gem and use locally
+
+    1. Run the build command
+        ```
+        gem build batchly_api.gemspec
+        ```
+
+    2. Run the install command  
+        ```
+        gem install ./batchly_api-1.0.1.gem
+        ```
+
+    3. In your Gemfile add this line
+        ```
+        gem 'batchly_api', '~> 1.0.1'
+        ```
+
+    4. Now create an instance and use the instance methods, like following.
+
+        ```
+        ctl = BatchlyApi::AccountsController.new params
+        ctl.get_list_projects params
+        ```

data/lib/batchly_api.rb

@@ -1,4 +1,4 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 require 'openssl'
 require 'json'
 require 'unirest'
@@ -10,20 +10,30 @@ require 'batchly_api/configuration.rb'
 require 'batchly_api/custom_auth_utility.rb'
 
 # Controllers
-require 'batchly_api/controllers/account_controller.rb'
-require 'batchly_api/controllers/data_source_controller.rb'
-require 'batchly_api/controllers/job_controller.rb'
-require 'batchly_api/controllers/project_controller.rb'
-require 'batchly_api/controllers/run_controller.rb'
+require 'batchly_api/controllers/accounts_controller.rb'
+require 'batchly_api/controllers/data_sources_controller.rb'
+require 'batchly_api/controllers/jobs_controller.rb'
+require 'batchly_api/controllers/processors_controller.rb'
+require 'batchly_api/controllers/projects_controller.rb'
+require 'batchly_api/controllers/runs_controller.rb'
 
 # Models
+require 'batchly_api/models/add_aws_account_request.rb'
 require 'batchly_api/models/add_s_3_data_source_request.rb'
-require 'batchly_api/models/job_schedule.rb'
+require 'batchly_api/models/execute_job_request.rb'
+require 'batchly_api/models/create_job_request.rb'
+require 'batchly_api/models/request_type_enum.rb'
+require 'batchly_api/models/response_type_enum.rb'
+require 'batchly_api/models/add_processor_request.rb'
+require 'batchly_api/models/operating_system_enum.rb'
+require 'batchly_api/models/language_enum.rb'
+require 'batchly_api/models/custom_image.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'
+require 'batchly_api/models/add_parameter_group_request.rb'
+require 'batchly_api/models/key_value_pair_string_string.rb'
+require 'batchly_api/models/parameter.rb'
+require 'batchly_api/models/base_string_enum.rb'
 
-Unirest.timeout(60)
+Unirest.timeout(180)

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/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 
 module BatchlyApi
   class APIException < StandardError
@@ -14,16 +14,10 @@ module BatchlyApi
     # @param [Numeric] the HTTP response code from the API request
 	# @param [Object] the HTTP unprased response from the API request
     def initialize(reason, response_code, response_body)
-      super(reason)
-      @response_code = response_code
-      @response_body = response_body
-
-      if $DEBUG
-        puts reason
-        puts response_code
-        puts response_body
-      end
+        super(reason)
+        @response_code = response_code
+		@response_body = response_body
     end
 
   end
-end
+end

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/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 
 module BatchlyApi 
   class APIHelper

data/lib/batchly_api/configuration.rb

@@ -4,7 +4,7 @@ module BatchlyApi
   class Configuration
 
     # The base Uri for API calls
-    @BASE_URI = "http://api.corrs.batchly.net"
+    @BASE_URI = "http://corrs.batchly.net"
 
     # The access key for batchly
     @API_KEY = "UPDATE YOUR GENERATED API KEY HERE"

data/lib/batchly_api/controllers/{account_controller.rb → accounts_controller.rb}

@@ -1,9 +1,9 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 
 module BatchlyApi
-  class AccountController
+  class AccountsController
 
-    # Lists all active projects in the given account identifier.
+    # Returns a Lists of all the projects for the given account identifier.
     # @param [String] id Required parameter: Account ID
     # @return Array<ProjectModel> response from the API call
     def list_projects id
@@ -11,7 +11,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/account/{id}/Projects"
+      query_builder << "/api/Accounts/{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.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json"
       }
 
@@ -41,58 +41,58 @@ module BatchlyApi
       response.body
     end
 
-    # Deactivates the account and all associated jobs.
-    # @param [String] id Required parameter: Account Identifier.
-    # @return void response from the API call
-    def delete id
+    # Adds a new AWS account to batchly. AWS Accesskey and Secretkey should have 'IAMFullAccess' Permissions.
+    #                 Shared AWS keys are not stored in our servers. Keys are used to create a new role and then discarded.
+    # @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 << "/api/Account/{id}"
-
-      # process optional query parameters
-      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
-        "id" => id,
-      }
+      query_builder << "/api/Accounts/AWS"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3"
+        "user-agent" => "batchly/1.0.1",
+        "accept" => "application/json",
+        "content-type" => "application/json; charset=utf-8"
       }
 
       # append custom auth authorization
-      CustomAuthUtility.append_custom_auth_params query_url, "DELETE", headers
+      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
 
       # invoke the API call request to fetch the response
-      response = Unirest.delete query_url, headers:headers
+      response = Unirest.post query_url, headers:headers, parameters:model.to_json
 
       # Error handling using HTTP status codes
-      if response.code == 404
-        raise APIException.new "NotFound", 404, response.raw_body
+      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
+
+      response.body
     end
 
-    # Lists all active accounts associated with the batchly account
+    # Returns a Lists of all the active accounts in batchly.
     # @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 << "/api/Account"
+      query_builder << "/api/Accounts"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json"
       }
 
@@ -110,40 +110,41 @@ 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: Request model for adding AWS account
-    # @return AccountModel response from the API call
-    def add_aws_cloud_account model
+    # Deletes the specified account. All projects, jobs, processors associated with the account are made inactive.
+    # @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 << "/api/account/AWS"
+      query_builder << "/api/Accounts/{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.3",
-        "accept" => "application/json",
-        "content-type" => "application/json; charset=utf-8"
+        "user-agent" => "batchly/1.0.1"
       }
 
       # 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
 
   end

data/lib/batchly_api/controllers/{data_source_controller.rb → data_sources_controller.rb}

@@ -1,9 +1,9 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 
 module BatchlyApi
-  class DataSourceController
+  class DataSourcesController
 
-    # Registers a new s3 endpoint with batchly.  This endpoint can be used as either a source or destination for your job.
+    # Adds a new S3 datasource to batchly.
     # @param [AddS3DataSourceRequest] model Required parameter: Add S3 DataSource request
     # @return String response from the API call
     def add_s_3 model
@@ -11,14 +11,14 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/datasources/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.3",
+        "user-agent" => "batchly/1.0.1",
         "content-type" => "application/json; charset=utf-8"
       }
 

data/lib/batchly_api/controllers/{job_controller.rb → jobs_controller.rb}

@@ -1,23 +1,67 @@
-# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/26/2015
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 12/05/2015
 
 module BatchlyApi
-  class JobController
+  class JobsController
 
-    # Lists all active jobs in batchly
+    # Creates a run for the submitted job identifier.                  The run is started if the job is not scheduled.  Only one run for a job can be active.  Returns conflict response if a job is already executing.
+    # @param [String] id Required parameter: Job Id that needs to be executed
+    # @param [ExecuteJobRequest] request Optional parameter: Request parameters can be null if default parameters can be used for execution. If present, Request values will be considered instead of defaults
+    # @return RunModel response from the API call
+    def execute_job id, request: nil
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/api/Jobs/{id}/Execute"
+
+      # 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/1.0.1",
+        "accept" => "application/json",
+        "content-type" => "application/json; charset=utf-8"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "POST", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.post query_url, headers:headers, parameters:request.to_json
+
+      # Error handling using HTTP status codes
+      if response.code == 400
+        raise APIException.new "BadRequest", 400, response.raw_body
+      elsif response.code == 409
+        raise APIException.new "Conflict", 409, 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
+
+    # Returns a List of 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 << "/api/Job"
+      query_builder << "/api/Jobs"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json"
       }
 
@@ -35,7 +79,11 @@ module BatchlyApi
       response.body
     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.
+    # Adds a new job to batchly.  The following steps are involved when creating a new job
+    #                 -&gt; Get a list of projects. If needed, create a new project.
+    #                 -&gt; Add datasources for source and destination
+    #                 -&gt; Get a list of processors. If needed, create a new processor
+    #                 -&gt; Create a job with source, destination, project and processor identifier
     # @param [CreateJobRequest] request Required parameter: Create Job Request
     # @return JobModel response from the API call
     def add_job request
@@ -43,14 +91,14 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Job"
+      query_builder << "/api/Jobs"
 
       # validate and preprocess url
       query_url = APIHelper.clean_url query_builder
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json",
         "content-type" => "application/json; charset=utf-8"
       }
@@ -71,7 +119,7 @@ module BatchlyApi
       response.body
     end
 
-    # Describes the Job
+    # Describes in detail the job
     # @param [String] id Required parameter: Job Identifier
     # @return JobModel response from the API call
     def describe_job id
@@ -79,7 +127,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Job/{id}"
+      query_builder << "/api/Jobs/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -91,7 +139,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3",
+        "user-agent" => "batchly/1.0.1",
         "accept" => "application/json"
       }
 
@@ -111,7 +159,7 @@ module BatchlyApi
       response.body
     end
 
-    # Deletes the jobs and removes all schedules
+    # Deletes the job and deactivates any scheduler associated with the job.
     # @param [String] id Required parameter: Job Identifier
     # @return void response from the API call
     def delete_job id
@@ -119,7 +167,7 @@ module BatchlyApi
       query_builder = Configuration.BASE_URI.dup
 
       # prepare query string for API call
-      query_builder << "/api/Job/{id}"
+      query_builder << "/api/Jobs/{id}"
 
       # process optional query parameters
       query_builder = APIHelper.append_url_with_template_parameters query_builder, {
@@ -131,7 +179,7 @@ module BatchlyApi
 
       # prepare headers
       headers = {
-        "user-agent" => "batchly/0.5.3"
+        "user-agent" => "batchly/1.0.1"
       }
 
       # append custom auth authorization