https://github.com/kickinespresso/espresso_path
GeoPath Ruby API
https://github.com/kickinespresso/espresso_path
api geopath ruby
Last synced: 10 months ago
JSON representation
GeoPath Ruby API
- Host: GitHub
- URL: https://github.com/kickinespresso/espresso_path
- Owner: kickinespresso
- License: mit
- Created: 2018-01-18T18:01:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-07T18:49:49.000Z (over 8 years ago)
- Last Synced: 2025-08-31T04:04:30.465Z (10 months ago)
- Topics: api, geopath, ruby
- Language: Ruby
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# EspressoPath
Welcome to your EspressoPath! Espresso Path is GeoPath API Ruby Wrapper
## WARNING - EXTREME ALPHA
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'espresso_path', '~> 0.1.7'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install espresso_path
## Documentation
[EspressoPath Docs](http://www.rubydoc.info/github/kickinespresso/espresso_path/master)
## Testing
1) Create `.env` in the root directory
2) Add the following environment variables
ESPRESSO_PATH_USER_NAME=YourEmail
ESPRESSO_PATH_PASSWORD=YourPassword
3) Run tests with
rspec
## Usage
TODO: Write usage instructions here
## Development
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 tags, 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/kickinespresso/espresso_path. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
When making pull requests, please be sure to update the [CHANGELOG.md](CHANGELOG.md) with the corresponding changes.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
## Sponsors
This project is sponsored by [KickinEspresso](https://kickinespresso.com/?utm_source=github&utm_medium=sponsor&utm_campaign=opensource)
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kickinespresso/ex_gtin/tags).
## Code of Conduct
Please refer to the [Code of Conduct](CODE_OF_CONDUCT.md) for details
## RubyGems
[EspressoPath on RubyGems](https://rubygems.org/gems/espresso_path)
## Release Process
[RELEASING.md](RELEASING.md)