stairs 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 833bd6c4d72f929af87141bfd8b1b3918ca0e752
-  data.tar.gz: 02d1f1bc60dd0718df4ff57cae1eaa20d70acd49
+  metadata.gz: d1035904a5f2df9f1310a2a7499500e6bb123589
+  data.tar.gz: b96bd24c537f525276cc2c585a12bc8372175e61
 SHA512:
-  metadata.gz: b7b75e24b00bfb76ea9b19c52733f154586ab0245ae97232efe736fb1b28e59cd137280b37f37de53ccd12052af5147b48a27992558b65e29955170126fb1573
-  data.tar.gz: 748201f6166f6f935c46b7ddd773c0922c109d99fe8823a3bab8a724d3fe21e80b17086e7ee91e7e609206a761844cf6bed2f0dbbbfb690ea4658b37fda7fd88
+  metadata.gz: 2c1fe6a87b3af48fb04782a2e773e4fa6284e23141fb34f38dd78e6aebeae835f459d75ad8e6b2f945ee0613701db1345fc83a97d990ee3dc9c3702a50292145
+  data.tar.gz: 05cdd22e964203a638fad22ba4e757bb479e1b54611aad59162caf8af8bdf2604527d3399bfa492aa8bba5aa0e571102479406698cdd694f9b963a1c7486b3fd

data/README.md

@@ -12,7 +12,8 @@ environments.
 require "stairs/tasks"
 ```
 
-1. Define `setup.rb` in the root of your project
+1. [Define your script](#defining-scripts) in `setup.rb` at the root of your
+   project
 
 ## Usage
 
@@ -24,7 +25,8 @@ $ rake newb
 
 ## Defining scripts
 
-A script composes many steps that setup a project.
+A script composes many steps that setup a project. __Note:__ optional steps are
+not yet implemented.
 
 ```ruby
 setup :secret_token
@@ -92,61 +94,34 @@ write_line "more: false", "config/settings.yml"
 ```
 
 ### Defining setup steps
+
+__Note:__ this block syntax is not yet implemented, use predefined steps for
+now.
+
 ```ruby
 setup :a_cool_service do
   ## ..
 end
 ```
 
-#### Using predefined steps
+#### Using predefined steps (aka plugins)
 ```ruby
 setup :s3
 ```
 
 ## Plugins for common setups
 
-### Included plugins
-
-* `:s3` interactive prompt for setting AWS + S3 bucket access credentials
-* `:balanced`: automatically creates a test Marketplace on Balanced
-* `:secret_token`: sets a secure random secret token
+* `:secret_token` sets a secure random secret token
+* `:s3` interactive prompt for setting AWS + S3 bucket access credentials:
+  [patbenatar/stairs-steps-s3][s3]
+* `:balanced`: automatically creates a test Marketplace on Balanced:
+  [patbenatar/stairs-steps-balanced][balanced]
 
 ### Defining custom plugins
 
-```ruby
-require "fog"
-class S3Setup < Stairs::Step
-  title "S3"
-  description "Setup AWS tokens and bucket"
-
-  def run
-    @key = provide "AWS access key"
-    @secret = provide "AWS secret"
-
-    choice "Do you have an existing bucket?" do |yes|
-      env "S3_BUCKET", if yes
-        provide "Bucket name", default: "app-dev"
-      else
-        create_bucket
-      end
-    end
-
-    env "AWS_ACCESS_KEY", @key
-    env "AWS_SECRET", @secret
-  end
-
-  private
-
-  def create_bucket
-    # use @key and @secret to create bucket via API
-  end
-end
-```
-
-## To think about...
-
-* How to manage gem dependencies (S3Setup for example requires fog to be
-  installed)
+Steps inherit from `Stairs::Step`, have a title, description, and
+implement the `run` method. See those included and in the various
+extension gems for examples.
 
 ## Contributing
 
@@ -155,3 +130,6 @@ end
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[s3]: http://github.com/patbenatar/stairs-steps-s3
+[balanced]: http://github.com/patbenatar/stairs-steps-balanced

data/lib/stairs/steps.rb

@@ -1,7 +1,5 @@
 module Stairs
   module Steps
     autoload :SecretToken, "stairs/steps/secret_token"
-    autoload :S3, "stairs/steps/s3"
-    autoload :Balanced, "stairs/steps/balanced"
   end
 end

data/lib/stairs/version.rb

@@ -1,3 +1,3 @@
 module Stairs
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/stairs.gemspec

@@ -23,8 +23,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "highline", "~> 1.6.20"
   spec.add_dependency "activesupport", ">= 3.2.0"
-
-  # Plugin dependencies
-  # TODO better way to manage these?
-  spec.add_dependency "balanced", "~> 0.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - patbenatar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,20 +66,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
-- !ruby/object:Gem::Dependency
-  name: balanced
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.4
 description: A DSL and collection of plugins for easy setup of projects on new development
   environments.
 email:
@@ -97,8 +83,6 @@ files:
 - lib/stairs/script.rb
 - lib/stairs/step.rb
 - lib/stairs/steps.rb
-- lib/stairs/steps/balanced.rb
-- lib/stairs/steps/s3.rb
 - lib/stairs/steps/secret_token.rb
 - lib/stairs/tasks.rb
 - lib/stairs/version.rb

data/lib/stairs/steps/balanced.rb

@@ -1,27 +0,0 @@
-require "balanced"
-
-module Stairs
-  module Steps
-    class Balanced < Step
-      title "Balanced Payments"
-      description "Creates a test Marketplace on Balanced"
-
-      def run
-        ::Balanced.configure(api_key.secret)
-
-        env "BALANCED_URI", marketplace.uri
-        env "BALANCED_KEY", api_key.secret
-      end
-
-      private
-
-      def api_key
-        @api_key ||= ::Balanced::ApiKey.new.save
-      end
-
-      def marketplace
-        @marketplace ||= ::Balanced::Marketplace.new.save
-      end
-    end
-  end
-end

data/lib/stairs/steps/s3.rb

@@ -1,14 +0,0 @@
-module Stairs
-  module Steps
-    class S3 < Step
-      title "S3"
-      description "Setup AWS and S3 bucket access"
-
-      def run
-        env "AWS_ACCESS_KEY_ID", provide("AWS Access Key ID")
-        env "AWS_SECRET_ACCESS_KEY", provide("AWS Secret Access Key")
-        env "AWS_S3_BUCKET", provide("S3 Bucket name")
-      end
-    end
-  end
-end