ruby-keystone-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 585a295cf2751dee490fe1956e44133bd8ac33e8
+  data.tar.gz: c281bd9a20458285b700319faa7ad3bf501820ea
+SHA512:
+  metadata.gz: 69780b126eaae6bd00acced9a978e6a5601bdc469437cfd585849b1502edc5e8eded9077e79fd21a1ac9cdc44947ebb0063e386a6f2d7b4641d51c1427067667
+  data.tar.gz: ef7d55082aeeb0a962dbcea68f931084e730468dbc704118d827a6d7abbe9a0bc554f152e945c316b07dc37d70f81b75b208c28345cf528ffad799356acd6dfb

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+*.swo
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.ruby-gemset

@@ -0,0 +1 @@
+keystone-client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2015 Cimpress
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License

data/README.md

@@ -0,0 +1,102 @@
+# Keystone::V2_0::Client
+
+Ruby client to interact with the OpenStack Keystone identity and
+service catalog service for Version 2.0 of the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-keystone-client'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install ruby-keystone-client
+```
+
+## Usage
+
+### Initialization
+
+To interface with a Keystone installation, start by requiring the Keystone library:
+
+```bash
+require 'keystone/v2_0/client'
+
+=> true
+```
+
+Then, establish a connection to the Keystone service with which you wish to interact. For example, this
+Keystone service is installed on localhost running on port 35357, and we are connecting with the following:
+
+- Username: admin
+- Password  adminpass
+- Tenant:   admin
+- Auth URL: http://127.0.0.1:35357/v2.0/
+
+```bash
+ks_client = Keystone::V2_0::Client.new("admin", "adminpass", "admin", "http://127.0.0.1:35357/v2.0/")
+
+=> #<Keystone::V2_0::Client:0x000000030715b8 @username="admin", @password="adminpass", @tenant_name="admin", @auth_url="http://127.0.0.1:35357/v2.0/", @user_manager=#<Keystone::V2_0::Manager::User:0x00000003071590 @auth_url="http://127.0.0.1:35357/v2.0/", @url_endpoint="users", @json_key="users">, @role_manager=#<Keystone::V2_0::Manager::Role:0x00000003071568 @auth_url="http://127.0.0.1:35357/v2.0/", @url_endpoint="OS-KSADM/roles", @json_key="roles">, @tenant_manager=#<Keystone::V2_0::Manager::Tenant:0x00000003071540 @auth_url="http://127.0.0.1:35357/v2.0/", @url_endpoint="tenants", @json_key="tenants">, @service_manager=#<Keystone::V2_0::Manager::Service:0x000000030714f0 @auth_url="http://127.0.0.1:35357/v2.0/", @url_endpoint="OS-KSADM/services", @json_key="OS-KSADM:services">, @endpoint_manager=#<Keystone::V2_0::Manager::Endpoint:0x000000030714c8 @auth_url="http://127.0.0.1:35357/v2.0/", @url_endpoint="endpoints", @json_key="endpoints">>
+```
+
+Once you have your client "ks", you can continue to query for data within Keystone.
+
+### Tenants
+
+To query for tenants within Keystone:
+
+```bash
+ks_client.tenant_interface.list
+
+=> [#<Keystone::V2_0::Resource::Tenant:0x00000003007398 @description="Admin Tenant", @enabled=true, @id="9958cfb44628476b8f16996e76703292", @name="admin">]
+```
+
+### Users
+
+To query for users within Keystone:
+
+```bash
+ks_client.user_interface.list
+
+=> [#<Keystone::V2_0::Resource::User:0x0000000309e518 @username="admin", @name="admin", @enabled=true, @email=nil, @id="49f544c6b0d0403b97d90fe0ee0b585f">]
+```
+
+### Roles
+
+To query for roles within Keystone:
+
+```bash
+ks_client.role_interface.list
+
+=> [#<Keystone::V2_0::Resource::Role:0x0000000303e258 @enabled="True", @description="Default role for project membership", @name="_member_", @id="9fe2ff9ee4384b1894a90878d3e92bab">, #<Keystone::V2_0::Resource::Role:0x0000000303dfd8 @name="admin", @id="e409aeca08b548ceb94ced546e1a4a18">]
+```
+
+### Endpoints
+
+To query for endpoints within Keystone:
+
+```bash
+ks_client.endpoint_interface.list
+
+=> [#<Keystone::V2_0::Resource::Endpoint:0x000000032add90 @admin_url="http://127.0.0.1:35357/v2.0", @service_id="876fce0975f841fdbebd8352acda75f4", @region="regionOne", @public_url="http://10.11.13.10:5000/v2.0", @enabled=true, @id="a584ab022f0348ab9335fa2468960578", @internal_url="http://10.11.13.10:5000/v2.0">]
+```
+
+### Services
+
+To query for services within Keystone:
+
+```bash
+ks_client.service_interface.list
+
+=> [#<Keystone::V2_0::Resource::Service:0x00000002f9d628 @id="876fce0975f841fdbebd8352acda75f4", @enabled=true, @type="identity", @name="keystone", @description="Keystone Identity Service">]
+```

data/Rakefile

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

data/lib/keystone/v2_0/client.rb

@@ -0,0 +1,89 @@
+require "keystone/v2_0/version"
+require "keystone/v2_0/manager/user"
+require "keystone/v2_0/manager/role"
+require "keystone/v2_0/manager/tenant"
+require "keystone/v2_0/manager/service"
+require "keystone/v2_0/manager/endpoint"
+require "rest-client"
+require "json"
+
+module Keystone
+  module V2_0
+    class Client
+      # client specific attributes
+      attr_accessor :username
+      attr_accessor :password
+      attr_accessor :tenant_name
+      attr_accessor :auth_url
+
+      # query providers
+      attr_accessor :user_manager
+      attr_accessor :role_manager
+      attr_accessor :tenant_manager
+      attr_accessor :service_manager
+      attr_accessor :endpoint_manager
+
+      # create a new Keystone client instance with the given credentials
+      def initialize(username, password, tenant_name, auth_url)
+        # initialize the object
+        self.username    = username
+        self.password    = password
+        self.tenant_name = tenant_name
+        self.auth_url    = auth_url
+
+        # create the initial query managers
+        self.user_manager     = Keystone::V2_0::Manager::User.new     auth_url
+        self.role_manager     = Keystone::V2_0::Manager::Role.new     auth_url
+        self.tenant_manager   = Keystone::V2_0::Manager::Tenant.new   auth_url
+        self.service_manager  = Keystone::V2_0::Manager::Service.new  auth_url
+        self.endpoint_manager = Keystone::V2_0::Manager::Endpoint.new auth_url
+
+        # create the manager methods through which queries will be performed
+        # using meta-programming to ensure DRY principle is followed
+        [ "users", "roles", "tenants", "services", "endpoints" ].each do |query|
+          singular_method = query.sub(/s$/, '')
+          self.class.send(:define_method, "#{singular_method}_interface") do
+            unless (token = get_token).nil?
+              self.send("#{singular_method}_manager").token = token
+              return self.send("#{singular_method}_manager")
+            else
+              raise "An exception has occurred attempting to invoke '#{query}'"
+            end
+          end
+        end
+      end
+
+      private
+
+      # obtain a token for the action being performed
+      def get_token
+        options                           = {}
+        options[:url]                     = self.auth_url + "/tokens"
+        options[:method]                  = :post
+        options[:headers]                 = {}
+        options[:headers]["User-Agent"]   = "keystone-client"
+        options[:headers]["Accept"]       = "application/json"
+        options[:headers]["Content-Type"] = "application/json"
+        options[:payload]                 = { "auth" =>
+                                              { "tenantName" => self.tenant_name,
+                                                "passwordCredentials" =>
+                                                {
+                                                  "username" => self.username,
+                                                  "password" => self.password
+                                                }
+                                              }
+                                            }.to_json
+
+        # provide a block to ensure the response is parseable rather than
+        # having RestClient throw an exception
+        RestClient::Request.execute(options) do |response, request, result|
+          if response and response.code == 200
+            return JSON.parse(response.body)["access"]["token"]["id"]
+          else
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/manager/base.rb

@@ -0,0 +1,63 @@
+require "rest-client"
+
+module Keystone
+  module V2_0
+    module Manager
+      class Base
+        attr_accessor :auth_url
+        attr_accessor :url_endpoint
+        attr_accessor :token
+
+        def initialize(auth_url, url_endpoint)
+          self.auth_url     = auth_url
+          self.url_endpoint = url_endpoint
+        end
+
+        protected
+
+        def list
+          options                           = {}
+          options[:url]                     = "#{self.auth_url.sub(/\/$/, '')}/#{self.url_endpoint}"
+          options[:method]                  = :get
+          options[:headers]                 = {}
+          options[:headers]["X-Auth-Token"] = self.token
+          options[:headers]["User-Agent"]   = "keystone-client"
+          options[:headers]["Accept"]       = "application/json"
+          options[:headers]["Content-Type"] = "application/json"
+
+          # provide a block to ensure the response is parseable rather than
+          # having RestClient throw an exception
+          RestClient::Request.execute(options) do |response, request, result|
+            if response and response.code == 200
+              return JSON.parse(response.body)
+            else
+              return nil
+            end
+          end
+        end
+
+        def create(payload)
+          options                           = {}
+          options[:url]                     = "#{self.auth_url.sub(/\/$/, '')}/#{self.url_endpoint}"
+          options[:method]                  = :post
+          options[:headers]                 = {}
+          options[:headers]["X-Auth-Token"] = self.token
+          options[:headers]["User-Agent"]   = "keystone-client"
+          options[:headers]["Accept"]       = "application/json"
+          options[:headers]["Content-Type"] = "application/json"
+          options[:payload]                 = payload
+
+          # provide a block to ensure the response is parseable rather than
+          # having RestClient throw an exception
+          RestClient::Request.execute(options) do |response, request, result|
+            if response and response.code == 200
+              return JSON.parse(response.body)
+            else
+              return nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/manager/endpoint.rb

@@ -0,0 +1,53 @@
+require "keystone/v2_0/manager/base"
+require "keystone/v2_0/resource/endpoint"
+
+module Keystone
+  module V2_0
+    module Manager
+      class Endpoint < Keystone::V2_0::Manager::Base
+        @@url_endpoint = "endpoints"
+
+        def initialize(auth_url)
+          super auth_url, @@url_endpoint
+        end
+
+        def list
+          endpoints     = super
+          endpoint_list = []
+
+          # map role hash to array of Endpoint objects
+          unless endpoints.nil?
+            endpoints["endpoints"].each do |endpoint_data|
+              endpoint_resource = Keystone::V2_0::Resource::Endpoint.new(endpoint_data)
+              endpoint_list << endpoint_resource
+            end
+
+            return endpoint_list
+          else
+            return nil
+          end
+        end
+
+        def create(service_id: '', region: '', admin_url: '', internal_url: '', public_url: '', enabled: true)
+          create_key = "endpoint"
+          payload = { create_key =>
+                      { "service_id"  => service_id,
+                        "region"      => region,
+                        "adminurl"    => admin_url,
+                        "internalurl" => internal_url,
+                        "publicurl"   => public_url,
+                        "enabled"     => enabled
+                      }
+                    }
+          endpoint_data = super(payload.to_json)
+
+          if endpoint_data and endpoint_data[create_key]
+            return Keystone::V2_0::Resource::Endpoint.new(endpoint_data[create_key])
+          else
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/manager/role.rb

@@ -0,0 +1,33 @@
+require "keystone/v2_0/manager/base"
+require "keystone/v2_0/resource/role"
+
+module Keystone
+  module V2_0
+    module Manager
+      class Role < Keystone::V2_0::Manager::Base
+        @@url_endpoint = "OS-KSADM/roles"
+
+        def initialize(auth_url)
+          super auth_url, @@url_endpoint
+        end
+
+        def list
+          roles     = super
+          role_list = []
+
+          # map role hash to array of Role objects
+          unless roles.nil?
+            roles["roles"].each do |role_data|
+              role_resource = Keystone::V2_0::Resource::Role.new(role_data)
+              role_list << role_resource
+            end
+
+            return role_list
+          else
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/manager/service.rb

@@ -0,0 +1,50 @@
+require "keystone/v2_0/manager/base"
+require "keystone/v2_0/resource/service"
+
+module Keystone
+  module V2_0
+    module Manager
+      class Service < Keystone::V2_0::Manager::Base
+        @@url_endpoint = "OS-KSADM/services"
+
+        def initialize(auth_url)
+          super auth_url, @@url_endpoint
+        end
+
+        def list
+          services     = super
+          service_list = []
+
+          # map role hash to array of Service objects
+          unless services.nil?
+            services["OS-KSADM:services"].each do |service_data|
+              service_resource = Keystone::V2_0::Resource::Service.new(service_data)
+              service_list << service_resource
+            end
+
+            return service_list
+          else
+            return nil
+          end
+        end
+
+        def create(name: '', type: '', description: '')
+          create_key = "OS-KSADM:service"
+          payload = { create_key =>
+                      { "name"        => name,
+                        "type"        => type,
+                        "description" => description
+                      }
+                    }
+          service_data = super(payload.to_json)
+
+          if service_data and service_data[create_key]
+            return Keystone::V2_0::Resource::Service.new(service_data[create_key])
+          else
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/manager/tenant.rb

@@ -0,0 +1,33 @@
+require "keystone/v2_0/manager/base"
+require "keystone/v2_0/resource/tenant"
+
+module Keystone
+  module V2_0
+    module Manager
+      class Tenant < Keystone::V2_0::Manager::Base
+        @@url_endpoint = "tenants"
+
+        def initialize(auth_url)
+          super auth_url, @@url_endpoint
+        end
+
+        def list
+          tenants     = super
+          tenant_list = []
+
+          # map role hash to array of Tenant objects
+          unless tenants.nil?
+            tenants["tenants"].each do |tenant_data|
+              tenant_resource = Keystone::V2_0::Resource::Tenant.new(tenant_data)
+              tenant_list << tenant_resource
+            end
+
+            return tenant_list
+          else
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/manager/user.rb

@@ -0,0 +1,33 @@
+require "keystone/v2_0/manager/base"
+require "keystone/v2_0/resource/user"
+
+module Keystone
+  module V2_0
+    module Manager
+      class User < Keystone::V2_0::Manager::Base
+        @@url_endpoint = "users"
+
+        def initialize(auth_url)
+          super auth_url, @@url_endpoint
+        end
+
+        def list
+          users     = super
+          user_list = []
+
+          # map user hash to array of User objects
+          unless users.nil?
+            users["users"].each do |user_data|
+              user_resource = Keystone::V2_0::Resource::User.new(user_data)
+              user_list << user_resource
+            end
+
+            return user_list
+          else
+            return nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/resource/base.rb

@@ -0,0 +1,19 @@
+require "json"
+
+module Keystone
+  module V2_0
+    module Resource
+      class Base
+        def initialize(data)
+          # dynaically assign attributes based on the
+          # mappings provided by the subclass
+          data.each do |key, val|
+            if self.class.attr_mappings.keys.include?(key)
+              self.send("#{self.class.attr_mappings[key]}=", data[key])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/resource/endpoint.rb

@@ -0,0 +1,29 @@
+require "keystone/v2_0/resource/base"
+
+module Keystone
+  module V2_0
+    module Resource
+      class Endpoint < Keystone::V2_0::Resource::Base
+        attr_accessor :id
+        attr_accessor :service_id
+        attr_accessor :region
+        attr_accessor :admin_url
+        attr_accessor :internal_url
+        attr_accessor :public_url
+        attr_accessor :enabled
+
+        @@attr_mappings = { "id"          => :id,
+                            "service_id"  => :service_id,
+                            "region"      => :region,
+                            "adminurl"    => :admin_url,
+                            "internalurl" => :internal_url,
+                            "publicurl"   => :public_url,
+                            "enabled"     => :enabled }
+
+        def self.attr_mappings
+          @@attr_mappings
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/resource/role.rb

@@ -0,0 +1,23 @@
+require "keystone/v2_0/resource/base"
+
+module Keystone
+  module V2_0
+    module Resource
+      class Role < Keystone::V2_0::Resource::Base
+        attr_accessor :id
+        attr_accessor :name
+        attr_accessor :description
+        attr_accessor :enabled
+
+        @@attr_mappings = { "id"          => :id,
+                            "name"        => :name,
+                            "description" => :description,
+                            "enabled"     => :enabled }
+
+        def self.attr_mappings
+          @@attr_mappings
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/resource/service.rb

@@ -0,0 +1,25 @@
+require "keystone/v2_0/resource/base"
+
+module Keystone
+  module V2_0
+    module Resource
+      class Service < Keystone::V2_0::Resource::Base
+        attr_accessor :id
+        attr_accessor :name
+        attr_accessor :type
+        attr_accessor :description
+        attr_accessor :enabled
+
+        @@attr_mappings = { "id"          => :id,
+                            "name"        => :name,
+                            "type"        => :type,
+                            "description" => :description,
+                            "enabled"     => :enabled }
+
+        def self.attr_mappings
+          @@attr_mappings
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/resource/tenant.rb

@@ -0,0 +1,23 @@
+require "keystone/v2_0/resource/base"
+
+module Keystone
+  module V2_0
+    module Resource
+      class Tenant < Keystone::V2_0::Resource::Base
+        attr_accessor :id
+        attr_accessor :name
+        attr_accessor :description
+        attr_accessor :enabled
+
+        @@attr_mappings = { "id"          => :id,
+                            "name"        => :name,
+                            "description" => :description,
+                            "enabled"     => :enabled }
+
+        def self.attr_mappings
+          @@attr_mappings
+        end
+      end
+    end
+  end
+end

data/lib/keystone/v2_0/resource/user.rb

@@ -0,0 +1,25 @@
+require "keystone/v2_0/resource/base"
+
+module Keystone
+  module V2_0
+    module Resource
+      class User < Keystone::V2_0::Resource::Base
+        attr_accessor :id
+        attr_accessor :username
+        attr_accessor :name
+        attr_accessor :enabled
+        attr_accessor :email
+
+        @@attr_mappings = { "id"       => :id,
+                            "username" => :username,
+                            "name"     => :name,
+                            "enabled"  => :enabled,
+                            "email"    => :email }
+
+        def self.attr_mappings
+          @@attr_mappings
+        end
+      end
+    end
+  end
+end