batchly_api 0.5.1

data/lib/batchly_api/controllers/project_controller.rb

@@ -0,0 +1,196 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/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
+    # @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"
+
+      # 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 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}"
+
+      # 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
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: TODO: type description here
+    # @param [UpdateProjectRequest] request Required parameter: TODO: type description here
+    # @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}"
+
+      # 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"
+      }
+
+      # append custom auth authorization
+      CustomAuthUtility.append_custom_auth_params query_url, "PUT", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.put 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 == 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
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: TODO: type description here
+    # @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}"
+
+      # 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

data/lib/batchly_api/controllers/run_controller.rb

@@ -0,0 +1,191 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/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
+    # @return RunModel response from the API call
+    def add_run request
+      # 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",
+        "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
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: TODO: type description here
+    # @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}"
+
+      # 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
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: TODO: type description here
+    # @return void 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}"
+
+      # 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, "PUT", headers
+
+      # invoke the API call request to fetch the response
+      response = Unirest.put 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
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: TODO: type description here
+    # @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}"
+
+      # 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

data/lib/batchly_api/custom_auth_utility.rb

@@ -0,0 +1,62 @@
+# This file was automatically generated for support.batchly.net by APIMATIC BETA v2.0 on 11/18/2015
+
+module BatchlyApi
+  class CustomAuthUtility
+
+    HEADER_AUTHORIZATION = "Authorization"
+    HMAC_TEMPLATE = "Hmac %s"
+    HEADER_NONCE = "Nonce"
+    HEADER_TIMESTAMP = "Timestamp"
+    HEADER_API_KEY = "Api-Key"
+
+    def self.percent_encode( string )
+      URI.escape( string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]") ).gsub('*', '%2A')
+    end
+
+    def self.query_string(params)
+      pairs = []
+      params.sort.each { | key, val |
+        pairs.push( "#{ percent_encode( key ) }=#{ percent_encode( val.to_s ) }" )
+      }
+      pairs.join '&'
+    end
+
+    # Appends the necessary OAuth credentials for making this authorized call
+    # @param [Hash] The out going request to access the resource
+    def self.append_custom_auth_params(parsed_url, method, headers)
+      apiKey = Configuration.API_KEY.dup
+      apiSecret = Configuration.API_SECRET.dup
+
+      req_url = parsed_url.scheme + '://' + parsed_url.host + parsed_url.path
+      hmacHeaders = {
+        HEADER_NONCE => Array.new( 5 ) { rand(256) }.pack('C*').unpack('H*').first,
+        HEADER_TIMESTAMP => Time.now.to_i,
+        HEADER_API_KEY =>apiKey
+      }
+
+      params = hmacHeaders
+      method = method.upcase
+
+      if parsed_url.query
+        params.merge! CGI.parse( parsed_url.query )
+      end
+
+      base_str = [
+        method.upcase,
+        percent_encode( req_url ),
+        percent_encode(query_string(params))
+      ].join( "&" )
+
+      key =  percent_encode( apiSecret )
+
+      digest = OpenSSL::Digest::Digest.new( 'sha1' )
+      hmac = OpenSSL::HMAC.digest( digest, key, base_str )
+
+      headers["Authorization"] = HMAC_TEMPLATE % [ percent_encode( Base64.encode64( hmac ).chomp.gsub( /\n/, '' ) ) ]
+      headers[HEADER_NONCE] = hmacHeaders[HEADER_NONCE]
+      headers[HEADER_TIMESTAMP] = hmacHeaders[HEADER_TIMESTAMP]
+      headers[HEADER_API_KEY] = hmacHeaders[HEADER_API_KEY]
+    end
+
+  end
+end