azure-armrest 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d37ff1ea6844a2ba05ee94cb4cb8a660f7a4de0
-  data.tar.gz: 5c517080720615271223342ac26279df490b753e
+  metadata.gz: 1dd317c12a178191adb7d5f66fde6ed1c5739c96
+  data.tar.gz: 70f5fb9db2f070fb5b1d3cd9b9f917a444eb4bfd
 SHA512:
-  metadata.gz: ddf50c2759ae7f41cb610cc7ac14aa1459b01b1ee0ef9761183cfb9ebab182f086a87828d3bc751ad8dbfa2123c0e9bdcf019e227d5db22ec9e5b6851056c93b
-  data.tar.gz: 98ef0ba9a5a445c3828407071ba4287910cb5b6d888590f384051b4318b0bc317818d9f3a2e9654be916a553de3f56420587af663b9fc1dd1c4b026d4cedb00c
+  metadata.gz: 1ad7c72b3d648dc98ef1e6a1913e544b10d27cedb66b04dce4abf587b1fb7a7dbf98dc4ddf8f0707f184737da3960861cf19df2d1be6b03451477cca790bf50e
+  data.tar.gz: 7dbb101daa10eda92507ebf74511b70cde4cd1ef3292d4c662be2e372608527de2419005b732c2d372e3b03d760f6c5dff8d2583d91cc34fd5bcb1921df30d93

data/CHANGES

@@ -1,2 +1,9 @@
-= 0.1.0 - ???
+= 0.0.2 - 23-Sep-2015
+* Revamped class names. Now use "Service" instead of "Manager".
+* Several new service classes added, updated, and refactored.
+* All service classes now take and store configuration information as the
+  first argument to ensure distinct credentials.
+* Added Bill Wei as author.
+
+= 0.0.1 - 13-Aug-2015
 * Initial release

data/README.md

@@ -13,10 +13,11 @@ A Ruby interface for Azure using the new REST API.
 ```ruby
 require 'azure/armrest'
 
-# Set things on a global level. All other objects will then use the
+# Create a configuration object. All service objects will then use the
 # information you set here.
+# A token will be retrieved based on the information you provided
 
-Azure::Armrest::ArmrestManager.configure(
+conf = Azure::Armrest::ArmrestService.configure(
   :client_id       => 'XXXXX',
   :client_key      => 'YYYYY',
   :tenant_id       => 'ZZZZZ',
@@ -24,25 +25,13 @@ Azure::Armrest::ArmrestManager.configure(
 )
 
 # This will then use the configuration info set above.
-vmm = Azure::Armrest::VirtualMachineManager.new
-
-# Alternatively you can set the configuration information on a per-instance
-# basis if you need different credentials for different classes.
-vmm = Azure::Armrest::VirtualMachineManager.new(
-  :client_id       => 'XXXXX',
-  :client_key      => 'YYYYY',
-  :tenant_id       => 'ZZZZZ',
-  :subscription_id => 'ABCDEFG'
-)
-
-# Call this before making method calls if using per-instance configuration.
-# This is not necessary if you set it via ArmrestManager.configure.
-vmm.get_token
+# You can add other options specific to the service to be created
+vms = Azure::Armrest::VirtualMachineService.new(conf, options)
 
 # Create a virtual machine
 vmm.create_virtual_machine(
   :name           => 'some_vm',
-  :location       => 'West US', 
+  :location       => 'West US',
   :vm_size        => 'Standard_A1',
   :computer_name  => 'whatever',
   :admin_username => 'admin_user',
@@ -52,11 +41,6 @@ vmm.create_virtual_machine(
 )
 ```
 
-## Tokens and methods
-
-You will not be able to make any method calls until you first call the
-get_token method.
-
 ## Subscriptions
 
 If you do not provide a subscription ID to the constructor, then the first
@@ -75,4 +59,5 @@ The gem is available as open source under the terms of the [Apache License 2.0](
 
 * Daniel Berger
 * Bronagh Sorota
+* Bill Wei
 

data/Rakefile

@@ -10,9 +10,9 @@ namespace :spec do
       t.pattern = ['spec/armrest_module_spec.rb']
     end
 
-    desc 'Run tests for the Armrest::ArmrestManager base class'
-    RSpec::Core::RakeTask.new(:manager) do |t|
-      t.pattern = ['spec/armrest_manager_spec.rb']
+    desc 'Run tests for the Armrest::ArmrestService base class'
+    RSpec::Core::RakeTask.new(:service) do |t|
+      t.pattern = ['spec/armrest_service_spec.rb']
     end
   end
 end

data/azure-armrest.gemspec

@@ -4,30 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'azure/armrest/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'azure-armrest'
-  spec.version       = Azure::Armrest::VERSION
-  spec.authors       = ['Daniel J. Berger', 'Bronagh Sorota', 'Greg Blomquist']
-  spec.email         = ['dberger@redhat.com', 'bsorota@redhat.com', 'gblomqui@redhat.com']
+  spec.name     = 'azure-armrest'
+  spec.version  = Azure::Armrest::VERSION
+  spec.authors  = ['Daniel J. Berger', 'Bronagh Sorota', 'Greg Blomquist', 'Bill Wei']
+  spec.email    = ['dberger@redhat.com', 'bsorota@redhat.com', 'gblomqui@redhat.com', 'billwei@redhat.com']
+  spec.summary  = 'An interface for ARM/JSON Azure REST API'
+  spec.homepage = 'http://github.com/ManageIQ/azure-armrest'
+  spec.license  = 'Apache 2.0'
+  spec.files    = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
-  spec.summary       = 'An interface for ARM/JSON Azure REST API'
-  spec.description   = <<-EOF
+  spec.description = <<-EOF
 This is a Ruby interface for Azure using the newer REST API. This is
 different than the current azure gem, which uses the older (XML) interface
 behind the scenes.
   EOF
-  spec.homepage      = 'http://github.com/ManageIQ/azure-armrest'
-  spec.license       = 'Apache 2.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_dependency 'json'
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'cache_method', "~> 0.2.7"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "codeclimate-test-reporter"
-
-  spec.add_dependency 'json'
-  spec.add_dependency 'rest-client'
+  spec.add_development_dependency "timecop", "~> 0.7"
 end

data/lib/azure/armrest.rb

@@ -1,6 +1,7 @@
 require 'rest-client'
 require 'json'
 require 'thread'
+require 'uri'
 
 # The Azure module serves as a namespace.
 module Azure
@@ -21,12 +22,16 @@ module Azure
 end
 
 require 'azure/armrest/version'
-require 'azure/armrest/armrest_manager'
-require 'azure/armrest/storage_account_manager'
-require 'azure/armrest/availability_set_manager'
-require 'azure/armrest/virtual_machine_manager'
-require 'azure/armrest/virtual_machine_image_manager'
-require 'azure/armrest/virtual_machine_extension_manager'
-require 'azure/armrest/virtual_network_manager'
-require 'azure/armrest/subnet_manager'
-require 'azure/armrest/event_manager'
+require 'azure/armrest/armrest_service'
+require 'azure/armrest/storage_account_service'
+require 'azure/armrest/availability_set_service'
+require 'azure/armrest/virtual_machine_service'
+require 'azure/armrest/virtual_machine_image_service'
+require 'azure/armrest/virtual_machine_extension_service'
+require 'azure/armrest/virtual_network_service'
+require 'azure/armrest/subnet_service'
+require 'azure/armrest/event_service'
+require 'azure/armrest/template_deployment_service'
+require 'azure/armrest/resource_service'
+require 'azure/armrest/resource_group_service'
+require 'azure/armrest/resource_provider_service'

data/lib/azure/armrest/armrest_service.rb

@@ -0,0 +1,385 @@
+module Azure
+  module Armrest
+    # Abstract base class for the other service classes.
+    class ArmrestService
+      ArmrestConfiguration = Struct.new(
+        :client_id,
+        :client_key,
+        :tenant_id,
+        :subscription_id,
+        :resource_group,
+        :api_version,
+        :grant_type,
+        :content_type,
+        :accept,
+        :token,
+        :token_expiration # token expiration local system date
+      ) do
+        @@tokens = Hash.new([])
+
+        def as_cache_key
+          "#{grant_type}_#{tenant_id}_#{client_id}_#{client_key}"
+        end
+
+        def token
+          self[:token], self[:token_expiration] = @@tokens[as_cache_key] if self[:token].nil?
+
+          if self[:token].nil? || Time.now > (self[:token_expiration] || Time.new(0))
+            self[:token], self[:token_expiration] = fetch_token
+          end
+          self[:token]
+        end
+
+        def fetch_token
+          token_url = Azure::Armrest::AUTHORITY + tenant_id + "/oauth2/token"
+
+          response = JSON.parse(RestClient.post(
+            token_url,
+            :grant_type    => grant_type,
+            :client_id     => client_id,
+            :client_secret => client_key,
+            :resource      => Azure::Armrest::RESOURCE
+          ))
+          token = 'Bearer ' + response['access_token']
+          @@tokens[as_cache_key] = [token, Time.now + response['expires_in'].to_i]
+        end
+
+        private :fetch_token
+      end
+
+      # Configuration to access azure APIs
+      attr_accessor :armrest_configuration
+
+      # Base url used for REST calls.
+      attr_accessor :base_url
+
+      @@providers_hash = {} # Set in constructor
+
+      @@tokens = {} # token caches
+
+      @@subscriptions = {} # subscription caches
+
+      # Create a configuration object based on input options.
+      # This object can be used to create service objects.
+      #
+      # Possible options are:
+      #
+      #   - client_id
+      #   - client_key
+      #   - tenant_id
+      #   - subscription_id
+      #   - resource_group
+      #   - api_version
+      #   - grant_type
+      #   - content_type
+      #   - accept
+      #   - token,
+      #   - token_expiration
+      #
+      # Of these, you should include a client_id, client_key and tenant_id.
+      # The resource_group can be specified here, but many methods allow you
+      # to specify a resource group if you prefer flexibility.
+      #
+      # If no subscription_id is provided then this method will attempt to find
+      # a list of associated subscriptions and use the first one it finds as
+      # the default. If no associated subscriptions are found, an ArgumentError
+      # is raised.
+      #
+      # The other options (grant_type, content_type, accept, token,
+      # token_expirationand api_version) should generally NOT be set by you
+      # except in specific circumstances.  Setting them explicitly will likely
+      # cause breakage. Token and token_expiration must be set in pair.
+      # Token_expiration is of local system time.
+      # The api_version will typically be overridden on a per-provider/resource
+      # basis within subclasses anyway.
+      #
+      # You may need to associate your application with a subscription using
+      # the new portal or the New-AzureRoleAssignment powershell command.
+      #
+      def self.configure(options)
+        configuration = ArmrestConfiguration.new
+
+        options.each do |k,v|
+          configuration[k] = v
+        end
+
+        unless configuration.client_id && configuration.client_key
+          raise ArgumentError, "client_id and client_key must be specified"
+        end
+
+        configuration.api_version     ||= '2015-01-01'
+        configuration.grant_type      ||= 'client_credentials'
+        configuration.content_type    ||= 'application/json'
+        configuration.accept          ||= 'application/json'
+        configuration.subscription_id ||= fetch_subscription_id(configuration)
+
+        configuration
+      end
+
+      def self.fetch_subscription_id(config)
+        return @@subscriptions[config.as_cache_key] if @@subscriptions.has_key?(config.as_cache_key)
+
+        url = File.join(Azure::Armrest::RESOURCE, "subscriptions?api-version=#{config.api_version}")
+
+        response = RestClient.get(
+          url,
+          :content_type  => config.content_type,
+          :authorization => config.token
+        )
+
+        hash = JSON.parse(response)["value"].first
+
+        raise ArgumentError, "No associated subscription found" if hash.empty?
+
+        id = hash.fetch("subscriptionId")
+        @@subscriptions[config.as_cache_key] = id
+      end
+
+      private_class_method :fetch_subscription_id
+
+      # Do not instantiate directly. This is an abstract base class from which
+      # all other service classes should subclass, and call super within their
+      # own constructors.
+      #
+      def initialize(armrest_configuration, _options)
+        self.armrest_configuration = armrest_configuration
+
+        # Base URL used for REST calls. Modify within method calls as needed.
+        @base_url = Azure::Armrest::RESOURCE
+
+        set_providers_info
+      end
+
+      # Returns a list of the available resource providers.
+      #
+      def providers
+        url = url_with_api_version(armrest_configuration.api_version, @base_url, 'providers')
+        resp = rest_get(url)
+        JSON.parse(resp.body)["value"]
+      end
+
+      # Returns information about the specific provider +namespace+.
+      #
+      def provider_info(provider)
+        url = url_with_api_version(armrest_configuration.api_version, @base_url, 'providers', provider)
+        response = rest_get(url)
+        JSON.parse(response.body)
+      end
+
+      alias geo_locations provider_info
+
+      # Returns a list of all locations for all resource types of the given
+      # +provider+. If you do not specify a provider, then the locations for
+      # all providers will be returned.
+      #
+      # If you need individual details on a per-provider basis, use the
+      # provider_info method instead.
+      #--
+      #
+      def locations(provider = nil)
+        hash = provider.nil? ? @@providers_hash : {provider => @@providers_hash[provider.downcase]}
+
+        hash.collect do |_provider, provider_data|
+          provider_data.collect { |_resource, resource_data| resource_data['locations'] }
+        end.flatten.uniq
+      end
+
+      # Returns a list of subscriptions for the tenant.
+      #
+      def subscriptions
+        url = url_with_api_version(armrest_configuration.api_version, @base_url, 'subscriptions')
+        resp = rest_get(url)
+        JSON.parse(resp.body)["value"]
+      end
+
+      # Return information for the specified subscription ID, or the
+      # subscription ID that was provided in the constructor if none is
+      # specified.
+      #
+      def subscription_info(subscription_id = armrest_configuration.subscription_id)
+        url = url_with_api_version(
+          armrest_configuration.api_version,
+          @base_url,
+          'subscriptions',
+          armrest_configuration.subscription_id
+        )
+
+        resp = rest_get(url)
+        JSON.parse(resp.body)
+      end
+
+      # Returns a list of resources for the current subscription. If a
+      # +resource_group+ is provided, only list resources for that
+      # resource group.
+      #
+      def resources(resource_group = nil)
+        url_comps = [@base_url, 'subscriptions', armrest_configuration.subscription_id]
+        url_comps += ['resourcegroups', resource_group] if resource_group
+        url_comps << 'resources'
+
+        url = url_with_api_version(armrest_configuration.api_version, url_comps)
+        response = rest_get(url)
+
+        JSON.parse(response.body)["value"]
+      end
+
+      # Returns a list of resource groups for the current subscription.
+      #
+      def resource_groups
+        url = url_with_api_version(
+          armrest_configuration.api_version,
+          @base_url,
+          'subscriptions',
+          armrest_configuration.subscription_id,
+          'resourcegroups'
+        )
+        response = rest_get(url)
+        JSON.parse(response.body)["value"]
+      end
+
+      # Returns information on the specified +resource_group+ for the current
+      # subscription, or the resource group specified in the constructor if
+      # none is provided.
+      #
+      def resource_group_info(resource_group)
+        url = url_with_api_version(
+          armrest_configuration.api_version,
+          @base_url,
+          'subscriptions',
+          armrest_configuration.subscription_id,
+          'resourcegroups',
+          resource_group
+        )
+
+        resp = rest_get(url)
+        JSON.parse(resp.body)
+      end
+
+      # Returns a list of tags for the current subscription.
+      #
+      def tags
+        url = url_with_api_version(
+          armrest_configuration.api_version,
+          @base_url,
+          'subscriptions',
+          armrest_configuration.subscription_id,
+          'tagNames'
+        )
+        resp = rest_get(url)
+        JSON.parse(resp.body)["value"]
+      end
+
+      # Returns a list of tenants that can be accessed.
+      #
+      def tenants
+        url = url_with_api_version(armrest_configuration.api_version, @base_url, 'tenants')
+        resp = rest_get(url)
+        JSON.parse(resp.body)
+      end
+
+      private
+
+      # REST verb methods
+
+      def rest_get(url)
+        RestClient.get(
+          url,
+          :accept        => armrest_configuration.accept,
+          :content_type  => armrest_configuration.content_type,
+          :authorization => armrest_configuration.token,
+        )
+      end
+
+      def rest_put(url, body = '')
+        RestClient.put(
+          url,
+          body,
+          :accept        => armrest_configuration.accept,
+          :content_type  => armrest_configuration.content_type,
+          :authorization => armrest_configuration.token,
+        )
+      end
+
+      def rest_post(url, body = '')
+        RestClient.post(
+          url,
+          body,
+          :accept        => armrest_configuration.accept,
+          :content_type  => armrest_configuration.content_type,
+          :authorization => armrest_configuration.token,
+        )
+      end
+
+      def rest_patch(url, body = '')
+        RestClient.patch(
+          url,
+          body,
+          :accept        => armrest_configuration.accept,
+          :content_type  => armrest_configuration.content_type,
+          :authorization => armrest_configuration.token,
+        )
+      end
+
+      def rest_delete(url)
+        RestClient.delete(
+          url,
+          :accept        => armrest_configuration.accept,
+          :content_type  => armrest_configuration.content_type,
+          :authorization => armrest_configuration.token,
+        )
+      end
+
+      # Take an array of URI elements and join the together with the API version.
+      def url_with_api_version(api_version, *paths)
+        File.join(*paths) << "?api-version=#{api_version}"
+      end
+
+      # Build a one-time lookup table for each provider & resource. This
+      # lets subclasses set api-version strings properly for each method
+      # depending on whichever provider they're using.
+      #
+      # e.g. @@providers_hash['Microsoft.Compute']['virtualMachines']['api_version']
+      #
+      # Note that for methods that don't depend on a resource type should use
+      # armrest_configuration.api_version instead or set it explicitly as needed.
+      #
+      def set_providers_info
+        return unless @@providers_hash.empty?
+
+        providers.each do |info|
+          provider_info = {}
+          info['resourceTypes'].each do |resource|
+            provider_info[resource['resourceType']] = {
+              'api_version' => resource['apiVersions'].first,
+              'locations'   => resource['locations'] - [''] # Ignore empty elements
+            }
+          end
+          @@providers_hash[info['namespace'].downcase] = provider_info
+        end
+      end
+
+      # Each Azure API call may require different api_version.
+      # The api_version in armrest_configuration is used for common methods provided
+      # by ArmrestService
+      #
+      # The options hash for each service's constructor can contain key-value pair
+      #   api_version => version
+      # This version will be used for the service specific API calls
+      #
+      # Otherwise the service specific api_version is looked up from @@providers_hash
+      #
+      # Finally api_version in armrest_configuration is used if service specific version
+      # cannot be determined
+      def set_service_api_version(options, service)
+        @api_version =
+          if options.has_key?('api_version')
+            options['api_version']
+          elsif @@providers_hash.has_key?(@provider.downcase)
+            @@providers_hash[@provider.downcase][service]['api_version']
+          else
+            armrest_configuration.api_version
+          end
+      end
+    end # ArmrestService
+  end # Armrest
+end # Azure