lmb-developers 1.2.7 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e64458ffec1b4d3c2bd34a026a8152dc28f3b19d063602d926e2120a0fc44c15
-  data.tar.gz: 916703f62987d556140d27606fe006e4acce6d39a66006dd9b20f1ed1f7c03fe
+  metadata.gz: 905ee8df8f98770914ccd0ccb57b189bfa4ac88bc1c6a2442030322199e86c59
+  data.tar.gz: c0997d3bf1170b44ded8402ca6fc1ce5deb7b11ffdb12863697c8b69ff677035
 SHA512:
-  metadata.gz: 876277b942a54431d5573fb9a0dd396be90a4fec5e8cfb7e3364f4f69bb44bfd59108fd161333cfbf5601f9d97cd901d0dd66c65152f0c91919ddb1eb3206842
-  data.tar.gz: eebd7d1d7fa5839b2f62a8d839d981a0fbe2f1fb065f812a2fd9180a7642f76ded5abfc019c724bf98c752fdfd222bb3cf8b2020f481cd57b1d48f9fd05b36c0
+  metadata.gz: b013245670313eb06f8783c050fbd6fbdc7f368a469b67add904d53196c2faeb3219e965fd85db75a5db449532686d0c18e6ca4e5d1e28a08340b7a1aaa21399
+  data.tar.gz: ff968a11436f26bd82a86785abf8596aec91e2dc8d4b589f73b77d8283ddca4a807fb7448f7106b899f233e099db5a8726a9800a36ad86a55c6156fa64fa6d3c

data/lib/lmb/developers/configuration.rb

@@ -2,6 +2,8 @@ module Lmb
     module Developers
       class Configuration
         attr_accessor :api_key,
+                      :username,
+                      :password
                       :environment
         attr_reader :url
         
@@ -22,11 +24,15 @@ module Lmb
         end
         # Configure global parameters
         #
-        # @param environment [String] environment to consume APIs, `TEST` or `PROD`
+        # @param environment [String] environment to consume APIs, `DEV`, `TEST` or `PROD`
         # @param api_key [String] ApiKey to consume APIs.
+        # @param username [String] Username to consume APIs.
+        # @param password [String] Password to consume APIs.
         # @return [Lmb::Developers::Configuration]
-        def configure(environment = 'DEV', api_key)
+        def configure(environment = 'DEV', api_key = 'api_key', username = 'username', password = 'password')
             @api_key = api_key
+            @username = username
+            @password = password
             @environment = environment
             @url = @config[environment][:url]
             self

data/lib/lmb/developers/loyalty.rb

@@ -1,100 +1,83 @@
+require 'base64'
+
 module Lmb
   module Developers
     class Loyalty
       attr_reader :configuration
 
-      # Paths to methods
+      # Define constant paths for different API endpoints.
       VOUCHER_EXPIRED_PATH = '/v1/loyalty/voucher/expired'.freeze
       VOUCHER_PROVISIONED_PATH = '/v1/loyalty/voucher/provisioned'.freeze
       VOUCHER_ACTIVATED_PATH = '/v1/loyalty/voucher/activated'.freeze
       SCORING_REDEMPTION_PATH = '/v1/loyalty/redemption'.freeze
 
-      # Set Inhabitant's Expired Vouchers.
+      # Set expired vouchers for inhabitants.
       #
-      # @param expirations [Hash] the expriations object.
-      # @return [Boolean]
+      # @param expirations [Hash] the expirations object.
+      # @return [Boolean] returns true if response code is 202, false otherwise.
       def self.voucher_expired(expirations)
-        uri = URI.parse("#{configuration.url}#{VOUCHER_EXPIRED_PATH}")
-        request = Net::HTTP::Post.new(uri)
-        request['Apikey'] = configuration.api_key.to_s
-        request['Cache-Control'] = 'no-cache'
-        request.body = JSON.dump(
-          'expirations' => expirations
-        )
-        req_options = {
-          use_ssl: uri.scheme == 'https'
-        }
-        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-          http.request(request)
-        end
-        response.code.to_i == 202
-      rescue StandardError => exception
-        exception
+        post_request(VOUCHER_EXPIRED_PATH, 'expirations' => expirations)
       end
 
-      # Set Inhabitant's Provisioned Vouchers.
+      # Set provisioned vouchers for inhabitants.
       #
-      # @param expirations [Hash] the provisions object.
-      # @return [Boolean]
+      # @param provisions [Hash] the provisions object.
+      # @return [Boolean] returns true if response code is 202, false otherwise.
       def self.voucher_provisioned(provisions)
-        uri = URI.parse("#{configuration.url}#{VOUCHER_PROVISIONED_PATH}")
-        request = Net::HTTP::Post.new(uri)
-        request['Apikey'] = configuration.api_key.to_s
-        request['Cache-Control'] = 'no-cache'
-        request.body = JSON.dump(
-          'provisions' => provisions
-        )
-        req_options = {
-          use_ssl: uri.scheme == 'https'
-        }
-        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-          http.request(request)
-        end
-        response.code.to_i == 202
-      rescue StandardError => exception
-        exception
+        post_request(VOUCHER_PROVISIONED_PATH, 'provisions' => provisions)
       end
 
-      # Set Inhabitant's Activated Vouchers.
+      # Set activated vouchers for inhabitants.
       #
