pico_api 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f576489c0e3b0b4cc8ab9d23d3dd273f50f3fcd6cf29689b26a67ee6508c3f
-  data.tar.gz: 83723e1d3095b13f302d016b8a3f2b166220a7e42842b569ef77cfd86f76648e
+  metadata.gz: 6d1191a8f8d535570f78985bbcb8fbd72c1ca6dae18c22c22721aaae7749e50d
+  data.tar.gz: ba4c1daa34d3f9dca5db1c2e3d2d617da6583b82394a62062cdbd919da7f34ab
 SHA512:
-  metadata.gz: 7eb82db803e9e5f78d7c78ecf8a2054dfbd523f200331586e8ac1e9c45c38c837fdae794c4296c593627c97a976382aca69b77a478359d8473e882435dcb936f
-  data.tar.gz: 43935b1f888497e2dafc4f488d53ecc4b55fdd48efa112ef6ca659b37cc94c4f8bbdef392ef30857ac0c474490a88d4e60cf8c1c2e2fb0186a6e719727fb17cf
+  metadata.gz: a886497c3c53c5ef5d9b7a64e0598ab397bb0409411f1463c4f45ae87a601cea58577a7daded0734ecb2fedbcb0aa8c746eb915e9775fe4a2b79352e6887a85e
+  data.tar.gz: a1c7f3f41ccb615fde6814e30afeb7e88c26349e181e1d7316fb79a8129bf7a529259e29291800c29111b5ce5b69abfad694e64f76901318efe01f13c2b135dd

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+group :test do
+  gem "rspec"
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/Readme.md

@@ -1,7 +1,7 @@
 # Pico API
 
 A tiny boilerplate JSON API template in ruby. Its minimal footprint makes it ideal for microservices or even full blown APIs.
-It has been created for those who don't need the RAILS "magic" and bloat. Can easily create different architectures, like STAR, CQRS..., and MVC.
+It has been created for those who don't need the RAILS "magic" and bloat. Can easily create different architectures, like STAR, CQRS, DDD..., and MVC.
 
 Pico API is just a collection of the fastest ruby libraries put together to form a basic API environment, with the JSON:API specification. It doesn't create any folder structures for your business logic, it only creates the initial configurations to get you started.
 
@@ -9,6 +9,7 @@ Example demo project can be found [here](https://github.com/alexavlonitis/pico_a
 
 ## Libraries Used
 
+- Rack -> Backbone
 - [roda](https://github.com/jeremyevans/roda) -> Routing
 - [rom-rb](https://github.com/rom-rb/rom) -> ORM
 - [jsonapi serializer](https://github.com/jsonapi-serializer/jsonapi-serializer) -> Fast-jsonapi fork
@@ -37,14 +38,19 @@ Migration info: https://rom-rb.org/5.0/learn/sql/migrations/
 - Run the migrations: `rake db:migrate`
 - Run the server:     `rackup -p 3001`
 
+### Routing
+
+Routing info: https://github.com/jeremyevans/roda 
+
+Add routing info in `config/application.rb` file 
 
 ## Development
 - [x] Create Database config
 - [x] Hook a json-api library
 - [x] Handle Errors
-- [ ] Create a Logger config
+- [x] Create a Logger config
 - [ ] Create a testing environment
-- [ ] Allow multiple db gateways in the config
+- [x] Allow multiple db gateways in the config
 - [ ] Add irb/pry console script
 
 ## Contributing

data/lib/pico_api/configuration.rb

@@ -21,7 +21,7 @@ module PicoApi
 
   class Configuration
     attr_reader :db_config
-    attr_accessor :namespace, :lib_path, :errors_map
+    attr_accessor :namespace, :lib_path, :errors_map, :logger
 
     def initialize(db_config)
       @db_config = db_config

data/lib/pico_api/database.rb

@@ -9,15 +9,29 @@ module PicoApi
       attr_accessor :container
 
       def setup!
-        database_config = PicoApi.configuration.db_config['default']
-        adapter = database_config['adapter'].to_sym
-        options = database_config['options'].symbolize_keys
-        connection_string = database_config['connection_string']
+        database_config = PicoApi.configuration.db_config.deep_symbolize_keys
+        logger = PicoApi.configuration.logger
+        gateways = database_config.keys
 
-        config = ROM::Configuration.new(adapter, connection_string, options)
-        yield config if block_given?
+        configs = create_config(gateways, database_config)
+        cont = ROM.container(**configs) { |config| yield config if block_given? }
 
-        @container = ROM.container(config)
+        gateways.each { |gateway| cont.gateways[gateway].use_logger(logger) } if logger
+
+        @container = cont
+      end
+
+      private
+
+      def create_config(gateways, database_config)
+        gateways.inject({}) do |memo, gateway|
+          adapter = database_config.dig(gateway, :adapter)&.to_sym
+          options = database_config.dig(gateway, :options)
+          connection_string = database_config.dig(gateway, :connection_string)
+
+          memo[gateway] = [adapter, connection_string, **options]
+          memo
+        end
       end
     end
   end

data/lib/pico_api/generators/templates/config/configuration.erb

@@ -1,9 +1,11 @@
 PicoApi.configure do |config|
   ## the base namespace of your app
-  config.namespace       = "<%= @project_name_camelcased %>"
+  config.namespace = "<%= @project_name_camelcased %>"
 
   ## the root directory where all the business logic resides
-  config.lib_path        = "lib/<%= @project_name_snakecased %>"
+  config.lib_path = "lib/<%= @project_name_snakecased %>"
+
+  config.logger = Logger.new(STDOUT) if ENV['LOG_TO_STDOUT'] == 'true'
 
   ## Add your custom exception mappings -> { exception: status_code }.
   # PicoApi serializes runtime exceptions to json-api specification error objects

data/lib/pico_api/generators/templates/config/database.yml

@@ -6,3 +6,9 @@ default:
   options:
     encoding:
 
+# Additional gateways supported
+# legacy:
+#   adapter:
+#   connection_string:
+#   options:
+#     encoding:

data/lib/pico_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PicoApi
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

data/pico_api.gemspec

@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.executables << 'pico_api'
 
-  spec.add_runtime_dependency 'erb', '~> 2.2.3'
-  spec.add_runtime_dependency 'jsonapi-serializer', '~> 2.2.0'
-  spec.add_runtime_dependency 'rackup', '~> 0.2.2'
-  spec.add_runtime_dependency 'rake', '~> 13.0.6'
-  spec.add_runtime_dependency 'roda', '~> 3.61.0'
-  spec.add_runtime_dependency 'rom', '~> 5.2.6'
-  spec.add_runtime_dependency 'rom-sql', '~> 3.5.0'
-  spec.add_runtime_dependency 'zeitwerk', '~> 2.6.1'
+  spec.add_runtime_dependency 'erb', '~> 2'
+  spec.add_runtime_dependency 'jsonapi-serializer', '~> 2'
+  spec.add_runtime_dependency 'rackup', '~> 0.2'
+  spec.add_runtime_dependency 'rake', '~> 13'
+  spec.add_runtime_dependency 'roda', '~> 3'
+  spec.add_runtime_dependency 'rom', '~> 5'
+  spec.add_runtime_dependency 'rom-sql', '~> 3.5'
+  spec.add_runtime_dependency 'zeitwerk', '~> 2.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pico_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex Avlonitis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -16,112 +16,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rackup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: roda
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.61.0
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.61.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.6
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.6
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rom-sql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.1
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.6.1
+        version: '2.6'
 description: A tiny Rack-based ruby template for APIs
 email: 
 executables:
@@ -130,6 +130,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - Rakefile
 - Readme.md