manageheroku 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b8aa0c4756084dbb1374e23ec4063f00b0a65ef
-  data.tar.gz: 7d3ab4230196e8043445cf19f45b450047bc8b1c
+  metadata.gz: a2b7e0c6e489cca7b8565cae44c9a3c3149d2a9d
+  data.tar.gz: f2cd5ab4739b3854ff62b4a30b7bbb503a4b10fe
 SHA512:
-  metadata.gz: 87198db67ae89278903ee28c35bb6401ed340ab8c67b8c47b28568c46967ec384656243375d7fb34496a5b3896872fcc2a2ee3fe6d60b884093f00dc65a32eb9
-  data.tar.gz: 02557908e8f65e50a73433ad64f654efb6a8b3441c5d7a63ae254cef2e159d6c6b4b1d90396e059a90f706a309390b932f7eccb3809ad2e291fd4273858fe1d8
+  metadata.gz: 283d3963c2f5244d3c567d8c5cc24048a8125996dcfcd60f6e34bb97fa8e25d6366b47ceb68058edd9619182a2632026744fef7b47fc7c610ba04d6108a9f363
+  data.tar.gz: 4473152d94246b52b250d23185f5af453f720bab81f8f340e5507a8e6f0bb88860722149ff2eb493932750afe3c932b87fdec76bb4c05d0cd4e9ba620c46803d

data/README.md

@@ -1,6 +1,6 @@
 # Manageheroku
 
-Manage Heroku App Formations
+Manage Heroku App Formations and Apps with YML config files. Allows you to version control important application attributes, and manage configuration for different environments and scenarios.
 
 ## Installation
 
@@ -18,7 +18,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Typical usage is to automate scaling any number of services through config files. For example:
+
+    oauth-token: <%= ENV["HEROKU_OAUTH_TOKEN"] %>
+    apps:
+      - name: "commerce-app-staging"
+        maintenance: false
+      - name: "pricing-service-staging"
+        maintenance: false
+      - name: "messaging-service-staging"
+        maintenance: false
+    formations:
+      - name: "commerce-app-staging"
+        procs:
+          - process: "web"
+            quantity: 4
+            size: "standard-2X"
+          - process: "resque"
+            quantity: 1
+      - name: "pricing-service-staging"
+        procs:
+          - process: "web"
+            quantity: 2
+          - process: "resque"
+            quantity: 1
+      - name: "messaging-service-staging"
+        procs:
+          - process: "web"
+            quantity: 2
+          - process: "resque"
+            quantity: 1
+
+This config file is for an imaginary ecommerce application that is composed of a website, a pricing service and a messaging service. Using manageheroku allows you to apply this configuration to the dyno formation of each application listed in the config file. For example:
+
+      config_file = File.join(Rails.root, 'script', 'config', "black_friday_conf.yml")
+      heroku = Manageheroku::Heroku.new(config_file)
+      heroku.update!
+
+Your application can programmatically run code like that to scale your applications based on a schedule or whatever your needs are. Currently your dyno formation sizes and quantities are the only things updatable. You can find a list of dyno types in heroku docs https://devcenter.heroku.com/articles/dyno-types
+
+### Apps
+
+The apps section of the config file allows you to configure attributes of a list of apps. Configurable attributes are maintenance mode and build stack. See https://devcenter.heroku.com/articles/platform-api-reference#app-update
+
+### Formations
+
+The formations section of the config file allows you to configure dyno formations for a list of apps. See https://devcenter.heroku.com/articles/platform-api-reference#formation-batch-update for details.
+
+### Real World Usage
+
+We have manageheroku config files for shutting down and starting up all of our internal environments: development, staging and performance. Then with cron (or resque scheduler) all these environments shut down at 8pm and start back up at 8am, so we're not paying for loads of resources that aren't being used.  We also use manageheroku config files for storing various interesting configurations of the application for our performance testing environments.
 
 ## Contributing
 

data/lib/manageheroku/app.rb

@@ -0,0 +1,14 @@
+module Manageheroku
+  class App
+    attr_reader :name
+    def initialize(name, attributes)
+      @name = name
+      @attributes = attributes
+    end
+
+    def update_params
+      [@name, @attributes]
+    end
+
+  end
+end

data/lib/manageheroku/conf.rb

@@ -15,5 +15,10 @@ module Manageheroku
       formation_objects = @conf_data["formations"]
       formation_objects.map{|formation_object| Manageheroku::Formation.new(formation_object["name"], formation_object["procs"]) }
     end
+
+    def apps
+      app_objects = @conf_data["apps"]
+      app_objects.map{|app_object| Manageheroku::App.new(app_object["name"], app_object)}
+    end
   end
 end

data/lib/manageheroku/heroku.rb

@@ -2,42 +2,74 @@ module Manageheroku
   class Heroku
 
     attr_reader :errors
+    attr_accessor :verbose
+
     def initialize(conf_file, api_object=nil)
       @conf = Manageheroku::Conf.new(conf_file)
       @formations = @conf.formations
+      @apps = @conf.apps
       @heroku = api_object || PlatformAPI.connect_oauth(@conf.oauth_token)
       @errors = []
+      @verbose = false
     end
 
     def update!
+      update_apps!
+      update_formations!
+    end
+
+    private
+
+    def update_apps!
+      @apps.each do |app|
+        begin
+          response = @heroku.app.update(*app.update_params)
+          log_info("Updating App #{app.name}:", response) if @verbose
+        rescue StandardError => e
+          log_errors e
+          raise e
+        end
+      end
+    end
+
+    def update_formations!
       @formations.each do |formation|
         begin
