ruby-lokalise-api 7.0.0 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0df97ee1958c45138da225b66c6cc99797a9cf77c3f84435b3fff41e86317c9
-  data.tar.gz: a98e58642231426d959a49299d47154c1883d1fa89214693bf062642a89c4581
+  metadata.gz: 9f195975b35421d2d4be87df71c5167fe34fc7143b580a1b79368a30d386e5cf
+  data.tar.gz: f461a8e2069ad81f3dd618cfa7f46641bdd020dbf893eb639e1cb04a83e35221
 SHA512:
-  metadata.gz: 3b1760ad8acee33810dc905ceb9fe8ff3791b8ac42cda5affb031112c53b0981dc5a2ad714d5ee04352fd5c50856ec695c45abf1c3765e939ab8230f1ed78ff1
-  data.tar.gz: 947b22b36b74ebde8abeeb8edde48b701e9b4cfd2f4f7bbf5f1c2e35aa94408c1b4deb60b56ab03c65ae1f0f5405c0aef0a9a5cdbf15d0e8e094060d75aeea34
+  metadata.gz: 01d5ef8819e3cdba05c651049a7c8fb4876d0e1b59b6fc3a87442ef3ec178c2ca2799ebbf145a94cba9cae37faac9fa0f8e4e6297023e88fab6aa5df19d6f627
+  data.tar.gz: 57bd17227380725a5b0e7898f23714584e354ace578b7e09f9c7fb87ce973594d07954d6cfcad3f42fc4a28b1d07ce2e9c681570f8fbc4f0b5d675bea75a1e6a

data/LICENSE

@@ -1,6 +1,6 @@
 BSD 3 Clause
 
-Copyright 2021 Lokalise Group, Ilya Krukowski
+Copyright 2023 Lokalise Group, Ilya Krukowski
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

data/README.md

@@ -2,7 +2,6 @@
 
 ![Gem](https://img.shields.io/gem/v/ruby-lokalise-api)
 ![CI](https://github.com/lokalise/ruby-lokalise-api/actions/workflows/ci.yml/badge.svg)
-[![Test Coverage](https://codecov.io/gh/lokalise/ruby-lokalise-api/graph/badge.svg)](https://codecov.io/gh/lokalise/ruby-lokalise-api)
 ![Downloads total](https://img.shields.io/gem/dt/ruby-lokalise-api)
 
 Official opinionated Ruby interface for the [Lokalise API](https://developers.lokalise.com/reference/lokalise-rest-api) that represents returned data as Ruby objects.

data/lib/ruby_lokalise_api/base_client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  class BaseClient
+    attr_reader :token, :token_header
+    attr_accessor :timeout, :open_timeout
+
+    def initialize(token, params = {})
+      @token = token
+      @timeout = params.fetch(:timeout, nil)
+      @open_timeout = params.fetch(:open_timeout, nil)
+      @token_header = ''
+    end
+
+    # rubocop:disable Metrics/ParameterLists
+    # Constructs request to perform the specified action
+    # @param klass The actual class to call the method upon
+    # @param method [Symbol] The method to call (:new, :update, :create etc)
+    # @param endpoint_ids [Array, Hash] IDs that are used to generate the proper path to the endpoint
+    # @param params [Array, Hash] Request parameters
+    # @param object_key [String, Symbol] Key that should be used to wrap parameters into
+    # @param initial_ids [Array] IDs that should be used to generate base endpoint path.
+    # The base path is used for method chaining
+    def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil, initial_ids = nil)
+      path = klass.endpoint(*endpoint_ids)
+      formatted_params = format_params(params, object_key)
+      formatted_params[:_initial_path] = klass.endpoint(*initial_ids) if initial_ids
+      klass.send method, self, path, formatted_params
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    # Converts `params` to hash with arrays under the `object_key` key.
+    # Used in bulk operations
+    #
+    # @return [Hash]
+    def format_params(params, object_key)
+      return params unless object_key
+
+      params = [params] unless params.is_a?(Array)
+      {object_key => params}
+    end
+
+    def base_url; end
+
+    def compression?; end
+
+    alias c_r construct_request
+  end
+end

data/lib/ruby_lokalise_api/client.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
-  class Client
+  class Client < BaseClient
     include RubyLokaliseApi::Rest::Branches
     include RubyLokaliseApi::Rest::Comments
     include RubyLokaliseApi::Rest::Contributors
     include RubyLokaliseApi::Rest::CustomTranslationStatuses
     include RubyLokaliseApi::Rest::Files
+    include RubyLokaliseApi::Rest::Jwt
     include RubyLokaliseApi::Rest::Keys
     include RubyLokaliseApi::Rest::Languages
     include RubyLokaliseApi::Rest::Orders
@@ -25,42 +26,10 @@ module RubyLokaliseApi
     include RubyLokaliseApi::Rest::Translations
     include RubyLokaliseApi::Rest::Webhooks
 
-    attr_reader :token, :token_header
-    attr_accessor :timeout, :open_timeout
-
     def initialize(token, params = {})
-      @token = token
-      @timeout = params.fetch(:timeout, nil)
-      @open_timeout = params.fetch(:open_timeout, nil)
-      @token_header = 'x-api-token'
-    end
-
-    # rubocop:disable Metrics/ParameterLists
-    # Constructs request to perform the specified action
-    # @param klass The actual class to call the method upon
-    # @param method [Symbol] The method to call (:new, :update, :create etc)
-    # @param endpoint_ids [Array, Hash] IDs that are used to generate the proper path to the endpoint
-    # @param params [Array, Hash] Request parameters
-    # @param object_key [String, Symbol] Key that should be used to wrap parameters into
-    # @param initial_ids [Array] IDs that should be used to generate base endpoint path.
-    # The base path is used for method chaining
-    def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil, initial_ids = nil)
-      path = klass.endpoint(*endpoint_ids)
-      formatted_params = format_params(params, object_key)
-      formatted_params[:_initial_path] = klass.endpoint(*initial_ids) if initial_ids
-      klass.send method, self, path, formatted_params
-    end
-    # rubocop:enable Metrics/ParameterLists
-
-    # Converts `params` to hash with arrays under the `object_key` key.
-    # Used in bulk operations
-    #
-    # @return [Hash]
-    def format_params(params, object_key)
-      return params unless object_key
+      super(token, params)
 
-      params = [params] unless params.is_a?(Array)
-      {object_key => params}
+      @token_header = 'x-api-token'
     end
 
     def base_url
@@ -70,7 +39,5 @@ module RubyLokaliseApi
     def compression?
       true
     end
-
-    alias c_r construct_request
   end
 end

data/lib/ruby_lokalise_api/data/attributes.yml

@@ -30,6 +30,8 @@ custom_translation_status:
 file:
   - filename
   - key_count
+jwt:
+  - jwt
 key:
   - key_id
   - created_at

data/lib/ruby_lokalise_api/oauth2/auth.rb

@@ -14,10 +14,6 @@ module RubyLokaliseApi
         @open_timeout = params[:open_timeout]
       end
 
-      def base_url
-        URI('https://app.lokalise.com/oauth2/')
-      end
-
       def auth(scope:, redirect_uri: nil, state: nil)
         scope = scope.join(' ') if scope.is_a?(Array)
 
@@ -49,6 +45,10 @@ module RubyLokaliseApi
         RubyLokaliseApi::OAuth2::Refresh.new post('token', self, params)
       end
 
+      def base_url
+        URI('https://app.lokalise.com/oauth2/')
+      end
+
       def compression?
         false
       end

data/lib/ruby_lokalise_api/resources/jwt.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Resources
+    class Jwt < Base
+      class << self
+        def endpoint(*_args)
+          path_from 'jwt-tokens': 'ota'
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/jwt.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module Jwt
+      # Returns a JWT that can be used to work with OTA
+      #
+      # @see https://developers.lokalise.com/reference/get-ota-jwt
+      # @return [RubyLokaliseApi::Resources::Jwt]
+      def jwt
+        c_r RubyLokaliseApi::Resources::Jwt, :find, nil, {}
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/version.rb

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

data/ruby-lokalise-api.gemspec

@@ -23,11 +23,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable',                     '~> 2.5'
   spec.add_dependency 'faraday',                         '~> 2.0'
-  spec.add_dependency 'faraday-gzip',                    '~> 0.1'
+  spec.add_dependency 'faraday-gzip',                    '>= 0.1', '< 2.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'
   spec.add_development_dependency 'oj',                  '~> 3.10'
   spec.add_development_dependency 'rake',                '~> 13.0'
@@ -36,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
   spec.add_development_dependency 'rubocop-rake',        '~> 0.6'
   spec.add_development_dependency 'rubocop-rspec',       '~> 2.0'
-  spec.add_development_dependency 'simplecov',           '~> 0.16'
+  spec.add_development_dependency 'simplecov',           '~> 0.21'
   spec.add_development_dependency 'vcr',                 '~> 6.0'
   spec.add_development_dependency 'webmock',             '~> 3.14'
   spec.metadata = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.1
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2023-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -42,16 +42,22 @@ 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
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +86,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -266,6 +258,7 @@ files:
 - README.md
 - 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
@@ -306,6 +299,7 @@ files:
 - 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/order.rb
@@ -331,6 +325,7 @@ files:
 - 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/keys.rb
 - lib/ruby_lokalise_api/rest/languages.rb
 - lib/ruby_lokalise_api/rest/orders.rb
@@ -373,7 +368,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.2
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API