ola_maps 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffdd3cbc975d235ec87c4484b194811bcba795b11662ff859b930085523b4ab
-  data.tar.gz: ea2ffbff4838dc8b9c6e6ff373d01ec4fbddd92f410f02e628dc1601bfbbbcae
+  metadata.gz: 246a3bf364c2d2e2c8740748da563937eed8c2f8cef09dd3e6d106197c232645
+  data.tar.gz: 363e06fee9583c4cbf1977d41c1989dfe36ae56f6916ebf50cf81a8522b8e9a7
 SHA512:
-  metadata.gz: dd9b986b1a9ee6b9d0b61efc17d847c106f3b58fa923bca07c5d55c21281f02ccea3fdda8fab64482849fd1045a8213b4e8de82495deef929e01b7a88c4d254a
-  data.tar.gz: 29255ad6e54214869c9d4c362e4271b04b4278fa2ca9095416cae9c965eb608fc31faf47a90a51c38fb134f82cb19d07cdee2a521a0eea17d5742e5f3aded252
+  metadata.gz: 235ba4d6d5a5626e1fce7ff4132143b88ac9e57d5e3fb124161d3cbde7804a108a1b25af7ced563abab65f7985a9c7e2d23684f825993712016772396b2c60e5
+  data.tar.gz: 4145268c120530d65a97570a310d40ef562cbaf57ebff82a455d3fa2c30f40c29a0d2b230c723b809445abb43eb5def15480f5b5192cf9570f73c584e2033f5b

data/README.md

@@ -12,17 +12,21 @@ gem 'ola_maps'
 
 Then, execute:
 
-`$ bundle install`
+```ruby
+$ bundle install
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-` $ gem install 'ola_maps'`
+```ruby
+$ gem install 'ola_maps'
+```
 
 ## Configuration
 
 Before using the gem, set up your environment variables in a .env file:
 
-```
+```ruby
 API_KEY=your_api_key
 CLIENT_ID=your_client_id
 CLIENT_SECRET=your_client_secret
@@ -32,7 +36,7 @@ CLIENT_SECRET=your_client_secret
 
 Here's how to use the `OlaMaps` gem:
 
-```
+```ruby
 require 'dotenv/load'
 require 'ola_maps'
 
@@ -87,123 +91,21 @@ Returns reverse geocoded address information for a given latitude and longitude.
 
 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)
+1. Fork it (https://github.com/shobhit-shukla/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
 
+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
 
 This gem is available as open-source under the terms of the MIT License.

data/lib/ola_maps/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ola_maps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shobhit
@@ -119,14 +119,14 @@ files:
 - lib/ola_maps.rb
 - lib/ola_maps/client.rb
 - lib/ola_maps/version.rb
-homepage: https://github.com/shobhit-shukla/ola-maps-ruby
+homepage: https://github.com/shobhit-shukla/ola_maps
 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
+  homepage_uri: https://github.com/shobhit-shukla/ola_maps
+  source_code_uri: https://github.com/shobhit-shukla/ola_maps
+  changelog_uri: https://github.com/shobhit-shukla/ola_maps
 post_install_message:
 rdoc_options: []
 require_paths: