Git Product home page Git Product logo

roomorama_api's Introduction

Build Status

RoomoramaApi

RoomoramaApi is a Ruby gem that wraps the Roomorama API V1.0 documented at https://roomorama.com/api.

For a step by step guide on getting started with Roomorama API, refer to https://roomorama.com/api/step_by_step.

This gem does not handle OAuth authentication or token generation. You may want to use https://github.com/intridea/omniauth and the Roomorama OAuth strategy at https://github.com/roomorama/omniauth-roomorama

Installation

Add this line to your application's Gemfile:

gem 'roomorama_api'

And then execute:

$ bundle

Usage

Currently this gem does not handle any oauth authentication yet. Host and Guest API calls are not support yet in this version.

Initialize a client

client = RoomoramaApi::Client.new

Initialize a client with OAuth token

client = RoomoramaApi::Client.new '<OAUTH TOKEN>'

Get all destinations

client.destinations_all

Search for properties/rooms

client.properties_find destination: 'singapore'
client.properties_find destination: 'singapore', order: 'title_asc'

Get data for a give property/room

client.properties_get_data 500, strip_html: 'false'

Make OAuth calls - get information about myself

client.user_me

Supported API Calls

destinations_all
properties_find
properties_get_data
properties_find_similar
properties_availabilities
properties_price_check
properties_reviews
favorites_list
favorites_create
favorites_delete
perks_list
perks_get_data
users_me
users_update_profile
users_get_data
users_register
users_reviews
host_properties_list
host_properties_show
host_properties_create
host_properties_update
host_availabilities_list
host_availabilities_update
host_inquiries_list
host_inquiries_show

Debugging

Turn on debug mode with

RoomoramaApi::Client.debug = true

Can't find the API Call you want?

Submit an issue or a pull request.

roomorama_api's People

Contributors

tmlee avatar lclemence 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.