ruby-lokalise-api 1.0.1

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

@@ -0,0 +1,12 @@
+module Lokalise
+  class Client
+    # Returns all teams available to the user
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-teams-get
+    # @return [Lokalise::Collection::Team<Lokalise::Resources::Team>]
+    # @param params [Hash]
+    def teams(params = {})
+      Lokalise::Collections::Team.all self, params
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Lokalise
+  class Client
+    # Returns all translations for the given project (ungrouped)
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-translations-get
+    # @return [Lokalise::Collection::Translation<Lokalise::Resources::Translation>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def translations(project_id, params = {})
+      Lokalise::Collections::Translation.all self, params, project_id
+    end
+
+    # Returns translation of the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-translation-get
+    # @return [Lokalise::Resources::Translation]
+    # @param project_id [String]
+    # @param translation_id [String, Integer]
+    # @param params [Hash]
+    def translation(project_id, translation_id, params = {})
+      Lokalise::Resources::Translation.find self, project_id, translation_id, params
+    end
+
+    # Updates translation of the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-translation-put
+    # @return [Lokalise::Resources::Translation]
+    # @param project_id [String]
+    # @param translation_id [String, Integer]
+    # @param params [Hash]
+    def update_translation(project_id, translation_id, params)
+      Lokalise::Resources::Translation.update self, project_id, translation_id, params
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Lokalise
+  module Utils
+    module AttributeHelpers
+      UNIFIED_RESOURCES = %w[comment language].freeze
+
+      # Returns the name of the API resource for the given class.
+      # 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.
+      #
+      # @return [String]
+      # @param model_class [String]
+      # @param plural [Boolean] Should the returned value be pluralized?
+      def data_key_for(model_class, plural = false)
+        data_key = if Module.const_defined? "Lokalise::Resources::#{model_class}::DATA_KEY"
+                     Module.const_get "Lokalise::Resources::#{model_class}::DATA_KEY"
+                   else
+                     model_class
+                   end.snakecase
+
+        return data_key unless plural
+
+        data_key + 's'
+      end
+
+      # Loads attributes for the given resource based on its name
+      #
+      # @return [Array<String>]
+      def attributes_for(klass)
+        @attributes ||= begin
+          YAML.load_file(File.expand_path('../data/attributes.json', __dir__)).freeze
+        end
+
+        name = unify klass.name.snakecase
+        @attributes[name]
+      end
+
+      private
+
+      # Unify some resources' names (eg, `ProjectComment` and `KeyComment` have the same attributes which are stored under `comment`)
+      #
+      # @return [String]
+      def unify(name)
+        UNIFIED_RESOURCES.each do |u_a|
+          return u_a if name.match?(/#{u_a}/)
+        end
+
+        name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# Initial code taken from Facets gem by Rubyworks
+# https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
+
+class String
+  # Underscore a string such that camelcase, dashes and spaces are
+  # replaced by underscores.
+  def snakecase
+    base_class_name.
+      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z\d])([A-Z])/, '\1_\2').
+      tr('-', '_').
+      gsub(/\s/, '_').
+      gsub(/__+/, '_').
+      downcase
+  end
+
+  # Turn `Module::Nested::ClassName` to just `ClassName`
+  def base_class_name
+    split('::').last
+  end
+end

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

@@ -0,0 +1,3 @@
+module Lokalise
+  VERSION = '1.0.1'.freeze
+end

data/ruby-lokalise-api.gemspec

@@ -0,0 +1,32 @@
+require File.expand_path('lib/ruby-lokalise-api/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'ruby-lokalise-api'
+  spec.version               = Lokalise::VERSION
+  spec.authors               = ['Ilya Bodrov']
+  spec.email                 = ['golosizpru@gmail.com']
+  spec.summary               = 'Ruby interface to the Lokalise API'
+  spec.description           = 'Opinionated Ruby client for the Lokalise platform API allowing to work with translations, projects, users and other resources as with Ruby objects.'
+  spec.homepage              = 'https://github.com/lokalise/ruby-lokalise-api'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.files = Dir['README.md', 'LICENSE',
+                   'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby-lokalise-api/data/attributes.json',
+                   'ruby-lokalise-api.gemspec', '.github/*.md',
+                   'Gemfile', 'Rakefile']
+  spec.test_files       = Dir['spec/**/*.rb']
+  spec.extra_rdoc_files = ['README.md']
+  spec.require_paths    = ['lib']
+
+  spec.add_dependency 'faraday',                       '~> 0.13'
+  spec.add_dependency 'multi_json',                    '~> 1.12'
+
+  spec.add_development_dependency 'dotenv',                    '~> 2.5'
+  spec.add_development_dependency 'rake',                      '~> 12.1'
+  spec.add_development_dependency 'rspec',                     '~> 3.6'
+  spec.add_development_dependency 'rubocop',                   '~> 0.60'
+  spec.add_development_dependency 'simplecov',                 '~> 0.16'
+  spec.add_development_dependency 'vcr',                       '~> 4.0'
+end

data/spec/lib/ruby-lokalise-api/error_spec.rb

@@ -0,0 +1,23 @@
+# TODO: rewrite with raw `get` method
+RSpec.describe Lokalise::Error do
+  include Lokalise::Request
+
+  before(:each) { Lokalise.reset_client! }
+  after(:each) { Lokalise.reset_client! }
+
+  it 'should raise BadRequest when API token is invalid' do
+    expect do
+      VCR.use_cassette('error_invalid_token') do
+        get 'projects', Lokalise.client('invalid')
+      end
+    end.to raise_error(Lokalise::Error::BadRequest)
+  end
+
+  it 'should raise NotFound when the provided path cannot be found' do
+    expect do
+      VCR.use_cassette('error_not_found') do
+        get 'invalid_path', test_client
+      end
+    end.to raise_error(Lokalise::Error::NotFound)
+  end
+end

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

@@ -0,0 +1,78 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:key_id) { 15_305_182 }
+
+  describe '#comments' do
+    it 'should return all comments' do
+      comments = VCR.use_cassette('all_comments') do
+        test_client.comments project_id, key_id
+      end.collection
+
+      expect(comments.count).to eq(3)
+    end
+
+    it 'should support pagination' do
+      comments = VCR.use_cassette('all_comments_pagination') do
+        test_client.comments project_id, key_id, limit: 1, page: 2
+      end
+
+      expect(comments.collection.count).to eq(1)
+      expect(comments.total_results).to eq(3)
+      expect(comments.total_pages).to eq(3)
+      expect(comments.results_per_page).to eq(1)
+      expect(comments.current_page).to eq(2)
+      expect(comments.collection.first.comment).to eq('demo comment')
+    end
+  end
+
+  specify '#comment' do
+    comment = VCR.use_cassette('comment') do
+      test_client.comment project_id, '15519786', '800746'
+    end
+
+    expect(comment.comment).to eq('rspec comment')
+    expect(comment.comment_id).to eq(800_746)
+    expect(comment.key_id).to eq(15_519_786)
+    expect(comment.added_by).to eq(20_181)
+    expect(comment.added_by_email).to eq('bodrovis@protonmail.com')
+    expect(comment.added_at).to eq('2018-12-09 19:41:44 (Etc/UTC)')
+  end
+
+  specify '#create_comments' do
+    comments = VCR.use_cassette('create_comments') do
+      test_client.create_comments project_id, key_id, [
+        {comment: 'demo comment'},
+        {comment: 'from rspec'}
+      ]
+    end
+
+    first_comment = comments.collection.first
+    second_comment = comments.collection[1]
+
+    expect(comments.project_id).to eq(project_id)
+    expect(first_comment.comment).to eq('demo comment')
+    expect(first_comment.key_id).to eq(key_id)
+    expect(second_comment.comment).to eq('from rspec')
+    expect(second_comment.key_id).to eq(key_id)
+  end
+
+  specify '#project_comments' do
+    comments = VCR.use_cassette('project_comments') do
+      test_client.project_comments project_id
+    end
+
+    comment = comments.collection.first
+
+    expect(comments.total_results).to eq(3)
+    expect(comment.comment).to eq('test')
+    expect(comment.comment_id).to eq(767_938)
+  end
+
+  specify '#delete_comment' do
+    response = VCR.use_cassette('delete_comment') do
+      test_client.delete_comment project_id, key_id, 767_938
+    end
+    expect(response['project_id']).to eq(project_id)
+    expect(response['comment_deleted']).to eq(true)
+  end
+end

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

@@ -0,0 +1,79 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:contributor_id) { 25_953 }
+
+  describe '#contributors' do
+    it 'should return all contributors' do
+      contributors = VCR.use_cassette('all_contributors') do
+        test_client.contributors project_id
+      end.collection
+
+      expect(contributors.count).to eq(2)
+      expect(contributors.first.fullname).to eq('John Doe')
+    end
+
+    it 'should support pagination' do
+      contributors = VCR.use_cassette('all_contributors_pagination') do
+        test_client.contributors project_id, limit: 1, page: 2
+      end
+
+      expect(contributors.collection.count).to eq(1)
+      expect(contributors.total_results).to eq(2)
+      expect(contributors.total_pages).to eq(2)
+      expect(contributors.results_per_page).to eq(1)
+      expect(contributors.current_page).to eq(2)
+    end
+  end
+
+  specify '#contributor' do
+    contributor = VCR.use_cassette('contributor') do
+      test_client.contributor project_id, '20181'
+    end
+
+    expect(contributor.user_id).to eq(20_181)
+    expect(contributor.email).to eq('bodrovis@protonmail.com')
+    expect(contributor.fullname).to eq('Ilya')
+    expect(contributor.created_at).to eq('2018-08-21 17:35:25 (Etc/UTC)')
+    expect(contributor.is_admin).to eq(true)
+    expect(contributor.is_reviewer).to eq(true)
+    expect(contributor.languages.first['lang_id']).to eq(640)
+    expect(contributor.admin_rights.first).to eq('upload')
+  end
+
+  specify '#create_contributors' do
+    contributor = VCR.use_cassette('create_contributors') do
+      test_client.create_contributors project_id,
+                                      email: 'rspec@test.com',
+                                      fullname: 'Rspec test',
+                                      languages: [{
+                                        lang_iso: 'en'
+                                      },
+                                                  {
+                                                    lang_iso: 'ru'
+                                                  }]
+    end.collection.first
+
+    expect(contributor.fullname).to eq('Rspec test')
+    expect(contributor.email).to eq('rspec@test.com')
+    expect(contributor.languages[1]['lang_iso']).to eq('ru')
+  end
+
+  specify '#update_contributor' do
+    contributor = VCR.use_cassette('update_contributor') do
+      test_client.update_contributor project_id, contributor_id,
+                                     languages: [{lang_iso: 'en'}]
+    end
+
+    expect(contributor.user_id).to eq(contributor_id)
+    expect(contributor.languages[0]['lang_iso']).to eq('en')
+    expect(contributor.languages.length).to eq(1)
+  end
+
+  specify '#delete_contributor' do
+    response = VCR.use_cassette('delete_contributor') do
+      test_client.delete_contributor project_id, contributor_id
+    end
+    expect(response['project_id']).to eq(project_id)
+    expect(response['contributor_deleted']).to eq(true)
+  end
+end

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

@@ -0,0 +1,53 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+
+  describe '#files' do
+    it 'should return all files' do
+      files = VCR.use_cassette('files') do
+        test_client.files project_id
+      end.collection
+
+      file = files.first
+
+      expect(files.count).to eq(1)
+      expect(file.filename).to eq('__unassigned__')
+      expect(file.key_count).to eq(1)
+    end
+
+    it 'should support pagination' do
+      files = VCR.use_cassette('all_files_pagination') do
+        test_client.files project_id, limit: 1, page: 1
+      end
+
+      expect(files.collection.count).to eq(1)
+      expect(files.total_results).to eq(1)
+      expect(files.total_pages).to eq(1)
+      expect(files.results_per_page).to eq(1)
+      expect(files.current_page).to eq(1)
+    end
+  end
+
+  specify '#download_files' do
+    response = VCR.use_cassette('download_files') do
+      test_client.download_files project_id,
+                                 "format": 'po',
+                                 "original_filenames": true
+    end
+
+    expect(response['project_id']).to eq(project_id)
+    expect(response['bundle_url']).to include('amazonaws.com')
+  end
+
+  specify '#upload_file' do
+    response = VCR.use_cassette('upload_file') do
+      test_client.upload_file project_id,
+                              "data": 'ZnI6DQogIHRlc3Q6IHRyYW5zbGF0aW9u',
+                              "filename": 'rspec.yml',
+                              'lang_iso': 'ru'
+    end
+
+    expect(response['project_id']).to eq(project_id)
+    expect(response['file']).to eq('rspec.yml')
+    expect(response['result']['skipped']).to eq(1)
+  end
+end

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

@@ -0,0 +1,119 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:key_id) { 15_305_182 }
+  let(:new_key_id) { 15_519_770 }
+
+  describe '#keys' do
+    it 'should return all keys' do
+      keys = VCR.use_cassette('all_keys') do
+        test_client.keys project_id
+      end.collection
+
+      expect(keys.count).to eq(1)
+    end
+
+    it 'should support pagination' do
+      keys = VCR.use_cassette('all_keys_pagination') do
+        test_client.keys project_id, limit: 1, page: 1
+      end
+
+      expect(keys.collection.count).to eq(1)
+      expect(keys.total_results).to eq(1)
+      expect(keys.total_pages).to eq(1)
+      expect(keys.results_per_page).to eq(1)
+      expect(keys.current_page).to eq(1)
+    end
+  end
+
+  specify '#key' do
+    key = VCR.use_cassette('key') do
+      test_client.key project_id, key_id, disable_references: 0
+    end
+
+    expect(key.key_id).to eq(key_id)
+    expect(key.created_at).to eq('2018-12-03 19:11:30 (Etc/UTC)')
+    expect(key.key_name['ios']).to eq('test')
+    expect(key.filenames['web']).to eq('rspec.yml')
+    expect(key.description).to eq('')
+    expect(key.platforms).to eq(%w[web])
+    expect(key.tags).to eq([])
+    expect(key.comments.first['comment']).to eq('demo comment')
+    expect(key.comments[1]['comment_id']).to eq(800_632)
+    expect(key.screenshots).to eq([])
+    expect(key.translations.first['modified_by_email']).to eq('bodrovis@protonmail.com')
+    expect(key.is_plural).to eq(false)
+    expect(key.plural_name).to eq('')
+    expect(key.is_hidden).to eq(false)
+    expect(key.is_archived).to eq(false)
+    expect(key.context).to eq('')
+    expect(key.char_limit).to eq(0)
+    expect(key.custom_attributes).to eq('')
+    expect(key.base_words).to eq(1)
+  end
+
+  specify '#create_keys' do
+    keys = VCR.use_cassette('create_keys') do
+      test_client.create_keys project_id, key_name: 'rspec_k', platforms: %w[ios]
+    end
+
+    key = keys.collection.first
+
+    expect(keys.project_id).to eq(project_id)
+    expect(key.key_name['ios']).to eq('rspec_k')
+    expect(key.platforms).to eq(%w[ios])
+  end
+
+  specify '#update_key' do
+    key = VCR.use_cassette('update_key') do
+      test_client.update_key project_id, new_key_id, key_name: 'updated_rspec_k', description: 'desc here'
+    end
+
+    expect(key.key_name['ios']).to eq('updated_rspec_k')
+    expect(key.platforms).to eq(%w[ios])
+    expect(key.description).to eq('desc here')
+  end
+
+  specify '#update_keys' do
+    keys = VCR.use_cassette('update_keys') do
+      test_client.update_keys project_id, [
+        {
+          key_id: new_key_id,
+          description: 'bulk updated'
+        },
+        {
+          key_id: key_id,
+          tags: %w[bulk upd]
+        }
+      ]
+    end.collection
+
+    first_key = keys.first
+    second_key = keys[1]
+
+    expect(first_key.key_id).to eq(key_id)
+    expect(first_key.key_name['ios']).to eq('test')
+    expect(first_key.tags).to eq(%w[bulk upd])
+
+    expect(second_key.key_id).to eq(new_key_id)
+    expect(second_key.key_name['web']).to eq('updated_rspec_k')
+    expect(second_key.description).to eq('bulk updated')
+  end
+
+  specify '#delete_key' do
+    response = VCR.use_cassette('delete_key') do
+      test_client.delete_key project_id, '15519771'
+    end
+
+    expect(response['project_id']).to eq(project_id)
+    expect(response['key_removed']).to eq(true)
+  end
+
+  specify '#delete_keys' do
+    response = VCR.use_cassette('delete_keys') do
+      test_client.delete_keys project_id, [new_key_id, key_id]
+    end
+
+    expect(response['project_id']).to eq(project_id)
+    expect(response['keys_removed']).to eq(true)
+  end
+end