ruby-lokalise-api 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a5f36579a974c5603be3b92103e0aebce9284a26919cbfbe87ce50b4f99669f
-  data.tar.gz: a36515189ac1c9242c5e21417ac52bcd27a0b43616d23e0881f41096bd03a778
+  metadata.gz: 0f06a31e2619b9aead1f7fe44c4b62557636389c95102757c263672bedef9f19
+  data.tar.gz: 4c76a5505ffca2f4cc6218abddc017439175d11ca689d0e0f5f2a042e94e3bf0
 SHA512:
-  metadata.gz: 8d60b0a73b05773d852d4694e725e89e908045b6683f9c5611448f23368e490cdb05bb22a29c663671cf6e8f0294db186a198ac7e7bb2a67d94173ce1b98fd7f
-  data.tar.gz: 500835c3d7f8c4a49691958abc3a5bf36a9f15ddbe3694e2ec02174524f21918f145d28f328d7e17f32e0bed866e87626be7e14a3b844984f65599bb01cc07b8
+  metadata.gz: f9e28c0ddf96ac41b7658fdf41d277d9a7fc57940c126f16dcc47b2f24d882b998d83f975a6c5a3840bc81eb8ee12bb2d04978f79cca6f52f0a33e81abf0a235
+  data.tar.gz: 58837157151d763e18c4c4f13617dfef4c56e1011e0ce2416832b778fbe6d60719b9c0e3ba10ab0c675239ce9f32ef86b86ddcd8f728bd50187e69625753891e

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+
+## 2.3.0 (17-July-19)
+
+* Incorporated latest API changes
+* Added support for [`TranslationStatus` endpoint](https://lokalise.co/api2docs/ruby/#resource-translation-statuses)
+
 ## 2.2.0 (19-May-19)
 
 * Added support for [`TeamUserGroup` endpoint](https://lokalise.co/api2docs/ruby/#resource-team-user-groups)

data/README.md

@@ -29,6 +29,7 @@ Official opinionated Ruby interface for the [Lokalise API](https://lokalise.co/a
   + [Team user groups](#team-user-groups)
   + [Translations](#translations)
   + [Translation Providers](#translation-providers)
+  + [Translation Statuses](#translation-statuses)
 * [Additional Info](#additional-info)
   + [Error handling](#error-handling)
   + [API Rate Limits](#api-rate-limits)
@@ -1367,6 +1368,105 @@ translation.update(params)
                                                     ## Single provider for the team
 ```
 
+### Translation Statuses
+
+[Translation Status attributes](https://lokalise.co/api2docs/ruby/#object-translation-statuses)
+
+*Custom translation statuses must be enabled for the project before using this endpoint!* It can be done in the project settings.
+
+#### Fetch translation statuses
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-custom-translation-statuses-get)
+
+```ruby
+@client.translation_statuses(project_id, params = {}) # Input:
+                                                      ## project_id (string, required)
+                                                      ## params (hash)
+                                                      ### :page and :limit
+                                                      # Output:
+                                                      ## Collection of translation statuses for the project
+```
+
+#### Fetch a single translation status
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-custom-translation-status-get)
+
+```ruby
+@client.translation_status(project_id, status_id) # Input:
+                                                  ## project_id (string, required)
+                                                  ## status_id (string or integer, required)
+                                                  # Output:
+                                                  ## Translation status inside the given project
+```
+
+#### Create translation status
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-a-custom-translation-status-post)
+
+```ruby
+@client.create_translation_status(project_id, params) # Input:
+                                                      ## project_id (string, required)
+                                                      ## params (hash, required)
+                                                      ### :title (string, required) - title of the new status
+                                                      ### :color (string, required) - HEX color code of the new status. Lokalise allows a very limited number of color codes to set. Check the official docs or use `#translation_status_colors` method listed below to find the list of supported colors
+                                                      # Output:
+                                                      ## Created translation status
+```
+
+#### Update translation status
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-custom-translation-status-put)
+
+```ruby
+@client.update_translation_status(project_id, status_id, params)  # Input:
+                                                                  ## project_id (string, required)
+                                                                  ## status_id (string or integer, required)
+                                                                  ## params (hash, required)
+                                                                  ### :title (string, required) - title of the new status
+                                                                  ### :color (string, required) - HEX color code of the new status
+                                                                  # Output:
+                                                                  ## Updated translation status
+```
+
+Alternatively:
+
+```ruby
+status = @client.translation_status(project_id, status_id)
+status.update(params)
+```
+
+#### Delete translation status
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-custom-translation-status-delete)
+
+```ruby
+@client.destroy_translation_status(project_id, status_id) # Input:
+                                                          ## project_id (string, required)
+                                                          ## status_id (string or integer, required)
+                                                          # Output:
+                                                          ## Translation status inside the given project
+```
+
+Alternatively:
+
+```ruby
+status = @client.translation_status(project_id, status_id)
+status.destroy
+```
+
+#### Supported color codes for translation statuses
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-available-colors-for-custom-translation-statuses-get)
+
+As long as Lokalise supports only very limited array of color hexadecimal codes for custom translation statuses, this method can be used to fetch all permitted values.
+
+```ruby
+@client.translation_status_colors(project_id) # Input:
+                                                          ## project_id (string, required)
+                                                          # Output:
+                                                          ## Array of color codes in HEX format
+```
+
 ## Additional Info
 
 ### Error handling

data/lib/ruby-lokalise-api.rb

@@ -30,6 +30,7 @@ require 'ruby-lokalise-api/resources/order'
 require 'ruby-lokalise-api/resources/payment_card'
 require 'ruby-lokalise-api/resources/translation_provider'
 require 'ruby-lokalise-api/resources/team_user_group'
+require 'ruby-lokalise-api/resources/custom_translation_status'
 
 require 'ruby-lokalise-api/collections/base'
 require 'ruby-lokalise-api/collections/project'
@@ -50,6 +51,7 @@ require 'ruby-lokalise-api/collections/order'
 require 'ruby-lokalise-api/collections/payment_card'
 require 'ruby-lokalise-api/collections/translation_provider'
 require 'ruby-lokalise-api/collections/team_user_group'
+require 'ruby-lokalise-api/collections/custom_translation_status'
 
 require 'ruby-lokalise-api/client'
 

data/lib/ruby-lokalise-api/client.rb

@@ -14,6 +14,7 @@ require 'ruby-lokalise-api/rest/orders'
 require 'ruby-lokalise-api/rest/payment_cards'
 require 'ruby-lokalise-api/rest/translation_providers'
 require 'ruby-lokalise-api/rest/team_user_group'
+require 'ruby-lokalise-api/rest/custom_translation_statuses'
 
 module Lokalise
   class Client

data/lib/ruby-lokalise-api/collections/custom_translation_status.rb

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class CustomTranslationStatus < Base
+      DATA_KEY_PLURAL = 'CustomTranslationStatuses'.freeze
+
+      class << self
+        def endpoint(project_id, *_args)
+          path_from projects: [project_id, 'custom_translation_statuses']
+        end
+      end
+    end
+  end
+end

data/lib/ruby-lokalise-api/data/attributes.json

@@ -19,6 +19,11 @@
     "admin_rights",
     "created_at_timestamp"
   ],
+  "custom_translation_status": [
+    "status_id",
+    "title",
+    "color"
+  ],
   "file": [
     "filename",
     "key_count"
@@ -137,7 +142,8 @@
     "completed_at",
     "completed_at_timestamp",
     "completed_by",
-    "completed_by_email"
+    "completed_by_email",
+    "custom_translation_status_ids"
   ],
   "team": [
     "team_id",
@@ -177,7 +183,8 @@
     "translation",
     "is_fuzzy",
     "is_reviewed",
-    "words"
+    "words",
+    "custom_translation_statuses"
   ],
   "translation_provider": [
     "provider_id",

data/lib/ruby-lokalise-api/resources/custom_translation_status.rb

@@ -0,0 +1,19 @@
+module Lokalise
+  module Resources
+    class CustomTranslationStatus < Base
+      ID_KEY = 'status'.freeze
+      supports :update, :destroy
+
+      class << self
+        def colors(client, path, *_args)
+          get(path, client)['content']['colors']
+        end
+
+        def endpoint(project_id, status_id = nil)
+          path_from projects: project_id,
+                    custom_translation_statuses: status_id
+        end
+      end
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/custom_translation_statuses.rb

@@ -0,0 +1,63 @@
+module Lokalise
+  class Client
+    # Returns all translation statuses for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-custom-translation-statuses-get
+    # @return [Lokalise::Collection::CustomTranslationStatus<Lokalise::Resources::CustomTranslationStatus>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def translation_statuses(project_id, params = {})
+      c_r Lokalise::Collections::CustomTranslationStatus, :all, project_id, params
+    end
+
+    # Returns a single translation status for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-custom-translation-status-get
+    # @return [Lokalise::Resources::CustomTranslationStatus]
+    # @param project_id [String]
+    # @param status_id [String, Integer]
+    def translation_status(project_id, status_id)
+      c_r Lokalise::Resources::CustomTranslationStatus, :find, [project_id, status_id]
+    end
+
+    # Creates translation status inside the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-custom-translation-status-post
+    # @return Lokalise::Resources::CustomTranslationStatus
+    # @param project_id [String]
+    # @param params Hash
+    def create_translation_status(project_id, params)
+      c_r Lokalise::Resources::CustomTranslationStatus, :create, project_id, params
+    end
+
+    # Updates the given translation status inside the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-custom-translation-status-put
+    # @return [Lokalise::Resources::CustomTranslationStatus]
+    # @param project_id [String]
+    # @param status_id [String, Integer]
+    # @param params [Hash]
+    def update_translation_status(project_id, status_id, params)
+      c_r Lokalise::Resources::CustomTranslationStatus, :update, [project_id, status_id], params
+    end
+
+    # Deletes translation status inside the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-custom-translation-status-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param status_id [String, Integer]
+    def destroy_translation_status(project_id, status_id)
+      c_r Lokalise::Resources::CustomTranslationStatus, :destroy, [project_id, status_id]
+    end
+
+    # Returns an array of available colors that can be assigned to custom translation statuses
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-available-colors-for-custom-translation-statuses-get
+    # @return [Array]
+    # @param project_id [String]
+    def translation_status_colors(project_id)
+      c_r Lokalise::Resources::CustomTranslationStatus, :colors, [project_id, 'colors']
+    end
+  end
+end

data/lib/ruby-lokalise-api/utils/attribute_helpers.rb

@@ -7,11 +7,18 @@ module Lokalise
       # Most class names correspond to resource names (eg, `Project`, `Team`)
       # but some may differ (`ProjectComment` corresponds to `Comment` resource).
       # The resource name is in lowercase, with underscores as separators.
+      # Some resources also have different pluralization rules. For example,
+      # "CustomTranslationStatus" is "CustomTranslationStatuses" (-es postfix).
+      # To address that, we try to fetch `DATA_KEY_PLURAL` set for the individual class.
       #
       # @return [String]
       # @param model_class [String]
       # @param plural [Boolean] Should the returned value be pluralized?
       def data_key_for(model_class, plural = false, collection = false)
+        data_key_plural = get_key('DATA_KEY_PLURAL', model_class, true, true)
+
+        return data_key_plural if collection && data_key_plural
+
         data_key = get_key 'DATA_KEY', model_class, collection
 
         return data_key unless plural
@@ -43,14 +50,17 @@ module Lokalise
 
       private
 
-      def get_key(name, model_class, collection = false)
-        if collection && Module.const_defined?("Lokalise::Collections::#{model_class}::#{name}")
-          Module.const_get "Lokalise::Collections::#{model_class}::#{name}"
-        elsif Module.const_defined? "Lokalise::Resources::#{model_class}::#{name}"
-          Module.const_get "Lokalise::Resources::#{model_class}::#{name}"
-        else
-          model_class
-        end.snakecase
+      def get_key(name, model_class, collection = false, strict = false)
+        key = if collection && Module.const_defined?("Lokalise::Collections::#{model_class}::#{name}")
+                Module.const_get "Lokalise::Collections::#{model_class}::#{name}"
+              elsif Module.const_defined? "Lokalise::Resources::#{model_class}::#{name}"
+                Module.const_get "Lokalise::Resources::#{model_class}::#{name}"
+              else
+                strict ? nil : model_class
+              end
+
+        # Sometimes key is nil
+        key ? key.snakecase : key
       end
 
       # Unify some resources' names (eg, `ProjectComment` and `KeyComment` have the same attributes which are stored under `comment`)

data/lib/ruby-lokalise-api/version.rb

@@ -1,3 +1,3 @@
 module Lokalise
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

data/ruby-lokalise-api.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop',                   '~> 0.60'
   spec.add_development_dependency 'rubocop-performance',       '~> 1.0'
   spec.add_development_dependency 'simplecov',                 '~> 0.16'
-  spec.add_development_dependency 'vcr',                       '~> 4.0'
+  spec.add_development_dependency 'vcr',                       '~> 5.0'
 end

data/spec/lib/ruby-lokalise-api/rest/custom_translation_statuses_spec.rb

@@ -0,0 +1,117 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:status_id) { 128 }
+  let(:new_status_id) { 126 }
+
+  describe '#translation_statuses' do
+    it 'should return all statuses' do
+      statuses = VCR.use_cassette('all_translation_statuses') do
+        test_client.translation_statuses project_id
+      end.collection
+
+      expect(statuses.count).to eq(3)
+      expect(statuses.first.status_id).to eq(status_id)
+    end
+
+    it 'should support pagination' do
+      statuses = VCR.use_cassette('all_translation_statuses_pagination') do
+        test_client.translation_statuses project_id, limit: 1, page: 2
+      end
+
+      expect(statuses.collection.count).to eq(1)
+      expect(statuses.total_results).to eq(3)
+      expect(statuses.total_pages).to eq(3)
+      expect(statuses.results_per_page).to eq(1)
+      expect(statuses.current_page).to eq(2)
+
+      expect(statuses.next_page?).to eq(true)
+      expect(statuses.last_page?).to eq(false)
+      expect(statuses.prev_page?).to eq(true)
+      expect(statuses.first_page?).to eq(false)
+    end
+  end
+
+  specify '#translation_status' do
+    status = VCR.use_cassette('translation_status') do
+      test_client.translation_status project_id, status_id
+    end
+
+    expect(status.status_id).to eq(status_id)
+    expect(status.title).to eq('random')
+    expect(status.color).to eq('#0079bf')
+  end
+
+  specify '#create_translation_status' do
+    title = 'Reviewed by doctors'
+    color = '#f2d600'
+    status = VCR.use_cassette('create_translation_status') do
+      test_client.create_translation_status project_id,
+                                            title: title,
+                                            color: color
+    end
+
+    expect(status.title).to eq(title)
+    expect(status.color).to eq(color)
+  end
+
+  specify '#update_translation_status' do
+    title = 'Reviewed by rubyists'
+    color = '#c377e0'
+    status = VCR.use_cassette('update_translation_status') do
+      test_client.update_translation_status project_id, new_status_id,
+                                            title: title,
+                                            color: color
+    end
+
+    expect(status.title).to eq(title)
+    expect(status.color).to eq(color)
+  end
+
+  specify '#destroy_translation_status' do
+    response = VCR.use_cassette('destroy_translation_status') do
+      test_client.destroy_translation_status project_id, new_status_id
+    end
+
+    expect(response['project_id']).to eq(project_id)
+    expect(response['custom_translation_status_deleted']).to eq(true)
+  end
+
+  specify '#translation_status_colors' do
+    response = VCR.use_cassette('translation_status_colors') do
+      test_client.translation_status_colors project_id
+    end
+
+    expect(response).to be_an(Array)
+    expect(response).to include('#f2d600')
+  end
+
+  context 'translation status chained methods' do
+    it 'should support update and destroy' do
+      status = VCR.use_cassette('create_another_translation_status') do
+        test_client.create_translation_status project_id,
+                                              title: 'rspec',
+                                              color: '#c377e0'
+      end
+
+      expect(status.title).to eq('rspec')
+      expect(status.color).to eq('#c377e0')
+
+      status = VCR.use_cassette('update_another_translation_status') do
+        status.update(
+          title: 'updated rspec',
+          color: '#0079bf'
+        )
+      end
+
+      expect(status.title).to eq('updated rspec')
+      expect(status.color).to eq('#0079bf')
+
+      response = VCR.use_cassette('delete_another_translation_status') do
+        status.destroy
+      end
+
+      expect(response['project_id']).to eq(project_id)
+      expect(response['custom_translation_status_deleted']).to eq(true)
+    end
+  end
+end

data/spec/lib/ruby-lokalise-api/rest/tasks_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe Lokalise::Client do
     end
 
     expect(task.task_id).to eq(11_925)
-    expect(task.title).to eq('Demo review')
+    expect(task.title).to eq('node updated')
     expect(task.description).to eq('')
     expect(task.status).to eq('in progress')
     expect(task.progress).to eq(1)
@@ -55,6 +55,7 @@ RSpec.describe Lokalise::Client do
     expect(task.completed_at).to eq(nil)
     expect(task.completed_at_timestamp).to eq(nil)
     expect(task.do_lock_translations).to eq(false)
+    expect(task.custom_translation_status_ids).to eq([])
   end
 
   specify '#create_task' do

data/spec/lib/ruby-lokalise-api/rest/translations_spec.rb

@@ -71,6 +71,7 @@ RSpec.describe Lokalise::Client do
     expect(translation.is_fuzzy).to eq(false)
     expect(translation.is_reviewed).to eq(false)
     expect(translation.words).to eq(5)
+    expect(translation.custom_translation_statuses).to eq([])
   end
 
   specify '#update_translation' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-19 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 description: Opinionated Ruby client for the Lokalise platform API allowing to work
   with translations, projects, users and other resources as with Ruby objects.
 email:
@@ -161,7 +161,6 @@ extra_rdoc_files:
 files:
 - ".github/CODE_OF_CONDUCT.md"
 - ".github/CONTRIBUTING.md"
-- ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - CHANGELOG.md
 - Gemfile
@@ -172,6 +171,7 @@ files:
 - lib/ruby-lokalise-api/client.rb
 - lib/ruby-lokalise-api/collections/base.rb
 - lib/ruby-lokalise-api/collections/contributor.rb
+- lib/ruby-lokalise-api/collections/custom_translation_status.rb
 - lib/ruby-lokalise-api/collections/file.rb
 - lib/ruby-lokalise-api/collections/key.rb
 - lib/ruby-lokalise-api/collections/key_comment.rb
@@ -195,6 +195,7 @@ files:
 - lib/ruby-lokalise-api/request.rb
 - lib/ruby-lokalise-api/resources/base.rb
 - lib/ruby-lokalise-api/resources/contributor.rb
+- lib/ruby-lokalise-api/resources/custom_translation_status.rb
 - lib/ruby-lokalise-api/resources/file.rb
 - lib/ruby-lokalise-api/resources/key.rb
 - lib/ruby-lokalise-api/resources/key_comment.rb
@@ -214,6 +215,7 @@ files:
 - lib/ruby-lokalise-api/resources/translation_provider.rb
 - lib/ruby-lokalise-api/rest/comments.rb
 - lib/ruby-lokalise-api/rest/contributors.rb
+- lib/ruby-lokalise-api/rest/custom_translation_statuses.rb
 - lib/ruby-lokalise-api/rest/files.rb
 - lib/ruby-lokalise-api/rest/keys.rb
 - lib/ruby-lokalise-api/rest/languages.rb
@@ -236,6 +238,7 @@ files:
 - spec/lib/ruby-lokalise-api/error_spec.rb
 - spec/lib/ruby-lokalise-api/rest/comments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/contributors_spec.rb
+- spec/lib/ruby-lokalise-api/rest/custom_translation_statuses_spec.rb
 - spec/lib/ruby-lokalise-api/rest/files_spec.rb
 - spec/lib/ruby-lokalise-api/rest/keys_spec.rb
 - spec/lib/ruby-lokalise-api/rest/languages_spec.rb
@@ -274,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the Lokalise API
@@ -282,6 +285,7 @@ test_files:
 - spec/lib/ruby-lokalise-api/error_spec.rb
 - spec/lib/ruby-lokalise-api/rest/comments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/contributors_spec.rb
+- spec/lib/ruby-lokalise-api/rest/custom_translation_statuses_spec.rb
 - spec/lib/ruby-lokalise-api/rest/files_spec.rb
 - spec/lib/ruby-lokalise-api/rest/keys_spec.rb
 - spec/lib/ruby-lokalise-api/rest/languages_spec.rb

data/.github/ISSUE_TEMPLATE.md

@@ -1,13 +0,0 @@
-### Steps to reproduce
-
-### Expected behavior
-
-Tell us what should happen
-
-### Actual behavior
-
-Tell us what happens instead
-
-### System configuration
-
-**Ruby version**: