batchly_api 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d08dfe84b746f0abd7eb08f51cb0291e3a8ce4c8
+  data.tar.gz: fa67cd56b55a42895a6c8de0cac601f505ec73e0
+SHA512:
+  metadata.gz: 5df14041efbe3416f277f01a56e740f513ef0625c06f78db2c7c7036922676b0f47fa18fec80047f1734a7edf1fb52b903ebfaafa2e81e0fcbc70a071ec6eeb3
+  data.tar.gz: 303a3eea99259aa0f7eb9b1921c89bb939fadfe31ff2bbdb90984fa03251f42b3ec0e6bf95cb0e59142ae700e2b515ca0d179e7b2e176c2062183725a20464b7

data/lib/batchly_api.rb

@@ -0,0 +1,30 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+require 'openssl'
+require 'json'
+require 'unirest'
+require 'uri'
+require 'cgi'
+require 'base64'
+
+# APIMATIC Helper Files
+require 'batchly_api/api_helper.rb'
+require 'batchly_api/api_exception.rb'
+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'
+
+# 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'

data/lib/batchly_api/api_exception.rb

@@ -0,0 +1,23 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+
+module BatchlyApi
+  class APIException < StandardError
+
+    # value store
+    attr_reader :response_code
+
+	# value store
+    attr_reader :response_body
+
+    # The HTTP response code from the API request
+    # @param [String] the reason for raising an exception
+    # @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
+    end
+
+  end
+end

data/lib/batchly_api/api_helper.rb

@@ -0,0 +1,82 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+
+module BatchlyApi 
+  class APIHelper
+    
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to replace in the url    
+    def self.append_url_with_template_parameters(query_builder, parameters)    
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.is_a? String
+
+      # return if there are no parameters to replace
+      if parameters.nil? then
+        abort('no parameters to append')
+      end
+
+      # iterate and append parameters
+      parameters.map do |key, value|
+        replace_value = ''
+
+        if value.nil? 
+            replace_value = ''
+        elsif value.is_a? Enumerable
+            replace_value = value.join("/")
+        else
+            replace_value = value.to_s
+        end
+
+        # find the template parameter and replace it with its value
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+
+      query_builder
+    end
+    
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to append
+    def self.append_url_with_query_parameters(query_builder, parameters)    
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.is_a? String
+
+      # return if there are no parameters to replace
+      if parameters.nil? then
+        abort('no parameters to append')
+      end
+
+      #remove any nil values
+      parameters = parameters.reject {|key, value| value.nil?}
+
+      # does the query string already has parameters
+      has_params = query_builder.include? '?'
+      separator = if has_params then '&' else '?' end
+
+      # append query with separator and parameters
+      query_builder << separator << URI.unescape(URI.encode_www_form(parameters))
+    end
+    
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.is_a? String
+
+      # ensure that the urls are absolute
+      matches = url.match(/^(https?:\/\/[^\/]+)/)
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+        
+      # get the http protocol match
+      protocol = matches[1]
+
+      # remove redundant forward slashes
+      query = url[protocol.length..-1].gsub(/\/\/+/, '/')
+
+      # return process url
+      return protocol + query;
+    end
+
+  end
+end

data/lib/batchly_api/configuration.rb

@@ -0,0 +1,21 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+
+module BatchlyApi
+  class Configuration
+
+    # The base Uri for API calls
+    @BASE_URI = "http://api.corrs.batchly.net"
+
+    # 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
+
+    end
+  end
+end

data/lib/batchly_api/controllers/account_controller.rb

@@ -0,0 +1,150 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+
+module BatchlyApi
+  class AccountController
+
+    # Lists all active projects in the given account identifier.
+    # @param [String] id Required parameter: TODO: type description here
+    # @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"
+
+      # 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"
+      }
+
+      # 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
+
+    # 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
+      # the base uri for api requests
+      query_builder = Configuration.BASE_URI.dup
+
+      # prepare query string for API call
+      query_builder << "/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",
+        "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:model.to_json
+
+      # 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
+
+      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
+      # 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,
+      }
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/0.5.1"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "DELETE", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.delete 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
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+    end
+
+    # 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"
+
+      # 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
+
+  end
+end

data/lib/batchly_api/controllers/data_source_controller.rb

@@ -0,0 +1,42 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/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
+    # @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"
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        "user-agent" => "batchly/0.5.1",
+        "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:model.to_json
+
+      # 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
+
+      response.body
+    end
+
+  end
+end

data/lib/batchly_api/controllers/job_controller.rb

@@ -0,0 +1,152 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+
+module BatchlyApi
+  class JobController
+
+    # TODO: type endpoint description here
+    # @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"
+
+      # 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
+
+    # 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
+    # @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"
+
+      # 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"
+      }
+
+      # 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.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
+    # @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}"
+
+      # 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"
+      }
+
+      # 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 == 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
+
+    # Deletes the jobs and removes all schedules
+    # @param [String] id Required parameter: TODO: type description here
+    # @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}"
+
+      # 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"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "DELETE", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.delete 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
+        raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
+      end
+    end
+
+  end
+end