abiquo-api 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96a3226fb37881a259d05429a2f9e45af89c614c
-  data.tar.gz: 692d1dd02caf070b11e79b916dac6186e442e5b4
+  metadata.gz: d3c3049291ec1569f72209a814aff513b14b3133
+  data.tar.gz: b0c28497ca9fb3fa847e3bec9b0a41d1cb6bf949
 SHA512:
-  metadata.gz: 0c9a61c26e512491b40a07f553856e1705bf678047ae2c2f6405ad4fdbd99225fcde3aa0b2a3235bcb6d5615c8053e59021f54a8de1dc922255a7ddad3bea9a5
-  data.tar.gz: a91b9bb302360c91ca442fc0ecf3eb99f930c630c144b8ec55b8baf048766d9a16508cc6d2f1bd46d63965b26aac26705951da1aeb10b2130113491d9767b116
+  metadata.gz: ca26573a649b5e145a6ab34a8ac187b15e4d60b286cdbfe4260c0f765d4f83ae9dfb6f9ecf3057ad2ce74bb77cc9bc0def42efb2e6c5c21a2dbda36c61df7fb7
+  data.tar.gz: e9ea6c2637cf89698d9fd38ab51977b781e4529de0f9131f1a1d1bb02fb3c080b2c3ec134c8c66526e35f3694e338c31ab4b7a040ee011cd39d7962a77d3ef83

data/abiquo-api.gemspec

@@ -17,6 +17,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency "excon", '~> 0.43', '>= 0.43.0'
+  gem.add_runtime_dependency "faraday", '~> 0.9.2', '>= 0.9.2'
+  gem.add_runtime_dependency "faraday_middleware", '~> 0.10.0', '>= 0.10.0'
+  gem.add_runtime_dependency "simple_oauth", '~> 0.3.1', '>= 0.3.1'
+  gem.add_runtime_dependency "addressable", '~> 2.4.0', '>= 2.4.0'
   gem.add_runtime_dependency "formatador", '~> 0.2', '>= 0.2.5'
   gem.add_runtime_dependency "json", '~> 1.8', '>= 1.8.0'
 end

data/lib/abiquo-api.rb

@@ -54,13 +54,32 @@ class AbiquoAPI
     api_url = options[:abiquo_api_url]
     api_username = options[:abiquo_username]
     api_password = options[:abiquo_password]
+    api_key = options[:abiquo_api_key]
+    api_secret = options[:abiquo_api_secret]
+    token_key = options[:abiquo_token_key]
+    token_secret = options[:abiquo_token_secret]
     connection_options = options[:connection_options] || {}
 
-    raise "You need to set :abiquo_api_url, :abiquo_username and :abiquo_password" if api_url.nil? or api_username.nil? or api_password.nil?
+    raise "You need to set :abiquo_api_url" if api_url.nil?
+    raise "You need to provide either basic auth or oauth credentials!!" if (api_username.nil? or api_password.nil?) and 
+          (api_key.nil? or api_secret.nil? or token_key.nil? or token_secret.nil?)
+
+    unless api_key.nil?
+      credentials = {
+        :consumer_key => api_key,
+        :consumer_secret => api_secret,
+        :token => token_key,
+        :token_secret => token_secret
+      }
+    else
+      credentials = {
+        :api_username => api_username,
+        :api_password => api_password
+      }
+    end
 
     @http_client = AbiquoAPIClient::HTTPClient.new(api_url,
-                                                  api_username,
-                                                  api_password,
+                                                  credentials,
                                                   connection_options)
 
     api_path = URI.parse(api_url).path
@@ -150,7 +169,6 @@ class AbiquoAPI
     }
 
     req_hash[:accept] = "#{accept}; version=#{@version};" unless accept.eql? ""
-    
     resp = @http_client.request(req_hash)
 
     if resp['collection'].nil?

data/lib/abiquo-api/collection.rb

@@ -12,7 +12,7 @@ module AbiquoAPIClient
       else
         @type = type
       end
-      
+
       unless parsed_response['links'].empty?
         coluri = URI.parse(parsed_response['links'].first['href'])
         @path = coluri.path
@@ -23,14 +23,17 @@ module AbiquoAPIClient
           @page_size = opt_hash[:limit].to_i
 
           st = opt_hash[:startwith].nil? ? 0 : opt_hash[:startwith].to_i
-          @current_page = (st / @page_size) + 1
+          @current_page = case
+            when @page_size == 0 then st
+            when @page_size  > 0 then (st / @page_size) + 1
+            end
         end
-        
+
         @links = parsed_response['links']
       end
 
       @collection = parsed_response['collection'].map {|r| client.new_object(r)}
-      
+
       @client = client
     end
 
@@ -64,7 +67,7 @@ module AbiquoAPIClient
       out = nil
 
       each {|i| out = i }
-      
+
       out
     end
 
@@ -114,13 +117,13 @@ module AbiquoAPIClient
           @collection = next_page.nil? ? [] : next_page
         end
 
-        loop do 
+        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
@@ -160,10 +163,13 @@ module AbiquoAPIClient
 
       l = AbiquoAPIClient::Link.new(:href => f['href'],
                                     :type => @type)
-      resp = @client.get(l, opts)      
-      
+      resp = @client.get(l, opts)
+
       st = opts[:startwith].nil? ? 0 : opts[:startwith].to_i
-      @current_page = (st / @page_size) + 1
+      @current_page = case
+        when @page_size == 0 then st
+        when @page_size  > 0 then (st / @page_size) + 1
+        end
 
       @links = resp['links']
 

data/lib/abiquo-api/httpclient.rb

@@ -1,5 +1,7 @@
+require 'faraday'
+require 'faraday_middleware'
 require 'excon'
-require 'uri'
+require 'addressable/uri'
 require 'json'
 
 module AbiquoAPIClient
@@ -10,7 +12,7 @@ module AbiquoAPIClient
   #
   class HTTPClient
     ##
-    # Excon connection object.
+    # Faraday connection object.
     #
     attr_reader :connection
 
@@ -26,25 +28,22 @@ module AbiquoAPIClient
     #
     # Parameters:
     #   :abiquo_api_url:: The URL of the Abiquo API. ie. https://yourserver/api
-    #   :abiquo_username:: The username used to connect to the Abiquo API.
-    #   :abiquo_password:: The password for your user.
+    #   :creds:: The credentials used to connect to the Abiquo API (basic auth or oauth).
     #   :connection_options:: { :connect_timeout => <time_in_secs>, :read_timeout => <time_in_secs>, :write_timeout => <time_in_secs>,
     #                           :ssl_verify_peer => <true_or_false>, :ssl_ca_path => <path_to_ca_file> }
     #
-    def initialize(api_url, api_username, api_password, connection_options)
-      Excon.defaults[:ssl_ca_path] = connection_options[:ssl_ca_path] || ''
-      Excon.defaults[:ssl_verify_peer] = connection_options[:ssl_verify_peer] || false
-
-      connect_timeout  = connection_options[:connect_timeout] || 60
-      read_timeout = connection_options[:read_timeout] || 60
-      write_timeout = connection_options[:write_timeout] || 60
-
-      @connection = Excon.new(api_url, 
-                            :user => api_username, 
-                            :password => api_password,
-                            :connect_timeout => connect_timeout,
-                            :read_timeout => read_timeout,
-                            :write_timeout => write_timeout)
+    def initialize(api_url, creds, connection_options)
+      if creds.has_key? :consumer_key
+        @connection = Faraday.new(api_url, connection_options) do |c|
+          c.request :oauth, creds
+          c.adapter :excon
+        end
+      else
+        @connection = Faraday.new(api_url, connection_options ) do |c|
+          c.basic_auth(creds[:api_username], creds[:api_password])
+          c.adapter :excon
+        end
+      end
 
       self
     end
@@ -54,7 +53,7 @@ module AbiquoAPIClient
     #
     # Parameters:
     # [params]   A hash of options to be passed to the 
-    #            Excon connection.
+    #            Faraday connection.
     # 
     # Returns a hash resulting of parsing the response
     # body as JSON, or nil if the response is "No 
@@ -71,17 +70,16 @@ module AbiquoAPIClient
 
       # Set Auth cookie and delete user and password if present
       unless @cookies.nil?
-        @connection.data.delete(:user) unless @connection.data[:user].nil?
-        @connection.data.delete(:password) unless @connection.data[:password].nil?
+        # @connection.data.delete(:user) unless @connection.data[:user].nil?
+        # @connection.data.delete(:password) unless @connection.data[:password].nil?
         headers.merge!(@cookies)
       end
+      if params.has_key? :headers
+        params[:headers].merge!(headers)
+      else
+        params[:headers] = headers
+      end
 
-      params[:headers] = headers
-
-      # Correct API path
-      path = URI.parse(params[:path]).path
-      params[:path] = path
-      
       response = issue_request(params)
       return nil if response.nil?
       
@@ -95,59 +93,63 @@ module AbiquoAPIClient
     private
 
     ##
-    # Issues the HTTP request using the Excon connection
+    # Issues the HTTP request using the Faraday connection
     # object.
     # 
     # Handles API error codes.
     #
-    def issue_request(options)
-      begin
-        options[:headers].merge!(@connection.headers)
-        resp = @connection.request(options)
-
-        # Save cookies
-        # Get all "Set-Cookie" headers and replace them with "Cookie" header.
-        @cookies = Hash[resp.headers.select{|k| k.eql? "Set-Cookie" }.map {|k,v| ["Cookie", v] }]
-
-        if resp.data[:status] == 204
-          nil
-        else
-          resp
+    def issue_request(params)
+      full_path = Addressable::URI.parse(params[:path])
+      if full_path.host.nil?
+        # only path
+        full_url = Addressable::URI.parse(@connection.url_prefix.to_s + '/' + params[:path].gsub(@connection.url_prefix.path, ""))
+      else
+        full_url = Addressable::URI.parse(params[:path])
+      end
+      full_url.query_values = params[:query]
+
+      resp = @connection.run_request(params[:method].downcase.to_sym, 
+                                     full_url.to_s,
+                                     params[:body],
+                                     params[:headers])
+      # Save cookies
+      # Get all "Set-Cookie" headers and replace them with "Cookie" header.
+      @cookies = Hash[resp.headers.select{|k| k.eql? "Set-Cookie" }.map {|k,v| ["Cookie", v] }]
+
+      if resp.status == 204
+        nil
+      elsif resp.status >= 400 and resp.status <= 600
+        unless resp.body.nil?
+          begin
+            error_response = JSON.parse(resp.body)
+            error_code = error_response['collection'][0]['code']
+            error_text = error_response['collection'][0]['message']
+          rescue JSON::ParserError
+            error_code = ''
+            error_text = ''
+          end
         end
-      rescue Excon::Errors::HTTPStatusError => error
-        case error.response.status
+        case resp.status
         when 401
-          raise AbiquoAPIClient::InvalidCredentials, "Wrong username or password"
+          raise AbiquoAPIClient::InvalidCredentials, "Wrong username or password - #{error_code} - #{error_text}"
         when 403
-          raise AbiquoAPIClient::Forbidden, "Not Authorized"
+          raise AbiquoAPIClient::Forbidden, "Not Authorized - #{error_code} - #{error_text}"
         when 406, 400
-          raise AbiquoAPIClient::BadRequest, "Bad request"
+          raise AbiquoAPIClient::BadRequest, "Bad request - #{error_code} - #{error_text}"
         when 415
-          raise AbiquoAPIClient::UnsupportedMediaType, "Unsupported mediatype"
+          raise AbiquoAPIClient::UnsupportedMediaType, "Unsupported mediatype - #{error_code} - #{error_text}"
         when 404
-          begin
-            error_response = JSON.parse(error.response.body)
-
-            error_code = error_response['collection'][0]['code']
-            error_text = error_response['collection'][0]['message']
-
-          rescue
-            raise AbiquoAPIClient::NotFound, "Not Found; #{error_code} - #{error_text}"
-          end
-          raise AbiquoAPIClient::NotFound, "Not Found"
+          raise AbiquoAPIClient::NotFound, "Not Found - #{error_code} - #{error_text}"
         else
-          begin
-            error_response = JSON.parse(error.response.body)
-
-            error_code = error_response['collection'][0]['code']
-            error_text = error_response['collection'][0]['message']
-
-          rescue
-            raise AbiquoAPIClient::Error, error.response.body
+          if error_code == '' and error_text == '' # Error and no json response
+            raise AbiquoAPIClient::Error, "#{resp.body}"
+          else # error with json response
+            raise AbiquoAPIClient::Error, "#{error_code} - #{error_text}"
           end
-          raise AbiquoAPIClient::Error, "#{error_code} - #{error_text}"
-        end
+        end 
+      else
+        resp
       end
     end
   end
-end
+end

data/lib/abiquo-api/version.rb

@@ -1,3 +1,3 @@
 module AbiquoAPIClient
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abiquo-api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Marc Cirauqui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -30,6 +30,86 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.43.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: formatador
   requirement: !ruby/object:Gem::Requirement