-      # @param expirations [Hash] the activations object.
-      # @return [Boolean]
+      # @param activations [Hash] the activations object.
+      # @return [Boolean] returns true if response code is 202, false otherwise.
       def self.voucher_activated(activations)
-        uri = URI.parse("#{configuration.url}#{VOUCHER_ACTIVATED_PATH}")
-        request = Net::HTTP::Post.new(uri)
-        request['Apikey'] = configuration.api_key.to_s
-        request['Cache-Control'] = 'no-cache'
-        request.body = JSON.dump(
-          'activations' => activations
-        )
-        req_options = {
-          use_ssl: uri.scheme == 'https'
-        }
-        response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-          http.request(request)
-        end
-        response.code.to_i == 202
-      rescue StandardError => exception
-        exception
+        post_request(VOUCHER_ACTIVATED_PATH, 'activations' => activations)
+      end
+
+      # Handles the redemption process.
+      #
+      # @param redemptions [Hash] the redemptions object.
+      # @return [Boolean] returns true if response code is 202, false otherwise.
+      def self.redemption(redemptions)
+        post_request(SCORING_REDEMPTION_PATH, redemptions)
+      end
+
+      private
+
+      # Generate Basic Authorization header from configuration's username and password.
+      #
+      # @return [String] returns the Authorization header string.
+      def self.generate_basic_auth
+        base64_encoded_credentials = Base64.encode64("#{configuration.username.to_s}:#{configuration.password.to_s}").strip
+        "Basic #{base64_encoded_credentials}"
       end
 
-      # Get configuration.
+      # Fetch the configuration for the API.
+      #
+      # @return [Object] returns the configuration object.
       def self.configuration
-        @configuration = Lmb::Developers.configuration
+        @configuration ||= Lmb::Developers.configuration
       end
 
-      def self.redemption(redemptions)
-        uri = URI.parse("#{configuration.url}#{SCORING_REDEMPTION_PATH}")
+      # Makes a POST request to a given endpoint with provided body.
+      #
+      # @param endpoint [String] the API endpoint.
+      # @param body [Hash] the request body.
+      # @return [Boolean] returns true if response code is 202, false otherwise.
+      def self.post_request(endpoint, body)
+        uri = URI.parse("#{configuration.url}#{endpoint}")
         request = Net::HTTP::Post.new(uri)
         request['Apikey'] = configuration.api_key.to_s
+        request['Authorization'] = generate_basic_auth
         request['Cache-Control'] = 'no-cache'
-        request.body = redemptions.to_json
-        req_options = {
-          use_ssl: uri.scheme == 'https'
-        }
+        request.body = body.to_json
+        req_options = { use_ssl: uri.scheme == 'https' }
+
         response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
           http.request(request)
         end
+
         response.code.to_i == 202
       rescue StandardError => exception
         exception

data/lib/lmb/developers.rb

@@ -11,11 +11,13 @@ module Lmb
             
             # Configure global parameters
             #
-            # @param environment [String] environment to consume APIs, `TEST` or `PROD`
+            # @param environment [String] environment to consume APIs, `DEV`, `TEST` or `PROD`
             # @param api_key [String] ApiKey to consume APIs.
+            # @param username [String] Username to consume APIs.
+            # @param password [String] Password to consume APIs.
             # @return [Lmb::Developers::Configuration]
-            def configure(environment, api_key)
-                configuration.configure(environment, api_key)
+            def configure(environment = "DEV", api_key = "apikey", username = "username", password = "password")
+                configuration.configure(environment, api_key, username, password)
             end
             
             # Instace or return global configuration

data/lmb-developers.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
     s.name        = 'lmb-developers'
-    s.version     = '1.2.7'
-    s.date        = '2019-05-19'
+    s.version     = '1.3.0'
+    s.date        = '2023-09-25'
     s.summary     = "Consume APIs at Leroy Merlin Brazil Developer's Portal"
     s.description = "Gem to consume APIs available at Leroy Merlin Brazil Developer's Portal https://developers.leroymerlin.com.br"
     s.author      = "PRTE - Tecnologia e Soluções"
@@ -9,6 +9,6 @@ Gem::Specification.new do |s|
     s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
     s.require_paths = ['lib']
     s.homepage    =
-      'https://github.com/somosprte/lmb-developers'
+      'https://github.com/adeo/brlm-loyalty-developers-gem'
     s.license       = 'MIT'
   end

data/product-info.json

@@ -0,0 +1,5 @@
+{
+
+    "tangram_id": "d0365f9c-d399-453e-867b-084eea99a10a"
+
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lmb-developers
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.3.0
 platform: ruby
 authors:
 - PRTE - Tecnologia e Soluções
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-19 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies: []
 description: Gem to consume APIs available at Leroy Merlin Brazil Developer's Portal
   https://developers.leroymerlin.com.br
@@ -29,7 +29,8 @@ files:
 - lib/lmb/developers/error.rb
 - lib/lmb/developers/loyalty.rb
 - lmb-developers.gemspec
-homepage: https://github.com/somosprte/lmb-developers
+- product-info.json
+homepage: https://github.com/adeo/brlm-loyalty-developers-gem
 licenses:
 - MIT
 metadata: {}
@@ -48,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Consume APIs at Leroy Merlin Brazil Developer's Portal