hydrogen-nucleus-api 1.9.2

data/lib/nucleus_api/api_error.rb

@@ -0,0 +1,38 @@
+=begin
+#Hydrogen Nucleus API
+
+#The Hydrogen Nucleus API
+
+OpenAPI spec version: 1.9.2
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+module NucleusApi
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
+        arg.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      else
+        super arg
+      end
+    end
+  end
+end

data/lib/nucleus_api/auth_configuration.rb

@@ -0,0 +1,181 @@
+=begin
+#Hydrogen Atom API
+
+#The Hydrogen Atom API
+
+OpenAPI spec version: 1.7.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.13
+
+=end
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'typhoeus'
+require 'uri'
+module NucleusApi
+  class AuthConfiguration < Configuration
+    attr_accessor :authorization
+    attr_accessor :client_token
+    attr_accessor :grant_type_key
+    attr_accessor :client_credentials
+    attr_accessor :password
+    attr_accessor :username
+    attr_accessor :application_json_value
+    attr_accessor :auth_uri
+    attr_accessor :client_token_auth_uri
+    attr_accessor :config
+    attr_accessor :bearer
+    attr_accessor :base_url
+    def initialize
+      super
+      @authorization = 'Authorization'
+      @client_token = 'Client-Token'
+      @grant_type_key = 'grant_type'
+      @client_credentials = 'client_credentials'
+      @password = 'password'
+      @username = 'username'
+      @application_json_value = 'application/json'
+      @auth_uri = '/authorization/v1/oauth/token'
+      @client_token_auth_uri = '/authorization/v1/client-token'
+      @bearer = 'Bearer '
+      @config = Configuration.default
+      yield(self) if block_given?
+    end
+
+    def self.default
+      @@default ||= AuthConfiguration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def set_base_url(base_url)
+      @config.host = base_url
+    end
+
+    def auth_url(host)
+      url = "#{scheme}://#{[host, auth_uri].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      URI.encode(url)
+    end
+
+    def client_token_auth_url(host)
+      url = "#{scheme}://#{[host, client_token_auth_uri].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      URI.encode(url)
+    end
+
+    def create_client_token_credential(client_id, client_secret, client_token)
+      basic_cred = 'Basic ' + ["#{client_id}:#{client_secret}"].pack('m').delete("\r\n")
+      header_params = {}
+      header_params[@authorization] = basic_cred;
+      header_params[@client_token] = @bearer + client_token;
+      response = Typhoeus::Request.new(
+          client_token_auth_url(@config.host),
+          :method => :post,
+          :headers => header_params,
+          :params => nil
+      ).run
+
+      if @debugging
+        @logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+      body = JSON.parse(response.body)
+      unless response.success?
+        if response.timed_out?
+          raise ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          raise ApiError.new(:code => 0,
+                             :message => response.return_message)
+        else
+          raise ApiError.new(:code => response.code,
+                             :response_headers => response.headers,
+                             :response_body => response.body), response.body
+        end
+      end
+      @config.access_token = body['access_token']
+    end
+
+    def create_client_credential(client_id, client_secret)
+      basic_cred = 'Basic ' + ["#{client_id}:#{client_secret}"].pack('m').delete("\r\n")
+      # Request Params
+      params = {}
+      params[@grant_type_key] = @client_credentials
+      # Header parameters
+      header_params = {}
+      header_params['Accept'] = '*/*'
+      header_params['Content-Type'] = 'application/json'
+      header_params[@authorization] = basic_cred
+      response = Typhoeus::Request.new(
+          auth_url(@config.host),
+          :method => :post,
+          :headers => header_params,
+          :params => params
+      ).run
+
+      if @debugging
+        @logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+      body = JSON.parse(response.body)
+      unless response.success?
+        if response.timed_out?
+          raise ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          raise ApiError.new(:code => 0,
+                             :message => response.return_message)
+        else
+          raise ApiError.new(:code => response.code,
+                             :response_headers => response.headers,
+                             :response_body => response.body), response.body
+        end
+      end
+      @config.access_token = body['access_token']
+    end
+
+    def set_access_token(token)
+      @config.access_token = token
+    end
+
+    def create_password_credential(client_id, client_secret, username, password)
+      basic_cred = 'Basic ' + ["#{client_id}:#{client_secret}"].pack('m').delete("\r\n")
+      # Request Params
+      params = {}
+      params[@grant_type_key] = @password
+      params[@username] = username
+      params[@password] = password
+      # header parameters
+      header_params = {}
+      header_params['Accept'] = '*/*'
+      header_params['Content-Type'] = 'application/json'
+      header_params[@authorization] = basic_cred
+      response = Typhoeus::Request.new(
+          auth_url(@config.host),
+          :method => :post,
+          :headers => header_params,
+          :params => params
+      ).run
+      if @debugging
+        @logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+      body = JSON.parse(response.body)
+      unless response.success?
+        if response.timed_out?
+          raise ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          raise ApiError.new(:code => 0,
+                             :message => response.return_message)
+        else
+          raise ApiError.new(:code => response.code,
+                             :response_headers => response.headers,
+                             :response_body => response.body), body
+        end
+      end
+      @config.access_token = body['access_token']
+    end
+  end
+end

data/lib/nucleus_api/configuration.rb

@@ -0,0 +1,209 @@
+=begin
+#Hydrogen Nucleus API
+
+#The Hydrogen Nucleus API
+
+OpenAPI spec version: 1.9.2
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'addressable/uri'
+
+module NucleusApi
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'https'
+      @host = 'api.hydrogenplatform.com'
+      @base_path = '/'
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = 0
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    def base_url
+      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      Addressable::URI.encode(url)
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'oauth2' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token}"
+          },
+      }
+    end
+  end
+end

data/lib/nucleus_api/environment.rb

@@ -0,0 +1,26 @@
+
+require 'uri'
+
+module NucleusApi
+  class Environment
+    attr_accessor :api_client
+    attr_accessor :auth_config
+    attr_accessor :SANDBOX
+    attr_accessor :PRODUCTION
+    def initialize(api_client = ApiClient.default, config = Configuration.default, auth_config = AuthConfiguration.default)
+      @api_client = api_client
+      @config = config
+      @auth_config = auth_config
+      @SANDBOX = 'sandbox.hydrogenplatform.com'
+      @PRODUCTION = 'api.hydrogenplatform.com'
+    end
+
+    def set_environment(host)
+      if (host)
+        @config.config.host=host
+        @api_client.config.host=host
+        @auth_config.set_base_url(host)
+      end
+    end
+  end
+end