fog-bouncer 0.0.8 → 0.1.0

data/.gitignore

@@ -6,7 +6,6 @@
 .yardoc
 Gemfile.lock
 InstalledFiles
-Makefile
 _yardoc
 coverage
 doc/

data/.travis.yml

@@ -0,0 +1,11 @@
+env: NO_SIMPLECOV=true
+
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+
+script: bundle exec rake test --trace

data/Makefile

@@ -0,0 +1,26 @@
+VERSION=$(shell ruby -r./lib/fog/bouncer/version -e "puts Fog::Bouncer::VERSION")
+
+# default the projcet name to the directory name
+PROJECT?=$(notdir $(PWD))
+GEM=$(PROJECT)-$(VERSION).gem
+
+.PHONY: test
+test:
+	bundle exec rake test
+
+.PHONY: package
+package: $(GEM)
+
+# Always build the gem
+.PHONY: $(GEM)
+$(GEM):
+	gem build $(PROJECT).gemspec
+
+.PHONY: install
+install: $(GEM)
+	gem install $<
+
+# Publish to gemgate
+.PHONY: publish
+publish: $(GEM)
+	 gem push $(GEM)

data/README.md

@@ -2,6 +2,8 @@
 
 ![fog-bouncer](https://github.com/dylanegan/fog-bouncer/raw/master/bouncer.jpg)
 
+[![Build Status](https://secure.travis-ci.org/dylanegan/fog-bouncer.png?branch=master)](http://travis-ci.org/dylanegan/fog-bouncer)
+
 A simple way to define and manage security groups for AWS with the backing support from fog.
 
 ## Usage

data/fog-bouncer.gemspec

@@ -16,8 +16,9 @@ Gem::Specification.new do |gem|
   gem.version       = Fog::Bouncer::VERSION
 
   gem.add_dependency "clamp", "~> 0.3.0"
-  gem.add_dependency "fog", "~> 1.2.0"
+  gem.add_dependency "fog", "~> 1.2"
   gem.add_dependency "ipaddress", "~> 0.8.0"
+  gem.add_dependency "jruby-openssl", "~> 0.7.6" if RUBY_PLATFORM == "java"
   gem.add_dependency "rake"
   gem.add_dependency "scrolls", "~> 0.0.5"
 

data/lib/fog/bouncer.rb

@@ -13,14 +13,38 @@ require "scrolls"
 
 module Fog
   module Bouncer
+    # Public: An AWS account ID
+    #
+    # Example
+    #
+    #   Fog::Bouncer.aws_account_id
+    #   # => "1234567890"
+    #
+    # Returns a String
     def self.aws_account_id
       ENV['AWS_ACCOUNT_ID']
     end
 
+    # Public: The available doorlists
+    #
+    # Example
+    #
+    #   Fog::Bouncer.doorlists
+    #   # => { :doorlist => Fog::Bouncer::Security }
+    #
+    # Returns a Hash
     def self.doorlists
       @doorlists ||= {}
     end
 
+    # Public: An establised fog AWS compute connection
+    #
+    # Example
+    #
+    #   Fog::Bouncer.fog
+    #   # => Fog::AWS::Compute
+    #
+    # Returns a Fog::AWS::Compute object
     def self.fog
       @fog ||= Fog::Compute.new(
         :provider => "AWS",
@@ -30,28 +54,64 @@ module Fog
       )
     end
 
+    # Public: Log data through Scrolls
+    #
+    # Example
+    #
+    #   Fog::Bouncer.log(data_one: true, data_two: true)
+    #
+    # Returns nothing
     def self.log(data, &block)
       log! unless logging?
       Scrolls.log({ 'fog-bouncer' => true, 'pretending' => pretending? }.merge(data), &block)
     end
 
+    # Public: Start the Scrolls logger
+    #
+    # Example
+    #
+    #   Fog::Bouncer.log!
+    #
+    # Returns nothing
     def self.log!
       Scrolls::Log.start(logger)
       @logging = true
     end
 
+    # Public: The logging location
+    #
+    # Returns an Object
     def self.logger
       @logger ||= STDOUT
     end
 
+    # Public: Set the logging location
+    #
+    # Returns nothing
     def self.logger=(logger)
       @logger = logger
     end
 
+    # Public: Check the logging state
+    #
+    # Example
+    #
+    #   Fog::Bouncer.logging?
+    #   # => true
+    #
+    # Returns false or true if logging has been started
     def self.logging?
       @logging ||= false
     end
 
+    # Public: Load a file for evaluation
+    #
+    # Example
+    #
+    #   Fog::Bouncer.load('/tmp/doorlist.rb')
+    #   # => Fog::Bouncer::Security
+    #
+    # Returns a Fog::Bouncer::Security object
     def self.load(file)
       if file && File.exists?(file)
         Fog::Bouncer.log(load: true, file: file) do
@@ -60,32 +120,68 @@ module Fog
       end
     end
 
-    def self.pretend(&block)
-      if block_given?
-        @pretend = true
-        yield
-        @pretend = false
-      else
-        @pretend ||= false
-      end
+    # Public: Check the pretend state
+    #
+    # Returns false or true if pretending
+    def self.pretend
+      @pretend ||= false
+    end
+
+    # Public: Pretend while evaluating the given block
+    #
+    # Example
+    #
+    #   Fog::Bouncer.while_pretending do
+    #     ...
+    #   end
+    #
+    # Returns nothing
+    def self.while_pretending(&block)
+      @pretend = true
+      yield
+      @pretend = false
     end
 
+    # Public: Set the pretend state
+    #
+    # Returns the given state
     def self.pretend=(value)
       @pretend = value
     end
 
+    # Public: Start pretending
+    #
+    # Returns true
     def self.pretend!
       @pretend = true
     end
 
+    # Public: Evaluate the pretend state
+    #
+    # Returns true if pretending or false if not
     def self.pretending?
       !!pretend
     end
 
+    # Public: Empty the doorlists
+    # 
+    # Returns an empty Hash
     def self.reset
       @doorlists = {}
     end
 
+    # Public: Create a doorlist
+    #
+    # Example
+    #
+    #   Fog::Bouncer.security :private do
+    #     group "name", "description" do
+    #       ...
+    #     end
+    #   end
+    #   # => Fog::Bouncer::Security
+    #
+    # Returns a Fog::Bouncer::Security object
     def self.security(name, &block)
       Fog::Bouncer.log(security: true, name: name) do
         doorlists[name] = Fog::Bouncer::Security.new(name, &block)

data/lib/fog/bouncer/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Bouncer
-    VERSION = "0.0.8"
+    VERSION = "0.1.0"
   end
 end

data/spec/helper.rb

@@ -1,4 +1,4 @@
-require "simplecov"
+require "simplecov" unless ENV['NO_SIMPLECOV']
 require 'minitest/autorun'
 
 ENV['AWS_ACCESS_KEY_ID'] ||= "abcde1234"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog-bouncer
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-18 00:00:00.000000000 Z
+date: 2012-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: ipaddress
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +118,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .simplecov
+- .travis.yml
 - Gemfile
+- Makefile
 - README.md
 - Rakefile
 - bin/fog-bouncer