souls 0.23.6 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9b239d8337484aa068e9a7746e248138dadafa12f7cdcdf04f715c896f94188
-  data.tar.gz: a8edefdb6f72c353a76e99807b39ae60882860336bf6cb6fc9d4511bf4ba551f
+  metadata.gz: b052d6dae1a6c0847f3fcb32dc77bde6ea698c642f2e3e667bffb940e6e2ed54
+  data.tar.gz: 556817e4f1cd69a831a08d59e6498b8472351c786e6c9f97f489f03b8a29e3f9
 SHA512:
-  metadata.gz: '09a772d76110044534c362babea22cabe480686806b6bd5505741b389f69bacdc86dcd72ebcf068e7be0e4c384df1f3218034aa36fac49f8890785be3f212498'
-  data.tar.gz: 87caf77681a745b9a5d57e7e5532c2cfe7f15bc0b8d8198c1bbcbbd5d7c67eb208cbd82808ce1d062688ebdd87da691f0221fc8c68ecb5ee483237dde6bf1c08
+  metadata.gz: 5240e15e169064d3bf6b91a91be906a996079bcf625211b51c10bc07aefde0d62830956a8a7a2ff1e2ba0012dad4453ad7240a3dd1439ea20eca585a69514038
+  data.tar.gz: 0641f3caf5426483944c66f77258bca8739f720e02b9451d33a04ab3e6bb5942bf12795c1d12a3a1fe460b2835fad732c5d8c27a8b650c7cf0a383cda210d5e1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    souls (0.23.6)
+    souls (0.23.9)
       paint (= 2.2.1)
       whirly (= 0.3.0)
 

data/README.md

@@ -19,31 +19,40 @@
 
 ## What's SOULs?
 
-Welcome to SOULs Framework!
+Welcome to SOULs Serverless Application Framework!
 
-SOULs is a Serverless Application Framework. SOULs has four strains, API, Worker, Console, Media, and can be used in combination according to the purpose. SOULs Backend GraphQL Ruby & Frontend Relay are Scalable and Easy to deploy to Google Cloud and Amazon Web Services
-You can focus on business logic. No more infra problems.
+SOULs is a Serverless Application Framework with GraphQL. 
+SOULs has six strains, API, Worker, Console, Admin, Media, Doc, and can be used in combination according to the purpose. SOULs Backend GraphQL Ruby & Frontend Relay are Scalable and Easy to deploy to Google Cloud. No more routing for Backends!
+You can focus on your business logic. No more infra problems.
 
-SOULs creates 4 types of framework.
+SOULs creates 6 types of framework.
 
 1. API - GraphQL (Ruby) - Simple API - Cloud Run
 2. Worker - Google Pub/Sub Worker API (Ruby) - Cloud Run
-3. Media Web Client - Media web client with SSG (TypeScript)
+3. Console Web Client - User Console and CMS (TypeScript)
 4. Admin Web Client - Admin Console and CMS (TypeScript)
+5. Media Web Client - Media web client with SSG (TypeScript)
+6. Doc Web Client - Doc web client with SSG (TypeScript)
 
 ## Dependency
 
 - [Google SDK](https://cloud.google.com/sdk/docs)
 - [Docker](https://www.docker.com/)
 - [Firebase CLI](https://firebase.google.com/docs/cli)
+- [Ruby](https://www.ruby-lang.org)
 
 ## Cloud Infrastructure
 
-- [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine)
-- [Google Traffic Director](https://cloud.google.com/traffic-director)
 - [Google Cloud Run](https://cloud.google.com/run)
+- [Google Cloud SQL](https://cloud.google.com/sql)
+- [Google Cloud Pub/Sub](https://cloud.google.com/pubsub)
+- [Google Cloud Storage](https://cloud.google.com/run)
+- [Google Cloud IAM](https://cloud.google.com/iam)
+- [Google Cloud DNS](https://cloud.google.com/dns)
+- [Google Cloud Container Registry](https://cloud.google.com/container-registry)
 - [Google Firebase](https://firebase.google.com/)
 - [Google Cloud Scheduler](https://cloud.google.com/scheduler)
+- [Github Actions](https://github.com/features/actions)
 
 ## Installation
 
@@ -65,23 +74,55 @@ And Create Your APP
 
     $ souls new app_name
 
-### Choose SOULs Type:
+## Choose SOULs Type:
 
-1. API
-2. Worker
-3. Media Web
-4. Admin Web
+Select Strain:
+1. SOULs GraphQL API
+2. SOULs Worker
+3. SOULs Console Web
+4. SOULs Admin Web
+5. SOULs Media Web
+6. SOULs Doc Web
 
 
-## SOULs Document
+## Gemfile 自動更新アップデート
 
+`Gemfile`, `Gemfile.lock` を最新のバージョンに自動更新します。
+
+```
+souls gem:update
+```
+
+
+除外したい `gem` は `config/souls.rb` 内の
+`config.fixed_gems` の配列に追加します。
+
+
+```ruby
+Souls.configure do |config|
+  config.app = "souls-api"
+  config.project_id = "souls-api"
+  config.strain = "worker"
+  config.api_repo = "elsoul/souls_api"
+  config.worker_repo = "elsoul/souls_worker"
+  config.worker_endpoint = "https://worker.com"
+  config.fixed_gems = ["selenium-webdriver", "pg"]
+end
+```
+
+
+
+## SOULs Serverless Application Framework Document
+
+SOULs サーバーレスアプリケーションフレームワーク
+ドキュメントはこちらから
 - [SOULs Document](https://souls.elsoul.nl/)
 
 
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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](https://rubygems.org/gems/souls).
 

data/config/souls.rb

@@ -1,5 +1,9 @@
 Souls.configure do |config|
-  config.app = "souls-app"
-  config.project_id = "souls-app"
-  config.strain = "api"
+  config.app = "souls-api"
+  config.project_id = "souls-api"
+  config.strain = "worker"
+  config.api_repo = "elsoul/souls_api"
+  config.worker_repo = "elsoul/souls_worker"
+  config.worker_endpoint = "https://worker.com"
+  config.fixed_gems = []
 end

data/exe/souls

@@ -9,7 +9,7 @@ begin
   souls_command = ARGV[0]
   case souls_command
   when "new"
-    STRAINS = %w[api worker console admin media].freeze
+    STRAINS = %w[api worker console admin media doc].freeze
     app_name = ARGV[1]
     if app_name.nil?
       puts(Paint["you need to specify your app name", :red])
@@ -17,14 +17,15 @@ begin
       exit
     end
     first_message = Paint % [
-      "Select Strain: %{red_text} %{yellow_text} %{green_text} %{blue_text} %{cyan_text}",
+      "Select Strain: %{red_text} %{yellow_text} %{green_text} %{blue_text} %{cyan_text} %{magenta_text}",
       :white,
       {
         red_text: ["\n1. SOULs GraphQL API", :red],
-        yellow_text: ["\n2. SOULs Worker", :yellow],
+        yellow_text: ["\n2. SOULs Pub/Sub Worker", :yellow],
         green_text: ["\n3. SOULs Console Web", :green],
         blue_text: ["\n4. SOULs Admin Web", :blue],
-        cyan_text: ["\n5. SOULs Media Web", :cyan]
+        cyan_text: ["\n5. SOULs Media Web", :cyan],
+        magenta_text: ["\n6. SOULs Doc Web", :magenta]
       }
     ]
     puts(first_message)
@@ -39,7 +40,7 @@ begin
   when "s", "server"
     strain = Souls.configuration.strain
     case strain
-    when "media", "admin", "console"
+    when "media", "admin", "console", "doc"
       system("yarn dev")
     when "worker"
       system("bundle exec puma -p 3000 -e development")
@@ -49,7 +50,7 @@ begin
   when "c", "console"
     strain = Souls.configuration.strain
     case strain
-    when "media", "admin"
+    when "media", "admin", "console", "doc"
       system("yarn dev")
     else
       rack_env = ARGV[1]
@@ -68,7 +69,22 @@ begin
     Whirly.start(spinner: "clock", interval: 420, stop: "🎉") do
       Whirly.status = status
       send_method = ARGV[1]
-      Souls::Gcloud.public_send(send_method)
+
+      case send_method
+      when "create_pubsub_topic"
+        topic_name = ARGV[2]
+        args = { topic_name: topic_name }
+        Souls::Gcloud.public_send(send_method, args)
+      when "create_pubsub_subscription"
+        project_id = Souls.configuration.project_id
+        topic_name = ARGV[2]
+        service_account = "#{Souls.configuration.app}@#{project_id}iam.gserviceaccount.com"
+        endpoint = Souls.configuration.endpoint
+        args = { project_id: project_id, topic_name: topic_name, service_account: service_account, endpoint: endpoint }
+        Souls::Gcloud.public_send(send_method, args)
+      else
+        Souls::Gcloud.public_send(send_method)
+      end
       Whirly.status = "Done!"
     end
   when "-v", "--version"

data/lib/souls.rb

@@ -97,6 +97,7 @@ module Souls
         url = URI("https://rubygems.org/api/v1/versions/#{gem[0]}/latest.json")
         res = Net::HTTP.get_response(url)
         data = JSON.parse(res.body)
+        next if Souls.configuration.fixed_gems.include?(gem[0].to_s)
         next if data["version"].to_s == gem[1].to_s
 
         updated_lines << if from_dev
@@ -185,14 +186,16 @@ module Souls
   end
 
   class Configuration
-    attr_accessor :app, :strain, :project_id, :worker_name, :api_name
+    attr_accessor :app, :strain, :project_id, :worker_repo, :api_repo, :worker_endpoint, :fixed_gems
 
     def initialize
       @app = nil
       @project_id = nil
       @strain = nil
-      @worker_name = nil
-      @api_name = nil
+      @worker_repo = nil
+      @api_repo = nil
+      @worker_endpoint = nil
+      @fixed_gems = nil
     end
   end
 end

data/lib/souls/gcloud.rb

@@ -1,5 +1,6 @@
 require_relative "./gcloud/compute"
 require_relative "./gcloud/iam"
+require_relative "./gcloud/pubsub"
 
 module Souls
   module Gcloud

data/lib/souls/gcloud/compute.rb

@@ -1,71 +1,73 @@
 module Souls
   module Gcloud
-    def self.auth_login
-      project_id = Souls.configuration.project_id
-      system("gcloud config set project #{project_id}")
-      system("gcloud auth login")
-    end
+    class << self
+      def auth_login
+        project_id = Souls.configuration.project_id
+        system("gcloud config set project #{project_id}")
+        system("gcloud auth login")
+      end
 
-    def self.enable_permissions
-      system("gcloud services enable compute.googleapis.com")
-      puts("Operating permission to compute.googleapis.com ...")
-      system("gcloud services enable iam.googleapis.com")
-      puts("Operating permission to iam.googleapis.com ...")
-      system("gcloud services enable dns.googleapis.com")
-      puts("Operating permission to dns.googleapis.com ...")
-      system("gcloud services enable sqladmin.googleapis.com")
-      puts("Operating permission to sqladmin.googleapis.com ...")
-      system("gcloud services enable sql-component.googleapis.com")
-      puts("Operating permission to sql-component.googleapis.com ...")
-      system("gcloud services enable servicenetworking.googleapis.com")
-      puts("Operating permission to servicenetworking.googleapis.com ...")
-      system("gcloud services enable containerregistry.googleapis.com")
-      puts("Operating permission to containerregistry.googleapis.com")
-      system("gcloud services enable run.googleapis.com")
-      puts("Operating permission to run.googleapis.com")
-    end
+      def enable_permissions
+        system("gcloud services enable compute.googleapis.com")
+        puts("Operating permission to compute.googleapis.com ...")
+        system("gcloud services enable iam.googleapis.com")
+        puts("Operating permission to iam.googleapis.com ...")
+        system("gcloud services enable dns.googleapis.com")
+        puts("Operating permission to dns.googleapis.com ...")
+        system("gcloud services enable sqladmin.googleapis.com")
+        puts("Operating permission to sqladmin.googleapis.com ...")
+        system("gcloud services enable sql-component.googleapis.com")
+        puts("Operating permission to sql-component.googleapis.com ...")
+        system("gcloud services enable servicenetworking.googleapis.com")
+        puts("Operating permission to servicenetworking.googleapis.com ...")
+        system("gcloud services enable containerregistry.googleapis.com")
+        puts("Operating permission to containerregistry.googleapis.com")
+        system("gcloud services enable run.googleapis.com")
+        puts("Operating permission to run.googleapis.com")
+      end
 
-    def self.create_network
-      return "Error: Please Set Souls.configuration" if Souls.configuration.app.nil?
+      def create_network
+        return "Error: Please Set Souls.configuration" if Souls.configuration.app.nil?
 
-      network = Souls.configuration.app
-      system("gcloud compute networks create #{network}")
-    rescue StandardError => e
-      raise(StandardError, e)
-    end
+        network = Souls.configuration.app
+        system("gcloud compute networks create #{network}")
+      rescue StandardError => e
+        raise(StandardError, e)
+      end
 
-    def self.create_firewall(ip_range: "10.140.0.0/20")
-      network = Souls.configuration.app
-      system(
-        "gcloud compute firewall-rules create #{network}
-      --network #{network}
-      --allow tcp,udp,icmp
-      --source-ranges #{ip_range}"
-      )
-      system("gcloud compute firewall-rules create #{network}-ssh --network #{network} --allow tcp:22,tcp:3389,icmp")
-    end
+      def create_firewall(ip_range: "10.140.0.0/20")
+        network = Souls.configuration.app
+        system(
+          "gcloud compute firewall-rules create #{network}
+          --network #{network}
+          --allow tcp,udp,icmp
+          --source-ranges #{ip_range}"
+        )
+        system("gcloud compute firewall-rules create #{network}-ssh --network #{network} --allow tcp:22,tcp:3389,icmp")
+      end
 
-    def self.create_private_access
-      network = Souls.configuration.app
-      project_id = Souls.configuration.project_id
-      system(
-        "gcloud compute addresses create #{network}-my-network \
-      --global \
-      --purpose=VPC_PEERING \
-      --prefix-length=16 \
-      --description='peering range for SOULs' \
-      --network=#{network} \
-      --project=#{project_id}"
-      )
-    end
+      def create_private_access
+        network = Souls.configuration.app
+        project_id = Souls.configuration.project_id
+        system(
+          "gcloud compute addresses create #{network}-my-network \
+          --global \
+          --purpose=VPC_PEERING \
+          --prefix-length=16 \
+          --description='peering range for SOULs' \
+          --network=#{network} \
+          --project=#{project_id}"
+        )
+      end
 
-    def self.create_sql_instance(root_pass: "Postgre123!", zone: "asia-northeast1-b")
-      app = "#{Souls.configuration.app}-db"
-      system(
-        "gcloud sql instances create #{app}
-        --database-version=POSTGRES_13 --cpu=2 --memory=7680MB --zone=#{zone}
-        --root-password='#{root_pass}' --database-flags cloudsql.iam_authentication=on"
-      )
+      def create_sql_instance(root_pass: "Postgre123!", zone: "asia-northeast1-b")
+        app = "#{Souls.configuration.app}-db"
+        system(
+          "gcloud sql instances create #{app}
+            --database-version=POSTGRES_13 --cpu=2 --memory=7680MB --zone=#{zone}
+            --root-password='#{root_pass}' --database-flags cloudsql.iam_authentication=on"
+        )
+      end
     end
   end
 end

data/lib/souls/gcloud/iam.rb

@@ -1,30 +1,32 @@
 module Souls
   module Gcloud
-    def self.create_service_account(service_account: "souls-app")
-      `gcloud iam service-accounts create #{service_account} \
-      --description="Souls Service Account" \
-      --display-name="#{service_account}"`
-    end
+    class << self
+      def create_service_account(service_account: "souls-app")
+        `gcloud iam service-accounts create #{service_account} \
+        --description="Souls Service Account" \
+        --display-name="#{service_account}"`
+      end
 
-    def self.create_service_account_key(service_account: "souls-app")
-      project_id = Souls.configuration.project_id
-      `gcloud iam service-accounts keys create ./config/keyfile.json \
-        --iam-account #{service_account}@#{project_id}.iam.gserviceaccount.com`
-    end
+      def create_service_account_key(service_account: "souls-app")
+        project_id = Souls.configuration.project_id
+        `gcloud iam service-accounts keys create ./config/keyfile.json \
+          --iam-account #{service_account}@#{project_id}.iam.gserviceaccount.com`
+      end
 
-    def self.add_service_account_role(service_account: "souls-app", role: "roles/firebase.admin")
-      project_id = Souls.configuration.project_id
-      `gcloud projects add-iam-policy-binding #{project_id} \
-      --member="serviceAccount:#{service_account}@#{project_id}.iam.gserviceaccount.com" \
-      --role="#{role}"`
-    end
+      def add_service_account_role(service_account: "souls-app", role: "roles/firebase.admin")
+        project_id = Souls.configuration.project_id
+        `gcloud projects add-iam-policy-binding #{project_id} \
+        --member="serviceAccount:#{service_account}@#{project_id}.iam.gserviceaccount.com" \
+        --role="#{role}"`
+      end
 
-    def self.add_permissions(service_account: "souls-app")
-      add_service_account_role(service_account: service_account, role: "roles/cloudsql.serviceAgent")
-      add_service_account_role(service_account: service_account, role: "roles/containerregistry.ServiceAgent")
-      add_service_account_role(service_account: service_account, role: "roles/pubsub.serviceAgent")
-      add_service_account_role(service_account: service_account, role: "roles/firestore.serviceAgent")
-      add_service_account_role(service_account: service_account, role: "roles/iam.serviceAccountUser")
+      def add_permissions(service_account: "souls-app")
+        add_service_account_role(service_account: service_account, role: "roles/cloudsql.serviceAgent")
+        add_service_account_role(service_account: service_account, role: "roles/containerregistry.ServiceAgent")
+        add_service_account_role(service_account: service_account, role: "roles/pubsub.serviceAgent")
+        add_service_account_role(service_account: service_account, role: "roles/firestore.serviceAgent")
+        add_service_account_role(service_account: service_account, role: "roles/iam.serviceAccountUser")
+      end
     end
   end
 end

data/lib/souls/gcloud/pubsub.rb

@@ -0,0 +1,21 @@
+module Souls
+  module Gcloud
+    class << self
+      def create_pubsub_topic(args)
+        system("gcloud pubsub topics create #{args[:topic_name]}")
+      end
+
+      def create_pubsub_subscription(args)
+        system(
+          "gcloud pubsub subscriptions create #{args[:topic_name]}-sub \
+          --topic #{args[:topic_name]} \
+          --topic-project #{args[:project_id]} \
+          --push-auth-service-account #{args[:service_account]} \
+          --push-endpoint #{args[:endpoint]} \
+          --expiration-period never
+           "
+        )
+      end
+    end
+  end
+end

data/lib/souls/version.rb

@@ -1,4 +1,4 @@
 module Souls
-  VERSION = "0.23.6".freeze
+  VERSION = "0.24.0".freeze
   public_constant :VERSION
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: souls
 version: !ruby/object:Gem::Version
-  version: 0.23.6
+  version: 0.24.0
 platform: ruby
 authors:
 - POPPIN-FUMI
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paint
@@ -75,6 +75,7 @@ files:
 - lib/souls/gcloud.rb
 - lib/souls/gcloud/compute.rb
 - lib/souls/gcloud/iam.rb
+- lib/souls/gcloud/pubsub.rb
 - lib/souls/generate.rb
 - lib/souls/generate/application.rb
 - lib/souls/generate/connection.rb