aurora-data-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 344043ce8593c877dc10b721e2b1724ea96265ed5411fbef7828a7c670a3d40e
+  data.tar.gz: b3b440e30ef5b87abb26d987c8a35951cdb5e4c135181fc20ef9d59142a1f625
+SHA512:
+  metadata.gz: dd445671cf4c71684bcc20f24e0eea75d82218dd6959d338cc87e6faafd59a02644fd95fa31e8310645b2796114ea3d541ffd4fa71eb92c81846fd775fcba56e
+  data.tar.gz: dcdcf6717773ed3bc9921193eddac358496fc19aa90a4e4b7e3ba41c87096ecdc932e69fdd968f37b269e06e6a3ccf0812f755e87e79ee24af167bb65766cbea

data/.rake_tasks~

@@ -0,0 +1,10 @@
+build
+build:checksum
+clean
+clobber
+install
+install:local
+release[remote]
+standard
+standard:fix
+test

data/.standard.yml

@@ -0,0 +1,6 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.7
+
+ignore:
+  - 'example/**/*'

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 - 2022-05-31
+
+- Initial release (experimental)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hasumikin@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in aurora-data-api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"
+gem "test-unit-rr"
+
+gem "standard", "~> 1.3"
+
+gem "steep"

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    aurora-data-api (0.1.0)
+      aws-sdk-rdsdataservice (~> 1.35.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.591.0)
+    aws-sdk-core (3.131.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.525.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-rdsdataservice (1.35.0)
+      aws-sdk-core (~> 3, >= 3.127.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.5.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.1.10)
+    ffi (1.15.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.6.1)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    power_assert (2.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.5.0)
+    regexp_parser (2.4.0)
+    rexml (3.2.5)
+    rr (3.0.9)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    steep (1.0.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    test-unit (3.5.3)
+      power_assert
+    test-unit-rr (1.0.5)
+      rr (>= 1.1.1)
+      test-unit (>= 2.5.2)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  aurora-data-api!
+  rake (~> 13.0)
+  standard (~> 1.3)
+  steep
+  test-unit (~> 3.0)
+  test-unit-rr
+
+BUNDLED WITH
+   2.3.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 HASUMI Hitoshi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,236 @@
+# AuroraDataApi [![Ruby](https://github.com/hasumikin/aurora-data-api/actions/workflows/main.yml/badge.svg)](https://github.com/hasumikin/aurora-data-api/actions/workflows/main.yml)
+
+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.
+
+PostgreSQL is the only target as of now.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aurora-data-api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install aurora-data-api
+
+## Usage
+
+Let's say we're developing a blog that has three models:
+
+- User: able to post an entry and to comment on any entry
+- Entry: an article
+- Comment: a comment on an entry
+
+```ruby
+class User < AuroraDataApi::Model
+  schema do
+    col :name,             String
+    col :internet_account, String
+    timestamp # Creates :created_at and :updated_at
+  end
+
+  def twitter
+    "https://twitter.com/#{internet_account}"
+  end
+end
+
+class Entry < AuroraDataApi::Model
+  schema do
+    col :user,  :User  # User.to_sym
+    col :title, String
+    col :body,  String
+    timestamp
+  end
+end
+
+class Comment < AuroraDataApi::Model
+  schema do
+    col :user,  :User  # User.to_sym
+    col :entry, :Entry, table: :entries  #...(*)
+    col :body,  String
+    timestamp
+  end
+end
+
+# (*)
+# The plural of "entry" is too difficult for aurora-data-api.
+# So you need to explicitly tell gem the table name.
+```
+
+
+```ruby
+require_relative '../models/user'
+UserDepot = AuroraDataApi::Depot[User] do
+end
+
+require_relative '../models/entry'
+EntryDepot = AuroraDataApi::Depot[Entry] do
+end
+
+require_relative '../models/comment'
+CommentDepot = AuroraDataApi::Depot[Comment] do
+end
+```
+
+### Insert a user
+
+```ruby
+user = User.new(name: "HASUMI Hitoshi", internet_account: "hasumikin")
+user.id                 # => nil
+UserDepot.insert(user)  # => 1
+user.id                 # => 1
+```
+
+### Update the user
+
+```ruby
+user.internet_account = "HASUMIKIN"
+UserDepot.update(user)  # => true (false if failed)
+user.internet_account   # => "HASUMIKIN"
+```
+
+### Delete the user
+
+```ruby
+UserDepot.delete(user)  # => true (false if failed)
+user.id                 # => nil
+```
+
+### Find a user
+
+```ruby
+hasumikin = UserDepot.select(
+  "WHERE internet_account = :internet_account",
+  internet_account: "hasumikin"
+).first
+```
+
+### Post an entry
+
+```ruby
+my_entry = Entry.new(
+  user: hasumikin,
+  title: "My first article",
+  body: "Hey, this is an article about Ruby."
+)
+EntryDepot.insert(my_entry)
+```
+
+### Update the entry
+
+```ruby
+my_entry.body = "Hey, this is an article about Ruby whick is a happy language!"
+EntryDepot.update(my_entry)
+```
+
+### Delete the entry
+
+```ruby
+EntryDepot.delete(my_entry)
+```
+
+### Count comments
+
+```ruby
+count = CommentDepot.count(
+  "WHERE entry_id = :entry_id",
+  entry_id: my_entry.id
+)
+```
+
+### Select comments
+
+```ruby
+comments = CommentDepot.select(<<~SQL, user_id: hasumikin.id)
+  INNER JOIN ENTRY ON entry.id = comment.entry_id
+  WHERE entry.user_id = :user_id
+  ORDER BY comment.created_at
+  LIMIT 10 OFFSET 0
+SQL
+comments.class                 # => Array
+comments.first.class           # => Comment
+comments.first.body            # => "I have a question, ..."
+comments.first.entry.class     # => Entry
+comments.first.entry.title     # => "My first article"
+comments.first.entry.user.name # => "HASUMI Hitoshi"
+```
+
+As of the current version, the last call `comments.first.entry.user.name` will execute another query so it may cause an N+1 problem.
+
+## Typical application structure
+
+```sh
+your_app
+├── Gemfile        # It includes `gem 'aurora-data-api'`
+├── app
+│   ├── handlers  # You may have Lambda functions here
+│   ├── models
+│   │   ├── comment.rb
+│   │   ├── entry.rb
+│   │   └── user.rb
+│   └── depots
+│       ├── comment_depot.rb
+│       ├── entry_depot.rb
+│       └── user_depot.rb
+├── db
+│   └── shcema.sql
+└── serverless.yml # aurora-data-api is perfect for Serverless Framework
+```
+
+aurora-data-api doesn't have a generator to initiate the structure.
+Make it manually instead like:
+
+```sh
+mkdir -p app/models app/depots db
+```
+
+## Migration
+
+The following command overwrites `db/schema.sql` (for only PostgreSQL) by aggregating `app/models/*.rb`
+
+```sh
+bundle exec aurora-data-api export
+```
+
+We recommend to use @k0kubun's sqldef to manage migration.
+
+See [k0kubun/sqldef](https://github.com/k0kubun/sqldef)
+
+## Environment variables
+
+The following variables should be defined:
+
+```ruby
+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
+```
+
+RDS_SECRET_ARN has to be attached to an IAM role of the "application".
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hasumikin/aurora-data-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hasumikin/aurora-data-api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AuroraDataApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hasumikin/aurora-data-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test steep standard]
+
+task :steep do
+  sh "bundle exec steep check"
+end

data/Steepfile

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

data/aurora-data-api.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/aurora-data-api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "aurora-data-api"
+  spec.version = AuroraDataApi::VERSION
+  spec.authors = ["HASUMI Hitoshi"]
+  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.homepage = "https://github.com/hasumikin/aurora-data-api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hasumikin/aurora-data-api"
+  spec.metadata["changelog_uri"] = "https://github.com/hasumikin/aurora-data-api/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk-rdsdataservice", "~> 1.35.0"
+  spec.add_dependency "thor"
+end

data/example/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env.staging
+.env.production
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Serverless directories
+.serverless
+
+# package directories
+node_modules
+
+

data/example/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/example/Dockerfile

@@ -0,0 +1,26 @@
+# syntax = docker/dockerfile:experimental
+
+FROM lambci/lambda:build-ruby2.7
+
+RUN curl -sL https://rpm.nodesource.com/setup_12.x | bash - \
+  && yum -y install nodejs postgresql wget && yum -y clean all
+
+RUN mkdir /home/ec2-user && chown ec2-user /home/ec2-user
+RUN mkdir /home/ec2-user/bin && chown ec2-user /home/ec2-user/bin
+RUN mkdir /app && chown ec2-user /app
+
+WORKDIR /app
+COPY --chown=ec2-user Gemfile Gemfile.lock package.json package-lock.json /app/
+RUN gem install bundler
+RUN bundle install
+
+COPY --chown=ec2-user . /app
+
+USER ec2-user
+RUN npm install
+RUN wget -O - https://github.com/k0kubun/sqldef/releases/latest/download/psqldef_linux_amd64.tar.gz \
+  | tar xvz -C /home/ec2-user/bin
+
+EXPOSE 4000
+CMD ["/bin/bash"]
+

data/example/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'aurora-data-api', github: 'hasumikin/aurora-data-api'
+gem 'aws-sdk-lambda'
+
+group :test, :development do
+  gem 'rake'
+  gem 'test-unit-rr'
+end