abiquo-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '081649fb6f2d19e5513bf3b9882819c30d16bbd1'
-  data.tar.gz: 63a0c58e1add09477c713902fa2d635469ddf599
+  metadata.gz: de18c834f09d7c9d5de6d66bf6bdeab3cf6411d2
+  data.tar.gz: 3452aabc8d21f916d95d433d4f8a7e13832b007e
 SHA512:
-  metadata.gz: abe73a4ea3d1aa60337299cd9b956f0033e63cdf2c7118319180b5e93d93946d41624a3ac6e8b3087f1d09422034c542d2b285c39508bd5dc2353f399f05175f
-  data.tar.gz: 76853b77d605f04a5fbe0f48b934944ba4492a4934d2df7b4194d34c1b86005467a5ca7f5a318c3b68773549841a158509f893d486015457fe64e4a8fe0ca455
+  metadata.gz: 3f058fd0c5fa53fb3eb7b18b86dff51c28f36086e5044cceeaf62bfbfa9203119b188ed176af5c797b2b722c4bdc254ac9339e50dc0d60fc1069a565148f1369
+  data.tar.gz: 8dcd5f3d1ff42318a24aec23fac631a665b9f0ebcc0f290abb59f9c072f448dc2087ed09a23d56bfe96003509bc4ab91fc21e1d16aa193593612f64ddbf84b27

data/README.md

@@ -68,24 +68,23 @@ abq = AbiquoAPI.new(:abiquo_api_url => 'https://10.60.13.40/api',
 Then you can start browsing the API:
 
 ```ruby
-l = AbiquoAPI::Link.new(:href => '/api/cloud/virtualdatacenters', 
-              :type => 'application/vnd.abiquo.virtualdatacenters+json',
-              :client => abq)
+l = AbiquoAPI::Link.new(:href => 'cloud/virtualdatacenters', 
+                        :type => 'application/vnd.abiquo.virtualdatacenters+json',
+                        :client => abq)
 
 l.get
 ```
 
 ## Client object
 
-The client object contains 3 objects that allow API browsing.
+The client object contains 2 methods that allow API browsing.
 
-- **user.** The user object returned by the ```/api/login``` call.
-- **enterprise.** The user's enterprise link to be used in new objects.
-- **properties.** A hash containing all the system properties in the system. Useful to get default values for some objects (ie. VLAN parameters in VDC creation).
+- **login** Makes the `login` API call, returning the current user information. From there you can navigate to related objects.
+- **properties** Makes the `config/properties` call and returns a hash containing all the system properties in the system. Useful to get default values for some objects (ie. VLAN parameters in VDC creation).
 
 ## Link object
 
-Represents an Abiquo API Link. Issuing ```get``` on them will retrieve link destination. This allows for things like:
+Represents an Abiquo API Link. Issuing `get` on them will retrieve link destination. This allows for things like:
 
 ```ruby
 vapp = vdc.link(:virtualappliances).get.first
@@ -107,19 +106,19 @@ This is used to iterate over paginated lists.
 
 ```ruby
 a = AbiquoAPI.new(:abiquo_api_url => 'https://10.60.13.40/api', 
-                     :abiquo_username => "admin", 
-                     :abiquo_password => "xabiquo")
+                  :abiquo_username => "admin", 
+                  :abiquo_password => "xabiquo")
 ```
 
 
-#### User object
+#### Login call
 
 Is the User object returned by the API at login. You can browse the links provided like:
 
 ```ruby
-a.user
+user = a.login
 
-vm = a.user.link(:virtualmachines).get.first
+vm = user.link(:virtualmachines).get.first
 
 vm.name
 => "ABQ_6b6d9856-c05f-425e-8916-1ff7de1683e3"
@@ -134,21 +133,22 @@ vm.id
 
 ```ruby
 a = AbiquoAPI.new(:abiquo_api_url => 'https://10.60.13.40/api', 
-                     :abiquo_username => "admin", 
-                     :abiquo_password => "xabiquo")
+                  :abiquo_username => "admin", 
+                  :abiquo_password => "xabiquo")
 ```
 
 #### Create a Link object to issue a request
 
 ```ruby
 l = AbiquoAPI::Link.new(:href => '/api/cloud/virtualdatacenters', 
-              :type => 'application/vnd.abiquo.virtualdatacenters+json')
+                        :type => 'application/vnd.abiquo.virtualdatacenters+json',
+                        :client => a)
 ```
 
 #### Get on the link
 
 ```ruby
-v = a.get(l).first
+v = l.get.first
 ```
 
 #### Create a new object
@@ -167,7 +167,7 @@ v1.vlan.delete("tag")
 
 ```ruby
 l1 = AbiquoAPI::Link.new(:href => '/api/cloud/virtualdatacenters', 
-              :type => 'application/vnd.abiquo.virtualdatacenter+json')
+                         :type => 'application/vnd.abiquo.virtualdatacenter+json')
 ```
 
 #### Post data

data/lib/abiquo-api.rb

@@ -82,24 +82,13 @@ class AbiquoAPI
                                                   credentials,
                                                   connection_options)
 
-    api_path = URI.parse(api_url).path
-
-    loginresp = @http_client.request(
-      :expects  => [200],
-      :method   => 'GET',
-      :path     => "#{api_path}/login",
-      :accept   => 'application/vnd.abiquo.user+json'
-      )
-    @enterprise = AbiquoAPIClient::Link.new(loginresp['links'].select {|l| l['rel'] == 'enterprise'}.first)
-    @user = AbiquoAPIClient::LinkModel.new(loginresp.merge({:client => self}))
-
     if options.has_key? :version
       @version = options[:version][0..2]
     else
       @version = @http_client.request(
             :expects  => [200],
             :method   => 'GET',
-            :path     => "#{api_path}/version",
+            :path     => "version",
             :accept   => 'text/plain'
       ).delete("\n")[0..2]
     end
@@ -107,6 +96,21 @@ class AbiquoAPI
     self
   end
 
+  ##
+  # Performs a `login` call to Abiquo to retrieve
+  # user related info
+  #
+  def login
+    loginresp = @http_client.request(
+      :expects  => [200],
+      :method   => 'GET',
+      :path     => "login",
+      :accept   => 'application/vnd.abiquo.user+json'
+      )
+    @enterprise = AbiquoAPIClient::Link.new(loginresp['links'].select {|l| l['rel'] == 'enterprise'}.first)
+    @user = AbiquoAPIClient::LinkModel.new(loginresp.merge({:client => self}))
+  end
+
   ##
   # Loads System properties
   #
@@ -114,7 +118,7 @@ class AbiquoAPI
     @http_client.request(
       :expects  => [200],
       :method   => 'GET',
-      :path     => "#{api_path}/config/properties",
+      :path     => "config/properties",
       :accept   => 'application/vnd.abiquo.systemproperties+json'
     )
   end
@@ -212,7 +216,7 @@ class AbiquoAPI
     req_hash[:content] = "#{ctype}; version=#{@version};" unless ctype.eql? ""
 
     resp = @http_client.request(req_hash)
-    resp.nil? ? nil : AbiquoAPIClient::LinkModel.new({ :client => self}.merge(resp))
+    resp.nil? ? nil : AbiquoAPIClient::LinkModel.new({:client => self}.merge(resp))
   end
 
   ##
@@ -249,7 +253,7 @@ class AbiquoAPI
     req_hash[:content] = "#{ctype}; version=#{@version};" unless ctype.eql? ""
 
     resp = @http_client.request(req_hash)
-    resp.nil? ? nil : AbiquoAPIClient::LinkModel.new({ :client => self}.merge(resp))
+    resp.nil? ? nil : AbiquoAPIClient::LinkModel.new({:client => self}.merge(resp))
   end
 
   ##
@@ -264,12 +268,12 @@ class AbiquoAPI
   # Returns nil
   #
   def delete(link, options = {})
-    @http_client.request(
-      :expects  => [204],
+    resp = @http_client.request(
+      :expects  => [204,202],
       :method   => 'DELETE',
       :path     => link.href,
       :query    => options
     )
-    nil
+    resp.nil? ? nil : AbiquoAPIClient::LinkModel.new({:client => self}.merge(resp))
   end
 end

data/lib/abiquo-api/version.rb

@@ -1,3 +1,3 @@
 module AbiquoAPIClient
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abiquo-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marc Cirauqui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon