Skip to content

Commit c38c1cc

Browse files
cbettacbetta
committed
Add template files
0 parents  commit c38c1cc

File tree

8 files changed

+275
-0
lines changed

8 files changed

+275
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+

‎.github/CONTRIBUTING.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## How to contribute to the Amadeus Node Client Library
2+
3+
#### **Did you find a bug?**
4+
5+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/amadeusdev/amadeus-node/issues).
6+
7+
* 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.
8+
9+
#### **Did you write a patch that fixes a bug?**
10+
11+
* Open a new GitHub pull request with the patch.
12+
13+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
14+
15+
#### **Do you intend to add a new feature or change an existing one?**
16+
17+
* Suggest your change [in a new issue](https://github.com/amadeusdev/amadeus-node/issues/new) and start writing code.
18+
19+
* Make sure your new code does not break any tests and include new tests.
20+
21+
* With good code comes good documentation. Try to copy the existing documentation and adapt it to your needs.
22+
23+
* Close the issue or mark it as inactive if you decide to discontinue working on the code.
24+
25+
#### **Do you have questions about the source code?**
26+
27+
* Ask any question about how to use the library by [raising a new issue](https://github.com/amadeusdev/amadeus-node/issues/new).
28+
29+
#### **Do you want to contribute to the documentation?**
30+
31+
Excellent, to get start developing this library ensure you have Node 2.2+ installed and clone the repository.
32+
33+
Then, you should be able to run the tests.
34+
35+
```sh
36+
bundle install # ensure all gems are installed
37+
bundle rake #run all tests
38+
```

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Description
2+
3+
[Describe the issue]
4+
5+
## Steps to Reproduce
6+
7+
1. [First step]
8+
2. [Second step]
9+
3. [and so on...]
10+
11+
__Expected Behavior:__ [What you expect to happen]
12+
13+
__Actual Behavior:__ [What actually happens]
14+
15+
__Stable Behavior?__ [What percentage of the time does it reproduce?]
16+
17+
## Versions
18+
19+
[What version of Node/NPM are you running? What Operating System are you on?]
20+
21+
## Checklist
22+
23+
Please make sure you checked the following:
24+
25+
* Are you running Node 2.2+?
26+
* Did you download the latest version of this gem?

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Fixes #
2+
3+
## Changes for this pull request
4+
5+
## Checklist
6+
7+
Remove this if you have done all of these:
8+
9+
* Ensure all tests pass and linting
10+
* Add any changes to the README
11+
* Add any changes or new comments to SDK methods
12+
* Ensure this PR only changes what it is intended to change

‎.github/SUPPORT.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Amadeus Support
2+
3+
Our [developer support team](https://developer.amadeus.com/developers) is here to help you. You can find us on [Twitter](#), [StackOverflow](#), and [email](#).

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## 1.0.0 - 2017-12-01
4+
5+
* Initial release

‎LICENSE‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
The MIT License (MIT)
2+
Copyright (c) 2018 Amadeus IT Group SA
3+
4+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
5+
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
6+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
7+
persons to whom the Software is furnished to do so, subject to the following conditions:
8+
9+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
10+
Software.
11+
12+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
13+
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
14+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
15+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Amadeus Node SDK
2+
3+
[![Gem Version](http://img.shields.io/gem/v/amadeus-node.svg)][gem]
4+
[![Build Status](http://img.shields.io/travis/amadeus-node.svg)][travis]
5+
[![Contact Support](https://img.shields.io/badge/contact-support-blue.svg)][support]
6+
7+
Amadeus provides a set of APIs for the travel industry. Flights, Hotels, Locations and more.
8+
9+
For more details see the [Node documentation](https://developer.amadeus.com/docs/node) on [Amadeus.com](https://developer.amadeus.com).
10+
11+
## Installation
12+
13+
This gem requires Node 2.2+. You can install install it directly or via bundler.
14+
15+
```node
16+
gem install 'amadeus'
17+
```
18+
19+
__Next__: [Get Started with the Node SDK.](https://developer.amadeus.com/docs/node/get_started/initialize)
20+
21+
## Getting Started
22+
23+
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).
24+
25+
```node
26+
require 'amadeus'
27+
28+
amadeus = Amadeus::Client.new({
29+
client_id: '[YOUR_CLIENT_ID]',
30+
client_secret: '[YOUR_CLIENT_SECRET]'
31+
})
32+
33+
amadeus.reference_data.locations.get({ keyword: 'Lon' })
34+
#=> Returns a list of locations (Airport ad City codes)
35+
# that match this string in some way
36+
```
37+
38+
__Next__: [Learn more about Locations](https://developer.amadeus.com/docs/node/get_started/locations) with our Node SDK.
39+
40+
## Initialization
41+
42+
The client can be initialized directly or via environment variables.
43+
44+
```node
45+
# Initialize using parameters
46+
amadeus = Amadeus::Client.new(client_id: '...', client_secret: '...')
47+
48+
# Alternative: Initialize using environment variables
49+
# * AMADEUS_CLIENT_ID
50+
# * AMADEUS_CLIENT_SECRET
51+
amadeus = Amadeus::Client.new
52+
```
53+
54+
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.
55+
56+
__Next__: [Learn more about our initializing the Node SDK](https://developer.amadeus.com/docs/node/get_started_initialize) in our documentation.
57+
58+
## Logging & Debugging
59+
60+
The SDK makes it easy to add your own logger.
61+
62+
```node
63+
amadeus = Amadeus::Client.new(
64+
client_id: '...',
65+
client_secret: '...',
66+
logger: MyOwnLogger.new
67+
)
68+
```
69+
70+
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.
71+
72+
```node
73+
amadeus = Amadeus::Client.new(
74+
client_id: '...',
75+
client_secret: '...',
76+
log_level: 1 # defaults to silent, 0
77+
)
78+
```
79+
80+
## Documentation
81+
82+
Amadeus has a large set of APIs, and our documentation is here to get you started today.
83+
84+
* [Get Started](https://developer.amadeus.com/docs/node/get_started) documentation
85+
* [Initialize the SDK](https://developer.amadeus.com/docs/node/get_started/initialize)
86+
* [Find an Airport](https://developer.amadeus.com/docs/node/get_started/find_an_airport)
87+
* [Book a Flight](https://developer.amadeus.com/docs/node/get_started/book_a_flight)
88+
* [Get Flight Inspiration](https://developer.amadeus.com/docs/node/get_started/get_flight_inspiration)
89+
90+
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.
91+
92+
## License
93+
94+
This library is released under the [MIT License](LICENSE).
95+
96+
## Help
97+
98+
Our [developer support team](https://developer.amadeus.com/developers) is here to help you. You can find us on [Twitter](#), [StackOverflow](#), and [email](#).
99+
100+
[gem]: https://nodegems.org/gems/amadeus-node
101+
[travis]: http://travis-ci.org/amadeus-node
102+
[support]: http://developer.amadeus.com/support

0 commit comments

Comments
 (0)