diffbot 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffdaf63580cbe142861ae566176c1ae64540f3aa
-  data.tar.gz: 804948072bb5b6ab792ada3680c899938fde6d3a
+  metadata.gz: 35d6b7f9cfea3baed8bce0a8f4c858ecd9aa6329
+  data.tar.gz: a9276c70d867748eb8be81cb9dd14d6ef30bddd6
 SHA512:
-  metadata.gz: 1dfab96f3beb2a6e3c584760db87264c84da1161d8d73c9163fbe96e56e0cb81510561d971eb8753434881607890531453bc557af3873485a821fad9d918333d
-  data.tar.gz: 84e6cd2719109ddf3775ec860c22f3647124fc0f3bdde14093eb5a7e5b4e8636d5505b3f779298a0f1c7e88b0e00d8133cc1206e865ea175eac18780d711c115
+  metadata.gz: 19a67f552b510e4d3774c1594a8bb2a4712b4ffa996390a6d52d57ca84cd3b09fb6ac30847cddd05767ab910f05fde909d18bc5ec5454930ae05ac4d792623c2
+  data.tar.gz: 178401466e3697b83295c08773a583075592bc9bb75d5e701d7e3bd5a49f3536091ff2dd528614389797d11bca9d6c0ce7a03afd022d8308d3e7f14ad2f06b02

data/.travis.yml

@@ -2,6 +2,6 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
-  - rbx-19mode
+  - 2.0.0
 env:
   - RUBYOPT="$RUBYOPT -Itest"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diffbot (0.1.2)
+    diffbot (0.1.3)
       excon
       hashie
       nokogiri (~> 1.5.0)
@@ -21,6 +21,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.3)
   diffbot!
   minitest
   rake

data/README.md

@@ -1,6 +1,6 @@
 # Diffbot
 
-This is a ruby client for the [Diffbot](http://diffbot.com) API.
+This is a ruby client for the [Diffbot](http://diffbot.com) API. [![Build Status](https://travis-ci.org/greshny/diffbot.png?branch=master)](https://travis-ci.org/greshny/diffbot)
 
 ## Install
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "rake/testtask"
 require "rubygems/package_task"
+require "bundler/gem_tasks"
 
 gem_spec = eval(File.read("./diffbot.gemspec")) rescue nil
 Gem::PackageTask.new(gem_spec) do |pkg|

data/diffbot.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "diffbot"
-  s.version     = "0.1.2"
+  s.version     = "0.1.3"
   s.description = "Diffbot provides a concise API for analyzing and extracting semantic information from web pages using Diffbot (http://www.diffbot.com)."
   s.summary     = "Ruby interface to the Diffbot API "
   s.authors     = ["Nicolas Sanguinetti", "Roman Greshny"]
@@ -14,6 +14,6 @@ Gem::Specification.new do |s|
   s.add_dependency("yajl-ruby")
   s.add_dependency("nokogiri", "~> 1.5.0")
   s.add_dependency("hashie")
-
+  s.add_development_dependency("bundler", "~> 1.3")
   s.add_development_dependency("minitest")
 end

data/lib/diffbot.rb

@@ -3,6 +3,7 @@ require "diffbot/coercible_hash"
 require "diffbot/request"
 require "diffbot/article"
 require "diffbot/frontpage"
+require "diffbot/product"
 
 module Diffbot
   # Public: Set global options. This is a nice API to group calls to the Diffbot
@@ -34,10 +35,29 @@ module Diffbot
     @article_defaults
   end
 
+  # 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.
+  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
+
   # Public: Reset the configuration to the defaults. Useful for testing.
   #
   # Returns nil.
   def self.reset!
+    @product_defaults = nil
     @article_defaults = nil
     @token = nil
     @instrumentor = nil

data/lib/diffbot/items/product.rb

@@ -0,0 +1,63 @@
+module Diffbot
+  module Items
+    class Product < Hashie::Trash
+      extend CoercibleHash
+
+      # Name of the product. Returned by default.
+      property :title
+
+      # Description, if available, of the product. Returned by default.
+      property :description
+
+      # Identified offer or actual/'final' price of the product. Returned by default.
+      property :offer_price, from: :offerPrice
+
+      # A Diffbot-determined unique product ID.
+      # If upc, isbn, mpn or sku are identified on the page,
+      # productId will select from these values in the above order.
+      # Otherwise Diffbot will attempt to derive the best unique value for the product.
+      # Returned by default.
+      property :product_id,  from: :productId
+
+      # Item's availability, either true or false. Returned by default.
+      property :availability
+
+      class Details < Hashie::Trash
+        property :amount
+        property :text
+        property :symbol
+      end
+
+      property :offer_price_details, from: :offerPriceDetails
+      coerce_property :offer_price_details, class: Details
+
+      class Media < Hashie::Trash
+        # Only images. Returns "True" if image is identified as primary in terms of size
+        # or positioning.
+        property :primary
+
+        # Direct (fully resolved) link to image or video content.
+        property :link
+
+        # Diffbot-determined best caption for the image.
+        property :caption
+
+        # Type of media identified (image or video).
+        property :type
+
+        # Image height, in pixels.
+        property :height
+
+        # Image width, in pixels.
+        property :width
+
+        # Full document Xpath to the media item.
+        property :xpath
+      end
+
+      # Array of media items (images or videos) of the product. Returned by default.
+      property :media
+      coerce_property :media, collection: Media
+    end
+  end
+end

data/lib/diffbot/product.rb

@@ -0,0 +1,67 @@
+require 'yajl'
+require 'diffbot/items/product'
+
+module Diffbot
+  # Representation of a product. This class offers a single entry point: the
+  # `.fetch` method, that, given a URL, will return the front page as analyzed
+  # by Diffbot.
+  class Product < Hashie::Trash
+    extend CoercibleHash
+    # Public: The Product API analyzes a shopping or e-commerce product page
+    #         and returns information on the product.
+    #
+    # url      - Product URL to process (URL encoded).
+    # token    - The API token for Diffbot.
+    # parser   - The callable object that will parse the raw output from the
+    #            API. Defaults to Yajl::Parser.method(:parse).
+    # defaults - The default request options. See Diffbot.product_defaults.
+    #
+    # Yields the request configuration.
+    #
+    # Examples
+    #
+    #   # Request a product with the default options.
+    #   product = Diffbot::Product.fetch(url, api_token)
+    #
+    # Returns a Diffbot::Product
+    def self.fetch url, token=Diffbot.token, parser=Yajl::Parser.method(:parse), defaults=Diffbot.product_defaults
+      request = Diffbot::Request.new(token)
+      response = request.perform(:get, endpoint,{url: url, token: token})
+      new(parser.call(response.body))
+    end
+
+    def self.endpoint
+      'http://api.diffbot.com/v2/product'
+    end
+
+    class Breadcrumb < Hashie::Trash
+      property :name
+      property :link
+    end
+
+    # If available, an array of link URLs and link text from page breadcrumbs.
+    # Returned by default.
+    property :breadcrumb
+    coerce_property :breadcrumb, collection: Breadcrumb
+
+    property :date_created
+
+    property :leaf_page, from: :leafPage
+
+    property :error
+    property :error_code, from: :errorCode
+
+    property :type
+
+    property :offer_price_details, from: :offerPriceDetails
+
+
+    # Products array
+    property :products
+    coerce_property :products, collection: Items::Product
+
+    # URL submitted. Returned by default.
+    property :url
+    class RequestParams < Hashie::Trash; end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffbot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicolas Sanguinetti
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -67,6 +67,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,8 @@ files:
 - lib/diffbot/frontpage.rb
 - lib/diffbot/frontpage/dml_parser.rb
 - lib/diffbot/item.rb
+- lib/diffbot/items/product.rb
+- lib/diffbot/product.rb
 - lib/diffbot/request.rb
 - test/article_test.rb
 - test/coercible_hash_test.rb