qna_maker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4103f532e31d381a82ed32c049d72a21547b3fae676d97630db2b5d1fc66a8b
-  data.tar.gz: ae4efc18758b6a37e439f7d999d47ecf6e0f4b3d44f6d30ba907d72bff6daa2a
+  metadata.gz: 0ee955956af27b2b001676c32496cd94f4c89db0ee3bd7c5d3717c22e955209e
+  data.tar.gz: e664c1ac7c731bbf5aa0c6fd9c81603674a489824fa1cdd475d123f6deade505
 SHA512:
-  metadata.gz: 35f412b81b086f3b167e234453665cc8992514fd486b2271600245053d7cc2723cd50cf9b0076dd1f741753bbb79aede1d391c7f3e2c24259667f73ac9a727c9
-  data.tar.gz: 07c989011fd502a8073e6513970d18a3701703cfe53a4b366352b918886e676d54770a952f4b7cba024b2a0ff3bf514429a5d30b0943a5c78d1c3f12ff95ae78
+  metadata.gz: 6ee21db904abbf80f6eb34edb3d9da0ffc19e4f7bb47e5ff846c137b874b7286857b63fae99913aaac388830d411e317ad54daf64aecf66c4f2de7823661b469
+  data.tar.gz: 1c0785b5c633dc95f3c32aa4af42bd42a9f53885a2b22c0473b661c58bf8d44bfb14783dab92027c61118405c58f95b7d5ec65c5bae9b43f232e99213efff977

data/.gitignore

@@ -6,7 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
-Gemfile.lock

data/.rubocop.yml

@@ -1,3 +1,5 @@
 # Disable all metrics.
 Metrics:
   Enabled: false
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -2,4 +2,6 @@ sudo: false
 language: ruby
 rvm:
   - 2.5.0
+  - 2.4.4
+  - 2.3.7
 before_install: gem install bundler -v 1.16.1

data/README.md

@@ -1,6 +1,10 @@
 # QnAMaker
 
