gcp_scheduler 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a9e2f3c9ca228ac9fa5751a87c9beba2ec73b8e38e0c2b1ef513d766178fc5
-  data.tar.gz: 255d18bd2a649d13fc24b1103c209aeaf2c29268f3f887e5720de376192059b8
+  metadata.gz: 7af3f302364000fb0d985aba456e67f317d5440a88bb0fa5d8a3ca1244d88d7a
+  data.tar.gz: 4c9ff3b6de8d2a3a2d7fb85325ff225f4b2732b8eb25d3a83b826aad6bfce166
 SHA512:
-  metadata.gz: 4a1a0bb5870a8fcbd739b00f394b6be7abb39b62142531383e200e5f8c2b7c2930b9bbadcbe73dc16482400de3e05898c520bdc2449c358d842aff35a4d23ee1
-  data.tar.gz: fc388ea4d13736d703a92f7f4098918c41c8d8648b03ac96f3549f78c5a9c3377f7db7e228f9e4cece9d0636a49bc9813fbf68d20bd2574e3060f16fe45aa01c
+  metadata.gz: 8507df6b58fd4d850012b0bb6b07718520aa530eb16eb4f6f593a9f2dbc0eaa4a116d2ad08384e90a0c90b227a723596dc63a846bd860b9ec7cb2b995cc1eb8e
+  data.tar.gz: '0685803c80df3a9f6ceb7c8dcd8f4031111bc8afce323b9f1d4ac9f185337904f2d7c077a2dba2c3aa5708d9f74e3d3a31af4e5217635db79d466b1961aa1ea0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gcp_scheduler (0.1.0)
+    gcp_scheduler (0.2.1)
       activesupport
       google-cloud-scheduler-v1 (>= 0.7.0)
       thor
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -42,14 +42,14 @@ GEM
       gapic-common (>= 0.18.0, < 2.a)
       google-cloud-errors (~> 1.0)
       google-cloud-location (>= 0.4, < 2.a)
-    google-protobuf (3.22.3-x86_64-darwin)
-    google-protobuf (3.22.3-x86_64-linux)
+    google-protobuf (3.25.2-x86_64-darwin)
+    google-protobuf (3.25.2-x86_64-linux)
     googleapis-common-protos (1.4.0)
       google-protobuf (~> 3.14)
       googleapis-common-protos-types (~> 1.2)
       grpc (~> 1.27)
-    googleapis-common-protos-types (1.5.0)
-      google-protobuf (~> 3.14)
+    googleapis-common-protos-types (1.11.0)
+      google-protobuf (~> 3.18)
     googleauth (1.5.2)
       faraday (>= 0.17.3, < 3.a)
       jwt (>= 1.4, < 3.0)
@@ -57,18 +57,18 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
-    grpc (1.54.0-x86_64-darwin)
-      google-protobuf (~> 3.21)
+    grpc (1.61.0-x86_64-darwin)
+      google-protobuf (~> 3.25)
       googleapis-common-protos-types (~> 1.0)
-    grpc (1.54.0-x86_64-linux)
-      google-protobuf (~> 3.21)
+    grpc (1.61.0-x86_64-linux)
+      google-protobuf (~> 3.25)
       googleapis-common-protos-types (~> 1.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     jwt (2.7.0)
     memoist (0.16.2)
     method_source (1.0.0)
-    minitest (5.18.0)
+    minitest (5.19.0)
     multi_json (1.15.0)
     os (1.1.4)
     pry (0.14.2)
@@ -103,6 +103,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -59,16 +59,16 @@ gcp_scheduler delete --gcp_project your_project_name --prefix development- --reg
 ```yaml
 jobs:
   - name: WeeklyJob
-    description: "Runs every week at 9:00 a.m. Created:<%= Time.now.strftime("%Y/%m/%d %-H:%M") %>"
+    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"
+    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'] %>"
+      Authorization: 'Bearer <%= ENV["SECRET"] %>'
 ```
 
 ## Contributing

data/gcp_scheduler.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH.push File.expand_path("lib", __dir__)
 
 Gem::Specification.new do |s|
   s.name        = "gcp_scheduler"
-  s.version     = "0.1.0"
+  s.version     = "0.2.1"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Akira Kusumoto"]
   s.email       = ["akirakusumo10@gmail.com"]

data/lib/gcp_scheduler/command.rb

@@ -27,10 +27,9 @@ module GcpScheduler
     end
 
     def create(scheduler_file_path:, prefix: "")
-      Scheduler.scheduler_config(scheduler_file_path)[:jobs].each do |job|
-        scheduler_name = "#{prefix}#{job[:name]}"
-        puts "Create #{scheduler_name}"
-        scheduler.create_job(name:        scheduler_name,
+      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],
@@ -38,7 +37,7 @@ module GcpScheduler
                              params:      job[:params],
                              http_method: job[:http_method],
                              headers:     job[:http_headers])
-        puts "Created #{scheduler_name}"
+        puts "Created #{job[:name]}"
       end
     end
   end

data/lib/gcp_scheduler/scheduler.rb

@@ -6,6 +6,13 @@ module GcpScheduler
       def scheduler_config(file_path)
         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
 
     def initialize(project:, location:)
@@ -37,11 +44,15 @@ module GcpScheduler
         http_target: {
           uri:         uri,
           http_method: http_method,
-          body:        params.to_json,
+          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/spec/fixtures/scheduler.yml

@@ -1,12 +1,12 @@
 jobs:
   - name: WeeklyJob
-    description: "Runs every week at 9:00 a.m. Created:<%= Time.now.strftime("%Y/%m/%d %-H:%M") %>"
+    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"
+    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'] %>"
+      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

@@ -27,4 +27,60 @@ describe GcpScheduler::Scheduler do
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gcp_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Akira Kusumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -106,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
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: A command-line interface for managing Google Cloud Scheduler jobs with ease