aurora-data-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 344043ce8593c877dc10b721e2b1724ea96265ed5411fbef7828a7c670a3d40e
-  data.tar.gz: b3b440e30ef5b87abb26d987c8a35951cdb5e4c135181fc20ef9d59142a1f625
+  metadata.gz: 9e9e12802725256d0bdc9d33f440906b71ae20924215188db1f65b7be77e5474
+  data.tar.gz: baaf18e32b395d14ae044ece3c23cad990b9bee6a199819a49e423bd99996e18
 SHA512:
-  metadata.gz: dd445671cf4c71684bcc20f24e0eea75d82218dd6959d338cc87e6faafd59a02644fd95fa31e8310645b2796114ea3d541ffd4fa71eb92c81846fd775fcba56e
-  data.tar.gz: dcdcf6717773ed3bc9921193eddac358496fc19aa90a4e4b7e3ba41c87096ecdc932e69fdd968f37b269e06e6a3ccf0812f755e87e79ee24af167bb65766cbea
+  metadata.gz: 303da4d601927f8419139e23b21f8d5b42a218a7ff6cea2132f89e2a80aea7074563e1f9826b5419e90a9da6812bf46e1490a9444ca50a9ad19a22a2ac23f29a
+  data.tar.gz: 6c08a977905060290ae36b5bc2abdb6c94dda4bbaabd68915037052cec4cd9b8c6dbb4be92d9edc9c2cb055ffa71e96e77b73bd692b213794493d6725baf7638

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.1 - 2022-06-02
+
+- Fix some issues (experimental)
+
 ## 0.1.0 - 2022-05-31
 
 - Initial release (experimental)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aurora-data-api (0.1.0)
+    aurora-data-api (0.1.1)
       aws-sdk-rdsdataservice (~> 1.35.0)
       thor
 
@@ -15,7 +15,7 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.591.0)
+    aws-partitions (1.592.0)
     aws-sdk-core (3.131.1)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)

data/README.md

@@ -2,7 +2,9 @@
 
 A kind of ORM for Amazon Aurora Serverless v1.
 
-Supposing that you are using Ruby (typically on AWS Lambda) as an application, Aurora Serverless v1 (NOT v2) as a database, and Data API as the database adapter.
+Supposing that you are using Ruby (typically on AWS Lambda) as an application, Aurora Serverless v1 (NOT v2) as a database, and Data API as a database adapter.
+
+This gem doesn't depend on ActiveRecord and takes advantage of PORO (plain old Ruby object) like Array, Hash, and Struct internally so you can easily hack.
 
 PostgreSQL is the only target as of now.
 
@@ -213,10 +215,15 @@ The following variables should be defined:
 ENV['PGDATABASE']       # Database name
 ENV['RDS_RESOURCE_ARN'] # Resource ARN of RDS Aurora Serverless
 ENV['RDS_SECRET_ARN']   # Secret ARN that is stored in AWS Secrets Manager
+ENV['TZ']               # (Optional) Timezone. Internal default is "UTC"
 ```
 
 RDS_SECRET_ARN has to be attached to an IAM role of the "application".
 
+## Example project with Serverless Project
+
+See [example](https://github.com/hasumikin/aurora-data-api/tree/master/example)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Steepfile

@@ -1,5 +1,5 @@
 target :lib do
   signature "sig"
   check "lib"
-  library "time"
+  library "time", "date"
 end

data/aurora-data-api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email = ["hasumikin@gmail.com"]
 
   spec.summary = "A kind of ORM for Amazon Aurora Serverless v1"
-  spec.description = "Assuming you are using AWS Lambda as a backend, Aurora Serverless v1 (NOT v2) as a database, and Data API as an adapter"
+  spec.description = "Doesn't depend on ActiveRecord and takes advantage of PORO (plain old Ruby object) like Array, Hash, and Struct internally so you can easily hack."
   spec.homepage = "https://github.com/hasumikin/aurora-data-api"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.7.0"

data/example/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'aurora-data-api', github: 'hasumikin/aurora-data-api'
+gem 'aurora-data-api'
 gem 'aws-sdk-lambda'
 
 group :test, :development do

data/example/Gemfile.lock

@@ -1,14 +1,9 @@
-GIT
-  remote: https://github.com/hasumikin/aurora-data-api.git
-  revision: 70ae5070c8391c6be2ac9b4209425308ed01f2e7
+GEM
+  remote: https://rubygems.org/
   specs:
     aurora-data-api (0.1.0)
       aws-sdk-rdsdataservice (~> 1.35.0)
       thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
     aws-eventstream (1.2.0)
     aws-partitions (1.594.0)
     aws-sdk-core (3.131.1)
@@ -39,7 +34,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  aurora-data-api!
+  aurora-data-api
   aws-sdk-lambda
   rake
   test-unit-rr

data/example/README.md

@@ -2,44 +2,119 @@
 
 ### Stack
 
+- Ruby + aurora-data-api gem
 - Serverless Framework
-  - Lamdda functions (outside VPC)
-  - RDS Aurora Serverless v1 (inside VPC) + 
+- Lambda functions outside VPC
+- RDS Aurora Serverless v1 inside VPC + Data API (HTTP endpoint)
+- Secrets Manager, IAM, etc.
 
-### Getting started
+### Try in your local computer with docker
 
 ```sh
 docker compose build
-docker compose run --rm serverless rake db:create_database
-docker compose run --rm serverless bundle exec aurora-data-api export
-docker compose run --rm serverless rake db:migrate_dry_run
-docker compose run --rm serverless rake db:migrate
 ```
+
+#### Create database
+
+```sh
+docker compose run --rm serverless rake db:create
+```
+
+#### Confirm the SQL of migration
+
 ```sh
 docker compose run --rm serverless rake db:migrate_dry_run
-=> -- Nothing is modified --
 ```
+
+#### Migrate
+
+```sh
+docker compose run --rm serverless rake db:migrate
+```
+
+#### Start containers
+
 ```sh
 docker compose up
 ```
+
+### APIs
+
 ```sh
 curl http://localhost:4000/offline/hello
 ```
 
+#### Create a user
+
 ```sh
 curl -X POST http://localhost:4000/offline/create_user \
 -H 'Content-Type: application/json' \
 -d '{"name":"HASUMI Hitoshi", "internet_account":"hasumikin"}'
+```
+
+#### List users
 
+```sh
+curl http://localhost:4000/offline/users
+```
+
+#### Update the user
+
+```sh
 curl -X PUT http://localhost:4000/offline/update_user \
 -H 'Content-Type: application/json' \
 -d '{"id":1, "name":"anonymous", "internet_account":"hasumikin"}'
+```
 
+#### Create an entry
+
+```sh
 curl -X POST http://localhost:4000/offline/create_entry \
 -H 'Content-Type: application/json' \
 -d '{"title":"My first atrticle", "user_id":1}'
