Project

lateral

0.0
No commit activity in last 3 years
No release in over 3 years
lateralnavinpeiris/lateralHomepageDocumentationSource CodeBug TrackerWiki
Ruby wrapper for lateral.io content recommendation API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,132
Stars
1
Forks
0
Watchers
2
 Releases
Current version
0.1.0
Total releases
1
First release
2015-06-04
Latest release
2015-06-04
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2016-11-22
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.9
guard-bundler
~> 2.1.0
guard-rspec
~> 4.5.0
guard-rubocop
~> 1.2.0
rake
~> 10.0
rspec
~> 3.2.0
rspec-its
~> 1.2.0
rubocop
~> 0.31.0
simplecov
~> 0.10.0
terminal-notifier
~> 1.6.2
terminal-notifier-guard
~> 1.6.4
webmock
~> 1.21.0

Runtime

httparty
~> 0.13.5
 Project Readme

Lateral

Ruby wrapper for lateral.io content recommendation service. For more information on methods allowed, returned codes etc, see the api docs.

Installation

Add this line to your application's Gemfile:

gem 'lateral'

And then execute:

$ bundle

Or install it yourself as:

$ gem install lateral

Usage

Get an API Key

You can get an API key from https://lateral.io/.

Use the service

text_matcher = Lateral::TextMatcher.new API_KEY

Available methods

NOTE: The hash-bang methods throws an error if the request failed while the non hash-bang methods return null

# Adding documents
text_matcher.add  document_id: 'document-id', text: 'document text'
text_matcher.add! document_id: 'document-id', text: 'document text'

# Deleting a document
text_matcher.delete  document_id: 'document-id'
text_matcher.delete! document_id: 'document-id'

# Delete all documents
text_matcher.delete_all
text_matcher.delete_all!

# Fetch a document
text_matcher.fetch  document_id: 'document-id'
text_matcher.fetch! document_id: 'document-id'

# List document ids
text_matcher.list
text_matcher.list!

# Recommend by id
text_matcher.recommend_by_id  document_id: 'document-id', records: 20
text_matcher.recommend_by_id! document_id: 'document-id', records: 20

# Recommend by text
text_matcher.recommend_by_text  text: 'some text', records: 20
text_matcher.recommend_by_text! text: 'some text', records: 20

# Update meta tags
text_matcher.update_meta  document_id: 'document-id', meta: 'meta-tags'
text_matcher.update_meta! document_id: 'document-id', meta: 'meta-tags'

# Update text
text_matcher.update_text  document_id: 'document-id', text: 'new document text'
text_matcher.update_text! document_id: 'document-id', text: 'new document text'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/navinpeiris/lateral/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request