ruby-lokalise-api 1.0.1

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

@@ -0,0 +1,22 @@
+RSpec.describe Lokalise::Client do
+  specify '#teams' do
+    teams = VCR.use_cassette('teams') do
+      test_client.teams page: 1, limit: 1
+    end
+
+    team = teams.collection.first
+
+    expect(teams.collection.length).to eq(1)
+    expect(teams.total_results).to eq(1)
+    expect(teams.total_pages).to eq(1)
+    expect(teams.results_per_page).to eq(1)
+    expect(teams.current_page).to eq(1)
+
+    expect(team.team_id).to eq(176_692)
+    expect(team.name).to eq('Ilya\'s Team')
+    expect(team.created_at).to eq('2018-08-21 17:35:25 (Etc/UTC)')
+    expect(team.plan).to eq('Trial')
+    expect(team.quota_usage['users']).to eq(4)
+    expect(team.quota_allowed['keys']).to eq(999_999_999)
+  end
+end

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

@@ -0,0 +1,54 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:translation_id) { 80_015_147 }
+
+  describe '#translations' do
+    it 'should return all translations' do
+      translations = VCR.use_cassette('translations') do
+        test_client.translations project_id
+      end.collection
+
+      expect(translations.count).to eq(9)
+    end
+
+    it 'should support pagination' do
+      translations = VCR.use_cassette('all_translations_pagination') do
+        test_client.translations project_id, limit: 4, page: 2
+      end
+
+      expect(translations.collection.count).to eq(4)
+      expect(translations.total_results).to eq(9)
+      expect(translations.total_pages).to eq(3)
+      expect(translations.results_per_page).to eq(4)
+      expect(translations.current_page).to eq(2)
+    end
+  end
+
+  specify '#translation' do
+    translation = VCR.use_cassette('translation') do
+      test_client.translation project_id, translation_id
+    end
+
+    expect(translation.translation_id).to eq(translation_id)
+    expect(translation.key_id).to eq(15_571_975)
+    expect(translation.language_iso).to eq('en')
+    expect(translation.modified_at).to eq('2018-12-10 19:04:08 (Etc/UTC)')
+    expect(translation.modified_by).to eq(20_181)
+    expect(translation.modified_by_email).to eq('bodrovis@protonmail.com')
+    expect(translation.translation).to eq('rspec trans')
+    expect(translation.is_fuzzy).to eq(false)
+    expect(translation.is_reviewed).to eq(true)
+    expect(translation.words).to eq(2)
+  end
+
+  specify '#update_translation' do
+    translation = VCR.use_cassette('update_translation') do
+      test_client.update_translation project_id, translation_id, translation: 'rspec trans',
+                                                                 is_reviewed: true
+    end
+
+    expect(translation.translation_id).to eq(translation_id)
+    expect(translation.translation).to eq('rspec trans')
+    expect(translation.is_reviewed).to eq(true)
+  end
+end

data/spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe String do
+  let(:snake_result) { 'snake_case' }
+  let(:bc_result) { 'Klass' }
+
+  specify '#snakecase' do
+    expect('SnakeCase'.snakecase).to eq snake_result
+    expect('Snake-Case'.snakecase).to eq snake_result
+    expect('Snake Case'.snakecase).to eq snake_result
+    expect('Snake  -  Case'.snakecase).to eq snake_result
+  end
+
+  specify '#base_class_name' do
+    expect('Namespace::Nested::Klass'.base_class_name).to eq bc_result
+    expect('Nested::Klass'.base_class_name).to eq bc_result
+    expect('Klass'.base_class_name).to eq bc_result
+  end
+end

data/spec/lib/ruby-lokalise-api_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe Lokalise do
+  specify '.client' do
+    expect(test_client).to be_an_instance_of(Lokalise::Client)
+    expect(test_client.token).to eq(ENV['LOKALISE_API_TOKEN'])
+  end
+
+  specify '.reset_client!' do
+    expect(test_client).to be_an_instance_of(Lokalise::Client)
+    Lokalise.reset_client!
+    current_client = Lokalise.instance_variable_get '@client'
+    expect(current_client).to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'dotenv/load'
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/'
+  add_filter '.github/'
+end
+
+require 'ruby-lokalise-api'
+
+# Support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include TestClient
+end

data/spec/support/test_client.rb

@@ -0,0 +1,5 @@
+module TestClient
+  def test_client(token = nil)
+    Lokalise.client(token || ENV['LOKALISE_API_TOKEN'])
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.ignore_hosts 'codeclimate.com'
+  c.hook_into :faraday
+  c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'vcr_cassettes')
+  c.filter_sensitive_data('<LOKALISE_TOKEN>') { ENV.fetch('LOKALISE_API_TOKEN') }
+end

metadata

@@ -0,0 +1,255 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lokalise-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Ilya Bodrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ruby-lokalise-api.rb
+- 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/file.rb
+- lib/ruby-lokalise-api/collections/key.rb
+- lib/ruby-lokalise-api/collections/key_comment.rb
+- lib/ruby-lokalise-api/collections/project.rb
+- lib/ruby-lokalise-api/collections/project_comment.rb
+- lib/ruby-lokalise-api/collections/project_language.rb
+- lib/ruby-lokalise-api/collections/screenshot.rb
+- lib/ruby-lokalise-api/collections/snapshot.rb
+- lib/ruby-lokalise-api/collections/system_language.rb
+- lib/ruby-lokalise-api/collections/task.rb
+- lib/ruby-lokalise-api/collections/team.rb
+- lib/ruby-lokalise-api/collections/team_user.rb
+- lib/ruby-lokalise-api/collections/translation.rb
+- lib/ruby-lokalise-api/connection.rb
+- lib/ruby-lokalise-api/data/attributes.json
+- lib/ruby-lokalise-api/error.rb
+- 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/file.rb
+- lib/ruby-lokalise-api/resources/key.rb
+- lib/ruby-lokalise-api/resources/key_comment.rb
+- lib/ruby-lokalise-api/resources/project.rb
+- lib/ruby-lokalise-api/resources/project_comment.rb
+- lib/ruby-lokalise-api/resources/project_language.rb
+- lib/ruby-lokalise-api/resources/screenshot.rb
+- lib/ruby-lokalise-api/resources/snapshot.rb
+- lib/ruby-lokalise-api/resources/system_language.rb
+- lib/ruby-lokalise-api/resources/task.rb
+- lib/ruby-lokalise-api/resources/team.rb
+- lib/ruby-lokalise-api/resources/team_user.rb
+- lib/ruby-lokalise-api/resources/translation.rb
+- lib/ruby-lokalise-api/rest/comments.rb
+- lib/ruby-lokalise-api/rest/contributors.rb
+- lib/ruby-lokalise-api/rest/files.rb
+- lib/ruby-lokalise-api/rest/keys.rb
+- lib/ruby-lokalise-api/rest/languages.rb
+- lib/ruby-lokalise-api/rest/projects.rb
+- lib/ruby-lokalise-api/rest/screenshots.rb
+- lib/ruby-lokalise-api/rest/snapshots.rb
+- lib/ruby-lokalise-api/rest/tasks.rb
+- lib/ruby-lokalise-api/rest/team_users.rb
+- lib/ruby-lokalise-api/rest/teams.rb
+- lib/ruby-lokalise-api/rest/translations.rb
+- lib/ruby-lokalise-api/utils/attribute_helpers.rb
+- lib/ruby-lokalise-api/utils/string_utils.rb
+- lib/ruby-lokalise-api/version.rb
+- ruby-lokalise-api.gemspec
+- 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/files_spec.rb
+- spec/lib/ruby-lokalise-api/rest/keys_spec.rb
+- spec/lib/ruby-lokalise-api/rest/languages_spec.rb
+- spec/lib/ruby-lokalise-api/rest/projects_spec.rb
+- spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/tasks_spec.rb
+- spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
+- spec/lib/ruby-lokalise-api/rest/teams_spec.rb
+- spec/lib/ruby-lokalise-api/rest/translations_spec.rb
+- spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
+- spec/lib/ruby-lokalise-api_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_client.rb
+- spec/support/vcr.rb
+homepage: https://github.com/lokalise/ruby-lokalise-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Ruby interface to the Lokalise API
+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/files_spec.rb
+- spec/lib/ruby-lokalise-api/rest/keys_spec.rb
+- spec/lib/ruby-lokalise-api/rest/languages_spec.rb
+- spec/lib/ruby-lokalise-api/rest/projects_spec.rb
+- spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/tasks_spec.rb
+- spec/lib/ruby-lokalise-api/rest/teams_spec.rb
+- spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
+- spec/lib/ruby-lokalise-api/rest/translations_spec.rb
+- spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
+- spec/lib/ruby-lokalise-api_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_client.rb
+- spec/support/vcr.rb