open_calais 0.0.1 → 0.0.2

data/README.md

@@ -1,9 +1,9 @@
 # OpenCalais
 
-Ruby gem to access the OpenCalaid API, using the new-ish REST API, and JSON responses.
-It uses Faraday to abstract HTTP library (defaults to use excon because ot is excellent), and multi_json to abstract JSON parsing.
+Ruby gem to access the [OpenCalais API](http://www.opencalais.com/documentation/calais-web-service-api/api-invocation/rest), using the new-ish REST API, and JSON responses.
+It uses [Faraday](https://github.com/lostisland/faraday) to abstract HTTP library (defaults to use excon because it is excellent), and multi_json to abstract JSON parsing.
 
-It returns a parsed version of the response, but the response contains the raw response (converted from json to hashes/arrays/string/etc).
+It returns a parsed version of the response, but the response also contains the raw response (converted from json to hashes/arrays/string/etc).
 
 ## Installation
 
@@ -21,28 +21,29 @@ Or install it yourself as:
 
 ## Usage
 
-OpenCalais has one main method, 'enrich', and so does the gem:
+OpenCalais has one main method, `enrich`, and so does the gem:
 
-    require 'open_calais'
+```ruby
+require 'open_calais'
 
-    # you can configure for all calls
-    OpenCalais.configure do |c|
-      c.api_key = "this is a test key"
-    end
+# you can configure for all calls
+OpenCalais.configure do |c|
+  c.api_key = "this is a test key"
+end
 
-    # or you can configure for a single call
-    open_calais = OpenCalais::Client.new(:api_key=>'an api key')
+# or you can configure for a single call
+open_calais = OpenCalais::Client.new(:api_key=>'an api key')
 
-    # it returns a OpenCalais::Response instance
-    response = open_calais.enrich('Ruby on Rails is a fantastic web framework. It uses MVC, and the Ruby programming language invented by Matz in Japan.')
+# it returns a OpenCalais::Response instance
+response = open_calais.enrich('Ruby on Rails is a fantastic web framework. It uses MVC, and the Ruby programming language invented by Matz in Japan.')
 
-    # which has the 'raw' response
-    response.raw
-
-    # and has been parsed a bit to get :language, :topics, :tags, :entities, :relations, :locations
-    # as lists of hashes
-    response.tags.each{|t| puts t[:name] }
+# which has the 'raw' response
+response.raw
 
+# and has been parsed a bit to get :language, :topics, :tags, :entities, :relations, :locations
+# as lists of hashes
+response.tags.each{|t| puts t[:name] }
+```
 
 ## Contributing
 

data/lib/open_calais/client.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'open_calais/configuration'
 require 'open_calais/connection'
 require 'open_calais/response'
@@ -35,12 +37,10 @@ module OpenCalais
 
     def enrich(text, opts={})
       raise 'Specify a value for the text' unless (text && text.length > 0)
+      options = current_options.merge(opts)
 
-      response = connection.post do |request|
+      response = connection(options).post do |request|
         request.body = text
-        OpenCalais::HEADERS.each do |k,v|
-          request.headers[v] = opts[k] if opts.key?(k)
-        end
       end
       OpenCalais::Response.new(response)
     end

data/lib/open_calais/configuration.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# -*- encoding: utf-8 -*-
 
 module OpenCalais
   module Configuration

data/lib/open_calais/connection.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'faraday_middleware'
 
 module OpenCalais
@@ -11,7 +13,7 @@ module OpenCalais
       :ssl
     ].freeze
 
-    def add_default_options(opts={})
+    def merge_default_options(opts={})
       headers = opts.delete(:headers) || {}
       options = {
         :headers => {
@@ -32,13 +34,14 @@ module OpenCalais
         :url => endpoint
       }.merge(opts)
       options[:headers] = options[:headers].merge(headers)
+      OpenCalais::HEADERS.each{|k,v| options[:headers][v] = options.delete(k) if options.key?(k)}      
       options
     end
 
     def connection(options={})
-      opts = add_default_options(options)
+      opts = merge_default_options(options)
       Faraday::Connection.new(opts) do |connection|
-        connection.request :url_encoded
+        connection.request  :url_encoded
         connection.response :mashify
         connection.response :logger if ENV['DEBUG']
 
@@ -49,7 +52,6 @@ module OpenCalais
         end
 
         connection.adapter(adapter)
-
       end
 
     end

data/lib/open_calais/response.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module OpenCalais
   class Response
     attr_accessor :raw, :language, :topics, :tags, :entities, :relations, :locations

data/lib/open_calais/version.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module OpenCalais
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'minitest/spec'
 require 'minitest/autorun'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_calais
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -187,12 +187,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4380033744204018911
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4380033744204018911
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -204,4 +210,3 @@ test_files:
 - test/configuration_test.rb
 - test/open_calais_test.rb
 - test/test_helper.rb
-has_rdoc: