zemanta_client 0.0.5 → 0.0.6

data/README.md

@@ -1,6 +1,6 @@
 # Zemanta
 
-This is a ruby client to awesome Zemanta app. 
+This is a ruby client to awesome Zemanta app.
 
 ## Installation
 
@@ -27,33 +27,34 @@ 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:
 
       ```ruby
-        Zemanta.configure { |c| c.api_key = 'your_api_key' } 
+        Zemanta.configure { |c| c.api_key = 'your_api_key' }
       ```
 
 
 ## Usage
 
-Two use cases are implemented: 
-  
+Two use cases are implemented:
+
   1. Retrieving suggest_markup data and enhancing the text.
 
     ```ruby
     Zemanta::Markup.fetch(text, opts = {})
     ```
-    
+
     It will fetch suggest_markup data for passed text from Zemanta api and wrap it in custom classes.
 
-  
+
   2. Enhancing the text with links:
-  
+
     ```ruby
     Zemanta::Enhancer.new(text, opts = {}).enhance
     ```
 
     Options:
-      no_duplicates (default: false) - ensures links are used once
-    
-  
+      * `no_duplicates` (default: false) - ensures links are used once
+      * `skip` (default: nil) - URL regexp of the links that should be skipped
+      * `strip_query_string` - removes the query string part of the suggested links urls
+
     It will fetch suggest_markup data for given text and for every returned link it will wrap the keyword with this link.
     Then it will return the updated text.
 
@@ -95,6 +96,7 @@ end
 
 ## Changelog
 
+0.0.6 - Added #skip and #strip_query_string options to enhancer
 0.0.5 - Added #no_duplicates option to Enhancer
 0.0.4 - Fixed yajl require in gemspec
 0.0.3 - Added Enhancer class, used yajl for json parsing, changed external gem api.

data/lib/zemanta/enhancer.rb

@@ -3,6 +3,8 @@ module Zemanta
     # Options:
     #
     #  no_duplicates (default: false) - ensures links are used once
+    #  skip - regexp for URLs not to be hot-linked
+    #  strip_query_string - remove the query string from urls
     #
     def initialize(text, opts = {})
       @text = text
@@ -18,7 +20,15 @@ module Zemanta
 
     def enhance!
       words_to_anchor(@opts).each do |dictionary|
-        link = "<a href=#{dictionary[:link]}>#{dictionary[:word]}</a>"
+        url = dictionary[:link]
+
+        if @opts[:skip]
+          next if url =~ @opts[:skip]
+        end
+
+        url = strip_query_string(url) if @opts[:strip_query_string]
+
+        link = "<a href=#{url}>#{dictionary[:word]}</a>"
         if @opts[:no_duplicates]
           @text.sub!(dictionary[:word], link)
         else
@@ -36,5 +46,10 @@ module Zemanta
     def suggest_markup(opts = {})
       Markup.fetch(@text, opts)
     end
+
+    def strip_query_string(url)
+      return nil unless url
+      url.gsub(/\?.*$/, '')
+    end
   end
 end

data/lib/zemanta/version.rb

@@ -1,3 +1,3 @@
 module Zemanta
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/zemanta/enhancer_spec.rb

@@ -22,5 +22,29 @@ describe Zemanta::Enhancer do
         output.scan('<a').should have(1).elements
       end
     end
+
+    describe "skip option" do
+      it "skips links whose URL matches a user-provided regexp" do
+        stub_zemanta_enhancer!
+        output = Zemanta::Enhancer.new(input, skip: /machu_picchu/).enhance
+        output.scan('<a').should have(1).elements
+      end
+
+      it "doesn't affect the links that don't match thr user-provided regexp" do
+        stub_zemanta_enhancer!
+        output = Zemanta::Enhancer.new(input, skip: /macchu_picchu/).enhance
+        output.scan('<a').should have(2).elements
+      end
+    end
+
+    describe "strip_query_string" do
+      it "strips the query string from the suggested urls" do
+        text = "Hello foo bar"
+        suggestions = [{ word: 'foo', link: "http://bar.com/foo?bar=123" }]
+        Zemanta::Enhancer.any_instance.stub(words_to_anchor: suggestions)
+        output = Zemanta::Enhancer.new(text, strip_query_string: true).enhance
+        output.should == "Hello <a href=http://bar.com/foo>foo</a> bar"
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zemanta_client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus