zemanta_client 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # Zemanta
 
-This is a ruby client to awesome Zemanta app. At this point it only supports suggest_markup method and is tested on ruby 1.9.3.
+This is a ruby client to awesome Zemanta app. 
 
 ## Installation
 
@@ -16,7 +16,7 @@ Or install it yourself as:
 
     $ gem install zemanta_client
 
-## Usage
+## Api key
 
 You need to set api_key to use the client. If you won't do that, gem will raise an error. There are 2 ways:
   1. Environment variable
@@ -26,11 +26,19 @@ You need to set api_key to use the client. If you won't do that, gem will raise
     - You can set your api_key in configuration block like this:
     - Zemanta.configure { |c| c.api_key = 'your_api_key' } 
 
-After your api_key has been set, all you need to do is:
 
-    Zemanta.new("Text you want to send to Zemanta").suggest_markup
+## Usage
+
+  Two use cases are implemented: Retrieving suggest_markup data and enhancing the text.
+
+  1. Zemanta::Markup.fetch(text, opts = {})
+    It will fetch suggest_markup data for passed text from Zemanta api and wrap it in custom classes.
+
+  2. Zemanta::Enhancer.new(text, opts = {}).enhance
+    It will fetch suggest_markup data for given text and for every returned link it will wrap the keyword with this link.
+    Than it will return updated text.
 
-And you will be returned Markup object or error will be raised if Zemanta returns one.
+  In both relevance and confidence keys can be passes inside opts to filter any links that are below passed values.
 
 ## Configuration
 
@@ -65,5 +73,6 @@ And you will be returned Markup object or error will be raised if Zemanta return
 
 ## Changelog
 
+0.0.3 - Added Enhancer class, used yajl for json parsing, changed external gem api.
 0.0.2 - Got rid of autoloads.
 0.0.1 - Initial release. Support for suggest_markup method and caching.

data/lib/zemanta/cache/disk.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   module Cache
     class Disk
       attr_accessor :db

data/lib/zemanta/configuration/null_storage.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Configuration
     class NullStorage
       def [](key)

data/lib/zemanta/configuration.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Configuration
     attr_accessor :custom_request_opts, :format, :api_key, :cache_storage
 

data/lib/zemanta/enhancer.rb

@@ -0,0 +1,32 @@
+module Zemanta
+  class Enhancer
+    def initialize(text, opts = {})
+      @text = text
+      @opts = opts
+    end
+
+    def enhance
+      enhance!
+      @text
+    end
+
+    private
+
+    def enhance!
+      words_to_anchor(@opts).each do |dictionary|
+        link = "<a href=#{dictionary[:link]}>#{dictionary[:word]}</a>"
+        @text.gsub!(dictionary[:word], link)
+      end
+    end
+
+    def words_to_anchor(opts)
+      suggest_markup(opts).links.map do |link|
+        { word: link.anchor, link: link.target.first.url }
+      end
+    end
+
+    def suggest_markup(opts = {})
+      Markup.fetch(@text, opts)
+    end
+  end
+end

data/lib/zemanta/fetcher/cache/key.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Fetcher
     class Cache
       class Key

data/lib/zemanta/fetcher/cache/null_response.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Fetcher
     class Cache
       class NullResponse

data/lib/zemanta/fetcher/cache/response.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Fetcher
     class Cache
       class Response

data/lib/zemanta/fetcher/cache.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Fetcher
     class Cache
       def initialize(opts = {})

data/lib/zemanta/fetcher/parser.rb

@@ -0,0 +1,13 @@
+module Zemanta
+  class Fetcher
+    class Parser
+      def initialize(json)
+        @json = json
+      end
+
+      def parse
+        Yajl::Parser.parse(@json)
+      end
+    end
+  end
+end

data/lib/zemanta/fetcher/web.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Fetcher
     class Web
       def initialize(opts = {})

data/lib/zemanta/fetcher.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Fetcher
     def initialize(opts = {})
       @opts = opts
@@ -21,7 +21,7 @@ class Zemanta
     end
 
     def parse(data)
-      JSON.parse(data)
+      Parser.new(data).parse
     end
 
     def request_opts

data/lib/zemanta/markup/link/target.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Markup
     class Link
       class Target

data/lib/zemanta/markup/link.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Markup
     class Link
       attr_reader :relevance, :confidence, :entity_type, :target, :anchor

data/lib/zemanta/markup.rb

@@ -1,4 +1,4 @@
-class Zemanta
+module Zemanta
   class Markup
     attr_reader :text, :links
 
@@ -6,5 +6,31 @@ class Zemanta
       @text  = opts["text"]
       @links = opts["links"].map{ |link| Link.new(link) }
     end
+
+    def self.fetch(text, opts = {})
+      relevance  = opts.delete(:relevance)  || 0
+      confidence = opts.delete(:confidence) || 0
+
+      new(suggest_markup_request(text, opts)).tap do |markup|
+        markup.drop_links_below(relevance, confidence)
+      end
+    end
+
+    def drop_links_below(relevance, confidence)
+      @links.keep_if do |link|
+        link.above?(relevance, confidence)
+      end
+    end
+
+    private
+
+    def self.suggest_markup_request(text, opts)
+      return {'links' => []} if text.to_s.empty?
+      request({ text: text, method: "zemanta.suggest_markup" }.merge(opts))["markup"]
+    end
+
+    def self.request(opts)
+      Fetcher.new(opts).post
+    end
   end
 end

data/lib/zemanta/version.rb

@@ -1,3 +1,3 @@
-class Zemanta
-  VERSION = "0.0.2"
+module Zemanta
+  VERSION = "0.0.3"
 end

data/lib/zemanta.rb

@@ -1,30 +1,23 @@
 require 'typhoeus'
-require 'json'
+require 'yajl'
 require 'digest/md5'
 
-require 'zemanta/cache'
 require 'zemanta/cache/disk'
 require 'zemanta/configuration'
 require 'zemanta/configuration/null_storage'
 require 'zemanta/fetcher'
+require 'zemanta/fetcher/parser'
 require 'zemanta/fetcher/web'
 require 'zemanta/fetcher/cache'
 require 'zemanta/fetcher/cache/null_response'
 require 'zemanta/fetcher/cache/response'
 require 'zemanta/fetcher/cache/key'
 require 'zemanta/markup'
-require "zemanta/markup/link"
+require 'zemanta/markup/link'
 require 'zemanta/markup/link/target'
+require 'zemanta/enhancer'
 
-class Zemanta
-  def initialize(text)
-    @text = text
-  end
-
-  def suggest_markup(opts = {})
-    Markup.new(suggest_markup_request(opts))
-  end
-
+module Zemanta
   def self.configure
     yield config
   end
@@ -32,14 +25,4 @@ class Zemanta
   def self.config
     @configuration ||= Configuration.new
   end
-
-  private
-
-  def suggest_markup_request(opts)
-    @response ||= request({ text: @text, method: "zemanta.suggest_markup" }.merge(opts))['markup']
-  end
-
-  def request(opts)
-    Fetcher.new(opts).post
-  end
-end
+end

data/spec/fixtures/zemanta/enhancer.json

@@ -0,0 +1,37 @@
+{
+  "markup":{
+    "text":"",
+    "links":[
+      {
+        "relevance":0.91956,
+        "confidence":0.846373,
+        "entity_type":[
+
+        ],
+        "target":[
+          {
+            "url":"http://www.some.url/leading_to/inca_trail",
+            "type":"geolocation",
+            "title":"The Inca Trail"
+          }
+        ],
+        "anchor":"Inca trail to Machu Picchu"
+      },
+      {
+        "relevance":0.881943,
+        "confidence":0.878267,
+        "entity_type":[
+          "/location/location"
+        ],
+        "target":[
+          {
+            "url":"http://www.some.url/about/machu_picchu",
+            "type":"geolocation",
+            "title":"Machu Picchu"
+          }
+        ],
+        "anchor":"Machu Pichu"
+      }
+    ]
+  }
+}

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'zemanta'
 require 'webmock/rspec'
+require 'json'
 
 Zemanta.configure do |c|
   c.api_key = 'fake_key'
@@ -41,3 +42,8 @@ def stub_zemanta_exception!
   stub_request(:post, /api.zemanta.com/).
     to_return(:status => 200, :body => '<h1>403 Developer Inactive</h1>')
 end
+
+def stub_zemanta_enhancer!
+  stub_request(:post, /api.zemanta.com/).
+    to_return(:status => 200, :body => fixture("enhancer").to_json)
+end

data/spec/zemanta/cache/disk_spec.rb

@@ -37,7 +37,7 @@ describe Zemanta::Cache::Disk do
     let(:value) { 'text-value' }
 
     it "creates new file for specified key" do
-      Pathname.new(storage.db.join(key)).delete
+      Pathname.new(storage.db.join(key)).delete if storage.db.join(key).exist?
       Pathname.new(storage.db.join(key)).should_not exist
 
       storage[key] = value

data/spec/zemanta/enhancer_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Zemanta::Enhancer do
+  context "enhance" do
+    let(:input) { "Here be dragons: Inca trail to Machu Picchu, Machu Pichu" }
+
+    it "returns string" do
+      stub_zemanta_enhancer!
+      Zemanta::Enhancer.new(input).enhance.should be_a String
+    end
+
+    it "converts keywords to links" do
+      stub_zemanta_enhancer!
+      Zemanta::Enhancer.new(input).enhance.scan('<a').should have(2).elements
+    end
+  end
+end

data/spec/zemanta/integration/correct_response_spec.rb

@@ -5,7 +5,7 @@ describe "suggest_markup" do
     stub_zemanta_full!
   end
 
-  let(:markup) { Zemanta.new("some text").suggest_markup }
+  let(:markup) { Zemanta::Markup.fetch("some text") }
   
   it "responds to #text" do
     markup.text.should == "text"

data/spec/zemanta/integration/incorrect_api_key_spec.rb

@@ -2,7 +2,7 @@
 require 'spec_helper'
 
 describe "incorrect api key" do
-  let(:markup) { Zemanta.new("some text").suggest_markup }
+  let(:markup) { Zemanta::Markup.fetch("some text") }
 
   it "raises exception when 403 error returned" do
     stub_zemanta_exception!

data/spec/zemanta/markup_spec.rb

@@ -12,5 +12,61 @@ describe Zemanta::Markup do
       subject.links.should be_a Array
       subject.links.first.should be_a Zemanta::Markup::Link
     end
+
+    context ".fetch" do
+      before(:each) { stub_zemanta_enhancer! }
+
+      it "returns Markup object for nonempty string" do
+        Zemanta::Markup.fetch("This is a text").should be_a Zemanta::Markup
+      end
+
+      it "returns Markup object for nil" do
+        Zemanta::Markup.fetch(nil).should be_a Zemanta::Markup
+      end
+
+      it "does not hit fetcher if nil passed" do
+        Zemanta::Fetcher.any_instance.should_not_receive(:post)
+        Zemanta::Markup.fetch(nil)
+      end
+
+      it "returns Markup object for empty string" do
+        stub_zemanta_full!
+        Zemanta::Markup.fetch("").should be_a Zemanta::Markup
+      end
+
+      it "does not hit fetcher if empty string passed" do
+        Zemanta::Fetcher.any_instance.should_not_receive(:post)
+        Zemanta::Markup.fetch("")
+      end
+
+      it "calls drop_links_below on created markup" do
+        Zemanta::Markup.any_instance.should_receive(:drop_links_below)
+        Zemanta::Markup.fetch("This is a text")
+      end
+
+      it "returns every link if no relevance or confidence passed" do
+        Zemanta::Markup.fetch("This is a text").links.count.should == 2
+      end
+
+    end
+
+    context "drop_links_below" do
+      subject { Zemanta::Markup.new(fixture("enhancer")['markup'])}
+
+      it "drops links below given relevance" do
+        subject.drop_links_below(0.9, 0)
+        subject.links.map(&:relevance).should == [0.91956]
+      end
+
+      it "drops links below given confidence" do
+        subject.drop_links_below(0, 0.85)
+        subject.links.map(&:confidence).should == [0.878267]
+      end
+
+      it "drops links below both given condifence and relevance" do
+        subject.drop_links_below(0.9, 0.9)
+        subject.links.empty?.should == true
+      end
+    end
   end
 end

data/spec/zemanta_spec.rb

@@ -1,12 +1,6 @@
 require 'spec_helper'
 
 describe Zemanta do
-  it "makes request with text and method params on #suggest_markup" do
-    context = Zemanta.new("This is a text")
-    context.stub(:suggest_markup_request) { fixture("markup") }
-    context.suggest_markup.should be_a Zemanta::Markup
-  end
-
   it "returns Configuration instance on Zemanta.config" do
     Zemanta.config.should be_a Zemanta::Configuration
   end
@@ -16,4 +10,4 @@ describe Zemanta do
       config.should be_a Zemanta::Configuration
     end
   end
-end
+end

data/zemanta.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "typhoeus"
+  gem.add_dependency "yajl"
 
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "webmock"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zemanta_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +88,22 @@ files:
 - README.md
 - Rakefile
 - lib/zemanta.rb
-- lib/zemanta/cache.rb
 - lib/zemanta/cache/disk.rb
 - lib/zemanta/configuration.rb
 - lib/zemanta/configuration/null_storage.rb
+- lib/zemanta/enhancer.rb
 - lib/zemanta/fetcher.rb
 - lib/zemanta/fetcher/cache.rb
 - lib/zemanta/fetcher/cache/key.rb
 - lib/zemanta/fetcher/cache/null_response.rb
 - lib/zemanta/fetcher/cache/response.rb
+- lib/zemanta/fetcher/parser.rb
 - lib/zemanta/fetcher/web.rb
 - lib/zemanta/markup.rb
 - lib/zemanta/markup/link.rb
 - lib/zemanta/markup/link/target.rb
 - lib/zemanta/version.rb
+- spec/fixtures/zemanta/enhancer.json
 - spec/fixtures/zemanta/full_response.json
 - spec/fixtures/zemanta/link.json
 - spec/fixtures/zemanta/markup.json
@@ -94,6 +112,7 @@ files:
 - spec/zemanta/cache/disk_spec.rb
 - spec/zemanta/configuration/null_storage_spec.rb
 - spec/zemanta/configuration_spec.rb
+- spec/zemanta/enhancer_spec.rb
 - spec/zemanta/fetcher/cache/key_spec.rb
 - spec/zemanta/fetcher/cache/null_response_spec.rb
 - spec/zemanta/fetcher/cache/response_spec.rb
@@ -132,6 +151,7 @@ signing_key:
 specification_version: 3
 summary: This is a ruby client for Zemanta api.
 test_files:
+- spec/fixtures/zemanta/enhancer.json
 - spec/fixtures/zemanta/full_response.json
 - spec/fixtures/zemanta/link.json
 - spec/fixtures/zemanta/markup.json
@@ -140,6 +160,7 @@ test_files:
 - spec/zemanta/cache/disk_spec.rb
 - spec/zemanta/configuration/null_storage_spec.rb
 - spec/zemanta/configuration_spec.rb
+- spec/zemanta/enhancer_spec.rb
 - spec/zemanta/fetcher/cache/key_spec.rb
 - spec/zemanta/fetcher/cache/null_response_spec.rb
 - spec/zemanta/fetcher/cache/response_spec.rb

data/lib/zemanta/cache.rb

@@ -1,4 +0,0 @@
-class Zemanta
-  module Cache
-  end
-end