qordoba_ruby_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 564a067980c8d7b0b0c09d02bf240d304104ae88
+  data.tar.gz: 06e7a879af06f1e5337b1289e12521ed569ea220
+SHA512:
+  metadata.gz: bca7e914f3e91bca74789f41ff962c3f264a9810b4c24ca31ce13dd5f6216bc4c89e079f8f2a2cb9b75165654877e9126f02a8f215f22804bf4f9d7899dacd1d
+  data.tar.gz: c3f098802f4caae23d39a5ac11ff20c32e905107b715060ee4dabaab27eee3eac8130aa471710e1d57b726c87a611a058e9dfe79cf26761abd38798159d495e8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qordoba_ruby_sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,14 @@
+# QordobaRubySdk
+
+## Installation
+
+## Usage
+
+## Development
+
+## Contributing
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qordoba_ruby_sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/qordoba_ruby_sdk/version.rb

@@ -0,0 +1,3 @@
+module QordobaRubySdk
+  VERSION = "0.1.0"
+end

data/lib/qordoba_ruby_sdk.rb

@@ -0,0 +1,247 @@
+require "qordoba_ruby_sdk/version"
+require 'rest-client'
+require 'json'
+
+class QordobaRubySdk 
+  
+  # =========== Constant Vars ==============
+
+  # API
+  BASE = 'https://devapi.qordoba.com/v2'
+  PING = 'ping'
+  LANGUAGES = 'languages'
+  COUNTRIES = 'countries'
+
+  # ORGANIZATION
+  ORG_TEAM = 'organizations/team'
+
+  # PROJECTS
+  PROJ_LIST = 'projects/list'
+  PROJ_DETAIL = 'projects/detail'
+  PROJ_STATUS = 'projects/status'
+  PROJ_WORKFLOW = 'projects/workflow'
+   
+  # FILES
+  FILE_LISTFILES = 'files/list'
+  FILE_TYPES = 'files/types'
+  FILE_UPLOAD = 'files/upload'
+  FILE_EXPORT = 'files/export'
+  FILE_UPDATE = 'files/update'
+  FILE_SEGMENTS = 'files/segments/list'
+  FILE_SEGMENT = 'files/segments/show'
+  FILE_JSON = 'files/json'
+  FILE_BULK1 = 'files/bulk1'
+  FILE_BULK2 = 'files/bulk2'
+
+  # TM
+  TM_LIST = 'tms/list'
+  TM_UPLOAD = 'tms/upload'
+  TM_SHOW = 'tms/show'
+  TM_SEGMENTS = 'tms/segments/list'
+  TM_ADD_SEGMENT = 'tms/segments/add'
+  TM_UPDATE_SEGMENT = 'tms/segments/update'
+  TM_DELETE_SEGMENT = 'tms/segments/delete'
+
+  # ERROR MESSAGES
+  CONSUMER_KEY_ERROR = 'consumer key must be a 32 digit string'
+  ORGANIZATION_ID_ERROR = 'organizationId must be a 4 digit number'
+  PROJECT_ID_ERROR = 'projectId must be a 4 digit number'
+  LANGUAGE_ID_ERROR = 'languageId must be an valid integer'
+  FILE_IDS_ERROR = 'must be a valid fileId or array of valid fileIds'
+  FILE_ID_ERROR = 'must be a valid six digit fileId'
+  SEGMENT_ID_ERROR = 'must be a valid numberic segmentId'
+  MILESTONE_ID_ERROR = 'must be a valid 4 digit numeric milestoneId'
+  VERSION_TAG_ERROR = 'must pass a valid version tag string'
+  PATH_TO_FILE_ERROR = 'must be a valid filepath'
+
+  # =========== Initialize App ==============
+
+  def initialize(consumerKey, organizationId, projectId)
+    _validate({ 
+      :consumerKey => consumerKey, 
+      :organizationId => organizationId, 
+      :projectId => projectId
+    })
+
+    @consumerKey = consumerKey
+    @organizationId = organizationId
+    @projectId = projectId
+
+  end
+
+  # ========= Validate User Inputs ============
+
+  def _validate(hash)
+    keys = hash.keys
+
+    keys.each do |key|
+      value = hash[key]
+      if key == :consumerKey
+        raise CONSUMER_KEY_ERROR unless value.kind_of?(String) && value.length == 32 
+      elsif key == :organizationId
+        raise ORGANIZATION_ID_ERROR unless value.is_a?(Integer) && value.to_s.length == 4
+      elsif key == :projectId
+        raise PROJECT_ID_ERROR unless value.is_a?(Integer) && value.to_s.length == 4
+      elsif key == :languageId
+        raise LANGUAGE_ID_ERROR unless value.is_a?(Integer) && value.to_s.length <= 3
+      elsif key == :versionTag
+        raise VERSION_TAG_ERROR unless value.is_a?(String)
+      elsif key == :fileIds
+        raise FILE_IDS_ERROR unless value.is_a?(Array) || value.is_a?(Integer)
+      elsif key == :fileId
+        raise FILE_ID_ERROR unless value.is_a?(Integer)
+      elsif key == :segmentId
+        raise SEGMENT_ID_ERROR unless value.is_a?(Integer)
+      elsif key == :milestoneId
+        raise MILESTONE_ID_ERROR unless value.is_a?(Integer) && value.to_s.length == 4
+      elsif key == :pathToFile
+        raise PATH_TO_FILE_ERROR unless File.exist?(value)
+      end
+    end
+  end
+
+  # ============= Parse JSON ================
+
+  def _clean(response)
+    if response.is_a?(String)
+      JSON.parse(response)
+    else
+      response
+    end
+  end
+
+
+  # =========== Getting Started ==============
+
+  def ping
+    _clean(RestClient.get "#{BASE}/#{PING}", 
+      { :consumerKey => @consumerKey })
+  end
+
+  def languages
+    _clean(RestClient.get "#{BASE}/#{LANGUAGES}", 
+      { :consumerKey => @consumerKey })
+  end
+
+  def countries
+    _clean(RestClient.get "#{BASE}/#{COUNTRIES}", 
+      { :consumerKey => @consumerKey })
+  end
+
+  # ============= Organization ================
+
+  def organization_team
+    _clean(RestClient.get "#{BASE}/#{ORG_TEAM}", 
+      { :consumerKey => @consumerKey,
+        :organizationId => @organizationId })
+  end
+
+  # =============== Project ===================
+
+  def project_list
+    _clean(RestClient.get "#{BASE}/#{PROJ_LIST}", 
+      { :consumerKey => @consumerKey,
+        :organizationId => @organizationId })
+  end
+
+  def project_detail
+    _clean(RestClient.get "#{BASE}/#{PROJ_DETAIL}", 
+      { :consumerKey => @consumerKey,
+        :projectId => @projectId })
+  end
+
+  def project_status
+    _clean(RestClient.get "#{BASE}/#{PROJ_STATUS}", 
+      { :consumerKey => @consumerKey,
+        :projectId => @projectId })
+  end
+
+  def project_workflow
+    _clean(RestClient.get "#{BASE}/#{PROJ_WORKFLOW}", 
+      { :consumerKey => @consumerKey,
+        :projectId => @projectId })
+  end
+
+  # ================ FILE ====================
+
+  def file_list(languageId)
+    _clean(RestClient.post "#{BASE}/#{FILE_LISTFILES}", {}.to_json,
+      { :consumerKey => @consumerKey,
+        :languageId => languageId,
+        :projectId => @projectId,
+        "content-type" => "application/json" })
+  end
+
+  def file_types
+    _clean(RestClient.get "#{BASE}/#{FILE_TYPES}",
+      { :consumerKey => @consumerKey,
+        :projectId => @projectId })
+  end
+
+  def file_upload(pathToFile, versionTag)
+    _clean(RestClient.post "#{BASE}/#{FILE_UPLOAD}",
+      { :file_names => '[]', 
+        :file => File.open(pathToFile), 
+        :multipart => true
+      }, 
+      { :consumerKey => @consumerKey,
+        :versionTag => versionTag,
+        :projectId => @projectId,
+        :organizationId => @organizationId,
+        :params => { :type => "JSON" } })
+  end
+
+  def file_export(languageId, fileIds)
+    if fileIds.is_a?(Array)
+      fileIds = fileIds.join(',')
+    end
+
+    _clean(RestClient.post "#{BASE}/#{FILE_EXPORT}", {}.to_json,
+      {
+        :consumerKey => @consumerKey,
+        :projectId => @projectId,
+        :fileIds => fileIds,
+        :targetLanguageIds => languageId,
+        "content-type" => "application/json"
+      })
+  end
+
+  def file_update(pathToFile, fileId)
+    _clean(RestClient.post "#{BASE}/#{FILE_UPDATE}",
+      { :file_names => '[]', 
+        :file => File.open(pathToFile), 
+        :multipart => true
+      }, {
+        :consumerKey => @consumerKey,
+        :projectId => @projectId,
+        :fileId => fileId,
+        :params => { "type" => "JSON" }
+      })
+  end
+
+  def file_segments(languageId, fileId)
+    _clean(RestClient.get "#{BASE}/#{FILE_SEGMENTS}",
+      { :consumerKey => @consumerKey,
+        :projectId => @projectId,
+        :languageId => languageId,
+        :fileId => fileId })
+  end
+
+  def file_segment(languageId, fileId, segmentId)
+    _clean(RestClient.get "#{BASE}/#{FILE_SEGMENT}",
+      { :consumerKey => @consumerKey,
+        :projectId => @projectId,
+        :languageId => languageId,
+        :fileId => fileId,
+        :segmentId => segmentId })
+  end
+
+  def file_json(languageId, milestoneId, fileId)
+    _clean(RestClient.get "#{BASE}/#{FILE_JSON}",
+      { :consumerKey => @consumerKey,
+        :projectId => @projectId,
+        :languageId => languageId,
+        :fileId => fileId,
+        :milestoneId => milestoneId })
+  end
+end

data/qordoba_ruby_sdk.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qordoba_ruby_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qordoba_ruby_sdk"
+  spec.version       = QordobaRubySdk::VERSION
+  spec.authors       = ["Erik Suddath"]
+  spec.email         = ["erik@qordoba.com"]
+
+  spec.summary       = %q{Ruby SDK for Qordoba V2 API.}
+  spec.description   = %q{A Ruby Client to interact with the Qordoba V2 API. The SDK gives developers programmatic access to everything on the Qordoba web platform in an easy to use interface.}
+  spec.homepage      = "https://www.qordoba.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: qordoba_ruby_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Suddath
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A Ruby Client to interact with the Qordoba V2 API. The SDK gives developers
+  programmatic access to everything on the Qordoba web platform in an easy to use
+  interface.
+email:
+- erik@qordoba.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/qordoba_ruby_sdk.rb
+- lib/qordoba_ruby_sdk/version.rb
+- qordoba_ruby_sdk.gemspec
+homepage: https://www.qordoba.com/
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Qordoba V2 API.
+test_files: []