ms_paraphrase 0.0.1

data/.rvmrc

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-2.0.0-p353@ms_paraphrase"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.5 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ms_paraphrase.gemspec
+gemspec
+
+gem 'rspec'
+gem 'rest_client'
+gem 'factory_girl'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Martin Tuncaydin
+
+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,63 @@
+# MsParaphrase
+
+This is a rails wrapper for the Microsoft Paraphrase API. Microsoft Paraphrase API is an English-to-English machine translation system that rephrases English sentences in English.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ms_paraphrase'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ms_paraphrase
+
+## Access
+
+Subscribe to the Microsoft Translator API <a href="http://go.microsoft.com/?linkid=9782667">here.</a>
+
+Register your application with <a href="https://datamarket.azure.com/developer/applications/">Azure DataMarket</a>.
+
+##Configuration
+
+The best way to configure the module is to add an initializer in config called ms_paraphrase.rb and add the following :
+
+    MsParaphrase.configure do |config|
+          config.token_api = 'https://datamarket.accesscontrol.windows.net/v2/OAuth2-13'
+          config.paraphrase_api = 'http://api.microsofttranslator.com/v3/json/paraphrase'
+          config.client_id = 'XXXXXXXXXXX'
+          config.client_secret = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+          config.scope = 'http://api.microsofttranslator.com'
+          config.grant_type = 'client_credentials'
+
+          #Configure token manager
+          MsParaphrase.configure_token_manager
+    end
+
+
+##Paraphrasing
+
+    s = "This is a sentence that we are going to run through the microsoft Paraphrase API"
+    MsParaphrase.translator.translate(s)
+
+
+Error message can be found by accessing :
+
+    MsParaphrase.translator.result['em']
+
+Array of results can be found by accessing :
+
+    MsParaphrase.translator.result['paraphrases']
+
+
+## Contributing
+
+1. Fork it ( http://github.com/flightjumpr/ms_paraphrase/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ms_paraphrase.rb

@@ -0,0 +1,115 @@
+require "ms_paraphrase/version"
+require 'uri'
+
+module MsParaphrase
+
+  class Configuration
+    attr_accessor :token_api, :paraphrase_api, :client_id, :client_secret, :scope, :grant_type
+
+    def initialize
+      #self.log_level = 'info'
+    end
+
+  end
+
+  class << self
+    attr_accessor :configuration, :token_manager, :translator
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    self.token_manager ||= TokenManager.new
+    self.translator ||= Translator.new
+    yield(configuration) if block_given?
+  end
+
+  def self.configure_token_manager
+    self.token_manager ||= TokenManager.new
+    yield(token_manager) if block_given?
+  end
+
+  class TokenManager
+
+    private
+    attr_accessor :token, :token_expiration
+    public
+
+    MAX_TRANSLATIONS = 20
+
+    def initialize
+      self.token = nil
+    end
+
+    def get_token
+      if token.nil? || !is_token_valid?(token)
+
+        self.token = JSON.parse(RestClient.post MsParaphrase.configuration.token_api, {:client_id => MsParaphrase.configuration.client_id,
+                                                                            :client_secret => MsParaphrase.configuration.client_secret,
+                                                                            :scope => MsParaphrase.configuration.scope,
+                                                                            :grant_type => MsParaphrase.configuration.grant_type}) if is_credentials_provided?
+      elsif is_token_valid?(token)
+        return token
+      end
+    end
+
+    private
+    def is_credentials_provided?
+      if MsParaphrase.configuration.token_api.nil?
+        raise TranslateApiException.new('No token API endpoint provided.')
+      elsif MsParaphrase.configuration.client_id.nil?
+        raise TranslateApiException.new('No client ID was provided.')
+      elsif MsParaphrase.configuration.client_secret.nil?
+        raise TranslateApiException.new('No client secret was provided.')
+      elsif MsParaphrase.configuration.scope.nil?
+        raise TranslateApiException.new('No scope was provided.')
+      elsif MsParaphrase.configuration.grant_type.nil?
+        raise TranslateApiException.new('No grant type provided.')
+      else
+        return true
+      end
+    end
+
+
+    def is_token_valid?(token)
+       token['expires_in'].to_i < 10 ? false : true
+    end
+
+  end
+
+  class Translator < TokenManager
+    attr_accessor :result
+
+    def translate(sentence)
+      unless sentence.nil?
+        v =  MsParaphrase.configuration.paraphrase_api + "?sentence=#{CGI::escape(sentence)}&language=en&Category=general"
+        r = RestClient.get v, { 'Authorization' => "Bearer #{MsParaphrase.token_manager.get_token['access_token']}"}
+        self.result = JSON.parse(r.force_encoding("UTF-8").gsub("\xEF\xBB\xBF", ''))
+        is_translation_success?
+      end
+    end
+
+    private
+    def is_translation_success?
+      if self.result.keys.include?('em') && self.result['em'] == 'OK' && self.result['paraphrases'].is_a?(Array)
+        return true
+      else
+        raise TranslationException.new(self.result['em'])
+      end
+    end
+
+  end
+
+  public
+  class TranslateApiException < Exception
+    def initialize(data)
+      @data = data
+    end
+  end
+
+  class TranslationException < Exception
+    def initialize(data)
+      @data = data
+    end
+  end
+
+end

data/lib/ms_paraphrase/version.rb

@@ -0,0 +1,3 @@
+module MsParaphrase
+  VERSION = "0.0.1"
+end

data/ms_paraphrase.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ms_paraphrase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ms_paraphrase"
+  spec.version       = MsParaphrase::VERSION
+  spec.authors       = ["Martin Tuncaydin"]
+  spec.email         = ["martin.tuncaydin@flightjumpr.com"]
+  spec.summary       = %q{Wrapper for the microsoft Paraphrase API.}
+  spec.description   = %q{Provides a connectivity wrapper around the microsoft Paraphrase API. Token management and paraphrasing of sentences.}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+end

data/test/connection_spec.rb

@@ -0,0 +1,65 @@
+require 'rspec'
+require 'rest_client'
+require 'ms_paraphrase'
+require 'json'
+
+describe 'Connectivity to translation API' do
+  before(:all) do
+    MsParaphrase.configure do |config|
+      config.token_api = 'https://datamarket.accesscontrol.windows.net/v2/OAuth2-13'
+      config.paraphrase_api = 'http://api.microsofttranslator.com/v3/json/paraphrase'
+      config.client_id = 'FlightJumpr'
+      config.client_secret = 'N1bGd+G03SWwz0rXdpbCQ5rL3as/3H0IqfRO39sql7A='
+      config.scope = 'http://api.microsofttranslator.com'
+      config.grant_type = 'client_credentials'
+
+      #Configure token manager
+      MsParaphrase.configure_token_manager
+    end
+  end
+
+  it 'should connect to microsoft token service and get token' do
+    response = RestClient.post MsParaphrase.configuration.token_api, :client_id => MsParaphrase.configuration.client_id, :client_secret => MsParaphrase.configuration.client_secret, :scope => MsParaphrase.configuration.scope, :grant_type => MsParaphrase.configuration.grant_type
+    expect(response.code).to eq(200) #check for http 200 code
+  end
+
+  it 'should return a json response' do
+    response = RestClient.post MsParaphrase.configuration.token_api, :client_id => MsParaphrase.configuration.client_id, :client_secret => MsParaphrase.configuration.client_secret, :scope => MsParaphrase.configuration.scope, :grant_type => MsParaphrase.configuration.grant_type
+    body = JSON.parse(response.body)
+    body.should include('access_token')
+  end
+
+  describe 'token manager tests' do
+
+    it "module should return saved or created token" do
+      expect(MsParaphrase.token_manager.get_token).to_not be_nil
+    end
+
+  end
+
+  describe 'should paraphrase submitted sentence' do
+    before(:all) do
+      MsParaphrase.configure_token_manager
+    end
+
+    it "should paraphrase provided sentence and produce results" do
+      s = 'This is an example sentence that in an idea world should be translated by the paraphrase API.'
+      expect(MsParaphrase.translator.translate(s)).equal? true
+    end
+
+    it "should produce error message due to too many sentences" do
+      s = 'This is an example sentence that in an idea world should be translated by the paraphrase API. This attempt should fail'
+      expect { MsParaphrase.translator.translate(s) }.to raise_error
+    end
+
+    it "should return response that contains em OK and a set of paraphrase results." do
+      s = 'This is an example sentence that in an idea world should be translated by the paraphrase API.'
+      MsParaphrase.translator.translate(s)
+      expect(MsParaphrase.translator.result.values.include?('em')).equal? true
+      expect(MsParaphrase.translator.result['em']).equal? "OK"
+      expect(MsParaphrase.translator.result['paraphrases']).is_a? Array
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ms_paraphrase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Tuncaydin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Provides a connectivity wrapper around the microsoft Paraphrase API.
+  Token management and paraphrasing of sentences.
+email:
+- martin.tuncaydin@flightjumpr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .idea/.name
+- .idea/.rakeTasks
+- .idea/encodings.xml
+- .idea/misc.xml
+- .idea/modules.xml
+- .idea/ms_paraphrase.iml
+- .idea/scopes/scope_settings.xml
+- .idea/vcs.xml
+- .idea/workspace.xml
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ms_paraphrase.rb
+- lib/ms_paraphrase/version.rb
+- ms_paraphrase.gemspec
+- test/connection_spec.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for the microsoft Paraphrase API.
+test_files:
+- test/connection_spec.rb