aviator 0.0.1 → 0.0.2

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -14,4 +14,9 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp/*.*
+!tmp/.gitignore
+.DS_Store
+test/environment.yml
+vcr.log
+

data/.ruby-gemset

@@ -0,0 +1 @@
+aviator

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p448

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+branches:
+  only:
+    - master
+    - develop
+    - release
+bundler_args: --without development
+script:
+  - cp test/environment.yml.travis-ci test/environment.yml
+  - bundle exec rake

data/Gemfile

@@ -2,3 +2,16 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in aviator.gemspec
 gemspec
+
+# Putting these gems in the test group so that
+# we can tell travis-ci not to build any of the
+# development gems. Makes the build run faster.
+group :test do
+  gem 'rake'
+  gem 'simplecov', '~> 0.7.0'
+  gem 'coveralls', '~> 0.6.0'
+  gem 'json', '~> 1.7.0'
+  gem 'minitest', '~> 4.7.0'
+  gem 'minitest-reporters', '~> 0.14.20'
+  gem 'vcr', '~> 2.5.0'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'minitest' do
+  watch(%r|^lib/aviator\.rb|)            { "test" }
+  watch(%r|^test/test_helper\.rb|)       { "test" }
+  watch(%r|^lib/aviator/(.*)\.rb|)       { |m| "test/aviator/#{m[1]}_test.rb" }
+  watch(%r|^test/aviator/.*_test\.rb|)   # Run the matched file
+end

data/LICENSE.txt

@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,12 @@
 # Aviator
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/relaxdiego/aviator.png?branch=master)](https://travis-ci.org/relaxdiego/aviator)
+[![Coverage Status](https://coveralls.io/repos/relaxdiego/aviator/badge.png?branch=master)](https://coveralls.io/r/relaxdiego/aviator?branch=master)
+[![Code Climate](https://codeclimate.com/github/relaxdiego/aviator.png)](https://codeclimate.com/github/relaxdiego/aviator)
+
+
+A lightweight library for communicating with the OpenStack API.
+
 
 ## Installation
 
@@ -18,8 +24,151 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'aviator'
+
+# Create a new session. See 'Configuration' below for the config file format.
+session = Aviator::Session.new(
+            config_file: 'path/to/aviator.yml',
+            environment: :production,
+            log_file:    'path/to/aviator.log'
+          )
+
+# Authenticate against the auth service specified in :config_file. If no 
+# credentials are available in the config file, this line will throw an error.
+session.authenticate
+
+# You can re-authenticate anytime. Note that this creates a new token in the 
+# underlying environment while the old token is discarded by the Session object.
+# Be aware of this fact as it might unnecessarily generate too many tokens.
+#
+# Notice how you can override the credentials in the config file. Also note that
+# the keys used below (:username, :password, :tenantName) match the name as 
+# indicated in the official OpenStack documentation.
+session.authenticate do |credentials|
+  credentials[:username]   = myusername
+  credentials[:password]   = mypassword
+  credentials[:tenantName] = tenantName
+end
+
+# Serialize the session information for caching. The output is in plaintext JSON which
+# contains sensitive information and you are responsible for securing this data.
+str = session.dump
+
+# Create a new Session object from a session dump. This DOES NOT create a new token. 
+# If you employed any form of encryption on the string, make sure to decrypt it first!
+session = Aviator::Session.load(str)
+
+# Depending on how old the loaded session dump is, the auth_info may already be expired. 
+# Check if it's still current by calling Session#validate and reauthenticate as needed.
+#
+# IMPORTANT: The validator must be defined in the config file and it must refer to the
+# name of a request that is known to Aviator. See 'Configuration' below for examples
+session.authenticate unless session.validate
+
+# If you want the newly created session to log its output, make sure to indicate it on load
+session = Aviator::Session.load(str, log_file: 'path/to/aviator.log')
+
+# Get a handle to the Identity Service.
+keystone = session.identity_service
+
+# Create a new tenant
+response = keystone.request(:create_tenant) do |params|
+  params[:name]        = 'Project'
+  params[:description] = 'My Project'
+  params[:enabled]     = true
+end
+
+# Aviator uses parameter names as defined in the official OpenStack API doc. You can 
+# also access the params via dot notation (e.g. params.description) or by using a string
+# for a hash key (e.g. params['description']). However, keep in mind that OpenStack
+# parameters that have dashes and other characters that are not valid for method names
+# and symbols can only be expressed as strings. E.g. params['changes-since']
+
+
+# Be explicit about the endpoint type. Useful in those rare instances when
+# the same request name means differently depending on the endpoint type.
+# For example, in OpenStack, :list_tenants will return only the tenants the
+# user is a member of in the public endpoint whereas the admin endpoint will
+# return all tenants in the system.
+response = keystone.request(:list_tenants, endpoint_type: 'admin')
+```
+
+## Configuration
+
+The configuration file is a simple YAML file with one or more environment definitions.
+
+```
+production:
+  provider: openstack
+  auth_service:
+    name:        identity
+    host_uri:    http://my.openstackenv.org:5000
+    request:     create_token
+    validator:   list_tenants   # Request to make for validating the session
+    api_version: v2             # Optional if version is indicated in host_uri
+  auth_credentials:
+    username:   admin
+    password:   mypassword
+    tenantName: myproject
+
+development_1:
+  provider: openstack
+  auth_service:
+    name:      identity
+    host_uri:  http://devstack:5000/v2.0
+    request:   create_token
+    validator: list_tenants
+  auth_credentials:
+    tokenId:    2c963f5512d067b24fdc312707c80c7a6d3d261b
+    tenantName: admin
+
+development_2:
+  provider: openstack
+  auth_service:
+    name:      identity
+    host_uri:  http://devstack:5000/v2.0
+    request:   create_token
+    validator: list_tenants
+  auth_credentials:
+    username: admin
+    password: mypassword
+    tenantName: myproject
+```
+
+A note on the validator: it can be any request as long as
+
+1. It is defined in Aviator
+1. Does not require any parameters
+1. It returns an HTTP status 200 or 203 to indicate auth info validity.
+1. It returns any other HTTP status to indicate that the auth info is invalid.
+
+## CLI tools
+
+List available providers. Includes only OpenStack for now.
+
+```bash
+$ aviator describe
+```
+
+List available services for OpenStack.
+
+```bash
+$ aviator describe openstack
+```
+
+List available requests for Keystone
+
+```bash
+$ aviator describe openstack identity
+```
+
+Describe Keystone's create_tenant request
 
+```bash
+$ aviator describe openstack identity v2 admin create_tenant
+```
+  
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+ 
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/aviator/**/*_test.rb"
+  t.libs.push 'test'
+end
+ 
+task :default => :test

data/aviator.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mmaglana@gmail.com"]
   spec.description   = %q{ Lightweight Ruby bindings for the OpenStack API }
   spec.summary       = %q{ Lightweight Ruby bindings for the OpenStack API }
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/relaxdiego/aviator"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'faraday', '~> 0.8.0'
+  spec.add_dependency 'activesupport', '~> 4.0.0'
+  spec.add_dependency 'thor', '~> 0.18.1'
+  
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rb-fsevent', '~> 0.9.0'
+  spec.add_development_dependency 'guard', '~> 1.8.0'
+  spec.add_development_dependency 'guard-rake', '~> 0.0.0'
+  spec.add_development_dependency 'guard-minitest', '~> 0.5.0'
+  spec.add_development_dependency 'ruby_gntp', '~> 0.3.0'
+  spec.add_development_dependency 'debugger', '~> 1.6.0'
+  spec.add_development_dependency 'pry', '~> 0.9.0'
+  spec.add_development_dependency 'yard', '~> 0.8.0'
+  spec.add_development_dependency 'redcarpet', '~> 2.3.0'
 end

data/bin/aviator

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'thor'
+require 'aviator/core'
+
+module Aviator
+module CLI
+
+  class Main < Thor
+    
+    desc 'describe [PROVIDER] [SERVICE] [API_VERSION ENDPOINT_TYPE REQUEST_NAME]', 'Describes various parts of Aviator.'
+    def describe(provider=nil, service=nil, api_version=nil, endpoint_type=nil, request=nil)
+      if request
+        describe_request provider, service, api_version, endpoint_type, request
+      elsif service
+        describe_service provider, service
+      elsif provider
+        describe_provider provider
+      else
+        list_providers
+      end
+    end
+
+
+    private
+
+
+    def describe_provider(provider)
+      puts "Available services from #{ provider }"
+      
+      Dir[Pathname.new(__FILE__).join('..', '..', 'lib', 'aviator', provider, '**')].each do |d|
+        puts "  #{ Pathname.new(d).basename }"
+      end
+    end
+
+
+    def describe_request(provider, service, api_version, endpoint_type, request_name)
+      endpoints = Service.new(provider: provider, service: service).requests[api_version.to_sym]
+      raise "Invalid API version #{ api_version }" unless endpoints
+      
+      requests = endpoints[endpoint_type.to_sym]
+      raise "Invalid endpoint type #{ endpoint_type }" unless requests
+      
+      request = requests[request_name.to_sym]
+      raise "Could not find request named #{ request_name }. Try a different api version or endpoint" unless request
+      
+      puts "Request: #{ request_name }"
+      
+      params = []
+      
+      request.optional_params.each do |param|
+        params << [param, :optional]
+      end
+      
+      request.required_params.each do |param|
+        params << [param, :required]
+      end
+
+      params.sort! { |a,b| a[0].to_s <=> b[0].to_s }
+      
+      puts "\nParameters:"
+      params.each do |param_desc|
+        puts "  (#{ param_desc[1] }) #{ param_desc[0] }"
+      end
+      
+      puts "\nSample Code:"
+      print "  session.#{ service }_service.request(:#{ request_name }, endpoint_type: '#{ endpoint_type }')"
+      if params
+        puts " do |params|"
+        params.each do |pair|
+          puts "    params['#{ pair[0] }'] = val"
+        end
+        puts "  end"
+      end
+      
+      puts "\nLinks:"
+      request.links.each do |link|
+        puts "  #{ link[:rel] }:"
+        puts "    #{ link[:href] }\n"
+      end
+    end
+
+
+    def describe_service(provider, service)
+      puts "Available requests for #{ provider } #{ service }:"
+      
+      Service.new(provider: provider, service: service).requests.each do |api_version, endpoints|
+        endpoints.each do |endpoint_type, requests|
+          requests.each do |request_name, request_obj|
+            puts "  #{ api_version} #{ endpoint_type } #{ request_name }"
+          end
+          puts ""
+        end
+      end
+    end
+
+
+    def list_providers
+      puts "Available providers:"
+      puts "  openstack"
+    end
+
+  end
+
+
+end
+end
+
+Aviator::CLI::Main.start(ARGV)

