abiquo-api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b4167bbf873afc7d296d61698a49b030db6f95
-  data.tar.gz: 862682f6f160d1289679db619cebd07a4fdd65f8
+  metadata.gz: fcac0cebe8eca1e8436a1e201a4fbc5ec3d7e30c
+  data.tar.gz: d7d7b8036b8746c68e72c8d8d83e5e02a119845f
 SHA512:
-  metadata.gz: f1b726b40ba781cef65752029080f30fbdb1df17cedf8c1d6a11809d61d5bec04d312523eabe00fe09eb202d8195e72c3f43089614ee2ab4651e95563b16a279
-  data.tar.gz: ba8daf8ea98f990cffdab92ac583c525d5719e5a7efdc4fc50907d15b8794553beed35efcc72781dd62ab677aa8394b6f932b249a1f24c82d94e60d8e6718ea9
+  metadata.gz: 772ad5ac86fb5cef5a94a6fb4d623da66dc83c5cf4b76e5e8fbbe2db2af1837ceabd83e917250ab8cc0b56f2d06a4bd8e5076d16fe1d367037b62d2256b06521
+  data.tar.gz: 8ec539f19258de9cf0bf4f9be60050956b27265680e46ba228a5793704547cfaaa0de7609d6c2abfd5c63381712216dc51a836b6027d40f5100a6d8446e874d7

data/README.md

@@ -27,7 +27,7 @@ Or, if you want to force a specific API version:
 ```ruby
 require 'abiquo-api'
 
-a = AbiquoAPI.new(:abiquo_api_url => 'https://10.60.13.40/api', 
+abq = AbiquoAPI.new(:abiquo_api_url => 'https://10.60.13.40/api', 
                   :abiquo_username => "admin", 
                   :abiquo_password => "xabiquo",
                   :version => "2.9")
@@ -37,9 +37,10 @@ Then you can start browsing the API:
 
 ```ruby
 l = AbiquoAPI::Link.new(:href => '/api/cloud/virtualdatacenters', 
-              :type => 'application/vnd.abiquo.virtualdatacenters+json')
+              :type => 'application/vnd.abiquo.virtualdatacenters+json',
+              :client => abq)
 
