ruby-lokalise-api 6.2.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90b862c7994f5c977a2a3a71dac7877163d83c7051ea16b808a770f2b1c24f9e
-  data.tar.gz: ca1cb74e869faae115c85d59011bd254bf0f06e6738d81297de4239d73c4c8d9
+  metadata.gz: 6f88c68ae7c24d90be54394259b2fc477eb52a485775be7292789ea743155556
+  data.tar.gz: 0ce8f2d8db252f4e7fa44cb87b68786adfacd86849b16d10c60ab58d3b9e51b8
 SHA512:
-  metadata.gz: 98cba873be8c354d5de708493cbdf078bca3c1269b8587417044b3a7e5b2c8d235b83e09de84cb2d03279d3459074b1b150dc7b8a5e830be12332254d2f57cbf
-  data.tar.gz: 5ef019ca07ac5e515f31805ebc63dd962832e42df1c10de46bc6a053de8639d92831763687d8cd80289ec8fb755da9c6b15f8272c0ec50c00c0ce722be4ed30c
+  metadata.gz: bb4469e28faafba3f0c81f4fb27b5b2747055da3d93cca81cf4244a38d0962ba896770a5fa8d81e859ad26f6f67cdf549ad288073bd5c946c5dacc58a812a1e7
+  data.tar.gz: fc41d966f5c55bbf900015ae3fa8f60f28cb9f1931b1f3172c247152e040dc0fab8b51eff7dcd107cd4423c73dca615b3db4f27e7e83acd963b37724d9251025

data/Rakefile

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 begin
   require 'bundler/setup'
@@ -9,13 +12,33 @@ rescue LoadError
   puts 'although not required, bundler is recommened for running the tests'
 end
 
-task default: :spec
-
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-require 'rubocop/rake_task'
 RuboCop::RakeTask.new do |task|
   task.requires << 'rubocop-performance'
   task.requires << 'rubocop-rspec'
+  task.requires << 'rubocop-rake'
+end
+
+CLOBBER.include(FileList['./*.gem'])
+
+namespace :lokalise do
+  desc 'Updates RubyGems, installs dependencies'
+  task :install do
+    puts 'Running bundle install'
+    sh 'gem update --system'
+    sh 'bundle'
+  end
+
+  desc 'Builds the gem'
+  task :build do
+    puts 'Building'
+    sh 'gem build ruby-lokalise-api.gemspec'
+  end
 end
+
+task rubospec: %w[rubocop spec]
+
+task full_build: %w[clobber lokalise:install lokalise:build]
+
+task default: :full_build

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/base_request.rb

@@ -3,6 +3,47 @@
 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
 
@@ -11,8 +52,16 @@ module RubyLokaliseApi
       path.delete_prefix('/').gsub(%r{//}, '/').gsub(%r{/+\z}, '')
     end
 
-    def raise_on_error!(status, body)
-      respond_with_error(status, body) if status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
+    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)

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,43 +26,18 @@ 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)
+      super(token, params)
+
       @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
+    def base_url
+      'https://api.lokalise.com/api2/'
     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}
+    def compression?
+      true
     end
-
-    alias c_r construct_request
   end
 end

data/lib/ruby_lokalise_api/connection.rb

@@ -2,26 +2,33 @@
 
 module RubyLokaliseApi
   module Connection
-    BASE_URL = 'https://api.lokalise.com/api2/'
-
     def connection(client)
       Faraday.new(options(client), request_params_for(client)) do |faraday|
         faraday.adapter Faraday.default_adapter
-        faraday.request :gzip
+        faraday.request(:gzip) if client.compression?
       end
     end
 
     private
 
     def options(client)
+      params = __base_options(client)
+
+      if client.respond_to?(:token) && client.respond_to?(:token_header)
+        params[:headers][client.token_header] = client.token
+      end
+      params[:headers][:accept_encoding] = 'gzip,deflate,br' if client.compression?
+
+      params
+    end
+
+    def __base_options(client)
       {
         headers: {
           accept: 'application/json',
-          user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}",
-          accept_encoding: 'gzip,deflate,br',
-          client.token_header => client.token
+          user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}"
         },
-        url: BASE_URL
+        url: client.base_url
       }
     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

@@ -3,13 +3,15 @@
 module RubyLokaliseApi
   module OAuth2
     class Auth
-      include RubyLokaliseApi::OAuth2::Request
+      include RubyLokaliseApi::BaseRequest
 
-      attr_reader :client_id, :client_secret
+      attr_reader :client_id, :client_secret, :timeout, :open_timeout
 
-      def initialize(client_id, client_secret)
+      def initialize(client_id, client_secret, params = {})
         @client_id = client_id
         @client_secret = client_secret
+        @timeout = params[:timeout]
+        @open_timeout = params[:open_timeout]
       end
 
       def auth(scope:, redirect_uri: nil, state: nil)
@@ -30,7 +32,8 @@ module RubyLokaliseApi
                                      code: code,
                                      grant_type: 'authorization_code'
                                    })
-        post 'token', params
+
+        RubyLokaliseApi::OAuth2::Token.new post('token', self, params)
       end
 
       def refresh(token)
@@ -38,7 +41,16 @@ module RubyLokaliseApi
                                      refresh_token: token,
                                      grant_type: 'refresh_token'
                                    })
-        post 'token', params
+
+        RubyLokaliseApi::OAuth2::Refresh.new post('token', self, params)
+      end
+
+      def base_url
+        URI('https://app.lokalise.com/oauth2/')
+      end
+
+      def compression?
+        false
       end
 
       private
@@ -52,8 +64,8 @@ module RubyLokaliseApi
 
       def _build_url_from(params)
         URI::HTTPS.build(
-          host: BASE_URL.host,
-          path: "#{BASE_URL.path}auth",
+          host: base_url.host,
+          path: "#{base_url.path}auth",
           query: URI.encode_www_form(params)
         ).to_s
       end

data/lib/ruby_lokalise_api/oauth2/refresh.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module OAuth2
+    class Refresh
+      attr_reader :access_token, :expires_in, :scope, :token_type
+
+      def initialize(raw_params)
+        @access_token = raw_params['access_token']
+        @expires_in = raw_params['expires_in']
+        @scope = raw_params['scope']
+        @token_type = raw_params['token_type']
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/oauth2/token.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module OAuth2
+    class Token
+      attr_reader :access_token, :refresh_token, :expires_in, :token_type
+
+      def initialize(raw_params)
+        @access_token = raw_params['access_token']
+        @refresh_token = raw_params['refresh_token']
+        @expires_in = raw_params['expires_in']
+        @token_type = raw_params['token_type']
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/request.rb

@@ -3,58 +3,17 @@
 module RubyLokaliseApi
   module Request
     include RubyLokaliseApi::BaseRequest
-    include RubyLokaliseApi::Connection
 
     # Lokalise returns pagination info in special headers
-    PAGINATION_HEADERS = %w[x-pagination-total-count x-pagination-page-count x-pagination-limit x-pagination-page].freeze
-
-    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
+    PAGINATION_HEADERS = %w[x-pagination-total-count x-pagination-page-count x-pagination-limit
+                            x-pagination-page].freeze
 
     private
 
     def respond_with(response, client)
       body = custom_load response.body
       uri = Addressable::URI.parse response.env.url
-      status = response.status
-      raise_on_error! status, body
+      raise_on_error! response, body
       extract_headers_from(response).
         merge('content' => body,
               'client' => client,

data/lib/ruby_lokalise_api/resources/base.rb

@@ -27,12 +27,17 @@ module RubyLokaliseApi
         @path = infer_path_from response, endpoint_generator
       end
 
+      # Returns object attribute with [] notation by calling
+      # the corresponding method on the object if the
+      # instance variable named after the requested key exists
+      #
+      # @param raw_key_attr [String or Hash]
       def [](raw_key_attr)
         key_attr = raw_key_attr.to_s.to_sym
 
-        return nil unless self.instance_variables.include?(:"@#{key_attr}")
+        return nil unless instance_variables.include?(:"@#{key_attr}")
 
-        self.send key_attr
+        send key_attr
       end
 
       class << self

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/custom_translation_statuses.rb

@@ -6,7 +6,8 @@ module RubyLokaliseApi
       # Returns all translation statuses for the given project
       #
       # @see https://developers.lokalise.com/reference/list-all-custom-translation-statuses
-      # @return [RubyLokaliseApi::Collection::CustomTranslationStatus<RubyLokaliseApi::Resources::CustomTranslationStatus>]
+      # @return [RubyLokaliseApi::Collection::CustomTranslationStatus
+      # <RubyLokaliseApi::Resources::CustomTranslationStatus>]
       # @param project_id [String]
       # @param params [Hash]
       def translation_statuses(project_id, params = {})

data/lib/ruby_lokalise_api/rest/files.rb

@@ -13,7 +13,8 @@ module RubyLokaliseApi
         c_r RubyLokaliseApi::Collections::File, :all, project_id, params
       end
 
-      # Exports translation files as .zip bundle, uploads them to Amazon S3 and returns a URL to the generated bundle. The URL is valid for a year
+      # Exports translation files as .zip bundle, uploads them to Amazon S3 and
+      # returns a URL to the generated bundle. The URL is valid for a year
       #
       # @see https://developers.lokalise.com/reference/download-files
       # @return [Hash]

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/utils/attribute_helpers.rb

@@ -70,7 +70,8 @@ module RubyLokaliseApi
         key ? key.snakecase : key
       end
 
-      # Unify some resources' names (eg, `ProjectComment` and `KeyComment` have the same attributes which are stored under `comment`)
+      # Unify some resources' names (eg, `ProjectComment` and `KeyComment` have the same
+      # attributes which are stored under `comment`)
       #
       # @return [String]
       def unify(name)

data/lib/ruby_lokalise_api/version.rb

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

data/lib/ruby_lokalise_api.rb

@@ -43,8 +43,14 @@ module RubyLokaliseApi
       @oauth2_client = nil
     end
 
-    def auth_client(client_id, client_secret)
-      RubyLokaliseApi::OAuth2::Auth.new client_id, client_secret
+    # Initializes a new Auth client to request OAuth 2 tokens
+    #
+    # @return [RubyLokaliseApi::OAuth2::Auth]
+    # @param client_id [String]
+    # @param client_secret [String]
+    # @param params [Hash]
+    def auth_client(client_id, client_secret, params = {})
+      RubyLokaliseApi::OAuth2::Auth.new client_id, client_secret, params
     end
   end
 end

data/ruby-lokalise-api.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec',               '~> 3.6'
   spec.add_development_dependency 'rubocop',             '~> 1.6'
   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 'vcr',                 '~> 6.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +266,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
@@ -283,8 +298,8 @@ files:
 - lib/ruby_lokalise_api/error.rb
 - lib/ruby_lokalise_api/json_handler.rb
 - lib/ruby_lokalise_api/oauth2/auth.rb
-- lib/ruby_lokalise_api/oauth2/connection.rb
-- lib/ruby_lokalise_api/oauth2/request.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
@@ -292,6 +307,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
@@ -317,6 +333,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
@@ -359,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.19
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API

data/lib/ruby_lokalise_api/oauth2/connection.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module OAuth2
-    module Connection
-      BASE_URL = URI('https://app.lokalise.com/oauth2/')
-
-      def connection
-        Faraday.new(options) { |f| f.adapter Faraday.default_adapter }
-      end
-
-      private
-
-      def options
-        {
-          headers: {
-            accept: 'application/json',
-            user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}"
-          },
-          url: BASE_URL.to_s
-        }
-      end
-    end
-  end
-end

data/lib/ruby_lokalise_api/oauth2/request.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module RubyLokaliseApi
-  module OAuth2
-    module Request
-      include RubyLokaliseApi::BaseRequest
-      include RubyLokaliseApi::OAuth2::Connection
-
-      def post(path, params = {})
-        respond_with connection.post(prepare(path), custom_dump(params))
-      end
-
-      private
-
-      def respond_with(response)
-        body = custom_load response.body
-        status = response.status
-        raise_on_error! status, body
-        body
-      end
-    end
-  end
-end