firmenwissen 1.0.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6499228c4827e93416dd1c35718fb4ecd483c67e5ef14f1bd35be6596a6b8acd
-  data.tar.gz: 990c0a68b091c84e7d7046ee8606705c01ab8c67753afac1809621f2a94ba794
+  metadata.gz: 42e291ddf7bad7c2089c96877b831d5ab022482cd002018ded618e3a82be2f5a
+  data.tar.gz: 3448ce23abb5250d597f99c8fba7617ab98b7a2c51ca28df0b5f1778f239a4d7
 SHA512:
-  metadata.gz: f242d64753d4dd251562c8550b5e7b0547579acb8d53f338d42fa6e42ad5d48655d607925e3bcfb855b9c9d15f02e7b59ca09f24eb295b0e1fc63edfe0be3c9a
-  data.tar.gz: 55c3ca5f9fed873de5570fb0e80e70bee788bbbdf5e88372d365380ab67bca61af6d561a7513237aa6300f8043c7b312454024be16c74e3181dd46fdc18e6cf4
+  metadata.gz: 9ba9040ccff5e27f74c7329e32e1e40e0fb4ef7a394ceb9afca0db95f91928928ef1d7839ebecbc51d7a40c4cec1187e97d1ad8a4a8bfd6a49134e07e1593067
+  data.tar.gz: 58478133681a39f6c479a981463351e88a019d197b5989ed89d55b9ad20364a7ed450cdda012d56a70ada0e845ce8ae7d4851f3cad96c0721ca9fe6c037c401c

data/README.md

@@ -45,17 +45,32 @@ 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.user     = 'username'     # Username for Firmenwissen basic auth (required)
-  config.password = 'password'     # Password for Firmenwissen basic auth (required)
-  config.timeout  = 5              # Request timeout in seconds
+  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
+  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
 ```
+### 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.
 
@@ -93,5 +108,8 @@ end
 ```
 **Note:** All configuration options can be overridden on a per-request basis by passing an options hash to the `search` method.
 
+### On sessions
+Session information is stored globally and used for _all_ subsequent requests made via the Firmenwissen gem if `persistent_session` is active.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/firmenwissen/configuration.rb

@@ -10,13 +10,15 @@ module Firmenwissen
       end
     end
 
-    SETTINGS = %i[endpoint password mock_data mock_requests 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: [],
-      timeout: 5
+      persistent_session: false,
+      timeout: 5,
+      authentication_strategy: "basic"
     }.freeze
 
     SETTINGS.each do |setting|
@@ -46,5 +48,13 @@ module Firmenwissen
     def mock_requests?
       mock_requests
     end
+
+    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

@@ -8,7 +8,7 @@ module Firmenwissen
     def execute
       http = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.use_ssl?)
       http.read_timeout = config.timeout
-      http.request(request)
+      http.request(request, &method(:extract_session))
     ensure
       http.finish
       http
@@ -21,7 +21,9 @@ 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
     end
@@ -29,5 +31,15 @@ module Firmenwissen
     def config
       @config ||= Firmenwissen.configuration.merge(options)
     end
+
+    def extract_session(response)
+      return unless config.persistent_session?
+
+      Firmenwissen::Session.update_from_set_cookie_headers(response.get_fields('Set-Cookie'))
+    end
+
+    def session_cookie
+      @session_cookie ||= Firmenwissen::Session.to_cookie_string
+    end
   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/session.rb

@@ -0,0 +1,26 @@
+module Firmenwissen
+  module Session
+    module_function
+
+    def cookies
+      @cookies ||= {}
+    end
+
+    def update_from_set_cookie_headers(set_cookie_headers)
+      return if set_cookie_headers.nil?
+
+      set_cookie_headers.each do |header|
+        name_and_value, _other_attrs = header.split(/;\s?/)
+        name, value = name_and_value.split('=', 2)
+
+        next if name.empty? || value.nil? || value.empty?
+
+        cookies[name] = value
+      end
+    end
+
+    def to_cookie_string
+      cookies.map { |entry| [entry].join('=') }.join('; ')
+    end
+  end
+end

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.0.3'
+  VERSION = '1.2.1'
 end

data/lib/firmenwissen.rb

@@ -6,6 +6,7 @@ require 'firmenwissen/configuration'
 require 'firmenwissen/http_request'
 require 'firmenwissen/key_mapper'
 require 'firmenwissen/request'
+require 'firmenwissen/session'
 require 'firmenwissen/suggestion'
 require 'firmenwissen/uri_decorator'
 require 'firmenwissen/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firmenwissen
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.1
 platform: ruby
 authors:
 - Gerrit Seger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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
@@ -92,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
@@ -101,6 +131,7 @@ files:
 - lib/firmenwissen/request/mock.rb
 - lib/firmenwissen/response/base.rb
 - lib/firmenwissen/response/mock.rb
+- lib/firmenwissen/session.rb
 - lib/firmenwissen/suggestion.rb
 - lib/firmenwissen/uri_decorator.rb
 - lib/firmenwissen/version.rb
@@ -123,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby client for the FirmenWissen API