Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/benweissmann/3taps-ruby-client

A Ruby gem for accessing the 3taps API.
https://github.com/benweissmann/3taps-ruby-client

Last synced: 29 days ago
JSON representation

A Ruby gem for accessing the 3taps API.

Host: GitHub
URL: https://github.com/benweissmann/3taps-ruby-client
Owner: benweissmann
License: mit
Created: 2012-07-21T22:38:25.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2012-07-22T03:17:14.000Z (over 12 years ago)
Last Synced: 2024-10-28T13:10:37.397Z (2 months ago)
Language: Ruby
Homepage: http://developers.3taps.net
Size: 316 KB
Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.rdoc
- License: LICENSE.txt

Awesome Lists containing this project

README

= threetaps-client

== Installation

== Usage

=== Search

To perform a search you need to
1. create SearchRequest object and fill its attributes

request = SearchRequest.new

request.rpp = 10

request.text = "porsche"

2. create SearchClient object

client = SearchClient.new

3. call search method on client with request as a parameter and get an SearchResponse object.

response = client.search(request)

4. now you can operate with search results:

postings = response.results

quantity = response.num_results

execution_time = response.exec_time_ms

== Contributing to threetaps-client

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.