pico_api 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14850439f778e937789908411715f6b5ce574ea99a4806fffb00ef649dfd8a80
-  data.tar.gz: e7a2151b9decd161b1b427e4980904ba63b2d00f3ca0e90d2d924dc64042574e
+  metadata.gz: e00987197e956e77af63d09b3d1d458e335857f6a376076824c0f35da7154295
+  data.tar.gz: 4bed688ad8bd088af9bc9c4532b2b1fde95f215a1da74c8bb161980f5a3a5e64
 SHA512:
-  metadata.gz: 730b621fdc6d88fca903262364e0e911c5d941f9ba830d2beb6c1965d19b928531838b11e827b16941ad441a128b9024d1390ebe266973eae1a26de505b7d8ab
-  data.tar.gz: 195e3271e7198c9e515b9cb25d9f6d818d18c155e5f164d6fe90b6c0268175be5389c71794f12049da3fd498585935c586cdd15ef1326287610ff72d809c2104
+  metadata.gz: 5cb58169f60fd534f1f1dc79beccdc36c698dab9fcd2b3300783ba2e627a4f68db2eb70f2bdfb26217d11747d4c5837a202218209edbc05a12dafb9e77204d2d
+  data.tar.gz: 41e81c723e248df1d4cadaf0055f63ae662025113137f5b2fd57889eba9ca6336c63b825afe8158c53bed903faa6ee40120c2f7d3e7fe1ed607d106ed1fcf849

data/Gemfile

@@ -2,9 +2,7 @@
 
 source "https://rubygems.org"
 
-gemspec
-
 group :test do
-  gem "rspec", "~> 3"
+  gem "rspec"
   gem "pry"
 end

data/Gemfile.lock

@@ -1,98 +1,12 @@
-PATH
-  remote: .
-  specs:
-    pico_api (0.0.1)
-      erb (~> 2.2.3)
-      jsonapi-serializer (~> 2.2.0)
-      rackup (~> 0.2.2)
-      rake (~> 13.0.6)
-      roda (~> 3.61.0)
-      rom (~> 5.2.6)
-      rom-sql (~> 3.5.0)
-      zeitwerk (~> 2.6.1)
-
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    cgi (0.3.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    dry-container (0.11.0)
-      concurrent-ruby (~> 1.0)
-    dry-core (0.9.1)
-      concurrent-ruby (~> 1.0)
-      zeitwerk (~> 2.6)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.3.0)
-    dry-initializer (3.1.1)
-    dry-logic (1.3.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.9, >= 0.9)
-      zeitwerk (~> 2.6)
-    dry-struct (1.5.2)
-      dry-core (~> 0.9, >= 0.9)
-      dry-types (~> 1.6)
-      ice_nine (~> 0.11)
-      zeitwerk (~> 2.6)
-    dry-types (1.6.1)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 0.3)
-      dry-core (~> 0.9, >= 0.9)
-      dry-inflector (~> 0.1, >= 0.1.2)
-      dry-logic (~> 1.3, >= 1.3)
-      zeitwerk (~> 2.6)
-    erb (2.2.3)
-      cgi
-    i18n (1.12.0)
-      concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
-    jsonapi-serializer (2.2.0)
-      activesupport (>= 4.2)
     method_source (1.0.0)
-    minitest (5.16.3)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (3.0.0)
-    rackup (0.2.2)
-      rack (>= 3.0.0.beta1)
-      webrick
-    rake (13.0.6)
-    roda (3.61.0)
-      rack
-    rom (5.2.6)
-      rom-changeset (~> 5.2, >= 5.2.3)
-      rom-core (~> 5.2, >= 5.2.5)
-      rom-repository (~> 5.2, >= 5.2.2)
-    rom-changeset (5.2.3)
-      dry-core (~> 0.4)
-      rom-core (~> 5.2)
-      transproc (~> 1.0, >= 1.1.0)
-    rom-core (5.2.6)
-      concurrent-ruby (~> 1.1)
-      dry-container (~> 0.7)
-      dry-core (~> 0.4)
-      dry-equalizer (~> 0.2)
-      dry-inflector (~> 0.1)
-      dry-initializer (~> 3.0, >= 3.0.1)
-      dry-struct (~> 1.0)
-      dry-types (~> 1.0)
-      transproc (~> 1.0, >= 1.1.0)
-    rom-repository (5.2.2)
-      dry-core (~> 0.4)
-      dry-initializer (~> 3.0, >= 3.0.1)
-      rom-core (~> 5.2, >= 5.2.2)
-    rom-sql (3.5.0)
-      dry-core (~> 0.5, >= 0.5)
-      dry-types (~> 1.0)
-      rom (~> 5.2, >= 5.2.1)
-      sequel (>= 4.49)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -106,20 +20,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    sequel (5.62.0)
-    transproc (1.1.1)
-    tzinfo (2.0.5)
-      concurrent-ruby (~> 1.0)
-    webrick (1.7.0)
-    zeitwerk (2.6.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  pico_api!
   pry
-  rspec (~> 3)
+  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,15 +38,21 @@ 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
 - [x] Allow multiple db gateways in the config
 - [ ] Add irb/pry console script
+- [ ] Seperate configs to different environments (dev, prod, etc..)
 
 ## Contributing
 

data/lib/pico_api/configuration.rb

@@ -6,7 +6,12 @@ require 'yaml'
 module PicoApi
   class << self
     def configuration
-      @configuration ||= Configuration.new
+      @configuration ||= Configuration.new(db_config)
+    end
+
+    def db_config
+      template = ERB.new(File.new('./config/database.yml').read)
+      YAML.safe_load(template.result(binding))
     end
 
     def configure
@@ -15,20 +20,11 @@ module PicoApi
   end
 
   class Configuration
-    attr_accessor :namespace, :lib_path, :errors_map, :db_yaml_path
-
-    def db_yaml_path
-      @db_yaml_path || "/config/database.yml"
-    end
-
-    def db_config
-      YAML.safe_load(read_db_yaml_file.result(binding))
-    end
-
-    private
+    attr_reader :db_config
+    attr_accessor :namespace, :lib_path, :errors_map, :logger
 
-    def read_db_yaml_file
-      ERB.new(File.new(db_yaml_path).read)
+    def initialize(db_config)
+      @db_config = db_config
     end
   end
 end

data/lib/pico_api/database.rb

@@ -9,21 +9,29 @@ module PicoApi
       attr_accessor :container
 
       def setup!
-        database_config = PicoApi.configuration.db_config.symbolize_keys
+        database_config = PicoApi.configuration.db_config.deep_symbolize_keys
+        logger = PicoApi.configuration.logger
         gateways = database_config.keys
 
-        configs = gateways.inject({}) do |memo, gateway|
-          adapter = database_config.dig(gateway, :adapter).to_sym
-          options = database_config.dig(gateway, :options).symbolize_keys
+        configs = create_config(gateways, database_config)
+        cont = ROM.container(**configs) { |config| yield config if block_given? }
+
+        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[gateway] = [adapter, connection_string, **options]
           memo
         end
-
-        @container = ROM.container(**configs) do |config|
-          yield config if block_given?
-        end
       end
     end
   end

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

@@ -1,5 +1,5 @@
 require "pico_api"
-require "./config/dotenv" if ENV['PICO_API_ENV'] == "development"
+require "./config/dotenv"
 require "./config/configuration"
 require "./config/database_setup"
 require "./config/application"

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PicoApi
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 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.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Alex Avlonitis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2022-11-10 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: