ember_cli_deploy_redis 0.1.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjVlZTM5MTYwODRlNjVhN2VkYzA1NjcwNDY1MmViMTQxNGNiM2JlNA==
+    MTBjNmE1MTRkMTg2NDY5ZGFjNzY3YTliZjQ4NGUxOTM1MWMxMTZiMg==
   data.tar.gz: !binary |-
-    NjUyMGE1MGZhNmU3YjM4NGUwZmYzYjNhMDIyNGJkYWIxZDNmNzI5Zg==
+    YTgwYjZmYTdmZGUwYjQwMjUzMWI5N2I3ZDBmZTFjMjUwMDBhNjhhNQ==
 SHA512:
   metadata.gz: !binary |-
-    YzMyNDFmMzFjOTU3NWEwZTQxYTljNWNmMmI2NTI0N2IwYWQwODk0ZDc2ZTE1
-    YmRmNTQ3N2I3ZGE5NzdiNzMzNzFkMTQzZWY4OTE4ZWQ4MTg3ZmY4NTM5OGZh
-    YTQxY2U2MTRmZDJjNDI3YjM0MmY1YjUzNzhjN2U2N2Y1YTMwZDM=
+    MTQ5YmM1MDljMWMxMWYxMzk1M2JlZmVhOTExYTlmMDY5MDg3ZTc1ODBkYWVl
+    NDEwOWVhNmNkMGJlM2VhZDZkM2E3OGYxOTA0ZDM1MTY0YjQ2OTY3ZDQ3M2Fj
+    YjgxZTY0NTYyODUwNDQ4OGUxZGU0NmVkNTE5NTcxYWIwMmJmODU=
   data.tar.gz: !binary |-
-    YTcxZjkwMDczMTY1ZThhMDc3NWI3NGM0OTJmYTg0NDc1MGQwOTEyNzJmYmJh
-    Mjk3YTUwNWJhMDhlMzg0MmM4MDgyZmE5NTViNGI1YTc4ZmE3Mjg2NmYxMTg4
-    NmY0MWVjZjJhZTMxOTk5NDU2NDk3Mjc0NzcxNmY4YTk0ODY0M2U=
+    Y2M3OTEyMmMwMDJkMDk3ZjNhZmY4ZmY0OTQwODQ2NWM4OTFjZTQ2NDE2MTZj
+    OWMzNmQyYzdhZmNhNTEzYjhmZGU4NDZmNmEwZWE1MGNlNDM2Y2ViZGFmMjI1
+    NDY4YzY5NTYyMGM3OGZiMjAwMmExNWJjOGE4ZGU5YWJkN2NiM2E=

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+Gemfile.lock

data/.jrubyrc

@@ -0,0 +1 @@
+compat.version=2.0

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/.travis.yml

@@ -5,6 +5,11 @@ rvm:
 - 2.0.0
 - 2.1.6
 - 2.2.3
+- jruby-1.7.22
+- jruby-9.0.1.0
+- jruby-head
+env:
+- JRUBY_OPTS="-Xcli.debug=true --debug"
 script: bundle exec rspec
 deploy:
   provider: rubygems

data/README.md

@@ -4,56 +4,110 @@
 
 # ember_cli_deploy_redis
 
-Ruby interaction with [ember-cli-deploy-redis][2] to support [ember-cli][1] project deployments.
+Ruby interaction with [the Ahalogy fork of ember-cli-deploy-redis][2] to support [ember-cli][1] project deployments.
 
 [ember-cli-deploy-redis][2] stores deployment information including
-the index page contents in Redis, and this gem allows access to it so that it can be served.
+the index page contents in Redis.
+This gem allows access to that content so that it can be served.
 
 ## Installing
 
 ```ruby
-  gem install ember_cli_deploy_redis
+gem install ember_cli_deploy_redis
 ```
 
 Or if you are using bundler add to your Gemfile:
 
 ```ruby
-  gem ember_cli_deploy_redis, '~> 0.0.1'
+gem ember_cli_deploy_redis, '~> 0.0.1'
 ```
 
 ## Usage
 
-The following errors may be raised by the methods mentioned below:
-
-* `EmberCliDeployRedis::NoDeployments`
-* `EmberCliDeployRedis::FileMissingFromDeployment`
-
 ### Configuration
 
 ```ruby
 EmberCliDeployRedis.configure do |config|
-  config.app_name = "ember_cli_project_name"
+  config.default_app_name = "ember_cli_project_name"
   # Optional:
   config.keyspace = "optional_redis_keyspace"
 end
 ```
 
-### Getting deployed revisions
+### Getting all deployed revisions for the default app
+
+```ruby
+EmberCliDeployRedis.revisions
+```
+
+This will raise an `EmberCliDeployRedis::ConfigurationError` if `default_app_name` was not configured.
+
+### Getting the currently-active revision for the default app
+
+```ruby
+EmberCliDeployRedis.active_revision
+```
+
+This will raise an `EmberCliDeployRedis::ConfigurationError` if `default_app_name` was not configured.
+
+### Get a specific app
 
 ```ruby
-  EmberCliDeployRedis.revisions
+EmberCliDeployRedis::Application.new('app_name')
 ```
 
-### Getting the latest deployed revision
+### Get specific revision from an app
 
 ```ruby
-  EmberCliDeployRedis.latest_revision
+application.revision_by_name('revision_identifier')
 ```
 
 ### Getting the contents of a deployed file
 
 ```ruby
-  EmberCliDeployRedis.latest_revision.contents_of('index.html')
+EmberCliDeployRedis.active_revision.contents_of('index.html')
+```
+
+This will raise an `EmberCliDeployRedis::FileMissingFromDeployment` if the file is not present in Redis.
+
+## Web UI
+
+Borrowed from the awesome [Sidekiq Web UI](https://github.com/mperham/sidekiq/wiki/Monitoring).
+
+Add sinatra to your Gemfile:
+
+```ruby
+# if you require 'sinatra' you get the DSL extended to Object
+gem 'sinatra', :require => nil
+```
+
+Add the following to your config/routes.rb:
+
+```ruby
+require 'ember_cli_deploy_redis/web'
+mount EmberCliDeployRedis::Web => '/sidekiq'
+```
+
+This interface allows the display of the currently-active revision and the most recent revisions.
+
+It also includes "test" link for each non-active revision.
+This is done using a query parameter, the name of which is set in the `revision_specifier_query_param` configuration variable.
+
+### Configuration
+
+```ruby
+EmberCliDeployRedis.configure do |config|
+  # By default, the default_app_name is used. Otherwise, you can specify multiple app names:
+  config.web_application_names = %w(application1 application2)
+  
+  # To enable "test" links for revisions:
+  config.revision_specifier_query_param = "_ember_app"
+
+  # To perform an action when a revision is made active:
+  config.on_revision_activated do |new_revision|
+    # Slack webhook here!
+  end
+end
 ```
 
 ## To Do

data/ember_cli_deploy_redis.gemspec

@@ -2,32 +2,35 @@
 $:.push File.expand_path("../lib", __FILE__)
 require "ember_cli_deploy_redis/version"
 
-Gem::Specification.new do |s|
-  s.name        = "ember_cli_deploy_redis"
-  s.version     = EmberCliDeployRedis::VERSION
-  s.authors     = ["Ahalogy"]
-  s.email       = ["robin@robindaugherty.net"]
-  s.homepage    = ""
-  s.summary     = "Ruby interaction with ember-cli-deploy-redis"
-  s.description = <<-MD
-Supports ember-cli project deployments
-made using ember-cli-deploy-redis, which stores deployment information including
-the index page contents in Redis.
+Gem::Specification.new do |spec|
+  spec.name        = "ember_cli_deploy_redis"
+  spec.version     = EmberCliDeployRedis::VERSION
+  spec.licenses    = ["MIT"]
+  spec.authors     = ["Ahalogy", "Robin Daugherty"]
+  spec.email       = ["robin@robindaugherty.net"]
+  spec.homepage    = "https://github.com/Ahalogy/ember_cli_deploy_redis_ruby"
+  spec.summary     = "Serves up ember-cli content deployed with our fork of ember-cli-deploy-redis"
+  spec.description = <<-MD
+Handles the serving of page contents of deployed ember-cli projects deployed using our fork of
+(ember-cli-deploy-redis)[https://github.com/Ahalogy/ember-cli-deploy-redis],
+which stores deployment information including the index page contents in Redis.
 MD
+  spec.requirements << 'An Ember-ClI project'
+  spec.requirements << '(ember-cli-deploy)[https://github.com/ember-cli/ember-cli-deploy], 0.4.x'
+  spec.requirements << '(ember-cli-deploy-redis)[https://github.com/Ahalogy/ember-cli-deploy-redis]'
+  spec.requirements << 'A Ruby (Rails/Sinatra/etc) app to serve up the Ember-CLI project and provide it an API.'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '~> 2.0'
 
-  s.add_dependency "redis"
-  s.add_development_dependency "fakeredis"
-  s.add_development_dependency "shoulda-matchers"
-  s.add_development_dependency "dotenv"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "pry"
-  s.add_development_dependency 'pry-byebug'
-  s.add_development_dependency 'pry-doc'
-  s.add_development_dependency 'pry-rescue'
-  s.add_development_dependency 'pry-stack_explorer'
+  spec.add_runtime_dependency "redis"
+  spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'sinatra', '~> 1.4', '>= 1.4.6'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec-html-matchers'
 end

data/lib/ember_cli_deploy_redis.rb

@@ -18,7 +18,7 @@ module EmberCliDeployRedis
 
     def default_app
       unless configuration.default_app_name
-        fail 'No default_app_name has been configured for the ember-cli project.'
+        fail EmberCliDeployRedis::ConfigurationError, 'No default_app_name has been configured.'
       end
       @default_app ||= EmberCliDeployRedis::Application.new(configuration.default_app_name)
     end
@@ -27,8 +27,14 @@ module EmberCliDeployRedis
       default_app.revisions
     end
 
+    # @deprecated use {#active_revision} instead
     def latest_revision
-      default_app.latest_revision
+      warn "[DEPRECATION] `latest_revision` is deprecated, use `active_revision` instead"
+      active_revision
+    end
+
+    def active_revision
+      default_app.active_revision
     end
   end
 end

data/lib/ember_cli_deploy_redis/application.rb

@@ -11,8 +11,19 @@ module EmberCliDeployRedis
       EmberCliDeployRedis::RevisionList.from_redis(self)
     end
 
+    # @deprecated use {#active_revision} instead
     def latest_revision
-      EmberCliDeployRedis::Revision.latest_from_redis(self)
+      warn "[DEPRECATION] `latest_revision` is deprecated, use `active_revision` instead"
+      active_revision
+    end
+
+    def active_revision
+      EmberCliDeployRedis::Revision.active_from_redis(self)
+    end
+
+    # Returns the Revision specified by name, or nil if nothing matched.
+    def revision_by_name(revision_name)
+      revisions.find { |r| r.name == revision_name }
     end
 
     private

data/lib/ember_cli_deploy_redis/configuration.rb

@@ -1,15 +1,43 @@
 module EmberCliDeployRedis
   class Configuration
-    attr_accessor :redis, :keyspace
-    attr_reader :default_app_name
+    attr_accessor :redis
 
     def keyspace
       @keyspace ||= 'ember-cli-deploy'
     end
 
+    attr_writer :keyspace
+
+    attr_reader :default_app_name
+
     def default_app_name=(name)
+      fail ArgumentError, "default_app_name has already been set" if @default_app_name
       @default_app_name = name
-      @default_app = nil
+    end
+
+    # Array of names of Ember applications that will be supported.
+    def web_application_names
+      @web_application_names ||= [default_app_name]
+    end
+
+    def web_application_names=(names)
+      fail ArgumentError, "names must be an array" unless names.respond_to? :each
+      @web_application_names = names
+    end
+
+    attr_reader :revision_specifier_query_param
+    def revision_specifier_query_param=(param_name)
+      @revision_specifier_query_param = param_name
+    end
+
+    def on_revision_activated(&block)
+      @on_revision_activated_block = block
+    end
+
+    attr_reader :on_revision_activated_block
+
+    def revision_has_been_activated(revision)
+      @on_activate_revision_block.call(revision) if @on_activate_revision_block
     end
 
     def redis_key_for_revision_list(application)

data/lib/ember_cli_deploy_redis/errors.rb

@@ -1,4 +1,4 @@
 module EmberCliDeployRedis
-  class NoDeployments < ::StandardError; end
+  class ConfigurationError < ::StandardError; end
   class FileMissingFromDeployment < ::StandardError; end
 end

data/lib/ember_cli_deploy_redis/revision.rb

@@ -5,8 +5,9 @@ module EmberCliDeployRedis
     attr_reader :application
     attr_reader :name
 
-    def self.latest_from_redis(application)
-      new application, latest_revision_from_redis(application)
+    def self.active_from_redis(application)
+      revision_name = active_revision_from_redis(application)
+      new application, revision_name if revision_name
     end
 
     def initialize(application, name)
@@ -18,20 +19,27 @@ module EmberCliDeployRedis
       contents_of_file_from_redis(filename)
     end
 
+    def active?
+      self == application.active_revision
+    end
+
+    def ==(other)
+      other.name == name
+    end
+
+    def activate!
+      key = EmberCliDeployRedis.configuration.redis_key_for_revision_list(application)
+      EmberCliDeployRedis.configuration.redis.lpush(key, name)
+    end
+
     private
 
     attr_writer :application
     attr_writer :name
 
-    def self.latest_revision_from_redis(application)
+    def self.active_revision_from_redis(application)
       key = EmberCliDeployRedis.configuration.redis_key_for_revision_list(application)
       names = EmberCliDeployRedis.configuration.redis.lrange(key, 0, 0)
-      unless names.size > 0
-        fail(
-          EmberCliDeployRedis::NoDeployments,
-          "No revisions have been deployed to Redis",
-        )
-      end
       names.first
     end
 

data/lib/ember_cli_deploy_redis/revision_list.rb

@@ -1,15 +1,12 @@
-require 'forwardable'
+require 'delegate'
 
 module EmberCliDeployRedis
   # Holds a list of deployed application revisions that may be used.
-  class RevisionList
-    extend Forwardable
-
+  # Delegates to the array of revisions, so standard {Array} methods can be called.
+  class RevisionList < SimpleDelegator
     attr_reader :application
     attr_reader :revisions
 
-    def_delegators :revisions, :[], :first, :last
-
     def self.from_redis(application)
       new application, list_from_redis(application).map { |r| Revision.new(application, r) }
     end
@@ -17,6 +14,15 @@ module EmberCliDeployRedis
     def initialize(application, revisions)
       self.application = application
       self.revisions = revisions
+      super(revisions)
+    end
+
+    def method_missing(method, *args, &block)
+      if revisions.respond_to? method
+        revisions.send(method, *args, &block)
+      else
+        super
+      end
     end
 
     private

data/lib/ember_cli_deploy_redis/version.rb

@@ -1,3 +1,3 @@
 module EmberCliDeployRedis
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/ember_cli_deploy_redis/web.rb

@@ -0,0 +1,59 @@
+require 'erb'
+require 'yaml'
+require 'sinatra/base'
+
+require 'ember_cli_deploy_redis'
+require 'ember_cli_deploy_redis/web_helpers'
+
+module EmberCliDeployRedis
+  class Web < Sinatra::Base
+    enable :sessions
+    use Rack::Protection, :use => :authenticity_token unless ENV['RACK_ENV'] == 'test'
+
+    set :root, File.expand_path(File.dirname(__FILE__) + "/../../web")
+    set :public_folder, proc { "#{root}/assets" }
+    set :views, proc { "#{root}/views" }
+    set :locales, ["#{root}/locales"]
+
+    helpers WebHelpers
+
+    get '/' do
+      @applications = EmberCliDeployRedis.configuration.web_application_names.map { |name|
+        Application.new(name)
+      }
+      erb :dashboard
+    end
+
+    get "/applications/:app_name" do
+      halt 404 unless params[:app_name]
+      @application = Application.new(params[:app_name])
+      @revisions = @application.revisions
+      erb :application
+    end
+
+    post "/applications/:app_name/activate/:revision_name" do
+      halt 404 unless params[:app_name]
+      halt 404 unless params[:revision_name]
+      application = Application.new(params[:app_name])
+      revision = application.revision_by_name(params[:revision_name])
+      if EmberCliDeployRedis.configuration.on_revision_activated_block
+        EmberCliDeployRedis.configuration.on_revision_activated_block.call(revision)
+      end
+      revision.activate!
+      redirect_with_query("#{root_path}applications/#{application.name}")
+    end
+  end
+end
+
+if defined?(::ActionDispatch::Request::Session) &&
+    !::ActionDispatch::Request::Session.respond_to?(:each)
+  # mperham/sidekiq#2460
+  # Rack apps can't reuse the Rails session store without
+  # this monkeypatch
+  class ActionDispatch::Request::Session
+    def each(&block)
+      hash = self.to_hash
+      hash.each(&block)
+    end
+  end
+end