ruby-lokalise-api 5.0.0 → 6.2.0

data/lib/ruby_lokalise_api/rest/team_user_billing_details.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module TeamUserBillingDetails
+      # Returns team user billing details
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-team-user-billing-details
+      # @return [RubyLokaliseApi::Resources::TeamUserBillingDetails]
+      # @param team_id [String]
+      def team_user_billing_details(team_id)
+        c_r RubyLokaliseApi::Resources::TeamUserBillingDetails, :find, team_id
+      end
+
+      # Creates team user billing details
+      #
+      # @see https://developers.lokalise.com/reference/create-team-user-billing-details
+      # @return [RubyLokaliseApi::Resources::TeamUserBillingDetails]
+      # @param team_id [String]
+      # @param params [Hash]
+      def create_team_user_billing_details(team_id, params)
+        c_r RubyLokaliseApi::Resources::TeamUserBillingDetails, :create, team_id, params
+      end
+
+      # Updates team user billing details
+      #
+      # @see https://developers.lokalise.com/reference/create-team-user-billing-details
+      # @return [RubyLokaliseApi::Resources::TeamUserBillingDetails]
+      # @param team_id [String]
+      # @param params [Hash]
+      def update_team_user_billing_details(team_id, params)
+        c_r RubyLokaliseApi::Resources::TeamUserBillingDetails, :update, team_id, params
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/team_user_groups.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module TeamUserGroups
+      # Returns all team user groups for the given team
+      #
+      # @see https://developers.lokalise.com/reference/list-all-team-users
+      # @return [RubyLokaliseApi::Collection::TeamUserGroup<RubyLokaliseApi::Resources::TeamUserGroup>]
+      # @param team_id [String]
+      # @param params [Hash]
+      def team_user_groups(team_id, params = {})
+        c_r RubyLokaliseApi::Collections::TeamUserGroup, :all, team_id, params
+      end
+
+      # Returns team user from the given team
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-a-team-user
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param team_id [String]
+      # @param group_id [String, Integer]
+      def team_user_group(team_id, group_id)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :find, [team_id, group_id]
+      end
+
+      # Creates team user group
+      #
+      # @see https://developers.lokalise.com/reference/create-a-group
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param params [Hash]
+      def create_team_user_group(team_id, params)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :create, team_id, params
+      end
+
+      # Updates team user group for the given team
+      #
+      # @see https://developers.lokalise.com/reference/update-a-group
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param team_id [String]
+      # @param group_id [String, Integer]
+      # @param params [Hash]
+      def update_team_user_group(team_id, group_id, params)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :update, [team_id, group_id], params
+      end
+
+      # Deletes team user group from the given team
+      #
+      # @see https://developers.lokalise.com/reference/delete-a-group
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param team_id [String]
+      # @param group_id [String, Integer]
+      def destroy_team_user_group(team_id, group_id)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :destroy, [team_id, group_id]
+      end
+
+      # Adds projects to the given group
+      #
+      # @see https://developers.lokalise.com/reference/add-projects-to-group
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param team_id [String]
+      # @param group_id [String, Integer]
+      # @param project_ids [String, Integer, Array<String>, Array<Integer>]
+      def add_projects_to_group(team_id, group_id, project_ids)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :update,
+            [team_id, group_id, 'projects', 'add'],
+            project_ids, :projects, [team_id, group_id]
+      end
+
+      # Removes projects from the given group
+      #
+      # @see https://developers.lokalise.com/reference/remove-projects-from-group
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param team_id [String]
+      # @param group_id [String, Integer]
+      # @param project_ids [String, Integer, Array<String>, Array<Integer>]
+      def remove_projects_from_group(team_id, group_id, project_ids)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :update,
+            [team_id, group_id, 'projects', 'remove'],
+            project_ids, :projects, [team_id, group_id]
+      end
+
+      # Adds users to the given group
+      #
+      # @see https://developers.lokalise.com/reference/add-members-to-group
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param team_id [String]
+      # @param group_id [String, Integer]
+      # @param users_ids [String, Integer, Array<String>, Array<Integer>]
+      def add_users_to_group(team_id, group_id, users_ids)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :update,
+            [team_id, group_id, 'members', 'add'],
+            users_ids, :users, [team_id, group_id]
+      end
+
+      # Removes users from the given group
+      #
+      # @see https://developers.lokalise.com/reference/remove-members-from-group
+      # @return [RubyLokaliseApi::Resources::TeamUserGroup]
+      # @param team_id [String]
+      # @param group_id [String, Integer]
+      # @param users_ids [String, Integer, Array<String>, Array<Integer>]
+      def remove_users_from_group(team_id, group_id, users_ids)
+        c_r RubyLokaliseApi::Resources::TeamUserGroup, :update,
+            [team_id, group_id, 'members', 'remove'],
+            users_ids, :users, [team_id, group_id]
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/team_users.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module TeamUsers
+      # Returns all team users for the given team
+      #
+      # @see https://developers.lokalise.com/reference/list-all-team-users
+      # @return [RubyLokaliseApi::Collection::TeamUser<RubyLokaliseApi::Resources::TeamUser>]
+      # @param team_id [String]
+      # @param params [Hash]
+      def team_users(team_id, params = {})
+        c_r RubyLokaliseApi::Collections::TeamUser, :all, team_id, params
+      end
+
+      # Returns team user from the given team
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-a-team-user
+      # @return [RubyLokaliseApi::Resources::TeamUser]
+      # @param team_id [String]
+      # @param user_id [String, Integer]
+      def team_user(team_id, user_id)
+        c_r RubyLokaliseApi::Resources::TeamUser, :find, [team_id, user_id]
+      end
+
+      # Updates team user for the given team
+      #
+      # @see https://developers.lokalise.com/reference/update-a-team-user
+      # @return [RubyLokaliseApi::Resources::TeamUser]
+      # @param team_id [String]
+      # @param user_id [String, Integer]
+      # @param params [Hash]
+      def update_team_user(team_id, user_id, params)
+        c_r RubyLokaliseApi::Resources::TeamUser, :update, [team_id, user_id], params
+      end
+
+      # Deletes team user from the given team
+      #
+      # @see https://developers.lokalise.com/reference/delete-a-team-user
+      # @return [RubyLokaliseApi::Resources::TeamUser]
+      # @param team_id [String]
+      # @param user_id [String, Integer]
+      def destroy_team_user(team_id, user_id)
+        c_r RubyLokaliseApi::Resources::TeamUser, :destroy, [team_id, user_id]
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/teams.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Teams
+      # Returns all teams available to the user
+      #
+      # @see https://developers.lokalise.com/reference/list-all-teams
+      # @return [RubyLokaliseApi::Collection::Team<RubyLokaliseApi::Resources::Team>]
+      # @param params [Hash]
+      def teams(params = {})
+        c_r RubyLokaliseApi::Collections::Team, :all, nil, params
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/translation_providers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module TranslationProviders
+      # Returns all translation providers for the given team
+      #
+      # @see https://developers.lokalise.com/reference/list-all-providers
+      # @return [RubyLokaliseApi::Collection::TranslationProvider<RubyLokaliseApi::Resources::TranslationProvider>]
+      # @param team_id [String]
+      # @param params [Hash]
+      def translation_providers(team_id, params = {})
+        c_r RubyLokaliseApi::Collections::TranslationProvider, :all, team_id, params
+      end
+
+      # Returns a single translation provider for the given team
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-a-provider
+      # @return [RubyLokaliseApi::Resources::TranslationProvider]
+      # @param team_id [String]
+      # @param provider_id [String, Integer]
+      def translation_provider(team_id, provider_id)
+        c_r RubyLokaliseApi::Resources::TranslationProvider, :find, [team_id, provider_id]
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/translations.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Translations
+      # Returns all translations for the given project (ungrouped)
+      #
+      # @see https://developers.lokalise.com/reference/list-all-translations
+      # @return [RubyLokaliseApi::Collection::Translation<RubyLokaliseApi::Resources::Translation>]
+      # @param project_id [String]
+      # @param params [Hash]
+      def translations(project_id, params = {})
+        c_r RubyLokaliseApi::Collections::Translation, :all, project_id, params
+      end
+
+      # Returns translation of the given project
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-a-translation
+      # @return [RubyLokaliseApi::Resources::Translation]
+      # @param project_id [String]
+      # @param translation_id [String, Integer]
+      # @param params [Hash]
+      def translation(project_id, translation_id, params = {})
+        c_r RubyLokaliseApi::Resources::Translation, :find, [project_id, translation_id], params
+      end
+
+      # Updates translation of the given project
+      #
+      # @see https://developers.lokalise.com/reference/update-a-translation
+      # @return [RubyLokaliseApi::Resources::Translation]
+      # @param project_id [String]
+      # @param translation_id [String, Integer]
+      # @param params [Hash]
+      def update_translation(project_id, translation_id, params)
+        c_r RubyLokaliseApi::Resources::Translation, :update, [project_id, translation_id], params
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/webhooks.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Webhooks
+      # Returns all webhooks for the given project
+      #
+      # @see https://developers.lokalise.com/reference/list-all-webhooks
+      # @return [RubyLokaliseApi::Collection::Webhook<RubyLokaliseApi::Resources::Webhook>]
+      # @param project_id [String]
+      # @param params [Hash]
+      def webhooks(project_id, params = {})
+        c_r RubyLokaliseApi::Collections::Webhook, :all, project_id, params
+      end
+
+      # Returns a single webhook for the given project
+      #
+      # @see https://developers.lokalise.com/reference/retrieve-a-webhook
+      # @return [RubyLokaliseApi::Resources::Webhook]
+      # @param project_id [String]
+      # @param webhook_id [String, Integer]
+      def webhook(project_id, webhook_id)
+        c_r RubyLokaliseApi::Resources::Webhook, :find, [project_id, webhook_id]
+      end
+
+      # Creates webhook for the given project
+      #
+      # @see https://developers.lokalise.com/reference/create-a-webhook
+      # @return [RubyLokaliseApi::Resources::Webhook]
+      # @param project_id [String]
+      # @param params [Hash]
+      def create_webhook(project_id, params)
+        c_r RubyLokaliseApi::Resources::Webhook, :create, project_id, params
+      end
+
+      # Updates webhook for the given project
+      #
+      # @see https://developers.lokalise.com/reference/update-a-webhook
+      # @return [RubyLokaliseApi::Resources::Webhook]
+      # @param project_id [String]
+      # @param webhook_id [String, Integer]
+      # @param params [Hash]
+      def update_webhook(project_id, webhook_id, params = {})
+        c_r RubyLokaliseApi::Resources::Webhook, :update, [project_id, webhook_id], params
+      end
+
+      # Deletes webhook for the given project
+      #
+      # @see https://developers.lokalise.com/reference/delete-a-webhook
+      # @return [Hash]
+      # @param project_id [String]
+      # @param webhook_id [String, Integer]
+      def destroy_webhook(project_id, webhook_id)
+        c_r RubyLokaliseApi::Resources::Webhook, :destroy, [project_id, webhook_id]
+      end
+
+      # Regenerates secret for the given webhook
+      #
+      # @see https://developers.lokalise.com/reference/regenerate-a-webhook-secret
+      # @return [Hash]
+      # @param project_id [String]
+      # @param webhook_id [String, Integer]
+      def regenerate_webhook_secret(project_id, webhook_id)
+        c_r RubyLokaliseApi::Resources::Webhook, :regenerate_secret,
+            [project_id, webhook_id, 'secret', 'regenerate']
+      end
+    end
+  end
+end

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/utils/attribute_helpers.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Utils
     module AttributeHelpers
-      using Lokalise::Utils::StringUtils
+      using RubyLokaliseApi::Utils::StringUtils
 
       UNIFIED_RESOURCES = %w[comment language].freeze
 
@@ -49,7 +49,7 @@ module Lokalise
       #
       # @return [Array<String>]
       def attributes_for(klass)
-        @attributes ||= YAML.load_file(File.expand_path('../data/attributes.json', __dir__)).freeze
+        @attributes ||= YAML.load_file(File.expand_path('../data/attributes.yml', __dir__)).freeze
 
         name = unify klass.name.snakecase
         @attributes[name]
@@ -58,10 +58,10 @@ module Lokalise
       private
 
       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}"
+        key = if collection && Module.const_defined?("RubyLokaliseApi::Collections::#{model_class}::#{name}")
+                Module.const_get "RubyLokaliseApi::Collections::#{model_class}::#{name}"
+              elsif Module.const_defined? "RubyLokaliseApi::Resources::#{model_class}::#{name}"
+                Module.const_get "RubyLokaliseApi::Resources::#{model_class}::#{name}"
               else
                 strict ? nil : model_class
               end

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/utils/endpoint_helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Utils
     module EndpointHelpers
       def path_from(raw_mapping)

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/utils/string_utils.rb

@@ -3,7 +3,7 @@
 # Initial code taken from Facets gem by Rubyworks
 # https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
 
-module Lokalise
+module RubyLokaliseApi
   module Utils
     module StringUtils
       refine String do

data/lib/ruby_lokalise_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  VERSION = '6.2.0'
+end

data/lib/ruby_lokalise_api.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'faraday'
+require 'faraday/gzip'
+require 'yaml'
+require 'addressable'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  'oauth2' => 'OAuth2',
+  'oauth2_client' => 'OAuth2Client'
+)
+loader.setup
+
+module RubyLokaliseApi
+  class << self
+    # Initializes a new Client object
+    #
+    # @return [RubyLokaliseApi::Client]
+    # @param token [String]
+    # @param params [Hash]
+    def client(token, params = {})
+      @client = RubyLokaliseApi::Client.new token, params
+    end
+
+    # Reset the currently set client
+    def reset_client!
+      @client = nil
+    end
+
+    # Initializes a new OAuth2Client object
+    #
+    # @return [RubyLokaliseApi::OAuth2Client]
+    # @param token [String]
+    # @param params [Hash]
+    def oauth2_client(token, params = {})
+      @oauth2_client = RubyLokaliseApi::OAuth2Client.new token, params
+    end
+
+    # Reset the currently set OAuth2 client
+    def reset_oauth2_client!
+      @oauth2_client = nil
+    end
+
+    def auth_client(client_id, client_secret)
+      RubyLokaliseApi::OAuth2::Auth.new client_id, client_secret
+    end
+  end
+end

data/ruby-lokalise-api.gemspec

@@ -1,31 +1,31 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/ruby-lokalise-api/version', __dir__)
+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-Krukowski']
+  spec.version               = RubyLokaliseApi::VERSION
+  spec.authors               = ['Ilya Krukowski']
   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               = 'BSD-3-Clause'
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7'
 
   spec.files = Dir['README.md', 'LICENSE',
-                   'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby-lokalise-api/data/attributes.json',
+                   'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby_lokalise_api/data/attributes.yml',
                    '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 'addressable',                     '~> 2.5'
   spec.add_dependency 'faraday',                         '~> 2.0'
   spec.add_dependency 'faraday-gzip',                    '~> 0.1'
-  spec.add_dependency 'json',                            '>= 1.8.0'
+  spec.add_dependency 'json',                            '~> 2'
+  spec.add_dependency 'zeitwerk',                        '~> 2.4'
 
   spec.add_development_dependency 'codecov',             '~> 0.1'
   spec.add_development_dependency 'dotenv',              '~> 2.5'
@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec',       '~> 2.0'
   spec.add_development_dependency 'simplecov',           '~> 0.16'
   spec.add_development_dependency 'vcr',                 '~> 6.0'
+  spec.add_development_dependency 'webmock',             '~> 3.14'
   spec.metadata = {
     'rubygems_mfa_required' => 'true'
   }