md-notes-resource 1.0

data/lib/md_notes/controllers/base_controller.rb

@@ -0,0 +1,49 @@
+# md_notes
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MdNotes
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'APIMATIC 2.0'
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      APIHelper.clean_hash(request.headers)
+      request.headers.merge!(@global_headers)
+
+      response = if binary
+                   config.http_client.execute_as_binary(request)
+                 else
+                   config.http_client.execute_as_string(request)
+                 end
+      @http_call_back.on_after_response(response) if @http_call_back
+
+      response
+    end
+
+    def validate_response(response)
+      raise APIException.new 'HTTP Response Not OK', response unless
+        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+  end
+end

data/lib/md_notes/controllers/o_auth_authorization_controller.rb

@@ -0,0 +1,140 @@
+# md_notes
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MdNotes
+  # OAuthAuthorizationController
+  class OAuthAuthorizationController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] username Required parameter: Resource owner username
+    # @param [String] password Required parameter: Resource owner password
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [OAuthToken] response from the API call
+    def request_token(authorization,
+                      username,
+                      password,
+                      scope: nil,
+                      _field_parameters: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/oauth/token'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => authorization
+      }
+
+      # Prepare form parameters.
+      _parameters = {
+        'grant_type' => 'password',
+        'username' => username,
+        'password' => password,
+        'scope' => scope
+      }
+      if !_parameters.nil? && !_field_parameters.nil?
+        _parameters.merge!(_field_parameters)
+      end
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: _parameters
+      )
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise OAuthProviderException.new(
+          'OAuth 2 provider returned an error.',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise OAuthProviderException.new(
+          'OAuth 2 provider says client authentication failed.',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      OAuthToken.from_hash(decoded)
+    end
+
+    # Obtain a new access token using a refresh token
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] refresh_token Required parameter: Refresh token
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [OAuthToken] response from the API call
+    def refresh_token(authorization,
+                      refresh_token,
+                      scope: nil,
+                      _field_parameters: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/oauth/token'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Authorization' => authorization
+      }
+
+      # Prepare form parameters.
+      _parameters = {
+        'grant_type' => 'refresh_token',
+        'refresh_token' => refresh_token,
+        'scope' => scope
+      }
+      if !_parameters.nil? && !_field_parameters.nil?
+        _parameters.merge!(_field_parameters)
+      end
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: _parameters
+      )
+      _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise OAuthProviderException.new(
+          'OAuth 2 provider returned an error.',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise OAuthProviderException.new(
+          'OAuth 2 provider says client authentication failed.',
+          _response
+        )
+      end
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      OAuthToken.from_hash(decoded)
+    end
+  end
+end

data/lib/md_notes/controllers/service_controller.rb

@@ -0,0 +1,40 @@
+# md_notes
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MdNotes
+  # ServiceController
+  class ServiceController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # TODO: type endpoint description here
+    # @return [ServiceStatus] response from the API call
+    def get_status
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/api/status'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      ServiceStatus.from_hash(decoded)
+    end
+  end
+end

data/lib/md_notes/controllers/user_controller.rb

@@ -0,0 +1,40 @@
+# md_notes
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MdNotes
+  # UserController
+  class UserController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # TODO: type endpoint description here
+    # @return [User] response from the API call
+    def get_user
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/api/user'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      User.from_hash(decoded)
+    end
+  end
+end

data/lib/md_notes/exceptions/api_exception.rb

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

data/lib/md_notes/exceptions/o_auth_provider_exception.rb

@@ -0,0 +1,44 @@
+# md_notes
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MdNotes
+  # OAuth 2 Authorization endpoint exception.
+  class OAuthProviderException < APIException
+    # Gets or sets error code.
+    # @return [OAuthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error = hash['error']
+      @error_description = hash['error_description']
+      @error_uri = hash['error_uri']
+    end
+  end
+end

data/lib/md_notes/http/auth/o_auth2.rb

@@ -0,0 +1,78 @@
+# md_notes
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module MdNotes
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2
+    def self.auth_controller(config)
+      OAuthAuthorizationController.new config
+    end
+
+    # Add OAuth2 authentication to the http request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      check_auth config.o_auth_token
+      token = config.o_auth_token.access_token
+      http_request.headers['Authorization'] = "Bearer #{token}"
+    end
+
+    # Get an OAuth token that you must then set in your Configuration object
+    # to authorize subsequent calls.
+    # @param [String | Array of String] Any scopes for the authentication token.
+    # @param [Hash] Any additional form parameters.
+    def self.authorize(config, scope: nil, additional_params: nil)
+      token = auth_controller(config).request_token(
+        build_basic_auth_header(config),
+        config.o_auth_username,
+        config.o_auth_password,
+        scope: scope ? Array(scope).compact.join(' ') : nil,
+        _field_parameters: additional_params
+      )
+      token.expiry = (Time.now.to_i + token.expires_in.to_i) if token.expires_in
+      token
+    end
+
+    # Builds the basic auth header for endpoints in the
+    # OAuth Authorization Controller.
+    def self.build_basic_auth_header(config)
+      value = "#{config.o_auth_client_id}:" \
+              "#{config.o_auth_client_secret}"
+      encoded = Base64.strict_encode64(value)
+      "Basic #{encoded}"
+    end
+
+    # Checks if OAuth token is valid.
+    def self.check_auth(token)
+      # Check if OAuth token exists.
+      if token.nil?
+        raise 'Client is not authorized. An OAuth token is needed to ' \
+              'make API calls.'
+      # Check if OAuth token has expired.
+      elsif token.expiry && token.expiry < Time.now.to_i
+        raise 'The OAuth token has expired. Please refresh the existing token' \
+              ' or generate a new one.'
+      end
+    end
+
+    # Refreshes OAuth token and returns it. You must then set it in your
+    # Configuration object.
+    # @param [String | Array of String] Any scopes for the new authentication
+    # token.
+    # @param [Hash] Any additional form parameters.
+    def self.refresh_token(config, scope: nil, additional_params: nil)
+      token = auth_controller(config).refresh_token(
+        build_basic_auth_header(config),
+        config.o_auth_token.refresh_token,
+        scope: scope ? Array(scope).compact.join(' ') : nil,
+        _field_parameters: additional_params
+      )
+      token.expiry = (Time.now.to_i + token.expires_in.to_i) if token.expires_in
+      token
+    end
+  end
+end

data/lib/md_notes/http/faraday_client.rb

@@ -0,0 +1,70 @@
+# md_notes
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'faraday/http_cache'
+require 'faraday_middleware'
+
+module MdNotes
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The constructor.
+    def initialize(timeout:, max_retries:, retry_interval:,
+                   backoff_factor:, retry_statuses:, retry_methods:,
+                   cache: false, verify: true)
+      @connection = Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.use :gzip
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.ssl[:verify] = verify
+        faraday.request :retry, max: max_retries, interval: retry_interval,
+                                backoff_factor: backoff_factor,
+                                retry_statuses: retry_statuses,
+                                methods: retry_methods
+        faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:timeout] = timeout if timeout > 0
+      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.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    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.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response, http_request)
+      HttpResponse.new(response.status, response.reason_phrase,
+                       response.headers, response.body, http_request)
+    end
+  end
+end