data/lib/aviator/core.rb

@@ -0,0 +1,9 @@
+require 'json'
+require 'active_support/inflector'
+require 'faraday'
+
+require "aviator/version"
+require "aviator/core/request"
+require "aviator/core/response"
+require "aviator/core/service"
+require "aviator/core/session"

data/lib/aviator/core/request.rb

@@ -0,0 +1,229 @@
+module Aviator
+
+  class Request
+
+    class ApiVersionNotDefinedError < StandardError
+      def initialize
+        super "api_version is not defined."
+      end
+    end
+
+    class EndpointTypeNotDefinedError < StandardError
+      def initialize
+        super "endpoint_type is not defined."
+      end
+    end
+
+    class PathNotDefinedError < StandardError
+      def initialize
+        super "path is not defined."
+      end
+    end
+
+
+    def initialize(session_data=nil)
+      @session_data = session_data
+
+      params = self.class.params_class.new if self.class.params_class
+
+      if params
+        yield(params) if block_given?
+        validate_params(params)
+      end
+
+      @params = params
+    end
+
+
+    def anonymous?
+      self.class.anonymous?
+    end
+
+
+    def api_version
+      self.class.api_version
+    end
+
+
+    def body?
+      self.class.body?
+    end
+
+
+    def endpoint_type
+      self.class.endpoint_type
+    end
+
+
+    def headers?
+      self.class.headers?
+    end
+
+
+    def http_method
+      self.class.http_method
+    end
+
+
+    def links
+      self.class.links
+    end
+    
+
+    def optional_params
+      self.class.optional_params
+    end
+
+
+    def params
+      @params.dup
+    end
+
+
+    def querystring?
+      self.class.querystring?
+    end
+
+
+    def required_params
+      self.class.required_params
+    end
+
+
+    def session_data
+      @session_data
+    end
+
+
+    def session_data?
+      !session_data.nil?
+    end
+
+
+    def url?
+      self.class.url?
+    end
+
+
+    private
+
+
+    def validate_params(params)
+      required_params = self.class.required_params
+
+      required_params.each do |name|
+        raise ArgumentError.new("Missing parameter #{ name }.") if params.send(name).nil?
+      end
+    end
+
+
+    # NOTE that, because we are defining the following as class methods, when they
+    # are called, all 'instance' variables are actually defined in the descendant class,
+    # not in the instance/object. This is by design since we want to keep these attributes
+    # within the class and because they don't change between instances anyway.
+    class << self
+
+      def anonymous
+        @anonymous = true
+      end
+
+
+      def anonymous?
+        @anonymous == true
+      end
+
+
+      def api_version(value=nil)
+        if value
+          @api_version = value
+        else
+          @api_version
+        end
+      end
+
+
+      def body?
+        instance_methods.include? :body
+      end
+
+
+      def endpoint_type(value=nil)
+        if value
+          @endpoint_type = value
+        else
+          @endpoint_type
+        end
+      end
+
+
+      def headers?
+        instance_methods.include? :headers
+      end
+
+
+      def http_method(value=nil)
+        if value
+          @http_method = value
+        else
+          @http_method
+        end
+      end
+      
+      
+      def link_to(rel, href)
+        links << { rel: rel, href: href }
+      end
+      
+      
+      def links
+        @links ||= []
+      end
+
+
+      def params_class
+        all_params = required_params + optional_params
+
+        if all_params.length > 0
+          @params_class ||= Struct.new(*all_params)
+        end
+
+        @params_class
+      end
+
+
+      def optional_params
+        @optional_params ||= []
+      end
+
+
+      def querystring?
+        instance_methods.include? :querystring
+      end
+
+
+      def required_params
+        @required_params ||= []
+      end
+
+
+      def url?
+        instance_methods.include? :url
+      end
+
+
+      private
+
+      def required_param(param_name)
+        required_params << param_name unless required_params.include?(param_name)
+      end
+
+
+      def optional_param(param_name)
+        optional_params << param_name unless optional_params.include?(param_name)
+      end
+
+    end
+
+  end
+
+end