elsoul / souls Goto Github PK

🕺 SOULs 💃 Build Serverless Apps faster like Rails. Powered by Ruby GraphQL, Active Record, RSpec, RuboCop, and Google Cloud.

Home Page: https://souls.el-soul.com

License: Apache License 2.0

Ruby 99.28% Shell 0.04% Dockerfile 0.62% Procfile 0.06%

ruby graphql google-cloud serverless-framework serverless framework google-cloud-run pubsub rails ruby-on-rails

souls's Introduction

Ruby Serverless Application Framework SOULs Document

Go to SOULs Document

What's SOULs?

Ruby Serverless Framework 'SOULs'.

The SOULs project was launched with the goal of reducing software development, operation and maintenance costs.

Build Serverless Apps faster like Rails. Powered by Ruby GraphQL, Active Record, RSpec, RuboCop, and Google Cloud.

Focus on business logic in serverless environment
Maximize development efficiency with CI / CD standard schema-driven Scaffold
Achieve global scale with lower management costs

SOULs creates 3 types of App.

API - GraphQL (Ruby) - Simple API - Cloud Run
Worker - Google Pub/Sub Messaging Worker API (Ruby) - Cloud Run
Functions - Google Cloud Functions

Dependency

Cloud Infrastructure

Installation

Add this line to your application's Gemfile:

gem 'souls'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install souls

And Create Your APP

$ souls new app_name

Development

After checking out the repo, run bin/setup to install dependencies. Then, run souls t to run the tests. You can also run souls c 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 tags, and push the .gem file to rubygems.org.

Test Coverage

Rspec Test Coverage

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elsoul/souls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the Apache-2.0 License.

Code of Conduct

Everyone interacting in the SOULs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

souls's People

Contributors

Stargazers

Watchers

Forkers

s4na majacq iq-scm edenshin

souls's Issues

Fix Resolver RBS Template

module Resolvers
  class BaseResolver
  end
end

Update `graphql-batch` to `dataloader` for N+1 query solution

currently graphql-batch has been implemented in souls as default.

remove this module

https://github.com/elsoul/souls/blob/master/apps/api/app/utils/association_loader.rb

and

Let's change it to dataloader since it's using fiber and graphql-ruby 's default.

we need to make apps/api/app/graphql/sources dir for dataloader fetch file like user_by_id.rb

Dataloader
https://graphql-ruby.org/dataloader/overview.html

souls g migration 実行時に is_deleted を自動で追加する

add `| (:id, String, required: true ) -> String` to `update_mutation_rbs`

        def self.argument: (:uid, String, required: false ) -> String
                         | (:id, String, required: true ) -> String
                         | (:is_deleted, Boolean, required: false ) -> Boolean

return_method から send_method へ変更

Update graphql-ruby gem version from v1.13.10 to v2.0.14

There are breaking changes between v1.13.x and v2.0.~
Let's update SOULs default gem version.

GraphQL Ruby GitHub
https://github.com/rmosolgo/graphql-ruby

Change Log
https://github.com/rmosolgo/graphql-ruby/blob/master/CHANGELOG.md

This might affect these parts below;

SOULs API template
SOULs GraphQL generation command

List should be desc by default

query test singularises fields

need to add pubsub subscription delete

add `Souls::Types` RBS template

Update ruby version 3.1.0 to 3.1.2

ruby version update

`souls s` gets error when `redis` is already running

[Error] souls sync model

➜  api git:(frontend) souls sync model
🎉  Syncing Files...                   /Users/ktm/dev/trade-pos/config/souls.rb:5:in `block in <top (required)>'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/lib/souls.rb:34:in `configure'
/Users/ktm/dev/trade-pos/config/souls.rb:1:in `<top (required)>'
<internal:/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/3.0.0/rubygems/core_ext/kernel_require.rb>:85:in `require'
<internal:/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/3.0.0/rubygems/core_ext/kernel_require.rb>:85:in `require'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/lib/souls/cli/sync/model.rb:14:in `cp_and_dl_files'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/lib/souls/cli/sync/model.rb:7:in `block in model'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/lib/souls/cli/sync/model.rb:6:in `each'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/lib/souls/cli/sync/model.rb:6:in `model'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/exe/souls:152:in `public_send'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/exe/souls:152:in `block in <top (required)>'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/whirly-0.3.0/lib/whirly.rb:171:in `start'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/lib/ruby/gems/3.0.0/gems/souls-0.48.2/exe/souls:150:in `<top (required)>'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/bin/souls:23:in `load'
/Users/ktm/.anyenv/envs/rbenv/versions/3.0.2/bin/souls:23:in `<main>'
undefined method `github_repo=' for #<Souls::Configuration:0x00007ff62bad7e78 @app="trade-pos", @project_id="usmef-japan-trade", @region=nil, @endpoint=nil, @strain="mother", @fixed_gems=[""], @workers=nil>
➜  api git:(frontend) souls -v
0.48.2

need to add error handling with `souls db create` when docker psql doesn't exist

souls db create
rake aborted!
No Rakefile found (looking for: rakefile, Rakefile, rakefile.rb, Rakefile.rb)

(See full trace by running task with --trace)
/home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/souls-1.13.4/lib/souls/cli/db/index.rb:91:in `db_system': It looks like there was a problem with the DB. Make sure PSQL is running with 'souls docker psql' (Souls::PSQLException)
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/souls-1.13.4/lib/souls/cli/db/index.rb:30:in `create'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor/command.rb:27:in `run'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor/invocation.rb:127:in `invoke_command'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor.rb:392:in `dispatch'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor/invocation.rb:116:in `invoke'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor.rb:243:in `block in subcommand'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor/command.rb:27:in `run'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor/invocation.rb:127:in `invoke_command'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor.rb:392:in `dispatch'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/thor-1.1.0/lib/thor/base.rb:485:in `start'
        from /home/fudo/.rbenv/versions/3.0.1/lib/ruby/gems/3.0.0/gems/souls-1.13.4/exe/souls:11:in `<top (required)>'
        from /home/fudo/.rbenv/versions/3.0.1/bin/souls:23:in `load'
        from /home/fudo/.rbenv/versions/3.0.1/bin/souls:23:in `<main>'

remove define_method from QueryType

module Types
  class QueryType < Souls::Types::BaseObject
    add_field(GraphQL::Types::Relay::NodeField)
    add_field(GraphQL::Types::Relay::NodesField)
    SoulsHelper.get_tables.each do |t|
      field t.singularize.underscore.to_s.to_sym, resolver: Object.const_get("Queries::#{t.singularize.camelize}")
      field "#{t.singularize.underscore}_search".to_sym,
            resolver: Object.const_get("Resolvers::#{t.singularize.camelize}Search")
      field t.pluralize.underscore.to_s.to_sym,
            Object.const_get("Types::#{t.singularize.camelize}Type").connection_type,
            null: true
      #remove this line
      define_method t do
        Object.const_get(t.singularize.camelize.to_s).all.order(id: :desc)
      end
      # end
    end
  end
end

Fix tests for this repository

It's better if the test is passing and green.

separate deploying flow from creating cloud sql

remove plural query files from scaffold command

resolver does have the same return.
lets remove unnecessary code

add `souls db reset` command

Update GCloud authentication method to use Workload Identity Federation

https://github.com/google-github-actions/auth#setup

fix `souls g type_rbs`. `GraphQL::Types::ISO8601DateTime` to `String`

例外追加の必要あり "tags" で Array型のときに、tag に変換されてしまう

souls g コマンドでカラム名を使う部分に影響あり

fix souls g manager rspec

Display user-friendly errors for when problems occur with initial install"

grep returns more than 2 instances if the app_name contains other app_name in the same GCP project

'souls gcloud sql assign_ip' overwirtes white list

It may delete IPs which already registered before when run command again

verison mangament for api/worker files

should be in 'rake upload:init_files' command

update `souls gcloud sql create_instance` to use PostgreSQL14

currently, PostgreSQL13 is a default.

Let's change it to PostgreSQL14.

https://github.com/elsoul/souls/blob/master/lib/souls/cli/gcloud/sql/index.rb#L12

Add graphql dataloader for relation table to scaffold command

Basically, we need to do 2 things.

Improve souls g type command
add dataloader method when it has a relation table
Create souls g source command
add souls g source command and it generates fetch file in source dir.

reference
https://graphql-ruby.org/dataloader/overview.html

new_record needs decoded id

update_article.rb

        new_record = { **args, id: data_id, user_id: user_id, article_category_id: article_category_id }

improve `souls sync pubsub` command

Better to put this command in workflow.

add souls build tag push command

add souls build, souls tag and souls push command

fix base64 global id

fix souls docker psql

Remove `Whirly` when `souls gcloud iam setup`

Remove Whirly when souls gcloud iam setup

from line 5

https://github.com/elsoul/souls/blob/master/lib/souls/cli/gcloud/iam/index.rb#L5

add `check_user_permissions` method to SOULs gem

def check_user_permissions(user, obj, method)
  raise(StandardError, "Invalid or Missing Token") unless user

  policy_class = obj.class.name + "Policy"
  policy_clazz = policy_class.constantize.new(user, obj)
  permission = policy_clazz.public_send(method)
  raise(Pundit::NotAuthorizedError, "permission error!") unless permission
end

Add `souls_fb_auth` in SoulsMutation

I updated souls-doc's firebase login method like below;

module Mutations
  module Managers::UserManager
    class SignInUser < BaseMutation
      field :status, String, null: false
      field :token, String, null: true
      field :user_role, String, null: true
      field :username, String, null: true
      argument :token, String, required: false

      def resolve(token:)
        payload = souls_fb_auth(token: token)
        begin
          user = ::User.find_by_uid(payload["sub"])
          user.update(icon_url: payload["picture"], username: payload["name"])
          token_base = JsonWebToken.encode(user_id: user.id)
          {
            status: "ログイン成功!",
            username: user.username,
            token: token_base
          }
        rescue StandardError
          user =
            ::User.new(
              uid: payload["sub"],
              email: payload["email"],
              icon_url: payload["picture"],
              username: payload["name"],
              user_role: 4
            )
          if user.save
            token = JsonWebToken.encode(user_id: user.id)
            {
              status: "ユーザー新規登録完了!",
              username: user.username,
              token: token,
              user_role: user.user_role
            }
          else
            { status: user.errors.full_messages }
          end
        end
      end
    end
  end
end

SOULs Doc

It would be super if that souls_fb_auth works behind and return Firebase payload.

current code

module Mutations
  class BaseMutation < GraphQL::Schema::RelayClassicMutation
    argument_class Types::BaseArgument
    field_class Types::BaseField
    input_object_class Types::BaseInputObject
    object_class Types::BaseObject

    def fb_auth(token:)
      FirebaseIdToken::Certificates.request!
      sleep(3) if ENV["RACK_ENV"] == "development"
      @payload = FirebaseIdToken::Signature.verify(token)
      raise(ArgumentError, "Invalid or Missing Token") if @payload.blank?

      @payload
    end
,
,

module Legiscan
  require 'legiscan/error'
  require 'legiscan/request'
  require 'legiscan/push'

Was able to fix it by moving those class definitions in the same file

But now I'm getting an error with my concerns. I'm getting this error

NameError: uninitialized constant Voter

  include Voter

in my model

class User < ApplicationRecord
  include Voter
  include Follower
  include Verifiable
  include Devise::JWT::RevocationStrategies::JTIMatcher

How can I import modules into my models?