nucleus 0.1.0 → 0.2.0

data/lib/nucleus/core/error_messages.rb

@@ -1,127 +1,127 @@
-module Nucleus
-  # The {ErrorMessages} module groups all error definitions that can be returned by the RESTful API.
-  # With its constants, it provides the skeleton to create error messages that comply with the error schema of Nucleus.
-  module ErrorMessages
-    #################
-    # CLIENT ERRORS #
-    #################
-
-    ENDPOINT_BAD_REQUEST = {
-      status: 400,
-      error_code: 400_001,
-      message: 'Bad Request'
-    }
-
-    AUTH_BAD_REQUEST = {
-      status: 400,
-      error_code: 400_002,
-      message: 'Bad Authentication Request'
-    }
-
-    BAD_REQUEST_VALIDATION = {
-      status: 400,
-      error_code: 400_003,
-      message: 'Bad Request: Parameter validation failed'
-    }
-
-    BAD_REQUEST_APP_ARCHIVE = {
-      status: 400,
-      error_code: 400_004,
-      message: 'Bad Request: Application archive is damaged or did not match the declared file format'
-    }
-
-    AUTH_UNAUTHORIZED = {
-      status: 401,
-      error_code: 401_000,
-      message: 'Unauthorized: Authentication failed'
-    }
-
-    ENDPOINT_AUTH_FAILED = {
-      status: 401,
-      error_code: 401_001,
-      message: 'Authentication failed, endpoint rejected authentication attempt'
-    }
-
-    NOT_FOUND = {
-      status: 404,
-      error_code: 404_000,
-      message: 'The resource could not be found'
-    }
-
-    ENDPOINT_NOT_FOUND = {
-      status: 404,
-      error_code: 404_001,
-      message: 'The resource could not be found'
-    }
-
-    INVALID_ACCEPT_HEADER = {
-      status: 406,
-      error_code: 406_000,
-      message: 'Invalid Accept header, vendor or version not found'
-    }
-
-    BAD_REQUEST_ENTITY = {
-      status: 422,
-      error_code: 422_000,
-      message: 'Unprocessable Entity: Request was valid, but has been rejected by the endpoint, '\
-      'saying the message was semantically false. Check the dev_message for detailed error analysis'
-    }
-
-    # All platform specific semantic errors should have a unique error code!
-    PLATFORM_SPECIFIC_ERROR_ENTITY = {
-      status: 422,
-      error_code: 422_001,
-      message: 'Unprocessable Entity: Request format was valid, but has been rejected by the endpoint, '\
-        'saying the message contains data that can not be processed by this specific platform.'
-    }
-
-    # Quota violations are a common issue and therefore deserve their own message ;)
-    PLATFORM_QUOTA_ERROR = {
-      status: 422,
-      error_code: 422_002,
-      message: 'Unprocessable Entity: Request format was valid, but has been rejected by the endpoint. '\
-        'Your account would exceed its quota limits. Please check your account and its billing status.'
-    }
-
-    #################
-    # SERVER ERRORS #
-    #################
-
-    RESCUED = {
-      status: 500,
-      error_code: 500_000,
-      message: 'Oops, something went terribly wrong here :/'
-    }
-
-    RESCUED_ADAPTER_CALL = {
-      status: 500,
-      error_code: 500_001,
-      message: 'Endpoint call failed with unforeseen cause'
-    }
-
-    RESCUED_ADAPTER_CALL_SERVER = {
-      status: 500,
-      error_code: 500_002,
-      message: 'Endpoint crashed with server error'
-    }
-
-    MISSING_IMPLEMENTATION = {
-      status: 501,
-      error_code: 501_000,
-      message: 'Not Implemented'
-    }
-
-    UNAVAILABLE = {
-      status: 503,
-      error_code: 503_000,
-      message: 'Service Unavailable'
-    }
-
-    PLATFORM_GATEWAY_TIMEOUT = {
-      status: 504,
-      error_code: 504_000,
-      message: 'Gateway Timeout. The platform raised an internal Timeout error. We don\'t know to what '\
-        'degree the request has been processed, or if it wasn\'t executed at all.'
-    }
-  end
-end
+module Nucleus
+  # The {ErrorMessages} module groups all error definitions that can be returned by the RESTful API.
+  # With its constants, it provides the skeleton to create error messages that comply with the error schema of Nucleus.
+  module ErrorMessages
+    #################
+    # CLIENT ERRORS #
+    #################
+
+    ENDPOINT_BAD_REQUEST = {
+      status: 400,
+      error_code: 400_001,
+      message: 'Bad Request'
+    }
+
+    AUTH_BAD_REQUEST = {
+      status: 400,
+      error_code: 400_002,
+      message: 'Bad Authentication Request'
+    }
+
+    BAD_REQUEST_VALIDATION = {
+      status: 400,
+      error_code: 400_003,
+      message: 'Bad Request: Parameter validation failed'
+    }
+
+    BAD_REQUEST_APP_ARCHIVE = {
+      status: 400,
+      error_code: 400_004,
+      message: 'Bad Request: Application archive is damaged or did not match the declared file format'
+    }
+
+    AUTH_UNAUTHORIZED = {
+      status: 401,
+      error_code: 401_000,
+      message: 'Unauthorized: Authentication failed'
+    }
+
+    ENDPOINT_AUTH_FAILED = {
+      status: 401,
+      error_code: 401_001,
+      message: 'Authentication failed, endpoint rejected authentication attempt'
+    }
+
+    NOT_FOUND = {
+      status: 404,
+      error_code: 404_000,
+      message: 'The resource could not be found'
+    }
+
+    ENDPOINT_NOT_FOUND = {
+      status: 404,
+      error_code: 404_001,
+      message: 'The resource could not be found'
+    }
+
+    INVALID_ACCEPT_HEADER = {
+      status: 406,
+      error_code: 406_000,
+      message: 'Invalid Accept header, vendor or version not found'
+    }
+
+    BAD_REQUEST_ENTITY = {
+      status: 422,
+      error_code: 422_000,
+      message: 'Unprocessable Entity: Request was valid, but has been rejected by the endpoint, '\
+      'saying the message was semantically false. Check the dev_message for detailed error analysis'
+    }
+
+    # All platform specific semantic errors should have a unique error code!
+    PLATFORM_SPECIFIC_ERROR_ENTITY = {
+      status: 422,
+      error_code: 422_001,
+      message: 'Unprocessable Entity: Request format was valid, but has been rejected by the endpoint, '\
+        'saying the message contains data that can not be processed by this specific platform.'
+    }
+
+    # Quota violations are a common issue and therefore deserve their own message ;)
+    PLATFORM_QUOTA_ERROR = {
+      status: 422,
+      error_code: 422_002,
+      message: 'Unprocessable Entity: Request format was valid, but has been rejected by the endpoint. '\
+        'Your account would exceed its quota limits. Please check your account and its billing status.'
+    }
+
+    #################
+    # SERVER ERRORS #
+    #################
+
+    RESCUED = {
+      status: 500,
+      error_code: 500_000,
+      message: 'Oops, something went terribly wrong here :/'
+    }
+
+    RESCUED_ADAPTER_CALL = {
+      status: 500,
+      error_code: 500_001,
+      message: 'Endpoint call failed with unforeseen cause'
+    }
+
+    RESCUED_ADAPTER_CALL_SERVER = {
+      status: 500,
+      error_code: 500_002,
+      message: 'Endpoint crashed with server error'
+    }
+
+    MISSING_IMPLEMENTATION = {
+      status: 501,
+      error_code: 501_000,
+      message: 'Not Implemented'
+    }
+
+    UNAVAILABLE = {
+      status: 503,
+      error_code: 503_000,
+      message: 'Service Unavailable'
+    }
+
+    PLATFORM_GATEWAY_TIMEOUT = {
+      status: 504,
+      error_code: 504_000,
+      message: 'Gateway Timeout. The platform raised an internal Timeout error. We don\'t know to what '\
+        'degree the request has been processed, or if it wasn\'t executed at all.'
+    }
+  end
+end

