Add this line to your application's Gemfile:
And then execute:
Example rails usage
Requests are performed through a client object
client = ::.
Visitors to the application should be tagged with an anonymous user id
class ApplicationController before_filter do session[:attune_id] ||= attune_client.anonymous.create.id end private def attune_client @attune_client ||= . end end
The user id can be bound to a customer id at login
class SessionsController # ... def create # ... attune_customer = ::::.(customer: current_user.id) attune_client.anonymous.update(session[:attune_id], attune_customer) end end
The client can then perform rankings
class ProductsController def index @products = sorted(Product.all) end private def sorted products ranking_params = ::::. ranking_params.anonymous = session[:attune_id] ranking_params.view = request.fullpath ranking_params.entity_type = 'products' ranking_params.user_agent = request.env["HTTP_USER_AGENT"] ranking_params.ids = products.map(&:id) scope = ::::. scope.name = 'category' scope.value = 'pants' ranking_params.scope = [scope] ranking = attune_client.entities.get_rankings(ranking_params) products.sort_by do |product| ranking.ranking.index(product.id.to_s) end end end
The client provides a way to request a new auth_token through the API
client = ::. auth_token = client.get_auth_token('my-client-id', 'my-client-secret')
Also see Blacklist examples for examples of our blacklist API.
Attune can be configured globally
. do |c| c.auth_token = "my-secure-auth-token" c.endpoint = "http://example.com/" c.timeout = 5 end
Settings can also be overridden on a client object
client = ::.(auth_token: "my-secure-auth-token", timeout: 2)
How to identify attune vs control in the browser?
You can identify the cell assignment by fetching the data in the below variable # @attr [String] cell Cell assignment
For testing and development, the ranking API can be simulated using.
In this mode no API calls will be made, and rankings will be returned in their original order.
.test_mode! is equivalent to setting
disabled to true and
- Fork it ( http://github.com/attune-api/attune-ruby/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request