right_api_helper 0.0.2 → 1.0.0

data/README.md

@@ -57,10 +57,31 @@ You can also pass a logger object to the `right_api_client` gem. For example:
 * Need to further sanitize VCR output before including spec/cassettes dir.
 * break `lib/right_api_helper/api15.rb` apart into separate helpers?
 
+
+## Using Vagrant
+
+For local gem development using Vagrant, you must have Vagrant 1.2 or greater installed.  Please see the [vagrant documentation](http://docs.vagrantup.com/v2/) for instructions.  This was tested on Vagrant 1.4.3, so I would start with that.
+
+You will also need to install some gems and the berkshelf and omnibus vagrant plugins.
+Here are the commands:
+
+	$ bundle
+	$ vagrant plugin install vagrant-berkshelf
+	$ vagrant plugin install vagrant-omnibus
+	$ vagrant up
+
+Once your instance is launched and configured, ssh in and run the specs
+
+	$ vagrant ssh
+	> cd /vagrant
+	> bundle
+	> bundle exec rake spec
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/caryp/right_api_helper/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
+5. Create a new Pull Request

data/Vagrantfile

@@ -0,0 +1,52 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Load creds from a file
+right_api_secrets = YAML.load_file("#{ENV['HOME']}/.right_api_client/login.yml")
+
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+
+  # Every Vagrant virtual environment requires a box to build off of.
+  config.vm.box = "opscode_ubuntu-12.04_chef-provisionerless"
+
+  # The url from where the 'config.vm.box' box will be fetched if it
+  # doesn't already exist on the user's system.
+  config.vm.box_url = "http://opscode-vm-bento.s3.amazonaws.com/vagrant/virtualbox/opscode_ubuntu-12.04_chef-provisionerless.box"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  config.vm.synced_folder "~/.right_api_client", "/vagrant/.right_api_client"
+
+  # Enable provisioning with chef solo, specifying a cookbooks path, roles
+  # path, and data_bags path (all relative to this Vagrantfile), and adding
+  # some recipes and/or roles.
+  #
+  config.vm.provision :chef_solo do |chef|
+    chef.cookbooks_path = "./cookbooks"
+    chef.add_recipe "right_api_helper::default"
+    chef.add_recipe "right_api_helper::development"
+    chef.json = {
+      :right_api_helper => {
+        :account_id => right_api_secrets[:account_id],
+        :user_email => right_api_secrets[:email],
+        :user_password => right_api_secrets[:password]
+       }
+    }
+  end
+
+  # tell vagrant-omnibus to install a specific vesion of Chef
+  # you will need to install the vagrant-omnibus plugin
+  config.omnibus.chef_version = "11.6.0"
+
+  # tell vagrant to use bershelf to pull in cookbook dependencies
+  # you will need to install the vagrant-berkshelf plugin
+  config.berkshelf.enabled = true
+  config.berkshelf.berksfile_path = "./cookbooks/right_api_helper/Berksfile"
+
+end

data/cookbooks/right_api_helper/.gitignore

@@ -0,0 +1,15 @@
+.vagrant
+Berksfile.lock
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+/cookbooks
+
+# Bundler
+Gemfile.lock
+bin/*
+.bundle/*
+

data/cookbooks/right_api_helper/Berksfile

@@ -0,0 +1,3 @@
+site :opscode
+
+metadata

data/cookbooks/right_api_helper/Gemfile

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

data/cookbooks/right_api_helper/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2014 RightScale, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/cookbooks/right_api_helper/README.md

@@ -0,0 +1,55 @@
+# right_api_helper cookbook
+
+installs the `right_api_helper` gem and prerequisites
+
+# Requirements
+
+Attributes
+----------
+#### right_api_client::default
+<table>
+  <tr>
+    <th>Key</th>
+    <th>Type</th>
+    <th>Description</th>
+    <th>Default</th>
+  </tr>
+  <tr>
+    <td><tt>['right_api_client']['user_email']</tt></td>
+    <td>String</td>
+    <td>the RightScale user's email address</td>
+    <td><tt>nil</tt></td>
+  </tr>
+  <tr>
+    <td><tt>['right_api_client']['user_password']</tt></td>
+    <td>String</td>
+    <td>the RightScale user's password</td>
+    <td><tt>nil</tt></td>
+  </tr>
+  <tr>
+    <td><tt>['right_api_client']['accound_id']</tt></td>
+    <td>String</td>
+    <td>the RightScale account ID</td>
+    <td><tt>nil</tt></td>
+  </tr>
+
+</table>
+
+Usage
+-----
+#### cas_portal::default
+Just include `cas_portal::default` in your node's `run_list`:
+
+```json
+{
+  "name":"my_node",
+  "run_list": [
+    "recipe[cas_portal::default]"
+  ]
+}
+
+# Recipes
+
+# Author
+
+Author:: RightScale, Inc. (<cary@rightscale.com>)

data/cookbooks/right_api_helper/Thorfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'bundler/setup'
+require 'berkshelf/thor'

data/cookbooks/right_api_helper/attributes/default.rb

@@ -0,0 +1,3 @@
+node.default['right_api_client']['user_email'] = nil
+node.default['right_api_client']['user_password'] = nil
+node.default['right_api_client']['account_id'] = nil

data/cookbooks/right_api_helper/chefignore

@@ -0,0 +1,96 @@
+# Put files/directories that should be ignored in this file when uploading
+# or sharing to the community site.
+# Lines that start with '# ' are comments.
+
+# OS generated files #
+######################
+.DS_Store
+Icon?
+nohup.out
+ehthumbs.db
+Thumbs.db
+
+# SASS #
+########
+.sass-cache
+
+# EDITORS #
+###########
+\#*
+.#*
+*~
+*.sw[a-z]
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+
+## COMPILED ##
+##############
+a.out
+*.o
+*.pyc
+*.so
+*.com
+*.class
+*.dll
+*.exe
+*/rdoc/
+
+# Testing #
+###########
+.watchr
+.rspec
+spec/*
+spec/fixtures/*
+test/*
+features/*
+Guardfile
+Procfile
+
+# SCM #
+#######
+.git
+*/.git
+.gitignore
+.gitmodules
+.gitconfig
+.gitattributes
+.svn
+*/.bzr/*
+*/.hg/*
+*/.svn/*
+
+# Berkshelf #
+#############
+Berksfile
+Berksfile.lock
+cookbooks/*
+tmp
+
+# Cookbooks #
+#############
+CONTRIBUTING
+CHANGELOG*
+
+# Strainer #
+############
+Colanderfile
+Strainerfile
+.colander
+.strainer
+
+# Vagrant #
+###########
+.vagrant
+Vagrantfile
+
+# Travis #
+##########
+.travis.yml

data/cookbooks/right_api_helper/metadata.rb

@@ -0,0 +1,13 @@
+name             'right_api_helper'
+maintainer       'RightScale, Inc.'
+maintainer_email 'cary@rightscale.com'
+license          'MIT'
+description      'Installs/Configures right_api_helper'
+long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
+version          '0.1.0'
+
+depends 'apt'
+depends 'build-essential'
+
+depends 'git' # for dev environment
+

data/cookbooks/right_api_helper/recipes/default.rb

@@ -0,0 +1,61 @@
+#
+# Cookbook Name:: right_api_helper
+# Recipe:: default
+#
+# Copyright (C) 2014 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+# system setup
+#
+include_recipe "apt"
+include_recipe "build-essential"
+
+# install ruby 1.9
+#
+package "ruby1.9.1"
+package "ruby1.9.1-dev"
+
+bash "update-alternatives --set ruby /usr/bin/ruby1.9.1"
+bash "update-alternatives --set gem /usr/bin/gem1.9.1"
+
+# add RightScale API credentials
+#
+directory "/home/vagrant/.right_api_client"
+
+template "/home/vagrant/.right_api_client/login.yml" do
+  source "login.yml.erb"
+  user "vagrant"
+  mode 0600
+  variables({
+    :user_email => node['right_api_helper']['user_email'],
+    :user_password => node['right_api_helper']['user_password'],
+    :account_id => node['right_api_helper']['account_id']
+  })
+end
+
+# install gem
+#
+gem_package "right_api_helper"
+
+
+
+

data/cookbooks/right_api_helper/recipes/development.rb

@@ -0,0 +1,28 @@
+#
+# Cookbook Name:: right_api_helper
+# Recipe:: default
+#
+# Copyright (C) 2014 RightScale, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+include_recipe "git"
+gem_package "bundler"

data/cookbooks/right_api_helper/templates/default/login.yml.erb

@@ -0,0 +1,35 @@
+# The API login details can be put in a YAML file. This is an example login.yml which
+# will be needed for login_to_client_irb.rb quick login method.
+
+# Account ID is a required parameter. You can find your account number by logging into the
+# RightScale dashboard (https://my.rightscale.com), navigate to the Settings > Account Settings page.
+# The account number is at the end of the browser address bar.
+:account_id: <%= @account_id %>
+
+# There are five login mechanisms:
+
+# 0. Use the following parameters to login with your email and base64-encoded password:
+# To encode your plaintext password, use 'base64' command or similar.
+#:email: <%= @user_email %>
+#:password_base64: my_password_encoded_as_base64
+
+# 1. Use the following parameters to login with your email and plaintext password:
+:email: <%= @user_email %>
+:password: <%= @user_password %>
+
+# 2. Use the following parameter to login with an instance_token:
+# To find the instance_token, launch a server, navigate to the info page and under
+# User Data box, you will see RS_API_TOKEN = your_account_id:the_instance_token
+#:instance_token: my_instance_token
+
+# 3. Use the following parameter to send a pre-authenticated cookie with every request:
+#:cookies: my_cookie_string
+
+# 4. Use the following parameter to send an existing OAuth access token with every request:
+# To learn more about OAuth and how to obtain an access token, see
+# http://support.rightscale.com/12-Guides/03-Rightscale_API/OAuth
+#:access_token: my_token_string
+
+# The following are optional parameters:
+#:api_url: (this defaults to https://my.rightscale.com)
+#:api_version: (this defaults to 1.5)

data/lib/right_api_helper/version.rb

@@ -1,3 +1,3 @@
 module RightApiHelper
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/spec/spec_helper.rb

@@ -28,8 +28,8 @@ VCR.configure do |c|
   c.hook_into :webmock
   c.configure_rspec_metadata!
 
-  # Uncomment this to record new cassettes
-  #c.default_cassette_options = { :record => :all }
+  # Comment this to record new cassettes for fast unit testing
+  c.default_cassette_options = { :record => :all }
 
   # filer out authentication data
   login_info = YAML::load(File.open("#{ENV['HOME']}/.right_api_client/login.yml"))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_api_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -153,7 +153,20 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- Vagrantfile
 - bin/organize
+- cookbooks/right_api_helper/.gitignore
+- cookbooks/right_api_helper/Berksfile
+- cookbooks/right_api_helper/Gemfile
+- cookbooks/right_api_helper/LICENSE
+- cookbooks/right_api_helper/README.md
+- cookbooks/right_api_helper/Thorfile
+- cookbooks/right_api_helper/attributes/default.rb
+- cookbooks/right_api_helper/chefignore
+- cookbooks/right_api_helper/metadata.rb
+- cookbooks/right_api_helper/recipes/default.rb
+- cookbooks/right_api_helper/recipes/development.rb
+- cookbooks/right_api_helper/templates/default/login.yml.erb
 - demo/deployments.json
 - demo/index.html
 - demo/logo.png