firmenwissen 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6499228c4827e93416dd1c35718fb4ecd483c67e5ef14f1bd35be6596a6b8acd
-  data.tar.gz: 990c0a68b091c84e7d7046ee8606705c01ab8c67753afac1809621f2a94ba794
+  metadata.gz: 4b79d5acc8cdbc3936a046219302466d3fb782668787787dae2116f39c9bfa0c
+  data.tar.gz: 01d7fcf4001c1a13308819d248ec8752a746f9451d0fbbdc025e742ee0233aa7
 SHA512:
-  metadata.gz: f242d64753d4dd251562c8550b5e7b0547579acb8d53f338d42fa6e42ad5d48655d607925e3bcfb855b9c9d15f02e7b59ca09f24eb295b0e1fc63edfe0be3c9a
-  data.tar.gz: 55c3ca5f9fed873de5570fb0e80e70bee788bbbdf5e88372d365380ab67bca61af6d561a7513237aa6300f8043c7b312454024be16c74e3181dd46fdc18e6cf4
+  metadata.gz: 9a9075c20026a58be30af77fd1df06596eff00a60970ea83d060ecfa73ef938c0a7d0e165785ab6ded7e99f894494936770a8bbfe833325469ce2a2e4c33697b
+  data.tar.gz: af6eee45a08cd89d9f5cd3b085977bd6eeabb150e87d4e36a2a1ac01a98285530758cbbdfdb107855e9ed2b407a33d36802ced4701f82caa9c433d860c5efa90

data/README.md

@@ -48,9 +48,10 @@ suggestion.to_h # => { crefo_id: '1234567890', name: 'COMPEON GmbH', ... }
 ### 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.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}'
@@ -93,5 +94,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.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'

data/lib/firmenwissen/configuration.rb

@@ -10,12 +10,13 @@ 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]
 
     DEFAULT_SETTINGS = {
       endpoint: 'https://www.firmenwissen.de/search/suggest/companywithaddress/{query}{?country}',
       mock_requests: false,
       mock_data: [],
+      persistent_session: false,
       timeout: 5
     }.freeze
 
@@ -46,5 +47,9 @@ module Firmenwissen
     def mock_requests?
       mock_requests
     end
+
+    def persistent_session?
+      persistent_session
+    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
@@ -22,6 +22,7 @@ module Firmenwissen
       @request ||= begin
         Net::HTTP::Get.new(uri).tap do |req|
           req.basic_auth(config.user, config.password)
+          req.add_field('Cookie', session_cookie) if config.persistent_session? && !session_cookie.empty?
         end
       end
     end
@@ -29,5 +30,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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firmenwissen
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Gerrit Seger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -38,6 +38,20 @@ 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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - gerrit.seger@gmail.com
 executables: []
@@ -101,14 +115,15 @@ 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
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,9 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Ruby client for the FirmenWissen API
 test_files: []