nugramserver-ruby 0.1.0

data/LICENSE.txt

@@ -0,0 +1,203 @@
+Copyright (c) 2010 Nu Echo Inc
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,68 @@
+NuGram Hosted Server client APIs
+================================
+
+This repository provides the Ruby client API to the NuGram Hosted Server in various languages. It is based on the Ruby library available at https://github.com/nuecho/nugramserver-clients.
+
+NuGram Hosted Server (www.grammarserver.com) is a free hosted service for the management of static and dynamic grammars, courtesy of Nu Echo Inc. It can be used to generate dynamic grammars, and interpret textual sentences.
+
+Installation
+------------
+
+	gem install nugramserver-ruby
+
+Example
+-------
+
+Say you want to create a dynamically-generated grammar for a simple voice-dialing application. The grammar template, hosted on www.grammarserver.com, could look like the following:
+
+### voicedialing.abnf (ABNF template grammar)
+    #ABNF 1.0;
+    
+    language en-US;
+    mode voice;
+    root $voicedialing;
+
+    public $voicedialog = 
+      [$politeness]
+      @for (entry : entries) 
+        ( [@word entry.firstname] @word entry.lastname 
+          @tag "out.id = '" entry.id "'" @end )
+      @end
+      [please]
+    ;
+    
+    $politeness = 
+        (I would | I'd) like to (speak with| talk to) 
+      | give me
+    ;
+
+And the code to instantiate the grammar would look like:
+
+### app.rb (Ruby)
+
+	require 'nugramserver-ruby'
+    server = GrammarServer.new()
+    session = server.create_session("username", "password")
+    grammar = session.instantiate("voicedialing.abnf", 
+                                  {'entries' => 
+                                    [{'firstname' => "John", 'lastname' => 'Doe', 'id' => '1234'},
+                                     {'firstname' => "Bill", 'lastname' => 'Smith', 'id' => '4321'}]})
+    puts "grammar url = ", grammar.get_url('grxml')
+    # ....
+    # When you are done with the grammar...
+    session.disconnect
+
+Supported languages
+-------------------
+
+The supported languages are currently:
+
+- Ruby/JRuby
+
+Contact Info
+------------
+
+For any question or request, contact the NuGram team at nugram-support@nuecho.com. The NuGram Platform website is http://nugram.nuecho.com
+
+The Nu Echo team
+

data/lib/nugramserver-ruby.rb

@@ -0,0 +1 @@
+require 'nugramserver-ruby/nugramserver-ruby'

data/lib/nugramserver-ruby/nugramserver-ruby.rb

@@ -0,0 +1,184 @@
+# NuGram Hosted Server client API in Ruby
+#
+# This code relies on the 'json' Ruby gem.
+#
+# Copyright (C) 2009, 2010 Nu Echo Inc.
+#
+# 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.
+
+require 'rubygems' 
+require 'json'
+require 'net/http'
+require 'uri'
+
+
+DEFAULT_SERVER_HOST = "www.grammarserver.com"
+DEFAULT_SERVER_PORT = 8082
+
+## An object of this class acts as a proxy to NuGram Hosted Server.
+class GrammarServer
+
+  attr_reader :host, :port
+
+  def initialize(host=DEFAULT_SERVER_HOST, port=DEFAULT_SERVER_PORT)
+    @host = host
+    @port = port
+  end
+  
+  def get_url
+    "http://#{@host}:#{@port}"
+  end
+  
+  def create_session(username, password)
+    GrammarServerSession.new(self, username, password)
+  end
+  
+end
+
+## This class represents a session with NuGram Hosted Server.
+
+class GrammarServerSession
+
+  attr_reader :server, :username, :password
+
+  def initialize(server, username, password)
+    @server = server
+    @username = username
+    @password = password
+    @sessionid = self.connect
+  end
+  
+  ## Returns the session ID
+  def get_id
+    @sessionid
+  end
+  
+  def connect
+    Net::HTTP.start(@server.host, @server.port) {|http|
+      req = Net::HTTP::Post.new('/session')
+      req.body= "responseFormat=json"
+      req.basic_auth @username, @password
+      response = http.request(req)
+      case response
+        when Net::HTTPSuccess then
+           result = JSON.parse(response.body)
+           result['session']['id']
+        else
+          response.error!
+        end
+    }
+  end
+  
+  ## Terminates the session with NuGram Hosted Server
+  def disconnect
+    Net::HTTP.start(@server.host, @server.port) {|http|
+      req = Net::HTTP::Delete.new("/session/#{@sessionid}")
+      req.basic_auth @username, @password
+      response = http.request(req)
+    }
+  end
+  
+  ## This method uploads a source grammar to NuGram Hosted Server.
+  def upload(grammarPath, content)
+    Net::HTTP.start(@server.host, @server.port) {|http|
+      req = Net::HTTP::Put.new("/grammar/#{grammarPath}")
+      req.body= content
+      req.basic_auth @username, @password
+      response = http.request(req)
+      case response
+        when Net::HTTPSuccess then
+          true
+        else
+          response.error!
+        end
+    }    
+  end
+  
+  ## This method requests NuGram Hosted Server to load a static grammar.
+  def load(grammarPath)
+    instantiate(grammarPath, {})
+  end
+
+  ## This method instantiates a dynamic grammar and loads it.
+  ## The 'context' argument is expected to be a hash (dictionary) that
+  ## maps strings to values. Each value must be convertible to standard JSON.
+  ## Each key in the context must correspond to the name of a variable in the
+  ## ABNF template.
+  def instantiate(grammarPath, context)
+    Net::HTTP.start(@server.host, @server.port) {|http|
+      req = Net::HTTP::Post.new("/grammar/#{@sessionid}/#{grammarPath}")
+      body = URI.escape(context.to_json)
+      req.body= "responseFormat=json&context=#{context.to_json}"
+      req.basic_auth @username, @password
+      response = http.request(req)
+      case response
+        when Net::HTTPSuccess then
+           result = JSON.parse(response.body)
+           InstantiatedGrammar.new(self, result['grammar'])
+        else
+          response.error!
+        end
+    }    
+  end
+  
+end
+
+
+## Objects of this class act as proxy for instantiated grammars on NuGram Hosted Server.
+
+class InstantiatedGrammar
+
+  def initialize(session, data)
+    @session = session
+    @data = data
+  end
+  
+  ## Returns the URL of the grammar
+  def get_url (extension = 'abnf')
+    grammarUrl = @data['grammarUrl']
+    "#{grammarUrl}.#{extension}"
+  end
+  
+  ## Retrieves the source representation of the grammar in the 
+  ## requested format ('abnf', 'grxml', or 'gsl')
+  def get_content (extension = 'abnf')
+    url = URI.parse(self.get_url(extension))
+    Net::HTTP.start(url.host, url.port) {|http|
+      req = Net::HTTP::Get.new(url.path)
+      response = http.request(req)
+      case response
+        when Net::HTTPSuccess then
+           response.body
+        else
+          response.error!
+        end
+    }
+  end
+
+  ## Computes the semantic interpretation of the given sentence
+  ## (which must a string). Returns a Python object of 'False' if
+  ## the sentence cannot be parsed by the grammar.
+  def interpret(sentence)
+    url = URI.parse(@data['interpreterUrl'])
+    sentence = URI.escape(sentence)
+    Net::HTTP.start(url.host, url.port) {|http|
+      req = Net::HTTP::Post.new(url.path)
+      req.body= "responseFormat=json&sentence=#{sentence}"
+      req.basic_auth @session.username, @session.password
+      response = http.request(req)
+      case response
+        when Net::HTTPSuccess then
+           JSON.parse(response.body)['interpretation']
+        else
+          response.error!
+        end
+    }        
+  end
+
+end
+

data/spec/nugramserver-ruby_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# These tests are all local unit tests
+#FakeWeb.allow_net_connect = false
+
+describe "NugramserverRuby" do
+  before(:all) do
+    # Define our Nu Echo Grammar Server credentials
+    @username = 'rubygem'
+    @password = 'nuechorox!'
+    
+    # Authentication resource
+    FakeWeb.register_uri(:post, 
+                         "http://#{@username}:#{@password}@www.grammarserver.com:8082/session", 
+                         :content_type => 'application/json',
+                         :status       => ["200", "Ok"],
+                         :body         => "{\"session\": {\"id\":\"524DC3C5041FC48DD27E\"}}")
+
+   # Create a new grammar
+   # FakeWeb.register_uri(:post, 
+   #                      "http://#{@username}:#{@password}@www.grammarserver.com:8082/grammar/524DC3C5041FC48DD27E/voicedialing.abnf",
+   #                      :content_type => 'application/json',
+   #                      :status       => ["200", "Ok"],
+   #                      :body         => "{\"session\": {\"id\":\"524DC3C5041FC48DD27E\"}}")
+                        
+    @grammar_server = GrammarServer.new
+  end
+  
+  it "should create a GrammarServer object" do
+    @grammar_server.instance_of?(GrammarServer).should == true
+  end
+  
+  it "should create a new Nugram Grammar Server session" do
+    session = @grammar_server.create_session(@username, @password)
+  end
+  
+  it "should create a grammar" do
+    pending()
+    session = @grammar_server.create_session(@username, @password)
+    grammar = session.instantiate("voicedialing.abnf", 
+                                    { 'entries' => 
+                                      [{ 'firstname' => "John", 'lastname' => 'Doe', 'id' => '1234' },
+                                       { 'firstname' => "Bill", 'lastname' => 'Smith', 'id' => '4321' }] })
+    p grammar
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'nugramserver-ruby'
+require 'fakeweb'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: nugramserver-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- NuEcho
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  name: json
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: yard
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: bundler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: jeweler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rcov
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  name: json
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rspec
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+  prerelease: false
+description: ""
+email: nugram-support@nuecho.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- lib/nugramserver-ruby.rb
+- lib/nugramserver-ruby/nugramserver-ruby.rb
+- LICENSE.txt
+- README.md
+has_rdoc: true
+homepage: http://github.com/jsgoecke/nugramserver-ruby
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: NuGram Hosted Server client APIs
+test_files: 
+- spec/nugramserver-ruby_spec.rb
+- spec/spec_helper.rb