rosette_api 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a933956e30bc2d5f25da1185986b4d15213ed8c6
-  data.tar.gz: d15ced2b62c5bf6c120fba6751e6bdd2b5719d0a
+  metadata.gz: 4104193d91e0db035f76f3b5662d6d0d96ba6094
+  data.tar.gz: eedfda26a8b17f548159297e2ec8e40ec5b921d9
 SHA512:
-  metadata.gz: 4ec8d75ea02529e81810389c1f2007c070118b063596394940bd594c4b021edbb477f2e9b4ead8359fa82ca370f7c4f3070fab017f434848ca26eb5f65a6ec11
-  data.tar.gz: dc1bf7cac6789d0fe273a2081e8b53440037a2b55abfadf69df0f3a8857ae922d3e99b6c5d4f8cb85beca86c7d38e589a997da3258a60e04a0d9c8c32dd95186
+  metadata.gz: 34165ed9c5648635851d61fd922e6fb5cb512371e5bc85ef430f48f7a199f7b445d3fba0c3c02d931971a3c401e66c0ca008d2086686edc382477bfc55e2b8b9
+  data.tar.gz: 677d79b77789d0463fad837d1407f0561c537fa784e71e0183020b2e6b28f3534d310bcef99d1030c1df441a2149ed8ba4feb299e707bfa2e097c026a2767780

data/lib/document_parameters.rb

@@ -15,6 +15,8 @@ class DocumentParameters
   attr_accessor :language
   # Rosette API options (optional, should be a hash)
   attr_accessor :rosette_options
+  # custom Rosette API headers
+  attr_accessor :custom_headers
 
   def initialize(options = {}) #:notnew:
     options = {
@@ -23,7 +25,8 @@ class DocumentParameters
       file_path: nil,
       genre: nil,
       language: nil,
-      rosette_options: nil
+      rosette_options: nil,
+      custom_headers: nil
     }.update options
     @content = options[:content]
     @content_uri = options[:content_uri]
@@ -31,6 +34,7 @@ class DocumentParameters
     @genre = options[:genre]
     @language = options[:language]
     @rosette_options = options[:rosette_options]
+    @custom_headers = options[:custom_headers]
   end
 
   # Validates the parameters by checking if there are multiple content sources
@@ -43,6 +47,8 @@ class DocumentParameters
     elsif [@content, @content_uri, @file_path].all?(&:nil?)
       raise BadRequestFormatError.new 'The format of the request is invalid: no content provided; must' \
                                       ' be one of an attachment, an inline "content" field, or an external "contentUri"'
+    elsif !@rosette_options.nil?
+      raise BadRequestError.new('rosette_options can only be an instance of a Hash') unless @rosette_options.is_a? Hash
     end
   end
 
@@ -66,7 +72,8 @@ class DocumentParameters
       file_path: @file_path,
       genre: @genre,
       language: @language,
-      options: @rosette_options
+      options: @rosette_options,
+      custom_headers: @custom_headers
     }
   end
 end

data/lib/name_similarity_parameters.rb

@@ -21,6 +21,7 @@ class NameSimilarityParameters
     @genre = options[:genre]
     @name1 = name1
     @name2 = name2
+    @rosette_options = options[:rosette_options]
   end
 
   # Validates the parameters by checking if name1 and name2 are instances of
@@ -30,6 +31,8 @@ class NameSimilarityParameters
       raise BadRequestError.new('name1 option can only be an instance of a String or NameParameter')
     elsif [String, NameParameter].none? { |clazz| @name2.is_a? clazz }
       raise BadRequestError.new('name2 option can only be an instance of a String or NameParameter')
+    elsif !@rosette_options.nil?
+      raise BadRequestError.new('rosette_options can only be an instance of a Hash') unless @rosette_options.is_a? Hash
     end
   end
 

data/lib/name_translation_parameters.rb

@@ -47,10 +47,18 @@ class NameTranslationParameters
     @target_script = options[:target_script]
   end
 
+  # Validates the parameters by checking if rosette_options is an instance of a Hash.
+  def validate_params
+    if !@rosette_options.nil?
+      raise BadRequestError.new('rosette_options can only be an instance of a Hash') unless @rosette_options.is_a? Hash
+    end
+  end
+
   # Converts this class to Hash with its keys in lower CamelCase.
   #
   # Returns the new Hash.
   def load_params
+    self.validate_params
     self.to_hash.select { |_key, value| !value.nil? }
         .map { |key, value| [key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase), value] }
         .to_h