-API wrapper for [QnA Maker](https://qnamaker.ai) 
+![Gem](https://img.shields.io/gem/dv/qna_maker/stable.svg)
+[![Build Status](https://travis-ci.org/Birdie0/qna_maker.svg?branch=master)](https://travis-ci.org/Birdie0/qna_maker)
+[![Maintainability](https://api.codeclimate.com/v1/badges/96bf3ebcfe21cd1b9359/maintainability)](https://codeclimate.com/github/Birdie0/qna_maker/maintainability)
+
+API wrapper for [QnA Maker](https://qnamaker.ai)
 
 ## Installation
 
@@ -24,13 +28,13 @@ Or install it yourself as:
 require 'qna_maker'
 
 client = QnAMaker::Client.new('kb_id' , 'subscription_key')
-# => #<QnAMaker::Client @knowledgebase_id="kb_id", @subscription_key="subscription_key", ...>
+#=> #<QnAMaker::Client @knowledgebase_id="kb_id", @subscription_key="subscription_key", ...>
 
 answers = client.generate_answer('hi')
-# => [#<QnAMaker::Answer @answer="hello", @questions=["hi"], @score=100.0>]
+#=> [#<QnAMaker::Answer @answer="hello", @questions=["hi"], @score=100.0>]
 
-puts answers.first.answer
-# => hello
+answers.first.answer
+#=> "hello"
 ```
 
 ## Development status
@@ -39,16 +43,16 @@ Gem is under active development! It isn't finished yet!
 
 ### Todo list
 
-* [ ] Methods
+* [x] Methods
   * [x] **POST** - Create Knowledge Base
   * [x] **DELETE** - Delete Knowledge Base
   * [x] **GET** - Download Alterations
   * [x] **GET** - Download Knowledge Base
   * [x] **POST** - Generate answer
   * [x] **PUT** - Publish Knowledge Base
-  * [ ] **PATCH** - Train Knowledge Base
-  * [ ] **PATCH** - Update Alterations
-  * [ ] **PATCH** - Update Knowledge Base
+  * [x] **PATCH** - Train Knowledge Base
+  * [x] **PATCH** - Update Alterations
+  * [x] **PATCH** - Update Knowledge Base
 * [ ] Documentation
 * [ ] Tests
 

data/bin/console

@@ -3,12 +3,5 @@
 require 'bundler/setup'
 require 'qna_maker'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)
+require 'pry'
+Pry.start

data/lib/qna_maker/endpoints/create_kb.rb

@@ -22,7 +22,7 @@ module QnAMaker
       when 401
         raise UnauthorizedError, response.parse['error']['message']
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
 
@@ -48,7 +48,7 @@ module QnAMaker
       when 401
         raise UnauthorizedError, response.parse['error']['message']
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
   end

data/lib/qna_maker/endpoints/delete_kb.rb

@@ -13,13 +13,13 @@ module QnAMaker
       when 401
         raise UnauthorizedError, response.parse['error']['message']
       when 403
-        raise QuotaExceededError, response.parse['error']['message'].join(' ')
+        raise ForbiddenError, response.parse['error']['message']
       when 404
-        raise NotFoundError, response.parse['error']['message'].join(' ')
+        raise NotFoundError, response.parse['error']['message']
       when 409
-        raise ConflictError, response.parse['error']['message'].join(' ')
+        raise ConflictError, response.parse['error']['message']
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
 
@@ -36,13 +36,13 @@ module QnAMaker
       when 401
         raise UnauthorizedError, response.parse['error']['message']
       when 403
-        raise QuotaExceededError, response.parse['error']['message'].join(' ')
+        raise ForbiddenError, response.parse['error']['message']
       when 404
-        raise NotFoundError, response.parse['error']['message'].join(' ')
+        raise NotFoundError, response.parse['error']['message']
       when 409
-        raise ConflictError, response.parse['error']['message'].join(' ')
+        raise ConflictError, response.parse['error']['message']
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
   end

data/lib/qna_maker/endpoints/download_alterations.rb

@@ -18,11 +18,11 @@ module QnAMaker
       when 401
         raise UnauthorizedError, response.parse['error']['message']
       when 403
-        raise QuotaExceededError, response.parse['error']['message'].join(' ')
+        raise ForbiddenError, response.parse['error']['message']
       when 404
-        raise NotFoundError, response.parse['error']['message'].join(' ')
+        raise NotFoundError, response.parse['error']['message']
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
   end

data/lib/qna_maker/endpoints/download_kb.rb

@@ -13,11 +13,11 @@ module QnAMaker
       when 401
         raise UnauthorizedError, response.parse['error']['message']
       when 403
-        raise QuotaExceededError, response.parse['error']['message'].join(' ')
+        raise ForbiddenError, response.parse['error']['message'].join(' ')
       when 404
         raise NotFoundError, response.parse['error']['message'].join(' ')
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
   end

data/lib/qna_maker/endpoints/generate_answer.rb

@@ -20,15 +20,15 @@ module QnAMaker
       when 401
         raise UnauthorizedError, response.parse['error']['message']
       when 403
-        raise QuotaExceededError, response.parse['error']['message'].join(' ')
+        raise QuotaExceededError, response.parse['error']['message']
       when 404
-        raise NotFoundError, response.parse['error']['message'].join(' ')
+        raise NotFoundError, response.parse['error']['message']
       when 408
-        raise OperationTimeOutError, response.parse['error']['message'].join(' ')
+        raise OperationTimeOutError, response.parse['error']['message']
       when 429
-        raise RateLimitExceededError, response.parse['error']['message'].join(' ')
+        raise RateLimitExceededError, response.parse['error']['message']
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
   end

data/lib/qna_maker/endpoints/publish_kb.rb

@@ -12,14 +12,14 @@ module QnAMaker
         raise BadArgumentError, response.parse['error']['message'].join(' ')
       when 401
         raise UnauthorizedError, response.parse['error']['message']
-      when 404
-        raise NotFoundError, response.parse['error']['message'].join(' ')
       when 403
-        raise QuotaExceededError, response.parse['error']['message'].join(' ')
+        raise ForbiddenError, response.parse['error']['message']
+      when 404
+        raise NotFoundError, response.parse['error']['message']
       when 409
-        raise ConflictError, response.parse['error']['message'].join(' ')
+        raise ConflictError, response.parse['error']['message']
       else
-        raise UnknownError, 'Oh no!'
+        raise UnknownError, "Oh no! (#{response.code})"
       end
     end
   end

data/lib/qna_maker/endpoints/train_kb.rb

@@ -1,19 +1,35 @@
-# def train_kb(user_question, kb_question, kb_answer)
-#   response = HTTP.patch(
-#     full_url(:train_kb),
-#     json: {
-#       feedbackRecords: [{
-#         userId: '1',
-#         userQuestion: user_question,
-#         kbQuestion: kb_question,
-#         kbAnswer: kb_answer
-#       }]
-#     }
-#   )
-#   case response.code
-#   when 204
-#     'Success!'
-#   else
-#     response.code
-#   end
-# end
+module QnAMaker
+  class Client
+    def train_kb(feedback_records = [])
+      feedback_records = feedback_records.map do |record|
+        { userId: record[0],
+          userQuestion: record[1],
+          kbQuestion: record[2],
+          kbAnswer: record[3] }
+      end
+      response = @http.patch(
+        "#{BASE_URL}/#{@knowledgebase_id}/train",
+        json: { feedbackRecords: feedback_records }
+      )
+
+      case response.code
+      when 204
+        nil
+      when 400
+        raise BadArgumentError, response.parse['error']['message'].join(' ')
+      when 401
+        raise UnauthorizedError, response.parse['error']['message']
+      when 403
+        raise ForbiddenError, response.parse['error']['message']
+      when 404
+        raise NotFoundError, response.parse['error']['message']
+      when 408
+        raise OperationTimeOutError, response.parse['error']['message']
+      when 429
+        raise RateLimitExceededError, response.parse['error']['message']
+      else
+        raise UnknownError, "Oh no! (#{response.code})"
+      end
+    end
+  end
+end

data/lib/qna_maker/endpoints/update_alterations.rb

@@ -0,0 +1,27 @@
+module QnAMaker
+  class Client
+    def update_alterations(add = [], delete = [])
+      response = @http.patch(
+        "#{BASE_URL}/#{@knowledgebase_id}/updateAlterations",
+        json: { add: add, delete: delete }
+      )
+
+      case response.code
+      when 204
+        nil
+      when 400
+        raise BadArgumentError, response.parse['error']['message'].join(' ')
+      when 401
+        raise UnauthorizedError, response.parse['error']['message']
+      when 403
+        raise ForbiddenError, response.parse['error']['message']
+      when 404
+        raise NotFoundError, response.parse['error']['message']
+      when 409
+        raise ConflictError, response.parse['error']['message']
+      else
+        raise UnknownError, "Oh no! (#{response.code})"
+      end
+    end
+  end
+end

data/lib/qna_maker/endpoints/update_kb.rb

@@ -1,13 +1,33 @@
-# def update_kb(add = [], delete = [])
-#   response = HTTP.patch(
-#     full_url(:update_kb),
-#     json: { add: { qnaPairs: add }, delete: { qnaPairs: delete } }
-#   )
+module QnAMaker
+  class Client
+    def update_kb(add = [], delete = [], add_urls = [])
+      response = @http.patch(
+        "#{BASE_URL}/#{@knowledgebase_id}",
+        json: {
+          add: {
+            qnaPairs: add.map { |pair| { question: pair[0], answer: pair[1] } },
+            urls: add_urls
+          },
+          delete: { qnaPairs: delete.map { |pair| { question: pair[0], answer: pair[1] } } }
+        }
+      )
 
-#   case response.code
-#   when 204
-#     'Success!'
-#   else
-#     response.code
-#   end
-# end
+      case response.code
+      when 204
+        nil
+      when 400
+        raise BadArgumentError, response.parse['error']['message'].join(' ')
+      when 401
+        raise UnauthorizedError, response.parse['error']['message']
+      when 403
+        raise ForbiddenError, response.parse['error']['message']
+      when 404
+        raise NotFoundError, response.parse['error']['message']
+      when 409
+        raise ConflictError, response.parse['error']['message']
+      else
+        raise UnknownError, "Oh no! (#{response.code})"
+      end
+    end
+  end
+end

data/lib/qna_maker/errors.rb

@@ -20,6 +20,9 @@ module QnAMaker
   class ConflictError < StandardError
   end
 
+  class ForbiddenError < StandardError
+  end
+
   class UnknownError < StandardError
   end
 end

data/lib/qna_maker/version.rb

@@ -1,3 +1,3 @@
 module QnAMaker
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/qna_maker.rb

@@ -11,9 +11,9 @@ require 'qna_maker/endpoints/download_alterations'
 require 'qna_maker/endpoints/download_kb'
 require 'qna_maker/endpoints/generate_answer'
 require 'qna_maker/endpoints/publish_kb'
-# require 'qna_maker/endpoints/train_kb'
-# require 'qna_maker/endpoints/update_kb'
-# require 'qna_maker/endpoints/update_alterations'
+require 'qna_maker/endpoints/train_kb'
+require 'qna_maker/endpoints/update_kb'
+require 'qna_maker/endpoints/update_alterations'
 
 require 'http'
 

data/qna_maker.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'http', '~> 3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qna_maker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Birdie0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2018-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,7 @@ files:
 - lib/qna_maker/endpoints/generate_answer.rb
 - lib/qna_maker/endpoints/publish_kb.rb
 - lib/qna_maker/endpoints/train_kb.rb
+- lib/qna_maker/endpoints/update_alterations.rb
 - lib/qna_maker/endpoints/update_kb.rb
 - lib/qna_maker/errors.rb
 - lib/qna_maker/string.rb