data/lib/nucleus/core/models/abstract_model.rb

@@ -1,29 +1,29 @@
-module Nucleus
-  #
-  # @author Cedric Roeck (cedric.roeck@gmail.com)
-  # @since 0.1.0
-  class AbstractModel
-    include Kwalify::Util::HashLike
-
-    attr_accessor :id
-    attr_accessor :name
-    attr_accessor :created_at
-    attr_accessor :updated_at
-
-    def initialize(hash = nil)
-      return if hash.nil?
-      @name = hash['name']
-      @id = hash['id']
-    end
-
-    def to_s
-      return name if self.respond_to?('name')
-      return id if id
-      super.to_s
-    end
-
-    def inspect
-      to_s
-    end
-  end
-end
+module Nucleus
+  #
+  # @author Cedric Roeck (cedric.roeck@gmail.com)
+  # @since 0.1.0
+  class AbstractModel
+    include Kwalify::Util::HashLike
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :created_at
+    attr_accessor :updated_at
+
+    def initialize(hash = nil)
+      return if hash.nil?
+      @name = hash['name']
+      @id = hash['id']
+    end
+
+    def to_s
+      return name if respond_to?('name')
+      return id if id
+      super.to_s
+    end
+
+    def inspect
+      to_s
+    end
+  end
+end

