heroku_hatchet 3.1.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2363b4e6ad949febf29929396202ad62215d4b8442fab1a5701273dc6356e0e8
-  data.tar.gz: 2834674840abffb9e1bdcf944629c6b00dc987fb17db61685a5b4e15f29bbd71
+  metadata.gz: cb7387bbf480ee1443a1985b8bfd3681e6126605786c0ee102be9a691cd37f01
+  data.tar.gz: 59876cc8324d6397434dbb03492a6d1231023c343aa6a70a61502cc5d8059fdc
 SHA512:
-  metadata.gz: 0ba670133988a7297d8573c69c488bfdb4450cb5420778f372475a1523bd482cf40bd5fb1e4299e6118dd46fb3cb78cabed819099bdd56a0caa71c57ff6e8692
-  data.tar.gz: 4bf38e97b2afd7524e1ff81cac1fa1b4fb0cb8dbcd4fe62e49039aacdf79706def80b2ee8e8fe4a079355db559471895a42deec37e7304a94d31f4cc2ca985ff
+  metadata.gz: 95998e8ab947245d1ebc799fd6bf54b377bffda5e4b63f608aa2663e55e278d71d307754a6d2a623e66e8ff07dcbd04d1b30f4d3ab666b5b1e9856b78f22e645
+  data.tar.gz: 7554ca9897c18aa4022526a5e9deba8f05475797f57b5635dc51658797c92390556ea12fcdc66bad6567cbf8a3fb3ab72ae1408d41345bba95fe0d904f2851df

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## HEAD
 
