minimart 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yjk5YWIyMGEzYTNiODU2ODJkMTE0MGJmODJkMWUyNDcxMjNiYWYzNA==
+  data.tar.gz: !binary |-
+    ZGU0NmJiNjNjMTJlNWVlYjA3YjlmMTlmZmFhNjQwYTBlNDgwOWYxYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZDg2MmY5MWQ1NzUxNmZjNzEyYWY1N2RiNzhlMmM4MWQ2OGEyODQ5YmNmYjYz
+    MjcwYWZkYWQzZGI4MTdmOWY1ODg0MTNmYzQyMmE1NzkxNGNiYjg3ZGY2N2Uw
+    MjA2NjZlN2U5OWIyZDE4N2E0YzQyOTZiYjYxNzgyZTI5NjdlMDM=
+  data.tar.gz: !binary |-
+    YjBiNzgzYWYzYWVhMDZiZWJmNzM0MjUzYmYyNDgxYzA0ZGUxYTE1MjcxZmYy
+    NDI2MzRiMWU4N2UzMWVkMWE5MDQ2YzQ2ZmY0ZDhhNTM2ZDU2OWNlNmViZGIx
+    M2FkYjBlYzExYjdjYWVhZTI4ZDY5OTRjMzk0ZjA1MWZlZTQyODM=

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.sass-cache/
+/_site/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log
+.ruby-version
+.ruby-gemset
+.rvmrc
+vendor/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order rand

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- ruby-head
+- 2.1.1
+- 1.9.3
+deploy:
+  provider: rubygems
+  api_key:
+    secure: WQnBmi+DIi18NXL+iCZZ9gV8YEEmLQ8LOQY/nZ7fnnX1ziHpUDZjneXAP7t762d6dNYib8f6Bs5n+HltAhrKiyY+t/jErmjS3DR1UV2uv+/lZgu0KwxA9WSph5LBLKDYw1R+fWf6E7nlnm4+fhhT19Qr5VaL7Wsf9ojiv+RCl9U=
+  gem: minimart
+  on:
+    tags: true
+    repo: electric-it/minimart

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,198 @@
+# MiniMart
+
+MiniMart is a RubyGem that makes it simple to build a repository of Chef cookbooks using only static files.
+
+Minimart is made up of two main components:
+
+* A mirroring tool that will download any cookbooks described in an inventory file.
+
+* A web tool that will generate a Berkshelf compatible index of the cookbooks in your inventory, and a user friendly web interface for browsing cookbooks.
+
+## Installing Minimart
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minimart'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minimart
+
+## Basic Usage
+
+### Getting Started
+
+After installing the `minimart` gem, you can start a new MiniMart by running the following command:
+
+    $ minimart init
+
+### Mirroring Cookbooks
+
+The `init` command will generate a sample `inventory.yml` file for you to use as a reference when building your own inventory. A real inventory may look like the following:
+
+    sources:
+      - "https://supermarket.chef.io"
+    cookbooks:
+      apache2:
+        versions:
+          - '= 3.0.0'
+          - '= 2.0.0'
+      nginx:
+        version: "~> 2.7.0"
+        git:
+          location: "https://github.com/miketheman/nginx.git"
+          tags:
+            - 'v2.6.0'
+            - 'v2.5.0'
+
+This file allows you to specify multiple sources to fetch cookbooks from (in order of precedence). You can also specify multiple versions of the same cookbook, either from one of the sources, using Git, or a local path. All of the `version` style commands allow for plural, and singular YAML keys (version, versions, branch, branches, etc...).
+
+Once you are done modifying the `inventory.yml` file, you can run the `mirror` command to download any cookbooks to your local inventory.
+
+    $ minimart mirror
+
+The above inventory file would download multiple versions of the `apache2`, and `nginx` cookbooks. The inventory directory would have the following structure:
+
+    inventory
+    ├── apache2-2.0.0
+    │   ├── README.md
+    │   ├── metadata.rb
+    │   ├── ... (all of the other cookbook files)
+    ├── ... (directories and files for other cookbooks)
+
+### Generating a MiniMart Endpoint
+
+Once you are satisfied with the cookbooks in your inventory, you can use the `web` command to generate the MiniMart index file, archived cookbook directories, and static HTML for browsing any mirrored cookbooks. This directory structure will be built in your local directory (wherever you are running `minimart`), and can be synced to your web server, s3, etc...
+
+The `web` command requires the user to specify a `host` to build a proper index file. The `host` should be the domain name, or IP you plan to use to host Minimart. To generate a MiniMart that would be hosted on `example.com` you would run:
+
+    $ minimart web --host=http://example.com
+
+`web` will run through any of the cookbooks in the inventory, and generate the following:
+
+    web
+    ├── assets
+    │   ├── ... (CSS, JS, etc...)
+    ├── cookbook_files
+    │   ├── apache2
+    │   │   └── 2_0_0
+    │   │       └── apache2-2.0.0.tar.gz
+    │   ├── nginx
+    │   │   └── ... (additional .tar.gz cookbooks)
+    ├── cookbooks
+    │   ├── apache2
+    │   │   └── 2.0.0.html
+    │
+    ├── index.html
+    ├── universe
+
+It is important to note the creation of the `universe` file. This is the JSON index file that is necessary for MiniMart to work with Berkshelf. It contains a listing of all cookbook versions, and where they can be found (hence the need for the `host`).
+
+### Deploying MiniMart
+
+Deploying MiniMart *should* be as easy as syncing the contents of your `web` directory to a web server that will serve static files.
+
+The caveat is that you **must configure your server to serve the `universe` file with a content-type of `application/json`**.
+
+##### Amazon S3
+You must set the 'Content-Type' Metadata of `universe` to `application/json` with the tool you are using to sync files to S3.
+
+##### nginx
+In your nginx.conf:
+
+    location /universe {
+      default_type application/json;
+    }
+
+##### Apache
+In your apache2.conf:
+
+    <Location "/universe">
+    ForceType application/json
+    </Location>
+
+### Additional Configuration
+If you are using berkshelf-api, you can add chef, and github configuration options to your `inventory.yml` file to properly download cookbooks from those sources.
+
+    sources:
+      - "api.berkshelf.com"
+    configuration:
+      verify_ssl: true # This defaults to true!
+      chef:
+        client_name: 'berkshelf'
+        client_key: '/path/to.pem'
+      github:
+        organization: "org-name"
+        api_endpoint: "https://api.github.com/"
+        web_endpoint: "https://api.github.com/"
+
+
+### Example Jenkins Script
+This is an example of a script that can be used by Jenkins to sync the
+cookbooks to the S3 bucket. This script can be placed in the same
+directory as the `inventory.yml` file created by `minimart init`. This
+can be pulled down from a repository and then ran by Jenkins.
+
+    #!/bin/bash
+
+    # Exit 1 if any command fails
+    set -e
+
+    # Name of the repository bucket
+    BUCKET_NAME=your.s3.bucket.name
+
+    echo Changing to special RVM and gemset...
+    rvm 2.1.2
+
+    echo Updating required gems...
+    bundle install
+
+    echo Mirroring cookbooks...
+    minimart mirror
+
+    echo Generating market...
+    minimart web --host=$BUCKET_NAME
+
+    echo Syncing web site up to s3://$BUCKET_NAME
+    aws s3 sync web s3://$BUCKET_NAME --acl public-read --exclude
+    "web/universe"
+    aws s3 cp web/universe s3://$BUCKET_NAME --acl public-read
+
+    echo cleaning up Jenkins...
+    rm -rf ./inventory
+
+
+## Contributing
+
+1. Fork it ( https://github.com/electric-it/minimart/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## License
+
+```
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+        Unless required by applicable law or agreed to in writing,
+        software
+        distributed under the License is distributed on an "AS IS"
+        BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+        implied.
+        See the License for the specific language governing permissions
+        and
+        limitations under the License.
+```

data/Rakefile

@@ -0,0 +1,45 @@
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end
+
+namespace :web do
+  ROOT        = Pathname.new(File.dirname(__FILE__))
+  RAW_WEB_DIR = ROOT.join('web', '_assets')
+  WEB_DIR     = ROOT.join('web', 'assets')
+
+  desc 'Compile assets'
+  task :compile => [:compile_js, :compile_css]
+
+  task :compile_js do
+    require 'sprockets'
+    require 'uglifier'
+
+    puts 'Compiling JS...'
+    js_dir = WEB_DIR.join('javascripts')
+    FileUtils.mkdir_p(js_dir)
+    sprockets = Sprockets::Environment.new(ROOT)
+    sprockets.js_compressor  = :uglify
+    sprockets.append_path(RAW_WEB_DIR.join('javascripts'))
+    sprockets['manifest.js'].write_to(js_dir.join('application.min.js'))
+    puts 'Done Compiling JS...'
+  end
+
+  task :compile_css do
+    require 'sprockets'
+    require 'sass'
+
+    puts 'Compiling CSS...'
+    css_dir = WEB_DIR.join('stylesheets')
+    FileUtils.mkdir_p(css_dir)
+    sprockets = Sprockets::Environment.new(ROOT)
+    sprockets.css_compressor  = :sass
+    sprockets.append_path(RAW_WEB_DIR.join('stylesheets'))
+    sprockets['manifest.css'].write_to(css_dir.join('application.min.css'))
+    puts 'Done Compiling CSS...'
+  end
+end

data/bin/minimart

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$:.push File.expand_path('../../lib', __FILE__)
+require 'minimart/cli'
+Minimart::Cli.start(ARGV.dup)

data/lib/minimart.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'fileutils'
+
+module Minimart
+  require 'minimart/version'
+  require 'minimart/configuration'
+  require 'minimart/error'
+
+  require 'minimart/mirror'
+  require 'minimart/web'
+
+  def self.root_path
+    File.dirname(__FILE__)
+  end
+end

data/lib/minimart/cli.rb

@@ -0,0 +1,93 @@
+require 'thor'
+
+require 'minimart'
+require 'minimart/commands/mirror'
+require 'minimart/commands/web'
+
+module Minimart
+  # The command line interface for Minimart.
+  class Cli < Thor
+    include Thor::Actions
+
+    DEFAULT_INVENTORY_CONFIG    = './inventory.yml'
+    DEFAULT_INVENTORY_DIRECTORY = './inventory'
+    DEFAULT_WEB_DIRECTORY       = './web'
+
+    ##
+    # Init
+    ##
+    desc 'init', 'Begin a new Minimart.'
+    option :inventory_config, default: DEFAULT_INVENTORY_CONFIG
+    # Begin a new Minimart
+    def init
+      create_file options[:inventory_config] do
+<<-YML
+# sources:
+#   - "https://supermarket.getchef.com"
+# cookbooks:
+#   cookbook-name:
+#     versions:
+#       - "~> 4.0.2"
+#       - "> 5.0.0"
+#     git:
+#       location: url | path
+#       branches:
+#         - a_branch_name
+#       refs:
+#         - SHA
+
+YML
+      end
+    end
+
+    ##
+    # Mirror
+    ##
+    desc 'mirror', 'Mirror cookbooks specified in an inventory file.'
+    option :inventory_config,
+      default: DEFAULT_INVENTORY_CONFIG,
+      desc:    'The path to the Minimart config file. Minimart will create the file if it does not exist.'
+
+    option :inventory_directory,
+      default: DEFAULT_INVENTORY_DIRECTORY,
+      desc:    'The path to store any cookbooks downloaded by the mirroring tool.'
+    # Mirror cookbooks specified in an inventory file.
+    def mirror
+      Minimart::Commands::Mirror.new(options).execute!
+
+    rescue Minimart::Error::BaseError => e
+      Minimart::Error.handle_exception(e)
+    end
+
+    ##
+    # Web
+    ##
+    desc 'web', 'Generate a web interface to download any mirrored cookbooks.'
+    option :inventory_directory,
+      default: DEFAULT_INVENTORY_DIRECTORY,
+      desc:   'Path to the cookbooks downloaded by the mirroring tool.'
+
+    option :web_directory,
+      default: DEFAULT_WEB_DIRECTORY,
+      desc:    'Path to output the web endpoint of Minimart.'
+
+    option :host,
+      aliases: :h,
+      required: true,
+      desc:     'The web endpoint where Minimart will be hosted. This is required to properly generate the index file to be used by Berkshelf.'
+
+    option :html,
+      type:    :boolean,
+      default: true,
+      desc:    'Flag to determine whether or not to generate HTML output along with the universe endpoint.'
+
+    # Generate a web interface to download any mirrored cookbooks.
+    def web
+      Minimart::Commands::Web.new(options).execute!
+
+    rescue Minimart::Error::BaseError => e
+      Minimart::Error.handle_exception(e)
+    end
+
+  end
+end

data/lib/minimart/commands/mirror.rb

@@ -0,0 +1,30 @@
+module Minimart
+  module Commands
+    # Mirror is the main entrance point for the mirroring portion of Minimart.
+    # Given a directory, and a path to a config file, this class
+    # will generate an inventory.
+    class Mirror
+
+      # @return [String] The path to the inventory configuration file.
+      attr_reader :inventory_config
+
+      # @return [String] The directory to store the inventory.
+      attr_reader :inventory_directory
+
+
+      # @param [Hash] opts
+      # @option opts [String] :inventory_directory The directory to store the inventory.
+      # @option opts [String] :inventory_config The path to the inventory configuration file.
+      def initialize(opts)
+        @inventory_directory = opts[:inventory_directory]
+        @inventory_config    = Minimart::Mirror::InventoryConfiguration.new(opts[:inventory_config])
+      end
+
+      # Generate the inventory.
+      def execute!
+        builder = Minimart::Mirror::InventoryBuilder.new(inventory_directory, inventory_config)
+        builder.build!
+      end
+    end
+  end
+end