open_calais 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e83c4943a15fe6e32a9ef29e41c98cc93c8f5027
-  data.tar.gz: 74891ffae6746754684263c2ba604686c186af47
+SHA256:
+  metadata.gz: 34b051160ea2d22366cacafdcb786d98e7671c49cfd67798095e0563b08766bc
+  data.tar.gz: fc056e88eb523daeaa03d14e5b70ceb5797b352e062dbf15d7807b204dc99491
 SHA512:
-  metadata.gz: f5bf49e97dd891cdd99932a86754e302a9dd68e5dde6b61149fc1095805652e4dc4b5f82d2b61c916f9b2a01346b171198c35245fa2a1ec9daaafb982be4ffa3
-  data.tar.gz: b5f6f8cc0ff27feacd86c973f3125eb3d286f936c5fb0eed4c82fc4b9f93cd44e02e7da8bd1b4dfdd0b7e4e2a4b10d4680e5f414d5ab0ab1c62e58fe70f54665
+  metadata.gz: 8765c48314b227bee03d5fd88c7e6e178724574a316b139c651a27da1ad8d992fd33bf54ae419d76a68d88d44bc0535df5195c47ce905e405104adc13f13b08d
+  data.tar.gz: 01b798fb0b54312b077c1ef3cc38fa926dc86ce395323bcfeef4ae24410838bc1b944b6d363c1ac49d36282761eef0f7996f9f0e2aa3e3d2cca6f86ade3c3a21

data/.travis.yml

@@ -1,4 +1,11 @@
+sudo: false
 language: ruby
+cache: bundler
+env:
+  - TRAVIS=true
 rvm:
-  - "2.1.6"
-  - "2.2.1"
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+script:
+  - bundle exec rake test

data/README.md

@@ -4,14 +4,18 @@
 [![Build Status](https://travis-ci.org/PRX/open_calais.svg?branch=master)](https://travis-ci.org/PRX/open_calais)
 [![Code Climate](https://codeclimate.com/github/PRX/open_calais/badges/gpa.svg)](https://codeclimate.com/github/PRX/open_calais)
 [![Coverage Status](https://coveralls.io/repos/PRX/open_calais/badge.svg?branch=master)](https://coveralls.io/r/PRX/open_calais?branch=master)
-[![Dependency Status](https://gemnasium.com/PRX/open_calais.svg)](https://gemnasium.com/PRX/open_calais)
 
-### Gem Version 0.1.* supports the original OpenCalais API
-### Gem Version 0.2.* now uses the upgraded API http://new.opencalais.com/upgrade/
+_Gem Version 0.1.* supports the original OpenCalais API_
 
-If you are upgrading the the new version of the API, you will need a new API key. You should also review the [upgrade guide](http://new.opencalais.com/upgrade/).
+_Gem Version 0.2.* now uses the upgraded API http://www.opencalais.com/_
 
-This is a ruby gem to access the [OpenCalais API](http://www.opencalais.com/documentation/calais-web-service-api/api-invocation/rest), using the REST API, and JSON responses.
+_Gem Version 0.4.* supports refinitiv API_
+
+Open Calais is now found at: https://developers.refinitiv.com/open-permid/intelligent-tagging-restful-api
+
+It has a new default endpoint: https://api-eit.refinitiv.com/permid/calais
+
+This is a ruby gem to access the (formerly OpenCalais) [Refinitiv Intelligent Tagging API](https://developers.refinitiv.com/open-permid/intelligent-tagging-restful-api), using the 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.
 
@@ -33,7 +37,7 @@ Or install it yourself as:
 
 ## Usage
 
-OpenCalais has one main method, `enrich`, and so does the gem:
+Intelligent Tagging (OpenCalais) has one main method, `enrich`, and so does the gem:
 
 ```ruby
 require 'open_calais'
@@ -44,7 +48,7 @@ OpenCalais.configure do |c|
 end
 
 # or you can configure for a single call
-open_calais = OpenCalais::Client.new(:api_key=>'an api key')
+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.')
@@ -54,7 +58,7 @@ 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] }
+response.tags.each { |t| puts t[:name] }
 ```
 
 ## Contributing

data/Rakefile

@@ -6,6 +6,7 @@ Rake::TestTask.new do |t|
   t.libs.push 'test'
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
+  t.warning = true
 end
 
 task :default => :test

data/lib/open_calais.rb

@@ -14,30 +14,20 @@ module OpenCalais
     :license_id                    => 'X-AG-Access-Token',
     :content_type                  => 'Content-Type',
     :output_format                 => 'outputFormat',
-    :reltag_base_url               => 'reltagBaseURL',
-    :calculate_relevance_score     => 'calculateRelevanceScore',
-    :enable_metadata_type          => 'enableMetadataType',
-    :doc_rdf_accessible            => 'docRDFaccessible',
-    :discard_metadata              => 'discardMetadata',
-    :omit_outputting_original_text => 'omitOutputtingOriginalText',
-    :allow_distribution            => 'allowDistribution',
-    :allow_search                  => 'allowSearch',
-    :external_id                   => 'externalID',
-    :submitter                     => 'submitter'
+    :language                      => 'x-calais-language'
   }
 
   CONTENT_TYPES = {
-    :xml     => 'TEXT/XML',
-    :html    => 'TEXT/HTML',
-    :htmlraw => 'TEXT/HTMLRAW',
+    :xml     => 'text/xml',
+    :html    => 'text/html',
+    :htmlraw => 'text/htmlraw',
     :raw     => 'text/raw'
   }
 
   OUTPUT_FORMATS = {
-    :rdf          => 'XML/RDF',
-    :simple       => 'Text/Simple',
-    :microformats => 'Text/Microformats',
-    :json         => 'application/json'
+    :rdf  => 'xml/rdf',
+    :n3   => 'text/n3',
+    :json => 'application/json'
   }
 
   METADATA_SOCIAL_TAGS = 'SocialTags'
@@ -49,5 +39,4 @@ module OpenCalais
   GEO_TYPES       = %w(City Continent Country NaturalFeature ProvinceOrState Region)
 
   DISAMBUGUATIONS = %w(er/Company er/Geo er/Product)
-
 end

data/lib/open_calais/client.rb

@@ -9,7 +9,7 @@ module OpenCalais
 
     include Connection
 
-    attr_reader *OpenCalais::Configuration.keys
+    attr_reader(*OpenCalais::Configuration.keys)
 
     attr_accessor :current_options
 
@@ -38,7 +38,7 @@ module OpenCalais
 
     def analyze(text, opts={})
       raise 'Specify a value for the text' unless (text && text.length > 0)
-      options = {params: current_options}.merge(opts)
+      options = current_options.merge(opts)
 
       response = connection(options).post do |request|
         request.body = text
@@ -49,7 +49,5 @@ module OpenCalais
     # using analyze as a standard method name
     # enrich is more OpenCalais specific
     alias_method :enrich, :analyze
-
   end
-
 end

data/lib/open_calais/configuration.rb

@@ -17,12 +17,12 @@ module OpenCalais
     DEFAULT_ADAPTER = :excon
 
     # The api endpoint to get REST info from opencalais
-    DEFAULT_ENDPOINT = 'https://api.thomsonreuters.com/permid/calais'.freeze
+    DEFAULT_ENDPOINT = 'https://api-eit.refinitiv.com/permid/calais'.freeze
 
     # The value sent in the http header for 'User-Agent' if none is set
     DEFAULT_USER_AGENT = "OpenCalais Ruby Gem #{OpenCalais::VERSION}".freeze
 
-    attr_accessor *VALID_OPTIONS_KEYS
+    attr_accessor(*VALID_OPTIONS_KEYS)
 
     # Convenience method to allow for global setting of configuration options
     def configure
@@ -53,6 +53,5 @@ module OpenCalais
       self.user_agent         = DEFAULT_USER_AGENT
       self
     end
-
   end
 end

data/lib/open_calais/connection.rb

@@ -1,10 +1,15 @@
 # -*- encoding: utf-8 -*-
 
 require 'faraday_middleware'
+require 'hashie'
 
 module OpenCalais
   module Connection
 
+    class HashieWrapper < ::Hashie::Mash
+      disable_warnings
+    end
+
     ALLOWED_OPTIONS = [
       :headers,
       :url,
@@ -22,24 +27,22 @@ module OpenCalais
           'Accept'       => "#{OpenCalais::OUTPUT_FORMATS[:json]};charset=utf-8",
 
           # open calais default headers
-          OpenCalais::HEADERS[:license_id]                    => api_key,
-          OpenCalais::HEADERS[:content_type]                  => OpenCalais::CONTENT_TYPES[:raw],
-          OpenCalais::HEADERS[:output_format]                 => OpenCalais::OUTPUT_FORMATS[:json],
-          OpenCalais::HEADERS[:calculate_relevance_score]     => 'false',
-          OpenCalais::HEADERS[:enable_metadata_type]          => 'SocialTags',
-          OpenCalais::HEADERS[:doc_rdf_accessible]            => 'false',
-          OpenCalais::HEADERS[:omit_outputting_original_text] => 'TRUE' # case matters here, actually
+          OpenCalais::HEADERS[:license_id]    => api_key,
+          OpenCalais::HEADERS[:content_type]  => OpenCalais::CONTENT_TYPES[:raw],
+          OpenCalais::HEADERS[:output_format] => OpenCalais::OUTPUT_FORMATS[:json],
+          OpenCalais::HEADERS[:language]      => 'English'
         },
         :ssl => {:verify => false},
         :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
+      options.select{|k,v| ALLOWED_OPTIONS.include?(k.to_sym)}
     end
 
     def connection(options={})
       opts = merge_default_options(options)
+      FaradayMiddleware::Mashify.mash_class = HashieWrapper
       Faraday::Connection.new(opts) do |connection|
         connection.request  :url_encoded
         connection.response :mashify

data/lib/open_calais/response.rb

@@ -1,8 +1,11 @@
 # -*- encoding: utf-8 -*-
-require 'stringex'
+
+require 'active_support'
 
 module OpenCalais
   class Response
+
+    include ActiveSupport::Inflector
     attr_accessor :raw, :language, :topics, :tags, :entities, :relations, :locations
 
     def initialize(response)
@@ -19,11 +22,11 @@ module OpenCalais
     end
 
     def humanize_topic(topic)
-      topic.gsub('_', ' & ').titleize.remove_formatting
+      transliterate(topic.gsub('_', ' & ').titleize)
     end
 
     def importance_to_score(imp)
-      case imp
+      case imp.to_i
       when 1 then 0.9
       when 2 then 0.7
       else 0.5
@@ -38,38 +41,68 @@ module OpenCalais
       r.each do |k,v|
         case v._typeGroup
         when 'topics'
-          self.topics << {:name => humanize_topic(v.name), :score => v.score.to_f, :original => v.name}
+          self.topics << {
+            :name => humanize_topic(v.name),
+            :score => v.score.to_f,
+            :original => v.name
+          }
         when 'socialTag'
-          self.tags << {:name => v.name.gsub('_', ' and ').downcase, :score => importance_to_score(v.importance)}
+          self.tags << {
+            :name => v.name.gsub('_', ' and ').downcase,
+            :score => importance_to_score(v.importance)
+          }
         when 'entities'
-          item = {:guid => k, :name => v.name, :type => v._type.remove_formatting.titleize, :score => 1.0}
-
-          instances = Array(v.instances).select{|i| i.exact.downcase != item[:name].downcase }
-          item[:matches] = instances if instances && instances.size > 0
-
-          if OpenCalais::GEO_TYPES.include?(v._type)
-            if (v.resolutions && v.resolutions.size > 0)
-              r = v.resolutions.first
-              item[:name]      = r.shortname || r.name
-              item[:latitude]  = r.latitude
-              item[:longitude] = r.longitude
-              item[:country]   = r.containedbycountry if r.containedbycountry
-              item[:state]     = r.containedbystate if r.containedbystate
-            end
-            self.locations << item
-          else
-            self.entities << item
-          end
+          parse_entity(k, v)
         when 'relations'
-          item = v.reject{|k,v| k[0] == '_' || k == 'instances'} || {}
-          item[:type] = v._type.remove_formatting.titleize
-          self.relations << item
+          parse_relation(k, v)
         end
       end
 
       # remove social tags which are in the topics list already
-      topic_names = self.topics.collect{|topic| topic[:name].downcase}
-      self.tags.delete_if{|tag| topic_names.include?(tag[:name]) }
+      topic_names = self.topics.collect { |topic| topic[:name].downcase }
+      self.tags.delete_if { |tag| topic_names.include?(tag[:name]) }
+    end
+
+    def parse_entity(k, v)
+      if v.name.nil?
+        v.name = v.instances.first[:exact]
+      end
+
+      item = {
+        :guid => k,
+        :name => v.name,
+        :type => transliterate(v._type).titleize,
+        :score => v.relevance
+      }
+
+      instances = Array(v.instances).select { |i| i.exact.downcase != item[:name].downcase }
+      if instances && instances.size > 0
+        item[:matches] = instances
+      end
+
+      if OpenCalais::GEO_TYPES.include?(v._type)
+        self.locations << set_location_info(item, v)
+      else
+        self.entities << item
+      end
+    end
+
+    def set_location_info(item, v)
+      if (v.resolutions && v.resolutions.size > 0)
+        r = v.resolutions.first
+        item[:name]      = r.shortname || r.name
+        item[:latitude]  = r.latitude
+        item[:longitude] = r.longitude
+        item[:country]   = r.containedbycountry if r.containedbycountry
+        item[:state]     = r.containedbystate if r.containedbystate
+      end
+      item
+    end
+
+    def parse_relation(k, v)
+      item = v.reject { |key,val| key[0] == '_' || key == 'instances' } || {}
+      item[:type] = transliterate(v._type).titleize
+      self.relations << item
     end
   end
 end

data/lib/open_calais/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module OpenCalais
-  VERSION = "0.2.0"
+  VERSION = '0.4.0'
 end

data/open_calais.gemspec

@@ -11,21 +11,20 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{This is a gem to call the OpenCalais improved REST API.}
   gem.description   = %q{This is a gem to call the OpenCalais improved REST API. http://www.opencalais.com/ http://www.opencalais.com/documentation/calais-web-service-api/api-invocation/rest}
   gem.homepage      = "https://github.com/PRX/open_calais"
-
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency('faraday', '>= 0.7.4')
-  gem.add_runtime_dependency('faraday_middleware', '~> 0.9')
-  gem.add_runtime_dependency('multi_json', '>= 1.0.3', '~> 1.0')
+  gem.add_runtime_dependency('faraday')
+  gem.add_runtime_dependency('faraday_middleware')
+  gem.add_runtime_dependency('multi_json')
   gem.add_runtime_dependency('multi_xml')
   gem.add_runtime_dependency('excon')
-  gem.add_runtime_dependency('hashie',  '>= 0.4.0')
+  gem.add_runtime_dependency('hashie')
   gem.add_runtime_dependency('activesupport')
-  gem.add_runtime_dependency('stringex')
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('minitest')

data/test/client_test.rb

@@ -4,37 +4,36 @@ describe OpenCalais::Client do
 
   it "is initialized with defaults" do
     oc = OpenCalais::Client.new
-    oc.current_options.wont_be_nil
-    oc.current_options.must_equal OpenCalais.options
+    _(oc.current_options).wont_be_nil
+    _(oc.current_options).must_equal OpenCalais.options
   end
 
   it "is initialized with specific values" do
     oc = OpenCalais::Client.new(:api_key => 'current')
-    oc.current_options.wont_be_nil
-    oc.current_options.wont_equal OpenCalais.options
-    oc.current_options[:api_key].must_equal 'current'
-    oc.api_key.must_equal 'current'
+    _(oc.current_options).wont_be_nil
+    _(oc.current_options).wont_equal OpenCalais.options
+    _(oc.current_options[:api_key]).must_equal 'current'
+    _(oc.api_key).must_equal 'current'
   end
 
   it "gets tags for text" do
     oc = OpenCalais::Client.new(:api_key => ENV['OPEN_CALAIS_KEY'])
     response = oc.enrich("Ruby on Rails is a fantastic web framework. It uses MVC, and the ruby programming language invented by Matz")
-    response.wont_be_nil
-    response.raw.wont_be_nil
+    _(response).wont_be_nil
+    _(response.raw).wont_be_nil
   end
 
   it "passes in header options in client" do
     oc = OpenCalais::Client.new(:api_key => ENV['OPEN_CALAIS_KEY'], :content_type => OpenCalais::CONTENT_TYPES[:html])
     response = oc.enrich("Ruby on Rails is a fantastic web framework. It uses MVC, and the ruby programming language invented by Matz")
-    response.wont_be_nil
-    response.raw.wont_be_nil
+    _(response).wont_be_nil
+    _(response.raw).wont_be_nil
   end
 
   it "passes in header optionsin enrich" do
     oc = OpenCalais::Client.new(:api_key => ENV['OPEN_CALAIS_KEY'])
     response = oc.enrich("Ruby on Rails is a fantastic web framework. It uses MVC, and the ruby programming language invented by Matz", :headers => {:content_type => OpenCalais::CONTENT_TYPES[:html]})
-    response.wont_be_nil
-    response.raw.wont_be_nil
+    _(response).wont_be_nil
+    _(response.raw).wont_be_nil
   end
-
 end

data/test/configuration_test.rb

@@ -8,8 +8,7 @@ describe OpenCalais::Configuration do
 
   it "can be configured" do
     TestConfig.configure do |c|
-      c.must_be_kind_of OpenCalais::Configuration
+      _(c).must_be_kind_of OpenCalais::Configuration
     end
   end
-
 end

data/test/open_calais_test.rb

@@ -3,23 +3,22 @@ require File.expand_path(File.dirname(__FILE__) + '/test_helper')
 describe OpenCalais do
 
   it "has default configuration options" do
-    OpenCalais.options.wont_be_nil
-    OpenCalais.options[:adapter].must_equal OpenCalais::Configuration::DEFAULT_ADAPTER
+    _(OpenCalais.options).wont_be_nil
+    _(OpenCalais.options[:adapter]).must_equal OpenCalais::Configuration::DEFAULT_ADAPTER
   end
 
   it "can be configured" do
-    OpenCalais.must_respond_to(:configure)
+    _(OpenCalais).must_respond_to(:configure)
 
-    OpenCalais.api_key.must_be_nil
+    _(OpenCalais.api_key).must_be_nil
 
     OpenCalais.configure do |c|
-      c.must_equal OpenCalais
+      _(c).must_equal OpenCalais
       c.api_key = "this is a test key"
     end
 
-    OpenCalais.api_key.must_equal "this is a test key"
+    _(OpenCalais.api_key).must_equal "this is a test key"
 
-    OpenCalais.options[:api_key].must_equal "this is a test key"
+    _(OpenCalais.options[:api_key]).must_equal "this is a test key"
   end
-
 end

data/test/test_helper.rb

@@ -8,7 +8,6 @@ if ENV['TRAVIS']
   Coveralls.wear!
 end
 
-require 'minitest/spec'
 require 'minitest/autorun'
 
 require 'open_calais'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_calais
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kuklewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2020-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,48 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -88,20 +82,6 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: stringex
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -210,7 +190,8 @@ files:
 - test/open_calais_test.rb
 - test/test_helper.rb
 homepage: https://github.com/PRX/open_calais
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -227,8 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: This is a gem to call the OpenCalais improved REST API.