test-pack-1 1.0.0

data/lib/test_pack_1/controllers/statuses_controller.rb

@@ -0,0 +1,215 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # StatusesController
+  class StatusesController < BaseController
+    @instance = StatusesController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # Gets active statuses for multiple devices. This request can also be made
+    # using the POST method, with a JSON request body instead of query
+    # parameters.
+    # @param [List of Integer] device_ids Required parameter: Which devices to
+    # get statuses for.
+    # @param [List of StatusCategoryEnum] category Optional parameter: Which
+    # status categories to get statuses for.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `StatusItem`
+    # schema. By default all fields are included.
+    # @param [List of String] sort_by Optional parameter: Which fields to sort
+    # the response items by. By default the items are sorted by
+    # timestampStart.
+    # @param [Boolean] sort_asc Optional parameter: Whether to sort the items in
+    # ascending order.
+    # @param [Integer] page_size Optional parameter: The number of items to
+    # return per page.
+    # @param [Integer] page Optional parameter: Which page to return when the
+    # number of items exceed the page size.
+    # @return List of StatusItem response from the API call
+    def get_active_statuses(device_ids,
+                            category = nil,
+                            fields = nil,
+                            sort_by = nil,
+                            sort_asc = false,
+                            page_size = 50,
+                            page = 1)
+      # Prepare query url.
+      _path_url = '/activestatus.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'category' => category,
+          'fields' => fields,
+          'sortBy' => sort_by,
+          'sortAsc' => sort_asc,
+          'pageSize' => page_size,
+          'page' => page
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      CustomQueryAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'The request cannot be fulfilled due to bad syntax.',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'One of the following: * The request is missing a valid API key. *' \
+          ' The API key does not authorize access the requested' \
+          ' data. Devices   or data signals can be limited. ',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'The HTTP method is not allowed for the endpoint.',
+          _context
+        )
+      elsif _context.response.status_code == 429
+        raise APIException.new(
+          'The API key has been used in too many requests in a given amount' \
+          ' of time. The following headers will be set in the' \
+          ' response: * X-Rate-Limit-Limit - The total number of' \
+          ' allowed requests for this period. *' \
+          ' X-Rate-Limit-Remaining - The remaining number of' \
+          ' requests for this period. * X-Rate-Limit-Reset - The' \
+          ' number of seconds left until the end of this period. ',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      decoded.map { |element| StatusItem.from_hash(element) }
+    end
+
+    # Gets statuses for multiple devices during the given time period. This
+    # request can also be made using the POST method, with a JSON request body
+    # instead of query parameters.
+    # @param [List of Integer] device_ids Required parameter: Which devices to
+    # get statuses for.
+    # @param [DateTime] timestamp_start Required parameter: The first timestamp
+    # to get data for. Timestamps ending with 'Z' are treated as UTC. Other
+    # timestamps are treated as local time in your system-configured time
+    # zone.
+    # @param [DateTime] timestamp_end Required parameter: The last timestamp to
+    # get data for. Timestamps ending with 'Z' are treated as UTC. Other
+    # timestamps are treated as local time in your system-configured time
+    # zone.
+    # @param [List of StatusCategoryEnum] category Optional parameter: Which
+    # status categories to get statuses for.
+    # @param [List of String] fields Optional parameter: Which fields to include
+    # in the response. Valid fields are those defined in the `StatusItem`
+    # schema. By default all fields are included.
+    # @param [List of String] sort_by Optional parameter: Which fields to sort
+    # the response items by. By default the items are sorted by
+    # timestampStart.
+    # @param [Boolean] sort_asc Optional parameter: Whether to sort the items in
+    # ascending order.
+    # @param [Integer] page_size Optional parameter: The number of items to
+    # return per page.
+    # @param [Integer] page Optional parameter: Which page to return when the
+    # number of items exceed the page size.
+    # @return List of StatusItem response from the API call
+    def get_statuses(device_ids,
+                     timestamp_start,
+                     timestamp_end,
+                     category = nil,
+                     fields = nil,
+                     sort_by = nil,
+                     sort_asc = false,
+                     page_size = 50,
+                     page = 1)
+      # Prepare query url.
+      _path_url = '/status.json'
+      _query_builder = Configuration.get_base_uri
+      _query_builder << _path_url
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        {
+          'deviceIds' => device_ids,
+          'timestampStart' => timestamp_start,
+          'timestampEnd' => timestamp_end,
+          'category' => category,
+          'fields' => fields,
+          'sortBy' => sort_by,
+          'sortAsc' => sort_asc,
+          'pageSize' => page_size,
+          'page' => page
+        },
+        array_serialization: Configuration.array_serialization
+      )
+      _query_url = APIHelper.clean_url _query_builder
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      CustomQueryAuth.apply(_request)
+      _context = execute_request(_request)
+      # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise APIException.new(
+          'The request cannot be fulfilled due to bad syntax.',
+          _context
+        )
+      elsif _context.response.status_code == 401
+        raise APIException.new(
+          'One of the following: * The request is missing a valid API key. *' \
+          ' The API key does not authorize access the requested' \
+          ' data. Devices   or data signals can be limited. ',
+          _context
+        )
+      elsif _context.response.status_code == 405
+        raise APIException.new(
+          'The HTTP method is not allowed for the endpoint.',
+          _context
+        )
+      elsif _context.response.status_code == 429
+        raise APIException.new(
+          'The API key has been used in too many requests in a given amount' \
+          ' of time. The following headers will be set in the' \
+          ' response: * X-Rate-Limit-Limit - The total number of' \
+          ' allowed requests for this period. *' \
+          ' X-Rate-Limit-Remaining - The remaining number of' \
+          ' requests for this period. * X-Rate-Limit-Reset - The' \
+          ' number of seconds left until the end of this period. ',
+          _context
+        )
+      end
+      validate_response(_context)
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      decoded.map { |element| StatusItem.from_hash(element) }
+    end
+  end
+end

data/lib/test_pack_1/exceptions/api_exception.rb

@@ -0,0 +1,20 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < StandardError
+    attr_reader :context, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason)
+      @context = context
+      @response_code = context.response.status_code
+    end
+  end
+end

data/lib/test_pack_1/http/auth/custom_query_auth.rb

@@ -0,0 +1,16 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # Utility class for custom query_parameter authorization.
+  class CustomQueryAuth
+    # Add custom authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(http_request)
+      http_request.add_query_parameter('apiToken', Configuration.api_token)
+    end
+  end
+end

data/lib/test_pack_1/http/faraday_client.rb

@@ -0,0 +1,64 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+require 'faraday/http_cache'
+require 'faraday_middleware'
+
+module TestPack1
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The constructor.
+    def initialize(timeout: nil, cache: false,
+                   max_retries: nil, retry_interval: nil)
+      @connection = Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.request :retry, max: max_retries, interval: if max_retries &&
+                                                               retry_interval
+                                                              retry_interval
+                                                            end
+        faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:open_timeout] = timeout if timeout
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        unless http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        unless http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response)
+      HttpResponse.new(response.status, response.headers, response.body)
+    end
+  end
+end

data/lib/test_pack_1/http/http_call_back.rb

@@ -0,0 +1,24 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient
+    # will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpContext] The HttpContext of the API call.
+    def on_after_response(_http_context)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+  end
+end

data/lib/test_pack_1/http/http_client.rb

@@ -0,0 +1,104 @@
+# test_pack_1
+#
+# This file was automatically generated by APIMATIC v2.0 (
+# https://apimatic.io ).
+
+module TestPack1
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def get(query_url,
+            headers: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
+    end
+
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def post(query_url,
+             headers: {},
+             parameters: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def put(query_url,
+            headers: {},
+            parameters: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def patch(query_url,
+              headers: {},
+              parameters: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+  end
+end