openstack-keystone-client 0.0.2 → 0.0.3

data/LICENSE

@@ -1,22 +1,178 @@
-Copyright (c) 2012 yuanying, atoato88
-
-MIT License
-
-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.
+Copyright (c) 2012 Yuanying, atoato88
+All rights reserved.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/README.md

@@ -3,7 +3,8 @@ Ruby Openstack Keystone Client
 
 ## Description
 
-This is a client for the OpenStack Keystone/Glance/Nova API. There's a Ruby API.
+This is a client for the OpenStack Keystone API. There's a Ruby API.
+Porting from [python-keystoneclient](https://github.com/openstack/python-keystoneclient).
 
 ## Keystone API
 

data/lib/keystone/v2_0/client.rb

@@ -1,5 +1,6 @@
 require 'openstack-client'
 require 'openstack-client/service_catalog'
+require 'keystone/v2_0/tenants'
 require 'keystone/v2_0/tokens'
 require 'keystone/v2_0/ec2'
 
@@ -30,18 +31,17 @@ class Keystone::V2_0::Client < ::Openstack::Client
 
   # Creates a new Keystone::V2_0::Client object.
   #
-  # The constructor takes a hash of options, including:
-  #
-  #   :username - Your Openstack username (optional)
-  #   :password - Your Openstack password (optional)
-  #   :tenant_id - Your Openstack tenantId (optional)
-  #   :tenant_name - Your Openstack tenantName (optional)
-  #   :auth_url - Keystone service endpoint for authorization.
-  #   :region_name - The specific service region to use. Defaults to first returned region.
-  #   :token - Whether to retry if your auth token expires (defaults to true)
-  #   :endpoint - A user-supplied endpoint URL for the keystone
-  #               service.  Lazy-authentication is possible for API
-  #               service calls if endpoint is set at instantiation.(optional)
+  # @param [Hash] options
+  # @option options [String] :username Your Openstack username (optional)
+  # @option options [String] :password Your Openstack password (optional)
+  # @option options [String] :tenant_id Your Openstack tenantId (optional)
+  # @option options [String] :tenant_name Your Openstack tenantName (optional)
+  # @option options [String] :auth_url Keystone service endpoint for authorization.
+  # @option options [String] :region_name The specific service region to use. Defaults to first returned region.
+  # @option options [String] :token Whether to retry if your auth token expires (defaults to true)
+  # @option options [String] :endpoint A user-supplied endpoint URL for the keystone
+  #                                    service.  Lazy-authentication is possible for API
+  #                                    service calls if endpoint is set at instantiation.(optional)
   #
   def initialize options={}
     self.username     = options[:username]
@@ -55,7 +55,7 @@ class Keystone::V2_0::Client < ::Openstack::Client
 
     # self.roles = roles.RoleManager(self)
     # self.services = services.ServiceManager(self)
-    # self.tenants = tenants.TenantManager(self)
+    self.tenants = Keystone::V2_0::TenantManager.new(self)
     self.tokens = Keystone::V2_0::TokenManager.new(self)
     # self.users = users.UserManager(self)
 
@@ -77,7 +77,7 @@ class Keystone::V2_0::Client < ::Openstack::Client
   # then the resulting authenticated client will be scoped to that
   # tenant and contain a service catalog of available endpoints.
   # 
-  # Returns ``true`` if authentication was successful.
+  # @return [boolean] if authentication was successful returns true.
   def authenticate
     self.management_url = self.auth_url
     raw_token = self.tokens.authenticate(
@@ -96,10 +96,14 @@ class Keystone::V2_0::Client < ::Openstack::Client
   def _extract_service_catalog url, body
     self.service_catalog  = Openstack::Client::ServiceCatalog.new(body)
     self.auth_token       = self.service_catalog.token['id']
-    self.management_url   = self.service_catalog.url_for(
+    begin
+      self.management_url   = self.service_catalog.url_for(
                                                     attribute: 'region',
                                                     filter_value: self.region_name,
                                                     endpoint_type: 'adminURL'
                                                   )
+    rescue
+      # logger.info 'identity endpoint Not Found'
+    end
   end
 end

data/lib/keystone/v2_0/tenants.rb

@@ -0,0 +1,33 @@
+require 'openstack-client/base'
+
+module Keystone
+  module V2_0
+  end
+end
+
+class Keystone::V2_0::Tenant < Openstack::Client::Resource
+  def initialize manager, info, loaded=nil
+    super
+  end
+end
+
+class Keystone::V2_0::TenantManager < Openstack::Client::Manager
+  RESOURCE_CLASS = Keystone::V2_0::Tenant
+
+  def initialize api
+    super
+  end
+
+  def get tenant
+    self._get("/tenants/#{get_id(tenant)}", 'tenant')
+  end
+
+  def list limit=nil, marker=nil
+    params = {}
+    params['limit']   = limit   if limit
+    params['marker']  = marker  if marker
+
+    self._list(url_with_params("/tenants", params), 'tenants')
+  end
+
+end

data/lib/keystone/v2_0/tokens.rb

@@ -2,59 +2,58 @@ require 'openstack-client/base'
 
 module Keystone
   module V2_0
+  end
+end
 
-    class Token < Openstack::Client::Resource
-      def initialize manager, info, loaded=nil
-        super
-      end
-    end
+class Keystone::V2_0::Token < Openstack::Client::Resource
+  def initialize manager, info, loaded=nil
+    super
+  end
+end
+
+class Keystone::V2_0::TokenManager < Openstack::Client::Manager
+  RESOURCE_CLASS = Keystone::V2_0::Token
+
+  def initialize api
+    super
+  end
 
-    class TokenManager < Openstack::Client::Manager
-      RESOURCE_CLASS = Token
-
-      def initialize api
-        super
-      end
-
-      # options:
-      #   :username
-      #   :tenant_id
-      #   :tenant_name
-      #   :password
-      #   :token
-      #   :return_raw
-      def authenticate options
-        if options[:token]
-          params = { 'auth' => { 'token' => { 'id' => options[:token] } } }
-        elsif options[:username] and options[:password]
-          params = { 
-            'auth' => { 
-              'passwordCredentials' => {
-                'username' => options[:username],
-                'password' => options[:password]
-          }}}
-        else
-          raise 'A username and password or token is required.'
-        end
-
-        if options[:tenant_id]
-          params['auth']['tenantId'] = options[:tenant_id]
-        elsif options[:tenant_name]
-          params['auth']['tenantName'] = options[:tenant_name]
-        end
-
-        return self._create('/tokens', params, 'access', options[:return_raw])
-      end
-
-      def delete token
-        self._delete("/tokens/#{token.id}")
-      end
-
-      def endpoints token
-        self._get("/tokens/#{token.id}/endpoints", 'token')
-      end
+  # @param [Hash] options
+  # @option options [String] :username
+  # @option options [String] :tenant_id
+  # @option options [String] :tenant_name
+  # @option options [String] :password
+  # @option options [String] :token
+  # @option options [String] :return_raw
+  def authenticate options
+    if options[:token]
+      params = { 'auth' => { 'token' => { 'id' => options[:token] } } }
+    elsif options[:username] and options[:password]
+      params = { 
+        'auth' => { 
+          'passwordCredentials' => {
+            'username' => options[:username],
+            'password' => options[:password]
+      }}}
+    else
+      raise 'A username and password or token is required.'
+    end
 
+    if options[:tenant_id]
+      params['auth']['tenantId'] = options[:tenant_id]
+    elsif options[:tenant_name]
+      params['auth']['tenantName'] = options[:tenant_name]
     end
 
+    return self._create('/tokens', params, 'access', options[:return_raw])
+  end
+
+  def delete token
+    self._delete("/tokens/#{token.id}")
   end
+
+  def endpoints token
+    self._get("/tokens/#{token.id}/endpoints", 'token')
+  end
+
 end

data/lib/keystone/version.rb

@@ -1,5 +1,5 @@
 module Keystone
   class Client
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/openstack-client/service_catalog.rb

@@ -14,6 +14,7 @@ class Openstack::Client::ServiceCatalog
   end
 
   # Fetch token details fron service catalog
+  # @return [Hash] token
   def token
     unless defined?(@token)
       @token = {
@@ -32,6 +33,12 @@ class Openstack::Client::ServiceCatalog
   # the first endpoint of the specified type.
   # 
   # See tests for a sample service catalog.
+  # 
+  # @param [Hash] options
+  # @option options [String] :service_type    service type for url. (Default 'identity')
+  # @option options [String] :endpoint_type   endpoint_type for url. (Default 'publicURL')
+  # @option options [String] :attribute       attribute for filter.
+  # @option options [String] :filter_value    filter_value for url.
   def url_for options={}
     service_type  = options[:service_type] || 'identity'
     endpoint_type = options[:endpoint_type] || 'publicURL'

data/openstack-keystone-client.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["yuanying@fraction.jp", "atoato88@gmail.com"]
   gem.description   = %q{OpenStack Keystone client for Ruby.}
   gem.summary       = %q{This is a client for the OpenStack Keystone API. There's a Ruby API.}
-  gem.homepage      = "https://github.com/yuanying/ruby-openstack-keystone-client"
+  gem.homepage      = "https://github.com/nec-soft/ruby-openstack-keystone-client"
 
   gem.files         = `git ls-files`.split($\)
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstack-keystone-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70297282418740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70297282418740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70297282417420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70297282417420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70297282416120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70297282416120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70297282414940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +70,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70297282414940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
-  requirement: &70297282414160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +86,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70297282414160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70297282412940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +102,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70297282412940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: OpenStack Keystone client for Ruby.
 email:
 - yuanying@fraction.jp
@@ -94,6 +124,7 @@ files:
 - Rakefile
 - lib/keystone/v2_0/client.rb
 - lib/keystone/v2_0/ec2.rb
+- lib/keystone/v2_0/tenants.rb
 - lib/keystone/v2_0/tokens.rb
 - lib/keystone/version.rb
 - lib/openstack-client.rb
@@ -108,7 +139,7 @@ files:
 - spec/openstack-client/service_catalog_spec.rb
 - spec/openstack-client_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/yuanying/ruby-openstack-keystone-client
+homepage: https://github.com/nec-soft/ruby-openstack-keystone-client
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -122,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3300449888302740402
+      hash: -2869047404017589983
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,10 +162,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3300449888302740402
+      hash: -2869047404017589983
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: This is a client for the OpenStack Keystone API. There's a Ruby API.