api_ai_wrapper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 469724d657925c38ac67bf0c138f213735ed032a
+  data.tar.gz: ccc0bd55f2401a5a57766bb53fd030076a528b52
+SHA512:
+  metadata.gz: 3b58704d1d01e1e063e562d349d6dd2379256d52f192c5298616ff0f6a98bb2ca5644beff1fc184abc3bab00ac28c67acd4064f93de4b9c0969f8135fce5891f
+  data.tar.gz: a941104c2cb448f049048fe366877863efff846252b3523b62a06b4c9e28e8f085b924872dddaabfe7d603f8781153f44cae6c356a72286d192477ff0c6e9771

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,13 @@
+#encoding: utf-8
+
+source 'https://rubygems.org'
+
+gem "httpclient"
+
+group :test, :development do
+  gem "rspec"
+  gem "simplecov"
+  gem "webmock"
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    hashdiff (0.3.4)
+    httpclient (2.8.3)
+    json (2.1.0)
+    public_suffix (2.0.5)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httpclient
+  rspec
+  simplecov
+  webmock
+
+BUNDLED WITH
+   1.15.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,2 @@
+# api_ai_wrapper
+A simple library that let's any developer automate the training process of a Natural Language Processing Engine on API.AI, and retrieve meaning from new utterances.

data/api_ai_wrapper.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'api_ai_wrapper'
+  s.version     = '1.0.0'
+  s.date        = '2017-08-04'
+  s.summary     = "An API.AI Ruby Wrapper"
+  s.description = "A simple ruby library that let's any developer automate the training process of a Natural Language Processing Engine on API.AI, and retrieve meaning from new utterances."
+  s.authors     = ["Vincent Gabou"]
+  s.email       = 'vincent.gabou@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'http://rubygems.org/gems/api_ai_wrapper'
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency 'httpclient', '~> 2.8', '>= 2.8.0'
+end

data/lib/api_ai_wrapper.rb

@@ -0,0 +1,10 @@
+require "json"
+require "httpclient"
+require "securerandom"
+
+require "api_ai_wrapper/extensions/object"
+require "api_ai_wrapper/extensions/string"
+require "api_ai_wrapper/extensions/hash"
+require "api_ai_wrapper/constants"
+require "api_ai_wrapper/errors"
+require "api_ai_wrapper/engine"

data/lib/api_ai_wrapper/components/component.rb

@@ -0,0 +1,35 @@
+module ApiAiWrapper::Components
+
+  class Component
+    attr_accessor :engine
+
+    # We define http_verb methods get/post/put/delete to add correct headers and parse result automatically
+    [:get, :post, :put, :delete].each do |http_verb|
+      define_method(http_verb.to_sym) do |url, params = {}|
+        raise_if_unauthorized # checks if the correct token is present
+        set_headers # sets headers with the correct token
+
+        response = self.engine.client.send(http_verb, url, params, self.engine.headers)
+
+        handle_response(JSON.parse(response.body))
+      end
+    end
+
+    private
+
+    # Throws an error if the call is not successful
+    # Returns response if no error is returned
+    def handle_response(response_body)
+      response = response_body.deep_symbolize_keys
+      response_status = response[:status]
+      response_code = response_status[:code]
+
+      if response_code != 200
+        raise ApiAiWrapper::Errors::Engine::ApiError.new(response_status[:errorDetails], response_code, response_status[:errorType])
+      end
+
+      response
+    end
+  end
+  
+end

data/lib/api_ai_wrapper/components/extractor_component.rb

@@ -0,0 +1,16 @@
+module ApiAiWrapper::Components
+  class ExtractorComponent < ApiAiWrapper::Components::Component
+
+    def raise_if_unauthorized
+      raise ApiAiWrapper::Errors::Engine::MissingToken.new("client token is missing") if self.engine.client_token.blank?
+    end
+
+    def set_headers
+      self.engine.headers = {
+        "Authorization" => "Bearer #{self.engine.client_token}",
+        "Content-Type" => "application/json; charset=utf-8"
+      }
+    end
+
+  end
+end

data/lib/api_ai_wrapper/components/trainer_component.rb

@@ -0,0 +1,16 @@
+module ApiAiWrapper::Components
+  class TrainerComponent < ApiAiWrapper::Components::Component
+
+    def raise_if_unauthorized
+      raise ApiAiWrapper::Errors::Engine::MissingToken.new("developer token is missing") if self.engine.developer_token.blank?
+    end
+
+    def set_headers
+      self.engine.headers = {
+        "Authorization" => "Bearer #{self.engine.developer_token}",
+        "Content-Type" => "application/json; charset=utf-8"
+      }
+    end
+
+  end
+end

data/lib/api_ai_wrapper/constants.rb

@@ -0,0 +1,10 @@
+module ApiAiWrapper
+
+  class Constants
+    DEFAULT_BASE_URL = "https://api.api.ai/v1/"
+    DEFAULT_VERSION = "20150910"
+    DEFAULT_LOCALE = "en"
+    DEFAULT_CLIENT_TIMEOUT = 50000
+  end
+
+end

data/lib/api_ai_wrapper/engine.rb

@@ -0,0 +1,40 @@
+require "api_ai_wrapper/components/component"
+require "api_ai_wrapper/components/trainer_component"
+require "api_ai_wrapper/components/extractor_component"
+require "api_ai_wrapper/trainers/intent_trainer"
+require "api_ai_wrapper/trainers/entity_trainer"
+require "api_ai_wrapper/meaning_extractor"
+
+module ApiAiWrapper
+  class Engine
+    AUTOLOAD_CLASSES = [
+      ApiAiWrapper::Trainers::EntityTrainer,
+      ApiAiWrapper::Trainers::IntentTrainer,
+      ApiAiWrapper::MeaningExtractor
+    ]
+
+    attr_accessor :client, :client_timeout, :headers, :locale, :base_url, :version, :client_token, :developer_token
+    attr_accessor :entity_trainer, :intent_trainer, :meaning_extractor
+
+    def initialize(options = {})
+      self.client = HTTPClient.new
+      self.client.receive_timeout = options[:client_timeout].presence || ApiAiWrapper::Constants::DEFAULT_CLIENT_TIMEOUT
+      self.locale = options[:locale].presence || ApiAiWrapper::Constants::DEFAULT_LOCALE
+      self.base_url = ApiAiWrapper::Constants::DEFAULT_BASE_URL
+      self.version = options[:version].presence || ApiAiWrapper::Constants::DEFAULT_VERSION
+      self.client_token = options[:client_token].presence
+      self.developer_token = options[:developer_token].presence
+
+      # RAISE ERROR IF NO TOKEN PRESENT
+      raise ApiAiWrapper::Errors::Engine::MissingTokens.new if self.client_token.blank? && self.developer_token.blank?
+
+      # define entity_trainer and intent_trainer on the fly
+      AUTOLOAD_CLASSES.each{ |class_name|
+        instance = class_name.new
+        instance.engine = self
+        self.send("#{class_name.to_s.demodulize.underscore}=", instance)
+      }
+    end
+
+  end
+end

data/lib/api_ai_wrapper/errors.rb

@@ -0,0 +1,31 @@
+class ApiAiWrapper::Errors
+
+  module Request
+    class UnsupportedParams < StandardError; end
+  end
+
+  module Engine
+    class MissingTokens < StandardError
+      def initialize(_message = "You have not set a developer or client token for this engine")
+        @message = _message
+      end
+    end
+
+    class MissingToken < StandardError
+      def initialize(_message)
+        @message = "Unauthorized call - #{_message}"
+        @code = 401
+      end
+    end
+
+    class ApiError < StandardError
+      def initialize(_message, _code, _status)
+        @message = _message
+        @code = _code
+        @status = _status
+      end
+    end
+
+  end
+
+end

data/lib/api_ai_wrapper/extensions/hash.rb

@@ -0,0 +1,37 @@
+class Hash
+
+  def transform_keys
+    return enum_for(:transform_keys) unless block_given?
+    result = self.class.new
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  def _deep_transform_keys_in_object(object, &block)
+    case object
+    when Hash
+      object.each_with_object({}) do |(key, value), result|
+        result[yield(key)] = _deep_transform_keys_in_object(value, &block)
+      end
+    when Array
+      object.map {|e| _deep_transform_keys_in_object(e, &block) }
+    else
+      object
+    end
+  end
+
+  def deep_transform_keys(&block)
+    _deep_transform_keys_in_object(self, &block)
+  end
+
+  def symbolize_keys
+    transform_keys { |key| key.to_sym rescue key }
+  end
+
+  def deep_symbolize_keys
+    deep_transform_keys { |key| key.to_sym rescue key }
+  end
+
+end

data/lib/api_ai_wrapper/extensions/object.rb

@@ -0,0 +1,13 @@
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+
+  def presence
+    self if present?
+  end
+end

data/lib/api_ai_wrapper/extensions/string.rb

@@ -0,0 +1,21 @@
+class String
+
+  def demodulize
+    if i = self.rindex("::")
+      self[(i + 2)..-1]
+    else
+      self
+    end
+  end
+
+  def underscore
+    return self unless /[A-Z-]|::/.match?(self)
+    word = self.gsub("::".freeze, "/".freeze)
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2'.freeze)
+    word.gsub!(/([a-z\d])([A-Z])/, '\1_\2'.freeze)
+    word.tr!("-".freeze, "_".freeze)
+    word.downcase!
+    word
+  end
+
+end

data/lib/api_ai_wrapper/meaning_extractor.rb

@@ -0,0 +1,28 @@
+module ApiAiWrapper
+
+  # https://api.ai/docs/reference/agent/query#query_parameters_and_json_fields
+  class MeaningExtractor < ApiAiWrapper::Components::ExtractorComponent
+
+    # https://api.ai/docs/reference/agent/query#post_query
+    # Retrieves the meaning of a utterance
+    # options can contain (in accordance with API reference) :
+    # - contexts
+    # - location
+    # - timezone
+    # - lang
+    # - sessionId
+    def post_query(query, options = {})
+      set_headers
+      body = {
+        query: query,
+        lang: self.engine.locale,
+        sessionId: SecureRandom.hex
+      }.merge(options)
+      endpoint_url = URI.join(self.engine.base_url, "query?v=#{self.engine.version}")
+
+      res = self.post(endpoint_url, body.to_json)
+    end
+
+  end
+
+end

data/lib/api_ai_wrapper/trainers/entity_trainer.rb

@@ -0,0 +1,83 @@
+module ApiAiWrapper::Trainers
+
+  # https://api.ai/docs/reference/agent/entities#overview
+  # https://api.ai/docs/reference/agent/entities#entity_object
+  class EntityTrainer < ApiAiWrapper::Components::TrainerComponent
+
+    # https://api.ai/docs/reference/agent/entities#get_entities
+    # Retrieves all entities for a given token
+    def get_entities
+      endpoint_url = URI.join(self.engine.base_url, "entities?v=#{self.engine.version}")
+
+      self.get(endpoint_url, {})
+    end
+
+    # https://api.ai/docs/reference/agent/entities#get_entitieseid
+    # Retrieves entity info
+    # eid can either be the ID or the entity NAME
+    def get_entity(eid)
+      endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}?v=#{self.engine.version}")
+
+      self.get(endpoint_url, {})
+    end
+
+    # https://docs.api.ai/docs/entities#post-entities
+    # Creates an entity with the corresponding entries
+    def post_entity(name, entries)
+      body = {
+        name: name,
+        entries: entries
+      }
+      endpoint_url = URI.join(self.engine.base_url, "entities?v=#{self.engine.version}")
+
+      self.post(endpoint_url, body.to_json)
+    end
+
+    # https://api.ai/docs/reference/agent/entities#post_entitieseidentries
+    # Allows to add entries to en existing entity
+    # eid can either be the ID or the entity NAME
+    def post_entity_entries(eid, entries)
+      endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}/entries?v=#{self.engine.version}")
+
+      self.post(endpoint_url, entries.to_json)
+    end
+
+    # https://api.ai/docs/reference/agent/entities#put_entitieseid
+    # Update an entity
+    def put_entity(eid, options = {})
+      endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}?v=#{self.engine.version}")
+
+      self.put(endpoint_url, options.to_json)
+    end
+
+    # https://api.ai/docs/reference/agent/entities#put_entitieseid
+    # Update an entity's entries
+    def put_entity_entries(eid, entries)
+      body = { entries: entries }
+      endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}/entries?v=#{self.engine.version}")
+
+      self.put(endpoint_url, entries.to_json)
+    end
+
+    # https://api.ai/docs/reference/agent/entities#delete_entitieseid
+    # Delete an entity
+    # eid can either be the ID or the entity NAME
+    def delete_entity(eid)
+      endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}?v=#{self.engine.version}")
+
+      self.delete(endpoint_url, {})
+    end
+
+    # https://api.ai/docs/reference/agent/entities#delete_entitieseidentries
+    # Delete an entity's entries
+    # eid can either be the ID or the entity NAME
+    # entries is an array of reference values (e.g. ["blue", "red"] for entity "color")
+    def delete_entity_entries(eid, entries)
+      body = { entries: entries }
+      endpoint_url = URI.join(self.engine.base_url, "entities/#{eid}/entries?v=#{self.engine.version}")
+
+      self.delete(endpoint_url, body.to_json)
+    end
+
+  end
+end