-a.get(l)
+l.get
 ```
 
 ## Client object
@@ -62,6 +63,10 @@ vapp = vdc.link(:virtualappliances).get.first
 
 This is used to map Abiquo API objects.
 
+## Generic list
+
+This is used to iterate over paginated lists. 
+
 ## Examples
 
 ### Browse the API

data/lib/abiquo-api.rb

@@ -1,7 +1,8 @@
-require 'abiquo-api/errors.rb'
-require 'abiquo-api/httpclient.rb'
-require 'abiquo-api/link.rb'
-require 'abiquo-api/model.rb'
+require 'abiquo-api/collection'
+require 'abiquo-api/errors'
+require 'abiquo-api/httpclient'
+require 'abiquo-api/link'
+require 'abiquo-api/model'
 
 ##
 # Ruby Abiquo API client main class
@@ -27,11 +28,6 @@ class AbiquoAPI
   #
   attr_accessor :user
 
-  ##
-  # The config properties for the UI.
-  #
-  attr_accessor :properties
-
   ##
   # The Abiquo API version used by this client.
   #
@@ -69,13 +65,6 @@ class AbiquoAPI
     @enterprise = AbiquoAPIClient::Link.new(loginresp['links'].select {|l| l['rel'] == 'enterprise'}.first)
     @user = AbiquoAPIClient::LinkModel.new(loginresp.merge({:client => self}))
 
-    @properties = @http_client.request(
-      :expects  => [200],
-      :method   => 'GET',
-      :path     => "#{api_path}/config/properties",
-      :accept   => 'application/vnd.abiquo.systemproperties+json'
-      )
-
     if options.has_key? :version
       @version = options[:version][0..2]
     else
@@ -89,6 +78,18 @@ class AbiquoAPI
 
     self
   end
+
+  ##
+  # Loads System properties
+  #
+  def properties
+    @http_client.request(
+      :expects  => [200],
+      :method   => 'GET',
+      :path     => "#{api_path}/config/properties",
+      :accept   => 'application/vnd.abiquo.systemproperties+json'
+    )
+  end
   
   ##
   # Returns a new instance of the {AbiquoAPIClient::LinkModel} class.
@@ -100,6 +101,18 @@ class AbiquoAPI
     AbiquoAPIClient::LinkModel.new(hash.merge({ :client => self}))
   end
 
+  ##
+  # Returns a new instance of the {AbiquoAPIClient::LinkCollection} 
+  # class.
+  # 
+  # Parameters:
+  #   An instance of {AbiquoAPIClient::Link} pointing to the URL of 
+  #   the collection.
+  #
+  def list(link, options = {})
+    AbiquoAPI::LinkCollection.new(self.get(link, options), link.type, self)
+  end
+
   ##
   # Executes an HTTP GET over the {AbiquoAPIClient::Link} passed as parameter.
   # 
@@ -131,15 +144,10 @@ class AbiquoAPI
     
     resp = @http_client.request(req_hash)
 
-    if resp.is_a? Array
-      tmp_a = []
-      resp.each do |r|
-        tmp_r = AbiquoAPIClient::LinkModel.new(r.merge({:client => self}))
-        tmp_a << tmp_r
-      end
-      tmp_a
-    else
+    if resp['collection'].nil?
       AbiquoAPIClient::LinkModel.new(resp.merge({ :client => self}))
+    else
+      resp
     end
   end
 

data/lib/abiquo-api/collection.rb

@@ -0,0 +1,173 @@
+require 'formatador'
+
+module AbiquoAPIClient
+  ##
+  # Represents a collection of resources in the Abiquo API.
+  #
+  class LinkCollection
+    def initialize(parsed_response, type, client)
+      @size = parsed_response['totalSize'].nil? ? parsed_response['collection'].count : parsed_response['totalSize']
+      if type.include? ";"
+        @type = type.split(';').first
+      else
+        @type = type
+      end
+      
+      unless parsed_response['links'].empty?
+        coluri = URI.parse(parsed_response['links'].first['href'])
+        @path = coluri.path
+
+        opts = coluri.query
+        unless opts.nil?
+          opt_hash = opts.split("&").map{|e| { e.split("=").first.to_sym => e.split("=").last }}.reduce({}) {|h,pairs| pairs.each {|k,v| h[k] ||= v}; h}
+          @page_size = opt_hash[:limit].to_i
+
+          st = opt_hash[:startwith].nil? ? 0 : opt_hash[:startwith].to_i
+          @current_page = (st / @page_size) + 1
+        end
+        
+        @links = parsed_response['links']
+      end
+
+      @collection = parsed_response['collection'].map {|r| client.new_object(r)}
+      
+      @client = client
+    end
+
+    ##
+    # Returns the total size of the collection
+    #
+    def size
+      @size
+    end
+    alias count size
+
+    ##
+    # Returns the first element in the collection
+    #
+    def first(count = nil)
+      if count.nil?
+        @collection.first
+      else
+        out = []
+        @collection.first(count).each do |item|
+          out << item
+        end
+        out
+      end
+    end
+
+    ##
+    # Returns the last element in the collection
+    #
+    def last
+      out = nil
+
+      each {|i| out = i }
+      
+      out
+    end
+
+    ##
+    # Returns an array representing the collection
+    #
+    def to_a
+      out = []
+
+      each { |e| out << e }
+
+      out
+    end
+
+    ##
+    # Selects elements of the collections for which
+    # the supplied block evaluates to true
+    #
+    def select
+      out = []
+
+      each { |e| out << e if yield(e) }
+
+      out
+    end
+
+    ##
+    # Returns an array resulting of applying the provided
+    # block to all of the elements of the collection
+    #
+    def map
+      out = []
+
+      each { |e| out << yield(e) }
+
+      out
+    end
+    alias collect map
+
+    ##
+    # Iterates the collection
+    #
+    def each
+      if block_given?
+        unless @current_page == 1 or @current_page.nil?
+          next_page = retrieve('first')
+          @collection = next_page.nil? ? [] : next_page
+        end
+
+        loop do 
+          @collection.each do |item|
+            yield item
+          end
+      
+          break if @links.nil? or @links.select {|l| l['rel'].eql? "next" }.first.nil?
+          
+          next_page = retrieve('next')
+          @collection = next_page.nil? ? [] : next_page
+        end
+      else
+        self.to_enum
+      end
+    end
+
+    ##
+    # Pretty print the object.
+    #
+    def inspect
+      Thread.current[:formatador] ||= Formatador.new
+      data = "#{Thread.current[:formatador].indentation}<#{self.class.name}"
+      Thread.current[:formatador].indent do
+        unless self.instance_variables.empty?
+          vars = self.instance_variables.clone
+          vars.delete(:@client)
+          vars.delete(:@page)
+          data << " "
+          data << vars.map { |v| "#{v}=#{instance_variable_get(v.to_s).inspect}" }.join(", ")
+        end
+      end
+      data << " >"
+      data
+    end
+
+    private
+
+    def retrieve(rel)
+      return nil if @links.nil?
+      f = @links.select {|l| l['rel'].eql? rel }.first
+      return nil if f.nil?
+
+      q = URI.parse(f['href']).query.split('&').map {|it| it.split('=') }
+      opts = Hash[q.map{ |k, v| [k.to_sym, v] }]
+
+      l = AbiquoAPIClient::Link.new(:href => f['href'],
+                                    :type => @type)
+      resp = @client.get(l, opts)      
+      
+      st = opts[:startwith].nil? ? 0 : opts[:startwith].to_i
+      @current_page = (st / @page_size) + 1
+
+      @links = resp['links']
+
+      resp['collection'].map {|e| @client.new_object(e) }
+    end
+  end
+end

data/lib/abiquo-api/httpclient.rb

@@ -76,33 +76,6 @@ module AbiquoAPIClient
       rescue
         response = response.body
       end
-
-      # Handle pagination
-      if not response['links'].nil? and response['links'].select {|l| l['rel'].eql? "next" }.count > 0
-        items = []
-        items = items + response['collection'] if not response['collection'].nil?
-        
-        loop do
-          next_url = response['links'].select {|l| l['rel'].eql? "next" }.first['href']
-          uri = URI.parse(next_url)
-          params[:path] = uri.path
-          params[:query] = uri.query
-          params[:headers] = headers
-          response = issue_request(params)
-          response = JSON.parse(response.body) unless response.body.empty?
-          items = items + response['collection'] if not response['collection'].nil?
-          
-          break if response['links'].select {|l| l['rel'].eql? "next" }.count == 0
-        end
-
-        items
-      else
-        if not response['collection'].nil?
-          response['collection']
-        else
-          response.nil? ? nil : response
-        end
-      end
     end
 
     private

data/lib/abiquo-api/link.rb

@@ -45,13 +45,19 @@ module AbiquoAPIClient
 
     ##
     # If the :client attribute is not nil, will retrieve
-    # the resource that this link represents, or nil otherwise
+    # the resource or collection that this link represents,
+    # or nil otherwise
     #
     def get(options = {})
       if @client.nil?
         return nil
       else
-        @client.get(self, options)
+        r = @client.get(self, options)
+        if r.is_a? Hash
+          AbiquoAPI::LinkCollection.new(r, self.type, @client)
+        else
+          r
+        end
       end
     end
 

data/lib/abiquo-api/model.rb

@@ -101,17 +101,32 @@ module AbiquoAPIClient
     end
 
     ##
-    # Retrieves the link that has the 'rel' attribute specified
-    # as parameter.
+    # Returns an array of {AbiquoAPI::Link} for the resource
+    #
+    def links
+      self.links.map {|l| l.values }.flatten
+    end
+
+    ##
+    # Retrieves the link or links that hve the 'rel' attribute 
+    # specified as parameter.
     #
     # Parameters:
     # [link_rel]  The 'rel' value to look for, symbolized.
     #
-    # Returns the first link found with the 'rel' attribute 
+    # Returns the link the 'rel' attribute 
     # specified or nil if not found.
     #
     def link(link_rel)
-      self.links.select {|l| l[link_rel] }.first[link_rel]
+      ls = self.links.select {|l| l[link_rel] }.map { |t| t.values }.flatten
+      case ls.count
+      when 1
+        ls.first
+      when 0
+        nil
+      else
+        ls
+      end
     end
 
     ##

data/lib/abiquo-api/version.rb

@@ -1,3 +1,3 @@
 module AbiquoAPIClient
-  VERSION = '0.0.3'
-end
+  VERSION = '0.0.4'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abiquo-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Marc Cirauqui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -82,6 +82,7 @@ files:
 - README.md
 - abiquo-api.gemspec
 - lib/abiquo-api.rb
+- lib/abiquo-api/collection.rb
 - lib/abiquo-api/errors.rb
 - lib/abiquo-api/httpclient.rb
 - lib/abiquo-api/link.rb
@@ -111,3 +112,4 @@ signing_key:
 specification_version: 4
 summary: Simple Abiquo API client
 test_files: []
+has_rdoc: