rancher-api 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e337f5276881a7c831bc00a1c18e0c8882c9582
-  data.tar.gz: 54f4fefb50597f3461833702b815b482121e74b0
+  metadata.gz: cb8f88ffae8adb164999403ecdbd8448c5396c9c
+  data.tar.gz: d36bb511111622f42f4d7fb5e81bea7ac5856622
 SHA512:
-  metadata.gz: 0f3770f21943d4af6818e30b5f0b3019729b710834c1bb70829ad9dfd72da4cff0ea936155e42935445a31cfb7d2c668ed3e1c5fbf231c5a314fedce5655d04d
-  data.tar.gz: 31ae813f34c201932bb7a1c7525376af03c1b41b1928f57b450f2ad583e06f0e82dd93f1dd8aa193c4d68263cf53af9ed6caebdc2968f30d345a5e906df56529
+  metadata.gz: 8932873e8728d37462c7cf1a8ac969c717d981a68623b358d126ee74860e9d426dcc8f7f448c1ec27acd55d00a38f0aa2f437ebcfab776c23701b38bb5719bca
+  data.tar.gz: 767307b8bbd15e462e1c23144c676c0c529a9737acc647676df2cbbf6a5dcb917a751309e2814a81859ab1b1664cc7f01af186d2d8af85c36b5dc33695c4501c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rancher-api (0.3.5)
+    rancher-api (0.3.6)
       faraday_middleware
       faye-websocket
       her (~> 0.7.6)
@@ -9,24 +9,28 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.3)
-      activesupport (= 4.2.3)
+    activemodel (4.2.5.2)
+      activesupport (= 4.2.5.2)
       builder (~> 3.1)
-    activesupport (4.2.3)
+    activesupport (4.2.5.2)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    addressable (2.3.8)
     builder (3.2.2)
     byebug (6.0.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    eventmachine (1.0.8)
-    faraday (0.9.1)
+    eventmachine (1.0.9.1)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.9.1)
+    faraday_middleware (0.10.0)
       faraday (>= 0.7.4, < 0.10)
-    faye-websocket (0.10.0)
+    faye-websocket (0.10.3)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
     her (0.7.6)
@@ -36,9 +40,14 @@ GEM
       multi_json (~> 1.7)
     i18n (0.7.0)
     json (1.8.3)
-    minitest (5.8.0)
+    method_source (0.8.2)
+    minitest (5.8.4)
     multi_json (1.11.2)
     multipart-post (2.0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.4.2)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
@@ -53,10 +62,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.2)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    websocket-driver (0.6.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
 
@@ -66,9 +81,12 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.10)
   byebug
+  pry
   rake (~> 10.0)
   rancher-api!
   rspec (~> 3.3.0)
+  vcr (= 2.9.3)
+  webmock (= 1.21.0)
 
 BUNDLED WITH
    1.10.5

data/README.md

@@ -1,5 +1,14 @@
 # Rancher::Api
 
+[![Gem Version](https://badge.fury.io/rb/rancher-api.svg)](http://badge.fury.io/rb/rancher-api)
+![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/rancher-api)
+
+
+[![Circle CI](https://circleci.com/gh/akurkin/rancher-api/tree/master.svg?style=svg)](https://circleci.com/gh/akurkin/rancher-api/tree/master)
+[![Code Climate](https://codeclimate.com/github/akurkin/rancher-api/badges/gpa.svg)](https://codeclimate.com/github/akurkin/rancher-api)
+[![Test Coverage](https://codeclimate.com/github/akurkin/rancher-api/badges/coverage.svg)](https://codeclimate.com/github/akurkin/rancher-api/coverage)
+
+
 Rancher::Api is a Ruby wrapper around [Rancher](http://rancher.com/) API built with [Her](http://www.her-rb.org/)
 
 Connect to Rancher and execute requests from your ruby scripts.
@@ -29,24 +38,34 @@ Or install it yourself as:
 ## Rancher Version
 
 Tested with:
-Rancher v0.32.0
+Rancher v0.63.1
 
 ## Usage
 
 Configure Rancher::Api first by providing url, access and secret keys:
 
-### Entities
-
-**Project** - Top level object that represents "Environment" in Rancher UI
-**Service** - Service (combines containers from the same image)
-**Machine** - Physical docker hosts
-**Instance** - represents containers that were ever installed via Rancher. Better to query containers as nested resource, cuz there can be thousands of containers that were running before and still available to query via API. Removed containers are marked as 'removed' respectively.
-**Environment** - In rancher UI these are known as **Stack**, though in API they are **environments**. We're sticking to API resource name.
-**Host** - these are hosts, with detailed information about docker installation and resources
+### Classes
+
+- **Project**
+Top level object that represents "Environment" in Rancher UI
+- **Service**
+Service (combines containers from the same image)
+- **Machine**
+Physical docker hosts
+- **Instance**
+represents containers that were ever installed via Rancher. Better to query containers as nested resource, cuz there can be thousands of containers that were running before and still available to query via API. Removed containers are marked as 'removed' respectively
+- **Environment**
+In Rancher UI these are known as **Stack**, though in API they are **environments**. We're sticking to API resource name
+- **Host**
+These are hosts, with detailed information about docker installation and resources
 
 ### Setup
 
+#### Using initializer
+
 ```ruby
+require 'rancher/api'
+
 Rancher::Api.configure do |config|
   config.url = 'http://127.0.0.1:8080/v1/'
   config.access_key = '8604A1FC8C108BAFB1E3'
@@ -54,6 +73,18 @@ Rancher::Api.configure do |config|
 end
 ```
 
+#### Using environment variables
+
+You can configure `rancher-api` gem using `rancher-compose`-compatible environment variables:
+
+- RANCHER_URL
+- RANCHER_ACCESS_KEY
+- RANCHER_SECRET_KEY
+
+```ruby
+Rancher::Api.setup!
+```
+
 ### Querying
 
 Now, you're able to query entities like this:
@@ -66,6 +97,10 @@ machine = Rancher::Api::Machine.find('1ph1')
 ### Creating new machines
 Creating new machine using **Digital Ocean** driver:
 
+**NOTICE**: First specify driver, so that driver_config= accessor can correctly map config on the right attribute. I.e. for 'digitalocean' config attribute is 'digitaloceanConfig'.
+
+#### Digital Ocean
+
 ```ruby
 project = Rancher::Api::Project.all.to_a.first
 
@@ -81,7 +116,31 @@ new_machine.driver_config = Rancher::Api::Machine::DriverConfig.new(
 new_machine.save
 ```
 
-**NOTICE**: First specify driver, so that driver_config= accessor can correctly map config on the right attribute. I.e. for 'digitalocean' config attribute is 'digitaloceanConfig'.
+#### Vmware Vsphere
+
+```ruby
+project = Rancher::Api::Project.all.to_a.first
+
+new_machine = project.machines.build
+new_machine.name = 'api-test'
+new_machine.driver = Rancher::Api::Machine::VMWARE_VSPHERE
+new_machine.driver_config = Rancher::Api::Machine::DriverConfig.new(
+    boot2dockerUrl: nil,
+    cpuCount: '1',
+    datacenter: 'ha-dc',
+    datastore: 'prod',
+    diskSize: '10000',
+    memorySize: '1024',
+    network: 'prod',
+    password: 'holamundo',
+    pool: nil,
+    username: 'myuser',
+    vcenter: 'vcenter.happyops.com',
+    vcenterPort: nil
+)
+
+new_machine.save
+```
 
 
 ### Executing shell commands in containers
@@ -89,6 +148,7 @@ new_machine.save
 ```ruby
 container = Rancher::Api::Instance.find('1i382')
 puts container.execute('whoami').response
+puts container.execute(['bundle', 'exec', 'rake', 'db:create', 'db:migrate']).response
 ```
 
 ## Development

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: 2.2.2
+
+dependencies:
+  pre:
+    - gem install bundler -v 1.10.5

data/examples/create_docker_host.rb

@@ -0,0 +1,62 @@
+# Objectives of this script is to:
+# - check if docker host for branch exists (using labels)
+# - create docker host via Rancher if it doesn't exist
+#
+require 'rancher/api'
+
+BRANCH = ENV['CIRCLE_BRANCH']
+DIGITAL_OCEAN_ACCESS_TOKEN = 'xxx'
+
+Rancher::Api.configure do |config|
+  config.url = "http://#{ENV['RANCHER_HOST']}/v1/"
+  config.access_key = ENV['RANCHER_ACCESS_KEY']
+  config.secret_key = ENV['RANCHER_SECRET_KEY']
+end
+
+project = Rancher::Api::Project.all.to_a.first
+all_machines = project.machines
+
+# 1. check if docker host exists, label branch must be equal to current branch
+machine = all_machines.select { |x| x.labels['branch'] == BRANCH }.first
+
+# 2. docker host doesn't exist, let's create one
+unless machine
+  machine = project.machines.build
+  machine.name = 'app-' + BRANCH
+  machine.driver = Rancher::Api::Machine::DIGITAL_OCEAN
+  machine.driver_config = Rancher::Api::Machine::DriverConfig.new(
+    accessToken: DIGITAL_OCEAN_ACCESS_TOKEN,
+    size: '1gb',
+    region: 'ams3',
+    image: 'ubuntu-14-04-x64'
+  )
+
+  machine.labels = {
+    branch: BRANCH
+  }
+
+  machine.save
+
+  puts "CREATING NEW MACHINE: #{machine.id} - #{machine.name}"
+  puts 'Set timeout to 5 minutes'
+
+  # Wait until machine is active, on Digital Ocean claim to be 55 seconds
+  #
+  Timeout.timeout(300) do
+    i = 45
+    puts "Waiting #{i} seconds..."
+    sleep i
+
+    while machine.transitioning == 'yes'
+      wait_time = 5
+      i += wait_time
+
+      puts machine.transitioningMessage
+      puts "Waiting total: #{i} seconds ..."
+
+      sleep wait_time
+
+      machine = Rancher::Api::Machine.find(machine.id)
+    end
+  end
+end

data/lib/rancher/api.rb

@@ -11,6 +11,11 @@ module Rancher
       attr_writer :configuration
     end
 
+    def self.setup!
+      configure do |_x|
+      end
+    end
+
     def self.configuration
       @configuration ||= Configuration.new
     end

data/lib/rancher/api/configuration.rb

@@ -4,6 +4,12 @@ module Rancher
       attr_accessor :url
       attr_accessor :access_key
       attr_accessor :secret_key
+
+      def initialize
+        @url = ENV['RANCHER_URL']
+        @access_key = ENV['RANCHER_ACCESS_KEY']
+        @secret_key = ENV['RANCHER_SECRET_KEY']
+      end
     end
   end
 end

data/lib/rancher/api/models/machine.rb

@@ -4,6 +4,7 @@ module Rancher
   module Api
     class Machine
       DIGITAL_OCEAN = 'digitalocean'
+      VMWARE_VSPHERE = 'vmwarevsphere'
 
       include Her::Model
 
@@ -17,15 +18,15 @@ module Rancher
 
       def driver_config
         case driver
-        when DIGITAL_OCEAN
-          DriverConfig.new(attributes["#{DIGITAL_OCEAN}Config"])
+        when DIGITAL_OCEAN, VMWARE_VSPHERE
+          DriverConfig.new(attributes["#{driver}Config"])
         end
       end
 
       def driver_config=(dc)
         case driver
-        when DIGITAL_OCEAN
-          attributes["#{DIGITAL_OCEAN}Config"] = dc.attributes
+        when DIGITAL_OCEAN, VMWARE_VSPHERE
+          attributes["#{driver}Config"] = dc.attributes
         end
       end
     end

data/lib/rancher/api/version.rb

@@ -1,5 +1,5 @@
 module Rancher
   module Api
-    VERSION = "0.3.5"
+    VERSION = "0.3.6"
   end
 end

data/rancher-api.gemspec

@@ -34,5 +34,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3.0'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'webmock', '1.21.0'
+  spec.add_development_dependency 'vcr', '2.9.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rancher-api
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Alex Kurkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: her
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.3
 description: Ruby gem to easily connect to Rancher API. Via this gem you can do anything
   that API lets you to do it
 email:
@@ -128,6 +170,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
+- examples/create_docker_host.rb
 - lib/rancher/api.rb
 - lib/rancher/api/configuration.rb
 - lib/rancher/api/middlewares.rb