ruby-lokalise-api 1.1.0 → 2.0.0

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def screenshots(project_id, params = {})
-      Lokalise::Collections::Screenshot.all self, params, project_id
+      c_r Lokalise::Collections::Screenshot, :all, project_id, params
     end
 
     # Returns a single screenshot for the given project
@@ -17,7 +17,7 @@ module Lokalise
     # @param project_id [String]
     # @param screenshot_id [String, Integer]
     def screenshot(project_id, screenshot_id)
-      Lokalise::Resources::Screenshot.find self, project_id, screenshot_id
+      c_r Lokalise::Resources::Screenshot, :find, [project_id, screenshot_id]
     end
 
     # Creates one or more screenshots for the given project
@@ -27,7 +27,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def create_screenshots(project_id, params = {})
-      Lokalise::Resources::Screenshot.create self, project_id, params, :screenshots
+      c_r Lokalise::Resources::Screenshot, :create, project_id, params, :screenshots
     end
 
     # Updates screenshot
@@ -38,7 +38,7 @@ module Lokalise
     # @param screenshot_id [String, Integer]
     # @param params [Hash]
     def update_screenshot(project_id, screenshot_id, params = {})
-      Lokalise::Resources::Screenshot.update self, project_id, screenshot_id, params
+      c_r Lokalise::Resources::Screenshot, :update, [project_id, screenshot_id], params
     end
 
     # Deletes screenshot
@@ -47,8 +47,8 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String]
     # @param screenshot_id [String, Integer]
-    def delete_screenshot(project_id, screenshot_id)
-      Lokalise::Resources::Screenshot.destroy self, project_id, screenshot_id
+    def destroy_screenshot(project_id, screenshot_id)
+      c_r Lokalise::Resources::Screenshot, :destroy, [project_id, screenshot_id]
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def snapshots(project_id, params = {})
-      Lokalise::Collections::Snapshot.all self, params, project_id
+      c_r Lokalise::Collections::Snapshot, :all, project_id, params
     end
 
     # Creates snapshot for the given project
@@ -17,7 +17,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def create_snapshot(project_id, params = {})
-      Lokalise::Resources::Snapshot.create self, project_id, params
+      c_r Lokalise::Resources::Snapshot, :create, project_id, params
     end
 
     # Restore project from the given snapshot by producing project's copy
@@ -27,7 +27,7 @@ module Lokalise
     # @param project_id [String]
     # @param snapshot_id [String, Integer]
     def restore_snapshot(project_id, snapshot_id)
-      Lokalise::Resources::Snapshot.restore self, project_id, snapshot_id
+      c_r Lokalise::Resources::Snapshot, :restore, [project_id, snapshot_id]
     end
 
     # Deletes snapshot
@@ -36,8 +36,8 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String]
     # @param snapshot_id [String, Integer]
-    def delete_snapshot(project_id, snapshot_id)
-      Lokalise::Resources::Snapshot.destroy self, project_id, snapshot_id
+    def destroy_snapshot(project_id, snapshot_id)
+      c_r Lokalise::Resources::Snapshot, :destroy, [project_id, snapshot_id]
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def tasks(project_id, params = {})
-      Lokalise::Collections::Task.all self, params, project_id
+      c_r Lokalise::Collections::Task, :all, project_id, params
     end
 
     # Returns a single task for the given project
@@ -17,7 +17,7 @@ module Lokalise
     # @param project_id [String]
     # @param task_id [String, Integer]
     def task(project_id, task_id)
-      Lokalise::Resources::Task.find self, project_id, task_id
+      c_r Lokalise::Resources::Task, :find, [project_id, task_id]
     end
 
     # Creates task for the given project
@@ -27,7 +27,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def create_task(project_id, params)
-      Lokalise::Resources::Task.create self, project_id, params
+      c_r Lokalise::Resources::Task, :create, project_id, params
     end
 
     # Updates task for the given project
@@ -38,7 +38,7 @@ module Lokalise
     # @param task_id [String, Integer]
     # @param params [Hash]
     def update_task(project_id, task_id, params = {})
-      Lokalise::Resources::Task.update self, project_id, task_id, params
+      c_r Lokalise::Resources::Task, :update, [project_id, task_id], params
     end
 
     # Deletes task for the given project
@@ -47,8 +47,8 @@ module Lokalise
     # @return [Hash]
     # @param project_id [String]
     # @param task_id [String, Integer]
-    def delete_task(project_id, task_id)
-      Lokalise::Resources::Task.destroy self, project_id, task_id
+    def destroy_task(project_id, task_id)
+      c_r Lokalise::Resources::Task, :destroy, [project_id, task_id]
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param team_id [String]
     # @param params [Hash]
     def team_users(team_id, params = {})
-      Lokalise::Collections::TeamUser.all self, params, team_id
+      c_r Lokalise::Collections::TeamUser, :all, team_id, params
     end
 
     # Returns team user from the given team
@@ -17,7 +17,7 @@ module Lokalise
     # @param team_id [String]
     # @param user_id [String, Integer]
     def team_user(team_id, user_id)
-      Lokalise::Resources::TeamUser.find self, team_id, user_id
+      c_r Lokalise::Resources::TeamUser, :find, [team_id, user_id]
     end
 
     # Updates team user for the given team
@@ -28,7 +28,7 @@ module Lokalise
     # @param user_id [String, Integer]
     # @param params [Hash]
     def update_team_user(team_id, user_id, params)
-      Lokalise::Resources::TeamUser.update self, team_id, user_id, params
+      c_r Lokalise::Resources::TeamUser, :update, [team_id, user_id], params
     end
 
     # Deletes team user from the given team
@@ -37,8 +37,8 @@ module Lokalise
     # @return [Lokalise::Resources::TeamUser]
     # @param team_id [String]
     # @param user_id [String, Integer]
-    def delete_team_user(team_id, user_id)
-      Lokalise::Resources::TeamUser.destroy self, team_id, user_id
+    def destroy_team_user(team_id, user_id)
+      c_r Lokalise::Resources::TeamUser, :destroy, [team_id, user_id]
     end
   end
 end

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

@@ -6,7 +6,7 @@ module Lokalise
     # @return [Lokalise::Collection::Team<Lokalise::Resources::Team>]
     # @param params [Hash]
     def teams(params = {})
-      Lokalise::Collections::Team.all self, params
+      c_r Lokalise::Collections::Team, :all, nil, params
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Lokalise
     # @param project_id [String]
     # @param params [Hash]
     def translations(project_id, params = {})
-      Lokalise::Collections::Translation.all self, params, project_id
+      c_r Lokalise::Collections::Translation, :all, project_id, params
     end
 
     # Returns translation of the given project
@@ -18,7 +18,7 @@ module Lokalise
     # @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
+      c_r Lokalise::Resources::Translation, :find, [project_id, translation_id], params
     end
 
     # Updates translation of the given project
@@ -29,7 +29,7 @@ module Lokalise
     # @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
+      c_r Lokalise::Resources::Translation, :update, [project_id, translation_id], params
     end
   end
 end

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

@@ -12,17 +12,23 @@ module Lokalise
       # @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
+        data_key = get_key 'DATA_KEY', model_class
 
         return data_key unless plural
 
         data_key + 's'
       end
 
+      # Returns key used to determine resource id (for example `user_id` or `project_id`).
+      # Most ids corresponds to resources' class names, but some may differ (for instance,
+      # `Contributor` has  `user_id` attribute).
+      #
+      # @return [String]
+      # @param model_class [String]
+      def id_key_for(model_class)
+        get_key('ID_KEY', model_class) + '_id'
+      end
+
       # Loads attributes for the given resource based on its name
       #
       # @return [Array<String>]
@@ -37,6 +43,14 @@ module Lokalise
 
       private
 
+      def get_key(name, model_class)
+        if Module.const_defined? "Lokalise::Resources::#{model_class}::#{name}"
+          Module.const_get "Lokalise::Resources::#{model_class}::#{name}"
+        else
+          model_class
+        end.snakecase
+      end
+
       # Unify some resources' names (eg, `ProjectComment` and `KeyComment` have the same attributes which are stored under `comment`)
       #
       # @return [String]

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

@@ -0,0 +1,12 @@
+module Lokalise
+  module Utils
+    module EndpointHelpers
+      def path_from(raw_mapping)
+        template = Addressable::Template.new '{/segments*}'
+        template.expand(
+          segments: raw_mapping.to_a.flatten
+        ).to_s
+      end
+    end
+  end
+end

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

@@ -18,4 +18,8 @@ class String
   def base_class_name
     split('::').last
   end
+
+  def remove_trailing_slash
+    gsub %r{/\z}, ''
+  end
 end

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

@@ -1,3 +1,3 @@
 module Lokalise
-  VERSION = '1.1.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/ruby-lokalise-api.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
+  spec.add_dependency 'addressable',                   '~> 2.5'
   spec.add_dependency 'faraday',                       '~> 0.13'
   spec.add_dependency 'multi_json',                    '~> 1.12'
 

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

@@ -1,6 +1,7 @@
 RSpec.describe Lokalise::Client do
   let(:project_id) { '803826145ba90b42d5d860.46800099' }
   let(:key_id) { 15_305_182 }
+  let(:another_key_id) { 15_519_786 }
 
   describe '#comments' do
     it 'should return all comments' do
@@ -28,19 +29,18 @@ RSpec.describe Lokalise::Client do
       expect(comments.prev_page?).to eq(true)
       expect(comments.first_page?).to eq(false)
 
-      expect(comments.ids).to include(project_id, key_id)
       expect(comments.client).to be_an_instance_of(Lokalise::Client)
     end
   end
 
   specify '#comment' do
     comment = VCR.use_cassette('comment') do
-      test_client.comment project_id, '15519786', '800746'
+      test_client.comment project_id, another_key_id, '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.key_id).to eq(another_key_id)
     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)')
@@ -76,11 +76,28 @@ RSpec.describe Lokalise::Client do
     expect(comment.comment_id).to eq(767_938)
   end
 
-  specify '#delete_comment' do
+  specify '#destroy_comment' do
     response = VCR.use_cassette('delete_comment') do
-      test_client.delete_comment project_id, key_id, 767_938
+      test_client.destroy_comment project_id, key_id, 767_938
     end
     expect(response['project_id']).to eq(project_id)
     expect(response['comment_deleted']).to eq(true)
   end
+
+  context 'comment chained methods' do
+    it 'should support destroy' do
+      comment = VCR.use_cassette('create_another_comment') do
+        test_client.create_comments project_id, another_key_id, comment: 'chained comment'
+      end.collection.first
+
+      expect(comment.comment).to eq('chained comment')
+
+      delete_response = VCR.use_cassette('delete_comment_chained') do
+        comment.destroy
+      end
+
+      expect(delete_response['project_id']).to eq(project_id)
+      expect(delete_response['comment_deleted']).to eq(true)
+    end
+  end
 end

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

@@ -74,11 +74,44 @@ RSpec.describe Lokalise::Client do
     expect(contributor.languages.length).to eq(1)
   end
 
-  specify '#delete_contributor' do
+  specify '#destroy_contributor' do
     response = VCR.use_cassette('delete_contributor') do
-      test_client.delete_contributor project_id, contributor_id
+      test_client.destroy_contributor project_id, contributor_id
     end
     expect(response['project_id']).to eq(project_id)
     expect(response['contributor_deleted']).to eq(true)
   end
+
+  context 'contributor chained methods' do
+    it 'should support update and destroy' do
+      contributor = VCR.use_cassette('create_another_contributor') do
+        test_client.create_contributors project_id,
+                                        email: 'demo@test.com',
+                                        fullname: 'chained',
+                                        languages: [{lang_iso: 'en'}]
+      end.collection.first
+
+      expect(contributor.client).to eq(test_client)
+      expect(contributor.fullname).to eq('chained')
+
+      id = contributor.user_id
+      path = contributor.path
+
+      updated_contributor = VCR.use_cassette('update_contributor_chained') do
+        contributor.update fullname: 'updated!'
+      end
+
+      expect(updated_contributor.client).to eq(test_client)
+      expect(updated_contributor.fullname).to eq('updated!')
+      expect(updated_contributor.user_id).to eq(id)
+      expect(updated_contributor.path).to eq(path)
+
+      delete_response = VCR.use_cassette('delete_contributor_chained') do
+        updated_contributor.destroy
+      end
+
+      expect(delete_response['project_id']).to eq(project_id)
+      expect(delete_response['contributor_deleted']).to eq(true)
+    end
+  end
 end

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

@@ -108,21 +108,72 @@ RSpec.describe Lokalise::Client do
     expect(second_key.description).to eq('bulk updated')
   end
 
-  specify '#delete_key' do
+  specify '#destroy_key' do
     response = VCR.use_cassette('delete_key') do
-      test_client.delete_key project_id, '15519771'
+      test_client.destroy_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
+  specify '#destroy_keys' do
     response = VCR.use_cassette('delete_keys') do
-      test_client.delete_keys project_id, [new_key_id, key_id]
+      test_client.destroy_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
+
+  context 'key chained methods' do
+    it 'should support update and destroy' do
+      key = VCR.use_cassette('create_another_key') do
+        test_client.create_keys project_id, key_name: 'chained_k', platforms: %w[ios]
+      end.collection.first
+
+      expect(key.key_name['ios']).to eq('chained_k')
+
+      path = key.path
+
+      updated_key = VCR.use_cassette('update_key_chained') do
+        key.update key_name: 'updated!'
+      end
+
+      expect(updated_key.client).to eq(test_client)
+      expect(updated_key.key_name['ios']).to eq('updated!')
+      expect(updated_key.path).to eq(path)
+
+      delete_response = VCR.use_cassette('delete_key_chained') do
+        updated_key.destroy
+      end
+
+      expect(delete_response['project_id']).to eq(project_id)
+      expect(delete_response['key_removed']).to eq(true)
+    end
+  end
+
+  context 'keys collection chained methods' do
+    it 'should support destroy_all' do
+      keys = VCR.use_cassette('create_keys_collection') do
+        test_client.create_keys project_id, [
+          {
+            key_name: 'key_collect1', platforms: %w[ios]
+          },
+          {
+            key_name: 'key_collect2', platforms: %w[ios]
+          }
+        ]
+      end
+
+      expect(keys.collection.length).to eq(2)
+
+      delete_response = VCR.use_cassette('delete_all_keys_chained') do
+        keys.destroy_all
+      end
+
+      expect(delete_response['project_id']).to eq(project_id)
+      expect(delete_response['keys_removed']).to eq(true)
+    end
+  end
 end