Code Monkey home page Code Monkey logo

gobble-gem's Introduction

Gobble-Gem

Build Status Code Climate Test Coverage

Features

Ruby gem to interface with the Gobble-It API. API available at http://g-it.herokuapp.com/api.

It allows you create URLs by passing in parameters while running the gem.

Limitations

Currently, the gem only allows you create URLs. It does not let you obtain your user details or any other information.

Installation

To install, execute:

$ gem install gobble

Usage

$ gobble -f [full_url] (-s [short_url]) -k [api_key] (--save)

Options in round brackets are optional.

Arguments

$ -f full_url 

Full_url represents full_url to be shortened

$ -s short_url 

Short_url represents custom short link. Optional. If not passed in, a unique one is generated)

$ -k api_key  		

Api_key gotten from user account. Sign up on http://g-it.heroku.com for yours.)

$ --save	   

To save api key on your PC.)

$ -h

To show help message)

Testing

To test the application, run the following command to carry out all tests:

    $ bundle exec rake spec

To view test descriptors, run the following command:

    $ bundle exec rake spec -fd

Contributing

  1. Fork it by visiting - https://github.com/andela-toduah/gobble-gem/fork

  2. Create your feature branch

     $ git checkout -b new_feature
    
  3. Contribute to code

  4. Commit changes made

     $ git commit -a -m 'descriptive_message_about_change'
    
  5. Push to branch created

     $ git push origin new_feature
    
  6. Then, create a new Pull Request

gobble-gem's People

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

rahdio

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.