firmenwissen 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 479f8a1bea375d5c4af1c8980981c1fc2f0d4d0bfe7c8b7ac60cf17821b76672
+  data.tar.gz: e4aa6079c3be8d66819ff0d49e8f7c8fef9261c61f4b5353174c4227788593c2
+SHA512:
+  metadata.gz: c877c1e82ffde13a74f956d72d94d5b7eb7106e27dabb66e377c40d7983076706a34276be83bb0c325d7fa3dde0b735f5164b62a86666c380e31d20851fb2acb
+  data.tar.gz: '095e5255d2bb6c45cea6151bd5acafeba67fc07fa074db666c56e06c0c7c9748690bded252489748ed23c0f913c038af9e3e6be7a4258e02712735c96f2cbc5e'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Gerrit Seger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Firmenwissen
+A ruby gem to conveniently access the [Firmenwissen](www.firmenwissen.de) Smart Sign-Up API.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firmenwissen'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install firmenwissen
+```
+
+## Usage
+### Searching
+```ruby
+response = Firmenwissen.search('company xyz')
+
+if response.successful?
+  suggestions = response.suggestions
+  ...
+end
+```
+
+will give you an array of suggestions from Firmenwissen, if any, for the specified query string.
+
+```ruby
+suggestion = suggestions.first
+
+suggestion.crefo_id # => '1234567890'
+suggestion.name # => 'COMPEON GmbH'
+suggestion.trade_name # => 'Compeon'
+suggestion.country # => 'DE'
+suggestion.state # => 'Nordrhein-Westfalen'
+suggestion.zip_code # => '40211'
+suggestion.city # => 'Düsseldorf'
+suggestion.address # => 'Louise-Dumon-Straße 5'
+
+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
+  
+  # Configure the endpoint yourself. %s will be replaced by the actual query
+  config.endpoint = 'https://example.com/search?query=%s'
+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.
+
+```ruby
+Firmenwissen.configure do |config|
+  config.mock_requests = true
+  
+  # respond with a fixed array
+  config.mock_data = [{ crefo_id: '1111111111', name: 'Test GmbH', ... }, { ... }, ...]
+  
+  # respond when a query matches an exact keyword
+  # this will return a result mock when you search for 'compeon' or 'test', otherwise an empty result
+  mock_data = {
+    'compeon' => [{ crefo_id: '1234567890', name: 'COMPEON GmbH', ... }],
+    'test' => [{ crefo_id: '1111111111', ... }]
+  }
+
+  config.mock_data = mock_data
+  
+  # generate your own dynamic response
+  config.mock_data = Proc.new do |query|
+    # your code for mock data generation here
+  end
+ 
+  # or
+  
+  class DynamicMockData
+    def call(query)
+      # your code for mock data generation here
+    end
+  end
+  
+  config.mock_data = DynamicMockData.new
+end
+```
+**Note:** All configuration options can be overridden on a per-request basis by passing an options hash to the `search` method.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/firmenwissen.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'net/http'
+require 'addressable/template'
+
+require 'firmenwissen/configuration'
+require 'firmenwissen/http_request'
+require 'firmenwissen/key_mapper'
+require 'firmenwissen/request'
+require 'firmenwissen/suggestion'
+require 'firmenwissen/version'
+
+require 'firmenwissen/errors/credentials_error'
+
+require 'firmenwissen/request/base'
+require 'firmenwissen/request/mock'
+
+require 'firmenwissen/response/base'
+require 'firmenwissen/response/mock'
+
+module Firmenwissen
+  extend Configuration::Accessors
+
+  class << self
+    def search(query, options = {})
+      strategy = configuration.mock_requests? ? :mock : :base
+
+      Request.from_strategy(strategy, query, options).execute
+    end
+  end
+end

data/lib/firmenwissen/configuration.rb

@@ -0,0 +1,50 @@
+module Firmenwissen
+  class Configuration
+    module Accessors
+      def configuration
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield configuration
+      end
+    end
+
+    SETTINGS = %i[endpoint password mock_data mock_requests timeout user]
+
+    DEFAULT_SETTINGS = {
+      endpoint: 'https://www.firmenwissen.de/search/suggest/companywithaddress/{query}{?country}',
+      mock_requests: false,
+      mock_data: [],
+      timeout: 5
+    }.freeze
+
+    SETTINGS.each do |setting|
+      define_method(setting) do
+        settings[setting]
+      end
+
+      define_method("#{setting}=") do |value|
+        settings[setting] = value
+      end
+    end
+
+    attr_reader :settings
+
+    def initialize(options = {})
+      @settings = DEFAULT_SETTINGS.dup.merge(options)
+    end
+
+    def merge(options)
+      Configuration.new(settings.merge(options))
+    end
+
+    def credentials_present?
+      [user, password].all? { |setting| setting.is_a?(String) && !setting.empty? }
+    end
+
+    def mock_requests?
+      mock_requests
+    end
+  end
+end

data/lib/firmenwissen/errors/credentials_error.rb

@@ -0,0 +1,7 @@
+module Firmenwissen
+  class CredentialsError < StandardError
+    def initialize(message = 'Firmenwissen credentials are missing')
+      super
+    end
+  end
+end

data/lib/firmenwissen/http_request.rb

@@ -0,0 +1,33 @@
+module Firmenwissen
+  class HttpRequest
+    def initialize(uri, options = {})
+      @uri = uri
+      @options = options
+    end
+
+    def execute
+      http = Net::HTTP.start(uri.host)
+      http.read_timeout = config.timeout
+      http.request(request)
+    ensure
+      http.finish
+      http
+    end
+
+    protected
+
+    attr_reader :uri, :options, :params
+
+    def request
+      @request ||= begin
+        Net::HTTP::Get.new(uri).tap do |req|
+          req.basic_auth(config.user, config.password)
+        end
+      end
+    end
+
+    def config
+      @config ||= Firmenwissen.configuration.merge(options)
+    end
+  end
+end

