ola_maps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ffdd3cbc975d235ec87c4484b194811bcba795b11662ff859b930085523b4ab
+  data.tar.gz: ea2ffbff4838dc8b9c6e6ff373d01ec4fbddd92f410f02e628dc1601bfbbbcae
+SHA512:
+  metadata.gz: dd9b986b1a9ee6b9d0b61efc17d847c106f3b58fa923bca07c5d55c21281f02ccea3fdda8fab64482849fd1045a8213b4e8de82495deef929e01b7a88c4d254a
+  data.tar.gz: 29255ad6e54214869c9d4c362e4271b04b4278fa2ca9095416cae9c965eb608fc31faf47a90a51c38fb134f82cb19d07cdee2a521a0eea17d5742e5f3aded252

data/README.md

@@ -0,0 +1,217 @@
+# Ola Maps
+
+A Ruby gem for interacting with the Ola Maps API, providing a simple interface for location-based services like autocomplete, geocoding, and reverse geocoding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ola_maps'
+```
+
+Then, execute:
+
+`$ bundle install`
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+` $ gem install 'ola_maps'`
+
+## Configuration
+
+Before using the gem, set up your environment variables in a .env file:
+
+```
+API_KEY=your_api_key
+CLIENT_ID=your_client_id
+CLIENT_SECRET=your_client_secret
+```
+
+## Usage
+
+Here's how to use the `OlaMaps` gem:
+
+```
+require 'dotenv/load'
+require 'ola_maps'
+
+client = OlaMaps::Client.new(
+  api_key: ENV['API_KEY']
+)
+
+# Autocomplete
+autocomplete_response = client.autocomplete('kempe')
+puts autocomplete_response.body
+
+# Geocode
+geocode_response = client.geocode('Bangalore')
+puts geocode_response.body
+
+# Reverse Geocode
+reverse_geocode_response = client.reverse_geocode('12.931316595874005,77.61649243443775')
+puts reverse_geocode_response.body
+
+```
+
+## API Methods
+
+### `#autocomplete(input, origin: nil, location: nil, radius: nil, strictbounds: nil)`
+
+Returns autocomplete suggestions based on the input string.
+
+- **Parameters:**
+  - `input`: The input string for autocomplete.
+  - `origin`: (Optional) The origin location.
+  - `location`: (Optional) The location to bias the results.
+  - `radius`: (Optional) The radius within which to return results.
+  - `strictbounds`: (Optional) If true, restrict results to the specified area.
+
+### `#geocode(address, bounds: nil, language: 'English')`
+
+Returns geocoded address information.
+
+- **Parameters:**
+  - `address`: The address to geocode.
+  - `bounds`: (Optional) The bounds within which to search.
+  - `language`: (Optional) The language for the response (default is 'English').
+
+### `#reverse_geocode(latlng)`
+
+Returns reverse geocoded address information for a given latitude and longitude.
+
+- **Parameters:**
+  - `latlng`: The latitude and longitude in the format `lat,lng`.
+
+## Running Tests
+
+To run the tests for this gem, ensure you have the required environment variables set in your .env file, then execute:
+
+```
+bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [ola_maps](https://github.com/shobhit-shukla/ola_maps). 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/shobhit-shukla/ola_maps/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Here’s a template for your README file for the `OlaMaps` gem:
+
+````markdown
+# OlaMaps
+
+A Ruby gem for interacting with the Ola Maps API, providing a simple interface for location-based services like autocomplete, geocoding, and reverse geocoding.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ola_maps'
+```
+````
+
+Then, execute:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+### Environment Variables
+
+Before using the gem, set up your environment variables in a `.env` file:
+
+```plaintext
+API_KEY=your_api_key
+CLIENT_ID=your_client_id
+CLIENT_SECRET=your_client_secret
+```
+
+### Usage
+
+Here's how to use the `OlaMaps` gem:
+
+```ruby
+require 'dotenv/load'
+require 'ola_maps'
+
+client = OlaMaps::Client.new(
+  api_key: ENV['API_KEY'],
+  client_id: ENV['CLIENT_ID'],
+  client_secret: ENV['CLIENT_SECRET']
+)
+
+# Autocomplete
+autocomplete_response = client.autocomplete('kempe')
+puts autocomplete_response.body
+
+# Geocode
+geocode_response = client.geocode('Bangalore')
+puts geocode_response.body
+
+# Reverse Geocode
+reverse_geocode_response = client.reverse_geocode('12.931316595874005,77.61649243443775')
+puts reverse_geocode_response.body
+```
+
+## API Methods
+
+### `#autocomplete(input, origin: nil, location: nil, radius: nil, strictbounds: nil)`
+
+Returns autocomplete suggestions based on the input string.
+
+- **Parameters:**
+  - `input`: The input string for autocomplete.
+  - `origin`: (Optional) The origin location.
+  - `location`: (Optional) The location to bias the results.
+  - `radius`: (Optional) The radius within which to return results.
+  - `strictbounds`: (Optional) If true, restrict results to the specified area.
+
+### `#geocode(address, bounds: nil, language: 'English')`
+
+Returns geocoded address information.
+
+- **Parameters:**
+  - `address`: The address to geocode.
+  - `bounds`: (Optional) The bounds within which to search.
+  - `language`: (Optional) The language for the response (default is 'English').
+
+### `#reverse_geocode(latlng)`
+
+Returns reverse geocoded address information for a given latitude and longitude.
+
+- **Parameters:**
+  - `latlng`: The latitude and longitude in the format `lat,lng`.
+
+## Running Tests
+
+To run the tests for this gem, ensure you have the required environment variables set in your `.env` file, then execute:
+
+```bash
+bundle exec rspec
+```
+
+## Contributing
+
+1. Fork it (https://github.com/yourusername/ola_maps/fork)
+2. Create your feature branch (`git checkout -b feature/YourFeature`)
+3. Commit your changes (`git commit -m 'Add some feature'`)
+4. Push to the branch (`git push origin feature/YourFeature`)
+5. Create a new Pull Request
+
+## License
+
+This gem is available as open-source under the terms of the MIT License.
+
+### Customization
+
+Feel free to modify sections like the installation instructions or API method descriptions to match your specific implementation details.
+
+## Code of Conduct
+
+Everyone interacting in the OlaMaps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ola_maps/blob/main/CODE_OF_CONDUCT.md).

data/lib/ola_maps/client.rb

@@ -0,0 +1,76 @@
+require 'faraday'
+require 'securerandom'
+require 'json'
+
+module OlaMaps
+  class Client
+    BASE_URL = 'https://api.olamaps.io'
+
+    def initialize(api_key: nil, client_id: nil, client_secret: nil)
+      @api_key = api_key
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    def autocomplete(input, origin: nil, location: nil, radius: nil, strictbounds: nil)
+      query = { input: input, api_key: @api_key }
+      query[:origin] = origin if origin
+      query[:location] = location if location
+      query[:radius] = radius if radius
+      query[:strictbounds] = strictbounds if strictbounds
+
+      get('/places/v1/autocomplete', query)
+    end
+
+    def geocode(address, bounds: nil, language: 'English')
+      query = { address: address, api_key: @api_key }
+      query[:bounds] = bounds if bounds
+      query[:language] = language
+
+      get('/places/v1/geocode', query)
+    end
+
+    def reverse_geocode(latlng)
+      query = { latlng: latlng, api_key: @api_key }
+
+      get('/places/v1/reverse-geocode', query)
+    end
+
+    private
+
+    def get(path, params)
+      connection.get(path, params) do |req|
+        req.headers = default_headers
+      end
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: BASE_URL) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def default_headers
+      headers = {}
+      headers['X-Request-Id'] = SecureRandom.uuid
+      headers['X-Correlation-Id'] = SecureRandom.uuid
+      headers['Authorization'] = "Bearer #{get_token}" if @client_id && @client_secret
+      headers
+    end
+
+    def get_token
+      response = Faraday.post(
+        'https://account.olamaps.io/realms/olamaps/protocol/openid-connect/token',
+        {
+          grant_type: 'client_credentials',
+          client_id: @client_id,
+          client_secret: @client_secret,
+          scope: 'openid olamaps'
+        }
+      )
+      JSON.parse(response.body)['access_token']
+    end
+  end
+end

data/lib/ola_maps/version.rb

@@ -0,0 +1,3 @@
+module OlaMaps
+  VERSION = "0.1.0"
+end

data/lib/ola_maps.rb

@@ -0,0 +1,7 @@
+require 'dotenv/load'
+require "ola_maps/version"
+require "ola_maps/client"
+
+module OlaMaps
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: ola_maps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shobhit
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Provides an easy interface for interacting with the Ola Maps API.
+email:
+- shobits001@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ola_maps.rb
+- lib/ola_maps/client.rb
+- lib/ola_maps/version.rb
+homepage: https://github.com/shobhit-shukla/ola-maps-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/shobhit-shukla/ola-maps-ruby
+  source_code_uri: https://github.com/shobhit-shukla/ola-maps-ruby
+  changelog_uri: https://github.com/shobhit-shukla/ola-maps-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the Ola Maps API.
+test_files: []