Sha256: 867c0a4a93406be196f072d826253a8fa0c9ab0274f6eccfc0393be1340c0f51

Contents?: true

Size: 1.32 KB

Versions: 16

Compression:

Stored size: 1.32 KB

Contents

= 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.

== Copyright

Copyright (c) 2011 3taps.com. See LICENSE.txt for
further details.

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
threetaps-client-1.0.14 README.rdoc
threetaps-client-1.0.13 README.rdoc
threetaps-client-1.0.12 README.rdoc
threetaps-client-1.0.11 README.rdoc
threetaps-client-1.0.10 README.rdoc
threetaps-client-1.0.9 README.rdoc
threetaps-client-1.0.8 README.rdoc
threetaps-client-1.0.7 README.rdoc
threetaps-client-1.0.6 README.rdoc
threetaps-client-1.0.5 README.rdoc
threetaps-client-1.0.4 README.rdoc
threetaps-client-1.0.3 README.rdoc
threetaps-client-1.0.2 README.rdoc
threetaps-client-1.0.1 README.rdoc
threetaps-client-1.0.0 README.rdoc
threetaps-client-0.5.1 README.rdoc