Giter VIP home page Giter VIP logo

streetfoodr's Introduction

Streetfoodr

Streetfoodr provides accress to Street Food App's REST API.

##Installation Install Streetfoodr

$ gem install streetfoodr

or add it to your Gemfile

gem 'streetfoodr'

##API Reference

The streetfoodapp api documentation is located here, but it's not totally accurate - in particular, there aren't actually any API keys required at this time and the locations GET url does not require a city.

##Examples of use

####Find all food trucks in a city

require 'streetfoodr'  

Streetfoodr::FoodTruck.get_city_trucks("boston")

####Find API identifier for a given food truck

require 'streetfoodr'  

Streetfoodr::FoodTruck.get_api_identifier_by_name("Stoked Wood Fired Pizza Co.", "boston")

####Find specific food truck's schedule

require 'streetfoodr'  

#API identifier, which is related to the name, but is usually not the same, then city
truck = Streetfoodr::FoodTruck.new("stoked", "boston")

truck.locations

####Find specific food truck's schedule from a past month/year

require 'streetfoodr'  

truck = Streetfoodr::FoodTruck.new("stoked", "boston")

#year, then number of month
truck.history(2013, 11)

##Contributing This gem is still in beta, so there's plenty of fine-tuning to be done. Anyone who wants to contribute is welcome! Feel free to fork the project, make your changes in a feature or bugfix branch, and send me a pull request. However, please make sure that any code you send me has comprehensive tests.

##Boilerplate This is release under the MIT license. I'm not affiliated with Street Food App, I just created this gem to help other developers work with their API.

streetfoodr's People

Contributors

rsid avatar

Watchers

James Cloos avatar  avatar

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.