zemanta_client 0.0.3 → 0.0.4

data/README.md

@@ -19,48 +19,66 @@ Or install it yourself as:
 ## 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
-    - Set ZEMANTA_KEY key in you environment variables and gem will use it
+    - Set `ZEMANTA_KEY` key in you environment variables and gem will use it
 
   2. Configuration
     - You can set your api_key in configuration block like this:
-    - Zemanta.configure { |c| c.api_key = 'your_api_key' } 
+
+      ```ruby
+        Zemanta.configure { |c| c.api_key = 'your_api_key' } 
+      ```
 
 
 ## Usage
 
-  Two use cases are implemented: Retrieving suggest_markup data and enhancing the text.
+Two use cases are implemented: 
+  
+  1. Retrieving suggest_markup data and enhancing the text.
 
-  1. Zemanta::Markup.fetch(text, opts = {})
+    ```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. Zemanta::Enhancer.new(text, opts = {}).enhance
+  
+  2. Enhancing the text with links:
+  
+    ```ruby
+    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.
+    Then it will return the updated text.
 
-  In both relevance and confidence keys can be passes inside opts to filter any links that are below passed values.
+In both relevance and confidence keys can be passes inside opts to filter any links that are below passed values.
 
 ## Configuration
 
-  There are several configuration options you can set:
-
-      Zemanta.configure do |config|
-        You can pass a hash of custom options that will be passed into each request. It's empty by default.
-        config.custom_request_opts = {}
-      
-        Zemanta supports various response formats. However, this client works only with json, so changing this would be rather bad idea.
-        config.format = "json"
-      
-        This client supports caching, details below. Default is no caching.
-        config.cache_store = Zemanta::Configuration::NullStorage
-      
-        You can pass api_key to zemanta, as described above.
-        config.api_key = "yourapikeyhere"
-      end
+There are several configuration options you can set:
+
+```ruby
+Zemanta.configure do |config|
+  # You can pass a hash of custom options that will be passed into each request. It's empty by default.
+  config.custom_request_opts = {}
+
+  # Zemanta supports various response formats. However, this client works only with json, so changing this would be rather bad idea.
+  config.format = "json"
+
+  # This client supports caching, details below. Default is no caching.
+  config.cache_store = Zemanta::Configuration::NullStorage
+
+  # You can pass api_key to zemanta, as described above.
+  config.api_key = "yourapikeyhere"
+end
+```
 
 ## Caching
-  By default there is no caching. You can pass any cache store to config.cache_store in configuration.
-  The only expectation is that it answers to [] and []= methods. For example, you can pass ruby hash or Cache::Disk.new
+
+  By default there is no caching. You can pass any cache store to `config.cache_store` in configuration.
+  The only expectation is that it answers to `[]` and `[]=` methods. For example, you can pass ruby hash or `Cache::Disk.new`
   object to use simple file system storage.
 
 ## Contributing
@@ -73,6 +91,7 @@ You need to set api_key to use the client. If you won't do that, gem will raise
 
 ## Changelog
 
+0.0.4 - fixed yajl require in gemspec
 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.
+0.0.1 - Initial release. Support for suggest_markup method and caching.

data/lib/zemanta/version.rb

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

data/zemanta.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "typhoeus"
-  gem.add_dependency "yajl"
+  gem.add_dependency "yajl-ruby"
 
   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.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yajl
+  name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: