appfuel-service 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91ad1af85e2c4df47201aa7f47652e6318395bd7
-  data.tar.gz: 11aa99fce5a2764eb0abdffd34d9fd10e2102f92
+  metadata.gz: 7d89625ae0ff9e49ecd85a326aec3467a84d91bb
+  data.tar.gz: 910682f71f8d186de81227cd6a77026ef9793732
 SHA512:
-  metadata.gz: 51af031db94a891c2627433dcc47ad3dc4fcc3f6f6405c386a81d8c6e4bc9911b4c1a777f8342fa6b743dbde5561c21eb78133c819c63ddb64dfa2dc1249c425
-  data.tar.gz: c4d7bb8d3fce5c51044d0ea5cb653eb0faf8d6bb0d08c0e0d8af013eaf593a7928ab1047139134f808aaddb77c961544d72a3aaf8e5815aa27576b55a72f12a7
+  metadata.gz: 358fa56770a955568a92c697233f5e5c899eb6f2acabee45569940a12d97c1a2e981986dddf9e4780e6072a51e9ead2d85df3a30b6702a5268830d540d51e85d
+  data.tar.gz: 2189021627302cab3ed90a64cd2ddcddf40204fd03384e5c7ad6ecb6a59a09bfb43ac4fc3d87b30a8e6401f1b861eced2e3713977c8c838d52399c7771402baf

data/CHANGELOG.md

@@ -2,3 +2,9 @@
 All notable changes to this project will be documented in this file. (Pending approval) This project adheres to [Semantic Versioning](http://semver.org/). You can read more on this at [keep a change log](http://keepachangelog.com/)
 
 # [Unreleased]
+
+# Releases
+
+## [[0.1.3]](https://github.com/rsb/appfuel/releases/tag/0.1.3) 2017-06-07
+### Added
+- Configuration definitions for database, aws, worker, sentry and new relic

data/appfuel-service.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "appfuel",  "~> 0.2.6"
+  spec.add_dependency "appfuel",  "~> 0.2.7"
   spec.add_dependency "sneakers", "~> 2.5"
 
   spec.add_development_dependency "bundler",  "~> 1.15"

data/lib/appfuel/service/config/aws.rb

@@ -0,0 +1,29 @@
+module Appfuel
+  module Service
+    module Config
+      #
+      # Defines how to parse and validate configuration data for aws
+      #
+      # Configuration Overview:
+      #   access_key_id:    access credentials for aws
+      #   secret_access_key: access credentials for aws
+      #   assets_bucket:    name of bucket to hold assets
+      #   documents_buckets  name of bucket to hold documents
+      #
+      #   @returns Config::Definition
+      def self.aws_definition
+        Appfuel::Configuration.define :aws do
+          defaults region: 'us-west-2'
+
+          validator {
+            required(:region).filled(:str?)
+            optional(:access_key_id).filled(:str?)
+            optional(:secret_access_key).filled(:str?)
+            optional(:kms_master_key_id).filled(:str?)
+            optional(:kms_data_key_cipher).filled(:str?)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/appfuel/service/config/database.rb

@@ -0,0 +1,57 @@
+module Appfuel
+  module Service
+    module Config
+      # Defines database configuration. This is designed to hold more than one
+      # database connection which is why they are named invidually. We are using
+      # active record so the config is taylored to that style connection.
+      #
+      # Configuration Overview
+      #
+      # pool:     Managed connection which controls the amount of thread access to
+      #           a limited number of database connections
+      # adapter:  We always use postgres, rarely changes
+      # encoding: We always use unicode, rarely changes
+      # database  Name of the database
+      # username  Name of the database user
+      # password  Database password
+      # host      Location of the database server
+      #
+      # @return Defintion
+      def self.db_definition
+        Appfuel::Configuration.define :db do
+          validator {
+            required(:main).filled(:hash?)
+            required(:path).filled(:str?)
+            required(:seed_path).filled(:str?)
+            required(:migrations_path).filled(:str?)
+          }
+
+          db_path = 'db'
+          defaults path: db_path,
+            migrations_path: "#{db_path}/migrations",
+            seed_path: 'db/seed'
+
+          define :main do
+            defaults pool:     5,
+              adapter: 'postgresql',
+              encoding: 'unicode',
+              schema_format: 'sql'
+
+            validator do
+              required(:schema_search_path).filled(:str?)
+              required(:schema_format).filled(:str?)
+              required(:database).filled(:str?)
+              required(:username).filled(:str?)
+              required(:password).filled(:str?)
+              required(:host).filled(:str?)
+              required(:adapter).filled(:str?)
+              optional(:pool).filled(:int?)
+              optional(:encoding).filled(:str?)
+              optional(:port).filled(:int?)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appfuel/service/config/newrelic.rb

@@ -0,0 +1,22 @@
+module Appfuel
+  module Service
+    module Config
+      def self.newrelic_definition
+        Appfuel::Configuration.define :newrelic do
+          defaults license_key: '',
+                   app_name: '',
+                   log_level: 'info',
+                   monitor_mode: 'true',
+                   agent_enabled:'true'
+          validator {
+            required(:new_relic_license_key).filled(:str?)
+            required(:new_relic_app_name).filled(:str?)
+            required(:new_relic_log_level).filled(:str?)
+            required(:new_relic_monitor_mode).filled(:str?)
+            required(:new_relic_agent_enabled).filled(:str?)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/appfuel/service/config/sentry.rb

@@ -0,0 +1,13 @@
+module Appfuel
+  module Service
+    module Config
+      def self.sentry_definition
+        Appfuel::Configuration.define :sentry do
+          validator {
+             required(:dsn).filled(:str?)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/appfuel/service/config/sneakers.rb

@@ -0,0 +1,58 @@
+module Appfuel
+  module Service
+    module Config
+      #
+      # Defines how to parse and validate configuration data for sneakers
+      # for more information of the configuration please go to the wiki for
+      # the sneakers project https://github.com/jondot/sneakers/wiki/Configuration
+      #
+      # Configuration Overview:
+      #   heartbeat:         RabbitMQ   heartbeat delay in seconds
+      #   ack:               RabbitMQ   the worker must acknowledge work is done
+      #   daemonize:         Sneakers   deameonize the worker
+      #   log                Sneakers   log file location
+      #   pid_path           Sneakers   daemon's pidfile location
+      #   workers            Sneakers   the number of worker processes
+      #   threads            Sneakers   number of threads per worker
+      #   prefetch           RabbitMQ   how many messages to send to a worker
+      #   timeout_job_after  Sneakers   Maximal seconds to wait for job
+      #   start_worker_delay Sneakers   Delay between thread startup
+      #   durable            RabbitMQ   Queue should persist
+      #   exchange           RabbitMQ   name of the exchange
+      #   exchange_type      RabbitMQ   type of exchange (direct, topic, fanout)
+      #   vhost              RabbitMQ   name of the vhost
+      #   amqp               RabbitMQ   connection string used to communicate
+      #
+      #   @returns Config::Definition
+      def self.sneakers_definition
+        Appfuel::Configuration.define :sneakers do
+          defaults heartbeat: 60,
+                  ack: true,
+                  daemonize: true,
+                  workers: 1,
+                  threads: 1,
+                  prefetch: 1,
+                  timeout_job_after: 5,
+                  durable: true
+
+          validator {
+            required(:amqp).filled(:str?)
+            required(:vhost).filled(:str?)
+            required(:exchange).filled(:str?)
+            required(:exchange_type).filled(:str?)
+            required(:durable).filled(:bool?)
+            required(:ack).filled(:bool?)
+            required(:daemonize).filled(:bool?)
+            required(:heartbeat).filled(:int?)
+            required(:log).filled(:str?)
+            required(:pid_path).filled(:str?)
+            required(:threads).filled(:int?)
+            required(:workers).filled(:int?)
+            required(:timeout_job_after).filled(:int?)
+            required(:prefetch).filled(:int?)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/appfuel/service/config/worker.rb

@@ -0,0 +1,49 @@
+module Appfuel
+  module Service
+    module Config
+      # Defines the configuration for the whole worker. It basically has two
+      # child definitions :db and :sneakers
+      #
+      # Configuration Overview
+      #
+      # env:        The environement this worker is deployed as dev, qa, stg, prod
+      # logfile:    The location of the application log file if the value is
+      #             stdout or stderr it will use that instead
+      # dispatchers List of workers that dispatch messages to actions. The reason
+      #             why you would want more than one is to use different exchange
+      #             types
+      #
+      # db          Database configuration please see sp_offers/config/database
+      # sneakers    RabbitMQ configuration please see sp_offers/config/sneakers
+      # aws         Configuration S3 where we store our documents
+      # @return Definition
+      def self.worker_definition
+        Appfuel::Configuration.define :worker do
+          file 'config/app.yaml'
+          defaults logfile: 'stdout',
+                    audit_logfile: 'stdout'
+
+          validator {
+            required(:env).filled(:str?)
+            required(:logfile).filled(:str?)
+            required(:audit_logfile).filled(:str?)
+            # Children will be validated on there own
+            # we are just ensuring they exist
+            required(:db).filled(:hash?)
+            optional(:sneakers).filled(:hash?)
+            optional(:aws).filled(:hash?)
+            optional(:sentry).filled(:hash?)
+            optional(:newrelic).filled(:hash?)
+          }
+          self << [
+            Config.db_definition,
+            Config.sneakers_definition,
+            Config.aws_definition,
+            Config.sentry_definition,
+            Config.newrelic_definition
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/appfuel/service/config.rb

@@ -0,0 +1,7 @@
+require 'yaml'
+require_relative 'config/database'
+require_relative 'config/sneakers'
+require_relative 'config/aws'
+require_relative 'config/worker'
+require_relative 'config/sentry'
+require_relative 'config/newrelic'

data/lib/appfuel/service/version.rb

@@ -1,5 +1,5 @@
 module Appfuel
   module Service
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/lib/appfuel/service.rb

@@ -3,3 +3,4 @@ require "sneakers"
 require "appfuel/service/version"
 require "appfuel/service/msg_request"
 require "appfuel/service/worker"
+require "appfuel/service/config"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appfuel-service
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Robert Scott-Buccleuch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appfuel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: sneakers
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,13 @@ files:
 - bin/console
 - bin/setup
 - lib/appfuel/service.rb
+- lib/appfuel/service/config.rb
+- lib/appfuel/service/config/aws.rb
+- lib/appfuel/service/config/database.rb
+- lib/appfuel/service/config/newrelic.rb
+- lib/appfuel/service/config/sentry.rb
+- lib/appfuel/service/config/sneakers.rb
+- lib/appfuel/service/config/worker.rb
 - lib/appfuel/service/msg_request.rb
 - lib/appfuel/service/version.rb
 - lib/appfuel/service/worker.rb