Merge branch 'develop'

Chris Park · Chris Park · commit 757e575545ab · 2016-10-06T13:13:15.000Z
diff --git a/README.md b/README.md
@@ -1,25 +1,29 @@
 [![Build Status](https://travis-ci.org/rosette-api/ruby.svg?branch=develop)](https://travis-ci.org/rosette-api/ruby)
 
-Ruby client binding for Rosette API
-==================================
+# Ruby client binding for Rosette API #
 See the wiki for more information.
 
-Installation
-------------
+## Installation ##
 
 `gem install rosette_api`
 
-Basic Usage
------------
+## Docker ##
+A Docker image for running the examples against the compiled source library is available on Docker Hub.
+
+Command: `docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-ruby`
+
+Additional environment settings:
+`-e ALT_URL=<alternative URL>`
+`-e FILENAME=<single filename>`
+
+## Basic Usage ##
 
 See [examples](examples)
 
-API Documentation
------------------
+## API Documentation ##
 
 See [documentation](http://rosette-api.github.io/ruby)
 
-Additional Information
-----------------------
+## Additional Information ##
 
 Visit [Rosette API site](https://developer.rosette.com)
diff --git a/docker/Dockerfile b/docker/Dockerfile
diff --git a/docker/README.md b/docker/README.md
diff --git a/docker/run_ruby.sh b/docker/run_ruby.sh
diff --git a/examples/categories.rb b/examples/categories.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-categories_url_data = 'http://www.onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/'
+categories_url_data = "http://www.onlocationvacations.com/2015/03/05/the-new-ghostbusters-movie-begins-filming-in-boston-in-june/"
 params = DocumentParameters.new(content_uri: categories_url_data)
 response = rosette_api.get_categories(params)
 puts JSON.pretty_generate(response)
diff --git a/examples/entities.rb b/examples/entities.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-entities_text_data = 'Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS'
+entities_text_data = "Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS"
 params = DocumentParameters.new(content: entities_text_data, genre: 'social-media')
 response = rosette_api.get_entities(params)
 puts JSON.pretty_generate(response)
diff --git a/examples/entities_linked.rb b/examples/entities_linked.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-entities_linked_text_data = '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.'
+entities_linked_text_data = "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."
 params = DocumentParameters.new(content: entities_linked_text_data, genre: 'social-media')
 response = rosette_api.get_entities(params, true)
 puts JSON.pretty_generate(response)
diff --git a/examples/language.rb b/examples/language.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-language_data = 'Por favor Señorita, says the man.?'
+language_data = "Por favor Señorita, says the man."
 params = DocumentParameters.new(content: language_data)
 params.custom_headers = { 'X-RosetteAPI-App'=> 'ruby-app'}
 response = rosette_api.get_language(params)
diff --git a/examples/morphology_complete.rb b/examples/morphology_complete.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-morphology_complete_data = 'The quick brown fox jumped over the lazy dog. Yes he did.'
+morphology_complete_data = "The quick brown fox jumped over the lazy dog. Yes he did."
 params = DocumentParameters.new(content: morphology_complete_data)
 response = rosette_api.get_morphology_complete(params)
 puts JSON.pretty_generate(response)
diff --git a/examples/morphology_compound-components.rb b/examples/morphology_compound-components.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-morphology_compound_components_data = 'Rechtsschutzversicherungsgesellschaften'
+morphology_compound_components_data = "Rechtsschutzversicherungsgesellschaften"
 params = DocumentParameters.new(content: morphology_compound_components_data)
 response = rosette_api.get_compound_components(params)
 puts JSON.pretty_generate(response)
diff --git a/examples/morphology_han-readings.rb b/examples/morphology_han-readings.rb
@@ -8,7 +8,7 @@
     rosette_api = RosetteAPI.new(api_key, url)
 end
 
-morphology_han_readings_data = '北京大学生物系主任办公室内部会议'
+morphology_han_readings_data = "北京大学生物系主任办公室内部会议"
 params = DocumentParameters.new(content: morphology_han_readings_data)
 response = rosette_api.get_han_readings(params)
 puts JSON.pretty_generate(response)
diff --git a/examples/name_similarity.rb b/examples/name_similarity.rb
@@ -8,8 +8,8 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-matched_name_data1 = 'Michael Jackson'
-matched_name_data2 = '迈克尔·杰克逊'
+matched_name_data1 = "Michael Jackson"
+matched_name_data2 = "迈克尔·杰克逊"
 name1 = NameParameter.new(matched_name_data1, entity_type: 'PERSON', language:'eng')
 params = NameSimilarityParameters.new(name1, matched_name_data2)
 response = rosette_api.name_similarity(params)
diff --git a/examples/name_translation.rb b/examples/name_translation.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-translated_name_data = 'معمر محمد أبو منيار القذاف'
+translated_name_data = "معمر محمد أبو منيار القذاف"
 params = NameTranslationParameters.new(translated_name_data, 'eng', target_script: 'Latn')
 response = rosette_api.name_translation(params)
 puts JSON.pretty_generate(response)
diff --git a/examples/relationships.rb b/examples/relationships.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-relationships_text_data = 'The Ghostbusters movie was filmed in Boston.'
+relationships_text_data = "Bill Gates, Microsoft's former CEO, is a philanthropist."
 params = DocumentParameters.new(content: relationships_text_data)
 params.rosette_options = { accuracyMode: 'PRECISION' }
 response = rosette_api.get_relationships(params)
diff --git a/examples/sentences.rb b/examples/sentences.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-sentences_data = 'This land is your land. This land is my land\nFrom California to the New York island;\nFrom the' \
+sentences_data = "This land is your land. This land is my land\nFrom California to the New York island;\nFrom the red wood forest to the Gulf Stream waters\n\nThis land was made for you and Me.\n\nAs I was walking that ribbon of highway,\nI saw above me that endless skyway:\nI saw below me that golden valley:\nThis land was made for you and me."
                  ' wood forest to the Gulf Stream waters\n\nThis land was made for you and Me.\n\nAs I was walking' \
                  ' that ribbon of highway,\nI saw above me that endless skyway:\nI saw below me that' \
                  ' golden valley:\nThis land was made for you and me.'
diff --git a/examples/sentiment.rb b/examples/sentiment.rb
@@ -11,7 +11,7 @@
 
 
 file = Tempfile.new(%w(foo .html))
-sentiment_file_data = '<html><head><title>New Ghostbusters Film</title></head><body><p>Original Ghostbuster Dan ' \
+sentiment_file_data = "<html><head><title>New Ghostbusters Film</title></head><body><p>Original Ghostbuster Dan Aykroyd, who also co-wrote the 1984 Ghostbusters film, couldn’t be more pleased with the new all-female Ghostbusters cast, telling The Hollywood Reporter, “The Aykroyd family is delighted by this inheritance of the Ghostbusters torch by these most magnificent women in comedy.”</p></body></html>"
                       'Aykroyd, who also co-wrote the 1984 Ghostbusters film, couldn’t be more pleased with the new ' \
                       'all-female Ghostbusters cast, telling The Hollywood Reporter, The Aykroyd family is delighted ' \
                       'by this inheritance of the Ghostbusters torch by these most magnificent women in comedy ' \
diff --git a/examples/syntax_dependencies.rb b/examples/syntax_dependencies.rb
@@ -0,0 +1,14 @@
+require 'rosette_api'
+
+api_key, url = ARGV
+
+if !url
+  rosette_api = RosetteAPI.new(api_key)
+else
+  rosette_api = RosetteAPI.new(api_key, url)
+end
+
+syntax_dependencies_data = "Yoshinori Ohsumi, a Japanese cell biologist, was awarded the Nobel Prize in Physiology or Medicine on Monday."
+params = DocumentParameters.new(content: syntax_dependencies_data, genre: 'social-media')
+response = rosette_api.get_syntax_dependencies(params)
+puts JSON.pretty_generate(response)
diff --git a/examples/tokens.rb b/examples/tokens.rb
@@ -8,7 +8,7 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 
-tokens_data = '北京大学生物系主任办公室内部会议'
+tokens_data = "北京大学生物系主任办公室内部会议"
 params = DocumentParameters.new(content: tokens_data)
 response = rosette_api.get_tokens(params)
 puts JSON.pretty_generate(response)
diff --git a/lib/request_builder.rb b/lib/request_builder.rb
@@ -24,7 +24,6 @@ def initialize(user_key, alternate_url, http_client, params = {}, binding_versio
     @alternate_url = alternate_url
     @http_client = http_client
     @params = params
-    @retries = 5
     @binding_version = binding_version
 
   end
@@ -173,17 +172,7 @@ def get_response(http, request)
     if response.code != '200'
       message = JSON.parse(response.body)['message']
       code = JSON.parse(response.body)['code']
-      if response.code == '429'
-        if @retries != 0
-          @retries = @retries - 1
-          sleep 15
-          self.get_response(http, request)
-        else
-          raise RosetteAPIError.new code, message
-        end
-      else
-        raise RosetteAPIError.new code, message
-      end
+      raise RosetteAPIError.new code, message
     else
       response_headers = {}
       response.header.each_header { |key, value| response_headers[key] = value }
diff --git a/lib/rosette_api.rb b/lib/rosette_api.rb
@@ -9,7 +9,7 @@
 # This class allows you to access all Rosette API endpoints.
 class RosetteAPI
   # Version of Ruby binding
-  BINDING_VERSION = '1.3.0'
+  BINDING_VERSION = '1.4.0'
   # Rosette API language endpoint
   LANGUAGE_ENDPOINT = '/language'
   # Rosette API morphology endpoint
@@ -36,6 +36,8 @@ class RosetteAPI
   PING = '/ping'
   # Text Embedding endpoint
   TEXT_EMBEDDING = '/text-embedding'
+  # Syntactic Dependencies endpoint
+  SYNTACTIC_DEPENDENCIES_ENDPOINT = '/syntax/dependencies'
 
   # Rosette API key
   attr_accessor :user_key
@@ -323,6 +325,23 @@ def get_text_embedding(params)
                   .send_post_request
   end
 
+  #
+  # Returns the vectors associated with the text
+  #
+  # ==== Attributes
+  #
+  # * +params+ - DocumentParameters helps to build the request body in RequestBuilder.
+  #
+  # Returns list of linguistic sentences of the input.
+  def get_syntax_dependencies(params)
+    check_params params
+
+    params = params.load_params
+
+    RequestBuilder.new(@user_key, @alternate_url + SYNTACTIC_DEPENDENCIES_ENDPOINT, @http_client, params, BINDING_VERSION)
+                  .send_post_request
+  end
+
   # Gets information about the Rosette API, returns name, build number
   # and build time.
   def info
diff --git a/rosette_api.gemspec b/rosette_api.gemspec
diff --git a/tests/tests_spec.rb b/tests/tests_spec.rb
