fog-openstack 0.1.15 → 0.1.17

data/docs/storage.md

@@ -32,10 +32,13 @@ Next, create a connection to Swift:
 service = Fog::Storage::OpenStack.new({
   :openstack_username  => USERNAME,      # Your OpenStack Username
   :openstack_api_key   => PASSWORD,      # Your OpenStack Password
-  :openstack_auth_url  => 'http://YOUR_OPENSTACK_ENDPOINT:PORT/v2.0/tokens'
+  :openstack_auth_url  => 'http://YOUR_OPENSTACK_ENDPOINT:PORT/v2.0/tokens',
+  :connection_options  => {}
 })
 ```
 
+Read more about the [Optional Connection Parameters](common/connection_params.md)
+
 Alternative regions are specified using the key `:openstack_region `. A list of regions available for Swift can be found by executing the following:
 
 ### Optional Service Parameters
@@ -73,46 +76,6 @@ The Storage service supports the following additional parameters:
 </tr>
 </table>
 
-
-### Optional Connection Parameters
-
-Fog supports passing additional connection parameters to its underlying HTTP library (Excon) using the `:connection_options` parameter.
-
-<table>
-<tr>
-<th>Key</th>
-<th>Description</th>
-</tr>
-<tr>
-<td>:connect_timeout</td>
-<td>Connection timeout (default: 60 seconds)</td>
-</tr>
-<tr>
-
-</tr>
-<tr>
-<td>:write_timeout</td>
-<td>Write timeout for connection (default: 60 seconds)</td>
-</tr>
-<tr>
-<td>:proxy</td>
-<td>Proxy for HTTP and HTTPS connections</td>
-</tr>
-<tr>
-<td>:ssl_ca_path</td>
-<td>Path to SSL certificate authorities</td>
-</tr>
-<tr>
-<td>:ssl_ca_file</td>
-<td>SSL certificate authority file</td>
-</tr>
-<tr>
-<td>:ssl_verify_peer</td>
-<td>SSL verify peer (default: true)</td>
-
-</table>
-
-
 ## Fog Abstractions
 
 Fog provides both a **model** and **request** abstraction. The request abstraction provides the most efficient interface and the model abstraction wraps the request abstraction to provide a convenient `ActiveModel` like interface.
@@ -439,14 +402,5 @@ file.destroy
 
 ## Additional Resources
 
-* [fog.io](http://fog.io/)
-* [Fog rdoc](http://rubydoc.info/gems/fog/)
-* [Fog Github repo](https://github.com/fog/fog)
-* [Fog Github Issues](https://github.com/fog/fog/issues)
-* [Excon Github repo](https://github.com/geemus/excon)
 * [Swift API](http://docs.openstack.org/api/openstack-object-storage/1.0/content/index.html)
-
-## Support and Feedback
-
-Your feedback is appreciated! If you have specific issues with the **fog** SDK, you should file an [issue via Github](https://github.com/fog/fog/issues).
-
+* [more resources and feedback](common/resources.md)

data/docs/workflow.md

@@ -18,6 +18,8 @@ service = Fog::Workflow::OpenStack.new({
 })
 ```
 
+Read more about the [Optional Connection Parameters](common/connection_params.md)
+
 ## Executions
 
 A Workflow is a composition of one or more actions.
@@ -120,10 +122,10 @@ In addition to workflows, the following Mistral resources are also supported:
 For examples on how to interact with these resources, please refer to
 https://github.com/fog/fog-openstack/tree/master/examples/workflow/workflow-examples.rb
 
-## Information about Mistral
+## Additional Resources
 
 * [Mistral Wiki](https://wiki.openstack.org/wiki/Mistral)
 * [Mistral DSL v2](http://docs.openstack.org/developer/mistral/dsl/dsl_v2.html)
 * [Mistral API v2](http://docs.openstack.org/developer/mistral/developer/webapi/v2.html)
 * [Mistral python client](https://github.com/openstack/python-mistralclient) Can be useful to see how to interact with the API.
-
+* [more resources and feedback](common/resources.md)

data/examples/metric/basics.rb

@@ -0,0 +1,42 @@
+require 'fog/openstack'
+require 'time'
+
+auth_url = "http://10.0.0.13:5000/v3/auth/tokens"
+username = 'admin'
+password = 'njXDF8bKr68RQsfbANvURzkmT'
+project  = 'admin'
+
+@connection_params = {
+    :openstack_auth_url     => auth_url,
+    :openstack_username     => username,
+    :openstack_api_key      => password,
+    :openstack_project_name => project,
+    :openstack_domain_id    => "default"
+}
+
+puts "### SERVICE CONNECTION ###"
+
+metric = Fog::Metric::OpenStack.new(@connection_params)
+
+p metric
+
+puts "### RESOURCES ###"
+
+p metric.list_resources
+
+p metric.resources.all(details: true)
+
+p metric.resources.find_by_id("3c6c53c9-25c1-4aca-984d-a20c1926b499")
+
+p metric.get_resource_metric_measures("d1f84147-d4ef-465e-a679-265df36918ed", "disk.ephemeral.size", start: 0, stop: Time.now.iso8601, granularity: 300).body
+
+
+puts "### METRICS ###"
+
+p metric.metrics.all
+
+p metric.metrics.find_by_id("7feff2ca-2edd-4ea5-96d7-2cc5262bb504")
+
+p metric.get_metric_measures("d8e5e557-e3cc-41bd-9d87-dac3eedd0df7", start: 0, stop: Time.now.iso8601, granularity: 300).body
+
+puts "### END ###"

data/examples/shared_file_system/basics.rb

@@ -0,0 +1,68 @@
+require 'fog/openstack'
+require 'pp'
+
+#
+# Creates a share network and a share
+#
+# Needs to be in an environment where keystone v3 is available
+#
+# You will need to source OpenStack credentials since the script
+# reads the following envionment variables:
+#
+#  OS_AUTH_URL
+#  OS_PASSWORD
+#  OS_USERNAME
+#  OS_USER_DOMAIN_NAME
+#  OS_PROJECT_NAME
+#  OS_REGION_NAME
+#
+#  optionally disable SSL verification
+#  SSL_VERIFY=false
+
+auth_options = {
+  :openstack_auth_url     => "#{ENV['OS_AUTH_URL']}/auth/tokens",
+  :openstack_api_key      => ENV['OS_PASSWORD'],
+  :openstack_username     => ENV['OS_USERNAME'],
+  :openstack_domain_name  => ENV['OS_USER_DOMAIN_NAME'],
+  :openstack_project_name => ENV['OS_PROJECT_NAME'],
+  :openstack_region       => ENV['OS_REGION_NAME'],
+  :connection_options     => {:ssl_verify_peer => ENV['SSL_VERIFY'] != 'false'}
+}
+
+network_service = Fog::Network::OpenStack.new(auth_options)
+share_service   = Fog::SharedFileSystem::OpenStack.new(auth_options)
+
+net = network_service.networks.first
+raise 'no network exists' if net.nil?
+
+puts "Create share network in #{net.name}"
+share_network = share_service.networks.create(
+  :neutron_net_id    => net.id,
+  :neutron_subnet_id => net.subnets.first.id,
+  :name              => 'fog_share_net'
+)
+
+pp share_network
+
+puts 'Create share'
+example_share = share_service.shares.create(
+  :share_proto      => 'NFS',
+  :size             => 1,
+  :name             => 'fog_share',
+  :share_network_id => share_network.id
+)
+
+pp example_share
+
+puts 'Create snapshot'
+example_snap = share_service.snapshots.create(
+  :share_id => example_share.id,
+  :name     => 'fog_share_snapshot'
+)
+
+pp example_snap
+
+puts 'Removing snapshot, share and share network'
+example_snap.destroy
+example_share.destroy
+share_network.destroy

data/gemfiles/Gemfile-1.9

@@ -17,4 +17,5 @@ group :development, :test do
   gem "json",            "< 2.0"
 # TODO: remove when https://github.com/fog/fog-openstack/issues/202 is fixed
 #  gem "coveralls",       "< 0.8.15"
+  gem "public_suffix",    "~> 1.4.6"
 end

data/lib/fog/identity/openstack/v3/requests/list_groups.rb

@@ -7,7 +7,7 @@ module Fog
             user_id = options.delete('user_id') || options.delete(:user_id)
 
             path = if user_id
-                     "users/#{user_id}groups"
+                     "users/#{user_id}/groups"
                    else
                      "groups"
                    end

data/lib/fog/image/openstack/v2/models/image.rb

@@ -14,6 +14,7 @@ module Fog
 
           attribute :self
           attribute :size
+          attribute :virtual_size
           attribute :disk_format
           attribute :container_format
           attribute :id
@@ -45,6 +46,8 @@ module Fog
               attributes[method_sym]
             elsif attributes.key?(method_sym.to_s)
               attributes[method_sym.to_s]
+            elsif method_sym.to_s.end_with?('=')
+              attributes[method_sym.to_s.gsub(/=$/, '')] = arguments[0]
             else
               super
             end
@@ -55,6 +58,8 @@ module Fog
               true
             elsif attributes.key?(method_sym.to_s)
               true
+            elsif method_sym.to_s.end_with?('=')
+              true
             else
               super
             end
@@ -66,28 +71,32 @@ module Fog
             self
           end
 
-          # This overrides the behaviour of Fog::OpenStack::Model::save() which tries to be clever and
-          #  assumes save=update if an ID is present - but Image V2 allows ID to specified on creation
-          def identity
-            nil
-          end
-
-          # Hash of attributes to update is passed in. Setting value to nil will delete that attribute.
-          #  Here we convert that hash into a form suitable for Glance's usage of JSON Patch (RFC6902)
-          def update(attr = {})
+          # Here we convert 'attributes' into a form suitable for Glance's usage of JSON Patch (RFC6902).
+          #  We fetch the existing attributes from the server to compute the delta (difference)
+          #  Setting value to nil will delete that attribute from the server.
+          def update(attr = nil)
             requires :id
-            json_patch = []
-            attr.each do |key, value|
-              op = (@attributes.keys.include? key) ? 'replace' : 'add'
-              op = 'remove' if value.nil?
-              json_patch << {:op => op, :path => "/#{key}", :value => value}
-            end
+            client_attributes = attr || @attributes
+            server_attributes = service.images.get(id).attributes
+
+            json_patch = build_update_json_patch(client_attributes, server_attributes)
+
             merge_attributes(
               service.update_image(id, json_patch).body
             )
             self
           end
 
+          # This overrides the behaviour of Fog::OpenStack::Model::save() which tries to be clever and
+          #  assumes save=update if an ID is present - but Image V2 allows ID to be specified on creation
+          def save
+            if @attributes[:self].nil?
+              create
+            else
+              update
+            end
+          end
+
           def destroy
             requires :id
             service.delete_image(id)
@@ -162,6 +171,42 @@ module Fog
             requires :id
             service.remove_tag_from_image(id, tag)
           end
+
+          private
+
+          def build_update_json_patch(client_attributes, server_attributes)
+            [
+              build_patch_operation('remove', patch_attributes_to_remove(client_attributes, server_attributes)),
+              build_patch_operation('add', patch_attributes_to_add(client_attributes, server_attributes)),
+              build_patch_operation('replace', patch_attributes_to_replace(client_attributes, server_attributes)),
+            ].flatten
+          end
+
+          def patch_attributes_to_remove(client_attributes, server_attributes)
+            client_attributes.select do |key, value|
+              value.nil? && !server_attributes[key].nil?
+            end
+          end
+
+          def patch_attributes_to_add(client_attributes, server_attributes)
+            client_attributes.reject do |key, _|
+              server_attributes.key?(key)
+            end
+          end
+
+          def patch_attributes_to_replace(client_attributes, server_attributes)
+            client_attributes.reject do |key, value|
+              value.nil? || server_attributes[key] == value
+            end
+          end
+
+          def build_patch_operation(op_name, attributes)
+            json_patch = []
+            attributes.each do |key, value|
+              json_patch << {:op => op_name, :path => "/#{key}", :value => value}
+            end
+            json_patch
+          end
         end
       end
     end

data/lib/fog/image/openstack/v2/models/images.rb

@@ -17,10 +17,7 @@ module Fog
           end
 
           def find_by_id(id)
-            image_hash = service.get_image_by_id(id).body
-            Fog::Image::OpenStack::V2::Image.new(
-              image_hash.merge(:service => service)
-            )
+            new(service.get_image_by_id(id).body)
           end
 
           alias get find_by_id

data/lib/fog/metric/openstack.rb

@@ -0,0 +1,126 @@
+module Fog
+  module Metric
+    class OpenStack < Fog::Service
+      SUPPORTED_VERSIONS = /v1/
+
+      requires :openstack_auth_url
+      recognizes :openstack_auth_token, :openstack_management_url,
+                 :persistent, :openstack_service_type, :openstack_service_name,
+                 :openstack_tenant, :openstack_tenant_id,
+                 :openstack_api_key, :openstack_username, :openstack_identity_endpoint,
+                 :current_user, :current_tenant, :openstack_region,
+                 :openstack_endpoint_type, :openstack_cache_ttl,
+                 :openstack_project_name, :openstack_project_id,
+                 :openstack_project_domain, :openstack_user_domain, :openstack_domain_name,
+                 :openstack_project_domain_id, :openstack_user_domain_id, :openstack_domain_id,
+                 :openstack_identity_prefix
+
+      model_path 'fog/metric/openstack/models'
+
+      model       :metric
+      collection  :metrics
+      model       :resource
+      collection  :resources
+
+      request_path 'fog/metric/openstack/requests'
+
+      request :get_resource_metric_measures
+      request :get_metric_measures
+      request :get_metric
+      request :list_metrics
+      request :get_resource
+      request :list_resources
+
+      class Mock
+        def self.data
+          @data ||= Hash.new do |hash, key|
+            hash[key] = {
+              :users   => {},
+              :tenants => {}
+            }
+          end
+        end
+
+        def self.reset
+          @data = nil
+        end
+
+        def initialize(options = {})
+          @openstack_username = options[:openstack_username]
+          @openstack_tenant   = options[:openstack_tenant]
+          @openstack_auth_uri = URI.parse(options[:openstack_auth_url])
+
+          @auth_token = Fog::Mock.random_base64(64)
+          @auth_token_expiration = (Time.now.utc + 86400).iso8601
+
+          management_url = URI.parse(options[:openstack_auth_url])
+          management_url.port = 8041
+          management_url.path = '/v1'
+          @openstack_management_url = management_url.to_s
+
+          @data ||= {:users => {}}
+          unless @data[:users].find { |u| u['name'] == options[:openstack_username] }
+            id = Fog::Mock.random_numbers(6).to_s
+            @data[:users][id] = {
+              'id'       => id,
+              'name'     => options[:openstack_username],
+              'email'    => "#{options[:openstack_username]}@mock.com",
+              'tenantId' => Fog::Mock.random_numbers(6).to_s,
+              'enabled'  => true
+            }
+          end
+        end
+
+        def data
+          self.class.data[@openstack_username]
+        end
+
+        def reset_data
+          self.class.data.delete(@openstack_username)
+        end
+
+        def credentials
+          {:provider                 => 'openstack',
+           :openstack_auth_url       => @openstack_auth_uri.to_s,
+           :openstack_auth_token     => @auth_token,
+           :openstack_management_url => @openstack_management_url}
+        end
+      end
+
+      class Real
+        include Fog::OpenStack::Core
+
+        def self.not_found_class
+          Fog::Metric::OpenStack::NotFound
+        end
+
+        def initialize(options = {})
+          initialize_identity options
+
+          @openstack_service_type           = options[:openstack_service_type] || ['metric']
+          @openstack_service_name           = options[:openstack_service_name]
+          @openstack_endpoint_type          = options[:openstack_endpoint_type] || 'publicURL'
+
+          @connection_options               = options[:connection_options] || {}
+
+          authenticate
+          set_api_path
+
+          @persistent = options[:persistent] || false
+          @connection = Fog::Core::Connection.new("#{@scheme}://#{@host}:#{@port}", @persistent, @connection_options)
+        end
+
+        def set_api_path
+          unless @path.match(SUPPORTED_VERSIONS)
+            @path = Fog::OpenStack.get_supported_version_path(
+              SUPPORTED_VERSIONS,
+              @openstack_management_uri,
+              @auth_token,
+              @connection_options
+            )
+          end
+        end
+      end
+    end
+  end
+end