hyperkit 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c987dcdd24e8fd164c8c1aa0ba7d6424413afbf
-  data.tar.gz: f1cb3dccfbe526352a95b237e3f02e09371df577
+  metadata.gz: 31c1d9b05f7078a592ef2e0fcfaee2715cd16484
+  data.tar.gz: 12e2f1eabed87b1691627e1c1a884eaaaaedc94f
 SHA512:
-  metadata.gz: 21984f55160a78b75d64971d67ea3ff45d8d5017ff3f34c7b985a265c34961844f0717680fa0c7e3061a67328cbb3c68bc65219c15e2f73687b0328c0e38acd0
-  data.tar.gz: 37e780a30ca13a612637de881d91d8ea86ca83c8fb9e1f89faff770313458bbfee028c9c382dd6036241e7ea524ebec8641baa565f5380a347ed1b4bc1e59f70
+  metadata.gz: 7608210cba76349bf7530ef5ea62e05be8b4e4e4f17654e0bbf772cc38554a0d7caf69297b483eccdba2bf0a61a8747996ca535b1d40584efa8456621e9edf25
+  data.tar.gz: a38a4bd0fb00a4368d8d2919472e3e3378123cc358fe9dd3f58ffe70f8b6b4a7bd95b06a543e574ebdf6baa5997abf20cbd617da4dc88b98ab4575662aa6a78f

data/.travis.yml

@@ -1,4 +1,22 @@
 language: ruby
+
 rvm:
+  - jruby
+  - rbx-2
   - 1.9.3
-before_install: gem install bundler -v 1.11.2
+  - 2.0
+  - 2.1
+  - 2.2
+
+bundler_args: --without development
+
+sudo: false
+
+matrix:
+  allow_failures:
+    - rvm: jruby
+    - rvm: rbx-2
+    - rvm: 1.9.3
+
+notifications:
+  emails: true

data/Gemfile

@@ -1,19 +1,20 @@
 source 'https://rubygems.org'
 
+gem 'rake'
+
 group :development do
   gem 'awesome_print', :require => 'ap'
   gem 'guard-rspec', '~> 4.6'
   gem 'hirb-unicode'
   gem 'pry'
   gem 'yard'
-  gem 'rake'
 end
 
 group :test do
   gem 'coveralls', :require => false
   gem 'multi_json', '~> 1.11.0'
   gem 'rb-fsevent', '~> 0.9'
-  gem 'rspec', '~> 3.0.0'
+  gem 'rspec', '~> 3.0'
   gem 'simplecov', :require => false
   gem 'vcr', '~> 3.0'
   gem 'webmock', '~> 1.24.2'

data/README.md

@@ -1,5 +1,7 @@
 # Hyperkit
 
+[![Gem Version](https://badge.fury.io/rb/hyperkit.svg)](https://badge.fury.io/rb/hyperkit) [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/jeffshantz/hyperkit/master) [![Build Status](https://travis-ci.org/jeffshantz/hyperkit.svg?branch=master)](https://travis-ci.org/jeffshantz/hyperkit) [![Coverage Status](https://coveralls.io/repos/github/jeffshantz/hyperkit/badge.svg?branch=master)](https://coveralls.io/github/jeffshantz/hyperkit?branch=master)
+
 Hyperkit is a flat API wrapper for LXD, the next-generation hypervisor.  It is
 shamelessly based on the design of Octokit, the popular wrapper for the GitHub
 API.
@@ -51,17 +53,17 @@ lxd.create_snapshot("test-container", "test-snapshot")
 # container.
 lxd2 = Hyperkit::Client.new(api_endpoint: "https://lxd2.example.com")
 source = lxd2.init_migration("remote-container")
-lxd.migrate_container(source, "migrated-container")
+lxd.migrate(source, "migrated-container")
 ```
 
 Each method in the API documentation has at least one example of its usage.   Please see the documentation for the following modules:
 
-* [Certificates]()
-* [Containers]()
-* [Images]()
-* [Networks]()
-* [Operations]()
-* [Profiles]()
+* [Certificates](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Certificates)
+* [Containers](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Containers)
+* [Images](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Images)
+* [Networks](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Networks)
+* [Operations](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Operations)
+* [Profiles](http://www.rubydoc.info/github/jeffshantz/hyperkit/master/Hyperkit/Client/Profiles)
 
 ## Requirements
 
@@ -98,7 +100,7 @@ client = Octokit::Client.new(api_endpoint: 'https://lxd.example.com:8443', verif
 client.create_container("test-container", alias: "ubuntu/trusty/amd64")
 ```
 
-[API methods]: http://TODO
+[API methods]: http://www.rubydoc.info/list/github/jeffshantz/hyperkit/master/method
 
 ## Authentication
 
@@ -160,13 +162,13 @@ Alternatively, you can simply copy your certificate file to the LXD server and
 use the `lxc` tool to trust it:
 
 ```
-lxd-server$ lxc config trust add my-new-cert.crt
+$ lxc config trust add my-new-cert.crt
 ```
 
 ## API coverage
 
 Hyperkit supports the entirety of [version 1.0 of the LXD
-API](https://github.com/lxc/lxd/blob/master/specs/rest-api.md), but does not
+API](https://github.com/lxc/lxd/blob/master/doc/rest-api.md), but does not
 support any of the Websocket API calls (e.g. `/1.0/events`).
 
 ## Asynchronous Operations
@@ -296,6 +298,8 @@ implementation, you will be responsible for providing patches in a timely
 fashion. If critical issues for a particular implementation exist at the time
 of a major release, support for that Ruby version may be dropped.
 
+[travis]: https://travis-ci.org/jeffshantz/hyperkit
+
 ## Versioning
 
 This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations

data/hyperkit.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["hyperkit@jeffshantz.com"]
 
   spec.summary       = %q{Hyperkit is a flat API wrapper for LXD, the next-generation hypervisor}
-  spec.homepage      = "https://github.com/jeffshantz/hyperkit"
+  spec.homepage      = "http://jeffshantz.github.io/hyperkit"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
@@ -28,6 +28,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", "~> 4.2.6"
   spec.add_dependency "sawyer"
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "bundler", "~> 1.0"
 
 end

data/lib/hyperkit.rb

@@ -25,7 +25,7 @@ require 'hyperkit/default'
 
 # Ruby toolkit for the LXD API.
 # LXD - the next-generation container hypervisor for Linux
-module Hyperkit 
+module Hyperkit
 
   class << self
     include Hyperkit::Configurable

data/lib/hyperkit/client.rb

@@ -22,6 +22,7 @@
 
 require 'hyperkit/configurable'
 require 'hyperkit/connection'
+require 'hyperkit/utility'
 require 'hyperkit/client/certificates'
 require 'hyperkit/client/containers'
 require 'hyperkit/client/images'
@@ -42,6 +43,7 @@ module Hyperkit
 
     include Hyperkit::Configurable
     include Hyperkit::Connection
+    include Hyperkit::Utility
     include Hyperkit::Client::Certificates
     include Hyperkit::Client::Containers
     include Hyperkit::Client::Images

data/lib/hyperkit/client/certificates.rb

@@ -6,7 +6,7 @@ module Hyperkit
   class Client
 
     # Methods for the certificates API
-    # 
+    #
     # @see Hyperkit::Client
     # @see https://github.com/lxc/lxd/blob/master/specs/rest-api.md
     module Certificates
@@ -20,7 +20,7 @@ module Hyperkit
       #     "c782c0f3530a04a5b2b78fc5292b7500aef1299370288b5eeb0450a6613a2c82",
       #     "b7720e1eb839056158cf65d182865491a0403f766983b95f5098d05911bbff89"
       #   ]
-      def certificates 
+      def certificates
         response = get(certificates_path)
         response.metadata.map { |path| path.split('/').last }
       end
@@ -30,7 +30,7 @@ module Hyperkit
       # @param cert [String] Certificate contents in PEM format
       # @param options [Hash] Additional data to be passed
       # @option options [String] :name Optional name for the certificate.  If not specified, the host in the TLS header for the request is used.
-      # @option options [String] :password The trust password for that server.  Only required if untrusted. 
+      # @option options [String] :password The trust password for that server.  Only required if untrusted.
       # @return [Sawyer::Resource]
       #
       # @example Add trusted certificate
@@ -48,22 +48,20 @@ module Hyperkit
       #
       # @param fingerprint [String] Fingerprint of the certificate to retrieve.  Can be a prefix, as long as it is unambigous
       # @return [Sawyer::Resource] Certificate information
-      # 
+      #
       # @example Retrieve a certificate
       #   Hyperkit.certificate("c782c0f3530a04a5b2b78fc5292b7500aef1299370288b5eeb0450a6613a2c82") #=> {
-      #     :certificate => "-----BEGIN CERTIFICATE-----\nMIIEW...ceyg04=\n-----END CERTIFICATE-----\n", 
-      #     :fingerprint => "c782c0f3530a04a5b2b78fc5292b7500aef1299370288b5eeb0450a6613a2c82", 
-      #     :type => "client"   
+      #     :certificate => "-----BEGIN CERTIFICATE-----\nMIIEW...ceyg04=\n-----END CERTIFICATE-----\n",
+      #     :fingerprint => "c782c0f3530a04a5b2b78fc5292b7500aef1299370288b5eeb0450a6613a2c82",
+      #     :type => "client"
       #   }
       #
       # @example Retrieve a certificate by specifying a prefix of its fingerprint
       #   Hyperkit.certificate("c7") #=> {
-      #     :certificate => "-----BEGIN CERTIFICATE-----\nMIIEW...ceyg04=\n-----END CERTIFICATE-----\n", 
-      #     :fingerprint => "c782c0f3530a04a5b2b78fc5292b7500aef1299370288b5eeb0450a6613a2c82", 
-      #     :type => "client"   
+      #     :certificate => "-----BEGIN CERTIFICATE-----\nMIIEW...ceyg04=\n-----END CERTIFICATE-----\n",
+      #     :fingerprint => "c782c0f3530a04a5b2b78fc5292b7500aef1299370288b5eeb0450a6613a2c82",
+      #     :type => "client"
       #   }
-      #
-      # @todo Write tests for the prefix
       def certificate(fingerprint)
         get(certificate_path(fingerprint)).metadata
       end
@@ -78,8 +76,6 @@ module Hyperkit
       #
       # @example Delete a certificate by specifying a prefix of its fingerprint
       #   Hyperkit.delete_certificate("c7")
-      #
-      # @todo Write tests for the prefix
       def delete_certificate(fingerprint)
         delete(certificate_path(fingerprint)).metadata
       end

data/lib/hyperkit/client/containers.rb

@@ -6,7 +6,7 @@ module Hyperkit
   class Client
 
     # Methods for the containers API
-    # 
+    #
     # @see Hyperkit::Client
     # @see https://github.com/lxc/lxd/blob/master/specs/rest-api.md
     module Containers
@@ -198,7 +198,7 @@ module Hyperkit
 
         response = post(containers_path, opts).metadata
         handle_async(response, options[:sync])
-      
+
       end
 
       # @!endgroup
@@ -233,7 +233,7 @@ module Hyperkit
       #   container = Hyperkit.container("test-container")
       #   container.ephemeral = true
       #   Hyperkit.update_container("test-container", container)
-      #   
+      #
       # @example Change container's AppArmor profile to 'unconfined'.
       #   container = Hyperkit.container("test-container")
       #
@@ -248,11 +248,7 @@ module Hyperkit
       def update_container(name, config, options={})
 
         config = config.to_hash
- 
-        # Stringify values in the config hash, since LXD chokes on non-String values
-        if config[:config]
-          config[:config] = config[:config].inject({}){|h,(k,v)| h[k.to_s] = v.to_s; h}
-        end
+        config[:config] = stringify_hash(config[:config]) if config[:config]
 
         response = put(container_path(name), config).metadata
         handle_async(response, options[:sync])
@@ -271,7 +267,7 @@ module Hyperkit
       # @example Rename container "test" to "test2"
       #   Hyperkit.rename_container("test", "test2")
       def rename_container(old_name, new_name, options={})
-        response = post(container_path(old_name), { "name": new_name }).metadata
+        response = post(container_path(old_name), { name: new_name }).metadata
         handle_async(response, options[:sync])
       end
 
@@ -294,7 +290,7 @@ module Hyperkit
       #   Hyperkit.execute_command("test-container", "echo 'hello world'")
       #
       # @example Run a command (passed as an array) in container "test-container"
-      #   Hyperkit.execute_command("test-container", 
+      #   Hyperkit.execute_command("test-container",
       #     ["bash", "-c", "echo 'hello world' > /tmp/test.txt"]
       #   )
       #
@@ -311,10 +307,7 @@ module Hyperkit
         opts = options.slice(:environment)
         command = Shellwords.shellsplit(command) if command.is_a?(String)
 
-        # Stringify any environment values since LXD croaks on non-String values
-        if opts[:environment]
-          opts[:environment] = opts[:environment].inject({}){|h,(k,v)| h[k.to_s] = v.to_s; h}
-        end
+        opts[:environment] = stringify_hash(opts[:environment]) if opts[:environment]
 
         response = post(File.join(container_path(container), "exec"), {
           command: command,
@@ -504,7 +497,7 @@ module Hyperkit
       # Prepare to migrate a container or snapshot.  Generates source data to be passed to {#migrate}.
       #
       # Note that CRIU must be installed on the server to migrate a running container, or LXD will
-      # return a 500 error.  On Ubuntu, you can install it with 
+      # return a 500 error.  On Ubuntu, you can install it with
       # <code>sudo apt-get install criu</code>.
       #
       # @param name [String] Container name
@@ -562,7 +555,7 @@ module Hyperkit
           source = container(container)
         end
 
-        response = post(url, { "migration": true })
+        response = post(url, { migration: true })
         agent = response.agent
 
         source_data = {
@@ -583,7 +576,7 @@ module Hyperkit
       # Migrate a remote container or snapshot to the server
       #
       # Note that CRIU must be installed on the server to migrate a running container, or LXD will
-      # return a 500 error.  On Ubuntu, you can install it with 
+      # return a 500 error.  On Ubuntu, you can install it with
       # <code>sudo apt-get install criu</code>.
       #
       # Also note that, unless overridden with the <code>profiles</code> parameter, if the source
@@ -641,7 +634,7 @@ module Hyperkit
           opts["base-image"] = source.config["volatile.base_image"]
           opts[:config] = options[:config] || source.config.to_hash
 
-          # If we're only copying the container, and configuration was explicitly 
+          # If we're only copying the container, and configuration was explicitly
           # overridden, then remove the volatile entries
           if ! options[:move] && ! options.has_key?(:config)
             opts[:config].delete_if { |k,v| k.to_s.start_with?("volatile") }
@@ -662,7 +655,7 @@ module Hyperkit
           else
             raise Hyperkit::MissingProfiles.new("Not all profiles applied to source container exist on the target LXD instance")
           end
-          
+
         end
 
         if options.has_key?(:ephemeral)
@@ -735,11 +728,11 @@ module Hyperkit
 
       # Create a snapshot of a container
       #
-      # If <code>stateful: true</code> is passed when creating a snapshot of a 
+      # If <code>stateful: true</code> is passed when creating a snapshot of a
       # running container, the container's runtime state will be stored in the
-      # snapshot.  Note that CRIU must be installed on the server to create a 
+      # snapshot.  Note that CRIU must be installed on the server to create a
       # stateful snapshot, or LXD will return a 500 error.  On Ubuntu, you can
-      # install it with 
+      # install it with
       # <code>sudo apt-get install criu</code>.
       #
       # @async This method is asynchronous.  See {Hyperkit::Configurable#auto_sync} for more information.
@@ -795,7 +788,7 @@ module Hyperkit
       # @example Rename snapshot "test/snap1" to "snap2"
       #   Hyperkit.rename_snapshot("test", "snap1", "snap2")
       def rename_snapshot(container, old_name, new_name, options={})
-        response = post(snapshot_path(container, old_name), { "name": new_name }).metadata
+        response = post(snapshot_path(container, old_name), { name: new_name }).metadata
         handle_async(response, options[:sync])
       end
 
@@ -812,7 +805,7 @@ module Hyperkit
       # @example Restore container "test" back to snapshot "snap1"
       #   Hyperkit.restore_snapshot("test", "snap1")
       def restore_snapshot(container, snapshot, options={})
-        response = put(container_path(container), { "restore": snapshot }).metadata
+        response = put(container_path(container), { restore: snapshot }).metadata
         handle_async(response, options[:sync])
       end
 
@@ -844,21 +837,21 @@ module Hyperkit
       #
       # @example Copy /etc/passwd in container "test" to the local file /tmp/passwd
       #   Hyperkit.pull_file("test", "/etc/passwd", "/tmp/passwd") #=> "/tmp/passwd"
-			def pull_file(container, source_file, dest_file)
-				contents = get(file_path(container, source_file), url_encode: false)
-				headers = last_response.headers
+      def pull_file(container, source_file, dest_file)
+        contents = get(file_path(container, source_file), url_encode: false)
+        headers = last_response.headers
 
-				File.open(dest_file, "wb") do |f|
-					f.write(contents)
-				end
+        File.open(dest_file, "wb") do |f|
+          f.write(contents)
+        end
 
-				if headers["x-lxd-mode"]
-					File.chmod(headers["x-lxd-mode"].to_i(8), dest_file)
-				end
+        if headers["x-lxd-mode"]
+          File.chmod(headers["x-lxd-mode"].to_i(8), dest_file)
+        end
 
-				dest_file
+        dest_file
 
-			end
+      end
 
       # Write to a file in a container
       #
@@ -896,14 +889,14 @@ module Hyperkit
         headers["X-LXD-gid"] = options[:gid].to_s if options[:gid]
         headers["X-LXD-mode"] = options[:mode].to_s(8).rjust(4, "0") if options[:mode]
 
-				if ! block_given?
-					content = options[:content].to_s
-				else
-					io = StringIO.new
-					yield io
-					io.rewind
-					content = io.read
-				end
+        if ! block_given?
+          content = options[:content].to_s
+        else
+          io = StringIO.new
+          yield io
+          io.rewind
+          content = io.read
+        end
 
         post(file_path(container, dest_file), {
           raw_body: content,
@@ -949,7 +942,7 @@ module Hyperkit
       # Retrieve a list of logs for a container
       #
       # @param container [String] Container name
-      # @return [Array<String>] An array of log filenames 
+      # @return [Array<String>] An array of log filenames
       #
       # @example Get list of logs for container "test-container"
       #   Hyperkit.logs("test-container")
@@ -1022,11 +1015,8 @@ module Hyperkit
       def extract_container_options(name, options)
         opts = options.slice(:architecture, :profiles, :ephemeral, :config).
                        merge({ name: name })
-      
-        # Stringify any config values since LXD croaks on non-String values
-        if opts[:config]
-          opts[:config] = opts[:config].inject({}){|h,(k,v)| h[k.to_s] = v.to_s; h}
-        end
+
+        opts[:config] = stringify_hash(opts[:config]) if opts[:config]
 
         opts
       end
@@ -1092,7 +1082,7 @@ module Hyperkit
         opts
 
       end
- 
+
     end
 
   end

data/lib/hyperkit/client/images.rb

@@ -3,7 +3,7 @@ module Hyperkit
   class Client
 
     # Methods for the images API
-    # 
+    #
     # @see Hyperkit::Client
     # @see https://github.com/lxc/lxd/blob/master/specs/rest-api.md
     module Images
@@ -14,10 +14,10 @@ module Hyperkit
       #
       # @return [Array<String>] An array of image fingerprints
       #
-      # @example Get list of images 
+      # @example Get list of images
       #   Hyperkit.images #=> ["54c8caac1f61901ed86c68f24af5f5d3672bdc62c71d04f06df3a59e95684473",
       #                               "97d97a3d1d053840ca19c86cdd0596cf1be060c5157d31407f2a4f9f350c78cc"]
-      def images 
+      def images
         response = get(images_path)
         response.metadata.map { |path| path.split('/').last }
       end
@@ -171,15 +171,15 @@ module Hyperkit
       # @return [Sawyer::Resource] Operation or result, depending value of <code>:sync</code> parameter and/or {Hyperkit::Client::auto_sync}
       #
       # @example Import image by alias
-      #   Hyperkit.create_image_from_remote("https://images.linuxcontainers.org:8443", 
+      #   Hyperkit.create_image_from_remote("https://images.linuxcontainers.org:8443",
       #     alias: "ubuntu/xenial/amd64")
-      #     
+      #
       # @example Import image by fingerprint
-      #   Hyperkit.create_image_from_remote("https://images.linuxcontainers.org:8443", 
+      #   Hyperkit.create_image_from_remote("https://images.linuxcontainers.org:8443",
       #     fingerprint: "b1cf3d836196c316897d39872ff25e2d912ea933207b0c591334a67b290a5f1b")
       #
       # @example Import image and automatically update it when it is updated on the remote server
-      #   Hyperkit.create_image_from_remote("https://images.linuxcontainers.org:8443", 
+      #   Hyperkit.create_image_from_remote("https://images.linuxcontainers.org:8443",
       #     alias: "ubuntu/xenial/amd64",
       #     auto_update: true)
       #
@@ -200,7 +200,7 @@ module Hyperkit
 
         opts[:source] = options.slice(:secret, :protocol, :certificate)
         opts[:source].merge!({
-          type: "image", 
+          type: "image",
           mode: "pull",
           server: server
         })
@@ -209,7 +209,7 @@ module Hyperkit
           raise Hyperkit::ImageIdentifierRequired.new("Please specify either :alias or :fingerprint")
         end
 
-        opts[:properties] = stringify_properties(options[:properties]) if options[:properties]
+        opts[:properties] = stringify_hash(options[:properties]) if options[:properties]
 
         if options[:alias]
           opts[:source][:alias] = options[:alias]
@@ -218,12 +218,12 @@ module Hyperkit
         end
 
         response = post(images_path, opts).metadata
-				handle_async(response, options[:sync])
+        handle_async(response, options[:sync])
       end
 
       # Import an image from a remote URL.
       #
-      # Note: the URL passed to this method is <b>not</b> the URL of a tarball.  
+      # Note: the URL passed to this method is <b>not</b> the URL of a tarball.
       # Instead, the URL must return the following headers:
       #
       # * <code>LXD-Image-URL</code> - URL of the image tarball
@@ -277,11 +277,11 @@ module Hyperkit
       def create_image_from_url(url, options={})
 
         opts = options.slice(:filename, :public)
-        opts[:properties] = stringify_properties(options[:properties]) if options[:properties]
-				opts[:source] = {
-					type: "url",
-					url: url
-				}
+        opts[:properties] = stringify_hash(options[:properties]) if options[:properties]
+        opts[:source] = {
+          type: "url",
+          url: url
+        }
 
         response = post(images_path, opts).metadata
         handle_async(response, options[:sync])
@@ -317,14 +317,14 @@ module Hyperkit
       def create_image_from_container(name, options={})
 
         opts = options.slice(:filename, :public, :description)
-        opts[:properties] = stringify_properties(options[:properties]) if options[:properties]
-				opts[:source] = {
-					type: "container",
-					name: name
-				}
+        opts[:properties] = stringify_hash(options[:properties]) if options[:properties]
+        opts[:source] = {
+          type: "container",
+          name: name
+        }
 
         response = post(images_path, opts).metadata
-				handle_async(response, options[:sync])
+        handle_async(response, options[:sync])
       end
 
       # Create an image from an existing snapshot.
@@ -358,14 +358,14 @@ module Hyperkit
       def create_image_from_snapshot(container, snapshot, options={})
 
         opts = options.slice(:filename, :public, :description)
-        opts[:properties] = stringify_properties(options[:properties]) if options[:properties]
-				opts[:source] = {
-					type: "snapshot",
-					name: "#{container}/#{snapshot}"
-				}
+        opts[:properties] = stringify_hash(options[:properties]) if options[:properties]
+        opts[:source] = {
+          type: "snapshot",
+          name: "#{container}/#{snapshot}"
+        }
 
         response = post(images_path, opts).metadata
-				handle_async(response, options[:sync])
+        handle_async(response, options[:sync])
       end
 
       # Delete an image
@@ -385,7 +385,7 @@ module Hyperkit
       #   Hyperkit.delete_image("b41")
       def delete_image(fingerprint, options={})
         response = delete(image_path(fingerprint)).metadata
-				handle_async(response, options[:sync])
+        handle_async(response, options[:sync])
       end
 
       # @!endgroup
@@ -404,7 +404,7 @@ module Hyperkit
       # @example Set image to be publicly-accessible
       #   Hyperkit.update_image("b1cf3d836196c316897d39872ff25e2d912ea933207b0c591334a67b290a5f1b",
       #     public: true)
-      #     
+      #
       # @example Overwrite image properties (removes all existing properties, sets "hello" property to "world")
       #   Hyperkit.update_image("b1cf3d836196c316897d39872ff25e2d912ea933207b0c591334a67b290a5f1b",
       #     properties: {
@@ -424,15 +424,15 @@ module Hyperkit
       #   )
       def update_image(fingerprint, options={})
         opts = options.slice(:public, :auto_update)
-        opts[:properties] = stringify_properties(options[:properties]) if options[:properties]
+        opts[:properties] = stringify_hash(options[:properties]) if options[:properties]
 
         put(image_path(fingerprint), opts).metadata
       end
- 
-      # Generate a secret for an image that can be used by an untrusted client 
+
+      # Generate a secret for an image that can be used by an untrusted client
       # to retrieve information on and/or export a private image.
       #
-      # The secret is automatically invalidated 5 seconds after first using it 
+      # The secret is automatically invalidated 5 seconds after first using it
       # (e.g. after calling Hyperkit.image(fingerprint, secret: "...").
       # This allows one to both retrieve the image information and then export it
       # with the same secret.
@@ -443,7 +443,6 @@ module Hyperkit
       #
       # @param fingerprint [String] Fingerprint of the image.  This can be a prefix of an image's fingerprint, as long as it is unambiguous.
       # @return [Sawyer::Response] An asynchronous response containing the generated secret
-      # @todo Add test for fingerprint prefix
       #
       # @example Generate a secret for an image
       #   response = Hyperkit.create_image_secret("878cf0c70e14fec80aaf4d5e923670e68c45aa89fb05a481019bf086aec42649") #=> {
@@ -498,7 +497,7 @@ module Hyperkit
       #
       # @example Export private image via secret (created by {#create_image_secret})
       #   image = Hyperkit.image_by_alias("busybox/default/amd64")
-      #   Hyperkit.export_image(image.fingerprint, 
+      #   Hyperkit.export_image(image.fingerprint,
       #     "/tmp", secret: "secret-issued-by-create_image_secret") => "/tmp/busybox-v1.21.1-lxc.tar.xz"
       def export_image(fingerprint, output_dir, options={})
 
@@ -541,7 +540,7 @@ module Hyperkit
       #     "ubuntu/xenial/ppc64el",
       #     "ubuntu/xenial/s390x/default",
       #     "ubuntu/xenial/s390x"
-      #   ] 
+      #   ]
       def image_aliases
         response = get(image_aliases_path)
         response.metadata.map { |path| path.sub("#{image_aliases_path}/","") }
@@ -561,7 +560,7 @@ module Hyperkit
       def image_alias(alias_name)
         get(image_alias_path(alias_name)).metadata
       end
- 
+
       # Assign an alias for an image
       #
       # @param fingerprint [String] Fingerprint of the image
@@ -659,12 +658,6 @@ module Hyperkit
         "/1.0/images"
       end
 
-      # Stringify any property values.  LXD returns an error if 
-      # integers are passed, for example
-			def stringify_properties(properties)
-          properties.inject({}){|h,(k,v)| h[k.to_s] = v.to_s; h}
-			end
- 
     end
 
   end

data/lib/hyperkit/client/networks.rb

@@ -3,7 +3,7 @@ module Hyperkit
   class Client
 
     # Methods for the networks API
-    # 
+    #
     # @see Hyperkit::Client
     # @see https://github.com/lxc/lxd/blob/master/specs/rest-api.md
     module Networks
@@ -38,7 +38,7 @@ module Hyperkit
       def networks_path
         "/1.0/networks"
       end
- 
+
     end
 
   end

data/lib/hyperkit/client/operations.rb

@@ -5,7 +5,7 @@ module Hyperkit
   class Client
 
     # Methods for the operations API
-    # 
+    #
     # @see Hyperkit::Client
     # @see https://github.com/lxc/lxd/blob/master/specs/rest-api.md
     module Operations
@@ -14,7 +14,7 @@ module Hyperkit
       #
       # This will include operations that are currently executing, as well as
       # operations that are paused until {#wait_for_operation} is called, at
-      # which time they will begin executing. 
+      # which time they will begin executing.
       #
       # Additionally, since LXD keeps completed operations around for 5 seconds,
       # the list returned may include recently completed operations.
@@ -40,7 +40,7 @@ module Hyperkit
       #     :created_at => 2016-04-14 21:30:59 UTC,
       #     :updated_at => 2016-04-14 21:30:59 UTC,
       #     :status => "Running",
-      #     :status_code => 103, 
+      #     :status_code => 103,
       #     :resources => {
       #       :containers => ["/1.0/containers/test-container"]
       #     },
@@ -54,13 +54,13 @@ module Hyperkit
 
       # Cancel a running operation
       #
-      # Calling this will change the state of the operation to 
+      # Calling this will change the state of the operation to
       # <code>cancelling</code>.  Note that the operation must be cancelable,
-      # which can be ascertained by calling {#operation} and checking the 
+      # which can be ascertained by calling {#operation} and checking the
       # <code>may_cancel</code> property.
       #
       # @param [String] uuid UUID of the operation
-      # @return [Sawyer::Resource] 
+      # @return [Sawyer::Resource]
       #
       # @example Cancel an operation
       #   Hyperkit.cancel_operation("8b3dd0c2-9dad-4964-b00d-e21481a47fb8") => {}
@@ -70,10 +70,15 @@ module Hyperkit
 
       # Wait for an asynchronous operation to complete
       #
-      # Note that this is only needed if {#Hyperkit::auto_sync} has been
+      # Note that this is only needed if {Hyperkit::Configurable#auto_sync} has been
       # set to <code>false</code>, or if the option <code>sync: false</code>
       # has been passed to an asynchronous method.
       #
+      # Note that, after an operation completes, LXD keeps it around for only 5
+      # seconds, so if you wait too long to call
+      # <code>wait_for_operation</code>, you'll get an exception when you
+      # eventually do call it.
+      #
       # @param [String] uuid UUID of the operation
       # @param [Fixnum] timeout Maximum time to wait (default: indefinite)
       # @return [Sawyer::Resource] Operation result
@@ -99,7 +104,7 @@ module Hyperkit
 
         sync = sync.nil? ? auto_sync : sync
 
-        if sync 
+        if sync
           wait_for_operation(response.id)
         else
           response
@@ -111,10 +116,10 @@ module Hyperkit
         File.join(operations_path, uuid)
       end
 
-      def operations_path 
+      def operations_path
         "/1.0/operations"
       end
- 
+
     end
 
   end

data/lib/hyperkit/client/profiles.rb

@@ -5,39 +5,112 @@ module Hyperkit
   class Client
 
     # Methods for the profiles API
-    # 
+    #
     # @see Hyperkit::Client
     # @see https://github.com/lxc/lxd/blob/master/specs/rest-api.md
     module Profiles
 
-      # GET /profiles
+      # List of profiles on the server
+      #
+      # @return [Array<String>] An array of profile names
+      #
+      # @example Get list of profiles
+      #   Hyperkit.profiles #=> ["default", "docker"]
       def profiles
         response = get(profiles_path)
         response.metadata.map { |path| path.split('/').last }
       end
 
-      # POST /profiles
+      # Create a profile
+      #
+      # @param name [String] Profile name
+      # @param options [Hash] Additional data to be passed
+      # @option options [Hash] :config Profile configuration
+      # @option options [String] :description Profile description
+      # @option options [Hash] :devices Profile devices
+      # @return [Sawyer::Resource]
+      #
+      # @example Create profile with config
+      #   Hyperkit.create_profile("test-profile", config: {
+      #     "limits.memory" => "2GB",
+      #     "limits.cpu" => 2,
+      #     "raw.lxc" => "lxc.aa_profile = unconfined"
+      #   })
+      #
+      # @example Create profile with devices
+      #   Hyperkit.create_profile("test-profile", devices: {
+      #     eth0: {
+      #       nictype: "bridged",
+      #       parent: "br-ext",
+      #       type: "nic"
+      #     }
+      #   })
       def create_profile(name, options={})
-        options = options.merge(name: name)
-        post(profiles_path, options).metadata
+        opts = options.merge(name: name)
+        opts[:config] = stringify_hash(opts[:config]) if opts[:config]
+        post(profiles_path, opts).metadata
       end
 
-      # GET /profiles/<name>
+      # Retrieve a profile
+      #
+      # @param name [String] Profile name
+      # @return [Sawyer::Resource] Profile
+      #
+      # @example Retrieve profile 'test-profile'
+      #   Hyperkit.profile("test-profile")
       def profile(name)
         get(profile_path(name)).metadata
       end
 
-      # PUT /profiles/<name>
+      # Update an existing profile
+      #
+      # @param name [String] Profile name
+      # @param options [Hash] Additional data to be passed
+      # @option options [Hash] :config Profile configuration.  Existing configuration will be overwritten.
+      # @option options [String] :description Profile description
+      # @option options [Hash] :devices Profile devices.  Existing devices will be overwritten.
+      # @return [Sawyer::Resource]
+      #
+      # @example Update profile with config (config is overwritten -- not merged)
+      #   Hyperkit.update_profile("test-profile", config: {
+      #     "limits.memory" => "4GB",
+      #     "limits.cpu" => 4,
+      #     "raw.lxc" => "lxc.aa_profile = unconfined"
+      #   })
+      #
+      # @example Create profile with devices (devices are overwritten -- not merged)
+      #   Hyperkit.create_profile("test-profile", devices: {
+      #     eth0: {
+      #       nictype: "bridged",
+      #       parent: "br-int",
+      #       type: "nic"
+      #     }
+      #   })
       def update_profile(name, options={})
-        put(profile_path(name), options.except(:name)).metadata
+        opts = options.except(:name)
+        opts[:config] = stringify_hash(opts[:config]) if opts[:config]
+        put(profile_path(name), opts).metadata
       end
 
-      # POST /profiles/<name>
+      # Rename a profile
+      #
+      # @param old_name [String] Existing profile name
+      # @param new_name [String] New profile name
+      # @return [Sawyer::Resource]
+      #
+      # @example Rename profile 'test' to 'test2'
+      #   Hyperkit.rename_profile("test", "test2")
       def rename_profile(old_name, new_name)
         post(profile_path(old_name), { name: new_name }).metadata
       end
 
-      # DELETE /profiles/<name>
+      # Delete a profile
+      #
+      # @param name [String] Profile name
+      # @return [Sawyer::Resource]
+      #
+      # @example Delete profile 'test-profile'
+      #   Hyperkit.delete_profile("test-profile")
       def delete_profile(name)
         delete(profile_path(name)).metadata
       end
@@ -47,7 +120,7 @@ module Hyperkit
       def profiles_path
         "/1.0/profiles"
       end
- 
+
       def profile_path(name)
         File.join(profiles_path, name)
       end

data/lib/hyperkit/configurable.rb

@@ -29,10 +29,54 @@ module Hyperkit
     # @!attribute api_endpoint
     #   @return [String] the base URL for API requests (default: <code>https://localhost:8443/</code>)
     # @!attribute auto_sync
+    #   Whether to automatically wait for asynchronous operations to complete
+    #
+    #   A good deal of the LXD API calls are asynchronous: you issue the call,
+    #   and you receive an operation ID.  You must then wait on the operation
+    #   to complete.  Each asynchronous method is marked as such in the Hyperkit
+    #   documentation.
+    #
+    #   <b>By default, Hyperkit provides auto-synchronization</b>.  When you
+    #   initiate an asynchronous operation, Hyperkit will automatically wait for
+    #   the operation to complete before returning.  If you wish to override
+    #   this functionality, there are two ways to do this:
+    #
+    #   * Pass <code>sync: false</code> to any of the asynchronous methods
+    #   * Set <code>auto_sync</code> to <code>false</code> at the module or
+    #     class level (see examples)
+    #
+    #   Any asynchronous calls you issue after setting <code>auto_sync</code>
+    #   to <code>false</code> will immediately return an operation ID instead of
+    #   blocking.  To ensure that an operation is complete, you will need to
+    #   call {Hyperkit::Client::Operations#wait_for_operation}.
+    #
+    #   Most users will likely want to keep <code>auto_sync</code> enabled for
+    #   convenience.
+    #
+    #   @example Create a container and automatically wait for it to complete (auto_sync is <code>true</code> by default)
+    #     Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64")
+    #
+    #   @example Disable auto-synchronization at the module level
+    #     Hyperkit.auto_sync = false
+    #     op = Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64")
+    #     Hyperkit.wait_for_operation(op.id)
+    #
+    #   @example Disable auto-synchronization at the class level
+    #     client = Hyperkit::Client.new(auto_sync: false)
+    #     op = client.create_container("test-container", alias: "ubuntu/trusty/amd64")
+    #     client.wait_for_operation(op.id)
+    #
+    #   @example Disable auto-synchronization, but enable it for one call by passing <code>sync: true</code>
+    #     Hyperkit.auto_sync = false
+    #     Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64", sync: true)
+    #   @example Enable auto-synchronization, but disable it for one call by passing <code>sync: false</code>
+    #     Hyperkit.auto_sync = true
+    #     op = Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64", sync: false)
+    #     Hyperkit.wait_for_operation(op.id)
     #   @return [String] whether to automatically wait on asynchronous events (default: <code>true</code>)
     # @!attribute client_cert
     #   @return [String] the client certificate used to authenticate to the LXD server
-    # @!attribute client_key 
+    # @!attribute client_key
     #   @return [String] the client key used to authenticate to the LXD server
     # @!attribute default_media_type
     #   @return [String] the preferred media type (for API versioning, for example)

data/lib/hyperkit/connection.rb

@@ -166,9 +166,9 @@ module Hyperkit
       if client_cert && File.exist?(client_cert)
         conn_opts[:ssl][:client_cert] = OpenSSL::X509::Certificate.new(File.read(client_cert))
       end
-      
+
       if client_key && File.exist?(client_key)
-        conn_opts[:ssl][:client_key] = OpenSSL::PKey::RSA.new(File.read(client_key)) 
+        conn_opts[:ssl][:client_key] = OpenSSL::PKey::RSA.new(File.read(client_key))
       end
 
       opts[:faraday] = Faraday.new(conn_opts)

data/lib/hyperkit/default.rb

@@ -46,7 +46,7 @@ module Hyperkit
     # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
     RACK_BUILDER_CLASS = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
 
-		# Default Faraday middleware stack
+    # Default Faraday middleware stack
     MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
       builder.use Hyperkit::Middleware::FollowRedirects
       builder.use Hyperkit::Response::RaiseError

data/lib/hyperkit/error.rb

@@ -43,7 +43,7 @@ module Hyperkit
       err
 
     end
-  
+
     def self.from_async_operation(response)
 
       return nil if response.nil? || response[:body].empty?
@@ -106,15 +106,15 @@ module Hyperkit
     end
 
     def self.error_for_500(response)
-			
+
       if response.body =~ /open: no such file or directory/i
         Hyperkit::NotFound
       elsif response.body =~ /open: is a directory/i
         Hyperkit::BadRequest
-			else
+      else
         Hyperkit::InternalServerError
       end
-     
+
     end
 
     private
@@ -146,7 +146,7 @@ module Hyperkit
 
     def response_error
       err = nil
-      
+
       if data.is_a?(Hash) && data[:error]
         err = data[:error]
       elsif data.is_a?(Hash) && data[:metadata]
@@ -247,7 +247,7 @@ module Hyperkit
   # none is provided
   class ImageIdentifierRequired < StandardError; end
 
-  # Raised when a method requires attributes of an alias to be 
+  # Raised when a method requires attributes of an alias to be
   # passed (e.g. description, traget), but none is provided
   class AliasAttributesRequired < StandardError; end
 

data/lib/hyperkit/middleware/follow_redirects.rb

@@ -2,14 +2,14 @@ require 'faraday'
 require 'set'
 
 module Hyperkit
- 
+
   module Middleware
 
     # Public: Exception thrown when the maximum amount of requests is exceeded.
     #
     # Taken from Octokit, which was originally adapted from
     # https://github.com/lostisland/faraday_middleware/blob/138766e/lib/faraday_middleware/response/follow_redirects.rb
-  
+
     class RedirectLimitReached < Faraday::Error::ClientError
       attr_reader :response
 

data/lib/hyperkit/utility.rb

@@ -0,0 +1,22 @@
+module Hyperkit
+
+  # Utility methods for Hyperkit
+  module Utility
+
+    private
+
+    # Stringify the keys and values of a hash
+    #
+    # LXD often chokes on non-String JSON values.  This method simply
+    # takes a Hash and stringifies its keys and values.  The result
+    # can then be converted to JSON and passed to LXD.
+    #
+    # @param input [Hash] Original Hash
+    # @return A copy of the Hash, with its keys and values stringified
+    def stringify_hash(input)
+      input.inject({}){|h,(k,v)| h[k.to_s] = v.to_s; h}
+    end
+
+  end
+
+end

data/lib/hyperkit/version.rb

@@ -1,3 +1,3 @@
 module Hyperkit
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperkit
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Jeff Shantz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.0'
 description: 
 email:
 - hyperkit@jeffshantz.com
@@ -87,8 +87,9 @@ files:
 - lib/hyperkit/error.rb
 - lib/hyperkit/middleware/follow_redirects.rb
 - lib/hyperkit/response/raise_error.rb
+- lib/hyperkit/utility.rb
 - lib/hyperkit/version.rb
-homepage: https://github.com/jeffshantz/hyperkit
+homepage: http://jeffshantz.github.io/hyperkit
 licenses:
 - MIT
 metadata: {}