geoloco 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c53324fe06fb58786ff555b0a11d3ca0fd2bda60f489b31fd20ab4975266d2c
-  data.tar.gz: 6d6ac9d5df99653e1e2ab13fd956966cde186b6e3da50a105f62c869c96a82e0
+  metadata.gz: 3f362468184f4c57e32785a761de82e7fff2ecff21b6c38f7c5b5dadd853c46e
+  data.tar.gz: 52082e781e0340b5c056b12cfb45e6aa8d6b7ead8880c82bdcdacba373a6eabd
 SHA512:
-  metadata.gz: 5165c03d95aa767769f1294b58135d29fba59e79ea88035dde945f3f95e410cf94643fcaaeeb58c0f92d897f8d46813adcc3d35ca88470ce1164b282604238ba
-  data.tar.gz: 8aaea202d406c55be223bef589a5e7c1dfcfa0d36e584cff04b68cb2c0af149647920eb2b9849beb248addf7c5a55afec0f5eab38fad3e0acbd4443f3b546493
+  metadata.gz: 0a1f0fbe2be6f0c617468b5c641898cc6030044c73c3d4df8b856d117fbb7fcdfeb933a1057109b096e8457e43d770a833941adccfc69bca054d38b9d10edaeb
+  data.tar.gz: 30d484e4dc35cc8e49e1c810560286f2656f4761bc93fc090fdce225dccbb4afe0edf2f516351b57ba86a9b1580e82e177998e1dbda58c103c1764564a8d9665

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Managed by https://github.com/powerhome/software. Do not make changes here, they will be reverted.
+* @powerhome/heroes-for-hire

data/.github/workflows/geoloco.yml

@@ -0,0 +1,13 @@
+name: geoloco
+
+on:
+  push:
+
+jobs:
+  ruby:
+    uses: powerhome/github-actions-workflows/.github/workflows/ruby-gem.yml@main
+    with:
+      package: ${{ github.workflow }}
+      ruby: '["3.3","3.4","4.0"]'
+      bundler: '["4"]'
+    secrets: inherit

data/.github/workflows/reviewdog.yml

@@ -0,0 +1,31 @@
+# Managed by https://github.com/powerhome/software. Do not make changes here, they will be reverted.
+
+name: Automated Code Reviews
+on: [pull_request]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  bearer:
+    name: bearer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - uses: reviewdog/action-setup@d8a7baabd7f3e8544ee4dbde3ee41d0011c3a93f # v1.5.0
+        with:
+          reviewdog_version: latest
+      - name: bearer
+        uses: bearer/bearer-action@828eeb928ce2f4a7ca5ed57fb8b59508cb8c79bc # v2
+        with:
+          diff: true
+          format: rdjson
+          output: rd.json
+          config-file: bearer.yml
+      - name: Run reviewdog
+        if: always()
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          touch rd.json && cat rd.json | reviewdog -f=rdjson -reporter=github-pr-check

data/.github/workflows/stale.yml

@@ -0,0 +1,35 @@
+# Managed by https://github.com/powerhome/software. Do not make changes here, they will be reverted.
+
+name: 'Close stale issues and PRs'
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '5 5 * * *'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@4391f3da665fdf50b6810c1a66712fb9ba21aa93 # v11.0.0
+        with:
+          operations-per-run: 200
+          delete-branch: true
+          stale-pr-message: >
+            This issue has been automatically marked as stale because it has not had
+            recent activity. It will be closed in 24 hours if no further activity occurs.
+
+            If this change is desirable, please accelerate completing it. If it is not,
+            please close the PR. If you're blocked on something, please ensure there's
+            a reference to this PR in a story on your team's board so the team will
+            follow up, and consider closing the PR for now.
+
+            Please do not artificially extend the deadline with a dummy comment. If
+            necessary, provide a status update, such as "this change is being actively
+            tested".
+
+            Thank you for your contributions and your collaboration in reducing WIP
+            and cycle time.
+          days-before-stale: 14
+          days-before-close: 3
+          days-before-issue-stale: -1
+          exempt-pr-labels: dependencies

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+4.0.7

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 1.1.0
+
+- Add API key authentication to the Google geocoding adapter
+- Require Ruby >= 3.3 and target Ruby 4.0.7 for development
+- Add `base64` as a runtime dependency (no longer a default gem since Ruby 3.4)
+- Drop the pinned Bundler 1.x development dependency and update locked gems
+- Replace Travis CI with the shared Power `ruby-gem` GitHub Actions workflow (tests on Ruby 3.3, 3.4 and 4.0, license compliance check, releases to RubyGems on `v*-geoloco` tags)

data/Gemfile.lock

@@ -1,45 +1,48 @@
 PATH
   remote: .
   specs:
-    geoloco (1.0.0)
+    geoloco (1.1.0)
+      base64
       httparty (>= 0.14.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    httparty (0.17.1)
-      mime-types (~> 3.0)
+    base64 (0.3.0)
+    bigdecimal (4.1.3)
+    csv (3.3.6)
+    diff-lcs (1.6.2)
+    httparty (0.24.3)
+      csv
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    multi_xml (0.6.0)
-    rake (10.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    mini_mime (1.1.5)
+    multi_xml (0.9.1)
+      bigdecimal (>= 3.1, < 5)
+    rake (13.4.2)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    timecop (0.9.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    timecop (0.9.11)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
   geoloco!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   timecop (>= 0.9)
 
 BUNDLED WITH
-   1.17.3
+  4.0.23

data/doc/dependency_decisions.yml

@@ -0,0 +1,3 @@
+---
+- - :inherit_from
+  - https://raw.githubusercontent.com/powerhome/oss-guide/master/license_rules.yml

data/geoloco.gemspec

@@ -38,11 +38,12 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 3.3'
 
+  spec.add_dependency 'base64'
   spec.add_dependency 'httparty', '>= 0.14.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'timecop', '>= 0.9'
 end

data/lib/geoloco/adapters/google.rb

@@ -11,8 +11,9 @@ module Geoloco
       GEOCODE_PATH = '/maps/api/geocode/json'
 
       class << self
-        def geocode(address, client_id:, key:)
-          response = Geoloco.http.get(geocode_url(address, client_id, key))
+        def geocode(address, key: nil, client_id: nil, api_key: nil)
+          url = geocode_url(address, client_id, key, api_key)
+          response = Geoloco.http.get(url)
           handle_errors(response, response.parsed_response)
           map_results(response.parsed_response)
         end
@@ -63,9 +64,16 @@ module Geoloco
                 &.dig(data)
         end
 
-        def geocode_url(address, client_id, key)
-          query = URI.encode_www_form(client: client_id, address: address)
-          signed_url(GEOCODE_PATH, query, key)
+        def geocode_url(address, client_id, key, api_key)
+          if client_id && key && api_key.nil?
+            query = URI.encode_www_form(client: client_id, address: address)
+            signed_url(GEOCODE_PATH, query, key)
+          elsif api_key && client_id.nil? && key.nil?
+            query = URI.encode_www_form(address: address, key: api_key)
+            "#{API_HOST}#{GEOCODE_PATH}?#{query}"
+          else
+            raise ArgumentError, 'provide client_id and key, or api_key'
+          end
         end
 
         def signed_url(path, query, key)

data/lib/geoloco/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Geoloco
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: Geoloco
+site_description: Geoloco Documentation
+nav:
+  - "Home": "README.md"
+plugins:
+  - techdocs-core

data/portal.yml

@@ -0,0 +1,12 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: geoloco
+  title: Geoloco
+  description: Geocoding for ruby with multiple adapters
+  annotations:
+    backstage.io/techdocs-ref: dir:.
+spec:
+  type: library
+  owner: heroes-for-hire
+  lifecycle: production

metadata

@@ -1,58 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: geoloco
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Carlos Palhares
 - Rafael Garcia
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
+        version: 0.14.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -89,17 +88,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/CODEOWNERS"
+- ".github/workflows/geoloco.yml"
+- ".github/workflows/reviewdog.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.md
 - Rakefile
 - bin/console
 - bin/setup
+- doc/dependency_decisions.yml
+- docs/README.md
 - geoloco.gemspec
 - lib/geoloco.rb
 - lib/geoloco/adapters/fake.rb
@@ -108,6 +112,8 @@ files:
 - lib/geoloco/geometry.rb
 - lib/geoloco/location.rb
 - lib/geoloco/version.rb
+- mkdocs.yml
+- portal.yml
 homepage: https://github.com/powerhome/geoloco
 licenses:
 - MIT
@@ -115,7 +121,6 @@ metadata:
   homepage_uri: https://github.com/powerhome/geoloco
   source_code_uri: https://github.com/powerhome/geoloco
   changelog_uri: https://github.com/powerhome/geoloco
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -123,16 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Multi adapter geolocation tool
 test_files: []

data/.travis.yml

@@ -1,16 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.0
-  - 2.6.3
-before_install: gem install bundler -v 1.17.2
-deploy:
-  provider: rubygems
-  api_key:
-    secure: aCipdg6IqKaxQmWQXFlqI2JqGOrCAxzYlutOn6nCSk9VCzmlRjDoEp1M99ASvmF5CP3KQgfRq8bxfLql8jss8tymK0u2ExvKaUglK0zb2KoLQDGDGuHw3RxCTnaxPBuO4/2PuS+nso6IcdqUaGOzh8FA7ePKPBmxl3kyNtArEDV88Eyx6tQYs1/1w153bAeBk57nTiu8CPS+dIWg+guQADTLPZ61fH4xKjPWXnr65pFF7YtU5YdPBHFkqL60X384OZj1c7ZTGvFj70+36oo617HigSg8HCE+E0R1N4JQ8/5xo2yHBdrtgsAqYyYWRgm1C6qu+T6yKMuokdoSd0Ji3Rigz6VRrOJfjmQQkwMnno9fCY3vND62zOb9Ow+MCNuQYSgNHc+YPURKmT05wadG0FpZdmo6hstPusleuG89NxnB/s2YjR0QWQK05MW1uhFdru1S2gBd1fMH1GLoThhdfGG1UJSkKOipUJyRupFaB9zimJO3HwaTP0Q+wP8MGZDAqbyzQ3bJSZaQmJC6loC2EtxxnOQxUIxaySLtNEU2LOr9IijExj1ldXkz8X1fIWwRr6BPnIeChFnuST+L9UDYtqk1WgQTUs+tOAxUjepAWhtIUL5h3Jg2NZd9RxPXq8IngDWZJwT8yA3E9wloQx5JzTIMas5wHwCQJuwjjk5ibss=
-  gem: consent
-  on:
-    tags: true
-    repo: powerhome/consent