smartring 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837a79f27bba855d63ff0055ef98af9f3b065c09f4d9172a8107af31a15fde77
-  data.tar.gz: 5afc964127b1f19de3c0c8462e854c98e24a6df02a4341625ef94b4ee5204bfe
+  metadata.gz: 91f5539a019096679d33badec75a70fa363e4f81e3f51cee66ef8cf5b69863ec
+  data.tar.gz: '0967632d3a9dd84bf5453038a32b898a75faf06ad67e812e774d8df4c46fb49a'
 SHA512:
-  metadata.gz: a6aa2a8fb795346e6e4bad8b49737bc2e4b09af53ab6668b71f32818e061415c882767a94f5807bc83094b82e11f6ec8e299f42c76d8503a85df232411fa61c8
-  data.tar.gz: 4cabd64289c24452b2365045d4b3a0d286086c8a4725ba6032e44f0fd37d45d10d0177ac0485e354971f851cab944261b96a5eec32d14f5cb08e183795aed04f
+  metadata.gz: eea04bdad4bd887734963968c8d2cda50c0306c67fa50fec85083dd098772d733a076ad1f8fab0a9f63203997aa40ff164029bf7368f7140e8a73d0e987aea5f
+  data.tar.gz: 4d0fe2605c97a2cb83f7b0208b78d8a34a8f12ee017b254c7c9216943868a4d7546d129d9d69e0cdfbd184e1503be45914105b52d17edbb9a22cfe8131528dae

data/lib/smartling/client.rb

@@ -5,6 +5,7 @@ require 'smartling/auth'
 require 'smartling/files'
 require 'smartling/contexts'
 require 'smartling/strings'
+require 'smartling/jobs'
 require 'smartling/verbs'
 require 'hipsterhash'
 require 'forwardable'
@@ -16,6 +17,7 @@ module Smartling
     include Auth
     include Files
     include Strings
+    include Jobs
     include Contexts
     include Verbs
 

data/lib/smartling/jobs.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module Smartling
+  # Methods for using the Smartling files API
+  module Jobs
+    def jobs(project_id: @project_id, job_name: nil, translation_job_uids:
+             nil, translation_job_status: nil, limit: nil, offset: nil,
+             sort_by: nil, sort_direction: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs"
+      query = {}
+      query[:jobName] = job_name unless job_name.nil?
+      query[:translationJobUids] = translation_job_uids 
+      query[:translationJobStatus] = translation_job_status unless translation_job_status.nil?
+      query[:limit] = limit unless limit.nil?
+      query[:offset] = offset unless offset.nil?
+      query[:sortBy] = sort_by unless sort_by.nil?
+      query[:sortDirection] = sort_direction unless sort_direction.nil?
+      return get(path) if query.empty?
+      return get(path, query: query)
+    end
+
+    def create_job(project_id: @project_id, job_name: nil, target_locale_ids:
+                   nil, description: nil, due_date: nil, reference_number:
+                   nil, callback_url: nil, callback_method: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs"
+      body = {}
+      body[:jobName] = job_name unless job_name.nil?
+      unless target_locale_ids.nil?
+        body[:targetLocaleIds] = target_locale_ids
+      end
+      body[:description] = description unless description.nil?
+      body[:dueDate] = Time.parse(due_date.to_s).iso8601 unless due_date.nil?
+      body[:referenceNumber] = reference_number unless reference_number.nil?
+      body[:callbackUrl] = callback_url unless callback_url.nil?
+      body[:callbackMethod] = callback_method unless callback_method.nil?
+      return post(path) if body.empty?
+      post(path, body: body)
+    end
+
+    def job(project_id: @project_id, translation_job_uid:)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      get(path)
+    end
+
+    def update_job(project_id: @project_id, translation_job_uid:,
+                   job_name: nil, description: nil, due_date: nil,
+                   reference_number: nil, callback_url: nil,
+                   callback_method: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      body = {}
+      body[:jobName] = job_name unless job_name.nil?
+      body[:description] = description unless description.nil?
+      body[:dueDate] = Time.parse(due_date.to_s).iso8601 unless due_date.nil?
+      body[:referenceNumber] = reference_number unless reference_number.nil?
+      body[:callbackUrl] = callback_url unless callback_url.nil?
+      body[:callbackMethod] = callback_method unless callback_method.nil?
+      return put(path) if body.empty?
+      put(path, body: body)
+    end
+
+    def search_jobs(project_id: @project_id, translation_job_uids: nil,
+                    file_uris: nil, hashcodes: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/search"
+      body = {}
+      unless  translation_job_uids.nil?
+        body[:translationJobUids] = translation_job_uids
+      end
+      body[:hashcodes] = hashcodes unless hashcodes.nil?
+      body[:fileUris] = file_uris unless file_uris.nil?
+      return post(path) if body.empty?
+      post(path, body: body)
+    end
+
+    def job_files(project_id: @project_id, translation_job_uid:, offset: nil,
+                  limit: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/files'
+      query = {}
+      query[:limit] = limit unless limit.nil?
+      query[:offset] = offset unless offset.nil?
+      return get(path) if query.empty?
+      get(path, query: query)
+    end
+
+    def job_progress(project_id: @project_id, translation_job_uid:,
+                     file_uri: nil, offset: nil, limit: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/progress'
+      query = {}
+      query[:fileUri] = file_uri unless file_uri.nil?
+      query[:limit] = limit unless limit.nil?
+      query[:offset] = offset unless offset.nil?
+      return get(path) if query.empty?
+      get(path, query: query)
+    end
+
+    def add_file_to_job(project_id: @project_id, translation_job_uid:,
+                        file_uri:, target_locale_ids: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/file/add'
+      body = {}
+      body[:fileUri] = file_uri
+      body[:targetLocaleIds] = target_locale_ids unless target_locale_ids.nil?
+      post(path, body: body)
+    end
+
+    def remove_file_from_job(project_id: @project_id, translation_job_uid:, file_uri:)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path =  path + '/file/remove'
+      body = { fileUri: file_uri }
+      post(path, body: body)
+    end
+
+    def add_strings_to_job(project_id: @project_id, translation_job_uid:,
+                           hashcodes:, target_locale_ids: nil,
+                           move_enabled: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/strings/add'
+      body = {}
+      body[:hashcodes] = hashcodes
+      body[:targetLocaleIds] = target_locale_ids unless target_locale_ids.nil?
+      body[:moveEnabled] = move_enabled unless move_enabled.nil?
+      post(path, body: body)
+    end
+
+    def remove_strings_from_job(project_id: @project_id, translation_job_uid:,
+                                hashcodes:, locale_ids: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/strings/remove'
+      body = {}
+      body[:hashcodes] = hashcodes
+      body[:localeIds] = locale_ids unless locale_ids.nil?
+      post(path, body: body)
+    end
+
+    def add_locale_to_job(project_id: @project_id, translation_job_uid:,
+                          locale_id:, sync_content: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + "/locales/#{locale_id}"
+      body = {}
+      body[:syncContent] = sync_content unless sync_content.nil?
+      return post(path) if body.nil?
+      post(path, body: body)
+    end
+
+    def remove_locale_from_job(project_id: @project_id, translation_job_uid:,
+                               locale_id: )
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + "/locales/#{locale_id}"
+      delete(path)
+    end
+
+    def close_job(project_id: @project_id, translation_job_uid:)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/close'
+      post(path)
+    end
+
+    def cancel_job(project_id: @project_id, translation_job_uid:, reason: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/cancel'
+      body = {}
+      body[:reason] = reason unless reason.nil?
+      return post(path) if body.nil?
+      post(path, body: body)
+    end
+
+    def authorize_job(project_id: @project_id, translation_job_uid:,
+                      locale_workflows: nil)
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + '/authorize'
+      case locale_workflows
+      when nil
+        return post(path)
+      when Array
+        body = {}
+        body[:localeWorkflows] = locale_workflows.map do |lw|
+          locale = lw[:target_locale_id] || lw.fetch('target_locale_id')
+          workflow = lw[:workflow_uid] || lw.fetch('workflow_uid')
+          { targetLocaleId: locale, workflowUid: workflow }
+        end
+        post(path, body: body)
+      else
+        raise ArgumentError, 'locale_workflows should be an array'
+      end
+    end
+
+    def job_process(project_id: @project_id, translation_job_uid:,
+                    process_uid: )
+      path = "/jobs-api/v3/projects/#{project_id}/jobs/#{translation_job_uid}"
+      path = path + "/processes/#{process_uid}"
+      get(path)
+    end
+  end
+end

data/test/smartling/client_test.rb

@@ -10,6 +10,7 @@ describe Smartling::Client, :vcr do
   it('knows context') { assert client.is_a?(Smartling::Contexts) }
   it('knows about files') { assert client.is_a?(Smartling::Files) }
   it('knows about strings') { assert client.is_a?(Smartling::Strings) }
+  it('knows about jobs') { assert client.is_a?(Smartling::Jobs) }
   it('knows how to authenticate') { assert client.is_a?(Smartling::Auth) }
 
   it 'can be created with options' do

data/test/smartling/jobs_test.rb

@@ -0,0 +1,270 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'smartling/jobs'
+
+describe Smartling::Jobs do
+  let(:smartling) do
+    Class.new(Minitest::Mock) do
+      include Smartling::Jobs
+    end.new
+  end
+
+  after { smartling.verify }
+
+  describe 'jobs' do
+    it 'GETs the right path and query params' do
+      smartling.expect(:get, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs}, path
+      end
+      smartling.jobs(project_id: 1)
+    end
+
+    it 'passes other arguments too' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{jobs-api/v3/projects/1/jobs}, path
+        assert_equal 'ASC', query[:sortDirection]
+        assert_equal 'foo', query[:jobName]
+        assert_equal %w(1 2 3), query[:translationJobUids]
+        assert_equal 100, query[:limit]
+        assert_equal 20, query[:offset]
+      end
+      smartling.jobs(project_id: 1, job_name: 'foo', sort_direction: 'ASC',
+                    translation_job_uids: %w(1 2 3), limit: 100, offset: 20)
+    end
+  end
+
+  describe 'create_job' do
+    it 'POSTs the right path and body' do
+      smartling.expect(:post, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs}, path
+      end
+      smartling.create_job(project_id: 1)
+    end
+
+    it 'builds the correct body' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs}, path
+        assert_equal 'foo', body[:jobName]
+        assert_equal Time.parse('2000-01-01').iso8601, body[:dueDate]
+        assert_equal %w(de), body[:targetLocaleIds]
+        assert_equal '123', body[:referenceNumber]
+        assert_equal 'https://foo.bar', body[:callbackUrl]
+      end
+      smartling.create_job(project_id: 1, job_name: 'foo',
+                           target_locale_ids: %w(de),
+                           due_date: Time.parse('2000-01-01'),
+                           reference_number: '123',
+                           callback_url: 'https://foo.bar')
+    end
+  end
+
+  describe 'job' do
+    it 'GETs the right endpoint' do
+      smartling.expect(:get, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x}, path
+      end
+      smartling.job(project_id: 1, translation_job_uid: 'x')
+    end
+  end
+
+  describe 'update_job' do
+    it 'PUTs the right data to the right endpoint' do
+      smartling.expect(:put, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x}, path
+        assert_equal 'D', body[:description]
+        assert_equal Time.parse('2001-01-01').iso8601, body[:dueDate]
+        assert_equal '123', body[:referenceNumber]
+        assert_equal 'https://x.y', body[:callbackUrl]
+        assert_equal 'GET', body[:callbackMethod]
+      end
+      smartling.update_job(project_id: 1, translation_job_uid: 'x',
+                           description: 'D', due_date: '2001-01-01',
+                           reference_number: '123', job_name: 'N',
+                           callback_url: 'https://x.y',
+                           callback_method: 'GET')
+    end
+  end
+
+  describe 'search_jobs' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/search}, path
+        assert_equal %w(a b), body[:hashcodes]
+        assert_equal %w(x y), body[:fileUris]
+        assert_equal %w(1 2), body[:translationJobUids]
+      end
+      smartling.search_jobs(project_id: 1, hashcodes: %w(a b),
+                            file_uris: %w(x y),
+                            translation_job_uids: %w(1 2))
+    end
+  end
+
+  describe 'job_files' do
+    it 'GETs the right endpoint' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/files}, path
+        assert_equal 3, query[:limit]
+        assert_equal 1, query[:offset]
+      end
+      smartling.job_files(project_id: 1, translation_job_uid: 'x', limit: 3,
+                          offset: 1)
+    end
+  end
+
+  describe 'job_progress (with a file uid)' do
+    it 'GETs job progress for a file' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/progress}, path
+        assert_equal 'a', query[:fileUri]
+      end
+      smartling.job_progress(project_id: 1, translation_job_uid: 'x',
+                             file_uri: 'a')
+    end
+  end
+
+  describe 'job_progress (without a file uid)' do
+    it 'GETs job progress for all files' do
+      smartling.expect(:get, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/progress}, path
+      end
+      smartling.job_progress(project_id: 1, translation_job_uid: 'x')
+    end
+  end
+
+  describe 'add_strings_to_job' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/strings/add}, path
+        assert_equal true, body[:moveEnabled]
+        assert_equal %w(x y), body[:hashcodes]
+        assert_equal %w(de), body[:targetLocaleIds]
+      end
+      smartling.add_strings_to_job(project_id: 1, translation_job_uid: 'x',
+                                   move_enabled: true, hashcodes: %w(x y),
+                                   target_locale_ids: %w(de))
+    end
+  end
+
+  describe 'remove_strings_from_job' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/strings/remove}, path
+        assert_equal %w(x y), body[:hashcodes]
+        assert_equal %w(de), body[:localeIds]
+      end
+      smartling.remove_strings_from_job(project_id: 1,
+                                        translation_job_uid: 'x',
+                                        hashcodes: %w(x y),
+                                        locale_ids: %w(de))
+    end
+  end
+
+  describe 'add_file_to_job' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/file/add}, path
+        assert_equal 'z', body[:fileUri]
+        assert_equal %w(de), body[:targetLocaleIds]
+      end
+      smartling.add_file_to_job(project_id: 1, translation_job_uid: 'x',
+                                file_uri: 'z', target_locale_ids: %w(de))
+    end
+  end
+
+  describe 'remove_file_from_job' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/file/remove}, path
+        assert_equal 'z', body[:fileUri]
+      end
+      smartling.remove_file_from_job(project_id: 1, translation_job_uid: 'x',
+                                     file_uri: 'z')
+    end
+  end
+
+  describe 'add_locale_to_job' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/locales/de-AT}, path
+        assert_equal true, body[:syncContent]
+      end
+      smartling.add_locale_to_job(project_id: 1, translation_job_uid: 'x',
+                                  locale_id: 'de-AT', sync_content: true)
+    end
+  end
+
+  describe 'remove_locale_from_job' do
+    it 'DELETEs the right endpoint' do
+      smartling.expect(:delete, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/locales/de-AT}, path
+      end
+      smartling.remove_locale_from_job(project_id: 1,
+                                       translation_job_uid: 'x',
+                                       locale_id: 'de-AT')
+    end
+  end
+
+  describe 'close_job' do
+    it 'POSTs to the right endpoint' do
+      smartling.expect(:post, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/close}, path
+      end
+      smartling.close_job(project_id: 1, translation_job_uid: 'x')
+    end
+  end
+
+  describe 'cancel_job' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/cancel}, path
+        assert_equal 'Laziness', body[:reason]
+      end
+      smartling.cancel_job(project_id: 1, translation_job_uid: 'x',
+                           reason: 'Laziness')
+    end
+  end
+
+  describe 'authorize_job' do
+    it 'POSTs the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/authorize}, path
+        workflow = body[:localeWorkflows].first
+        assert_equal 'a', body[:localeWorkflows][0][:targetLocaleId]
+        assert_equal 'b', body[:localeWorkflows][0][:workflowUid]
+        assert_equal 'c', body[:localeWorkflows][1][:targetLocaleId]
+        assert_equal 'd', body[:localeWorkflows][1][:workflowUid]
+      end
+      locale_workflows = [
+        { target_locale_id: 'a', workflow_uid: 'b' },
+        { target_locale_id: 'c', workflow_uid: 'd' }
+      ]
+      smartling.authorize_job(project_id: 1, translation_job_uid: 'x',
+                              locale_workflows: locale_workflows)
+    end
+
+    it 'does not require workflows' do
+      smartling.expect(:post, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/authorize}, path
+      end
+      smartling.authorize_job(project_id: 1, translation_job_uid: 'x')
+    end
+
+    it 'explains about workflows if needed' do
+      assert_raises(ArgumentError) do
+        smartling.authorize_job(project_id: 1, translation_job_uid: 'x',
+                                locale_workflows: {})
+      end
+    end
+  end
+
+  describe 'job_process' do
+    it 'GETs the right endpoint' do
+      smartling.expect(:get, nil) do |path|
+        assert_match %r{jobs-api/v3/projects/1/jobs/x/processes/y}, path
+      end
+      smartling.job_process(project_id: 1, translation_job_uid: 'x',
+                            process_uid: 'y')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartring
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - JJ Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -282,6 +282,7 @@ files:
 - lib/smartling/client.rb
 - lib/smartling/contexts.rb
 - lib/smartling/files.rb
+- lib/smartling/jobs.rb
 - lib/smartling/strings.rb
 - lib/smartling/verbs.rb
 - lib/smartring.rb
@@ -289,6 +290,7 @@ files:
 - test/smartling/client_test.rb
 - test/smartling/contexts_test.rb
 - test/smartling/files_test.rb
+- test/smartling/jobs_test.rb
 - test/smartling/strings_test.rb
 - test/smartling_test.rb
 - test/test_helper.rb