-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit c38c1cc
Showing
8 changed files
with
275 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, gender identity and expression, level of experience, | ||
nationality, personal appearance, race, religion, or sexual identity and | ||
orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
## How to contribute to the Amadeus Node Client Library | ||
|
||
#### **Did you find a bug?** | ||
|
||
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/amadeusdev/amadeus-node/issues). | ||
|
||
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/amadeusdev/amadeus-node/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring. | ||
|
||
#### **Did you write a patch that fixes a bug?** | ||
|
||
* Open a new GitHub pull request with the patch. | ||
|
||
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. | ||
|
||
#### **Do you intend to add a new feature or change an existing one?** | ||
|
||
* Suggest your change [in a new issue](https://github.com/amadeusdev/amadeus-node/issues/new) and start writing code. | ||
|
||
* Make sure your new code does not break any tests and include new tests. | ||
|
||
* With good code comes good documentation. Try to copy the existing documentation and adapt it to your needs. | ||
|
||
* Close the issue or mark it as inactive if you decide to discontinue working on the code. | ||
|
||
#### **Do you have questions about the source code?** | ||
|
||
* Ask any question about how to use the library by [raising a new issue](https://github.com/amadeusdev/amadeus-node/issues/new). | ||
|
||
#### **Do you want to contribute to the documentation?** | ||
|
||
Excellent, to get start developing this library ensure you have Node 2.2+ installed and clone the repository. | ||
|
||
Then, you should be able to run the tests. | ||
|
||
```sh | ||
bundle install # ensure all gems are installed | ||
bundle rake #run all tests | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
## Description | ||
|
||
[Describe the issue] | ||
|
||
## Steps to Reproduce | ||
|
||
1. [First step] | ||
2. [Second step] | ||
3. [and so on...] | ||
|
||
__Expected Behavior:__ [What you expect to happen] | ||
|
||
__Actual Behavior:__ [What actually happens] | ||
|
||
__Stable Behavior?__ [What percentage of the time does it reproduce?] | ||
|
||
## Versions | ||
|
||
[What version of Node/NPM are you running? What Operating System are you on?] | ||
|
||
## Checklist | ||
|
||
Please make sure you checked the following: | ||
|
||
* Are you running Node 2.2+? | ||
* Did you download the latest version of this gem? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Fixes # | ||
|
||
## Changes for this pull request | ||
|
||
## Checklist | ||
|
||
Remove this if you have done all of these: | ||
|
||
* Ensure all tests pass and linting | ||
* Add any changes to the README | ||
* Add any changes or new comments to SDK methods | ||
* Ensure this PR only changes what it is intended to change |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Amadeus Support | ||
|
||
Our [developer support team](https://developer.amadeus.com/developers) is here to help you. You can find us on [Twitter](#), [StackOverflow](#), and [email](#). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Changelog | ||
|
||
## 1.0.0 - 2017-12-01 | ||
|
||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
The MIT License (MIT) | ||
Copyright (c) 2018 Amadeus IT Group SA | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated | ||
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the | ||
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit | ||
persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the | ||
Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE | ||
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR | ||
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Amadeus Node SDK | ||
|
||
[][gem] | ||
[][travis] | ||
[][support] | ||
|
||
Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations and more. | ||
|
||
For more details see the [Node documentation](https://developer.amadeus.com/docs/node) on [Amadeus.com](https://developer.amadeus.com). | ||
|
||
## Installation | ||
|
||
This gem requires Node 2.2+. You can install install it directly or via bundler. | ||
|
||
```node | ||
gem install 'amadeus' | ||
``` | ||
|
||
__Next__: [Get Started with the Node SDK.](https://developer.amadeus.com/docs/node/get_started/initialize) | ||
|
||
## Getting Started | ||
|
||
To send make your first API call you will need to [register for an Amadeus Developer Account](https://developer.amadeus.com/register) and [set up your first application](https://dashboard.developer.amadeus.com/applications). | ||
|
||
```node | ||
require 'amadeus' | ||
|
||
amadeus = Amadeus::Client.new({ | ||
client_id: '[YOUR_CLIENT_ID]', | ||
client_secret: '[YOUR_CLIENT_SECRET]' | ||
}) | ||
|
||
amadeus.reference_data.locations.get({ keyword: 'Lon' }) | ||
#=> Returns a list of locations (Airport ad City codes) | ||
# that match this string in some way | ||
``` | ||
|
||
__Next__: [Learn more about Locations](https://developer.amadeus.com/docs/node/get_started/locations) with our Node SDK. | ||
|
||
## Initialization | ||
|
||
The client can be initialized directly or via environment variables. | ||
|
||
```node | ||
# Initialize using parameters | ||
amadeus = Amadeus::Client.new(client_id: '...', client_secret: '...') | ||
|
||
# Alternative: Initialize using environment variables | ||
# * AMADEUS_CLIENT_ID | ||
# * AMADEUS_CLIENT_SECRET | ||
amadeus = Amadeus::Client.new | ||
``` | ||
|
||
Your credentials can be found on the [Amadeus dashboard](https://dashboard.developer.amadeus.com/client_ids). [Sign up](https://developer.amadeus.com/register) for an account today. | ||
|
||
__Next__: [Learn more about our initializing the Node SDK](https://developer.amadeus.com/docs/node/get_started_initialize) in our documentation. | ||
|
||
## Logging & Debugging | ||
|
||
The SDK makes it easy to add your own logger. | ||
|
||
```node | ||
amadeus = Amadeus::Client.new( | ||
client_id: '...', | ||
client_secret: '...', | ||
logger: MyOwnLogger.new | ||
) | ||
``` | ||
|
||
Additionally, to enable more verbose logging, you can set the appropriate level either via a parameter on initialization, or using the `AMADEUS_LOG_LEVEL` environment variable. | ||
|
||
```node | ||
amadeus = Amadeus::Client.new( | ||
client_id: '...', | ||
client_secret: '...', | ||
log_level: 1 # defaults to silent, 0 | ||
) | ||
``` | ||
|
||
## Documentation | ||
|
||
Amadeus has a large set of APIs, and our documentation is here to get you started today. | ||
|
||
* [Get Started](https://developer.amadeus.com/docs/node/get_started) documentation | ||
* [Initialize the SDK](https://developer.amadeus.com/docs/node/get_started/initialize) | ||
* [Find an Airport](https://developer.amadeus.com/docs/node/get_started/find_an_airport) | ||
* [Book a Flight](https://developer.amadeus.com/docs/node/get_started/book_a_flight) | ||
* [Get Flight Inspiration](https://developer.amadeus.com/docs/node/get_started/get_flight_inspiration) | ||
|
||
Alternatively, head over to our [Reference](https://developer.amadeus.com/docs/node/reference) documentaton for in-depth information about every SDK method, it's arguments and return types. | ||
|
||
## License | ||
|
||
This library is released under the [MIT License](LICENSE). | ||
|
||
## Help | ||
|
||
Our [developer support team](https://developer.amadeus.com/developers) is here to help you. You can find us on [Twitter](#), [StackOverflow](#), and [email](#). | ||
|
||
[gem]: https://nodegems.org/gems/amadeus-node | ||
[travis]: http://travis-ci.org/amadeus-node | ||
[support]: http://developer.amadeus.com/support |