-          @heroku.formation.batch_update(*formation.update_params)
+          response = @heroku.formation.batch_update(*formation.update_params)
+          log_info("Updating Formation for #{formation.name}:", response) if @verbose
         rescue StandardError => e
-          if e.respond_to?(:response)
-            # errors with a response have good information that you miss in stacktrace form
-            status = e.response.status
-            status_line = e.response.status_line
-            response_body_id = nil
-            response_body_message = nil
-            begin
-              body_hash = JSON.parse(e.response.body)
-              response_body_id = body_hash["id"]
-              response_body_message = body_hash["message"]
-            rescue
-              response_body_message = e.response.body
-            end
-            error_string = <<-OUTPUT
-              Status: #{[status, status_line].join(";")}
-              Body: #{[response_body_id, response_body_message].join(";")}
-            OUTPUT
-            @errors << error_string
-            puts error_string #Heroku logs stdout
-          end
+          log_errors e
           raise e
         end
       end
     end
 
+    def log_info(*log_lines)
+      log_lines.each{ |line| puts line }
+    end
+
+    def log_errors(e)
+      if e.respond_to?(:response)
+        # errors with a response have good information that you miss in stacktrace form
+        status = e.response.status
+        status_line = e.response.status_line
+        response_body_id = nil
+        response_body_message = nil
+        begin
+          body_hash = JSON.parse(e.response.body)
+          response_body_id = body_hash["id"]
+          response_body_message = body_hash["message"]
+        rescue
+          response_body_message = e.response.body
+        end
+        error_string = <<-OUTPUT
+              Status: #{[status, status_line].join(";")}
+              Body: #{[response_body_id, response_body_message].join(";")}
+        OUTPUT
+        @errors << error_string
+        puts error_string #Heroku logs stdout
+      end
+    end
+
   end
 end

data/lib/manageheroku/version.rb

@@ -1,3 +1,3 @@
 module Manageheroku
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/manageheroku.rb

@@ -1,5 +1,6 @@
 require 'platform-api'
 require "manageheroku/version"
+require "manageheroku/app"
 require "manageheroku/formation"
 require "manageheroku/conf"
 require "manageheroku/heroku"

data/test/conf_test.rb

@@ -13,6 +13,12 @@ class ConfTest < MiniTest::Test
       conf.formations.last.name.must_equal "myapp-performance"
     end
 
+    it "must update all the apps" do
+      conf = Manageheroku::Conf.new(File.join(File.dirname(__FILE__), 'sample_conf.yml'))
+      conf.apps.first.name.must_equal "myapp-development"
+      conf.apps.last.name.must_equal "myapp-staging"
+    end
+
     it "supports ERB magic in the config file" do
       ENV["TEST_VAL"] = "erb_is_great"
       conf = Manageheroku::Conf.new(File.join(File.dirname(__FILE__), 'sample_conf.yml'))

data/test/heroku_test.rb

@@ -3,8 +3,9 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 class HerokuTest < MiniTest::Test
   describe "heroku" do
     # it "really works" do
-    #   conf_file_path = File.join(File.dirname(__FILE__), 'analysis_conf.yml')
+    #   conf_file_path = File.join(File.dirname(__FILE__), 'shutdown_development_conf.yml')
     #   heroku = Manageheroku::Heroku.new(conf_file_path)
+    #   heroku.verbose = true
     #   heroku.update!
     # end
     #
@@ -34,6 +35,10 @@ class HerokuTest < MiniTest::Test
       FormationStub.new
     end
 
+    def app
+      AppStub.new
+    end
+
     class FormationStub
       def batch_update(*params)
         response_params = {body: {"id"=>"Invalid params", "message"=>"Cannot update the same process twice"}.to_json,
@@ -42,6 +47,11 @@ class HerokuTest < MiniTest::Test
         raise Excon::Errors::UnprocessableEntity.new("Oh ye gods!", nil, Excon::Response.new(response_params))
       end
     end
+
+    class AppStub
+      def update(*params)
+      end
+    end
   end
 
   class ApiStubDegenerateCase
@@ -49,12 +59,21 @@ class HerokuTest < MiniTest::Test
       FormationStub.new
     end
 
+    def app
+      AppStub.new
+    end
+
     class FormationStub
       def batch_update(*params)
         response_params = { status: "503" }
         raise Excon::Errors::ServiceUnavailable.new("Et tu Heroku?", nil, Excon::Response.new(response_params))
       end
     end
+
+    class AppStub
+      def update(*params)
+      end
+    end
   end
 
 end

data/test/sample_conf.yml

@@ -1,4 +1,11 @@
 oauth-token: <%= ENV["TEST_VAL"] || "the-magic-oauth-token" %>
+
+apps:
+  - name: "myapp-development"
+    maintenance: true
+  - name: "myapp-staging"
+    maintenance: true
+
 formations:
   - name: "myapp-development"
     procs:
@@ -16,5 +23,6 @@ formations:
     procs:
       - process: "web"
         quantity: 0
+        size: "2X"
       - process: "resque-low"
         quantity: 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageheroku
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Josh Cronemeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-09 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -65,6 +65,7 @@ files:
 - README.md
 - Rakefile
 - lib/manageheroku.rb
+- lib/manageheroku/app.rb
 - lib/manageheroku/conf.rb
 - lib/manageheroku/formation.rb
 - lib/manageheroku/heroku.rb
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Manage Heroku Apps from config files