data/lib/firmenwissen/key_mapper.rb

@@ -0,0 +1,38 @@
+module Firmenwissen
+  module KeyMapper
+    KEY_MAPPINGS = {
+      crefo_id:      'crefonummer',
+      name:          'name',
+      trade_name:    'handelsName',
+      country:       'land',
+      state:         'bundesland',
+      zip_code:      'plz',
+      city:          'ort',
+      address:       'strasseHausnummer'
+    }.freeze
+
+    class << self
+      def from_api(hash)
+        map(hash, :from_api)
+      end
+
+      def to_api(hash)
+        map(hash, :to_api)
+      end
+
+      private
+
+      def map(hash, direction)
+        {}.tap do |result|
+          mapping_for(direction).each do |key, value|
+            result[key] = hash[value]
+          end
+        end
+      end
+
+      def mapping_for(direction)
+        direction == :from_api ? KEY_MAPPINGS : KEY_MAPPINGS.invert
+      end
+    end
+  end
+end

data/lib/firmenwissen/request.rb

@@ -0,0 +1,11 @@
+module Firmenwissen
+  module Request
+    class << self
+      def from_strategy(strategy, query, options = {})
+        strategy_name = strategy.to_s.capitalize
+
+        self.const_get(strategy_name).new(query, options)
+      end
+    end
+  end
+end

data/lib/firmenwissen/request/base.rb

@@ -0,0 +1,34 @@
+module Firmenwissen
+  module Request
+    class Base
+      def initialize(query, options = {})
+        @query = query
+        @options = options
+        @params = options.fetch(:params, {})
+
+        raise CredentialsError unless config.credentials_present?
+      end
+
+      def execute
+        Response::Base.new(http_request.execute)
+      end
+
+      protected
+
+      attr_reader :options, :query, :params
+
+      def http_request
+        HttpRequest.new(uri, options)
+      end
+
+      def uri
+        template = Addressable::Template.new(config.endpoint)
+        template.expand(query: query, **params)
+      end
+
+      def config
+        @config ||= Firmenwissen.configuration.merge(options)
+      end
+    end
+  end
+end

data/lib/firmenwissen/request/mock.rb

@@ -0,0 +1,9 @@
+module Firmenwissen
+  module Request
+    class Mock < Base
+      def execute
+        Response::Mock.new(config.mock_data, query, params)
+      end
+    end
+  end
+end

data/lib/firmenwissen/response/base.rb

@@ -0,0 +1,37 @@
+module Firmenwissen
+  module Response
+    class Base
+      def initialize(http_response)
+        @http_response = http_response
+      end
+
+      def suggestions
+        @suggestions ||= data.map { |suggestion| Suggestion.new(suggestion) }
+      end
+
+      def data
+        api_response = JSON.parse(http_response.body).fetch('companyNameSuggestions', [])
+
+        map_response(api_response)
+      end
+
+      def status_code
+        http_response.code
+      end
+
+      def successful?
+        status_code == '200'
+      end
+
+      private
+
+      attr_reader :http_response
+
+      def map_response(api_response)
+        api_response.map do |hash|
+          KeyMapper.from_api(hash)
+        end
+      end
+    end
+  end
+end

data/lib/firmenwissen/response/mock.rb

@@ -0,0 +1,38 @@
+module Firmenwissen
+  module Response
+    class Mock < Base
+      def initialize(mock_data, query, params = {})
+        @mock_data = mock_data
+        @query = query
+        @params = params
+
+        raise ArgumentError, 'mock data must either be an array, a hash or respond to `call`' unless mock_data_valid?
+      end
+
+      def data
+        return mock_data.call(query, params) if mock_data.respond_to?(:call)
+
+        case mock_data
+        when Array
+          mock_data
+        when Hash
+          mock_data[query] || []
+        else
+          []
+        end
+      end
+
+      def status_code
+        '200'
+      end
+
+      private
+
+      attr_reader :mock_data, :query, :params
+
+      def mock_data_valid?
+        mock_data.respond_to?(:call) || mock_data.is_a?(Array) || mock_data.is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/firmenwissen/suggestion.rb

@@ -0,0 +1,21 @@
+module Firmenwissen
+  class Suggestion
+    KeyMapper::KEY_MAPPINGS.keys.each do |key|
+      define_method(key) do
+        suggestion[key]
+      end
+    end
+
+    def initialize(suggestion)
+      @suggestion = suggestion
+    end
+
+    def to_h
+      suggestion.dup
+    end
+
+    private
+
+    attr_reader :suggestion
+  end
+end

data/lib/firmenwissen/version.rb

@@ -0,0 +1,3 @@
+module Firmenwissen
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: firmenwissen
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gerrit Seger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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
+    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: vcr
+  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: webmock
+  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'
+description: 
+email:
+- gerrit.seger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/firmenwissen.rb
+- lib/firmenwissen/configuration.rb
+- lib/firmenwissen/errors/credentials_error.rb
+- lib/firmenwissen/http_request.rb
+- lib/firmenwissen/key_mapper.rb
+- lib/firmenwissen/request.rb
+- lib/firmenwissen/request/base.rb
+- lib/firmenwissen/request/mock.rb
+- lib/firmenwissen/response/base.rb
+- lib/firmenwissen/response/mock.rb
+- lib/firmenwissen/suggestion.rb
+- lib/firmenwissen/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for the FirmenWissen API
+test_files: []