+## 4.0.0
+
+- Introduce API rate limiting (#46)
+- Deprecate App#platform_api method (#46)
+
 ## 3.1.1
 
 - Better errors when no lockfile is found #43

data/bin/hatchet

@@ -22,9 +22,11 @@ class HatchetCLI < Thor
     warn_dot_ignore!
     lock_hash = load_lockfile
     puts "Installing repos for hatchet"
+
+    missing_commit = false
     dirs.map do |directory, git_repo|
       Threaded.later do
-        commit = lock_hash.fetch(directory) { raise "expected #{directory} to be locked but it is not, please run `hatchet lock` and commit the results"}
+        commit = lock_hash[directory]
         directory = File.expand_path(directory)
         if Dir[directory].present?
           puts "== pulling '#{git_repo}' into '#{directory}'\n"
@@ -33,9 +35,15 @@ class HatchetCLI < Thor
           puts "== cloning '#{git_repo}' into '#{directory}'\n"
           clone(directory, git_repo)
         end
-        checkout_commit(directory, commit)
+        if commit
+          checkout_commit(directory, commit)
+        else
+          missing_commit = true
+        end
       end
     end.map(&:join)
+
+    self.lock if missing_commit
   end
 
   def load_lockfile

data/lib/hatchet.rb

@@ -17,6 +17,7 @@ require 'hatchet/app'
 require 'hatchet/anvil_app'
 require 'hatchet/git_app'
 require 'hatchet/config'
+require 'hatchet/api_rate_limit'
 
 module Hatchet
   RETRIES = Integer(ENV['HATCHET_RETRIES']   || 1)

data/lib/hatchet/api_rate_limit.rb

@@ -0,0 +1,40 @@
+# Wraps platform-api and adds API rate limits
+#
+# Instead of:
+#
+#     platform_api.pipeline.create(name: @name)
+#
+# Use:
+#
+#     api_rate_limit = ApiRateLimit.new(platform_api)
+#     api_rate_limit.call.pipeline.create(name: @name)
+#
+class ApiRateLimit
+  def initialize(platform_api)
+    @platform_api = platform_api
+    @capacity = 1
+    @called   = 0
+  end
+
+
+  # Sleeps for progressively longer when api rate limit capacity
+  # is lower.
+  #
+  # Unfortunatley `@platform_api.rate_limit` is an extra API
+  # call, so by checking our limit, we also are using our limit 😬
+  # to partially mitigate this, only check capacity every 5
+  # api calls, or if the
+  def call
+    @called += 1
+
+    if @called > 5 || @capacity < 1000
+      @called = 0
+      @capacity = @platform_api.rate_limit.info["remaining"]
+    end
+
+    sleep_time = (60/@capacity) if @capacity > 0.1 # no divide by zero
+    sleep(sleep_time || 60)
+
+    return @platform_api
+  end
+end

data/lib/hatchet/app.rb

@@ -31,7 +31,7 @@ module Hatchet
       @labs          = ([] << options[:labs]).flatten.compact
       @buildpacks    = options[:buildpack] || options[:buildpacks] || options[:buildpack_url] || self.class.default_buildpack
       @buildpacks    = Array(@buildpacks)
-      @reaper        = Reaper.new(platform_api: platform_api)
+      @reaper        = Reaper.new(api_rate_limit: api_rate_limit)
     end
 
     def self.default_buildpack
@@ -54,13 +54,13 @@ module Hatchet
     def set_config(options = {})
       options.each do |key, value|
         # heroku.put_config_vars(name, key => value)
-        platform_api.config_var.update(name, key => value)
+        api_rate_limit.call.config_var.update(name, key => value)
       end
     end
 
     def get_config
       # heroku.get_config_vars(name).body
-      platform_api.config_var.info_for_app(name)
+      api_rate_limit.call.config_var.info_for_app(name)
     end
 
     def lab_is_installed?(lab)
@@ -69,7 +69,7 @@ module Hatchet
 
     def get_labs
       # heroku.get_features(name).body
-      platform_api.app_feature.list(name)
+      api_rate_limit.call.app_feature.list(name)
     end
 
     def set_labs!
@@ -78,13 +78,13 @@ module Hatchet
 
     def set_lab(lab)
       # heroku.post_feature(lab, name)
-      platform_api.app_feature.update(name, lab, enabled: true)
+      api_rate_limit.call.app_feature.update(name, lab, enabled: true)
     end
 
     def add_database(plan_name = 'heroku-postgresql:dev', match_val = "HEROKU_POSTGRESQL_[A-Z]+_URL")
       Hatchet::RETRIES.times.retry do
         # heroku.post_addon(name, plan_name)
-        platform_api.addon.create(name, plan: plan_name )
+        api_rate_limit.call.addon.create(name, plan: plan_name )
         _, value = get_config.detect {|k, v| k.match(/#{match_val}/) }
         set_config('DATABASE_URL' => value)
       end
@@ -120,7 +120,7 @@ module Hatchet
 
     def deployed?
       # !heroku.get_ps(name).body.detect {|ps| ps["process"].include?("web") }.nil?
-      platform_api.formation.list(name).detect {|ps| ps["type"] == "web"}
+      api_rate_limit.call.formation.list(name).detect {|ps| ps["type"] == "web"}
     end
 
     def create_app
@@ -129,7 +129,7 @@ module Hatchet
           # heroku.post_app({ name: name, stack: stack }.delete_if {|k,v| v.nil? })
           hash = { name: name, stack: stack }
           hash.delete_if { |k,v| v.nil? }
-          platform_api.app.create(hash)
+          api_rate_limit.call.app.create(hash)
         rescue
           @reaper.cycle
           raise e
@@ -139,7 +139,7 @@ module Hatchet
 
     def update_stack(stack_name)
       @stack = stack_name
-      platform_api.app.update(name, build_stack: @stack)
+      api_rate_limit.call.app.update(name, build_stack: @stack)
     end
 
     # creates a new heroku app via the API
@@ -150,7 +150,7 @@ module Hatchet
       set_labs!
       # heroku.put_config_vars(name, 'BUILDPACK_URL' => @buildpack)
       buildpack_list = @buildpacks.map {|pack| { buildpack: pack }}
-      platform_api.buildpack_installation.update(name, updates: buildpack_list)
+      api_rate_limit.call.buildpack_installation.update(name, updates: buildpack_list)
       @app_is_setup = true
       self
     end
@@ -186,7 +186,7 @@ module Hatchet
       in_directory do
         self.setup!
         self.push_with_retry!
-        block.call(self, platform_api, output) if block_given?
+        block.call(self, api_rate_limit.call, output) if block_given?
       end
     ensure
       self.teardown!
@@ -255,7 +255,7 @@ module Hatchet
     end
 
     def create_pipeline
-      platform_api.pipeline.create(name: @name)
+      api_rate_limit.call.pipeline.create(name: @name)
     end
 
     def source_get_url
@@ -265,7 +265,7 @@ module Hatchet
 
     def create_source
       @create_source ||= begin
-        result = platform_api.source.create
+        result = api_rate_limit.call.source.create
         @source_get_url = result["source_blob"]["get_url"]
         @source_put_url = result["source_blob"]["put_url"]
         @source_put_url
@@ -273,12 +273,18 @@ module Hatchet
     end
 
     def delete_pipeline(pipeline_id)
-      platform_api.pipeline.delete(pipeline_id)
+      api_rate_limit.call.pipeline.delete(pipeline_id)
     end
 
     def platform_api
-      # We have to not use a cache due to https://github.com/heroku/platform-api/issues/73
-      @platform_api ||= PlatformAPI.connect_oauth(api_key, cache: Moneta.new(:Null))
+      puts "Deprecated: use `api_rate_limit.call` instead of platform_api"
+      api_rate_limit
+      return @platform_api
+    end
+
+    def api_rate_limit
+      @platform_api   ||= PlatformAPI.connect_oauth(api_key, cache: Moneta.new(:Null))
+      @api_rate_limit ||= ApiRateLimit.new(@platform_api)
     end
 
     private

data/lib/hatchet/reaper.rb

@@ -11,14 +11,14 @@ module Hatchet
     attr_accessor :apps
 
 
-    def initialize(platform_api:, regex: DEFAULT_REGEX)
-      @platform_api = platform_api
+    def initialize(api_rate_limit: , regex: DEFAULT_REGEX)
+      @api_rate_limit = api_rate_limit
       @regex        = regex
     end
 
     # Ascending order, oldest is last
     def get_apps
-      apps          = @platform_api.app.list.sort_by { |app| DateTime.parse(app["created_at"]) }.reverse
+      apps          = @api_rate_limit.call.app.list.sort_by { |app| DateTime.parse(app["created_at"]) }.reverse
       @app_count    = apps.count
       @hatchet_apps = apps.select {|app| app["name"].match(@regex) }
     end
@@ -63,7 +63,7 @@ module Hatchet
     def destroy_by_id(name:, id:, details: "")
       @message = "Destroying #{name.inspect}: #{id}. #{details}"
       puts @message
-      @platform_api.app.delete(id)
+      @api_rate_limit.call.app.delete(id)
     end
 
     private

data/lib/hatchet/version.rb

@@ -1,3 +1,3 @@
 module Hatchet
-  VERSION = "3.1.1"
+  VERSION = "4.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku_hatchet
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -199,6 +199,7 @@ files:
 - hatchet.lock
 - lib/hatchet.rb
 - lib/hatchet/anvil_app.rb
+- lib/hatchet/api_rate_limit.rb
 - lib/hatchet/app.rb
 - lib/hatchet/config.rb
 - lib/hatchet/git_app.rb