azure-armrest 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4759cde171ba44bc90f91439ddc0dcc7eedf318e
-  data.tar.gz: a3fe9d9e1262b89008aadb48fc253aa0f492e979
+  metadata.gz: defac8d47729576388ef8ee13366182f5d2ba617
+  data.tar.gz: 226dd08875b1bcee85ce4ada88c0d31653a7c0d5
 SHA512:
-  metadata.gz: 6f07e07d0567b32068495e0795ff78cf0d695ac4b157bcf835bfd75a6d5fba9f657c5f04d7170161a387e8bb82a05ecd6081c612b4905fa866a1c7798ee3b9c9
-  data.tar.gz: 30d9530160d22508227a01a9902097ba25eab6ad42a9e7caf5bb7f2cd93a81c64fca7dfa866d7bf5348b9d2c0ea310228e992abba90e00708b1eaa70a66a038e
+  metadata.gz: a111aa4f81c3a43699a5f39f78cbbadbc84361d18a58d40e4e5f803ad1ab2b90daa22d261ce3f58241ad787cd5c01c2678b91ec70ef977c6078d93bc74359ad1
+  data.tar.gz: 90cc8169495c37470eee3bc75b93fb907b93aa15a4a8f2c67c6cae34af5543b353a576f337f207f8c5da040a2ca4c4bf16e37a5bf92bb6821030c3669ad6b6bd

data/CHANGES

@@ -1,3 +1,9 @@
+= 0.0.7 - 5-Nov-2015
+* Refactored our BaseModel class so that it no longer uses Delegate or OpenStruct.
+* Added more methods to the StorageAccount model, and modified methods so that
+  any options are always the last argument.
+* Bug fix for the StorageAccount#all_blobs method.
+
 = 0.0.6 - 23-Oct-2015
 * Defined a custom == method for the BaseModel class.
 * The TemplateDeployment#properties.outputs now returns a hash.

data/lib/azure/armrest/model/base_model.rb

@@ -1,22 +1,21 @@
-require 'delegate'
-require 'ostruct'
-
 module Azure
   module Armrest
     # Base class for JSON wrapper classes. Each Service class should have
     # a corresponding class that wraps the JSON it collects, and each of
     # them should subclass this base class.
-    class BaseModel < Delegator
+    class BaseModel
+      # Initially inherit the exclusion list from parent class or create an empty Set.
       def self.excl_list
-        # initially inherit the exclusion list from parent class or create an empty Set
         @excl_list ||= superclass.respond_to?(:excl_list, true) ? superclass.send(:excl_list) : Set.new
       end
+
       private_class_method :excl_list
 
+      # Merge the declared exclusive attributes to the existing list.
       def self.attr_hash(*attrs)
-        # merge the declared exclusive attributes to the existing list
         @excl_list = excl_list | Set.new(attrs.map(&:to_s))
       end
+
       private_class_method :attr_hash
 
       attr_hash :tags
@@ -62,8 +61,7 @@ module Azure
           @json = json
         end
 
-        @ostruct = OpenStruct.new(hash)
-        super(@ostruct)
+        __setobj__(hash)
       end
 
       def resource_group
@@ -103,37 +101,54 @@ module Azure
         __getobj__.eql?(other.__getobj__)
       end
 
+      # Support hash style accessors
+      def [](key)
+        __getobj__[key]
+      end
+
+      def []=(key, val)
+        key_exists = __getobj__.include?(key)
+        __getobj__[key] = val
+
+        return if key_exists
+        add_accessor_methods(snake_case(key), key)
+      end
+
       protected
 
-      # Interface method required to make delegation work. Do
-      # not use this method directly.
+      # Do not use this method directly.
       def __getobj__
-        @ostruct
+        @hashobj
       end
 
-      # A custom Delegator interface method that creates snake_case
-      # versions of the camelCase delegate methods.
+      # Create snake_case accessor methods for all hash attributes
+      # Use _alias if an accessor conflicts with existing methods
       def __setobj__(obj)
+        @hashobj = obj
         excl_list = self.class.send(:excl_list)
-        obj.methods(false).each{ |m|
-          if m.to_s[-1] != '=' && !excl_list.include?(m.to_s) # Must deal with nested models
-            res = obj.send(m)
-            if res.is_a?(Array)
-              newval = res.map { |elem| elem.is_a?(Hash) ? @embedModel.new(elem) : elem }
-              obj.send("#{m}=", newval)
-            elsif res.is_a?(Hash)
-              obj.send("#{m}=", @embedModel.new(res))
+        obj.each do |key, value|
+          snake = snake_case(key)
+          unless excl_list.include?(snake) # Must deal with nested models
+            if value.is_a?(Array)
+              newval = value.map { |elem| elem.is_a?(Hash) ? @embedModel.new(elem) : elem }
+              obj[key] = newval
+            elsif value.is_a?(Hash)
+              obj[key] = @embedModel.new(value)
             end
           end
 
-          snake = m.to_s.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym
+          add_accessor_methods(snake, key)
+        end
+      end
+
+      def add_accessor_methods(method, key)
+        method.prepend('_') if methods.include?(method.to_sym)
+        instance_eval { define_singleton_method(method) { __getobj__[key] } }
+        instance_eval { define_singleton_method("#{method}=") { |val| __getobj__[key] = val } }
+      end
 
-          begin
-            obj.instance_eval("alias #{snake} #{m}; undef :#{m}") unless snake == m
-          rescue SyntaxError
-            next
-          end
-        }
+      def snake_case(name)
+        name.to_s.gsub(/(.)([A-Z])/,'\1_\2').downcase
       end
     end
 
@@ -169,4 +184,4 @@ module Azure
   end
 end
 
-require_relative 'storage_account' 
+require_relative 'storage_account'

data/lib/azure/armrest/model/storage_account.rb

@@ -7,7 +7,9 @@ module Azure
     class StorageAccount < BaseModel
       # Classes used to wrap container and blob information.
       class Container < BaseModel; end
+      class ContainerProperty < BaseModel; end
       class Blob < BaseModel; end
+      class BlobProperty < BaseModel; end
       class BlobServiceProperty < BaseModel; end
       class BlobServiceStat < BaseModel; end
       class BlobMetadata < BaseModel; end
@@ -35,6 +37,50 @@ module Azure
         end
       end
 
+      # Returns the properties for the given container +name+ using account +key+.
+      # If no key is provided, it is assumed that the StorageAccount object
+      # includes the key1 property.
+      #
+      def container_properties(name, key = nil)
+        key ||= properties.key1
+
+        response = blob_response(key, "restype=container", name)
+
+        ContainerProperty.new(response.headers)
+      end
+
+      # Returns the properties for the given container +name+ using account +key+.
+      # If no key is provided, it is assumed that the StorageAccount object
+      # includes the key1 property.
+      #
+      # If the returned object does not contain x_ms_blob_public_access then
+      # the container is private to the account owner. You can also use the
+      # :private? method to determine if the account is public or private.
+      #
+      def container_acl(name, key = nil)
+        key ||= properties.key1
+
+        response = blob_response(key, "restype=container&comp=acl", name)
+        response.headers[:private?] = response.headers.include?(:x_ms_blob_public_access) ? false : true
+
+        ContainerProperty.new(response.headers)
+      end
+
+      # Return the blob properties for the given +blob+ found in +container+. You may
+      # optionally provide a date to get information for a snapshot.
+      #
+      def blob_properties(container, blob, key = nil, options = {})
+        key ||= properties.key1
+
+        url = File.join(properties.primary_endpoints.blob, container, blob)
+        url += "?snapshot=" + options[:date] if options[:date]
+
+        headers = build_headers(url, key, :verb => 'HEAD')
+        response = RestClient.head(url, headers)
+
+        BlobProperty.new(response.headers)
+      end
+
       # Return a list of blobs for the given +container+ using the given +key+
       # or the key1 property of the StorageAccount object.
       #
@@ -49,7 +95,9 @@ module Azure
         doc = Nokogiri::XML(response.body)
 
         doc.xpath('//Blobs/Blob').map do |node|
-          Blob.new(Hash.from_xml(node.to_s)['Blob'])
+          blob = Blob.new(Hash.from_xml(node.to_s)['Blob'])
+          blob[:container] = container
+          blob
         end
       end
 
@@ -60,8 +108,8 @@ module Azure
         array = []
         threads = []
 
-        containers.each do |container|
-          threads << Thread.new(container, key){ |c,k| array << blobs(c.name, k) }
+        containers(key).each do |container|
+          threads << Thread.new(container, key) { |c, k| array << blobs(c.name, k) }
         end
 
         threads.each(&:join)
@@ -71,7 +119,7 @@ module Azure
 
       # Returns the blob service properties for the current storage account.
       #
-      def blob_properties(key = nil)
+      def blob_service_properties(key = nil)
         key ||= properties.key1
 
         response = blob_response(key, "restype=service&comp=properties")
@@ -84,11 +132,11 @@ module Azure
       # Return metadata for the given +blob+ within +container+. You may
       # specify a +date+ to retrieve metadata for a specific snapshot.
       #
-      def blob_metadata(container, blob, date = nil, key = nil)
+      def blob_metadata(container, blob, key = nil, options = {})
         key ||= properties.key1
 
         query = "comp=metadata"
-        query << "&snapshot=#{date}" if date
+        query << "&snapshot=" + options[:date] if options[:date]
 
         response = blob_response(key, query, container, blob)
 
@@ -109,6 +157,48 @@ module Azure
         BlobServiceStat.new(Hash.from_xml(doc.to_s)[toplevel])
       end
 
+      # Copy the blob from the source container/blob to the destination container/blob.
+      # If no destination blob name is provided, it will use the same name as the source.
+      #
+      # Example:
+      #
+      #   source = "Microsoft.Compute/Images/your_container/your-img-osDisk.123xyz.vhd"
+      #   storage_acct.copy_blob('system', source, 'vhds', nil, your_key)
+      #
+      def copy_blob(src_container, src_blob, dst_container, dst_blob = nil, key = nil)
+        key ||= properties.key1
+        dst_blob ||= File.basename(src_blob)
+
+        dst_url = File.join(properties.primary_endpoints.blob, dst_container, dst_blob)
+        src_url = File.join(properties.primary_endpoints.blob, src_container, src_blob)
+
+        options = {'x-ms-copy-source' => src_url, 'If-None-Match' => '*', :verb => 'PUT'}
+
+        headers = build_headers(dst_url, key, options)
+
+        # RestClient will set the Content-Type to application/x-www-form-urlencoded.
+        # We must override this setting or the request will fail.
+        headers['Content-Type'] = ''
+
+        response = RestClient.put(dst_url, '', headers)
+
+        Blob.new(response.headers)
+      end
+
+      # Delete the given +blob+ found in +container+.
+      #
+      def delete_blob(container, blob, key = nil, options = {})
+        key ||= properties.key1
+
+        url = File.join(properties.primary_endpoints.blob, container, blob)
+        url += "?snapshot=" + options[:date] if options[:date]
+
+        headers = build_headers(url, key, :verb => 'DELETE')
+        response = RestClient.delete(url, headers)
+
+        true
+      end
+
       private
 
       # Using the blob primary endpoint as a base, join any arguments to the
@@ -122,7 +212,7 @@ module Azure
 
       # Set the headers needed, including the Authorization header.
       #
-      def build_headers(url, key)
+      def build_headers(url, key, additional_headers = {})
         sig = Signature.new(url, key)
 
         headers = {
@@ -131,6 +221,7 @@ module Azure
           :auth_string    => true
         }
 
+        headers.merge!(additional_headers)
         headers['Authorization'] = sig.blob_signature(headers)
 
         headers

data/lib/azure/armrest/resource_group_service.rb

@@ -13,16 +13,14 @@ module Azure
       end
 
       # List all the resources for the current subscription. You can optionally
-      # pass :top or :filter options as well to restrict returned results.
-      #
-      # If you pass a :resource_group option, then only resources for that
-      # resource group are returned.
+      # pass :top or :filter options as well to restrict returned results. The
+      # :filter option only applies to tags.
       #
       # Examples:
       #
       #   rgs = ResourceGroupService.new
       #   rgs.list(:top => 2)
-      #   rgs.list(:filter => "location eq 'centralus'")
+      #   rgs.list(:filter => "sometag=value")
       #
       def list(options = {})
         url = build_url

data/lib/azure/armrest/resource_provider_service.rb

@@ -40,23 +40,34 @@ module Azure
       # this method are cached.
       #
       def list
-        url = build_url
-        response = rest_get(url)
-        JSON.parse(response)["value"].map{ |hash| Azure::Armrest::ResourceProvider.new(hash) }
+        _list.map{ |hash| Azure::Armrest::ResourceProvider.new(hash) }
+      end
+
+      def _list
+        response = rest_get(build_url)
+        JSON.parse(response)["value"]
       end
+      private :_list
 
-      cache_method(:list, cache_time)
+      # Cannot directly cache list method, because Marshal used by chche_method
+      # cannot dump anonymous class, including the ones derived from Azure::Armrest::BaseModel
+      # Same applies to other cached methods in this class
+      cache_method(:_list, cache_time)
 
       # Return information about a specific +namespace+ provider. The results
       # of this method are cached.
       #
       def get(namespace)
+        Azure::Armrest::ResourceProvider.new(_get(namespace))
+      end
+
+      def _get(namespace)
         url = build_url(namespace)
-        response = rest_get(url)
-        Azure::Armrest::ResourceProvider.new(response)
+        rest_get(url).body
       end
+      private :_get
 
-      cache_method(:get, cache_time)
+      cache_method(:_get, cache_time)
 
       # Returns an array of geo-locations for the given +namespace+ provider.
       # The results of this method are cached.
@@ -84,16 +95,16 @@ module Azure
       #
       def register(namespace)
         url = build_url(namespace, 'register')
-        response = rest_post(url)
-        response.return!
+        rest_post(url)
+        nil
       end
 
       # Unregister the current subscription from the +namespace+ provider.
       #
       def unregister(namespace)
         url = build_url(namespace, 'unregister')
-        response = rest_post(url)
-        response.return!
+        rest_post(url)
+        nil
       end
 
       private

data/lib/azure/armrest/version.rb

@@ -1,5 +1,5 @@
 module Azure
   module Armrest
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-armrest
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -232,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: An interface for ARM/JSON Azure REST API