lingotek-client 0.1.2 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.2.0    
+* Major changes
+  * adding resources to apis
+  * change api class to be static
 == 0.1.2    
 * bug fix
   * remove rake dependency

data/README.rdoc

@@ -0,0 +1,10 @@
+== Lingotek Client Sample
+require 'lingotek-client'
+include LingotekClient
+include LingotekClient::Resource
+
+API::connect('http://10.0.11.112:8080/lingopoint/api/4/', 'mykey', 'mysecret', 'myuser')
+
+Project.all.each do |project|
+  puts project.name
+end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/lingotek-client.rb

@@ -1,5 +1,11 @@
 module LingotekClient
 end
 
-require "lingotek-client/version"
-require "lingotek-client/api"
+require 'lingotek-client/version'
+require 'lingotek-client/api'
+
+require 'lingotek-client/resource/base'
+require 'lingotek-client/resource/project'
+require 'lingotek-client/resource/document'
+require 'lingotek-client/resource/workflow'
+require 'lingotek-client/resource/translation_target'

data/lib/lingotek-client/api.rb

@@ -1,91 +1,83 @@
 require 'oauth'
-require_relative 'rest-client-patch'
+require 'rest-client'
+
 
 require_relative './schema'
 
 module LingotekClient
-  class Api
-
-    def initialize(url, key, secret, external_id, validate = false)
-      @url = URI.parse(url)
-      @key = key
-      @secret = secret
-      @external_id = external_id
-      @validate = validate
-      generate_token
-    end
-
-    def method_missing(method, *args, &block)
-      inputs = args.first || {}
-      if args[1].nil?
-        validate = @validate
-      else
-        validate = args[1] 
+  module API
+
+    @@url = nil
+    @@key = nil
+    @@secret = nil
+    @@external_id = nil
+    @@validate = nil
+
+    class << self
+      def connect(url, key, secret, external_id, validate = false)
+        @@url = URI.parse(url)
+        @@key = key
+        @@secret = secret
+        @@external_id = external_id
+        @@validate = validate
+        generate_token
+        RestClient.reset_before_execution_procs
+        RestClient.add_before_execution_proc do |req, params|
+          @@access_token.sign! req
+        end
       end
 
-      LingotekClient::Schema.validate!(method, inputs.keys ) if validate
-      # retrive the file params
-      file_upload_params = inputs.select { |k,v|  v.is_a? File }
-      inputs.delete_if { |k,v|  v.is_a? File }
-      post(method, inputs, file_upload_params)
-    end
-
-    def generate_token
-      consumer = OAuth::Consumer.new(@key, @secret, site: site, :request_token_path => "", :authorize_path => "", :access_token_path => "", :http_method => :post)
-      @access_token = OAuth::AccessToken.new(consumer)
-    end
 
-    private
+      def method_missing(method, *args, &block)
+        inputs = args.first || {}
+        if args[1].nil?
+          validate = @@validate
+        else
+          validate = args[1] 
+        end
 
-    def post(method, params = {}, file_upload_params = {})
-      params[:externalId] ||= @external_id
-      client = RestClient::Resource.new url_path(method, params)
-      client.add_before_execution_proc do |req, params|
-        @access_token.sign! req
+        LingotekClient::Schema.validate!(method, inputs.keys ) if validate
+        # retrive the file params
+        file_upload_params = inputs.select { |k,v|  v.is_a? File }
+        inputs.delete_if { |k,v|  v.is_a? File }
+        post(method, inputs, file_upload_params)
       end
-      client.post(file_upload_params)
-    end
 
+      def generate_token
+        consumer = OAuth::Consumer.new(@@key, @@secret, :site => site, :request_token_path => "", :authorize_path => "", :access_token_path => "", :http_method => :post)
+        @@access_token = OAuth::AccessToken.new(consumer)
+      end
 
-#     def post(method, params = {}, file_upload_params = {})
-#       params[:externalId] ||= @external_id
-#       client = RestClient::Resource.new url_path(method, params)
-#       client.post(file_upload_params)
-#     end
 
-#     def post(method, params = {}, file_upload_params = {})
-#       params[:externalId] ||= @external_id
-#       RestClient.post(url_path(method, params), file_upload_params)
-#     end
+      def post(method, params = {}, file_upload_params = {})
+        params[:externalId] ||= @external_id
+        RestClient.post url_path(method, params), file_upload_params
+      end
 
-    def url_path(method, params)
-      "#{site}#{@url.path}#{method}?#{uri_encode_www_form(params)}"
-    end
+      def url_path(method, params)
+        "#{site}#{@@url.path}#{method}?#{uri_encode_www_form(params)}"
+      end
 
-    def uri_encode_www_form(params)
-      query = URI.encode_www_form(params.select { |k,v| (!v.is_a?(Array)) } )
-      query << '&' unless query.empty?
-      query << uri_encode_www_form_array(params.select { |k,v| v.is_a? Array } )
-    end
+      def uri_encode_www_form(params)
+        query = URI.encode_www_form(params.select { |k,v| (!v.is_a?(Array)) } )
+        query << '&' unless query.empty?
+        query << uri_encode_www_form_array(params.select { |k,v| v.is_a? Array } )
+      end
 
-    def uri_encode_www_form_array(params)
-      str = ""
-      params.each do |k,v|
-        v.each do |single_value|
-          str << "#{k}=#{single_value}&"
+      def uri_encode_www_form_array(params)
+        str = ""
+        params.each do |k,v|
+          v.each do |single_value|
+            str << "#{k}=#{single_value}&"
+          end
         end
+        str.gsub(/\&$/, '')
       end
-      str.gsub(/\&$/, '')
-    end
 
-    def site
-      "#{@url.scheme}://#{@url.host}:#{@url.port}"
+      def site
+        "#{@@url.scheme}://#{@@url.host}:#{@@url.port}"
+      end
     end
-
   end
 end
 
-# client = LingotekClient::Api.new('http://10.0.11.152:8080/lingopoint/api/4/', 'test', 'test123', 'shane@lingotek.com')
-# puts client.listLanguageSkills
-# puts client.listAssignedProjects
-

data/lib/lingotek-client/resource/base.rb

@@ -0,0 +1,33 @@
+module LingotekClient
+  module Resource 
+    class Base
+      attr_accessor :data
+
+      ERRORS = 'errors'
+      RESULTS = 'results'
+      FAIL = 'fail'
+
+      def initialize(attrs)
+        @data = attrs
+      end
+
+      def self.all
+        action_name = "#{key}s"
+        objects = JSON.parse(LingotekClient::API::send("list#{action_name}"))[action_name.downcase]
+        objects.map { |obj| self.new obj }
+      end
+
+      def self.find(id)
+        action_name = key
+        object = self.new(JSON.parse(Lingotek::API::api.send("get#{action_name}", "#{action_name.downcase}Id" => id)))
+        raise Exception.new "#{Key} not found" if object.id == nil
+        object
+      end
+
+      def self.key
+        "#{self.name.split("::").last}"
+      end
+
+    end
+  end
+end

data/lib/lingotek-client/resource/document.rb

@@ -0,0 +1,47 @@
+module LingotekClient
+  module Resource 
+    class Document < Base
+      attr_accessor :name, :description, :source_language, :tm_vault_id, :percent_complete, :source_character_count, :id , :source_word_count, :source_sentence_count, :unique_word_count, :unique_sentence_count, :duplicate_word_count, :duplicate_sentence_count, :format_tag_count, :translation_target_refs
+      def initialize(attrs)
+        super(attrs)
+        @id = attrs['id']
+        @name = attrs['name']
+        @description = attrs['description']
+        @source_language = attrs['sourceLanguage']
+        @tm_vault_id = attrs['tmVaultId']
+        @percent_complete = attrs['percentComplete']
+        @source_character_count = attrs['sourceCharacterCount']
+        @source_word_count = attrs['sourceWordCount'].to_i
+        @source_sentence_count = attrs['sourceSentenceCount'].to_i
+        @unique_word_count = attrs['uniqueWordCount'].to_i
+        @unique_sentence_count = attrs['uniqueSentenceCount'].to_i
+        @duplicate_word_count = attrs['duplicateWordCount'].to_i
+        @duplicate_sentence_count = attrs['duplicateSentenceCount'].to_i
+        @format_tag_count = attrs['formatTagCount'].to_i
+        @translation_target_refs = attrs['translationTargets']
+      end
+
+      def all
+        raise Exception.new "Method not available"
+      end
+
+      def translation_targets
+        Lingotek::API::TranslationTarget.find_by_document_id(@id)
+      end
+
+      def type
+        @name.split('.').last
+      end
+
+      def source_language
+        Language.new(@source_language)
+      end
+
+      def due_date
+        #TODO calculate the document due_date base on the lastest due date from all targets
+        Time.now
+      end
+
+    end
+  end
+end

data/lib/lingotek-client/resource/project.rb

@@ -0,0 +1,49 @@
+module LingotekClient
+  module Resource 
+    class Project < Base
+      attr_accessor :name, :state, :company_id, :percent_complete, :document_ids, :created_at, :id, :workflow_id, :due_date
+
+        FILENAME = 'download.zip'
+
+      ACTIVE = 'Active'
+      COMPLETED = 'Completed'
+
+      def initialize(attrs)
+        super(attrs)
+        @id = attrs['id']
+        @name = attrs['name']
+        @state = attrs['state']
+        @company_id = attrs['companyId']
+        @percent_complete = attrs['percentComplete']
+        @document_ids = attrs['documents'].map { |doc| doc['id'] }
+        @created_at = attrs['createdDate']
+        @workflow_id = attrs['workflowId']
+        @due_date = attrs['due_date']
+      end
+
+      def workflow
+        @workflow ||= Lingotek::API::Workflow.find @workflow_id if @workflow_id && @workflow_id != 0
+      end
+
+      def documents
+        @document_ids.map { |doc_id| Lingotek::API::Document.find(doc_id) }
+      end
+
+      def self.download_documents(id, target)
+        FileUtils.mkdir_p("#{target}/#{id}")
+        File.open(FILENAME, 'wa') do |f|
+          f.write(Lingotek::API::api.downloadProjectDocuments projectId: id)
+        end
+      end
+
+      def active?
+        @state == ACTIVE
+      end
+
+      def completed?
+        @state == COMPLETED
+      end
+
+    end
+  end
+end

data/lib/lingotek-client/resource/translation_target.rb

@@ -0,0 +1,33 @@
+module LingotekClient
+  module Resource 
+    class TranslationTarget < Base
+      attr_accessor :id, :language, :due_date, :description, :match_sentences, :match_words, :phases
+
+      def initialize(attrs)
+        super(attrs)
+        @id = attrs['id']
+        @language = attrs['language']
+        @due_date = attrs['due_date']
+        @description = attrs['description']
+        @match_sentences= attrs['matchSentneces']
+        @match_words= attrs['matchWords']
+        @phases = attrs['phases']
+      end
+
+      def self.find_by_document_id(id)
+        objects = JSON.parse(Lingotek::API::api.listTranslationTargets( documentId: id ) )
+        objects = objects['translationTargets']
+        objects.map { |obj| self.new obj }
+      end
+
+      def current_phase
+         @phase.first  if @phase
+      end
+
+      def country_code
+        @language.split('_').last.downcase
+      end
+
+    end
+  end
+end

data/lib/lingotek-client/resource/user.rb

@@ -0,0 +1,28 @@
+module LingotekClient
+  module Resource 
+    class User < Base
+      attr_accessor :username
+      def initialize(opts = {})
+        @username = opts[:username]
+      end
+
+
+      def valid_credentials?(password)
+        User.valid_credentials?(@username, password)
+      end
+
+      def self.valid_credentials?(username, password)
+        JSON.parse(Lingotek::API::api.validateCredentials(externalId: username, password: password))['result'] == 'success'
+      end
+
+      def enable_login(password)
+        enable_login(@username, password)
+      end
+
+      def self.enable_login(username, password)
+        JSON.parse(Lingotek::API::api.allowLocalLogin(externalId: username, password: password))['result'] == 'success'
+      end
+
+    end
+  end
+end

data/lib/lingotek-client/resource/workflow.rb

@@ -0,0 +1,25 @@
+module LingotekClient
+  module Resource 
+    class Workflow < Base
+      attr_accessor :id, :name , :desc, :mod, :steps
+
+      def initialize(attrs)
+        super(attrs)
+        @id = attrs['id']
+        @name = attrs['name']
+        @desc = attrs['desc']
+        @mod = attrs['mod']
+        @steps = attrs['steps']
+      end
+
+      def self.find(id)
+        action_name = key
+        object = JSON.parse(Lingotek::API::api.send("get#{action_name}", "id" => id))
+        raise Exception.new "API call failed" if object[Lingotek::API::Base::RESULTS] == Lingotek::API::Base::FAIL
+        object = self.new object[action_name.downcase]
+        raise Exception.new "#{Key} not found" if object.id == nil
+        object
+      end
+    end
+  end
+end

data/lib/lingotek-client/schema.rb

@@ -1,5 +1,5 @@
 require 'json'
-require_relative './api_schema'
+require 'lingotek-client/api_schema'
 
 module LingotekClient
   class Schema

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lingotek-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -82,21 +82,27 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.md
+- README.rdoc
+- CHANGELOG.rdoc
 files:
-- lib/lingotek-client/version.rb
+- lib/lingotek-client.rb
+- lib/lingotek-client/api_schema.rb
 - lib/lingotek-client/api.rb
-- lib/lingotek-client/rest-client-patch.rb
+- lib/lingotek-client/version.rb
+- lib/lingotek-client/resource/user.rb
+- lib/lingotek-client/resource/project.rb
+- lib/lingotek-client/resource/document.rb
+- lib/lingotek-client/resource/translation_target.rb
+- lib/lingotek-client/resource/base.rb
+- lib/lingotek-client/resource/workflow.rb
 - lib/lingotek-client/schema.rb
-- lib/lingotek-client/api_schema.rb
-- lib/lingotek-client.rb
-- update_schema/update_schema
 - update_schema/table.html
 - update_schema/test
+- update_schema/update_schema
 - VERSION
-- CHANGELOG.rdoc
 - LICENSE
