marble_api_client 1.0.0.pre.alpha

data/lib/marble_api_client/requests/index.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Requests
+    # Index Request Object
+    class Index
+      def initialize(context: {}, record: {}, page: 1, page_size: 25)
+        @context = context
+        @record = record
+        @page = page
+        @page_size = page_size
+      end
+
+      def request_body
+        {
+          context: @context,
+          record: @record,
+          page: @page,
+          page_size: @page_size
+        }.to_json
+      end
+    end
+  end
+end

data/lib/marble_api_client/requests.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'requests/create'
+require_relative 'requests/index'

data/lib/marble_api_client/responses/bad_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 400 Response Class
+    class BadRequest < ClientError
+      ERRORS = 'errors'
+
+      def initialize(response)
+        super
+      end
+
+      def errors
+        parsed_body.dig(ERRORS)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/client_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 400 Range Response Base Class
+    class ClientError
+      include HttpMethods
+
+      def initialize(response)
+        @response = response
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/forbidden.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 403 Response Class
+    class Forbidden < ClientError
+      STATUS_CODE = 'statusCode'
+      REDIRECT_URL = 'redirectUrl'
+      def initialize(response)
+        super
+      end
+
+      def status_code
+        parsed_body.dig(STATUS_CODE)
+      end
+
+      def redirect_url
+        parsed_body.dig(REDIRECT_URL)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/http_methods.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # Module assumes existance of @response Net::HTTPResponse object
+    module HttpMethods
+      def code
+        @response.code
+      end
+
+      def body
+        @response.body
+      end
+
+      private
+
+      def parsed_body
+        @parsed_body ||= JSON.parse(body)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/list.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 200 Response Index Class
+    class List < Success
+      PAGE = 'page'
+      PAGE_SIZE = 'pageSize'
+      META = 'meta'
+      RECORDS = 'records'
+      SORT_DIRECTION = 'sortDirection'
+      SORT_COLUMN_INDEX = 'sortColumnIndex'
+      TOTAL = 'total'
+      TOTAL_PAGES = 'totalPages'
+
+      def initialize(response)
+        super
+      end
+
+      def page
+        parsed_body.dig(PAGE)
+      end
+
+      def page_size
+        parsed_body.dig(PAGE_SIZE)
+      end
+
+      def meta
+        parsed_body.dig(META)
+      end
+
+      def records
+        parsed_body.dig(RECORDS)
+      end
+
+      def sort_direction
+        parsed_body.dig(SORT_DIRECTION)
+      end
+
+      def sort_column_index
+        parsed_body.dig(SORT_COLUMN_INDEX)
+      end
+
+      def total
+        parsed_body.dig(TOTAL)
+      end
+
+      def total_pages
+        parsed_body.dig(TOTAL_PAGES)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/not_found.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 404 Response Class
+    class NotFound < ClientError
+      ERRORS = 'errors'
+
+      def initialize(response)
+        super
+      end
+
+      def errors
+        parsed_body.dig(ERRORS)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/not_implemented.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+module MarbleApiClient
+  module Responses
+    # 501 Response Class
+    class NotImplemented < ServerError
+      ERRORS = 'errors'
+
+      def initialize(response)
+        super
+      end
+
+      def errors
+        parsed_body.dig(ERRORS)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/record.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 200 Response Create Class
+    class Record < Success
+      RECORD = 'record'
+
+      def initialize(response)
+        super
+      end
+
+      def record
+        parsed_body.dig(RECORD)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/server_error.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 500 Response Base Class
+    class ServerError
+      include HttpMethods
+
+      ERRORS = 'errors'
+
+      def initialize(response)
+        @response = response
+      end
+
+      def errors
+        parsed_body.dig(ERRORS)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/success.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 200 Response Base Class
+    class Success
+      include HttpMethods
+
+      def initialize(response)
+        @response = response
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/unauthorized.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 401 Response Class
+    class Unauthorized < ClientError
+      def initialize(response)
+        super
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses/unprocessable_entity.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module MarbleApiClient
+  module Responses
+    # 422 Response Object
+    class UnprocessableEntity < ClientError
+      ERRORS = 'errors'
+      ERROR_PROPERTIES = 'errorProperties'
+      WARNINGS = 'warnings'
+      WARNING_PROPERTIES = 'warningProperties'
+
+      def initialize(response)
+        super
+      end
+
+      def errors
+        parsed_body.dig(ERRORS)
+      end
+
+      def error_properties
+        parsed_body.dig(ERROR_PROPERTIES)
+      end
+
+      def warnings
+        parsed_body.dig(WARNINGS)
+      end
+
+      def warning_properties
+        parsed_body.dig(WARNING_PROPERTIES)
+      end
+    end
+  end
+end

data/lib/marble_api_client/responses.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative 'responses/http_methods'
+
+require_relative 'responses/success'
+require_relative 'responses/client_error'
+require_relative 'responses/server_error'
+
+require_relative 'responses/bad_request'
+require_relative 'responses/forbidden'
+require_relative 'responses/list'
+require_relative 'responses/not_found'
+require_relative 'responses/not_implemented'
+require_relative 'responses/record'
+require_relative 'responses/unauthorized'
+require_relative 'responses/unprocessable_entity'
+
+module MarbleApiClient
+  # Module for all response objects
+  module Responses
+    INDEX_ACTION = 'index'
+    CREATE_ACTION = 'create'
+
+    SUCCESS_RESPONSE_CODE = '200'
+    BAD_REQUEST_RESPONSE_CODE = '400'
+    UNAUTHORIZED_RESPONSE_CODE = '401'
+    FORBIDDEN_RESPONSE_CODE = '403'
+    NOT_FOUND_RESPONSE_CODE = '404'
+    UNPROCESSABLE_ENTITY_RESPONSE_CODE = '422'
+    SERVER_ERROR_RESPONSE_CODE = '500'
+    NOT_IMPLEMENTED_RESPONSE_CODE = '501'
+
+    RESPONSES = [
+      {
+        code: SUCCESS_RESPONSE_CODE,
+        action: INDEX_ACTION,
+        class_constant: List
+      },
+      {
+        code: SUCCESS_RESPONSE_CODE,
+        action: CREATE_ACTION,
+        class_constant: Record
+      },
+      {
+        code: BAD_REQUEST_RESPONSE_CODE,
+        class_constant: BadRequest
+      },
+      {
+        code: UNAUTHORIZED_RESPONSE_CODE,
+        class_constant: Unauthorized
+      },
+      {
+        code: FORBIDDEN_RESPONSE_CODE,
+        class_constant: Forbidden
+      },
+      {
+        code: NOT_FOUND_RESPONSE_CODE,
+        class_constant: NotFound
+      },
+      {
+        code: UNPROCESSABLE_ENTITY_RESPONSE_CODE,
+        class_constant: UnprocessableEntity
+      },
+      {
+        code: SERVER_ERROR_RESPONSE_CODE,
+        class_constant: ServerError
+      },
+      {
+        code: NOT_IMPLEMENTED_RESPONSE_CODE,
+        class_constant: NotImplemented
+      }
+    ].freeze
+
+    class << self
+      def get_response_object(response, action)
+        raise ArgumentError, 'HTTPResponse required' unless response.is_a?(Net::HTTPResponse)
+
+        response_object = find_object(response, action)
+
+        raise ArgumentError, "Unexpecred HTTResponse: #{response.code}" unless response_object
+
+        response_object[:class_constant].new(response)
+      end
+
+      def find_object(response, action)
+        RESPONSES.find do |r|
+          r[:code] == response.code && (r[:action] ? r[:action] == action : true)
+        end
+      end
+    end
+  end
+end