tel_search 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953a443aa4a2926232a53e25d542748579661ffd147676c29cbc543507e87d45
-  data.tar.gz: 3b415da4ab4f7ed80a0cf3c2c2fb088cdad9ea8676327446b57a0448e6f59991
+  metadata.gz: 785d7f800686e0b7c6472e1fac9246450079df424f9b55a9f362e8281df9b55b
+  data.tar.gz: 9b7f61745a4fbd67c8ded3760efa0e0e42ebcf2d584b4cf7f21847463c1f5d94
 SHA512:
-  metadata.gz: eb9e0d06e9e7ad23f66b83901620daccaea662fe82ebeb90964b1efd8d25b55c54c2298632941fe689bf8828a116c5cd67f3c2ec61181eaec4c6cdeebea07585
-  data.tar.gz: e3dd6bce4cc659f86f5c7be7e4f24c0f75970477e5e2c0bb97acba3494783322ba2b5c2d3ae74c71ba0738273c214316bc6f1867c52dce7d7301a95a718f3b56
+  metadata.gz: d81da868a8a5502933b408154358837eeee594e6f4346beb6a1c013cc76423665e33904279809573a45a9699f4853f3963be7575705746987ae51afd0ec30b50
+  data.tar.gz: dc58431b4804d6a1efefb3c31fdc1922d321bf0871a3101183268187a3ad970684068976590b7f08ca1fff2e012fb6a852ed87c9d62aba1512448ef60461d713

data/.github/workflows/main.yml

@@ -1,16 +1,35 @@
 name: Ruby
 
-on: [push,pull_request]
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
 
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: true
+    - name: Run rubocop
+      run: bundle exec standardrb
+
+  test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.2
+        ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-02-12
+
+ - Add mappings for `first_name`, `last_name` and `company`
+ - Raise error on bad requests
+ - Require Ruby > 3
+
 ## [0.1.0] - 2021-10-27
 
 - Initial release
 - Basic functionality of the api
+
+[Unreleased]: https://github.com/renuo/tel_search/compare/v0.1.0..v0.2.0
+[0.2.0]: https://github.com/renuo/tel_search/compare/v0.1.0..v0.2.0
+[0.1.0]: https://github.com/renuo/tel_search/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,70 +1,88 @@
 PATH
   remote: .
   specs:
-    tel_search (0.1.0)
+    tel_search (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.4)
-    hashdiff (1.0.1)
-    nokogiri (1.12.5-x86_64-darwin)
+    diff-lcs (1.5.0)
+    hashdiff (1.1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    nokogiri (1.16.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.5-x86_64-linux)
+    nokogiri (1.16.2-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    nokogiri (1.16.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    racc (1.6.0)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+      racc
+    public_suffix (5.0.4)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.20.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.5)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.3.0)
-      rubocop (= 1.20.0)
-      rubocop-performance (= 1.11.5)
-    unicode-display_width (2.1.0)
-    vcr (6.0.0)
-    webmock (3.14.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.33.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.59.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    unicode-display_width (2.5.0)
+    vcr (6.2.0)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-19
   x86_64-linux
 
@@ -78,4 +96,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.2.22
+   2.2.32

data/README.md

@@ -1,5 +1,7 @@
 # TelSearch
 
+[![Gem Version](https://badge.fury.io/rb/tel_search.svg)](https://badge.fury.io/rb/tel_search)
+
 A ruby client for the tel.search.ch api. [Docs](https://tel.search.ch/api/help.en.html)
 
 ## Installation
@@ -19,6 +21,7 @@ Or install it yourself as:
     $ gem install tel_search
 
 ## Usage
+
 ```ruby
 client = TelSearch::Client.new(ENV['TEL_API_KEY'])
 query = TelSearch::Query.new(where: 'Wallisellen', what: 'Renuo AG', language: :de)
@@ -30,13 +33,15 @@ response.entries.first.name == 'Renuo AG'
 
 ## Development
 
+Set `TEL_KEY` in your environment.
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/renuo/tel_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tel_search/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/renuo/tel_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/tel_search/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -44,8 +49,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TelSearch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[renuo]/tel_search/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TelSearch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[renuo]/tel_search/blob/main/CODE_OF_CONDUCT.md).
 
 ## Copyright
 
-Copyright 2021 [Renuo AG](https://www.renuo.ch/).
+Copyright 2021-2024 [Renuo AG](https://www.renuo.ch/).

data/lib/tel_search/client.rb

@@ -14,7 +14,10 @@ module TelSearch
 
     def execute(query)
       params_for_request = request_params(query.to_h)
-      parse_response(send_request(params_for_request))
+      response = send_request(params_for_request)
+      raise TelSearch::Error.new(response) unless response.is_a?(Net::HTTPSuccess)
+
+      parse_response(response)
     end
 
     private

data/lib/tel_search/entry.rb

@@ -1,38 +1,87 @@
 module TelSearch
   class Entry
-    ATTRIBUTES = %i[title type name first_name last_name street street_number zip city canton phone]
+    TYPES = {
+      person: "Person",
+      company: "Organisation"
+    }
+
+    ATTRIBUTES = %i[
+      canton
+      city
+      company
+      first_name
+      last_name
+      name
+      phone
+      street
+      street_number
+      title
+      type
+      zip
+    ].freeze
 
     ATTRIBUTE_MAPPING = {
-      streetno: :street_number
-    }
+      streetno: [:street_number],
+      firstname: [:first_name],
+      name: [
+        {
+          target: :last_name,
+          condition: ->(attributes) { attributes[:type]&.first == TYPES[:person] }
+        },
+        {
+          target: :company,
+          condition: ->(attributes) { attributes[:type]&.first == TYPES[:company] }
+        }
+      ]
+    }.freeze
 
     attr_accessor(*ATTRIBUTES)
 
     def from_rss(feed_entry)
       attributes = collect_tel_information(feed_entry)
       set_attributes(attributes)
+      map_attributes(attributes)
 
       self
     end
 
     private
 
+    def collect_tel_information(feed_entry)
+      feed_entry.xpath("./tel:*").each_with_object(Hash.new { |h, k| h[k] = [] }) do |node, hash|
+        hash[node.name.to_sym] << node.text
+      end
+    end
+
     def set_attributes(attributes)
       ATTRIBUTES.each do |attribute_name|
         set_property(attribute_name, attributes[attribute_name])
       end
     end
 
-    def collect_tel_information(feed_entry)
-      feed_entry.xpath("./tel:*").each_with_object(Hash.new { |h, k| h[k] = [] }) do |node, hash|
-        custom_key = ATTRIBUTE_MAPPING[node.name.to_sym]
-        node_name = custom_key || node.name.to_sym
-        hash[node_name] << node.text
+    def map_attributes(attributes)
+      ATTRIBUTE_MAPPING.each do |key, mappings|
+        next if key.nil? || mappings.nil?
+
+        node_value = attributes[key]
+
+        mappings.each do |mapping|
+          case mapping
+          when Symbol
+            set_property(mapping, node_value)
+          when Hash
+            condition = mapping[:condition]
+
+            set_property(mapping[:target], node_value) if condition.call(attributes)
+          end
+        end
       end
     end
 
     def set_property(prop_name, prop_value)
-      send("#{prop_name}=", prop_value.count > 1 ? prop_value : prop_value.first)
+      return if prop_value.nil?
+
+      send(:"#{prop_name}=", (prop_value.count > 1) ? prop_value : prop_value.first)
     end
   end
 end

data/lib/tel_search/param_parser.rb

@@ -34,12 +34,12 @@ module TelSearch
 
     def transform_value(value)
       case value
-        when true
-          "1"
-        when false
-          "0"
-        else
-          value
+      when true
+        "1"
+      when false
+        "0"
+      else
+        value
       end
     end
   end

data/lib/tel_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TelSearch
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/tel_search.rb

@@ -8,6 +8,12 @@ require_relative "tel_search/response"
 require_relative "tel_search/version"
 
 module TelSearch
-  class Error < StandardError; end
-  # Your code goes here...
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      super(response.body)
+      @response = response
+    end
+  end
 end

data/tel_search.gemspec

@@ -12,11 +12,11 @@ Gem::Specification.new do |spec|
   spec.description = "A ruby wrapper for the tel.search.ch/api endpoint"
   spec.homepage = "https://github.com/renuo/tel_search"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/renuo/tel_search"
-  spec.metadata["changelog_uri"] = "https://github.com/renuo/tel_search/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/renuo/tel_search/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tel_search
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Liberatys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2025-07-16 00:00:00.000000000 Z
 dependencies: []
 description: A ruby wrapper for the tel.search.ch/api endpoint
 email:
@@ -45,7 +45,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/renuo/tel_search
   source_code_uri: https://github.com/renuo/tel_search
-  changelog_uri: https://github.com/renuo/tel_search/CHANGELOG.md
+  changelog_uri: https://github.com/renuo/tel_search/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -54,14 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A ruby wrapper for the tel.search.ch/api endpoint