xnode-keystone 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9faa42e7c5f50577cc4d610767b4b021a7e6f622
+  data.tar.gz: ad518d1b937e84929b1ac9d79a75e427a7508d4a
+SHA512:
+  metadata.gz: 346eb8480ffd28829dc528b5917499c1289e9c0da04160ab8bb8c7341c51b15f99ae3a626e19f9eede7e48b406a243c4c8efc5fb638b65e9c0a5303202734216
+  data.tar.gz: 663691086092b08fa30cf74460627b000bb7aa77d3c0ff58d3e355182f93ca9e29102f7ec54162181008a2b27cc1558dcc132732cbe02140bc3d4a43dcf97c80

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xnode-keystone.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Paul Stevens
+
+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/README.md

@@ -0,0 +1,68 @@
+# Xnode::Keystone
+
+![Build Status](https://travis-ci.org/xnoder/xnode-keystone.svg)
+
+`xnode-keystone` provides methods that allow you to interact with the Keystone Identity service provided by an OpenStack
+cloud. It covers your authentication, and depending on your rights within the cloud, the ability to query and manipulate
+users and tenants.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xnode-keystone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xnode-keystone
+
+## Usage
+
+Basic usage is as follows. You need to have an openrc file somewhere that looks something like this:
+
+```
+export OS_USERNAME=demo
+export OS_PASSWORD=supas33krit
+export OS_TENANT_NAME=Demo
+export OS_AUTH_URL=https://controller:5000/v2.0
+```
+
+Source it with `. openrc.sh` to load the environment variables. `xnode-keystone` needs these to find your creds.
+
+```ruby
+require 'xnode-keystone'
+
+# Initialise a new instance of the base class
+auth = Xnode::Keystone::Authenticate.new
+
+# Send an authentication request, and get a JSON response back that's been decoded bash into a Hash
+request = auth.request
+
+# To extract a token from the request...
+token = auth.get_token(request)
+
+# And to get the public compute API endpoint back...
+endpoints = auth.catalog(request)
+compute = endpoints['compute']['public']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xnoder/xnode-keystone.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xnode/keystone"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xnode/keystone.rb

@@ -0,0 +1,71 @@
+# This gem provides methods for interacting with the OpenStack Keystone Identity service via HTTP calls to the
+# RESTful API. On initialization of the class, it simply reads in environment variables sourced to your shell
+# via an openrc.sh file (see http://docs.openstack.org/icehouse/install-guide/install/apt/content/ch_clients_openrc_files.html)
+# for the details.
+#
+# Author:: Paul Stevens (mailto:ps@xnode.co.za)
+# Copyright:: Copyright (c) 2015 Paul Stevens
+# License:: Distributed under the MIT license.
+
+require "xnode/keystone/version"
+require "xnode/keystone/http"
+require "xnode/keystone/utils"
+
+require 'json'
+
+module Xnode
+  module Keystone
+
+    # This class sets up an authenticated session with the OpenStack API's via Keystone, and exposes methods for
+    # interacting the Identity service.
+    #
+    # ==== Example
+    #
+    # => auth = Xnode::Keystone::Authenticate.new
+    # => request = auth.request
+    # => token = auth.get_token(request)
+    class Authenticate
+
+      # Set accessors for credentials
+      attr_accessor :username, :password, :tenant, :baseurl, :url
+
+      # Authenticates against the OpenStack Identity API endpoint on 5000/tcp or 35357/tcp via HTTP/S.
+      # Uses environment variables to set your authentication credentials.
+      def initialize
+        @username  = ENV['OS_USERNAME']
+        @password  = ENV['OS_PASSWORD']
+        @tenant    = ENV['OS_TENANT_NAME']
+        @baseurl   = ENV['OS_AUTH_URL']
+      end
+
+      # Uses a private post method (keystone/http.rb) to send an HTTP POST request to OpenStack. The JSON response is
+      # automatically decoded into a Ruby Hash for later manipulation. The response body remains untouched otherwise,
+      # so everything you'd expect to find in the response is within the Hash.
+      def request
+        url = @baseurl + '/tokens'
+        data = Xnode::Keystone.auth_data(@tenant, @username, @password).to_json
+        response  = Xnode::Keystone.post(url, data)
+      end
+
+      # Extracts the authentication token from the response, returning it as a String.
+      def get_token(data)
+        data['access']['token']['id']
+      end
+
+      # Parses the serviceCatalog returned within the response, and writes it into a modified Hash that makes it
+      # easy to extract public, internal or admin URI's by service type.
+      def catalog(data)
+        mapendpoints = Hash.new
+        data['access']['serviceCatalog'].each do |key, value|
+          mapendpoints[key['type']] = {
+            'public' => key['endpoints'][0]['publicURL'],
+            'internal' => key['endpoints'][0]['internalURL'],
+            'admin' => key['endpoints'][0]['adminURL']
+          }
+        end
+        return mapendpoints
+      end
+
+    end
+  end
+end

data/lib/xnode/keystone/http.rb

@@ -0,0 +1,41 @@
+# This module manages the actual HTTP requests made throughout the gem. The methods are effectively wrappers around
+# other library calls, but allows the author to switch out and modify the requests without breaking the API, as
+# the request responses are dictated by the OpenStack platform, allowing some scope in modifying the request/response
+# features for speed or error handling proficiency.
+
+require 'rest-client'
+
+module Xnode
+  module Keystone
+
+    private
+
+    # Send an HTTP GET request to an OpenStack API endpoint.
+    def get(url, headers)
+    end
+    module_function :get
+
+    # Send an HTTP POST request to an OpenStack API endpoint.
+    def post(url, data)
+      request   = RestClient.post "#{url}", data, :content_type => :json, :accept => :json
+      response  = JSON.parse(request.body)
+    end
+    module_function :post
+
+    # Send an HTTP DELETE request to an OpenStack API endpoint.
+    def delete
+    end
+    module_function :delete
+
+    # Send an HTTP PATCH request to an OpenStack API endpoint.
+    def patch
+    end
+    module_function :patch
+
+    # Send an HTTP PUT request to an OpenStack API endpoint.
+    def put
+    end
+    module_function :put
+
+  end
+end

data/lib/xnode/keystone/utils.rb

@@ -0,0 +1,24 @@
+# This module contains basic utility functions, such as structing headers, data structures for JSON conversion and
+# so on.
+
+module Xnode
+  module Keystone
+
+    private
+
+    # Set up a Keystone JSON request body for authentication purposes.
+    def auth_data(tenant, username, password)
+      headers = {
+        :auth => {
+          :tenantName => tenant,
+          :passwordCredentials => {
+            :username => username,
+            :password => password
+          }
+        }
+      }
+    end
+    module_function :auth_data
+
+  end
+end

data/lib/xnode/keystone/version.rb

@@ -0,0 +1,7 @@
+# Return a version number. Woo.
+
+module Xnode
+  module Keystone
+    VERSION = "0.1.1"
+  end
+end

data/xnode-keystone.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xnode/keystone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xnode-keystone"
+  spec.version       = Xnode::Keystone::VERSION
+  spec.authors       = ["Paul Stevens"]
+  spec.email         = ["ps@xnode.co.za"]
+
+  spec.summary       = %q{Authenticate against the OpenStack Keystone Identity Service.}
+  spec.description   = %q{Exposes methods to allow easy authentication and URI identification of OpenStack resources.}
+  spec.homepage      = "https://github.com/xnoder/xnode-keystone"
+  spec.license       = "MIT"
+
+  spec.add_runtime_dependency 'rest-client', "~> 1.8", ">= 1.8.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3", ">= 3.3.0"
+  spec.add_development_dependency "webmock", "~> 1.21", ">= 1.21.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: xnode-keystone
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Paul Stevens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+description: Exposes methods to allow easy authentication and URI identification of
+  OpenStack resources.
+email:
+- ps@xnode.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xnode/keystone.rb
+- lib/xnode/keystone/http.rb
+- lib/xnode/keystone/utils.rb
+- lib/xnode/keystone/version.rb
+- xnode-keystone.gemspec
+homepage: https://github.com/xnoder/xnode-keystone
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Authenticate against the OpenStack Keystone Identity Service.
+test_files: []