data/lib/nucleus/scripts/load_dependencies.rb

@@ -9,7 +9,6 @@ require 'logger'
 
 # database
 require 'moneta'
-require 'daybreak'
 require 'lmdb'
 
 # schema

data/lib/nucleus/scripts/setup_config.rb

@@ -1,28 +1,28 @@
-# configuration
-require 'logger'
-require 'configatron/core'
-require 'nucleus/ext/kernel'
-require 'nucleus/os'
-
-# import the configuration file that resides in the user's home directory as initial choice
-if OS.windows?
-  home_dir_config = File.expand_path(File.join(Dir.home, 'nucleus', 'nucleus_config.rb'))
-else
-  home_dir_config = File.expand_path(File.join(Dir.home, '.nucleus', 'nucleus_config.rb'))
-end
-if File.exist?(home_dir_config)
-  puts "Applying configuration from: #{home_dir_config}"
-  require home_dir_config
-end
-
-# include the configuration of the project to overwrite the home dir config
-project_dir_config = '../../../config/nucleus_config.rb'
-if File.exist?(File.expand_path(project_dir_config, File.dirname(__FILE__)))
-  puts "Applying configuration from: #{File.expand_path(project_dir_config, File.dirname(__FILE__))}"
-  require_relative project_dir_config
-end
-
-# make sure we have a logging directory
-unless nucleus_config.logging.key?(:path)
-  nucleus_config.logging.path = File.join(__dir__, '..', '..', '..', 'log')
-end
+# configuration
+require 'logger'
+require 'configatron/core'
+require 'nucleus/ext/kernel'
+require 'nucleus/os'
+
+# import the configuration file that resides in the user's home directory as initial choice
+home_dir_config = if OS.windows?
+                    File.expand_path(File.join(Dir.home, 'nucleus', 'nucleus_config.rb'))
+                  else
+                    File.expand_path(File.join(Dir.home, '.nucleus', 'nucleus_config.rb'))
+                  end
+if File.exist?(home_dir_config)
+  puts "Applying configuration from: #{home_dir_config}"
+  require home_dir_config
+end
+
+# include the configuration of the project to overwrite the home dir config
+project_dir_config = '../../../config/nucleus_config.rb'
+if File.exist?(File.expand_path(project_dir_config, File.dirname(__FILE__)))
+  puts "Applying configuration from: #{File.expand_path(project_dir_config, File.dirname(__FILE__))}"
+  require_relative project_dir_config
+end
+
+# make sure we have a logging directory
+unless nucleus_config.logging.key?(:path)
+  nucleus_config.logging.path = File.join(__dir__, '..', '..', '..', 'log')
+end

data/lib/nucleus/version.rb

@@ -1,3 +1,3 @@
-module Nucleus
-  VERSION = '0.1.0'
-end
+module Nucleus
+  VERSION = '0.2.0'.freeze
+end

data/nucleus.gemspec

@@ -17,16 +17,14 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0'
 
   # we ignore the test files and icons as they tremendously increase the gem size (up to 43MB)
-  spec.files         = `git ls-files -z --exclude-standard`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z --exclude-standard`.split("\x0").reject do |f|
     f[%r{^(lib/nucleus_api|spec/adapter|icons)/}]
   end
   # again only unit and integration, but no adapter test files
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.test_files = spec.files.grep(%r{^(spec)/})
 
   # used as global configuration
   spec.add_runtime_dependency 'configatron', '~> 4.5'
-  # DB store (1)
-  spec.add_runtime_dependency 'daybreak', '~> 0.3'
   # Required for log tailing against HTTP endpoints
   spec.add_runtime_dependency 'em-http-request', '~> 1.1'
   # Used as main HTTP / REST client
@@ -36,24 +34,24 @@ Gem::Specification.new do |spec|
   # Application data handling
   spec.add_runtime_dependency 'git', '~> 1.2'
   # Used to build the API
-  spec.add_runtime_dependency 'grape', '~> 0.12'
-  spec.add_runtime_dependency 'grape-entity', '~> 0.4', '>= 0.4.5'
+  spec.add_runtime_dependency 'grape', '~> 0.13.0'
+  spec.add_runtime_dependency 'grape-entity', '~> 0.4.8', '>= 0.4.5'
   # Used to document the API
-  spec.add_runtime_dependency 'grape-swagger', '~> 0.10', '>= 0.10.1'
+  spec.add_runtime_dependency 'grape-swagger', '~> 0.10.2', '>= 0.10.1'
   # Used to import the vendor, provider & adapter setup from configuration with schema validation
   spec.add_runtime_dependency 'kwalify', '~> 0.7'
-  # DB store (2)
+  # DB store
   spec.add_runtime_dependency 'lmdb', '~> 0.4'
   # Logging
   spec.add_runtime_dependency 'logger', '~> 1.2'
   # Application archive handling, detect unsupported uploads
-  spec.add_runtime_dependency 'mime-types', '~> 2.4'
+  spec.add_runtime_dependency 'mime-types', '~> 2.6'
   # Generic interface for DB store implementations
   spec.add_runtime_dependency 'moneta', '~> 0.8'
   # Openshift logging access and direct Git SSH requests
   spec.add_runtime_dependency 'net-ssh', '~> 3.0'
   # Used for JSON / Hash conversion and test cassette serialization (is way faster than other JSON libs)
-  spec.add_runtime_dependency 'oj', '~> 2.12'
+  spec.add_runtime_dependency 'oj', '~> 2.14'
   # Required for Cloud Foundry log messages
   spec.add_runtime_dependency 'protobuf', '~> 3.4'
   # To make sure HTTPS is used instead of HTTP
@@ -81,8 +79,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-yard'
   spec.add_development_dependency 'inch', '~> 0.7'
   spec.add_development_dependency 'rake', '~> 10.4'
-  spec.add_development_dependency 'rubocop', '~> 0.34'
-  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'rubocop', '~> 0.36.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 1.20'
   spec.add_development_dependency 'yard', '~> 0.8'
 end

data/spec/factories/models.rb

@@ -1,61 +1,63 @@
-FactoryGirl.define do
-  sequence :uuid do |_|
-    SecureRandom.uuid
-  end
-
-  factory :adapter, class: Nucleus::AdapterIndexEntry do
-    url { Faker::Internet.url }
-    id nil
-    adapter_clazz nil
-  end
-
-  factory :endpoint, class: Nucleus::Endpoint do
-    id { generate(:uuid) }
-    name { Faker::Internet.slug }
-    url { Faker::Internet.url }
-    created_at { (Faker::Date.between(180.days.ago, 90.days.ago)).iso8601 }
-    updated_at { (Faker::Date.between(90.days.ago, Date.today)).iso8601 }
-    provider nil
-
-    after(:create) do |endpoint|
-      # associate with provider
-      unless endpoint.provider.nil?
-        # TODO: find a solution how to test when multiple API versions are to be supported
-        dao = Nucleus::API::DB::ProviderDao.instance('v1')
-        provider = dao.get endpoint.provider
-        provider.endpoints = [] if provider.endpoints.nil?
-        provider.endpoints << endpoint.id
-        # save updated association
-        dao.set provider
-      end
-    end
-  end
-
-  factory :provider, class: Nucleus::Provider do
-    id { generate(:uuid) }
-    name { Faker::App.name }
-    created_at { (Faker::Date.between(180.days.ago, 90.days.ago)).iso8601 }
-    updated_at { (Faker::Date.between(90.days.ago, Date.today)).iso8601 }
-    vendor nil
-
-    after(:create) do |provider|
-      # associate with vendor
-      unless provider.vendor.nil?
-        # TODO: find a solution how to test when multiple API versions are to be supported
-        dao = Nucleus::API::DB::VendorDao.instance('v1')
-        vendor = dao.get provider.vendor
-        vendor.providers = [] if vendor.providers.nil?
-        vendor.providers << provider.id
-        # save updated association
-        dao.set vendor
-      end
-    end
-  end
-
-  factory :vendor, class: Nucleus::Vendor do
-    id { generate(:uuid) }
-    name { Faker::App.name }
-    created_at { (Faker::Date.between(180.days.ago, 90.days.ago)).iso8601 }
-    updated_at { (Faker::Date.between(90.days.ago, Date.today)).iso8601 }
-  end
-end
+require 'active_support/core_ext'
+
+FactoryGirl.define do
+  sequence :uuid do |_|
+    SecureRandom.uuid
+  end
+
+  factory :adapter, class: Nucleus::AdapterIndexEntry do
+    url { Faker::Internet.url }
+    id nil
+    adapter_clazz nil
+  end
+
+  factory :endpoint, class: Nucleus::Endpoint do
+    id { generate(:uuid) }
+    name { Faker::Internet.slug }
+    url { Faker::Internet.url }
+    created_at { Faker::Date.between(180.days.ago, 90.days.ago).iso8601 }
+    updated_at { Faker::Date.between(90.days.ago, Date.today).iso8601 }
+    provider nil
+
+    after(:create) do |endpoint|
+      # associate with provider
+      unless endpoint.provider.nil?
+        # TODO: find a solution how to test when multiple API versions are to be supported
+        dao = Nucleus::API::DB::ProviderDao.instance('v1')
+        provider = dao.get endpoint.provider
+        provider.endpoints = [] if provider.endpoints.nil?
+        provider.endpoints << endpoint.id
+        # save updated association
+        dao.set provider
+      end
+    end
+  end
+
+  factory :provider, class: Nucleus::Provider do
+    id { generate(:uuid) }
+    name { Faker::App.name }
+    created_at { Faker::Date.between(180.days.ago, 90.days.ago).iso8601 }
+    updated_at { Faker::Date.between(90.days.ago, Date.today).iso8601 }
+    vendor nil
+
+    after(:create) do |provider|
+      # associate with vendor
+      unless provider.vendor.nil?
+        # TODO: find a solution how to test when multiple API versions are to be supported
+        dao = Nucleus::API::DB::VendorDao.instance('v1')
+        vendor = dao.get provider.vendor
+        vendor.providers = [] if vendor.providers.nil?
+        vendor.providers << provider.id
+        # save updated association
+        dao.set vendor
+      end
+    end
+  end
+
+  factory :vendor, class: Nucleus::Vendor do
+    id { generate(:uuid) }
+    name { Faker::App.name }
+    created_at { Faker::Date.between(180.days.ago, 90.days.ago).iso8601 }
+    updated_at { Faker::Date.between(90.days.ago, Date.today).iso8601 }
+  end
+end