+```
+
+#### List entries
+
+```sh
+curl http://localhost:4000/offline/entries
+```
 
+#### Delete the entry
+
+```sh
 curl -X POST http://localhost:4000/offline/delete_entry \
 -H 'Content-Type: application/json' \
 -d '{"entry_id":1}'
 ```
+
+### Deploy to AWS
+
+Supposing you have an AWS credential in $HOME/.aws/credentials.
+It has to have almost administrative permission in order to provision a Serverless Framework app:
+
+```
+[YourAWSProfileName]
+aws_access_key_id=AKIAxxxxxxxxxxxxxxxxx
+aws_secret_access_key=xxxxxxxxxxxxxxxxxxxxxxxxxx
+```
+
+```sh
+serverless deploy --stage production --aws-profile [YourAWSProfileName]
+```
+
+About 30 minutes later, all stacks should've been provisioned in AWS.
+
+- You can see API endpoints by `sls info --stage production --aws-profile [YourAWSProfileName]`
+- Open the AWS management console
+- Find *RDS_SECRET_ARN* value lools like `arn:aws:secretsmanager:ap-northeast-1:01234567890:secret:aurora-data-api-example-production-AuroraUserSecret-xxxxxx` in "Secrets Manager"
+
+    <img src="https://raw.githubusercontent.com/hasumikin/aurora-data-api/master/example/doc/query-edidor.png" width="400" />
+
+- Go to "RDS" > "Query Editor" of and connect with the secret ARN above, then run the content of `db/schema.sql` to create tables
+
+Now that you can call APIs like:
+
+```sh
+curl https://xxxxxxxxx.execute-api.ap-northeast-1.amazonaws.com/production/hello
+```

data/example/Rakefile

@@ -1,7 +1,7 @@
 
 namespace "db" do
   desc "Create database"
-  task :create_database do
+  task :create do
     sql = <<~SQL
       CREATE DATABASE #{ENV['PGDATABASE']}
         TEMPLATE template0 ENCODING 'UTF-8' LC_COLLATE 'C' LC_CTYPE 'C';
@@ -10,7 +10,7 @@ namespace "db" do
   end
 
   desc "Drop database"
-  task :drop_database do
+  task :drop do
     sql = <<~SQL
       DROP DATABASE #{ENV['PGDATABASE']};
     SQL

data/example/app/handlers/main.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-Dir.glob("/var/runtime/bundler/gems/**").each do |dir|
-  $LOAD_PATH.unshift("#{dir}/lib/")
-end
-
 require "json"
 require "aurora-data-api"
 require_relative "../depots/user_depot"

data/example/app/models/entry.rb

@@ -6,6 +6,7 @@ class Entry < AuroraDataApi::Model
     col :user,  :User, table: :users, null: false
     col :title, String
     col :body,  String
+    col :publish_date, Date
     timestamp
   end
 end

data/example/serverless.yml

@@ -108,7 +108,7 @@ resources:
           AutoPause: true
           MaxCapacity: ${self:custom.myEnvironment.DBMaxCapacity.${sls:stage}, 2}
           MinCapacity: 2
-          SecondsUntilAutoPause: 900 # 15 min for example
+          SecondsUntilAutoPause: 3600 # 60 min for example
         DBSubnetGroupName:
           Ref: DBSubnetGroup
     DBSecret:

data/exe/aurora-data-api

@@ -2,9 +2,8 @@
 
 require "aurora-data-api/version"
 require "thor"
-
-class Date
-end
+require "date"
+require "fileutils"
 
 module AuroraDataApi
   class Error < StandardError; end

data/lib/aurora-data-api/depot.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "date"
+require "tzinfo"
+
 module AuroraDataApi
   class Depot
     def self.[](model, &block)
@@ -13,6 +16,7 @@ module AuroraDataApi
       @model = model
       instance_eval { block.call }
       @data_service = DataService.new
+      @observed_utc_offset = TZInfo::Timezone.get(ENV['TZ'] || "UTC").observed_utc_offset
     end
 
     def table_name
@@ -103,7 +107,9 @@ module AuroraDataApi
       when "text"
         col.value.gsub("''", "'")
       when "timestamptz"
-        Time.parse(col.value) + 9 * 60 * 60 # workaround
+        Time.parse(col.value) + @observed_utc_offset
+      when "date"
+        Date.parse(col.value)
       else
         col.value
       end

data/lib/aurora-data-api/model.rb

@@ -44,7 +44,7 @@ module AuroraDataApi
     end
 
     def self.relationship_by(table_sym)
-      result = Model::SCHEMA[name&.to_sym].select { |_k, v|
+      result = Model::SCHEMA[to_s.to_sym].select { |_k, v|
         v.is_a? Hash
       }.select { |_k, v|
         v.dig(:opt, :table) == table_sym
@@ -94,7 +94,7 @@ module AuroraDataApi
         if @struct[method_name].nil?
           col_id = "#{method_name}_#{literal_id}".to_sym
           if members.include?(col_id) && @struct[col_id]
-            col_model = SCHEMA[self.class.name&.to_sym][:cols].dig(method_name, :type)
+            col_model = SCHEMA[self.class.to_s.to_sym][:cols].dig(method_name, :type)
             return nil unless col_model
             @struct[method_name] = AuroraDataApi.const_get("#{col_model}Depot".to_sym).select(
               %(where "#{literal_id}" = :id), id: @struct[col_id]
@@ -109,7 +109,7 @@ module AuroraDataApi
     end
 
     def table_name
-      SCHEMA[self.class.name&.to_sym][:table_name]
+      SCHEMA[self.class.to_s.to_sym][:table_name]
     end
 
     def literal_id
@@ -120,7 +120,7 @@ module AuroraDataApi
       {}.tap do |hash|
         members.each do |member|
           next if member == literal_id && !include_id
-          next if SCHEMA[self.class.name&.to_sym][:cols][member][:type].is_a? Symbol
+          next if SCHEMA[self.class.to_s.to_sym][:cols][member][:type].is_a? Symbol
           send(member).then { |v| hash[member] = v }
         end
       end

data/lib/aurora-data-api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AuroraDataApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/aurora-data-api.rb

@@ -9,6 +9,3 @@ module AuroraDataApi
   class Error < StandardError; end
   # Your code goes here...
 end
-
-class Date
-end

data/sig/aurora-data-api.rbs

@@ -2,9 +2,6 @@ module AuroraDataApi
   Error: StandardError
 end
 
-class Date
-end
-
 module Aws
   def self.config: -> Hash[Symbol, untyped]
 

data/sig/model.rbs

@@ -2,20 +2,32 @@
 
 # Classes
 module AuroraDataApi
+  type attribute = Symbol | Time | Date | Integer | Symbol | bool | nil
+  type attribute_type = singleton(String)
+                      | singleton(Time)
+                      | singleton(Date)
+                      | singleton(Integer)
+                      | Symbol
+
   class Model
-    SCHEMA: Hash[untyped, untyped]
-    STRUCTS: Hash[untyped, untyped]
+    SCHEMA: Hash[Symbol, untyped]
+    STRUCTS: Hash[Symbol, untyped]
     @struct: untyped
 
+    type col_opt = Hash[:table, Symbol]
+                 | Hash[:null, bool]
+                 | Hash[:unique, bool]
+                 | Hash[:default, untyped]
+
     def self.model_name: -> Symbol
     def self.literal_id: (Symbol lit) -> Symbol
     def self.table: (Symbol name) -> Symbol
     def self.table_name: -> Symbol
     def self.schema: () { () -> void } -> void
-    def self.col: (Symbol name, singleton(String) | singleton(Time) | singleton(Date) | singleton(Integer) | Symbol type, ?Hash[Symbol, Symbol | bool] opt) -> void
+    def self.col: (Symbol name, attribute_type type, ?col_opt opt) -> void
     def self.timestamp: -> void
     def self.relationship_by: (Symbol table_sym) -> [untyped, untyped]?
-    def initialize: (**Hash[Symbol, untyped]) -> void
+    def initialize: (**Hash[Symbol, attribute]) -> void
 
     attr_reader id: Integer?
     attr_reader timestamp: bool
@@ -25,11 +37,11 @@ module AuroraDataApi
     def set_timestamp: (at: :update | :create) -> bool
     def members: -> Array[Symbol]
     def respond_to_missing?: (untyped symbol, untyped include_private) -> true
-    def method_missing: (untyped method_name, *untyped args) -> nil
+    def method_missing: (Symbol method_name, *untyped args) -> nil
     def table_name: -> Symbol
     def literal_id: -> Symbol
-    def build_params: (?include_id: bool) -> Hash[Symbol, untyped]
-    def attributes: -> Hash[Symbol, untyped]
+    def build_params: (?include_id: bool) -> Hash[Symbol, attribute]
+    def attributes: -> Hash[Symbol, attribute]
     def _set_id: (Integer? id) -> void
     def _destroy: -> bool
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aurora-data-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - HASUMI Hitoshi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-rdsdataservice
@@ -38,8 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Assuming you are using AWS Lambda as a backend, Aurora Serverless v1
-  (NOT v2) as a database, and Data API as an adapter
+description: Doesn't depend on ActiveRecord and takes advantage of PORO (plain old
+  Ruby object) like Array, Hash, and Struct internally so you can easily hack.
 email:
 - hasumikin@gmail.com
 executables:
@@ -75,6 +75,7 @@ files:
 - example/compose.yml
 - example/db/.gitignore
 - example/db/.keep
+- example/doc/query-edidor.png
 - example/package-lock.json
 - example/package.json
 - example/serverless.yml