wit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6ac091647ac82d9f4f086d6daaed555c0af3686
+  data.tar.gz: c74219501fe69d424acbea861836c73bab6b960c
+SHA512:
+  metadata.gz: 6cf30a3a98cae7ab9b2c0f3ca281b2dc057eb95d8e9eb386fcd08b5d345b9002222b733cb69241a09e105fa3640a8f22796436453e3e75ec965145aa54f47c66
+  data.tar.gz: 52eb5fd930b44c1e51d8883af5107299938a8091c6e7ed539fff0e2a310b3d49dc5902c476a16debe4fd19888807d4d0c5589e14aa8dd49a5506263de2e1167f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.yardopts

@@ -0,0 +1,4 @@
+-
+CHANGES.md
+LICENSE.txt
+README.md

data/CHANGES.md

@@ -0,0 +1,6 @@
+Wit Gem Changes
+===============
+
+## v0.0.1 - *2013-10-14*
+
+- First version, implementing the one API method: `message`.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Justin Workman
+
+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,75 @@
+Wit Ruby Gem
+============
+
+This is an unnoficial Ruby wrapper for the [Wit HTTP API][1]. Wit turns natural
+language into structured data, this gem lets you use the Wit API from your Ruby
+app, provided you have a developer's access token.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'wit'
+```
+
+And then execute:
+
+``` shell
+$ bundle
+```
+
+Or install it yourself as:
+
+``` shell
+$ gem install wit
+```
+
+## Usage
+
+At time of writing, the only API method is `message`.
+
+``` ruby
+require 'wit'
+
+wit = Wit::Client.new '<Your API Key>'
+puts wit.message("I need a bud right now")
+```
+
+A JSON Hash will be returned, like so:
+
+``` json
+{
+  "msg_id": "d953bd6c-c620-4dae-a3fc-7634b4330073",
+  "msg_body": "i need a bud right now!",
+  "outcome": {
+    "intent": "grab_me_something",
+    "entities": {
+      "object_to_grab": {
+        "value": "beer",
+        "start": 9,
+        "end": 12,
+        "body": "bud"
+      }
+    },
+    "confidence": 0.6310633902098893
+  }
+}
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+Copyright © 2013 [Justin Workman](mailto:xtagon@gmail.com)
+
+MIT License, see LICENSE.txt
+
+
+[1]: https://wit.ai/docs/api

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new :spec
+YARD::Rake::YardocTask.new :doc
+
+task default: :spec

data/lib/wit/client.rb

@@ -0,0 +1,53 @@
+module Wit
+	# Represents a connection to the Wit HTTP API
+	class Client
+		require 'multi_json'
+		require 'rest_client'
+
+		# The Wit API's base URL
+		API_ENDPOINT = 'https://api.wit.ai'
+
+		# @param [String] access_token Your unique Wit developer's access token
+		# @param [String] expected_version The Wit API version you wish to use ("YYYYMMDD").
+		#   Not passing this version parameter will use the newest version of the API.
+		def initialize(access_token, expected_version = nil)
+			unless expected_version.nil? || expected_version =~ /\d/
+				raise ArgumentError "expected_version must be nil or 'YYYYMMDD' date format"
+			end
+
+			@access_token = access_token
+			@expected_version = expected_version
+		end
+
+		# @note See the official Wit API documentation for details on what these parameters mean.
+		#
+		# @param [String] q User's query
+		# @param [String] context JSON representation of the user's context
+		# @param [String] meta JSON representation of any information you want to
+		#   attach to this request through its life cycle in Wit.
+		#
+		# @return [Hash] The API's JSON response as a Hash
+		def message(q, context = nil, meta = nil)
+			params = {q: q, context: context, meta: meta}
+			headers = default_headers.merge(params: params)
+			response = api['message'].get(headers)
+			MultiJson.load(response)
+		end
+
+		private
+
+		def default_headers
+			unless @default_headers
+				@default_headers = {Authorization: "Bearer #{@access_token}"}
+				unless @expected_version.nil?
+					@default_headers.merge!(Accept: "application/vnd.wit.#{@expected_version}")
+				end
+			end
+			@default_headers
+		end
+
+		def api
+			@api ||= RestClient::Resource.new API_ENDPOINT
+		end
+	end
+end

data/lib/wit/version.rb

@@ -0,0 +1,4 @@
+module Wit
+	# The version of the currently loaded Wit gem
+	VERSION = '0.0.1'
+end

data/lib/wit.rb

@@ -0,0 +1,2 @@
+require 'wit/version'
+require 'wit/client'

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'wit'
+
+RSpec.configure do |config|
+	config.treat_symbols_as_metadata_keys_with_true_values = true
+	config.run_all_when_everything_filtered = true
+	config.filter_run :focus
+
+	# 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'
+end

data/spec/wit/version_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Wit::VERSION do
+	it('is a valid version string') { should =~ /\A\d+\.\d+\.\d+(-\w+)?\Z/ }
+end

data/wit.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wit/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'wit'
+	spec.version       = Wit::VERSION
+	spec.authors       = ['Justin Workman']
+	spec.email         = ['xtagon@gmail.com']
+	spec.summary       = 'A Ruby wrapper for the Wit HTTP API.'
+	spec.description   = 'A Ruby wrapper for the Wit HTTP API, a natural language processing interface.'
+	spec.license       = 'MIT'
+
+	spec.files         = `git ls-files`.split($/)
+	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_runtime_dependency 'multi_json', '~> 1.8.2'
+	spec.add_runtime_dependency 'rest-client', '~> 1.6.7'
+
+	spec.add_development_dependency 'bundler', '~> 1.3'
+	spec.add_development_dependency 'rake'
+	spec.add_development_dependency 'redcarpet'
+	spec.add_development_dependency 'rspec', '~> 2.14.1'
+	spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: wit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Workman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the Wit HTTP API, a natural language processing interface.
+email:
+- xtagon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wit.rb
+- lib/wit/client.rb
+- lib/wit/version.rb
+- spec/spec_helper.rb
+- spec/wit/version_spec.rb
+- wit.gemspec
+homepage: 
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Wit HTTP API.
+test_files:
+- spec/spec_helper.rb
+- spec/wit/version_spec.rb
+has_rdoc: