RubyGems - fog-maestrodev - Versions diffs - 1.7.0.20121114190951 → 1.8.0.20130109172219 - Mend

fog-maestrodev 1.7.0.20121114190951 → 1.8.0.20130109172219

Files changed (964) hide show

data/docs/_config.yml DELETED Viewed

@@ -1,39 +0,0 @@
-safe:        false
-auto:        false
-server:      false
-server_port: 4000
-source:      .
-destination: ./_site
-plugins:     ./_plugins
-future:      true
-lsi:         false
-pygments:    false
-markdown:    maruku
-permalink:   none
-maruku:
-  use_tex:    false
-  use_divs:   false
-  png_engine: blahtex
-  png_dir:    images/latex
-  png_url:    /images/latex
-rdiscount:
-  extensions: []
-kramdown:
-  auto_ids: true,
-  footnote_nr: 1
-  entity_output: as_char
-  toc_levels: 1..6
-  use_coderay: false
-  coderay:
-    coderay_wrap: div
-    coderay_line_numbers: inline
-    coderay_line_numbers_start: 1
-    coderay_tab_width: 4
-    coderay_bold_every: 10
-    coderay_css: style

data/docs/_layouts/default.html DELETED Viewed

@@ -1,111 +0,0 @@
-<!doctype html>
-<!--[if lt IE 7 ]> <html lang="en" class="no-js ie6"> <![endif]-->
-<!--[if IE 7 ]>    <html lang="en" class="no-js ie7"> <![endif]-->
-<!--[if IE 8 ]>    <html lang="en" class="no-js ie8"> <![endif]-->
-<!--[if IE 9 ]>    <html lang="en" class="no-js ie9"> <![endif]-->
-<!--[if (gt IE 9)|!(IE)]><!--> <html lang="en" class="no-js"> <!--<![endif]-->
-<head>
-  <meta charset="utf-8">
-  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
-  <title>fog - {{ page.title }}</title>
-  <meta name="description" content="">
-  <meta name="author" content="">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <!--
-    <link rel="shortcut icon" href="/public/favicon.ico">
-    <link rel="apple-touch-icon" href="/public/apple-touch-icon.png">
-  -->
-  <link rel="stylesheet" href="/public/css/style.css?v=2">
-  <link rel="stylesheet" href="/public/css/fog.css?v=2">
-  <script src="/public/js/libs/modernizr-1.6.min.js"></script>
-</head>
-<body>
-  <div id="container">
-    <header>
-      <a href="/"><img src="/public/images/fog.png" title="fog" /></a>
-      <h1>{{ page.title }}</h1>
-      <dl>
-        <dt>version</dt><dd>vX.Y.Z</dd>
-        <dt>install</dt><dd><code>gem install fog</code></dd>
-        <dt>source</dt><dd><a href="http://github.com/fog/fog">fog/fog</a></dd>
-      </dl>
-    </header>
-    <nav>
-      <ul>
-        <li><a href="/">Home</a></li>
-        <li><a href="/about/structure.html">Structure</a></li>
-        <li><a href="/about/getting_started.html">Getting Started</a></li>
-        <li>&nbsp;</li>
-        <li><a href="/storage">Storage</a></li>
-        <li><a href="/compute">Compute</a></li>
-        <li><a href="/dns">DNS</a></li>
-        <li><a href="/cdn">CDN</a></li>
-      </ul>
-    </nav>
-    <div id="main">
-      {{ content }}
-      <h2>About</h2>
-      <ul>
-        <li><a href="/">Home</a></li>
-        <li><a href="/about/contributing.html">Contributing</a></li>
-        <li><a href="/about/press.html">Press</a></li>
-        <li><a href="/about/supported_services.html">Supported Services</a></li>
-        <li><a href="/about/users.html">Users</a></li>
-      </ul>
-    </div>
-    <footer>
-      sponsored by
-      <img height="20px" src="/public/images/engineyard.png" title="engineyard" />
-    </footer>
-  </div> <!-- end of #container -->
-  <script src="//ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.js"></script>
-  <script>!window.jQuery && document.write(unescape('%3Cscript src="public/js/libs/jquery-1.4.2.js"%3E%3C/script%3E'))</script>
-  <!-- scripts concatenated and minified via ant build script-->
-  <script src="public/js/plugins.js"></script>
-  <script src="public/js/script.js"></script>
-  <!-- end concatenated and minified scripts-->
-  <!--[if lt IE 7 ]>
-    <script src="public/js/libs/dd_belatedpng.min.js"></script>
-    <script> DD_belatedPNG.fix('img, .png_bg'); </script>
-  <![endif]-->
-  <!-- yui profiler and profileviewer - remove for production -->
-  <script src="public/js/profiling/yahoo-profiling.min.js"></script>
-  <script src="public/js/profiling/config.js"></script>
-  <!-- end profiling code -->
-  <!-- change the UA-XXXXX-X to be your site's ID -->
-  <script>
-   var _gaq = [['_setAccount', 'UA-301159-7'], ['_trackPageview']];
-   (function(d, t) {
-    var g = d.createElement(t),
-        s = d.getElementsByTagName(t)[0];
-    g.async = true;
-    g.src = ('https:' == location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-    s.parentNode.insertBefore(g, s);
-   })(document, 'script');
-  </script>
-</body>
-</html>

data/docs/about/contributing.markdown DELETED Viewed

@@ -1,228 +0,0 @@
----
-layout: default
-title:  Contributing
----
-First off, high five for coming to visit this page.  You are my new hero.
-## Overview
-* Organize your patches by keeping all related changes together in a topic branch.
-* Rebase your branch against master before submitting a pull request (and squish any 'oops' or work in progress commits).
-* Submit changes as pull requests describing what the changes should cover and referencing issues (if any).
-* Use 'tags' in your commits to indicate the scope, so things like '\[aws|compute\] fixed something'.
-* Write and run tests.  Tests should follow through usage workflows and ought to pass both with mocking on and off.
-## Deep dive
-Now then, some of the what makes it tick and why. For simplicity let's pretend you want to implement a new service, from scratch. I will walk through the requisite pieces and important things to keep in mind as you go.
-But, before I dive too deep, I'll leave you with an out.  Other great ways to contribute are fixing bugs, writing documentation or helping port other projects to use fog. That way everybody wins!
-## The Service
-First and foremost you'll need to create a service, which should start from something like:
-    module Fog
-      class TheService < Fog::Service
-        requires :necessary_credential
-        model_path 'path/to/models'
-        collection 'name_of_collection'
-        model 'name_of_model'
-        request_path 'path/to/requests'
-        request 'name_of_request'
-        class Mock
-          include Collections
-        end
-        class Real
-          include Collections
-        end
-      end
-    end
-### Highlights:
-* we segregate between real and mock so it is easier to add stuff to one or the other later.
-* this is where any shared stuff will go, like making/signing requests
-## Requests
-The next thing to bite off are the requests. fog is all about making cloud services easier to use and move between, but requests are not where this happens. Requests should map closely to the actual api requests (you should be able to directly reference the api docs and vice versa). In particular, try to keep the output of any data parsing as close to the actual format as possible. This makes implementation and maintenance much easier and provides a solid foundation for models to build nice things on top of. I generally end up working on stuff to get/list details first and then filling in create/destroy pairs and other requests.
-You start with something like this:
-<pre>
-module Fog
-  class TheService
-    class Real
-      def request(*args)
-      end
-    end
-    class Mock
-      def request(*args)
-        Fog::Mock.not_implemented
-      end
-    end
-  end
-end
-</pre>
-### Highlights:
-* You should define the method twice, once for the real implementation and once for mocked (they should take the same arguments).
-* The mock versions should just start out by raising a not implemented error, you can come back and fill this in later.
-* The real version should make a request, probably by a method defined on the real class in the service you defined earlier.
-* Each request should either return an Excon::Response (with a parsed body where appropriate) or raise an error.
-## Tests
-Now would be a good time to write some tests to make sure what you have written works (and will continue to). I've tried a couple variations on testing in the past, but have settled on consolidated lifetime testing. These vary enough that its hard to give a single simple example, but you can see many examples in "tests/compute/requests/aws":https://github.com/fog/fog/tree/master/tests/compute/requests/aws/.
-### Highlights:
-* Reuse the same objects and take them through their whole life cycle (this is much faster, and most of the time if one portion fails the others would anyway).
-* Test the format of the output to ensure parsers match expectations (check the provider's api docs) and that mocks return matching data.
-* Test common failure cases and their behavior, you'll need to know how the service acts in these cases to make better mocks.
-## Models
-You could also skip to the mocks here if you wanted, but I usually find the more time I spend working with the service the easier it is to build mocks. The models are the real pay dirt, you have slogged through low level requests that map to the provider api and now you want a nice interface. This is where models and collections come in. Collections provide access to lists of data on the provider and for creating new objects. Models represent the individual objects.
-If you know which object you'd like to represent you should start with the collection. When naming, please refer to the names that have been chosen for other services. I haven't standardized all nouns yet, but a few are already shared (Flavor, Image, Server)
-An example servers collection:
-    require 'fog/collection'
-    require 'fog/theservice/models/server'
-    module Fog
-      class TheService
-        class Servers < Fog::Collection
-          model Fog::TheService::Server
-          def all
-            # get list of servers
-            load(data) # data is an array of attribute hashes
-          end
-          def get(identity)
-            # get server matching id
-            new(data) # data is an attribute hash
-          rescue Excon::Errors::NotFound
-            nil
-          end
-        end
-      end
-    end
-### Highlights
-* First make an accessor in the Collections model so it will be included in Real and Mock.
-* `#model` will take a reference to the class that will be instantiated to represent individual objects.
-* `#all` should get a list of servers from the provider and pass an array of attribute hashes, one per server, to load.
-* `#get` should take an identity reference and instantiate a new model object with an attribute hash returned from the remote server, or return nil of no such object exists.
-Models handle remapping attributes into friendlier names and providing the rest of the interface.
-An example model:
-    require 'fog/model'
-    module Fog
-      module TheService
-        class Server << Fog::Model
-          identity  :id
-          attribute :state, 'StatusValue'
-          def destroy
-            requires :identity
-            connection.destroy_server(identity)
-            true
-          end
-          def ready?
-            state == 'running'
-          end
-          def save
-            requires ...
-            connection.create_server(options)
-            true
-          end
-        end
-      end
-    end
-### Highlights
-* `#identity` captures the id/name that the objects are identified by and takes the same arguments as attribute.
-* `#attribute` takes the name to make a variable available as and one or more aliases that parsers/requests will return this value as.
-* `#destroy` will require the identity of the model and should destroy it and return true.
-* `#ready?` should return whether the object has finished being initialized (where appropriate).
-* `#save` should take any required objects and instantiate the object on the provider's service.
-* These models just rely on underlying collections and requests, so it should not be necessary at this level to distinguish between Real and Mock methods.
-## Mocks
-Mocks provide a powerful tool for users of fog to experiment with their implementations much more quickly and without incurring costs. I usually save these for last, as implementing the requests and models provide some necessary context to finally put the mocks together. Your services mock class should have a data method that will return mocked data like so:
-    module Fog
-      module TheService
-        class Mock
-          def self.data
-            @data ||= Hash.new do |hash, key|
-              hash[key] = {}
-            end
-          end
-        end
-      end
-    end
-The keys in this hash should represent a unique identifier of the user accessing the data and the value assigned should contain any default data that a new user might have. Any implemented mock requests should then return data retrieved from here or raise an error.
-For instance:
-    module Fog
-      module TheService
-        class Mock
-          def destroy_server(server_identity)
-            if data = self.data[:servers].delete(server_identity)
-              response = Excon::Response.new
-              response.status = 202
-              response.body   = data
-              response
-            else
-              raise Fog::TheService::NotFound
-            end
-          end
-        end
-      end
-    end
-### Highlights
-* Mock requests should return the same type of data as an already parsed real response or should return the same error as a real problem.
-* By mocking at this low level, higher level functions are automatically mocked out for you.
-* The extra rigorous tests related to output formatting and error messages should help keep you honest, and each should pass in both mocked and unmocked modes.
-## Summary
-That provides a lot more detail than you will probably need right away, but hopefully you can refer back to different sections as you need them. If you have any questions send me a github message or email me (address is on my profile). You should always start development by creating your own fork. When you feel confident about your fork, send me a pull request. Be forewarned that I may edit some things before it gets to master, but I'll do my best to take care of this in a timely manner.
-Thanks again for your interest and let me know if there is anything else I can do to help.

data/docs/about/getting_started.markdown DELETED Viewed

@@ -1,108 +0,0 @@
----
-layout: default
-title:  Getting Started
----
-First off, install the gem:
-    $ gem install fog
-## Setting Up Local Storage
-We will be using Local storage in the example.  Local storage provides the same api that cloud storage services in fog do, but without the bother of needing to signup for stuff or pay extra money.
-First, make a local directory to hold your data.
-    $ mkdir ~/fog
-Now we can start writing our script, first off we should require fog.
-    require 'rubygems'
-    require 'fog'
-Now in order to play with our data we need to setup a storage connection.
-    storage = Fog::Storage.new({
-      :local_root => '~/fog',
-      :provider   => 'Local'
-    })
-`storage` will now contain our storage object, configured to use the Local provider from our specified directory.
-## Storing Data
-Now that you have cleared the preliminaries you are ready to start storing data. Storage providers in fog segregate files into `directories` to make it easier to organize things. So lets create a directory so we can see that in action.
-    directory = storage.directories.create(
-      :key => 'data'
-    )
-To make sure it was created you can always check in your filesystem, but we can also check from inside fog.
-    storage.directories
-Progress! Now it is time to actually create a file inside our new directory.
-    file = directory.files.create(
-      :body => 'Hello World!',
-      :key  => 'hello_world.txt'
-    )
-We should now have our file, first we can open it up and make sure we are on the right track.
-    $ open ~/fog/hello_world.txt
-It is much more likely that you will want to see what files you have from inside fog though.
-    directory.files
-Now that we have run through all the basics, lets clean up our mess.
-    file.destroy
-    directory.destroy
-After that you should be able to check your directory list in fog or your filesystem and see you are safely back to square one.
-## Next Steps
-Using the same interface you can also practice working against a real provider (such as Amazon S3). Rather than worrying about signing up for an account right away though, we can use mocks to simulate S3 while we practice.
-This time we will turn on mocking and then, just like before, we will need to make a connection.
-    Fog.mock!
-    storage = Fog::Storage.new({
-      :aws_access_key_id      => 'fake_access_key_id',
-      :aws_secret_access_key  => 'fake_secret_access_key',
-      :provider               => 'AWS'
-    })
-You may notice that we used bogus credentials, this is fine since we are just simulating things. To use real S3 you can simply omit Fog.mock! and swap in your real credentials.
-If you'd like to turn off mocking after turning it on, you can do it at any time and every subsequent connection will be a real connection.
-    # Turn on mocking
-    Fog.mock!
-    # Create a mock connection to S3
-    storage = Fog::Storage.new({
-      :aws_access_key_id => "asdf",
-      :aws_secret_access_key => "asdf",
-      :provider => "AWS"
-    })
-    # Turn off mocking
-    Fog.unmock!
-    # Create a real connection to S3
-    storage = Fog::Storage.new({
-      :aws_access_key_id => "asdf",
-      :aws_secret_access_key => "asdf",
-      :provider => "AWS"
-    })
-Don't worry about your losing mock data, it stays around until you reset it or until your process exits.
-    # Reset all mock data
-    Fog::Mock.reset
-Congratulations and welcome to the cloud!  Continue your journey at [fog.io](http://fog.io)