data/lib/request_builder.rb

@@ -41,6 +41,18 @@ class RequestBuilder
       raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
     end
 
+    if params['customHeaders'] != nil
+      keys_array = params['customHeaders'].keys
+      for k in keys_array
+        if k.to_s =~ /^X-RosetteAPI-/
+          request[k] = params['customHeaders'][k]
+        else
+            raise RosetteAPIError.new 'invalidHeader', 'Custom header must begin with "X-RosetteAPI-"'
+        end
+      end
+      params.delete 'customHeaders'
+    end
+
     request['X-RosetteAPI-Key'] = @user_key
     request['Content-Type'] = 'application/json'
     request['Accept'] = 'application/json'
@@ -68,6 +80,7 @@ class RequestBuilder
 
     boundary = SecureRandom.hex
     post_body = []
+    params.delete 'filePath'
     request_file = params.to_json
 
     # Add the content data
@@ -92,6 +105,19 @@ class RequestBuilder
     rescue
       raise RosetteAPIError.new 'connectionError', 'Failed to establish connection with Rosette API server.'
     end
+    
+    # add any custom headers from the user
+    if params['customHeaders'] != nil
+      keys_array = params['customHeaders'].keys
+      for k in keys_array
+        if k.to_s =~ /^X-RosetteAPI-/
+          request.add_field k, params['customHeaders'][k]
+        else
+            raise RosetteAPIError.new 'invalidHeader', 'Custom header must begin with "X-RosetteAPI-"'
+        end
+      end
+      params.delete 'customHeaders'
+    end
 
     request.add_field 'Content-Type', "multipart/form-data; boundary=#{boundary}"
     request.add_field 'X-RosetteAPI-Key', @user_key

data/lib/rosette_api.rb

@@ -9,7 +9,7 @@ require_relative 'bad_request_format_error'
 # This class allows you to access all Rosette API endpoints.
 class RosetteAPI
   # Version of Ruby binding
-  BINDING_VERSION = '1.1.1'
+  BINDING_VERSION = '1.2.0'
   # Rosette API language endpoint
   LANGUAGE_ENDPOINT = '/language'
   # Rosette API morphology endpoint
@@ -39,6 +39,8 @@ class RosetteAPI
   attr_accessor :user_key
   # Alternate Rosette API URL
   attr_accessor :alternate_url
+  # custom Rosette API headers
+  attr_accessor :custom_headers
 
   def initialize(user_key, alternate_url = 'https://api.rosette.com/rest/v1') #:notnew:
     @user_key = user_key
@@ -166,7 +168,6 @@ class RosetteAPI
     params = params.load_params
 
     endpoint = resolve_entities ? (ENTITIES_ENDPOINT + '/linked') : ENTITIES_ENDPOINT
-
     RequestBuilder.new(@user_key, @alternate_url + endpoint, params, BINDING_VERSION)
                   .send_post_request
   end
@@ -181,10 +182,12 @@ class RosetteAPI
   # base.
   def get_entities_linked(params)
     warn '[DEPRECATION] `get_entities_linked` is deprecated. Please use ' \
-         '`get_entities` instead with `resolve_entities` param set to true.'
+         '`get_entities` instead.'
     get_entities(params, true)
   end
 
+
+
   # Extracts Tier 1 contextual categories from the input.
   #
   # ==== Attributes

data/tests/tests_spec.rb

@@ -18,7 +18,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'language'}.to_json, headers: {})
     end
     it 'test language' do
@@ -55,7 +55,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'morphology/complete'}.to_json, headers: {})
     end
     it 'test morphology complete' do
@@ -77,7 +77,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'morphology/compound-components'}.to_json, headers: {})
     end
     it 'test morphology compound components' do
@@ -99,7 +99,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'morphology/han-readings'}.to_json, headers: {})
     end
     it 'test morphology han readings' do
@@ -121,7 +121,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'morphology/parts-of-speech'}.to_json, headers: {})
     end
     it 'test morphology parts of speech' do
@@ -143,7 +143,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'morphology/lemmas'}.to_json, headers: {})
     end
     it 'test morphology lemmas' do
@@ -165,7 +165,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'entities'}.to_json, headers: {})
     end
     it 'test entities' do
@@ -177,10 +177,10 @@ describe RosetteAPI do
     end
   end
 
-  describe '.get_entities_linked' do
-    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/entities_linked.json'))
+  describe '.get_entities_no_qids' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/entities_no_qids.json'))
     before do
-      stub_request(:post, 'https://api.rosette.com/rest/v1/entities/linked').
+      stub_request(:post, 'https://api.rosette.com/rest/v1/entities').
           with(body: request_file,
                headers: {'Accept' => 'application/json',
                             'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
@@ -188,22 +188,24 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
-          to_return(status: 200, body: {'test': 'entities/linked'}.to_json, headers: {})
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
+          to_return(status: 200, body: {'test': 'entities'}.to_json, headers: {})
     end
-    it 'test entities linked' do
+    it 'test entities without qids' do
       params = DocumentParameters.new
       params.content = 'Last month director Paul Feig announced the movie will have an all-star female cast including' \
                        ' Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon.'
-      response = RosetteAPI.new('0123456789').get_entities(params, true)
+      params.rosette_options = { linkEntities: false}
+      response = RosetteAPI.new('0123456789').get_entities(params)
       expect(response).instance_of? Hash
     end
 
-    it 'test entities linked for resolve_entities is not a boolean' do
+    it 'test rosette_options is not a Hash' do
       params = DocumentParameters.new
       params.content = 'Last month director Paul Feig announced the movie will have an all-star female cast including' \
                        ' Kristen Wiig, Melissa McCarthy, Leslie Jones and Kate McKinnon.'
-      expect { RosetteAPI.new('0123456789').get_entities(params, 'smth') }.to raise_error(BadRequestError)
+      params.rosette_options = 1
+      expect { RosetteAPI.new('0123456789').get_entities(params) }.to raise_error(BadRequestError)
     end
   end
 
@@ -218,7 +220,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'categories'}.to_json, headers: {})
     end
     it 'test categories' do
@@ -240,7 +242,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'relationships'}.to_json, headers: {})
     end
     it 'test relationships' do
@@ -262,7 +264,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'name-translation'}.to_json, headers: {})
     end
     it 'test name translation' do
@@ -289,7 +291,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'name-similarity'}.to_json, headers: {})
     end
     it 'test name similarity' do
@@ -325,7 +327,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'tokens'}.to_json, headers: {})
     end
     it 'test tokens' do
@@ -347,7 +349,7 @@ describe RosetteAPI do
                             'User-Agent' => 'Ruby',
                             'X-Rosetteapi-Key' => '0123456789',
                             'X-Rosetteapi-Binding' => 'ruby',
-                            'X-Rosetteapi-Binding-Version' => '1.1.0'}).
+                            'X-Rosetteapi-Binding-Version' => '1.1.1'}).
           to_return(status: 200, body: {'test': 'sentences'}.to_json, headers: {})
     end
     it 'test sentences' do
@@ -391,5 +393,43 @@ describe RosetteAPI do
     end
   end
 
+  describe '.get_language_custom_header' do
+    request_file = File.read File.expand_path(File.join(File.dirname(__FILE__), '../mock-data/request/language.json'))
+    before do
+      stub_request(:post, 'https://api.rosette.com/rest/v1/language').
+          with(body: request_file,
+               headers: {'Accept' => 'application/json',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'Content-Type' => 'application/json',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789',
+                            'X-Rosetteapi-Binding' => 'ruby',
+                            'X-Rosetteapi-Binding-Version' => '1.1.1',
+                            'X-RosetteApi-App' => 'ruby-app'}).
+          to_return(status: 200, body: {'test': 'language'}.to_json, headers: {})
+    end
+
+    it 'test custom_headers is invalid' do
+      params = DocumentParameters.new
+      params.content = 'Por favor Senorita, says the man.?'
+      params.custom_headers = { 'test': 'ruby-app'}
+      expect { RosetteAPI.new('0123456789').get_language(params) }.to raise_error(RosetteAPIError)
+    end
+  end
+
+  describe '.error_409_incompatible_client_version' do
+    before do
+      stub_request(:get, 'https://api.rosette.com/rest/v1/info').
+          with(headers: {'Accept' => '*/*',
+                            'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+                            'User-Agent' => 'Ruby',
+                            'X-Rosetteapi-Key' => '0123456789'}).
+          to_return(status: 409, body: {'code': 'incompatibleClientVersion'}.to_json, headers: {})
+    end
+    it 'test error 409 properly handled' do
+      expect { RosetteAPI.new('0123456789').info }.to raise_error(RosetteAPIError)
+    end
+  end
+
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rosette_api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Basis Technology Corp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-02 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubysl-securerandom
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 2
 summary: Rosette API gem that supports multilingual text-analytics.