firmenwissen 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b79d5acc8cdbc3936a046219302466d3fb782668787787dae2116f39c9bfa0c
-  data.tar.gz: 01d7fcf4001c1a13308819d248ec8752a746f9451d0fbbdc025e742ee0233aa7
+  metadata.gz: 42e291ddf7bad7c2089c96877b831d5ab022482cd002018ded618e3a82be2f5a
+  data.tar.gz: 3448ce23abb5250d597f99c8fba7617ab98b7a2c51ca28df0b5f1778f239a4d7
 SHA512:
-  metadata.gz: 9a9075c20026a58be30af77fd1df06596eff00a60970ea83d060ecfa73ef938c0a7d0e165785ab6ded7e99f894494936770a8bbfe833325469ce2a2e4c33697b
-  data.tar.gz: af6eee45a08cd89d9f5cd3b085977bd6eeabb150e87d4e36a2a1ac01a98285530758cbbdfdb107855e9ed2b407a33d36802ced4701f82caa9c433d860c5efa90
+  metadata.gz: 9ba9040ccff5e27f74c7329e32e1e40e0fb4ef7a394ceb9afca0db95f91928928ef1d7839ebecbc51d7a40c4cec1187e97d1ad8a4a8bfd6a49134e07e1593067
+  data.tar.gz: 58478133681a39f6c479a981463351e88a019d197b5989ed89d55b9ad20364a7ed450cdda012d56a70ada0e845ce8ae7d4851f3cad96c0721ca9fe6c037c401c

data/README.md

@@ -45,9 +45,10 @@ suggestion.address # => 'Louise-Dumon-Straße 5'
 
 suggestion.to_h # => { crefo_id: '1234567890', name: 'COMPEON GmbH', ... }
 ```
-### Configuration
+### Basic Auth Configuration
 ```ruby
 Firmenwissen.configure do |config|
+  config.authentication_strategy = 'basic' # This is set to 'basic' by default, eliminating the need for explicit configuration.
   config.user     = 'username'      # Username for Firmenwissen basic auth (required)
   config.password = 'password'      # Password for Firmenwissen basic auth (required)
   config.timeout  = 5               # Request timeout in seconds
@@ -57,6 +58,19 @@ Firmenwissen.configure do |config|
   config.endpoint = 'https://example.com/search?query={query}'
 end
 ```
+### Api Key Configuration
+```ruby
+Firmenwissen.configure do |config|
+  config.authentication_strategy = 'api_key' # Mandatory for all options except 'basic' (required)
+  config.api_key  = 'your api key'  # API Key for Firmenwissen API Key authentication (required)
+  config.timeout  = 5               # Request timeout in seconds
+  config.persistent_session = false # Whether to store/use session information for subsequent requests
+
+  # Configure the endpoint yourself. %s will be replaced by the actual query
+  config.endpoint = 'https://example.com/search?query={query}'
+end
+```
+
 ### Mocking results
 In a non production-like environment you will not want to perform real requests to the API. Thus you can configure the gem to respond with mocked data.
 

data/lib/firmenwissen/configuration.rb

@@ -10,14 +10,15 @@ module Firmenwissen
       end
     end
 
-    SETTINGS = %i[endpoint password mock_data mock_requests persistent_session timeout user]
+    SETTINGS = %i[endpoint password mock_data mock_requests persistent_session timeout user authentication_strategy api_key]
 
     DEFAULT_SETTINGS = {
       endpoint: 'https://www.firmenwissen.de/search/suggest/companywithaddress/{query}{?country}',
       mock_requests: false,
       mock_data: [],
       persistent_session: false,
-      timeout: 5
+      timeout: 5,
+      authentication_strategy: "basic"
     }.freeze
 
     SETTINGS.each do |setting|
@@ -51,5 +52,9 @@ module Firmenwissen
     def persistent_session?
       persistent_session
     end
+
+    def api_key_present?
+      api_key.is_a?(String) && !api_key.empty?
+    end
   end
 end

data/lib/firmenwissen/errors/api_key_error.rb

@@ -0,0 +1,7 @@
+module Firmenwissen
+  class ApiKeyError < StandardError
+    def initialize(message = 'Firmenwissen API Key is missing')
+      super
+    end
+  end
+end

data/lib/firmenwissen/errors/authentication_strategy_error.rb

@@ -0,0 +1,7 @@
+module Firmenwissen
+  class AuthenticationStrategyError < StandardError
+    def initialize(message = 'Invalid authentication strategy')
+      super
+    end
+  end
+end

data/lib/firmenwissen/http_request.rb

@@ -21,7 +21,8 @@ module Firmenwissen
     def request
       @request ||= begin
         Net::HTTP::Get.new(uri).tap do |req|
-          req.basic_auth(config.user, config.password)
+          req.basic_auth(config.user, config.password) if config.authentication_strategy == "basic"
+          req.add_field('API-KEY', config.api_key) if config.authentication_strategy == "api_key"
           req.add_field('Cookie', session_cookie) if config.persistent_session? && !session_cookie.empty?
         end
       end

data/lib/firmenwissen/request/base.rb

@@ -6,7 +6,14 @@ module Firmenwissen
         @options = options
         @params = options.fetch(:params, {})
 
-        raise CredentialsError unless config.credentials_present?
+        case config.authentication_strategy
+        when "basic"
+          raise CredentialsError unless config.credentials_present?
+        when "api_key"
+          raise ApiKeyError unless config.api_key_present?
+        else
+          raise AuthenticationStrategyError
+        end
       end
 
       def execute

data/lib/firmenwissen/uri_decorator.rb

@@ -1,3 +1,5 @@
+require 'delegate'
+
 class URIDecorator < SimpleDelegator
   def port
     inferred_port

data/lib/firmenwissen/version.rb

@@ -1,3 +1,3 @@
 module Firmenwissen
-  VERSION = '1.1.0'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firmenwissen
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Gerrit Seger
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - gerrit.seger@gmail.com
 executables: []
@@ -106,6 +120,8 @@ files:
 - Rakefile
 - lib/firmenwissen.rb
 - lib/firmenwissen/configuration.rb
+- lib/firmenwissen/errors/api_key_error.rb
+- lib/firmenwissen/errors/authentication_strategy_error.rb
 - lib/firmenwissen/errors/credentials_error.rb
 - lib/firmenwissen/errors/unprocessable_response_error.rb
 - lib/firmenwissen/http_request.rb
@@ -119,11 +135,11 @@ files:
 - lib/firmenwissen/suggestion.rb
 - lib/firmenwissen/uri_decorator.rb
 - lib/firmenwissen/version.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Ruby client for the FirmenWissen API
 test_files: []