class Juicer

Initialize the Juicer API client.

@param api_key [String] API key obtained from Apigee. @return [Juicer] the API client.

# File lib/juicer.rb, line 14
def initialize(api_key)
  @client = Juicer::Client.new(api_key)
end

Fetch an article by its CPS_ID

@param cps_id [String] the cps_id of an article. @return [Hash] the serialized article.

# File lib/juicer.rb, line 76
def article(cps_id)
  @client.request(:get, "articles/#{cps_id}")["article"]
end

Filter/find articles.

@note The results will include all entities of an article. Therefore, if

there are many results, the amount of data transferred is quite large.
Just a heads up when doing queries that potentially return a large number
of results.

@param opts [Hash] a Hash of filter options.

Possible keys are:

  * `text` - a search term, corresponds to Lucene syntax.
  * `product` - list of products to scope to. See {#products}.
  * `content_format` - list of content formats to scope to. See {#formats}.
  * `section` - list of sections to scope to. See {#sections}.
  * `site` - list of sites to scope to. See {#sites}.
  * `published_after` - only retrieve articles published after a certain
    date. The format is `yyyy-mm-dd`.
  * `published_before` - only retrieve articles published before a certain
    date. The format is `yyyy-mm-dd`.

@return [Array<Hash>] list of articles.

# File lib/juicer.rb, line 67
def articles(opts)
  @client.request(:get, "articles", opts)["articles"]
end

List content formats. @return [Array<String>] list of available content formats.

# File lib/juicer.rb, line 42
def formats
  @client.request(:get, "formats")["formats"]
end

List products. @return [Array<String>] list of available products.

# File lib/juicer.rb, line 35
def products
  @client.request(:get, "products")["products"]
end

List sections. @return [Array<String>] list of available section.

# File lib/juicer.rb, line 28
def sections
  @client.request(:get, "sections")["sections"]
end

Fetch articles related (similar) to an article. Uses tf-idf algorithm to find semantically similar documents.

@param cps_id [String] the `cps_id` of an article. @param opts [Hash] a Hash of query options.

Possible keys are:

  * `size` - how many results to return. Results are ordered by their
    "match" score, i.e how similar they are to a given article, and the
    top `size` results are returned.
  * `product` - a list of products to scope to. See {#products}.

@return [Array<Hash>] list of similar articles. Defaults to 10 most similar

across all products.

# File lib/juicer.rb, line 95
def similar_articles(cps_id, opts = {})
  @client.request(:get, "articles/#{cps_id}/similar", opts)["results"]
end

Fetch articles related (similar) to an arbitrary blob of text. Uses tf-idf algorithm to find semantically similar documents.

@param text [String] a blob of text. @param opts [Hash] a Hash of query options.

Possible keys are:

  * `size` - how many results to return. Results are ordered by their
    "match" score, i.e how similar they are to the given blob of text, and
    the top `size` results are returned.
  * `product` - a list of products to scope to. See {#products}.

@return [Array<Hash>] list of similar articles. Defaults to 10 most similar

across all products.

# File lib/juicer.rb, line 114
def similar_to(text, opts = {})
  body = { like_text: URI.encode(text) }.to_json
  @client.request(:post, "similar_to", opts, body)["results"]
end

List sites. @return [Array<String>] list of available sites.

# File lib/juicer.rb, line 21
def sites
  @client.request(:get, "sites")["sites"]
end