Sha256: 162399fade79632fc4a9411793a824218249997642275374875b2aed36299dbf

Contents?: true

Size: 1.16 KB

Versions: 6

Compression:

Stored size: 1.16 KB

Contents

#Synopsis

Ruby gem for using APIs, based on their Geekier API descriptions.

#Installation

##Gemfile

`gem "geekier_factory"`

##Standalone

`gem install geekier_factory`

#Usage

Download the API definition you want to use.

    require 'geekier_factory'
    
    # instanciate the api
    api = GeekierFactory.factorize('path/to/definition_file.json')
    
    # get a list of actions you can perform
    api.available_actions
    
    # select the action you want to perform
    action = api.available_actions[3]
    
    # check out what parameters are possible/necessary
    action.params
    
    # select an action and call it with its parameters
    action.call(:param1 => 'valueA', :param2 => 'valueB)

And that's how you do it.

#Participate

* fork && commit && send\_pull\_request
* add [more API definitions](https://github.com/rulesio/geekier)
* join the [Geekier Google group](https://groups.google.com/d/forum/geekier-apis)

#TODO

(in no particular order)

* Implement support for resources
* Parameter validations
* Support for Authentication/API level configuration 
* Add more descriptions
* Setup with all the cool testing and dependency checking solutions out there

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
geekier_factory-0.1.5 README.md
geekier_factory-0.1.4 README.md
geekier_factory-0.1.3 README.md
geekier_factory-0.1.2 README.md
geekier_factory-0.1.1 README.md
geekier_factory-0.1.0 README.md