ruby-lokalise-api 7.2.0 → 8.0.0

data/lib/ruby_lokalise_api/utils/loaders.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Utils
+    module Loaders
+      private
+
+      # Instantiates an endpoint
+      def endpoint(name:, client: self, params: {})
+        klass = RubyLokaliseApi.const_get "Endpoints::#{name}Endpoint"
+        klass.new client, params
+      end
+
+      # Instantiates a resource
+      def resource(name, data)
+        klass = RubyLokaliseApi.const_get "Resources::#{name}"
+        klass.new data
+      end
+
+      # Instantiates a collection
+      def collection(name, data)
+        klass = RubyLokaliseApi.const_get "Collections::#{name}"
+        klass.new data
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/utils/strings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Utils
+    module Strings
+      refine String do
+        # Initial code taken from Facets gem by Rubyworks
+        # https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
+        def snakecase
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+            gsub(/([a-z\d])([A-Z])/, '\1_\2').
+            tr('-', '_').
+            gsub(/\s/, '_').
+            gsub(/__+/, '_').
+            downcase
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/version.rb

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

data/lib/ruby_lokalise_api.rb

@@ -4,15 +4,19 @@ require 'zeitwerk'
 require 'faraday'
 require 'faraday/gzip'
 require 'yaml'
-require 'addressable'
+require 'addressable/template'
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   'oauth2' => 'OAuth2',
-  'oauth2_client' => 'OAuth2Client'
+  'oauth2_client' => 'OAuth2Client',
+  'oauth2_endpoint' => 'OAuth2Endpoint',
+  'oauth2_token' => 'OAuth2Token',
+  'oauth2_refreshed_token' => 'OAuth2RefreshedToken'
 )
 loader.setup
 
+# Official Ruby client for Lokalise APIv2
 module RubyLokaliseApi
   class << self
     # Initializes a new Client object

data/ruby-lokalise-api.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7'
 
   spec.files = Dir['README.md', 'LICENSE',
-                   'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby_lokalise_api/data/attributes.yml',
+                   'CHANGELOG.md', 'lib/**/*.rb', 'lib/ruby_lokalise_api/data/*.yml',
                    'ruby-lokalise-api.gemspec', '.github/*.md',
                    'Gemfile', 'Rakefile']
   spec.extra_rdoc_files = ['README.md']
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable',                     '~> 2.5'
   spec.add_dependency 'faraday',                         '~> 2.0'
-  spec.add_dependency 'faraday-gzip',                    '>= 0.1', '< 2.0'
+  spec.add_dependency 'faraday-gzip',                    '~> 2.0'
   spec.add_dependency 'json',                            '~> 2'
   spec.add_dependency 'zeitwerk',                        '~> 2.4'
 
@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake',        '~> 0.6'
   spec.add_development_dependency 'rubocop-rspec',       '~> 2.0'
   spec.add_development_dependency 'simplecov',           '~> 0.21'
-  spec.add_development_dependency 'vcr',                 '~> 6.0'
+  spec.add_development_dependency 'simplecov-lcov',      '~> 0.8'
   spec.add_development_dependency 'webmock',             '~> 3.14'
   spec.metadata = {
     'rubygems_mfa_required' => 'true'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-11 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -42,20 +42,14 @@ dependencies:
   name: faraday-gzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -213,19 +207,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -259,53 +253,84 @@ files:
 - Rakefile
 - lib/ruby_lokalise_api.rb
 - lib/ruby_lokalise_api/base_client.rb
-- lib/ruby_lokalise_api/base_request.rb
 - lib/ruby_lokalise_api/client.rb
 - lib/ruby_lokalise_api/collections/base.rb
-- lib/ruby_lokalise_api/collections/branch.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
-- lib/ruby_lokalise_api/collections/order.rb
-- lib/ruby_lokalise_api/collections/payment_card.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/queued_process.rb
-- lib/ruby_lokalise_api/collections/screenshot.rb
-- lib/ruby_lokalise_api/collections/segment.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/team_user_group.rb
-- lib/ruby_lokalise_api/collections/translation.rb
-- lib/ruby_lokalise_api/collections/translation_provider.rb
-- lib/ruby_lokalise_api/collections/webhook.rb
+- lib/ruby_lokalise_api/collections/branches.rb
+- lib/ruby_lokalise_api/collections/contributors.rb
+- lib/ruby_lokalise_api/collections/custom_translation_statuses.rb
+- lib/ruby_lokalise_api/collections/files.rb
+- lib/ruby_lokalise_api/collections/key_comments.rb
+- lib/ruby_lokalise_api/collections/keys.rb
+- lib/ruby_lokalise_api/collections/orders.rb
+- lib/ruby_lokalise_api/collections/payment_cards.rb
+- lib/ruby_lokalise_api/collections/project_comments.rb
+- lib/ruby_lokalise_api/collections/project_languages.rb
+- lib/ruby_lokalise_api/collections/projects.rb
+- lib/ruby_lokalise_api/collections/queued_processes.rb
+- lib/ruby_lokalise_api/collections/screenshots.rb
+- lib/ruby_lokalise_api/collections/segments.rb
+- lib/ruby_lokalise_api/collections/snapshots.rb
+- lib/ruby_lokalise_api/collections/system_languages.rb
+- lib/ruby_lokalise_api/collections/tasks.rb
+- lib/ruby_lokalise_api/collections/team_user_groups.rb
+- lib/ruby_lokalise_api/collections/team_users.rb
+- lib/ruby_lokalise_api/collections/teams.rb
+- lib/ruby_lokalise_api/collections/translation_providers.rb
+- lib/ruby_lokalise_api/collections/translations.rb
+- lib/ruby_lokalise_api/collections/webhooks.rb
+- lib/ruby_lokalise_api/concerns/attrs_loadable.rb
+- lib/ruby_lokalise_api/concerns/hash_accessible.rb
+- lib/ruby_lokalise_api/concerns/unsupportable.rb
 - lib/ruby_lokalise_api/connection.rb
-- lib/ruby_lokalise_api/data/attributes.yml
+- lib/ruby_lokalise_api/data/collection_attributes.yml
+- lib/ruby_lokalise_api/data/resource_attributes.yml
+- lib/ruby_lokalise_api/endpoints/base_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/branches_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/contributors_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/custom_translation_statuses_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/files_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/jwts_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/key_comments_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/keys_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/main_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/oauth2/oauth2_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/orders_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/payment_cards_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/project_comments_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/project_languages_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/projects_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/queued_processes_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/screenshots_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/segments_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/snapshots_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/system_languages_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/tasks_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/team_user_billing_details_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/team_user_groups_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/team_users_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/teams_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/translation_providers_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/translations_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/webhooks_endpoint.rb
 - lib/ruby_lokalise_api/error.rb
+- lib/ruby_lokalise_api/generics.rb
 - lib/ruby_lokalise_api/json_handler.rb
 - lib/ruby_lokalise_api/oauth2/auth.rb
-- lib/ruby_lokalise_api/oauth2/refresh.rb
-- lib/ruby_lokalise_api/oauth2/token.rb
 - lib/ruby_lokalise_api/oauth2_client.rb
 - lib/ruby_lokalise_api/request.rb
 - lib/ruby_lokalise_api/resources/base.rb
 - lib/ruby_lokalise_api/resources/branch.rb
+- lib/ruby_lokalise_api/resources/comment.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/jwt.rb
 - lib/ruby_lokalise_api/resources/key.rb
-- lib/ruby_lokalise_api/resources/key_comment.rb
+- lib/ruby_lokalise_api/resources/oauth2_refreshed_token.rb
+- lib/ruby_lokalise_api/resources/oauth2_token.rb
 - lib/ruby_lokalise_api/resources/order.rb
 - lib/ruby_lokalise_api/resources/payment_card.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/queued_process.rb
 - lib/ruby_lokalise_api/resources/screenshot.rb
@@ -320,12 +345,14 @@ files:
 - lib/ruby_lokalise_api/resources/translation.rb
 - lib/ruby_lokalise_api/resources/translation_provider.rb
 - lib/ruby_lokalise_api/resources/webhook.rb
+- lib/ruby_lokalise_api/response.rb
+- lib/ruby_lokalise_api/rest.rb
 - lib/ruby_lokalise_api/rest/branches.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/jwt.rb
+- lib/ruby_lokalise_api/rest/jwts.rb
 - lib/ruby_lokalise_api/rest/keys.rb
 - lib/ruby_lokalise_api/rest/languages.rb
 - lib/ruby_lokalise_api/rest/orders.rb
@@ -343,9 +370,11 @@ files:
 - lib/ruby_lokalise_api/rest/translation_providers.rb
 - lib/ruby_lokalise_api/rest/translations.rb
 - lib/ruby_lokalise_api/rest/webhooks.rb
-- lib/ruby_lokalise_api/utils/attribute_helpers.rb
-- lib/ruby_lokalise_api/utils/endpoint_helpers.rb
-- lib/ruby_lokalise_api/utils/string_utils.rb
+- lib/ruby_lokalise_api/utils/attributes.rb
+- lib/ruby_lokalise_api/utils/classes.rb
+- lib/ruby_lokalise_api/utils/keys.rb
+- lib/ruby_lokalise_api/utils/loaders.rb
+- lib/ruby_lokalise_api/utils/strings.rb
 - lib/ruby_lokalise_api/version.rb
 - ruby-lokalise-api.gemspec
 homepage: https://github.com/lokalise/ruby-lokalise-api
@@ -368,7 +397,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API

data/lib/ruby_lokalise_api/base_request.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module BaseRequest
-    include RubyLokaliseApi::JsonHandler
-    include RubyLokaliseApi::Connection
-
-    def get(path, client, params = {})
-      respond_with(
-        connection(client).get(prepare(path), params),
-        client
-      )
-    end
-
-    def post(path, client, params = {})
-      respond_with(
-        connection(client).post(prepare(path), custom_dump(params)),
-        client
-      )
-    end
-
-    def put(path, client, params = {})
-      respond_with(
-        connection(client).put(prepare(path), custom_dump(params)),
-        client
-      )
-    end
-
-    def patch(path, client, params = {})
-      respond_with(
-        connection(client).patch(prepare(path), params.any? ? custom_dump(params) : nil),
-        client
-      )
-    end
-
-    def delete(path, client, params = {})
-      respond_with(
-        # Rubocop tries to replace `delete` with `gsub` but that's a different method here!
-        # rubocop:disable Style/CollectionMethods
-        connection(client).delete(prepare(path)) do |req|
-          # rubocop:enable Style/CollectionMethods
-          req.body = custom_dump params
-        end,
-        client
-      )
-    end
-
-    private
-
-    # Get rid of double slashes in the `path`, leading and trailing slash
-    def prepare(path)
-      path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
-    end
-
-    def raise_on_error!(response, body)
-      return unless !response.success? || (body.respond_to?(:has_key?) && body.key?('error'))
-
-      respond_with_error(response.status, body)
-    end
-
-    def respond_with(response, _client)
-      body = custom_load response.body
-      raise_on_error! response, body
-      body
-    end
-
-    def respond_with_error(code, body)
-      raise(RubyLokaliseApi::Error, body['error'] || body) unless RubyLokaliseApi::Error::ERRORS.key? code
-
-      raise RubyLokaliseApi::Error::ERRORS[code].from_response(body)
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/branch.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Branch < Base
-      DATA_KEY_PLURAL = 'Branches'
-
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'branches']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/contributor.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Contributor < Base
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'contributors']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/custom_translation_status.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class CustomTranslationStatus < Base
-      DATA_KEY_PLURAL = 'CustomTranslationStatuses'
-
-      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/collections/file.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class File < Base
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'files']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/key.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Key < Base
-      # Destroys all keys in the collection
-      # @return [Hash]
-      def destroy_all
-        keys = collection.map(&:key_id)
-        RubyLokaliseApi::Resources::Key.destroy @client, @path, keys: keys
-      end
-
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'keys']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/key_comment.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class KeyComment < Base
-      class << self
-        def endpoint(project_id, key_id, *_args)
-          path_from projects: project_id,
-                    keys: [key_id, 'comments']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/order.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Order < Base
-      class << self
-        def endpoint(team_id, *_args)
-          path_from teams: [team_id, 'orders']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/payment_card.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class PaymentCard < Base
-      class << self
-        def endpoint(*_args)
-          path_from payment_cards: nil
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/project.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Project < Base
-      class << self
-        def endpoint(*_args)
-          path_from projects: nil
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/project_comment.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class ProjectComment < Base
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'comments']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/project_language.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class ProjectLanguage < Base
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'languages']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/queued_process.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class QueuedProcess < Base
-      DATA_KEY_PLURAL = 'Processes'
-
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'processes']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/screenshot.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Screenshot < Base
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'screenshots']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/segment.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Segment < Base
-      class << self
-        def endpoint(project_id, key_id, lang_iso, *_args)
-          path_from projects: project_id,
-                    keys: key_id,
-                    segments: lang_iso
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/snapshot.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Snapshot < Base
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'snapshots']
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/system_language.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class SystemLanguage < Base
-      class << self
-        def endpoint(*_args)
-          path_from system: 'languages'
-        end
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/collections/task.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module Collections
-    class Task < Base
-      class << self
-        def endpoint(project_id, *_args)
-          path_from projects: [project_id, 'tasks']
-        end
-      end
-    end
-  end
-end