diffbot 0.1.0 → 0.1.1

data/README.md

@@ -2,6 +2,12 @@
 
 This is a ruby client for the [Diffbot](http://diffbot.com) API.
 
+## Install
+
+Get the latest version from RubyGems:
+
+    $ gem install diffbot
+
 ## Global Options
 
 You can pass some settings to Diffbot like this:
@@ -30,7 +36,7 @@ The list of supported settings is:
 In order to fetch an article, do this:
 
 ``` ruby
-require "diffbot/article"
+require "diffbot"
 
 article = Diffbot::Article.fetch(article_url, diffbot_token)
 
@@ -74,7 +80,7 @@ end
 In order to fetch and analyze a front page, do this:
 
 ``` ruby
-require "diffbot/frontpage"
+require "diffbot"
 
 frontpage = Diffbot::Frontpage.fetch(url, diffbot_token)
 

data/diffbot.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "diffbot"
-  s.version     = "0.1.0"
+  s.version     = "0.1.1"
   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"]

data/lib/diffbot.rb

@@ -34,6 +34,15 @@ module Diffbot
     @article_defaults
   end
 
+  # Public: Reset the configuration to the defaults. Useful for testing.
+  #
+  # Returns nil.
+  def self.reset!
+    @article_defaults = nil
+    @token = nil
+    @instrumentor = nil
+  end
+
   class << self
     # Public: Your Diffbot API token.
     attr_accessor :token

data/lib/diffbot/article.rb

@@ -1,6 +1,4 @@
 require "yajl"
-require "diffbot"
-require "diffbot/coercible_hash"
 
 module Diffbot
   # Representation of an article (ie a blog post or similar). This class offers

data/lib/diffbot/frontpage.rb

@@ -1,5 +1,4 @@
 require "nokogiri"
-require "diffbot"
 require "diffbot/item"
 
 module Diffbot

data/lib/diffbot/frontpage/dml_parser.rb

@@ -31,10 +31,10 @@ class Diffbot::Frontpage::DmlParser
     attrs = {}
 
     info = dml % "info"
-    attrs["title"]      = (info % "title").text
-    attrs["icon"]       = (info % "icon").text
-    attrs["sourceType"] = (info % "sourceType").text
-    attrs["sourceURL"]  = (info % "sourceURL").text
+    attrs["title"]      = extract_text(info, "title")
+    attrs["icon"]       = extract_text(info, "icon")
+    attrs["sourceType"] = extract_text(info, "sourceType")
+    attrs["sourceURL"]  = extract_text(info, "sourceURL")
 
     items = dml / "item"
     attrs["items"] = items.map do |item|
@@ -44,9 +44,18 @@ class Diffbot::Frontpage::DmlParser
     attrs
   end
 
+  def extract_text(node, selector)
+    tag = node % selector
+    tag && tag.text
+  end
+
   # Parser that takes the XML from a particular item from the XML returned from
   # the frontpage API.
   class ItemParser
+    def self.parse(node)
+      node = Nokogiri(node)
+    end
+
     # The root element of each item.
     attr_reader :item
 

data/lib/diffbot/request.rb

@@ -2,14 +2,25 @@ require "excon"
 
 module Diffbot
   class Request
+    class << self
+      # Public: Whether we are in test mode or not (so we stub out HTTP calls).
+      # Defaults to false.
+      attr_accessor :testing
+    end
+
+    self.testing = false
+
     # The API token for Diffbot.
     attr_reader :token
 
     # Public: Initialize a new request to the API.
     #
-    # token - The API token for Diffbot.
-    def initialize(token)
+    # token     - The API token for Diffbot.
+    # test_mode - Whether requests are in test mode or not. This is passed to
+    #             Excon so we can mock connections.
+    def initialize(token, test_mode=self.class.testing)
       @token = token
+      @test_mode = test_mode
     end
 
     # Public: Perform an HTTP request against Diffbot's API.
@@ -26,8 +37,7 @@ module Diffbot
       request_options = build_request(method, query)
       yield request_options if block_given?
 
-      request  = Excon.new(endpoint)
-
+      request = Excon.new(endpoint)
       request.request(request_options)
     end
 
@@ -39,7 +49,7 @@ module Diffbot
     # Returns a Hash.
     def build_request(method, query_params={})
       query   = { token: token }.merge(query_params)
-      request = { query: query, method: method, headers: {} }
+      request = { query: query, method: method, headers: {}, mock: @test_mode }
 
       if Diffbot.instrumentor
         request.update(

data/test/article_test.rb

@@ -0,0 +1,45 @@
+require "test_helper"
+require "uri"
+
+describe Diffbot::Article do
+  describe ".fetch" do
+    before do
+      path = URI.parse(Diffbot::Article.endpoint).path
+
+      Excon.stub(method: :get, path: path) do |params|
+        body = { title: "The Title" }
+        body[:tags] = %w(tag1 tag2) if params[:query]["tags"]
+        body = Yajl::Encoder.encode(body)
+
+        { body: body, status: 200 }
+      end
+    end
+
+    it "returns a new Article" do
+      article = Diffbot::Article.fetch("http://example.org")
+      article.must_be_instance_of(Diffbot::Article)
+    end
+
+    it "sets the parameters as received from the API" do
+      article = Diffbot::Article.fetch("http://example.org")
+      article.title.must_equal("The Title")
+    end
+
+    it "can be configured by passing a block" do
+      article = Diffbot::Article.fetch("http://example.org") do |req|
+        req.tags = true
+        req.must_be_instance_of(Diffbot::Article::RequestParams)
+      end
+      article.tags.must_equal(["tag1", "tag2"])
+    end
+
+    it "will take the default configuration" do
+      Diffbot.article_defaults do |req|
+        req.tags = true
+      end
+
+      article = Diffbot::Article.fetch("http://example.org")
+      article.tags.wont_be_nil
+    end
+  end
+end

data/test/coercible_hash_test.rb

@@ -1,5 +1,4 @@
 require "test_helper"
-require "diffbot/coercible_hash"
 
 describe Diffbot::CoercibleHash do
   module Foo

data/test/request_test.rb

@@ -0,0 +1,69 @@
+require "test_helper"
+
+describe Diffbot::Request do
+  subject do
+    Diffbot::Request.new("DUMMY_TOKEN")
+  end
+
+  describe "#build_request" do
+    after do
+      Diffbot.instrumentor = nil
+    end
+
+    it "includes the method" do
+      req = subject.build_request(:get)
+      req[:method].must_equal(:get)
+    end
+
+    it "incldues the token in the query string" do
+      req = subject.build_request(:get)
+      req[:query][:token].must_equal("DUMMY_TOKEN")
+    end
+
+    it "includes passed-in query parameters in the query string" do
+      req = subject.build_request(:get, a: 1, b: 2)
+
+      req[:query].must_include(:a, :b)
+      req[:query][:a].must_equal(1)
+      req[:query][:b].must_equal(2)
+    end
+
+    it "sets an empty header hash so we can set headers afterwards" do
+      req = subject.build_request(:get)
+      req[:headers].must_equal({})
+    end
+
+    it "passes the instrumentor if present" do
+      Diffbot.instrumentor = instrumentor = Object.new
+      req = subject.build_request(:get)
+      req[:instrumentor].must_equal(instrumentor)
+      req[:instrumentor_name].must_equal("diffbot")
+    end
+  end
+
+  describe "#perform" do
+    before do
+      Excon.stub(method: :get) do |params|
+        body = params[:query].key?(:a) ? "Hello, A" : "Hello"
+        { body: body, status: 200 }
+      end
+    end
+
+    it "returns the raw response" do
+      response = subject.perform(:get, "http://example.org")
+      response.body.must_equal("Hello")
+    end
+
+    it "can pass query parameters" do
+      response = subject.perform(:get, "http://example.org", a: 1)
+      response.body.must_equal("Hello, A")
+    end
+
+    it "can modify the request" do
+      response = subject.perform(:get, "http://example.org") do |req|
+        req[:query][:a] = 1
+      end
+      response.body.must_equal("Hello, A")
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,2 +1,15 @@
 require "minitest/spec"
 require "minitest/autorun"
+require "diffbot"
+
+begin
+  require "purdytest"
+rescue LoadError
+  # Oh well, no colorized tests for you. You can always use minitest/pride if
+  # you want :P
+end
+
+MiniTest::Unit::TestCase.add_setup_hook do
+  Diffbot::Request.testing = true
+  Diffbot.reset!
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diffbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-06 00:00:00.000000000 Z
+date: 2012-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
-  requirement: &70280593864880 !ruby/object:Gem::Requirement
+  requirement: &70220474094100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70280593864880
+  version_requirements: *70220474094100
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70280593864420 !ruby/object:Gem::Requirement
+  requirement: &70220474093520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70280593864420
+  version_requirements: *70220474093520
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70280593864000 !ruby/object:Gem::Requirement
+  requirement: &70220474092960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70280593864000
+  version_requirements: *70220474092960
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70280593863580 !ruby/object:Gem::Requirement
+  requirement: &70220474092340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70280593863580
+  version_requirements: *70220474092340
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70280593863160 !ruby/object:Gem::Requirement
+  requirement: &70220474091460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70280593863160
+  version_requirements: *70220474091460
 description: Diffbot provides a concise API for analyzing and extracting semantic
   information from web pages using Diffbot (http://www.diffbot.com).
 email: hi@nicolassanguinetti.info
@@ -85,7 +85,9 @@ files:
 - lib/diffbot/frontpage/dml_parser.rb
 - lib/diffbot/item.rb
 - lib/diffbot/request.rb
+- test/article_test.rb
 - test/coercible_hash_test.rb
+- test/request_test.rb
 - test/test_helper.rb
 homepage: http://github.com/tinder/diffbot
 licenses: []