Merge branch 'develop'

rosette-api · Dec 19, 2016 · 823594f · 823594f
2 parents 757e575 + ec96e20
commit 823594f
Show file tree

Hide file tree

Showing 26 changed files with 519 additions and 169 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,312 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-12-07 10:52:04 -0500 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/Gemfile, **/gems.rb
+Bundler/OrderedGems:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 2
+Lint/Void:
+  Exclude:
+    - 'examples/sentences.rb'
+    - 'examples/sentiment.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 41
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/BlockLength:
+  Max: 425
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 140
+
+# Offense count: 142
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 408
+
+# Offense count: 6
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 42
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 94
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Style/AlignHash:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/BlockEndNewline:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 18
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly.
+# SupportedStyles: assign_to_condition, assign_inside_condition
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Offense count: 40
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: leading, trailing
+Style/DotPosition:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAdjacentOneLineDefs.
+Style/EmptyLineBetweenDefs:
+  Exclude:
+    - 'lib/rosette_api.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Exclude:
+    - 'examples/sentiment.rb'
+    - 'lib/request_builder.rb'
+    - 'rosette_api.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, no_empty_lines
+Style/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'lib/request_builder.rb'
+
+# Offense count: 3
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+Style/FileName:
+  Exclude:
+    - 'examples/morphology_compound-components.rb'
+    - 'examples/morphology_han-readings.rb'
+    - 'examples/morphology_parts-of-speech.rb'
+
+# Offense count: 2
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: for, each
+Style/For:
+  EnforcedStyle: for
+
+# Offense count: 30
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: when_needed, always
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 4
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/name_similarity_parameters.rb'
+    - 'lib/name_translation_parameters.rb'
+    - 'lib/request_builder.rb'
+
+# Offense count: 90
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: normal, rails
+Style/IndentationConsistency:
+  Exclude:
+    - 'examples/sentences.rb'
+    - 'examples/sentiment.rb'
+    - 'lib/rosette_api.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: Width.
+Style/IndentationWidth:
+  Exclude:
+    - 'examples/morphology_han-readings.rb'
+    - 'lib/request_builder.rb'
+    - 'tests/tests_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MultilineBlockLayout:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 41
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: aligned, indented, indented_relative_to_receiver
+Style/MultilineMethodCallIndentation:
+  Exclude:
+    - 'tests/tests_spec.rb'
+
+# Offense count: 15
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/rosette_api.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/NegatedIf:
+  Exclude:
+    - 'lib/name_translation_parameters.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IncludeSemanticChanges.
+Style/NonNilCheck:
+  Exclude:
+    - 'lib/request_builder.rb'
+
+# Offense count: 2
+Style/OptionalArguments:
+  Exclude:
+    - 'lib/request_builder.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'rosette_api.gemspec'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 7
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/document_parameters.rb'
+    - 'lib/name_parameter.rb'
+    - 'lib/name_similarity_parameters.rb'
+    - 'lib/name_translation_parameters.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SpaceAfterColon:
+  Exclude:
+    - 'examples/name_similarity.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Style/SpaceAroundOperators:
+  Exclude:
+    - 'examples/language.rb'
+    - 'rosette_api.gemspec'
+
+# Offense count: 56
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+# SupportedStyles: space, no_space, compact
+Style/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'examples/language.rb'
+    - 'tests/tests_spec.rb'
+
+# Offense count: 44
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'examples/categories.rb'
+    - 'examples/entities.rb'
+    - 'examples/language.rb'
+    - 'examples/morphology_complete.rb'
+    - 'examples/morphology_compound-components.rb'
+    - 'examples/morphology_han-readings.rb'
+    - 'examples/name_similarity.rb'
+    - 'examples/name_translation.rb'
+    - 'examples/sentiment.rb'
+    - 'examples/syntax_dependencies.rb'
+    - 'examples/tokens.rb'
+    - 'tests/tests_spec.rb'
+
+# Offense count: 14
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: final_newline, final_blank_line
+Style/TrailingBlankLines:
+  Exclude:
+    - 'examples/info.rb'
+    - 'examples/language.rb'
+    - 'examples/morphology_compound-components.rb'
+    - 'examples/morphology_han-readings.rb'
+    - 'examples/morphology_lemmas.rb'
+    - 'examples/morphology_parts-of-speech.rb'
+    - 'examples/name_similarity.rb'
+    - 'examples/name_translation.rb'
+    - 'examples/ping.rb'
+    - 'examples/sentences.rb'
+    - 'examples/sentiment.rb'
+    - 'examples/tokens.rb'
+    - 'lib/rosette_api.rb'
+    - 'lib/rosette_api_error.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/TrailingWhitespace:
+  Exclude:
+    - 'lib/request_builder.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'rosette_api.gemspec'
diff --git a/examples/README.md b/examples/README.md
@@ -22,7 +22,6 @@ Each example, when run, prints its output to the console.
 | -------------                 |-------------                                        |
 | categories.rb                    | Gets the category of a document at a URL              | 
 | entities.rb                      | Gets the entities from a piece of text                | 
-| entities_linked.rb               | Gets the linked (to Wikipedia) entities from a piece of text |
 | info.rb                          | Gets information about Rosette API                    | 
 | language.rb                      | Gets the language of a piece of text                  | 
 | name_similarity.rb                  | Gets the similarity score of two names                |

diff --git a/examples/categories.rb b/examples/categories.rb
@@ -9,6 +9,10 @@
 end
 
 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)
+begin
+    params = DocumentParameters.new(content_uri: categories_url_data)
+    response = rosette_api.get_categories(params)
+    puts JSON.pretty_generate(response)
+rescue RosetteAPIError => rosette_api_error
+    printf("Rosette API Error (%s): %s", rosette_api_error.status_code, rosette_api_error.message)
+end
diff --git a/examples/entities.rb b/examples/entities.rb
@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'rosette_api'
 
 api_key, url = ARGV
@@ -9,6 +10,10 @@
 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"
-params = DocumentParameters.new(content: entities_text_data, genre: 'social-media')
-response = rosette_api.get_entities(params)
-puts JSON.pretty_generate(response)
+begin
+    params = DocumentParameters.new(content: entities_text_data, genre: 'social-media')
+    response = rosette_api.get_entities(params)
+    puts JSON.pretty_generate(response)
+rescue RosetteAPIError => rosette_api_error
+    printf("Rosette API Error (%s): %s", rosette_api_error.status_code, rosette_api_error.message)
+end
diff --git a/examples/entities_linked.rb b/examples/entities_linked.rb
diff --git a/examples/info.rb b/examples/info.rb
@@ -8,4 +8,8 @@
   rosette_api = RosetteAPI.new(api_key, url)
 end
 response = rosette_api.info
-puts JSON.pretty_generate(response)
+begin
+    puts JSON.pretty_generate(response)
+rescue RosetteAPIError => rosette_api_error
+    printf("Rosette API Error (%s): %s", rosette_api_error.status_code, rosette_api_error.message)
+end
diff --git a/examples/language.rb b/examples/language.rb
@@ -9,7 +9,11 @@
 end
 
 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)
-puts JSON.pretty_generate(response)
+begin
+    params = DocumentParameters.new(content: language_data)
+    params.custom_headers = { 'X-RosetteAPI-App'=> 'ruby-app'}
+    response = rosette_api.get_language(params)
+    puts JSON.pretty_generate(response)
+rescue RosetteAPIError => rosette_api_error
+    printf("Rosette API Error (%s): %s", rosette_api_error.status_code, rosette_api_error.message)
+end