lingotek-client 0.1.0

data/update_schema/test

@@ -0,0 +1,357 @@
+{:acceptExternalInvite=>{:required=>["invite_id"], :optional=>[]},
+ :addCommunityDictionaryEntry=>{:required=>["type", "entry"], :optional=>[]},
+ :addCompany=>{:required=>["companyName"], :optional=>[]},
+ :addContact=>{:required=>["userEmail"], :optional=>["comment"]},
+ :addContentDocument=>
+  {:required=>
+    ["projectId",
+     "content",
+     "documentName",
+     "sourceLanguage",
+     "tmVaultId",
+     "format"],
+   :optional=>
+    ["documentDesc",
+     "note",
+     "srxFileContents",
+     "itsFileContents",
+     "fprmFileContents",
+     "secondaryFilter",
+     "secondaryFprmFileContents",
+     "placeholderMode",
+     "priority"]},
+ :addDocument=>
+  {:required=>
+    ["projectId",
+     "file",
+     "documentName",
+     "format",
+     "encoding",
+     "sourceLanguage",
+     "tmVaultId"],
+   :optional=>
+    ["tmTarget",
+     "zipFile",
+     "note",
+     "srxFile",
+     "itsFile",
+     "fprmFile",
+     "secondaryFilter",
+     "secondaryFprmFile",
+     "placeholderMode",
+     "priority"]},
+ :addDocumentURL=>
+  {:required=>["projectId", "url", "sourceLanguage", "tmVaultId"],
+   :optional=>
+    ["format",
+     "target",
+     "tmTarget",
+     "template",
+     "depth",
+     "srxFile",
+     "itsFile",
+     "fprmFile",
+     "secondaryFilter",
+     "secondaryFprmFile",
+     "placeholderMode",
+     "priority"]},
+ :addDocumentWithTargets=>
+  {:required=>
+    ["projectId",
+     "file",
+     "applyWorkflow",
+     "documentName",
+     "format",
+     "encoding",
+     "phaseTemplateId",
+     "sourceLanguage",
+     "tmVaultId"],
+   :optional=>["targetLanguage", "targetAsJSON", "tmTarget", "zipFile"]},
+ :addGlossary=>{:required=>["glossaryName", "asTerminology"], :optional=>[]},
+ :addLabel=>{:required=>["name"], :optional=>["status"]},
+ :addPhase=>
+  {:required=>["translationTargetId", "phaseName"],
+   :optional=>["phaseDescription", "isCommunityAccess", "isSelfAssigned"]},
+ :"addPhaseTemplate (deprecated)"=>
+  {:required=>["phaseTemplateName"], :optional=>[]},
+ :"addPhaseToTemplate (deprecated)"=>
+  {:required=>["phaseTemplateId", "phaseName"],
+   :optional=>["phaseDescription", "isCommunityAccess", "isSelfAssigned"]},
+ :addPreference=>{:required=>["key"], :optional=>["value"]},
+ :addProject=>
+  {:required=>["projectName"],
+   :optional=>["projectDueDate", "companyId", "workflowId", "searchPublic"]},
+ :addProjectDictionary=>
+  {:required=>["project_id", "dictionary_id"], :optional=>[]},
+ :addProjectMT=>{:required=>["project_id", "mt_engine_name"], :optional=>[]},
+ :addProjectTMVault=>
+  {:required=>["tmVaultName", "project_id", "index_id"],
+   :optional=>["isPublic"]},
+ :addSegmentLabelTemplate=>
+  {:required=>["segmentLabelTemplateName"], :optional=>["segmentLabels"]},
+ :addSegmentLabelToTemplate=>
+  {:required=>["segmentLabelTemplateName", "segmentLabels"], :optional=>[]},
+ :addTeam=>{:required=>["name"], :optional=>["description", "image"]},
+ :addTeamLead=>{:required=>["teamId", "clientId"], :optional=>[]},
+ :addTeamMember=>{:required=>["teamId", "clientId"], :optional=>[]},
+ :addTMVault=>{:required=>["tmVaultName"], :optional=>["isPublic"]},
+ :addTranslationTarget=>
+  {:required=>["documentId", "applyWorkflow", "targetLanguage"],
+   :optional=>[]},
+ :analyzeDocument=>{:required=>["documentId"], :optional=>[]},
+ :analyzeProject=>{:required=>["projectId", "documentId"], :optional=>[]},
+ :"applyPhaseTemplate (deprecated)"=>
+  {:required=>["translationTargetId", "phaseTemplateId"], :optional=>[]},
+ :applySegmentLabelTemplate=>
+  {:required=>["documentId", "segmentLabelTemplateName"], :optional=>[]},
+ :assignPhaseTranslator=>
+  {:required=>["phaseId", "translatorUserId"], :optional=>[]},
+ :assignProjectManager=>
+  {:required=>["projectId"], :optional=>["managerLoginName", "managerUserId"]},
+ :assignSelf=>{:required=>["phaseId"], :optional=>[]},
+ :"backgroundJobProgress (deprecated)"=>
+  {:required=>["queueId"], :optional=>[]},
+ :declineExternalInvite=>{:required=>["invite_id", "phase"], :optional=>[]},
+ :dismissPhaseTranslator=>
+  {:required=>["phaseId", "translatorUserId"], :optional=>[]},
+ :dismissProjectManager=>
+  {:required=>["projectId", "managerUserId"], :optional=>[]},
+ :documentSegments=>{:required=>["documentId"], :optional=>[]},
+ :downloadDocument=>
+  {:required=>["documentId", "targetLanguage"],
+   :optional=>["useSource", "useAttributions"]},
+ :downloadDocumentAsCSV=>
+  {:required=>["documentId", "targetLanguage"], :optional=>[]},
+ :downloadDocumentAsSkeleton=>{:required=>["documentId"], :optional=>[]},
+ :downloadDocumentAsTMX=>
+  {:required=>["documentId"], :optional=>["targetLanguage"]},
+ :downloadDocumentAsXliff=>
+  {:required=>["documentId"], :optional=>["targetLanguage"]},
+ :downloadDocumentContent=>
+  {:required=>["documentId", "targetLanguage"], :optional=>[]},
+ :downloadExport=>{:required=>["resourceType", "exportId"], :optional=>[]},
+ :"downloadGlossaryAsCSV (deprecated)"=>
+  {:required=>["glossaryId", "sourceLanguage"], :optional=>["targetLanguage"]},
+ :"downloadGlossaryAsTBX (deprecated)"=>
+  {:required=>["glossaryId", "sourceLanguage"], :optional=>["targetLanguage"]},
+ :"downloadTMVaultAsTMX (deprecated)"=>
+  {:required=>["tmVaultId", "sourceLanguage"], :optional=>["targetLanguage"]},
+ :"downloadTMVaultAsXliff (deprecated)"=>
+  {:required=>["tmVaultId", "sourceLanguage"], :optional=>["targetLanguage"]},
+ :editClientCommunityPreference=>{:required=>["key", "value"], :optional=>[]},
+ :editCompany=>{:required=>["companyId"], :optional=>["companyName"]},
+ :editContact=>{:required=>["contactId"], :optional=>["comment"]},
+ :editDocument=>
+  {:required=>["documentId"], :optional=>["documentName", "tmVaultId"]},
+ :editDocumentSetting=>
+  {:required=>["documentId", "type", "key", "value"], :optional=>[]},
+ :editGlossary=>{:required=>["glossaryId"], :optional=>["glossaryName"]},
+ :editLabel=>
+  {:required=>["id"],
+   :optional=>
+    ["name",
+     "status",
+     "order",
+     "offset",
+     "move_to_label",
+     "show_percent_complete"]},
+ :editPhase=>
+  {:required=>["phaseId"],
+   :optional=>
+    ["phaseName", "phaseDescription", "isCommunityAccess", "isSelfAssigned"]},
+ :"editPhaseTemplate (deprecated)"=>
+  {:required=>["phaseTemplateId"], :optional=>["phaseTemplateName"]},
+ :editPreference=>{:required=>["key", "value"], :optional=>[]},
+ :editProject=>
+  {:required=>["projectId"],
+   :optional=>["projectName", "projectDueDate", "companyId", "searchPublic"]},
+ :editProjectSetting=>
+  {:required=>["projectId", "type", "key", "value"], :optional=>[]},
+ :editSegmentLabelTemplate=>
+  {:required=>["segmentLabelTemplateName"], :optional=>[]},
+ :editTMVault=>
+  {:required=>["tmVaultId"], :optional=>["tmVaultName", "isPublic"]},
+ :editTranslationTarget=>{:required=>["translationTargetId"], :optional=>[]},
+ :exportResource=>
+  {:required=>
+    ["resourceType",
+     "resourceId",
+     "format",
+     "targetLanguages",
+     "sourceLanguage"],
+   :optional=>[]},
+ :findLabel=>{:required=>["name", "limit"], :optional=>[]},
+ :findTM=>
+  {:required=>["tmVaultId", "sourceLang", "targetLang"],
+   :optional=>["searchText", "startDate", "endDate"]},
+ :flushDocumentProgress=>{:required=>["documentId"], :optional=>[]},
+ :getClientCommunityPreference=>{:required=>["key"], :optional=>[]},
+ :getCMSKey=>{:required=>[], :optional=>[]},
+ :getCommunityDictionary=>{:required=>["type"], :optional=>[]},
+ :getCommunityPreference=>{:required=>["key", "type"], :optional=>[]},
+ :getCompany=>{:required=>["companyId"], :optional=>[]},
+ :getContact=>{:required=>["contactId"], :optional=>[]},
+ :getDashboardLink=>{:required=>[], :optional=>[]},
+ :getDocument=>{:required=>["documentId"], :optional=>[]},
+ :getDocumentProgress=>{:required=>["documentId"], :optional=>[]},
+ :getDocumentSetting=>
+  {:required=>["documentId", "type", "key"], :optional=>[]},
+ :getExternalInvites=>{:required=>["invite_id"], :optional=>[]},
+ :getGlossary=>{:required=>["glossaryId"], :optional=>[]},
+ :getLabel=>{:required=>[], :optional=>["id", "name"]},
+ :getPhase=>{:required=>["phaseId"], :optional=>[]},
+ :"getPhaseTemplate (deprecated)"=>
+  {:required=>["phaseTemplateId"], :optional=>[]},
+ :getPreference=>{:required=>["key"], :optional=>[]},
+ :getPriorityJobWorkbenchLink=>{:required=>[], :optional=>[]},
+ :getProject=>{:required=>["projectId"], :optional=>[]},
+ :getProjectSetting=>{:required=>["projectId", "type", "key"], :optional=>[]},
+ :getSegmentLabelTemplate=>
+  {:required=>["segmentLabelTemplateName"], :optional=>[]},
+ :getTMVault=>{:required=>["tmVaultId"], :optional=>[]},
+ :getTranslationTarget=>{:required=>["translationTargetId"], :optional=>[]},
+ :getUsers=>{:required=>["search", "limit", "community"], :optional=>[]},
+ :getVaultLanguages=>{:required=>["tmVaultId"], :optional=>[]},
+ :getWorkbenchLink=>
+  {:required=>["documentId", "phaseId", "invite_id", "embedded"],
+   :optional=>["redirectURL"]},
+ :ignoreSegment=>{:required=>["segmentId", "documentId"], :optional=>[]},
+ :importCommunityDictionary=>
+  {:required=>["type", "file", "delimiter"], :optional=>[]},
+ :joinTeam=>{:required=>["teamId"], :optional=>[]},
+ :leaveTeam=>{:required=>["teamId"], :optional=>[]},
+ :listAssignedProjects=>{:required=>[], :optional=>[]},
+ :listCommunities=>{:required=>[], :optional=>[]},
+ :listCompanies=>{:required=>[], :optional=>[]},
+ :listContacts=>{:required=>[], :optional=>[]},
+ :"listDefaultPhaseTemplates (deprecated)"=>{:required=>[], :optional=>[]},
+ :listDocuments=>{:required=>["documentId"], :optional=>[]},
+ :listDocumentSegmentLabels=>{:required=>["documentId"], :optional=>[]},
+ :listDocumentSegments=>{:required=>["documentId"], :optional=>[]},
+ :listDocumentTranslationSegments=>
+  {:required=>["documentId", "targetLanguage"], :optional=>[]},
+ :listGlossaries=>{:required=>[], :optional=>[]},
+ :listJobs=>{:required=>[], :optional=>[]},
+ :listLabels=>{:required=>[], :optional=>[]},
+ :listLanguages=>{:required=>[], :optional=>["language"]},
+ :listLanguageSkills=>{:required=>[], :optional=>[]},
+ :listLeaderboardRange=>
+  {:required=>[], :optional=>["teamName", "startDate", "endDate"]},
+ :listLeaderboardResults=>
+  {:required=>[], :optional=>["teamName", "maxResults"]},
+ :listPhases=>{:required=>["translationTargetId"], :optional=>[]},
+ :"listPhaseTemplates (deprecated)"=>{:required=>[], :optional=>[]},
+ :listProjects=>{:required=>[], :optional=>[]},
+ :listSegmentLabelTemplates=>{:required=>[], :optional=>[]},
+ :listTeamMembers=>{:required=>["teamId"], :optional=>[]},
+ :listTeams=>{:required=>[], :optional=>[]},
+ :listTMDocuments=>{:required=>["tmVaultId"], :optional=>[]},
+ :listTMVaults=>{:required=>[], :optional=>[]},
+ :listTranslationTargets=>{:required=>["documentId"], :optional=>[]},
+ :listUserStats=>{:required=>[], :optional=>[]},
+ :listWorkflows=>{:required=>[], :optional=>[]},
+ :machineTranslateDocument=>
+  {:required=>["documentId", "engineId", "phaseId"], :optional=>[]},
+ :markPhaseComplete=>{:required=>["phaseId"], :optional=>[]},
+ :MTSegments=>{:required=>["documentId", "json"], :optional=>[]},
+ :pollClientReport=>{:required=>["report_name"], :optional=>[]},
+ :pollDocumentAnalysis=>{:required=>["documentId"], :optional=>[]},
+ :pollDocumentImport=>{:required=>["documentId"], :optional=>[]},
+ :pollGlossaryImport=>{:required=>["glossaryUploadId"], :optional=>[]},
+ :pollProjectAnalysis=>{:required=>["projectId"], :optional=>[]},
+ :pollTMVaultImport=>{:required=>["tmVaultUploadId"], :optional=>[]},
+ :prefillDocument=>
+  {:required=>
+    ["phaseId",
+     "tmVaultId",
+     "tmVaultThreshold",
+     "lockTMVault",
+     "lockTerminology",
+     "overwrite",
+     "completePhase"],
+   :optional=>[]},
+ :regardSegment=>{:required=>["segmentId", "documentId"], :optional=>[]},
+ :removeClientCommunityPreference=>{:required=>["key"], :optional=>[]},
+ :removeCommunityDictionaryEntry=>
+  {:required=>["type", "entry"], :optional=>[]},
+ :removeCompany=>{:required=>["companyId"], :optional=>[]},
+ :removeContact=>{:required=>["contactId"], :optional=>[]},
+ :removeDocument=>{:required=>["documentId"], :optional=>[]},
+ :removeGlossary=>{:required=>["glossaryId"], :optional=>[]},
+ :removeLabel=>{:required=>["id"], :optional=>[]},
+ :removePhase=>{:required=>["phaseId"], :optional=>[]},
+ :removePhaseFromTemplate=>
+  {:required=>["phaseTemplateId", "phaseParameterSetId"], :optional=>[]},
+ :"removePhaseTemplate (deprecated)"=>
+  {:required=>["phaseTemplateId"], :optional=>[]},
+ :removePreference=>{:required=>["key"], :optional=>[]},
+ :removeProject=>{:required=>["projectId"], :optional=>[]},
+ :removeSegmentLabelFromTemplate=>
+  {:required=>["segmentLabelTemplateName", "segmentLabels"], :optional=>[]},
+ :removeSegmentLabelTemplate=>
+  {:required=>["segmentLabelTemplateName"], :optional=>[]},
+ :removeTeam=>{:required=>["teamId"], :optional=>[]},
+ :removeTeamLead=>{:required=>["teamId", "clientId"], :optional=>[]},
+ :removeTeamMember=>{:required=>["teamId", "clientId"], :optional=>[]},
+ :removeTM=>{:required=>["tmVaultId", "tid"], :optional=>[]},
+ :removeTMVault=>{:required=>["tmVaultId"], :optional=>[]},
+ :removeTranslationTarget=>{:required=>["translationTargetId"], :optional=>[]},
+ :removeUploadedTMFromVault=>{:required=>["id"], :optional=>[]},
+ :saveLabelTemplate=>{:required=>["name"], :optional=>["labels"]},
+ :saveSegment=>
+  {:required=>
+    ["sourceText", "targetText", "targetLanguage", "documentId", "overwrite"],
+   :optional=>[]},
+ :searchGlossary=>
+  {:required=>["glossaryId", "text", "sourceLanguage", "targetLanguage"],
+   :optional=>["count"]},
+ :setCommunityConcurrentUsers=>
+  {:required=>["community", "users"], :optional=>[]},
+ :setProfileAttributes=>
+  {:required=>[],
+   :optional=>
+    ["name",
+     "email",
+     "login_id",
+     "phone",
+     "company",
+     "native_language",
+     "location",
+     "notes",
+     "on_leaderboard",
+     "oldpword",
+     "newpword",
+     "source",
+     "old_source",
+     "target",
+     "old_target",
+     "experience",
+     "rate",
+     "rush_rate",
+     "currency",
+     "per",
+     "service_note",
+     "notifications_project_complete",
+     "notifications_assigned_document",
+     "notifications_available_community_document",
+     "notifications_phase_ready"]},
+ :translatorsForLanguage=>
+  {:required=>["sourceLang", "targetLang"], :optional=>[]},
+ :updateContentDocument=>
+  {:required=>["documentId", "content"],
+   :optional=>
+    ["srxFileContents",
+     "itsFileContents",
+     "fprmFileContents",
+     "secondaryFprmFileContents"]},
+ :updateDocument=>{:required=>["documentId", "file"], :optional=>[]},
+ :updateTM=>{:required=>["tmVaultId", "tid", "translation"], :optional=>[]},
+ :uploadCSVToGlossary=>
+  {:required=>["glossaryId", "file"], :optional=>["delimiter"]},
+ :uploadTBXToGlossary=>{:required=>["glossaryId", "file"], :optional=>[]},
+ :uploadTMXToTMVault=>
+  {:required=>["tmVaultId", "file", "name"], :optional=>[]},
+ :uploadXliffToTMVault=>
+  {:required=>["tmVaultId", "file", "name"], :optional=>[]},
+ :uploadXLSToGlossary=>{:required=>["glossaryId", "file"], :optional=>[]},
+ :userState=>{:required=>["clientId"], :optional=>[]}}

data/update_schema/update_schema

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'nokogiri'
+require 'json'
+
+def format(h) 
+  s = "    {\n"
+  h.each do |k,v|
+    s << "      #{k.to_s}: { required: #{v[:required].to_s}, optional: #{v[:optional].to_s}"
+    s << ", is_deprecated: true" if v[:is_deprecated]
+    s << "},\n"
+  end
+  s << "    }\n"
+end
+
+html = Nokogiri::HTML(File.read('table.html'))
+
+tds = html.css('td')
+api_count = tds.count / 2
+
+apis = {}
+api_count.times do |i|
+  method_i = i*2
+  input_i = method_i + 1
+  method = tds[method_i].css('a').first.text
+  find_method = %r{(?<method>\w+)\s*(?<is_deprecated>(\(deprecated\))?)}
+  method =  method.match(find_method)
+  is_deprecated = !(method[:is_deprecated].nil? || method[:is_deprecated].empty?)
+  method = method[:method]
+  required = []
+  optional = []
+  tds[input_i].css('code').each do |input|
+    if input.text.end_with?('*')
+      optional << input.text.chomp('*').to_sym
+    else
+      required << input.text.to_sym
+    end
+  end
+  apis[method.to_sym] = { required: required, optional: optional }
+  apis[method.to_sym][:is_deprecated] = true if is_deprecated
+end
+
+File.open('../lib/lingotek-client/api_schema.rb', 'w+') do |f|
+  f.puts 'module APISchema'
+  f.puts '  def schema'
+  f.puts "#{format(apis)}"
+  f.puts '  end'
+  f.puts 'end'
+end
+
+
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: lingotek-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Fernando Ribeiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+description: Client lib for lingotek apis
+email:
+- fribeiro@lingotek.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- lib/lingotek-client/version.rb
+- lib/lingotek-client/api.rb
+- lib/lingotek-client/schema.rb
+- lib/lingotek-client/api_schema.rb
+- lib/VERSION
+- lib/lingotek-client.rb
+- update_schema/update_schema
+- update_schema/table.html
+- update_schema/test
+- VERSION
+- LICENSE
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Lib that allows to connect with lingotek apis
+test_files: []
+has_rdoc: