WatsonNLPWrapper 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9add1c46b3d018c6604b8842a746999b56e64dc4
-  data.tar.gz: 9e1d10de405f9f90c6ec6c16927a7a04ea2917b5
+  metadata.gz: 2f1164982eb594a4d0a61c032390470cbd666e47
+  data.tar.gz: 0c0fab4adc203dc840778f3ebf42b8cca97a6408
 SHA512:
-  metadata.gz: ed3d4907aa3cea062c547a85d1f1b25cb3e66ce492fe28f0062ca82ea3de577619ac5eef094d8327b30076d823e3aaec4334fe57d1c1de97177b354524401baa
-  data.tar.gz: 3b2ba52ff23d67c3505676d397d9d852409812f4e53df175e585157feffc46b025f7278ec579ed0eab5eaec0516464c48c8262cd9fdefc66f78561134edadb44
+  metadata.gz: c27cc2db01ff6c14f0ef1a420f7a2cd22ac6f8091ab4aaa8ff51dc2d2c63a107d8e4ddb72f1c14fb8faf85d4bc4f42a7da5dc4d83ed800e187af3121fd300d31
+  data.tar.gz: d930b5ab986291ef15bf2cdd07b9049c8682d36d36040e0c5094822a049412c8c9a4060c17dc5b6baf698eab2175e6378e675c9a0fa5b98042863e823c25f03b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    WatsonNLPWrapper (1.0.0)
+    WatsonNLPWrapper (1.1.0)
       httparty (~> 0.13.7)
       json (~> 1.8)
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 TODO: Write your name
+Copyright (c) 2018 Rohan Anand
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,10 @@
 # WatsonNLPWrapper
 
 [![Build Status](https://travis-ci.org/thededlier/WatsonNLPWrapper.svg?branch=master)](https://travis-ci.org/thededlier/WatsonNLPWrapper)
+[![Gem Version](https://badge.fury.io/rb/WatsonNLPWrapper.svg)](https://badge.fury.io/rb/WatsonNLPWrapper)
+[rubygems.org/gems/WatsonNLPWrapper](https://rubygems.org/gems/WatsonNLPWrapper)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/WatsonNLPWrapper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a simple ruby wrapper implementation of IBM's Watson Natural Language Understanding API which is used to analyze text to extract meta-data from content
 
 ## Installation
 
@@ -24,13 +24,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Require the library
+require "WatsonNLPWrapper"
+
+# Initialize
+# Version parameter is not needed to be sent and by default is 2018-03-16
+nlp = WatsonNLPWrapper::WatsonNLPApi.new('{url}', '{username}', '{password}', '{version}')
+
+# Set sample text
+text = '{sample text}'
+
+# Call the analyze API with default features
+# This will give a json response
+nlp.analyze(text)
+
+# If you want to enable specific features only and not the default features
+
+features =
+  {
+    entities: {
+      emotion: true,
+      sentiment: true,
+      limit: 2
+    },
+    keywords: {
+      emotion: true,
+      sentiment: true,
+      limit: 2
+    }
+  }
+
+nlp.analyze(text, features)
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/WatsonNLPWrapper.rb

@@ -10,6 +10,9 @@ module WatsonNLPWrapper
     include WatsonNLPWrapper::Constants
     # Initialize instance variables for use later
     def initialize(url, username, password, version = DEFAULT_VERSION)
+      if url.nil? || username.nil? || password.nil? || version.nil?
+        raise ArgumentError.new(NIL_ARGUMENT_ERROR)
+      end
       @url = url
       @username = username
       @password = password
@@ -18,6 +21,10 @@ module WatsonNLPWrapper
 
     # Sends a POST request to analyze text with certain features enabled
     def analyze(text, features = default_features)
+      if text.nil? || features.nil?
+        raise ArgumentError.new(NIL_ARGUMENT_ERROR)
+      end
+
       response = self.class.post(
         "#{@url}/analyze?version=#{@version}",
         body: {
@@ -33,28 +40,29 @@ module WatsonNLPWrapper
       response.parsed_response
     end
 
-    # Returns credentials used for basic auth
-    def auth
-      {
-        username: @username,
-        password: @password
-      }
-    end
+    private
+      # Returns credentials used for basic auth
+      def auth
+        {
+          username: @username,
+          password: @password
+        }
+      end
 
-    # Default features if no features specified
-    def default_features
-      {
-        entities: {
-          emotion: true,
-          sentiment: true,
-          limit: 2
-        },
-        keywords: {
-          emotion: true,
-          sentiment: true,
-          limit: 2
+      # Default features if no features specified
+      def default_features
+        {
+          entities: {
+            emotion: true,
+            sentiment: true,
+            limit: 2
+          },
+          keywords: {
+            emotion: true,
+            sentiment: true,
+            limit: 2
+          }
         }
-      }
-    end
+      end
   end
 end

data/lib/WatsonNLPWrapper/constants.rb

@@ -2,5 +2,7 @@ module WatsonNLPWrapper
   module Constants
     DEFAULT_VERSION = '2018-03-16'
     CONTENT_TYPE = 'application/json'
+
+    NIL_ARGUMENT_ERROR = "Arguments cannot be nil"
   end
 end

data/lib/WatsonNLPWrapper/version.rb

@@ -1,3 +1,3 @@
 module WatsonNLPWrapper
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: WatsonNLPWrapper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rohan Anand
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler