open-elevation-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b140920a500137c4eb837a745242868a0b2ef6448a0a3b96515f1e9e28b6d5d
+  data.tar.gz: f0ca081ab2bc0b434739c40b4c282945239d27707630f6e0ca694eb29b847a42
+SHA512:
+  metadata.gz: e14888ab9df8df14ac881880aa1c5f6ac96d8cbbb67fb54e4b7897110c177f9aaebf3b90f1ba84bf45fe7ffc733b73686bb0094e64370af67081a6dcd6d72130
+  data.tar.gz: 3bef980cee75a518fd70fc0d5b9de47cb9094fa2f8697ead6b8a2e942b1f68e4805d4c2c065f2027be590cfc71e06b80cff76ad498adaa7a4ac815a3ea89fa80

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - rubocop-rspec
+AllCops:
+  DisplayCopNames: true
+  NewCops: enable
+  TargetRubyVersion: 3.1
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 18
+Metrics/BlockLength:
+  Max: 40
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Max: 30
+Layout/LineLength:
+  Exclude: 
+    - spec/quelink_mg/resp/*_spec.rb

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    open-elevation-api (0.1.0)
+      activesupport (~> 7.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.7.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.1.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    multi_xml (0.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.4)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    regexp_parser (2.8.1)
+    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.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.21.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  open-elevation-api!
+  pry (~> 0.13)
+  rspec (~> 3.9)
+  rubocop (~> 1.0)
+  rubocop-rspec (~> 2.2)
+  vcr (~> 6.0)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   2.4.7

data/README.md

@@ -0,0 +1,54 @@
+# open-api-elevation
+This gem is both for using official Open Elevation API https://open-elevation.com/ and the one you can serve on your own server https://github.com/Jorl17/open-elevation/blob/master/docs/host-your-own.md
+I encourage you if you plan to use Open Elevation API to either host on your own (mind it requires to store a lot of data ~20GB) or donate for Open Elevation API servers to help the creator provide the service
+
+
+## Instalation
+
+The open-api-elevation gem is available at rubygems.org. You can install with:
+
+`gem install open-api-elevation`
+
+Alternatively, you can install the gem with bundler:
+
+## Gemfile
+
+`gem 'open-api-elevation'`
+
+After doing bundle install, you should have the gem installed in your bundle.
+
+
+## Configuration
+If you want to use public OpenElevation API you may omit this step
+
+```
+OpenElevation.configure do |config|
+  config.api_url = 'https://EXAMPLE_API_SERVER/api/v1/lookup'
+end
+```
+
+## Usage
+
+You need to prepare collection that reponds to longitude and latitude methods
+```
+service = described_class.new(collection: ...)
+service.call
+```
+
+Results then may be obtained by
+```
+service.raw_response # as Hash
+service.collection_with_result # as original collection with elevation filled (if possible) 
+```
+
+
+## Development
+
+Building gem locally (you can change file name, ofc):
+
+`gem build *.gemspec -o pkg/open-api-elevation.gem`
+
+Installing:
+`gem install pkg/open-api-elevation.gem`
+
+

data/lib/open-elevation-api/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module OpenElevationApi
+  class Configuration
+    attr_accessor :api_url
+
+    OPEN_ELEVATION_API_URL = 'https://api.open-elevation.com/api/v1/lookup'
+
+    def initialize(api_url = nil)
+      @api_url = api_url || OPEN_ELEVATION_API_URL
+    end
+  end
+end

data/lib/open-elevation-api/get_elevations.rb

@@ -0,0 +1,55 @@
+require 'httparty'
+
+module OpenElevationApi
+  InvalidCollection = Class.new(StandardError)
+  class GetElevations
+    attr_reader :raw_response, :collection_with_result
+
+    def initialize(collection:, longitude_method: :longitude, latitude_method: :latitude)
+      @collection = collection
+      @longitude_method = longitude_method
+      @latitude_method = latitude_method
+    end
+
+    def call
+      raise InvalidCollection, 'Latitude or Longitude not provided' unless verify_collection
+
+      @raw_response = api_result
+      @collection_with_result = combined_results
+    end
+
+    private
+
+    def verify_collection
+      @collection.all? { |obj| obj.respond_to?(@longitude_method) && obj.respond_to?(@latitude_method) }
+    end
+
+    def body
+      {
+        locations: @collection.map do |obj|
+          { latitude: obj.send(@latitude_method), longitude: obj.send(@longitude_method) }
+        end
+      }.to_json
+    end
+
+    def api_result
+      @api_result ||= HTTParty.post(
+        OpenElevationApi.configuration.api_url,
+        body:,
+        headers: { 'Content-Type': 'application/json', Accept: 'application/json' }
+      )['results']
+    end
+
+    def combined_results
+      @collection.each do |obj|
+        result = api_result.find do |res|
+          res['latitude'] == obj.send(@latitude_method) && res['longitude'] == obj.send(@longitude_method)
+        end
+
+        next if result.nil? || !obj.respond_to?(:elevation)
+
+        obj.elevation = result['elevation']
+      end
+    end
+  end
+end

data/lib/open-elevation-api.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'date'
+require 'active_support'
+require 'active_support/time_with_zone'
+require 'active_support/core_ext/time/zones'
+
+require File.expand_path('open-elevation-api/get_elevations.rb', __dir__)
+require File.expand_path('open-elevation-api/configuration.rb', __dir__)
+
+module OpenElevationApi
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/open-elevation-api.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'open-elevation-api'
+  s.version     = '0.1.0'
+  s.summary     = 'Handles selecting elevation from Open Elevation API'
+  s.description = 'Works for both official API and self-hosted versions'
+  s.authors     = ['Stanislaw Zawadzki']
+  s.email       = 'st.zawadzki@gmail.com  '
+
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.require_paths = ['lib']
+  s.license       = 'MIT'
+  s.required_ruby_version = '>= 3.1'
+  s.add_dependency 'activesupport', '~> 7.0'
+  s.add_dependency 'httparty'
+  s.add_development_dependency 'pry', '~> 0.13'
+  s.add_development_dependency 'rspec', '~> 3.9'
+  s.add_development_dependency 'rubocop', '~> 1.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 2.2'
+  s.add_development_dependency 'vcr', '~> 6.0'
+  s.add_development_dependency 'webmock', '~> 3.0'
+  s.metadata['rubygems_mfa_required'] = 'false'
+end

data/spec/fixtures/vcr_cassettes/multiple_location.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.open-elevation.com/api/v1/lookup
+    body:
+      encoding: UTF-8
+      string: '{"locations":[{"latitude":51.01,"longitude":21.01},{"latitude":51.21,"longitude":21.06},{"latitude":51.51,"longitude":20.91}]}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.21.1
+      Date:
+      - Tue, 09 Jan 2024 18:59:59 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, POST, OPTIONS
+      Access-Control-Allow-Headers:
+      - DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Origin,Accept,Content-Type,X-Requested_with,X-CSRF-Token
+    body:
+      encoding: ASCII-8BIT
+      string: '{"results":[{"latitude":51.01,"longitude":21.01,"elevation":290.0},{"elevation":193.0,"longitude":21.06,"latitude":51.21},{"latitude":51.51,"longitude":20.91,"elevation":162.0}]}'
+  recorded_at: Tue, 09 Jan 2024 18:59:59 GMT
+recorded_with: VCR 6.1.0

data/spec/fixtures/vcr_cassettes/single_location.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.open-elevation.com/api/v1/lookup
+    body:
+      encoding: UTF-8
+      string: '{"locations":[{"latitude":51.01,"longitude":21.01}]}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.21.1
+      Date:
+      - Tue, 09 Jan 2024 18:21:25 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET, POST, OPTIONS
+      Access-Control-Allow-Headers:
+      - DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Origin,Accept,Content-Type,X-Requested_with,X-CSRF-Token
+    body:
+      encoding: ASCII-8BIT
+      string: '{"results":[{"latitude":51.01,"longitude":21.01,"elevation":290.0}]}'
+  recorded_at: Tue, 09 Jan 2024 18:21:25 GMT
+recorded_with: VCR 6.1.0

data/spec/open-elevation-api/get_elevations_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+RSpec.describe OpenElevationApi::GetElevations do
+  it 'returns error if longitude or latitude missing' do
+      elevation_stuct = OpenStruct.new(longitude: 21.01, elevation: nil)
+
+      service = described_class.new(collection: [elevation_stuct])
+      expect{service.call}.to raise_error OpenElevationApi::InvalidCollection
+  end
+
+  it 'gets single elevation - and enhancing collection' do
+    VCR.use_cassette('single location') do
+      elevation_stuct = OpenStruct.new(longitude: 21.01, latitude: 51.01, elevation: nil)
+
+      service = described_class.new(collection: [elevation_stuct])
+      service.call
+
+      expect(service.raw_response).to eq [{ 'latitude' => 51.01, 'longitude' => 21.01, 'elevation' => 290.0 }]
+      expect(service.collection_with_result.first.elevation).to eq 290.0
+    end
+  end
+
+  it 'gets single elevation - and enhancing collection, but with different method names' do
+    VCR.use_cassette('single location') do
+      elevation_stuct = OpenStruct.new(lon: 21.01, lat: 51.01, elevation: nil)
+
+      service = described_class.new(collection: [elevation_stuct], longitude_method: :lon, latitude_method: :lat)
+      service.call
+
+      expect(service.raw_response).to eq [{ 'latitude' => 51.01, 'longitude' => 21.01, 'elevation' => 290.0 }]
+      expect(service.collection_with_result.first.elevation).to eq 290.0
+      expect(service.collection_with_result.first.lat).to eq 51.01
+    end
+  end
+
+  it 'gets single elevation - and enhancing collection' do
+    VCR.use_cassette('single location') do
+      ElevationImmutableStruct = Struct.new(:longitude, :latitude)
+      elevation_stuct = ElevationImmutableStruct.new(21.01, 51.01)
+
+      collection = [elevation_stuct]
+      service = described_class.new(collection:)
+      service.call
+
+      expect(service.raw_response).to eq [{ 'latitude' => 51.01, 'longitude' => 21.01, 'elevation' => 290.0 }]
+      expect(service.collection_with_result).to eq collection
+    end
+  end
+
+  it 'gets multiple elevation - and enhancing collection' do
+    VCR.use_cassette('multiple location') do
+      elevation_stuct = OpenStruct.new(longitude: 21.01, latitude: 51.01, elevation: nil)
+      elevation_stuct_2 = OpenStruct.new(longitude: 21.06, latitude: 51.21, elevation: nil)
+      elevation_stuct_3 = OpenStruct.new(longitude: 20.91, latitude: 51.51, elevation: nil)
+
+      service = described_class.new(collection: [elevation_stuct, elevation_stuct_2, elevation_stuct_3])
+      service.call
+
+      expect(service.raw_response.map{|r| r['elevation']}).to eq [290.0, 193.0, 162.0]
+      expect(service.collection_with_result.first.elevation).to eq 290.0
+      expect(service.collection_with_result.last.elevation).to eq 162.0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'vcr'
+require_relative '../lib/open-elevation-api'
+
+OpenElevationApi.configure do |config|
+  config.api_url = OpenElevationApi::Configuration::OPEN_ELEVATION_API_URL
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: open-elevation-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stanislaw Zawadzki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Works for both official API and self-hosted versions
+email: 'st.zawadzki@gmail.com  '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/open-elevation-api.rb
+- lib/open-elevation-api/configuration.rb
+- lib/open-elevation-api/get_elevations.rb
+- open-elevation-api.gemspec
+- spec/fixtures/vcr_cassettes/multiple_location.yml
+- spec/fixtures/vcr_cassettes/single_location.yml
+- spec/open-elevation-api/get_elevations_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Handles selecting elevation from Open Elevation API
+test_files: []