api-ai 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 157f947e3ee7a31a3ea546d297614df916d0dcee
+  data.tar.gz: 79c2d5791c8fad4082d66dc3651be9c19fd52414
+SHA512:
+  metadata.gz: eb3cfe790c5296efcfc729fc0c893e9b751d410005d9733e5b445bf41ae0d3ee064a60e972c4ac6861accdcb71ab55a4679310057ee4b6edee85bbb378c971e7
+  data.tar.gz: 9988d1bcb7bfa373e74ef2e3e3f209c0270f85780c930d09245c9ec35c10ab37dc5fabf17f825f98795409266e889712683cf8f277c0cc7c79c0a06d8c0ac3ea

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+languages:
+  Ruby: true

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Idea
+.idea
+.idea/**/*
+
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2.2
+  - ruby-head
+  - jruby
+  - jruby-head
+
+sudo: false
+
+script: 'bundle exec rake spec'
+
+cache: bundler
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true

data/.yardopts

@@ -0,0 +1,9 @@
+--protected
+--no-private
+--embed-mixin ClassMethods
+--markup markdown
+-
+README.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+MIT-LICENSE

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 2015-09-27
+* Initial release
+* Only `query` endpoint for now

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api-ai-wrapper.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Gustavo Bazan
+
+MIT License
+
+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,61 @@
+# ApiAi
+[![Gem Version](https://badge.fury.io/rb/api-ai.svg)](http://badge.fury.io/rb/api-ai)
+[![Build Status](https://travis-ci.org/gssbzn/api-ai.svg)](https://travis-ci.org/gssbzn/api-ai)
+[![Code Climate](https://codeclimate.com/github/gssbzn/api-ai/badges/gpa.svg)](https://codeclimate.com/github/gssbzn/api-ai)
+[![Coverage Status](https://coveralls.io/repos/gssbzn/api-ai/badge.svg?branch=master&service=github)](https://coveralls.io/github/gssbzn/api-ai)
+
+A library that provides a plain function-call interface to the Slack API web endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api-ai'
+```
+
+And then execute:
+
+```console
+bundle
+```
+
+Or install it yourself as:
+
+```console
+gem install api-ai
+```
+
+## Usage
+
+```ruby
+client = ApiAi::Client.new AI_ACCESS_TOKEN, AI_SUBSCRIPTION_TOKEN
+response = client.query 'query' => "test", 'lang' => 'en', 'sessionId' => current_user.id, 'timezone' => current_user.timezone
+# { "id"=>"...",
+#   "timestamp"=>"...",
+#   "result"=>{
+#     "source"=>"domains",
+#     "resolvedQuery"=>"test",
+#     "action"=>"smalltalk.user",
+#     "parameters"=>{"simplified"=>"i am testing you"},
+#     "metadata"=>{},
+#     "fulfillment"=>{"speech"=>"I encourage you to test me often. That helps my developers improve my performance."}
+#   },
+#  "status"=>{"code"=>200, "errorType"=>"success"}}
+```
+
+## Additional Resources
+
+api.ai docs: https://docs.api.ai/docs/welcome
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/api-ai/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+MIT License. Copyright 2015 Gustavo Bazan. http://gustavobazan.com

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/api-ai.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_ai/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'api-ai'
+  spec.version       = ApiAi::VERSION
+  spec.authors       = ['Gustavo Bazan']
+  spec.email         = ['contacto@gustavobazan.com']
+  spec.summary       = 'api.ai Wrapper'
+  spec.description   = <<-EOF
+        A library that provides a plain function-call interface to the
+        api.ai web endpoints.
+    EOF
+  spec.homepage      = 'https://github.com/gssbzn/api-ai'
+  spec.license       = 'MIT'
+
+  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.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency 'webmock', '~> 1.21', '>= 1.21.0'
+  spec.add_development_dependency 'coveralls', '~>0.8.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7', '>= 0.8.0'
+end

data/lib/api-ai.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+require 'net/https'
+require 'cgi'
+require 'json'
+
+require_relative 'api_ai/version'
+require_relative 'api_ai/error'
+require_relative 'api_ai/session'
+require_relative 'api_ai/client'
+
+module ApiAi
+  # api.ai url
+  WEB_SERVER = 'api.ai'
+  # api.ai api path
+  API_SERVER = 'api.api.ai'
+
+  API_VERSION = '20150520'
+
+  # Parse response. You probably shouldn't be calling this directly.
+  # This takes responses from the server and parses them.
+  # It also checks for errors and raises exceptions with the appropriate messages.
+  #
+  # @param [Net::HTTPResponse] response
+  # @param [Boolean] raw if return raw data
+  # @raise [ApiAi::Error]
+  # @raise [ApiAi::AuthError]
+  def self.parse_response(response, raw = false)
+    if response.is_a?(Net::HTTPServerError)
+      fail ApiAi::Error.new("api.ai Server Error: #{response} - #{response.body}", response)
+    end
+    return response.body if raw
+    begin
+      return JSON.parse(response.body)
+    rescue JSON::ParserError
+      raise ApiAi::Error.new("Unable to parse JSON response: #{response.body}", response)
+    end
+  end
+end

data/lib/api_ai/client.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+require_relative 'session'
+require_relative 'endpoint'
+
+module ApiAi
+  # Use this class to make api.ai calls.
+  class Client
+    include Endpoint
+
+    # @param [String] access_token developer token
+    # @param [String] subscription_key subscription token
+    def initialize(access_token, subscription_key)
+      if access_token.is_a?(String) && subscription_key.is_a?(String)
+        @session = Session.new(access_token, subscription_key)
+      else
+        fail ArgumentError, "access_token or subscription_key doesn't have a valid type"
+      end
+    end
+  end
+end

data/lib/api_ai/endpoint.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+require_relative 'endpoint/query'
+require_relative 'endpoint/tts'
+require_relative 'endpoint/entities'
+require_relative 'endpoint/intents'
+require_relative 'error'
+
+module ApiAi
+  module Endpoint
+    include Query
+    include Tts
+    include Entities
+    include Intents
+  end
+end

data/lib/api_ai/endpoint/entities.rb

@@ -0,0 +1,9 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+module ApiAi
+  module Endpoint
+    module Entities
+    end
+  end
+end

data/lib/api_ai/endpoint/intents.rb

@@ -0,0 +1,9 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+module ApiAi
+  module Endpoint
+    module Intents
+    end
+  end
+end

data/lib/api_ai/endpoint/query.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+module ApiAi
+  module Endpoint
+    module Query
+      # Checks API calling code.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [String] 'query'
+      #   The natural language text to be processed. The request can have multiple query parameters.
+      # @option params [String] 'sessionId'
+      #   A string token up to 36 symbols long, used to identify the client and to manage sessions parameters (including contexts) per client.
+      # @option params [String] 'lang'
+      #   Language tag, e.g. EN, ES
+      #
+      # @see http://api.ai/docs/reference/#query
+      def query(params = {})
+        fail ArgumentError, "Required arguments 'query' missing" if params['query'].nil?
+        fail ArgumentError, "Required arguments 'sessionId' missing" if params['sessionId'].nil?
+        fail ArgumentError, "Required arguments 'lang' missing" if params['lang'].nil?
+        response = @session.do_post 'query', params
+        ApiAi.parse_response(response)
+      end
+    end
+  end
+end

data/lib/api_ai/endpoint/tts.rb

@@ -0,0 +1,9 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+module ApiAi
+  module Endpoint
+    module Tts
+    end
+  end
+end

data/lib/api_ai/error.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+module ApiAi
+  # This is the usual error raised on any api.ai related Errors
+  # @!attribute http_response
+  #   @return [Object] server response
+  # @!attribute error
+  #   @return [String] the name of the error
+  class Error < RuntimeError
+
+    attr_accessor :http_response, :error
+
+    def initialize(error, http_response = nil)
+      @error = error
+      @http_response = http_response
+    end
+
+    # String representation
+    # @return [String]
+    def to_s
+      "#{error}"
+    end
+  end
+
+  # This is the error raised on Authentication failures.  Usually this means
+  # one of three things
+  class AuthError < Error; end
+end

data/lib/api_ai/request.rb

@@ -0,0 +1,57 @@
+module ApiAi
+  # Methods to do http requests
+  module Request
+    # Convert params to query string
+    #
+    # @param [Hash] params
+    #   API call arguments
+    # @return [String]
+    def make_query_string(params)
+      clean_params(params).collect do |k, v|
+        CGI.escape(k) + '=' + CGI.escape(v)
+      end.join('&')
+    end
+
+    # Handle http requests
+    # @param [URI::HTTPS] uri
+    #   API uri
+    # @param [Object] request
+    #   request object
+    # @return [Net::HTTPResponse]
+    def do_http(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      # Let then know about us
+      request['User-Agent'] = 'SlackRubyAPIWrapper'
+      begin
+        http.request(request)
+      rescue OpenSSL::SSL::SSLError => e
+        raise Slack::Error, 'SSL error connecting to Slack.'
+      end
+    end
+
+    def do_http_with_body(uri, request, body) # :nodoc:
+      unless body.nil?
+        if body.is_a?(Hash)
+          request['Content-Type'] = 'application/json; charset=utf-8'
+          request.body = clean_params(body).to_json
+        else
+          s = body.to_s
+          request['Content-Length'] = s.length
+          request.body = s
+        end
+      end
+      do_http(uri, request)
+    end
+
+    private
+
+    def clean_params(params) # :nodoc:
+      r = {}
+      params.each do |k, v|
+        r[k] = v.to_s unless v.nil?
+      end
+      r
+    end
+  end
+end

data/lib/api_ai/session.rb

@@ -0,0 +1,55 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+require_relative 'request'
+
+module ApiAi
+  class Session # :nodoc:
+    include Request
+
+    # @param [String] access_token
+    # @param [String] subscription_key
+    def initialize(access_token, subscription_key)
+      unless access_token.is_a?(String)
+        fail 'bad type for access_token (expecting String)'
+      end
+      unless subscription_key.is_a?(String)
+        fail 'bad type for subscription_key (expecting String)'
+      end
+      @access_token = access_token
+      @subscription_key = subscription_key
+    end
+
+    def do_get(path, params = nil, headers = nil) # :nodoc:
+      params ||= {}
+      params['v'] = ApiAi::API_VERSION
+      headers ||= {}
+      headers['Authorization'] = "Bearer #{@access_token}"
+      headers['ocp-apim-subscription-key'] = "Bearer #{@subscription_key}"
+      uri = build_url_with_params(path, params)
+      do_http(uri, Net::HTTP::Get.new(uri.request_uri))
+    end
+
+    def do_post(path, params = nil, headers = nil) # :nodoc:
+      headers ||= {}
+      headers['Authorization'] = "Bearer #{@access_token}"
+      headers['ocp-apim-subscription-key'] = "Bearer #{@subscription_key}"
+
+      uri = build_url_with_params(path, 'v' => ApiAi::API_VERSION)
+      do_http_with_body(uri, Net::HTTP::Post.new(uri.request_uri, headers), params)
+    end
+
+    private
+
+    def build_url(path) # :nodoc:
+      host = ApiAi::API_SERVER
+      full_path = "/v1/#{path}"
+      URI::HTTPS.build(host: host, path: full_path)
+    end
+
+    def build_url_with_params(path, params) # :nodoc:
+      target = build_url(path)
+      target.query = make_query_string(params)
+      target
+    end
+  end
+end

data/lib/api_ai/version.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
+module ApiAi
+  VERSION = '0.0.1'.freeze
+end

data/spec/api_ai/client_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ApiAi::Client do
+  it 'Initialize' do
+    client = ApiAi::Client.new('', '')
+    expect(client).not_to be nil
+  end
+  it 'Validates token is string' do
+    expect { ApiAi::Client.new(1, '') }.to raise_error(ArgumentError)
+    expect { ApiAi::Client.new('', 1) }.to raise_error(ArgumentError)
+    expect { ApiAi::Client.new(1, 1) }.to raise_error(ArgumentError)
+  end
+end

data/spec/api_ai_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ApiAi do
+  it 'has a version number' do
+    expect(ApiAi::VERSION).not_to be nil
+  end
+  it 'has web server domain' do
+    expect(ApiAi::WEB_SERVER).to eq('api.ai')
+  end
+  it 'has api uri' do
+    expect(ApiAi::API_SERVER).to eq('api.api.ai')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'api-ai'

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: api-ai
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Bazan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: |2
+          A library that provides a plain function-call interface to the
+          api.ai web endpoints.
+email:
+- contacto@gustavobazan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- api-ai.gemspec
+- lib/api-ai.rb
+- lib/api_ai/client.rb
+- lib/api_ai/endpoint.rb
+- lib/api_ai/endpoint/entities.rb
+- lib/api_ai/endpoint/intents.rb
+- lib/api_ai/endpoint/query.rb
+- lib/api_ai/endpoint/tts.rb
+- lib/api_ai/error.rb
+- lib/api_ai/request.rb
+- lib/api_ai/session.rb
+- lib/api_ai/version.rb
+- spec/api_ai/client_spec.rb
+- spec/api_ai_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gssbzn/api-ai
+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.4.6
+signing_key: 
+specification_version: 4
+summary: api.ai Wrapper
+test_files:
+- spec/api_ai/client_spec.rb
+- spec/api_ai_spec.rb
+- spec/spec_helper.rb
+has_rdoc: