almapi 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f2c26aa18fade1372b97275580085b9ad05a60a2f7e73dca141e65f6990045d
-  data.tar.gz: b2e04d2a9f615f33db3c1802dd49894ddaa83397c629b73002080b6642478b48
+  metadata.gz: e2595f89d0085997b7725770d054dcdbd80f56dc3c57fbd3c28a6655f70def3e
+  data.tar.gz: edb1857f61ab8d66c891c7e201e7cd269f3617e193e6aa184d4c341fe167816f
 SHA512:
-  metadata.gz: 285d020a9b515fb8f28c77cc61e921460d60b4ab33d7c19bcdd0a6efb959f57ffbd233276ee6dff4399263e26dffb77a82bcedd2a56849770f2102e649b6ad89
-  data.tar.gz: e7cdb29ad8984185b9c2b846f88afb09196c336f68ed7d35fab7b60f905a1245ab2308d17a1c4875ecd953bc26f808d278f41bd60732e7e9d9838d7d8b889d76
+  metadata.gz: 2c7b704e6e58e721c1ab6c6bb531fd60096c928adca37451e79615352d6b10bcce87bf85464a84e4ba6fcefe03fb99645f52c7fd2cc97e7e73921f0ee88941e2
+  data.tar.gz: 619689dd130c5c710c17278e117f596b2d807652de3cf212bc9e81150b2a190ab3449acf462a501ce3a9efc65a62319968e385f6f6dfa19cede7de550ba20e23

data/README.md

@@ -2,6 +2,8 @@
 
 This gem is used to handle Alma'a API call.
 
+[![Gem Version](https://badge.fury.io/rb/almapi.svg)](https://badge.fury.io/rb/almapi)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/lib/almapi/almapi.rb

@@ -3,98 +3,107 @@
 require 'faraday'
 require 'faraday/follow_redirects'
 # Class Almapi handles Alma's API call
-class Almapi::Api
-  
-  # Reads the key for API calls.
-  #
-  # @return [String] the API key
-  attr_reader :apikey
+module Almapi
+  class Api
+    # Reads the key for API calls.
+    #
+    # @return [String] the API key
+    attr_reader :apikey
 
-  # Reads the URI base for API calls.
-  #
-  # @return [String] the URI base
-  attr_reader :uri_base
+    # Reads the URI base for API calls.
+    #
+    # @return [String] the URI base
+    attr_reader :uri_base
 
-  # Faraday object to handle API calls.
-  #
-  # @return [Object] the Faraday conn object
-  attr_reader :conn
+    # Faraday object to handle API calls.
+    #
+    # @return [Object] the Faraday conn object
+    attr_reader :conn
 
-  # Initializes a new Almapi object and instance
-  # variable @apikey, @uri_base and @conn
-  # that is a Faraday connexion.
-  #
-  # @param apikey : API key to be used in API call
-  # @param uri_base : base URI for API call
-  def initialize(apikey, uri_base)
-    @apikey = apikey
-    @uri_base = uri_base
-    @conn =
-      Faraday.new do |f|
-        f.response :follow_redirects
-      end
-  end
+    # Initializes a new Almapi object and instance
+    # variable @apikey, @uri_base and @conn
+    # that is a Faraday connexion.
+    #
+    # @param apikey : API key to be used in API call
+    # @param uri_base : base URI for API call
+    def initialize(apikey, uri_base)
+      @apikey = apikey
+      @uri_base = uri_base
+      headers = {
+        "Authorization" => "apikey #{@apikey}",
+        "Content-Type" => "application/xml",
+      }
+      @conn =
+        Faraday.new(@uri_base, headers: headers) do |f|
+          f.response :follow_redirects
+        end
+    end
+
+    # Handles a GET request creating the complete URI.
+    # It handles the general case, the case of barcode use for items and
+    # the case of analytics.
+    # If analytics, handles the resumption_token and limit is set to 1000
+    # which is the maximum.
+    #
+    # @param resource [String] mandatory : the part of the URI specifying the access point.
+    #   <b>EXCEPT for analytics and barcode</b>, it must not include "?" for  it adds "?apikey" automatically.
+    #   If analytics, resource must include the report name.
+    #   If barcode, resource must include the barcode value.
+    # @param resumption_token [String] : resumption token for an analytics call.
+    # @return [Response] : the resulting response
+    def get(resource, resumption_token = "")
+      url_api =
+        if resource.include?("analytics") # API call to Analytics entry point
+          "#{@uri_base}{resource}&limit=1000&#{resumption_token}"
+        # elsif resource.include?("barcode") # API call to items entry point with barcode
+        #  "#{@uri_base}#{resource}"
+        else
+          "#{@uri_base}#{resource}" # All other cases
+        end
 
-  # Handles a GET request creating the complete URI.
-  # It handles the general case, the case of barcode use for items and
-  # the case of analytics.
-  # If analytics, handles the resumption_token and limit is set to 1000
-  # which is the maximum.
-  #
-  # @param resource [String] mandatory : the part of the URI specifying the access point.
-  #   <b>EXCEPT for analytics and barcode</b>, it must not include "?" for  it adds "?apikey" automatically.  
-  #   If analytics, resource must include the report name.
-  #   If barcode, resource must include the barcode value.
-  # @param resumption_token [String] : resumption token for an analytics call.
-  # @return [Response] : the resulting response
-  def get(resource, resumption_token = "")
-    url_api =
-      if resource.include?("analytics") # API call to Analytics entry point
-        "#{@uri_base}{resource}&limit=1000&apikey=#{@apikey}&#{resumption_token}"
-      elsif resource.include?("barcode") # API call to items entry point with barcode
-        "#{@uri_base}#{resource}&apikey=#{@apikey}"
-      else
-        "#{@uri_base}#{resource}?apikey=#{@apikey}" # All other cases
-      end
-    
       handle_response(@conn.get(url_api))
+    end
 
-  end
+    # Handles a POST request creating the complete URI.
+    #
+    # @param resource [String] mandatory : the part of the URI specifying the access point.
+    #    Must not include "?" for it adds "?apikey" automatically.
+    # @param data [String] : an XML string containing data to post.
+    # @return [Response] : the resulting response
+    def post(resource, data)
+      url_api = resource.to_s
+      handle_response(@conn.post(url_api, data.to_s))
+    end
 
-  # Handles a POST request creating the complete URI. 
-  #
-  # @param resource [String] mandatory : the part of the URI specifying the access point.
-  #    Must not include "?" for it adds "?apikey" automatically.
-  # @param data [String] : an XML string containing data to post.
-  # @return [Response] : the resulting response
-  def post(resource, data)
-    url_api = "#{resource}?apikey=#{@apikey}"
-    handle_response(@conn.post(url_api, data.to_s, "Content-Type" => 'application/xml'))
-  end
+    # Handles a PUT request creating the complete URI.
+    #
+    # @param resource [String] mandatory : the part of the URI specifying the access point.
+    #    Must not include "?" for it adds "?apikey" automatically.
+    # @param data [String] : an XML string containing data to put.
+    # @return [Response] : the resulting response. If error occurs, raises an AlmapiError
+    def put(resource, data)
+      url_api = resource.to_s
+      puts url_api
+      begin
+        handle_response(@conn.put(url_api, data.to_s, "Content-Type" => "application/xml"))
+      rescue StandardError => e
+        puts e
+      end
+    end
 
-  # Handles a PUT request creating the complete URI.
-  #
-  # @param resource [String] mandatory : the part of the URI specifying the access point.
-  #    Must not include "?" for it adds "?apikey" automatically.
-  # @param data [String] : an XML string containing data to put. 
-  # @return [Response] : the resulting response. If error occurs, raises an AlmapiError
-  def put(resource, data)
-    url_api = "#{resource}?apikey=#{@apikey}"
-    handle_response(@conn.put(url_api, data.to_s, "Content-Type" => 'application/xml'))
-  end
+    # Handles a DELETE request creating the complete URI.
+    #
+    # @param resource [String] mandatory : the part of the URI specifying the access point.
+    #    Must not include "?" for it adds "?apikey" automatically.
+    # @param data [String] : an XML string containing data to put.
+    # @return [Response] : the resulting response. If error occurs, raises an AlmapiError
+    def delete(resource, _data)
+      url_api = resource.to_s
+      handle_response(@conn.delete(url_api))
+    end
 
-  # Handles a DELETE request creating the complete URI. 
-  #
-  # @param resource [String] mandatory : the part of the URI specifying the access point.
-  #    Must not include "?" for it adds "?apikey" automatically.
-  # @param data [String] : an XML string containing data to put.
-  # @return [Response] : the resulting response. If error occurs, raises an AlmapiError
-  def put(resource, data)
-    url_api = "#{resource}?apikey=#{@apikey}"
-    handle_response(@conn.put(url_api, data.to_s, "Content-Type" => 'application/xml'))
-  end  
+    private
 
-  private
     # [Private] handles the response and decides to raise AlmapiError if necessary
     #
     # @param response [Response] mandatory : the response of the API call
@@ -103,11 +112,12 @@ class Almapi::Api
       case response.status
       when 200
         # Success
-        return response
+        response
       else
         # Request has been correctly handled but cannot succeed
-        raise Almapi::AlmapiError.new("AlmapiError : #{response.status} -> #{response.body}")
+        raise Almapi::AlmapiError, "AlmapiError : #{response.status} -> #{response.body}"
+        p @conn
       end
     end
+  end
 end
-

data/lib/almapi/almapi_error.rb

@@ -1,11 +1,15 @@
-# Class AlmapiError handles Alma's API call errors
-class Almapi::AlmapiError < StandardError
-  # Initializes a new AlmapiError object
-  #
-  # @param msg [String] : error message
-  # @param exception_type [String] : exception type. 
-  def initialize(msg="This is an AlmpiError", exception_type="AlmpiError")
-    @exception_type = exception_type
-    super(msg) # Calling initialize in StandardError
-  end
-end
+# frozen_string_literal: true
+
+# Class AlmapiError handles Alma's API call errors
+module Almapi
+  class AlmapiError < StandardError
+    # Initializes a new AlmapiError object
+    #
+    # @param msg [String] : error message
+    # @param exception_type [String] : exception type.
+    def initialize(msg = "This is an AlmpiError", exception_type = "AlmpiError")
+      @exception_type = exception_type
+      super(msg) # Calling initialize in StandardError
+    end
+  end
+end

data/lib/almapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Almapi
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

data/lib/almapi.rb

@@ -7,5 +7,4 @@ require "almapi/almapi"
 # Module Almapi handles Alma's API call and errors
 # @author jszenb
 module Almapi
-
-end
+end

metadata

@@ -1,99 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: almapi
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - jszenb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.63.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.63.2
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.36
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.36
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Gestion des appels à l'API web Alma.