[+] first version

Author: Gugic

.gitignore

@@ -14,6 +14,11 @@
 .repl_history
 build/
 
+## Specific to IDEA
+api-ai-ruby.iml
+.idea
+
+
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
@@ -23,6 +28,7 @@ build/
 ## Environment normalisation:
 /.bundle/
 /lib/bundler/man/
+Gemfile.lock
 
 # 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

@@ -1,4 +1,18 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in gem_sample_pruby.gemspec
+#gem 'jruby-openssl', platforms: :jruby
+gem 'rake'
+gem 'yard'
+
+group :development do
+
+end
+
+group :test do
+  gem 'coveralls'
+  gem 'rspec', '>= 2.14'
+  gem 'simplecov', '>= 0.9'
+  gem 'webmock'
+end
+
 gemspec

README.md

@@ -1,4 +1,44 @@
-api-ai-ruby
-===========
+# The API.AI ruby gem
+
+A Ruby SDK to the https://api.ai natural language processing service.
+
+## Installation
+    gem install api-ai-ruby
+
+## Basic Usage
+
+    Just pass correct credentials to ApiAiRuby::Client constructor
+
+    ```ruby
+    client = ApiAiRuby::Client.new(
+        :client_access_token => 'YOUR_ACCESS_TOKEN',
+        :subscription_key => 'YOUR_SUBSCRIPTION_KEY'
+    )
+    ```
+    After that you can send text requests to the https://api.ai with command
+
+    ```ruby
+        response = client.text_request 'hello!'
+    ```
+
+    And voice requests with file stream
+
+    ```ruby
+        file = File.new 'hello.wav'
+        response = client.voice_request(file)
+    ```
+
+    ```
+        ...
+        response[:result][:resolvedQuery] => 'hello'
+        ...
+    ```
+
+
+
+
+
+
+
+
 
-Ruby SDK for api.ai

api-ai-ruby.gemspec

@@ -1,23 +1,26 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'api-ai-ruby/version'
+require 'api-ai-ruby/constants'
 
 Gem::Specification.new do |spec|
-  spec.name          = "api-ai-ruby"
-  spec.version       = GemSamplePruby::VERSION
-  spec.authors       = ["TODO: put author names"]
-  spec.email         = ["TODO: put Email addresses"]
-  spec.summary       = %q{TODO: Write a short summary. Required.}
-  spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.name          = 'api-ai-ruby'
+  spec.version       = ApiAiRuby::Constants::VERSION
+  spec.authors       = ['api.ai']
+  spec.email         = ['[email protected]']
+  spec.summary       = %q{ruby SDK for https://api.ai }
+  spec.description   = %q{Plugin makes it easy to integrate your Ruby application with https://api.ai natural language processing service.}
+  spec.homepage      = 'https://api.ai'
+  spec.license       = 'Apache 2.0 License'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'http', '~> 0.9.4'
+  spec.add_dependency 'http-form_data', '~> 1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
 end

lib/api-ai-ruby.rb

@@ -1,5 +1,8 @@
-class ApiAiRuby
-end
-
-require "api-ai-ruby/version"
+require 'api-ai-ruby/constants'
+require 'api-ai-ruby/client'
+require 'api-ai-ruby/request_error'
+require 'api-ai-ruby/client_error'
+require 'api-ai-ruby/request_query'
+require 'api-ai-ruby/text_request'
+require 'api-ai-ruby/voice_request'
 

lib/api-ai-ruby/client.rb

@@ -0,0 +1,60 @@
+module ApiAiRuby
+  class Client
+    attr_accessor :client_access_token, :subscription_key
+    attr_writer :user_agent, :api_version, :api_lang, :api_base_url
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [Twitter::Client]
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+    end
+
+    # @return [String]
+    def user_agent
+      @user_agent ||= "ApiAiRubyGem/#{ApiAiRuby::Constants::VERSION}"
+    end
+
+    def api_base_url
+      @api_base_url ||= ApiAiRuby::Constants::DEFAULT_BASE_URL
+    end
+
+    def api_lang
+      @api_lang ||= ApiAiRuby::Constants::DEFAULT_CLIENT_LANG
+    end
+
+    def api_version
+      @api_version ||= ApiAiRuby::Constants::DEFAULT_API_VERSION
+    end
+
+    # @return [Hash]
+    def credentials
+      {
+          client_access_token: client_access_token,
+          subscription_key: subscription_key
+      }
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    def text_request (query = '', options = {})
+      raise ApiAiRuby::ClientError.new('Credentials missing') if !credentials?
+      options[:query] = query
+      ApiAiRuby::TextRequest.new(self, options).perform
+    end
+
+    def voice_request(file_stream, options = {})
+      raise ApiAiRuby::ClientError.new('Credentials missing') if !credentials?
+      options[:file] = file_stream
+      ApiAiRuby::VoiceRequest.new(self, options).perform
+    end
+
+  end
+end

lib/api-ai-ruby/client_error.rb

@@ -0,0 +1,5 @@
+module ApiAiRuby
+  class ClientError < StandardError
+
+  end
+end

lib/api-ai-ruby/constants.rb

@@ -0,0 +1,8 @@
+module ApiAiRuby
+  class Constants
+    VERSION = '1.0.0'
+    DEFAULT_BASE_URL = 'https://api.api.ai/v1/'
+    DEFAULT_API_VERSION = '20150204'
+    DEFAULT_CLIENT_LANG = 'en'
+  end
+end

lib/api-ai-ruby/request_error.rb

@@ -0,0 +1,17 @@
+module ApiAiRuby
+  class RequestError < StandardError
+    #return [Integer]
+    attr_reader :code
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [Integer]
+    # @return [ApiAiRuby::RequestError]
+    def initialize(message = '', code = nil)
+      super(message)
+      @code = code
+    end
+
+  end
+end

lib/api-ai-ruby/request_query.rb

@@ -0,0 +1,60 @@
+require 'http'
+require 'http/form_data'
+
+module ApiAiRuby
+  class RequestQuery
+
+    attr_accessor :client, :headers, :options,  :request_method, :uri
+
+    # @param client [ApiAiRuby::Client]
+    # @param options [Hash]
+    # @return [ApiAiRuby::TextRequest]
+
+    def initialize(client, options = {})
+      @client = client
+      @uri = client.api_base_url + 'query?v=' + client.api_version
+      @request_method = :post
+      options[:lang] = client.api_lang
+      @options = options
+      @headers = {
+          'Authorization': 'Bearer ' + client.client_access_token,
+          'ocp-apim-subscription-key': 'Bearer ' + client.client_access_token
+      }
+    end
+
+    # @return [Array, Hash]
+    def perform
+      options_key = @request_method == :get ? :params : :form
+      response = HTTP.with(@headers).public_send(@request_method, @uri.to_s, options_key => @options)
+      response_body = symbolize_keys!(response.parse)
+      response_headers = response.headers
+      fail_or_return_response_body(response.code, response_body)
+    end
+
+    private
+
+
+    def fail_or_return_response_body(code, body)
+      error = false
+      if code != 200 || body[:status][:code] != 200
+        error = ApiAiRuby::RequestError.new body[:status][:errorDetails], body[:status][:code]
+      end
+      fail(error) if error
+      body
+    end
+
+    def symbolize_keys!(object)
+      if object.is_a?(Array)
+        object.each_with_index do |val, index|
+          object[index] = symbolize_keys!(val)
+        end
+      elsif object.is_a?(Hash)
+        object.keys.each do |key|
+          object[key.to_sym] = symbolize_keys!(object.delete(key))
+        end
+      end
+      object
+    end
+
+  end
+end

lib/api-ai-ruby/text_request.rb

@@ -0,0 +1,8 @@
+module ApiAiRuby
+  class TextRequest < ApiAiRuby::RequestQuery
+    def initialize (client, options={})
+      super client, options
+      @request_method = :get
+    end
+  end
+end

lib/api-ai-ruby/version.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+module ApiAiRuby
+  class VoiceRequest < ApiAiRuby::RequestQuery
+
+
+    # @param client [ApiAiRuby::Client]
+    # @param options [Hash]
+    # @return [ApiAiRuby::VoiceRequest]
+    def initialize(client,  options = {})
+      super client, options
+
+      file = options.delete(:file)
+      options = {
+          :request => options.to_json,
+          :voiceData => HTTP::FormData::File.new(file, filename: File.basename(file))
+      }
+      @options = options
+      self
+    end
+
+  end
+end

lib/api-ai-ruby/voice_request.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+describe 'api' do
+  let (:client) { ApiAiRuby::Client.new(:client_access_token => '3485a96fb27744db83e78b8c4bc9e7b7', :subscription_key => 'cb9693af-85ce-4fbf-844a-5563722fc27f')}
+
+  it 'should return response' do
+    response = client.text_request 'Hello'
+    expect(response[:result][:resolvedQuery]).to eq 'Hello'
+    expect(response[:result][:action]).to eq 'greeting'
+  end
+
+  it 'should use input contexts' do
+    response = client.text_request 'Hello', :resetContexts => true
+    expect(response[:result][:action]).to eq 'greeting'
+
+    response = client.text_request 'Hello', :contexts => ['firstContext'], :resetContexts => true
+    expect(response[:result][:action]).to eq 'firstGreeting'
+
+    response = client.text_request 'Hello', :contexts => ['secondContext'], :resetContexts => true
+    expect(response[:result][:action]).to eq 'secondGreeting'
+  end
+
+  it 'should return output contexts' do
+    response = client.text_request 'weather', :resetContexts => true
+    expect(response[:result][:action]).to eq 'showWeather'
+    expect(response[:result][:contexts]).not_to be_nil
+    expect(response[:result][:contexts].any? {|context| context[:name] == 'weather'}).to be true
+  end
+
+  it 'should response with error on wrong credentials' do
+    client = ApiAiRuby::Client.new(subscription_key: 'SK', client_access_token: 'CS')
+    expect {client.text_request}.to raise_error(ApiAiRuby::RequestError)
+  end
+
+  it 'should send voiceData to API' do
+    expect(client.voice_request(File.new(fixture_path + '/hello.wav'))[:result][:resolvedQuery]).to eq 'hello'
+  end
+end