gcp_scheduler 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62cbc3423620cda69674fa0d2b0d84eba999a2b9b7c4644770461721d798e6b7
-  data.tar.gz: 237263736fd1e7786d65749bf0a3d4b297ee045ad37371a704ac08ae23c0de59
+  metadata.gz: f8ac6e8722729145a8554094fd36c0f6fbca375ceee2dbb22dabb8000da4fff5
+  data.tar.gz: dac2f9c3a07478d3eb8e234dad0c1f0049a7ae022689150c1e3b1ad6339cc777
 SHA512:
-  metadata.gz: 7e3431c095b0806934a1288c5f0e781037f38bc0890e394e5b9ed8aabb01ab1573abfa01016474db7ed487d653446044950b12865c2ef4290817581c7388d035
-  data.tar.gz: 231ed0ea3846239aa1b95b34372325481a18325afa51ef9973479caa9b4c73779a8ee1a2c83e7d911386f4ab501b96328164d38c620dbeb030bc3791c87a5fa1
+  metadata.gz: 44a5afe8aecd424d1ece6110bb9c86fd19eb0c768da90a2644197a194d2c3ce1c3eb48c6e31f6fae912e1639cb1585adcf9ba8273c3a892ab5cdb54183a09cf1
+  data.tar.gz: d5f9cc18e76b649b9a5581b4a67964dd181b37e72d7aa175c6514a6f019fc90f355d8e1f794807037d9848888fb1b7f96741e20392f7eec0e4fc1de3bafc1fbe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gcp_scheduler (0.0.1)
+    gcp_scheduler (0.2.0)
       activesupport
       google-cloud-scheduler-v1 (>= 0.7.0)
       thor

data/README.md

@@ -22,15 +22,12 @@ export GOOGLE_APPLICATION_CREDENTIALS=your_credential.json
 ### ジョブの作成
 
 ```
-gcp_scheduler create --gcp_project your_project_name --scheduler_file path/to/scheduler.yml --uri https://your_domain.example.com --prefix development- --region asia-northeast1 --secret your_secret_token
+gcp_scheduler create --gcp_project your_project_name --scheduler_file path/to/scheduler.yml --prefix development- --region asia-northeast1
 ```
 
 - scheduler_fileを元にジョブを作成します。
 - prefixは、ジョブ名に付与されるプレフィックスです。
 - regionは、Cloud Schedulerのリージョンです。
-- uriは、スケジューラーがHTTP POSTを実行するURLです。
-- すべてのジョブは一つのURLにapplication/jsonでリクエストパラメータのjob_nameにscheduler_fileのjob名が入ります。
-- secretは、Http Authorization Header Bearer tokenです。
 
 ### ジョブの一覧表示
 
@@ -52,18 +49,26 @@ gcp_scheduler delete --gcp_project your_project_name --prefix development- --reg
 |---|-------------------------------------------------------------------------------------------|
 | `--gcp_project` | Google Cloud project name                                                                 |
 | `--scheduler_file` | Path to the scheduler configuration file (used with `create` command)                     |
-| `--uri` | URL of the endpoint to be executed by the job (used with `create` command)                |
 | `--prefix` | Prefix for the job name (used with `create`, `list`, and `delete` commands)               |
 | `--region` | Cloud Scheduler region                                                                    |
-| `--secret` | Http Authorization Header Bearer token to be sent by the job (used with `create` command) |
 
 ## scheduler.yml file
 
-scheduler.ymlファイルは、ジョブのスケジュール情報を定義するために使用されます。以下は、scheduler.ymlファイルのサンプルです。
+`--scheduler_file`オプションでyamlファイルを指定してください。スケジュールを定義するために使用されます。以下は、scheduler.ymlファイルのサンプルです。
 
 ```yaml
-weekly_job:
-  cron: '0 9 * * 1'
+jobs:
+  - name: WeeklyJob
+    description: 'Runs every week at 9:00 a.m. Created:<%= Time.now.strftime("%Y/%m/%d %-H:%M") %>'
+    schedule: '0 9 * * *'
+    time_zone: Asia/Tokyo
+    uri: https://yourdomain.example.com/api/v1/jobs
+    http_method: POST
+    params:
+      job_name: weekly_job
+    http_headers:
+      Content-Type: application/json
+      Authorization: 'Bearer <%= ENV["SECRET"] %>'
 ```
 
 ## Contributing

data/gcp_scheduler.gemspec

@@ -2,13 +2,13 @@ $LOAD_PATH.push File.expand_path("lib", __dir__)
 
 Gem::Specification.new do |s|
   s.name        = "gcp_scheduler"
-  s.version     = "0.0.1"
+  s.version     = "0.2.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Akira Kusumoto"]
   s.email       = ["akirakusumo10@gmail.com"]
   s.homepage    = "https://github.com/bluerabbit/gcp_scheduler"
   s.summary     = "A command-line interface for managing Google Cloud Scheduler jobs with ease"
-  s.description = "GCP Scheduler CLI is a Ruby gem that provides a simple command-line interface for managing Google Cloud Scheduler jobs. With this tool, you can create, list, and delete Cloud Scheduler jobs using intuitive commands. It streamlines job management tasks by allowing you to define job schedules in a YAML file and supports custom job prefixes, regions, and authentication tokens."
+  s.description = "GCP Scheduler is a Ruby gem that provides a simple command-line interface for managing Google Cloud Scheduler jobs. With this tool, you can create, list, and delete Cloud Scheduler jobs using intuitive commands. It streamlines job management tasks by allowing you to define job schedules in a YAML file."
 
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]

data/lib/gcp_scheduler/cli.rb

@@ -34,20 +34,14 @@ module GcpScheduler
 
     desc "create", "Create schedules from scheduler.yml"
     method_option :gcp_project, type: :string, required: true
-    method_option :region, type: :string, default: "asia-northeast1"
-    method_option :prefix, type: :string, default: ""
+    method_option :region, type: :string, required: true
     method_option :scheduler_file, type: :string, required: true
-    method_option :uri, type: :string, required: true
-    method_option :secret, type: :string, default: ""
-    method_option :time_zone, type: :string, default: "Etc/UTC"
+    method_option :prefix, type: :string, default: ""
     def create
       GcpScheduler.create(gcp_project:         options[:gcp_project],
                           region:              options[:region],
                           prefix:              options[:prefix],
-                          scheduler_file_path: options[:scheduler_file],
-                          uri:                 options[:uri],
-                          secret:              options[:secret],
-                          time_zone:           options[:time_zone])
+                          scheduler_file_path: options[:scheduler_file])
     end
 
     desc "version", "Show Version"

data/lib/gcp_scheduler/command.rb

@@ -1,42 +1,43 @@
 module GcpScheduler
   class Command
-    class << self
-      def list(gcp_project:, region:, prefix: "")
-        scheduler = Scheduler.new(project: gcp_project, location: region)
-        scheduler.jobs.each do |job|
-          scheduler_name = job.name.split("/").last
-          next unless scheduler_name.start_with?(prefix)
+    attr_reader :scheduler
 
-          puts "- name:#{scheduler_name} description:#{job.description} schedule:#{job.schedule}"
-        end
+    def initialize(gcp_project:, region:)
+      @scheduler = Scheduler.new(project: gcp_project, location: region)
+    end
+
+    def list(prefix: "")
+      scheduler.jobs.each do |job|
+        scheduler_name = job.name.split("/").last
+        next unless scheduler_name.start_with?(prefix)
+
+        puts "- name:#{scheduler_name} description:#{job.description} schedule:#{job.schedule}"
       end
+    end
 
-      def delete(gcp_project:, region:, prefix: "")
-        scheduler = Scheduler.new(project: gcp_project, location: region)
-        scheduler.jobs.each do |job|
-          scheduler_name = job.name.split("/").last
-          next unless scheduler_name.start_with?(prefix)
+    def delete(prefix: "")
+      scheduler.jobs.each do |job|
+        scheduler_name = job.name.split("/").last
+        next unless scheduler_name.start_with?(prefix)
 
-          puts "Delete #{scheduler_name}"
-          scheduler.delete_job(scheduler_name)
-          puts "Deleted #{scheduler_name}"
-        end
+        puts "Delete #{scheduler_name}"
+        scheduler.delete_job(scheduler_name)
+        puts "Deleted #{scheduler_name}"
       end
+    end
 
-      def create(gcp_project:, region:, scheduler_file_path:, uri:, secret:, time_zone:, prefix: "")
-        scheduler = Scheduler.new(project: gcp_project, location: region)
-        Scheduler.scheduler_config(scheduler_file_path).each do |name, h|
-          scheduler_name = "#{prefix}#{name}"
-          puts "Create #{scheduler_name}"
-          scheduler.create_job(name:        scheduler_name,
-                               description: "#{h["class"]} CreatedAt:#{Time.current.strftime("%Y/%m/%d %-H:%M")}",
-                               uri:         uri,
-                               schedule:    h["cron"],
-                               params:      { job_name: name },
-                               secret:      secret,
-                               time_zone:   time_zone)
-          puts "Created #{scheduler_name}"
-        end
+    def create(scheduler_file_path:, prefix: "")
+      Scheduler.scheduler_config_jobs(file_path: scheduler_file_path, job_name_prefix: prefix).each do |job|
+        puts "Create #{job[:name]}"
+        scheduler.create_job(name:        job[:name],
+                             description: job[:description],
+                             uri:         job[:uri],
+                             schedule:    job[:schedule],
+                             time_zone:   job[:time_zone],
+                             params:      job[:params],
+                             http_method: job[:http_method],
+                             headers:     job[:http_headers])
+        puts "Created #{job[:name]}"
       end
     end
   end

data/lib/gcp_scheduler/scheduler.rb

@@ -4,7 +4,14 @@ module GcpScheduler
 
     class << self
       def scheduler_config(file_path)
-        YAML.load(ERB.new(File.read(file_path)).result).with_indifferent_access
+        YAML.safe_load(ERB.new(File.read(file_path)).result, aliases: true).with_indifferent_access
+      end
+
+      def scheduler_config_jobs(file_path:, job_name_prefix: "")
+        config = scheduler_config(file_path)
+        config[:jobs].map do |job|
+          (config[:defaults] || {}).merge(job.merge(name: "#{job_name_prefix}#{job[:name]}")).with_indifferent_access
+        end
       end
     end
 
@@ -24,8 +31,9 @@ module GcpScheduler
                    description:,
                    uri:,
                    schedule:,
-                   secret:, time_zone:, params: {},
-                   http_method: :POST,
+                   time_zone:,
+                   params: {},
+                   http_method:,
                    headers: {})
 
       job = {
@@ -36,17 +44,15 @@ module GcpScheduler
         http_target: {
           uri:         uri,
           http_method: http_method,
-          body:        params.to_json,
-          headers:     headers.merge(
-            {
-              "Authorization" => "Bearer #{secret}",
-              "Content-Type"  => "application/json",
-              "User-Agent"    => "Google-Cloud-Scheduler",
-            },
-          ),
+          body:        params,
+          headers:     headers
         },
       }
 
+      if params.present? && headers["Content-Type"] == "application/json"
+        job[:http_target][:body] = params.to_json
+      end
+
       client.create_job parent: parent, job: job
     end
 

data/lib/gcp_scheduler.rb

@@ -10,21 +10,18 @@ module GcpScheduler
 
   class << self
     def list(gcp_project:, region:, prefix: "")
-      GcpScheduler::Command.list(gcp_project: gcp_project, prefix: prefix, region: region)
+      command = GcpScheduler::Command.new(gcp_project: gcp_project, region: region)
+      command.list(prefix: prefix)
     end
 
     def delete(gcp_project:, region:, prefix: "")
-      GcpScheduler::Command.delete(gcp_project: gcp_project, prefix: prefix, region: region)
+      command = GcpScheduler::Command.new(gcp_project: gcp_project, region: region)
+      command.delete(prefix: prefix)
     end
 
-    def create(gcp_project:, region:, scheduler_file_path:, uri:, secret:, time_zone:, prefix: "")
-      GcpScheduler::Command.create(gcp_project:         gcp_project,
-                                   region:              region,
-                                   prefix:              prefix,
-                                   scheduler_file_path: scheduler_file_path,
-                                   uri:                 uri,
-                                   secret:              secret,
-                                   time_zone:           time_zone)
+    def create(gcp_project:, region:, scheduler_file_path:, prefix: "")
+      command = GcpScheduler::Command.new(gcp_project: gcp_project, region: region)
+      command.create(prefix: prefix, scheduler_file_path: scheduler_file_path)
     end
   end
 end

data/spec/fixtures/scheduler.yml

@@ -1,2 +1,12 @@
-weekly_job:
-  cron: '0 9 * * 1'
+jobs:
+  - name: WeeklyJob
+    description: 'Runs every week at 9:00 a.m. Created:<%= Time.now.strftime("%Y/%m/%d %-H:%M") %>'
+    schedule: '0 9 * * *'
+    time_zone: Asia/Tokyo
+    uri: https://yourdomain.example.com/api/v1/jobs
+    http_method: POST
+    params:
+      job_name: weekly_job
+    http_headers:
+      Content-Type: application/json
+      Authorization: 'Bearer <%= ENV["SECRET"] %>'

data/spec/fixtures/scheduler_with_defaults.yml

@@ -0,0 +1,19 @@
+defaults:
+  uri: https://yourdomain.example.com/api/v1/jobs
+  http_method: POST
+  time_zone: Asia/Tokyo
+  http_headers:
+    Authorization: 'Bearer <%= ENV["SECRET"] %>'
+    Content-Type: application/json
+
+jobs:
+  - name: WeeklyJob
+    description: 'Runs every week at 9:00 a.m. Created:<%= Time.now.strftime("%Y/%m/%d %-H:%M") %>'
+    schedule: '0 9 * * *'
+    params:
+      job_name: weekly_job
+  - name: DailyJob
+    description: 'Runs every day at 10:30 a.m. Created:<%= Time.now.strftime("%Y/%m/%d %-H:%M") %>'
+    schedule: '30 10 * * *'
+    params:
+      job_name: daily_job

data/spec/gcp_scheduler/scheduler_spec.rb

@@ -2,10 +2,85 @@ require "spec_helper"
 
 describe GcpScheduler::Scheduler do
   describe "#scheduler_config" do
+    before do
+      travel_to Time.parse("2023/4/1 10:00")
+      ENV["SECRET"] = "secret_key"
+    end
+
+    after do
+      travel_back
+    end
+
     it do
-      path = fixture_path("scheduler.yml")
+      path   = fixture_path("scheduler.yml")
       config = GcpScheduler::Scheduler.scheduler_config(path)
