airvend 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8779b413dd8f8efb5b0263e161814e671b914b7f2ecc990ec7d080da399ab1f
+  data.tar.gz: fd7d73d444c292622545c441fc78d614caa0e53bce738481ea4be72929335fb7
+SHA512:
+  metadata.gz: 3bc28beb95fe5066f3e7ef75b3af9e3210c96eeaa4996630f12871b96df848d2c7da7a7f839fb0cd2ba94250b5bd94ef8db05a26e5c7d1eb245b0b2d45d0b355
+  data.tar.gz: '092aabc5563547b77e0208a78384fa1fabf2817bc33ce189983eddf96241b2e4d062aa1756a2aaecfe7994b7dd686ae8923bc2a3e76c2e4b891ba64f58c9e5d3'

data/.byebug_history

@@ -0,0 +1,19 @@
+exit
+underscorelize(a.to_s)
+a.to_s
+a
+underscorelize(a)
+a
+hash
+c
+exit
+self.airvendObj
+self
+self.
+@airvendObj
+exit
+input
+input[:mno]
+input['mno']
+input['mno']]
+input

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 14131938+urchymanny@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in airvend.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,148 @@
+PATH
+  remote: .
+  specs:
+    airvend (0.1.0)
+      faraday (~> 1.4)
+      faraday-detailed_logger (~> 2.3)
+      httparty (~> 0.18)
+      json (~> 2.5)
+      typhoeus (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.1.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    dotenv-rails (2.7.6)
+      dotenv (= 2.7.6)
+      railties (>= 3.2)
+    erubi (1.10.0)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-detailed_logger (2.3.0)
+      faraday (>= 0.8, < 2)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    ffi (1.15.1)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    loofah (2.10.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nokogiri (1.11.7-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    thor (1.1.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  airvend!
+  byebug
+  dotenv-rails
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Uchenna Mba
+
+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.

data/README.md

@@ -0,0 +1,346 @@
+# Airvend Ruby
+
+This gem makes it easy for businesses or individuals to implement vending of Airtime, Data, Electricity, Utilities & Television subscriptions to their application. This is a simplifiication of the [Airvend](https://airvend.ng) API
+
+### Documentation
+
+See [Here](https://documenter.getpostman.com/view/6349852/SVSHrpfv) for Airvend REST API Docs.
+
+To use this resource, you would need to register on the [Airvend B2B](https://business.airvend.ng/) to get access to personal test API Keys or contact me hey@uche.io
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'airvend'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install airvend
+
+## Usage
+
+### Initialization
+
+#### Instantiate Airvend object in sandbox with environment variable:
+
+To use the Airvend Gem, you need to instantiate the Airvend class with your credentials including your Username, Password & API Key. Best practice requires you to add your credentials to your Environment Variables `AIRVEND_USERNAME`, `AIRVEND_PASSWORD` & `AIRVEND_API_KEY`. You can call the new method on the Airvend Class afterwards
+
+```ruby
+airvend = Airvend.new
+```
+
+ 
+
+you can also call the class with your credentials without Environment Variables pre set
+
+```ruby
+airvend = Airvend.new("YOUR-AIRVEND-USERNAME", "YOUR-AIRVEND-PASSWORD", "YOUR-AIRVEND-API-KEY")
+```
+
+Expect a `AirvendBadUserError`, `AirvendBadPassError`, or `AirvendBadKeyError` if the username, password or API key is missing or invalid respectively.
+
+#### NOTE: It is best practice to always set your API keys to your environment variable for security purpose. Please be warned not use this package without setting your API keys in your environment variables in production.
+
+ 
+
+## Airvend Objects
+
+- [VEND](#vend)
+  - [Airtime Vending - Vend::Airtime.new(airvend)](#airtime-vending)
+  - [Internet Data Vending - Vend::InternetData.new(airvend)](#internet-data-vending)
+  - [Electricity Vending - Vend::Power.new(airvend)](#electricity-vending)
+  - [TV Vending - Vend::Television](#tv-vending)
+
+# VEND
+
+To vend different services, you have access to the different classes for the different services
+
+ 
+
+## Airtime Vending
+
+To vend airtime, you need to instantiate the Airtime Class with the [`airvend`](#instantiate-airvend-object-in-sandbox-with-environment-variable) object
+
+```ruby
+airtime = Vend::Airtime.new(airvend)
+```
+
+ 
+
+To purchase airtime for a phone number that is registered with any of the NCC licensed mobile networks `MTN`, `GLO`, `AIRTEL`, `9MOBILE` you can utilize the method below
+
+First, we need to provide the required data in the payload
+
+```ruby
+payload =  { 
+	ref: "YOUR-OWN-REF-HERE", 
+	phone: "08138236694", 
+	mno: "mtn", # can also be `glo`, `airtel` or `9mobile`
+	amount: "200"
+}
+```
+
+ 
+
+Next, we call the method to process the airtime purchase as shown below
+
+```ruby
+airtime.buy(payload)
+```
+
+ 
+
+## Internet Data Vending
+
+To vend Internet data subscriptions, you need to instantiate the `Internet` Class with the [`airvend`](#instantiate-airvend-object-in-sandbox-with-environment-variable) object
+
+```ruby
+internet = Vend::Internet.new(airvend)
+```
+
+ 
+
+To purchase internet data for a phone number that is registered with any of the NCC licensed mobile networks `MTN`, `GLO`, `AIRTEL`, `9MOBILE` you can utilize the method below
+
+First, we need to fetch a list of available internet data plans for the selected mobile network with the payload
+
+```ruby
+internet_plans = internet.plans("mtn") # can also be `glo`, `airtel` or `9mobile`
+```
+
+  
+
+This return an array of hashes with each containing a data plan in the format
+
+```ruby
+[
+  ...
+  {
+    :description=>"350MB", 
+    :amount=>"300", 
+    :code=>"300", 
+    :validity=>" for 7 Days"
+	}
+  ...
+]
+```
+
+#### Note the `code` is an identifier for the plan and is different from the amount
+
+ 
+
+Next, you can proceed to purchase the selected internet data plan with the payload
+
+```ruby
+payload =  { 
+	ref: "YOUR-OWN-REF-HERE", 
+	phone: "08138236694", 
+	mno: "mtn", # can also be `glo`, `airtel` or `9mobile`
+	code: "200" # this is code from the selected internet data plan from the list of data plans 
+  }
+```
+
+ 
+
+then we can proceed to make subscription after charging customer or your app user
+
+```ruby
+internet.buy(payload)
+```
+
+ 
+
+## Electricity Vending
+
+To vend Electricity Bills, you need to instantiate the `Power` Class with the [`airvend`](#instantiate-airvend-object-in-sandbox-with-environment-variable) object
+
+```ruby
+power = Vend::Power.new(airvend)
+```
+
+ 
+
+Before paying for electricity bills, it's important to confirm the customers details before proceeding
+
+```ruby
+payload = {
+  account: "45701113131", #this is the customers meter number
+  provider: "aedc",
+  account_type: "prepaid" # can also be "postpaid"
+}
+```
+
+ 
+
+the following providers are supported:
+
+- `aedc` for Abuja Electricity Distribution Company
+- `ie` for Ikeja Electricity
+- `eko` for Eko Distribution
+- `phed` for Port Harcourt Electricity Distribution
+- `eedc` for Enugu Electricity Distribution Company
+- `kedco` for Kaduna Electricity Distribution Company
+- `ibedc` for Ibadan Electricity Distribution Company
+
+ 
+
+To get the customer details, use the `verify` method
+
+````ruby
+customer = power.verify(payload)
+````
+
+which returns:
+
+``` ruby
+{
+  :name=>"OLUWAFEMI ODIGIE",
+  :accountstatus=>"OPEN",
+  :customernumber=>"BA36F4AEF88763454678BF9D1A85E4AE6F166CECA01DE4B58C1100DA3DA87362A6CBD3410E2B7F809C1A33E1AD6756BBA853F4C0275270B398BC69E8AC050E75|eyJwcm9kdWN0IjoiUE9SVEhBUkNPVVJURUxFQ1RSSUNJVFkiLCJ0eXBlIjoiUFJFUEFJRCIsImFjY291bnQiOiIwMTI0MDAxMjQ3Njk5IiwibmFtZSI6IkVzIE9tYWNoaSIsImFkZHJlc3MiOiJOTyA2NSBXb2ppIFJkIE5PIDY1IFdvamkgUmQiLCJ0YXJyaWYiOiJSMiIsImFycmVhcnMiOiIwIiwicGhvbmUiOiIiLCJtZXRlck51bWJlciI6IjAxMjQwMDEyNDc2OTkiLCJjdXN0b21lck51bWJlciI6IjgxNDE3MDIyODMwMSIsInRvdGFsQmlsbCI6IjAiLCJpYmNOYW1lIjoiR2FyZGVuIENpdHkgSW5kdXN0cmlhbCIsImJzY05hbWUiOiJSdW11b2diYSJ9",
+  :account=>"7021959296",
+  :customeraccounttype=>""
+}
+```
+
+ 
+
+Finally, to purchase power for the verified customer, you would prepare a payload using the customer number that is gotten from the `verify` method 
+
+``` ruby
+payload =  {
+	ref: "YOUR-OWN-REF-HERE",
+	account: "02188019141", 
+	provider: "aedc",
+	amount: "2000",
+	customernumber:"BA36F4AEF88763454678BF9D1A85E4AE6F166CECA01DE4B58C1100DA3DA87362A6CBD3410E2B7F809C1A33E1AD6756BBA853F4C0275270B398BC69E8AC050E75|eyJwcm9kdWN0IjoiUE9SVEhBUkNPVVJURUxFQ1RSSUNJVFkiLCJ0eXBlIjoiUFJFUEFJRCIsImFjY291bnQiOiIwMTI0MDAxMjQ3Njk5IiwibmFtZSI6IkVzIE9tYWNoaSIsImFkZHJlc3MiOiJOTyA2NSBXb2ppIFJkIE5PIDY1IFdvamkgUmQiLCJ0YXJyaWYiOiJSMiIsImFycmVhcnMiOiIwIiwicGhvbmUiOiIiLCJtZXRlck51bWJlciI6IjAxMjQwMDEyNDc2OTkiLCJjdXN0b21lck51bWJlciI6IjgxNDE3MDIyODMwMSIsInRvdGFsQmlsbCI6IjAiLCJpYmNOYW1lIjoiR2FyZGVuIENpdHkgSW5kdXN0cmlhbCIsImJzY05hbWUiOiJSdW11b2diYSJ9" #data contained in the response from verify customer method
+}
+```
+
+The `customernumber` is contained in the response from the `verify` method
+
+ 
+
+Next, to process the power purchase, use the method below on the provided payload
+
+```ruby
+power.buy(payload)
+```
+
+ 
+
+## TV Vending
+
+To vend TV Subscriptions like DStv & GoTv, you need to instantiate the `Television` Class with the [`airvend`](#instantiate-airvend-object-in-sandbox-with-environment-variable) object
+
+``` ruby
+tv = Vend::Television
+```
+
+ 
+
+Before paying for TV subscriptions, it's important to confirm the customers details before proceeding
+
+``` ruby
+payload = {
+  provider: "dstv",
+  account: "7021959296" # customer decoder iuc number
+}
+```
+
+ 
+
+To get the customer details, use the `verify` method
+
+``` ruby
+customer = tv.verify(payload)
+```
+
+which returns:
+
+``` ruby
+{
+  :name=>"OLUWAFEMI ODIGIE",
+  :accountstatus=>"OPEN",
+  :customernumber=>56920080,
+  :account=>"7021959296"
+}
+```
+
+ 
+
+Also, for processing TV Subscriptions, customers would be interested in selecting a subscription plan from their provider. You can get a list of available plans from each specific subscriber
+
+``` ruby
+tv_plans = tv.plans("dstv") # can also be `gotv`
+```
+
+This return an array of hashes with each containing a tv plans in the format
+
+```ruby
+[
+  ...
+  {
+    :description=>"DStv Compact",
+    :amount=> "7900", 
+    :code=>"COMPE36"
+	}
+  ...
+]
+```
+
+ 
+
+Finally, to subscribe to a tv plan for the verified customer, you would prepare a payload using the customer 
+
+``` ruby
+payload =  {
+	ref: "YOUR-OWN-REF-HERE",
+	account: "02188019141", 
+	provider: "aedc",
+  account_type: "prepaid",
+	amount: "2000",
+  customernumber: "56920080"
+}
+```
+
+ 
+
+next, to process the power purchase, use the method below on the provided payload
+
+```ruby
+tv.buy(payload)
+```
+
+ 
+
+## Transactions
+
+#### NOTE: This is currently not available.
+
+ 
+
+## 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 the created tag, 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/urchymanny/airvend-rails. 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/urchymanny/airvend-rails/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Airvend project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/urchymanny/airvend-rails/blob/master/CODE_OF_CONDUCT.md).
+