-- README.md
+- README.rdoc
+- CHANGELOG.rdoc
 homepage: http://lingotek.com
 licenses: []
 post_install_message: 
@@ -123,4 +129,3 @@ signing_key:
 specification_version: 3
 summary: Lib that allows to connect with lingotek apis
 test_files: []
-has_rdoc: 

data/lib/lingotek-client/rest-client-patch.rb

@@ -1,133 +0,0 @@
-require 'rest-client'
-
-module RestClient
-  class Resource
-    attr_reader :before_execution_procs
-
-    def initialize(url, options={}, backwards_compatibility=nil, &block)
-      @url = url
-      @block = block
-      if options.class == Hash
-        @options = options
-      else # compatibility with previous versions
-        @options = { :user => options, :password => backwards_compatibility }
-      end
-      @before_execution_procs = [] 
-    end
-
-    def add_before_execution_proc( & block )
-      @before_execution_procs << block
-    end
-
-    def reset_before_execution_procs
-      @before_execution_procs = []
-    end
-
-    def post(payload, additional_headers={}, &block)
-     headers = (options[:headers] || {}).merge(additional_headers)
-     args = options.merge(
-                    :method => :post,
-                    :url => url,
-                    :payload => payload,
-                    :headers => headers)
-     request = Request.new(args)
-    @before_execution_procs.each do |before_proc|
-       request.add_before_execution_proc &before_proc
-    end
-     request.execute( &(block || @block) )
-   end
-
-  end
-
-  class Request
-    attr_reader :before_execution_procs
-
-    def initialize args
-      @method = args[:method] or raise ArgumentError, "must pass :method"
-      @headers = args[:headers] || {}
-      if args[:url]
-        @url = process_url_params(args[:url], headers)
-      else
-        raise ArgumentError, "must pass :url"
-      end
-      @cookies = @headers.delete(:cookies) || args[:cookies] || {}
-      @payload = Payload.generate(args[:payload])
-      @user = args[:user]
-      @password = args[:password]
-      @timeout = args[:timeout]
-      @open_timeout = args[:open_timeout]
-      @block_response = args[:block_response]
-      @raw_response = args[:raw_response] || false
-      @verify_ssl = args[:verify_ssl] || false
-      @ssl_client_cert = args[:ssl_client_cert] || nil
-      @ssl_client_key = args[:ssl_client_key] || nil
-      @ssl_ca_file = args[:ssl_ca_file] || nil
-      @tf = nil # If you are a raw request, this is your tempfile
-      @max_redirects = args[:max_redirects] || 10
-      @processed_headers = make_headers headers
-      @args = args
-      @before_execution_procs = [] 
-    end
-
-    def add_before_execution_proc( & block )
-      @before_execution_procs << block
-    end
-
-    def reset_before_execution_procs
-      @before_execution_procs = []
-    end
-
-    def transmit uri, req, payload, & block
-      setup_credentials req
-
-      net = net_http_class.new(uri.host, uri.port)
-      net.use_ssl = uri.is_a?(URI::HTTPS)
-      if (@verify_ssl == false) || (@verify_ssl == OpenSSL::SSL::VERIFY_NONE)
-        net.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      elsif @verify_ssl.is_a? Integer
-        net.verify_mode = @verify_ssl
-        net.verify_callback = lambda do |preverify_ok, ssl_context|
-          if (!preverify_ok) || ssl_context.error != 0
-            err_msg = "SSL Verification failed -- Preverify: #{preverify_ok}, Error: #{ssl_context.error_string} (#{ssl_context.error})"
-            raise SSLCertificateNotVerified.new(err_msg)
-          end
-          true
-        end
-      end
-      net.cert = @ssl_client_cert if @ssl_client_cert
-      net.key = @ssl_client_key if @ssl_client_key
-      net.ca_file = @ssl_ca_file if @ssl_ca_file
-      net.read_timeout = @timeout if @timeout
-      net.open_timeout = @open_timeout if @open_timeout
-
-      # disable the timeout if the timeout value is -1
-      net.read_timeout = nil if @timeout == -1
-      net.out_timeout = nil if @open_timeout == -1
-
-      RestClient.before_execution_procs.each do |before_proc|
-        before_proc.call(req, args)
-      end
-
-      @before_execution_procs.each do |before_proc|
-        before_proc.call(req, args)
-      end
-
-      log_request
-
-      net.start do |http|
-        if @block_response
-          http.request(req, payload ? payload.to_s : nil, & @block_response)
-        else
-          res = http.request(req, payload ? payload.to_s : nil) { |http_response| fetch_body(http_response) }
-          log_response res
-          process_result res, & block
-        end
-      end
-    rescue EOFError
-      raise RestClient::ServerBrokeConnection
-    rescue Timeout::Error
-      raise RestClient::RequestTimeout
-    end
-  end
-
-end