-      expect(config).to eq({ "weekly_job" => { "cron" => "0 9 * * 1" } })
+      jobs   = config[:jobs]
+      expect(jobs.size).to eq(1)
+      job = jobs.first
+      expect(job[:params]).to eq({ "job_name" => "weekly_job" })
+      expect(job[:time_zone]).to eq("Asia/Tokyo")
+      expect(job[:description]).to eq("Runs every week at 9:00 a.m. Created:2023/04/01 10:00")
+      expect(job[:http_headers]).to eq("Authorization" => "Bearer secret_key", "Content-Type" => "application/json")
+      expect(job[:http_method]).to eq("POST")
+      expect(job[:name]).to eq("WeeklyJob")
+      expect(job[:schedule]).to eq("0 9 * * *")
+      expect(job[:uri]).to eq("https://yourdomain.example.com/api/v1/jobs")
+    end
+  end
+
+  describe "#scheduler_config_jobs" do
+    before do
+      travel_to Time.parse("2023/4/1 11:00")
+      ENV["SECRET"] = "secret_key"
+    end
+
+    after do
+      travel_back
+    end
+
+    it "Configuration file with default settings" do
+      path = fixture_path("scheduler_with_defaults.yml")
+      jobs = GcpScheduler::Scheduler.scheduler_config_jobs(file_path:       path,
+                                                           job_name_prefix: "rspec-")
+
+      expect(jobs.size).to eq(2)
+      weekly_job = jobs.first
+      expect(weekly_job[:name]).to eq("rspec-WeeklyJob")
+      expect(weekly_job[:params]).to eq({ "job_name" => "weekly_job" })
+      expect(weekly_job[:description]).to eq("Runs every week at 9:00 a.m. Created:2023/04/01 11:00")
+      expect(weekly_job[:schedule]).to eq("0 9 * * *")
+
+      daily_job = jobs.last
+      expect(daily_job[:name]).to eq("rspec-DailyJob")
+      expect(daily_job[:params]).to eq({ "job_name" => "daily_job" })
+      expect(daily_job[:description]).to eq("Runs every day at 10:30 a.m. Created:2023/04/01 11:00")
+      expect(daily_job[:schedule]).to eq("30 10 * * *")
+
+      # defaults
+      jobs.each do |job|
+        expect(job[:uri]).to eq("https://yourdomain.example.com/api/v1/jobs")
+        expect(job[:http_method]).to eq("POST")
+        expect(job[:time_zone]).to eq("Asia/Tokyo")
+        http_headers = { "Authorization" => "Bearer secret_key", "Content-Type" => "application/json" }
+        expect(job[:http_headers]).to eq(http_headers)
+      end
+    end
+
+    it "Configuration file without default settings" do
+      path = fixture_path("scheduler.yml")
+      jobs = GcpScheduler::Scheduler.scheduler_config_jobs(file_path:       path,
+                                                           job_name_prefix: "rspec-")
+
+      expect(jobs.size).to eq(1)
+      job = jobs.first
+      expect(job[:name]).to eq("rspec-WeeklyJob")
+      expect(job[:description]).to eq("Runs every week at 9:00 a.m. Created:2023/04/01 11:00")
+      expect(job[:schedule]).to eq("0 9 * * *")
+      expect(job[:time_zone]).to eq("Asia/Tokyo")
+      expect(job[:uri]).to eq("https://yourdomain.example.com/api/v1/jobs")
+      expect(job[:http_method]).to eq("POST")
+      expect(job[:params]).to eq({ "job_name" => "weekly_job" })
+      expect(job[:http_headers]).to eq("Authorization" => "Bearer secret_key", "Content-Type" => "application/json")
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 require "pry"
 require "rspec"
-
+require "active_support/testing/time_helpers"
 require "gcp_scheduler"
 require_relative "support/path"
 
 RSpec.configure do |config|
   config.include Spec::Path
+  config.include ActiveSupport::Testing::TimeHelpers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gcp_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Akira Kusumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,11 +80,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: GCP Scheduler CLI is a Ruby gem that provides a simple command-line interface
+description: GCP Scheduler is a Ruby gem that provides a simple command-line interface
   for managing Google Cloud Scheduler jobs. With this tool, you can create, list,
   and delete Cloud Scheduler jobs using intuitive commands. It streamlines job management
-  tasks by allowing you to define job schedules in a YAML file and supports custom
-  job prefixes, regions, and authentication tokens.
+  tasks by allowing you to define job schedules in a YAML file.
 email:
 - akirakusumo10@gmail.com
 executables:
@@ -107,6 +106,7 @@ files:
 - lib/gcp_scheduler/command.rb
 - lib/gcp_scheduler/scheduler.rb
 - spec/fixtures/scheduler.yml
+- spec/fixtures/scheduler_with_defaults.yml
 - spec/gcp_scheduler/scheduler_spec.rb
 - spec/gcp_scheduler_spec.rb
 - spec/spec_helper.rb