Module: Diffbot
- Defined in:
- lib/diffbot.rb,
lib/diffbot/item.rb,
lib/diffbot/article.rb,
lib/diffbot/product.rb,
lib/diffbot/request.rb,
lib/diffbot/frontpage.rb,
lib/diffbot/items/product.rb,
lib/diffbot/coercible_hash.rb
Defined Under Namespace
Modules: CoercibleHash, Items Classes: Article, Frontpage, Item, Product, Request
Class Attribute Summary collapse
-
.instrumentor ⇒ Object
Public: The object used for network instrumentation.
-
.token ⇒ Object
Public: Your Diffbot API token.
Class Method Summary collapse
-
.article_defaults ⇒ Object
Public: Configure the default request parameters for Article requests.
-
.configure {|_self| ... } ⇒ Object
Public: Set global options.
-
.product_defaults ⇒ Object
Public: Configure the default request parameters for Product requests.
-
.reset! ⇒ Object
Public: Reset the configuration to the defaults.
Class Attribute Details
.instrumentor ⇒ Object
Public: The object used for network instrumentation. Must match ActiveSupport::Notifications API.
72 73 74 |
# File 'lib/diffbot.rb', line 72 def instrumentor @instrumentor end |
.token ⇒ Object
Public: Your Diffbot API token.
68 69 70 |
# File 'lib/diffbot.rb', line 68 def token @token end |
Class Method Details
.article_defaults ⇒ Object
Public: Configure the default request parameters for Article requests. See Article::RequestParams documentation for the specific configuration values you can set.
Yields the default Article::RequestParams object.
Returns the default Article::RequestParams object.
27 28 29 30 31 32 33 34 35 36 |
# File 'lib/diffbot.rb', line 27 def self.article_defaults if block_given? @article_defaults = Article::RequestParams.new yield @article_defaults else @article_defaults ||= Article::RequestParams.new end @article_defaults end |
.configure {|_self| ... } ⇒ Object
Public: Set global options. This is a nice API to group calls to the Diffbot module.
Yields the Diffbot module so you can set options on it.
Returns self.
15 16 17 18 |
# File 'lib/diffbot.rb', line 15 def self.configure yield self self end |
.product_defaults ⇒ Object
Public: Configure the default request parameters for Product requests. See Product::RequestParams documentation for the specific configuration values you can set.
Yields the default Product::RequestParams object.
Returns the default Product::RequestParams object.
45 46 47 48 49 50 51 52 53 54 |
# File 'lib/diffbot.rb', line 45 def self.product_defaults if block_given? @product_defaults = Product::RequestParams.new yield @product_defaults else @product_defaults ||= Product::RequestParams.new end @product_defaults end |
.reset! ⇒ Object
Public: Reset the configuration to the defaults. Useful for testing.
Returns nil.
59 60 61 62 63 64 |
# File 'lib/diffbot.rb', line 59 def self.reset! @product_defaults = nil @article_defaults = nil @token = nil @instrumentor = nil end |