data/lib/api_ai_wrapper/trainers/intent_trainer.rb

@@ -0,0 +1,72 @@
+module ApiAiWrapper::Trainers
+
+  # https://api.ai/docs/reference/agent/intents#overview
+  # https://api.ai/docs/reference/agent/intents#intent_object
+  class IntentTrainer < ApiAiWrapper::Components::TrainerComponent
+
+    # https://api.ai/docs/reference/agent/intents#get_intents
+    # Fetches all intents for a given token
+    def get_intents
+      set_headers
+      endpoint_url = URI.join(self.engine.base_url, "intents?v=#{self.engine.version}")
+
+      res = self.engine.client.get(endpoint_url, {}, self.engine.headers)
+
+      JSON.parse(res.body)
+    end
+
+    # https://api.ai/docs/reference/agent/intents#get_intentsiid
+    # Retrieves intent info
+    def get_intent(iid)
+      set_headers
+      endpoint_url = URI.join(self.engine.base_url, "intents/#{iid}?v=#{self.engine.version}")
+
+      res = self.engine.client.get(endpoint_url, {}, self.engine.headers)
+
+      JSON.parse(res.body)
+    end
+
+    # https://api.ai/docs/reference/agent/intents#post_intents
+    # Creates an intent
+    # options can contain (in accordance with API reference) :
+    # - contexts
+    # - templates
+    # - responses
+    def post_intent(name, user_says_data, options = {})
+      set_headers
+      body = options.merge({
+        name: name,
+        auto: true, # ML activated
+        userSays: user_says_data
+      })
+      endpoint_url = URI.join(self.engine.base_url, "intents?v=#{self.engine.version}")
+
+      res = self.engine.client.post(endpoint_url, body.to_json, self.engine.headers)
+
+      JSON.parse(res.body)
+    end
+
+    # https://api.ai/docs/reference/agent/intents#put_intentsiid
+    # Update an intent
+    def put_intent(iid, options = {})
+      set_headers
+      endpoint_url = URI.join(self.engine.base_url, "intents/#{iid}?v=#{self.engine.version}")
+
+      res = self.engine.client.put(endpoint_url, options.to_json, self.engine.headers)
+
+      JSON.parse(res.body)
+    end
+
+    # https://api.ai/docs/reference/agent/entities#delete_entitieseid
+    # Delete an intent
+    def delete_intent(iid)
+      set_headers
+      endpoint_url = URI.join(self.engine.base_url, "intents/#{iid}?v=#{self.engine.version}")
+
+      res = self.engine.client.delete(endpoint_url, {}, self.engine.headers)
+
+      JSON.parse(res.body)
+    end
+
+  end
+end

data/spec/api_ai_wrapper/components/component_spec.rb

@@ -0,0 +1,80 @@
+require "spec_helper"
+
+RSpec.describe ApiAiWrapper::Components::Component do
+
+  let :engine do
+    ApiAiWrapper::Engine.new({
+      client_token: "some-token",
+      developer_token: "some-token"
+    })
+  end
+
+  let :component do
+    comp = ApiAiWrapper::Components::Component.new
+    comp.engine = engine
+    comp
+  end
+
+  describe "http_verbs" do
+    it "should define http_verb methods get/post/put/delete" do
+      [:get, :post, :put, :delete].each do |http_verb|
+        expect(component.respond_to?(http_verb)).to be true
+      end
+    end
+
+    it "should call #raise_if_unauthorized for each http_verb methods" do
+      expect(engine.intent_trainer).to receive(:raise_if_unauthorized).exactly(4).times
+      allow(engine.intent_trainer).to receive(:set_headers).and_call_original
+      allow(engine.intent_trainer).to receive(:handle_response)
+
+      [:get, :post, :put, :delete].each do |http_verb|
+        stub_call(engine, "some-url", { method: http_verb })
+        engine.intent_trainer.send(http_verb, URI.join(ApiAiWrapper::Constants::DEFAULT_BASE_URL, "some-url"))
+      end
+    end
+
+    it "should call #set_headers for each http_verb methods" do
+      allow(engine.intent_trainer).to receive(:raise_if_unauthorized)
+      expect(engine.intent_trainer).to receive(:set_headers).exactly(4).times.and_call_original
+      allow(engine.intent_trainer).to receive(:handle_response)
+
+      [:get, :post, :put, :delete].each do |http_verb|
+        stub_call(engine, "some-url", { method: http_verb })
+        engine.intent_trainer.send(http_verb, URI.join(ApiAiWrapper::Constants::DEFAULT_BASE_URL, "some-url"))
+      end
+    end
+
+    it "should call #handle_response for each http_verb methods" do
+      allow(engine.intent_trainer).to receive(:raise_if_unauthorized)
+      allow(engine.intent_trainer).to receive(:set_headers).and_call_original
+      expect(engine.intent_trainer).to receive(:handle_response).exactly(4).times.and_call_original
+
+      [:get, :post, :put, :delete].each do |http_verb|
+        stub_call(engine, "some-url", { method: http_verb })
+        engine.intent_trainer.send(http_verb, URI.join(ApiAiWrapper::Constants::DEFAULT_BASE_URL, "some-url"))
+      end
+    end
+  end
+
+  describe "#handle_response(response)" do
+    context "when API.AI call is successful (code is 200)" do
+      it "should return JSON parsed response" do
+        response = { "status" => { "code" => 200, "errorType" => "success" } }
+
+        expect(component.send(:handle_response, response)).to eq(response.deep_symbolize_keys)
+      end
+    end
+
+    context "when API.AI call is in error (code is not 200)" do
+      it "should return JSON parsed response" do
+        response = { "status" => { "code" => 203, "errorType" => "problem", "errorDetails" => "an error" } }
+
+        expect {
+          component.send(:handle_response, response)
+        }.to raise_error(ApiAiWrapper::Errors::Engine::ApiError)
+      end
+    end
+
+  end
+
+end

data/spec/api_ai_wrapper/components/extractor_component_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+RSpec.describe ApiAiWrapper::Components::ExtractorComponent do
+
+  describe "#raise_if_unauthorized" do
+    it "should not raise if call is client_token is present" do
+      engine = ApiAiWrapper::Engine.new(client_token: "some-token")
+      expect { 
+        engine.meaning_extractor.raise_if_unauthorized
+      }.not_to raise_error
+    end
+
+    it "should raise if call is client_token is blank" do
+      engine = ApiAiWrapper::Engine.new(client_token: nil, developer_token: "some-token")
+      expect {
+        engine.meaning_extractor.raise_if_unauthorized
+      }.to raise_error(ApiAiWrapper::Errors::Engine::MissingToken)
+    end
+  end
+
+  describe "#set_headers" do
+    let :engine do
+      ApiAiWrapper::Engine.new({
+        client_token: "some-token-1",
+        developer_token: "some-token"
+      })
+    end
+
+    it "should set authorization and content type headers correctly" do
+      expect(engine.headers).to be_nil
+
+      engine.meaning_extractor.set_headers
+
+      expect(engine.headers).to eq({ "Authorization" => "Bearer some-token-1", "Content-Type" => "application/json; charset=utf-8" })
+    end
+  end
+
+end

data/spec/api_ai_wrapper/components/trainer_component_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+RSpec.describe ApiAiWrapper::Components::TrainerComponent do
+
+  describe "#raise_if_unauthorized" do
+    it "should not raise if call is developer_token is present" do
+      engine = ApiAiWrapper::Engine.new(developer_token: "some-token")
+      expect { 
+        engine.entity_trainer.raise_if_unauthorized
+      }.not_to raise_error
+    end
+
+    it "should raise if call is developer_token is blank" do
+      engine = ApiAiWrapper::Engine.new(client_token: "some-token", developer_token: nil)
+      expect {
+        engine.entity_trainer.raise_if_unauthorized
+      }.to raise_error(ApiAiWrapper::Errors::Engine::MissingToken)
+    end
+  end
+
+  describe "#set_headers" do
+    let :engine do
+      ApiAiWrapper::Engine.new({
+        client_token: "some-token",
+        developer_token: "some-token-1"
+      })
+    end
+
+    it "should set authorization and content type headers correctly" do
+      expect(engine.headers).to be_nil
+
+      engine.intent_trainer.set_headers
+
+      expect(engine.headers).to eq({ "Authorization" => "Bearer some-token-1", "Content-Type" => "application/json; charset=utf-8" })
+    end
+  end
+
+end

data/spec/api_ai_wrapper/engine_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+RSpec.describe ApiAiWrapper::Engine do
+
+  let :engine do
+    ApiAiWrapper::Engine.new({
+      client_token: "some-token",
+      developer_token: "some-token"
+    })
+  end
+
+  let :default_params do
+    { client_token: "some-token", developer_token: "some-token" }
+  end
+
+  describe "#initialize" do
+
+    it "should instantiate a HTTPClient as a 'client' accessor" do
+      expect(engine.client).to be_instance_of(HTTPClient)
+    end
+
+    describe "client_timeout" do
+      it "should instantiate a default 'client_timeout' accessor as DEFAULT_CLIENT_TIMEOUT" do
+        expect(engine.client.receive_timeout).to eq(ApiAiWrapper::Constants::DEFAULT_CLIENT_TIMEOUT)
+      end
+
+      it "should instantiate a 'client_timeout' accessor when specified in options" do
+        expect(ApiAiWrapper::Engine.new(default_params.merge({ client_timeout: 1000 })).client.receive_timeout).to eq(1000)
+      end
+    end
+
+    describe "locale" do
+      it "should instantiate a default 'locale' accessor as en" do
+        expect(engine.locale).to eq(ApiAiWrapper::Constants::DEFAULT_LOCALE)
+      end
+
+      it "should instantiate a 'locale' accessor when specified in options" do
+        expect(ApiAiWrapper::Engine.new(default_params.merge({ locale: "fr" })).locale).to eq("fr")
+      end
+    end
+
+    it "should instantiate the correct default base url as 'base_url' accessor" do
+      expect(engine.base_url).to eq(ApiAiWrapper::Constants::DEFAULT_BASE_URL)
+    end
+
+    describe "version" do
+      it "should instantiate a default 'version' accessor" do
+        expect(engine.version).to eq(ApiAiWrapper::Constants::DEFAULT_VERSION)
+      end
+
+      it "should instantiate a 'locale' accessor when specified in options" do
+        expect(ApiAiWrapper::Engine.new(default_params.merge({ version: "some-version" })).version).to eq("some-version")
+      end
+    end
+
+    describe "tokens" do
+      it "should instantiate a 'client_token' accessor when specified in options" do
+        expect(ApiAiWrapper::Engine.new({ client_token: "some-token" }).client_token).to eq("some-token")
+      end
+
+      it "should instantiate a 'developer_token' accessor when specified in options" do
+        expect(ApiAiWrapper::Engine.new({ developer_token: "some-token" }).developer_token).to eq("some-token")
+      end
+
+      it "should raise MissingToken error if no token is present" do
+        expect { ApiAiWrapper::Engine.new }.to raise_error(ApiAiWrapper::Errors::Engine::MissingTokens)
+      end
+    end
+
+    describe "class autoloading" do
+      it "should instantiate an EntityTrainer as 'entity_trainer' accessor" do
+        expect(engine.entity_trainer).to be_instance_of(ApiAiWrapper::Trainers::EntityTrainer)
+      end
+
+      it "should instantiate an IntentTrainer as 'intent_trainer' accessor" do
+        expect(engine.intent_trainer).to be_instance_of(ApiAiWrapper::Trainers::IntentTrainer)
+      end
+
+      it "should instantiate an MeaningExtractor as 'meaning_extractor' accessor" do
+        expect(engine.meaning_extractor).to be_instance_of(ApiAiWrapper::MeaningExtractor)
+      end
+    end
+
+  end
+
+end

data/spec/api_ai_wrapper/meaning_extractor_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+RSpec.describe ApiAiWrapper::MeaningExtractor do
+
+  let :engine do
+    ApiAiWrapper::Engine.new({
+      client_token: "some-token",
+      developer_token: "some-token"
+    })
+  end
+
+  let :meaning_extractor do
+    engine.meaning_extractor
+  end
+
+  describe "#post_query(query, options = {})" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "query?v=#{engine.version}", {
+        method: :post,
+        request_body: {
+          query: "some-query",
+          lang: engine.locale,
+          sessionId: "some-session-id"
+        }.to_json
+      })
+      meaning_extractor.post_query("some-query", { sessionId: "some-session-id" })
+    end
+  end
+
+end

data/spec/api_ai_wrapper/trainers/entity_trainer_spec.rb

@@ -0,0 +1,98 @@
+require "spec_helper"
+
+RSpec.describe ApiAiWrapper::Trainers::EntityTrainer do
+
+  let :engine do
+    ApiAiWrapper::Engine.new({
+      client_token: "some-token",
+      developer_token: "some-token"
+    })
+  end
+
+  let :entity_trainer do
+    engine.entity_trainer
+  end
+
+  describe "#get_entities" do
+    it "should send a call to the correct endpoint with appropriate headers" do
+      stub_call(engine, "entities")
+      entity_trainer.get_entities
+    end
+  end
+
+  describe "#get_entity(eid)" do
+    it "should send a call to the correct endpoint with appropriate headers" do
+      stub_call(engine, "entities/some-id")
+      entity_trainer.get_entity("some-id")
+    end
+  end
+
+  describe "#post_entity(name, entries)" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "entities?v=#{engine.version}", {
+        method: :post,
+        request_body: {
+          name: "some-name",
+          entries: "some-entries"
+        }.to_json
+      })
+      entity_trainer.post_entity("some-name", "some-entries")
+    end
+  end
+
+  describe "#post_entity_entries(eid, entries)" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "entities/some-id/entries?v=#{engine.version}", {
+        method: :post,
+        request_body: "some-entries".to_json
+      })
+      entity_trainer.post_entity_entries("some-id", "some-entries")
+    end
+  end
+
+  describe "#put_entity(eid, options = {})" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "entities/some-id?v=#{engine.version}", {
+        method: :put,
+        request_body: {
+          name: "new-name"
+        }.to_json
+      })
+      entity_trainer.put_entity("some-id", { name: "new-name" })
+    end
+  end
+
+  describe "#put_entity_entries(eid, entries)" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "entities/some-id/entries?v=#{engine.version}", {
+        method: :put,
+        request_body: {
+          entries: "new-entries"
+        }.to_json
+      })
+      entity_trainer.put_entity_entries("some-id", { entries: "new-entries" })
+    end
+  end
+
+  describe "#delete_entity(eid)" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "entities/some-id?v=#{engine.version}", {
+        method: :delete
+      })
+      entity_trainer.delete_entity("some-id")
+    end
+  end
+
+  describe "#delete_entity_entries(eid, entries)" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "entities/some-id/entries?v=#{engine.version}", {
+        method: :delete,
+        request_body: {
+          entries: "entries-to-delete"
+        }
+      })
+      entity_trainer.delete_entity_entries("some-id", "entries-to-delete")
+    end
+  end
+
+end

data/spec/api_ai_wrapper/trainers/intent_trainer_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+RSpec.describe ApiAiWrapper::Trainers::IntentTrainer do
+
+  let :engine do
+    ApiAiWrapper::Engine.new({
+      client_token: "some-token",
+      developer_token: "some-token"
+    })
+  end
+
+  let :intent_trainer do
+    engine.intent_trainer
+  end
+
+  describe "#get_intents" do
+    it "should send a call to the correct endpoint with appropriate headers" do
+      stub_call(engine, "intents")
+      intent_trainer.get_intents
+    end
+  end
+
+  describe "#get_intent(iid)" do
+    it "should send a call to the correct endpoint with appropriate headers" do
+      stub_call(engine, "intents/some-id")
+      intent_trainer.get_intent("some-id")
+    end
+  end
+
+  describe "#post_intent(name, user_says_data, options = {})" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "intents?v=#{engine.version}", {
+        method: :post,
+        request_body: {
+          name: "some-name",
+          auto: true,
+          userSays: "some-data"
+        }.to_json
+      })
+      intent_trainer.post_intent("some-name", "some-data")
+    end
+  end
+
+  describe "#put_intent(iid, options = {})" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "intents/some-id?v=#{engine.version}", {
+        method: :put,
+        request_body: {
+          name: "new-name"
+        }.to_json
+      })
+      intent_trainer.put_intent("some-id", { name: "new-name" })
+    end
+  end
+
+  describe "#delete_intent(iid)" do
+    it "should send a call to the correct endpoint with appropriate headers and body params" do
+      stub_call(engine, "intents/some-id?v=#{engine.version}", {
+        method: :delete
+      })
+      intent_trainer.delete_intent("some-id")
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.color = true
+end
+
+require "simplecov"
+SimpleCov.start "rails"
+
+require "webmock/rspec"
+WebMock.disable_net_connect!
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'api_ai_wrapper')
+
+def stub_call(engine, path, options = {})
+  stub_request(options[:method].presence || :get, URI.join(engine.base_url, path))
+    .with({
+      headers: { "Authorization" => "Bearer some-token", "Content-Type" => "application/json; charset=utf-8" },
+      body: options[:request_body] || nil
+    })
+    .to_return(body: (options[:return_body].presence || { "status" => { "code" => 200, "errorType" => "success" } }.to_json))
+end
+
+def fixture_path
+  File.join(File.dirname(__FILE__), '..', 'spec', 'fixtures')
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: api_ai_wrapper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vincent Gabou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+description: A simple ruby library that let's any developer automate the training
+  process of a Natural Language Processing Engine on API.AI, and retrieve meaning
+  from new utterances.
+email: vincent.gabou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- api_ai_wrapper.gemspec
+- lib/api_ai_wrapper.rb
+- lib/api_ai_wrapper/components/component.rb
+- lib/api_ai_wrapper/components/extractor_component.rb
+- lib/api_ai_wrapper/components/trainer_component.rb
+- lib/api_ai_wrapper/constants.rb
+- lib/api_ai_wrapper/engine.rb
+- lib/api_ai_wrapper/errors.rb
+- lib/api_ai_wrapper/extensions/hash.rb
+- lib/api_ai_wrapper/extensions/object.rb
+- lib/api_ai_wrapper/extensions/string.rb
+- lib/api_ai_wrapper/meaning_extractor.rb
+- lib/api_ai_wrapper/trainers/entity_trainer.rb
+- lib/api_ai_wrapper/trainers/intent_trainer.rb
+- spec/api_ai_wrapper/components/component_spec.rb
+- spec/api_ai_wrapper/components/extractor_component_spec.rb
+- spec/api_ai_wrapper/components/trainer_component_spec.rb
+- spec/api_ai_wrapper/engine_spec.rb
+- spec/api_ai_wrapper/meaning_extractor_spec.rb
+- spec/api_ai_wrapper/trainers/entity_trainer_spec.rb
+- spec/api_ai_wrapper/trainers/intent_trainer_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/api_ai_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: An API.AI Ruby Wrapper
+test_files: []