ruby-lokalise-api 9.7.1 → 9.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d81a97427ff9dc39704702c65784cadf9c9ad5fdec26f2de03dd8e049c0f2518
-  data.tar.gz: c335bad01a49407da33b5d18b671bbf21560c9daf6f46022b6fea332aa43c4c4
+  metadata.gz: 837f5d7d18c692b1f77adc1ab9eeaf651f7fd05472cbb273e4ed9983610c5c43
+  data.tar.gz: b2674de6081d84a4a0cf720bbab391c7ba3e1e65e409db27a467dfbb240cf7f9
 SHA512:
-  metadata.gz: 52729414d5125f5b612324825084e132e9442898aa8e7f5185ffd7f044f686f1c750f12c545ecaad144a005c967c341efa0fb8266e94e09b6e9204640481dcac
-  data.tar.gz: 2a8cd86fdb375cc04aae9a366732f9b552b1f2ca44711d5fe0b0498ca280928949ebcea833d69cb168e2deeba812230a2168daedc8837c96c59c0a092940d4f6
+  metadata.gz: 41c24ef0abb5e55b866cccfc54b5d5ebff668d3899946634b76150081d0fa1f85ee8c681d3bbd4fe4a887d19858eda938e066e2aacef0ad2697ac661eefe4e90
+  data.tar.gz: ba86e2d299f9c0115e3eb9331078f13ad893da888b331f3356f5ef4dbced607fc8ef4b5b0bddbcd16ed2d36ba719e1d426bb45ed67bbb03b95ac900e8fff9893

data/lib/ruby_lokalise_api/base_client.rb

@@ -4,8 +4,6 @@ module RubyLokaliseApi
   # This class contains the base client. Inherited by Client (regular API client)
   # and OAuth2Client (used for OAuth2-based authentication)
   class BaseClient
-    include RubyLokaliseApi::Rest
-
     attr_reader :token, :token_header, :api_host
     attr_accessor :timeout, :open_timeout
 

data/lib/ruby_lokalise_api/client.rb

@@ -3,6 +3,8 @@
 module RubyLokaliseApi
   # Regular API client used to perform requests with a basic API token
   class Client < BaseClient
+    include RubyLokaliseApi::Rest
+
     def initialize(token, params = {})
       super
 

data/lib/ruby_lokalise_api/client_v1.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  # API client used to perform requests against new Lokalise API v1
+  class ClientV1 < BaseClient
+    include RubyLokaliseApi::RestV1
+
+    def initialize(token, params = {})
+      super
+
+      @token_header = 'x-api-token'
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/v1/audit_logs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    module V1
+      class AuditLogs < Base
+        ENDPOINT = RubyLokaliseApi::Endpoints::V1::AuditLogsEndpoint
+        RESOURCE = RubyLokaliseApi::Resources::V1::AuditLog
+        DATA_KEY = 'data'
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/collections/v1/base.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Collections
+    module V1
+      # Base collection. Collection is an array of resources. The actual resources can be found
+      # by calling the `.collection` method
+      class Base
+        include Enumerable
+        extend Forwardable
+
+        using RubyLokaliseApi::Utils::Classes
+        extend RubyLokaliseApi::Utils::Attributes
+        extend RubyLokaliseApi::Concerns::AttrsLoadable
+        include RubyLokaliseApi::Utils::Keys
+
+        ATTRS_FILENAME = 'collection_attributes.yml'
+
+        def_delegators :collection, :[], :last, :each
+
+        attr_reader :collection, :next_cursor, :has_more
+
+        def initialize(response)
+          @self_endpoint = response.endpoint
+
+          populate_common_attrs_from response
+          produce_collection_from response
+        end
+
+        # Tries to fetch the next cursor for paginated collection
+        # Returns a new collection or nil if the next cursor is not available
+        def load_next_cursor
+          return nil unless next_cursor?
+
+          fetch_cursor(next_cursor)
+        end
+
+        # Checks whether the next cursor is available
+        # @return [Boolean]
+        def next_cursor?
+          !next_cursor.nil? && next_cursor != ''
+        end
+
+        private
+
+        # This method is utilized to recreate an endpoint for the current collection
+        def reinit_endpoint(req_params: @self_endpoint.req_params, override_req_params: {})
+          @self_endpoint.reinitialize(
+            req_params: req_params.merge(override_req_params)
+          )
+        end
+
+        def populate_common_attrs_from(response)
+          # v1 has no common attrs so far
+          # supported_attrs.each do |attrib|
+          #   instance_variable_set :"@#{attrib}", response.content[attrib]
+          # end
+
+          @next_cursor = response.content['next_cursor']
+          @has_more = response.content['has_more']
+        end
+
+        def produce_collection_from(response)
+          content = response.content
+          return unless content
+
+          data_key_plural = collection_key_for klass: "V1::#{self.class.base_name}"
+
+          resources_data = content[data_key_plural]
+          other_data = content.except(data_key_plural)
+
+          @collection = build_collection resources_data, other_data
+        end
+
+        def build_collection(resources_data, other_data)
+          resources_data.map do |raw_resource|
+            self.class.const_get(:RESOURCE).new(resource_data(raw_resource, other_data))
+          end
+        end
+
+        def resource_data(raw_resource, other_data)
+          RubyLokaliseApi::Response.new(
+            raw_resource.merge(other_data),
+            resource_endpoint.new(
+              @self_endpoint.client,
+              query: query_for(raw_resource, other_data)
+            )
+          )
+        end
+
+        def query_for(raw_resource, other_data)
+          main_params = self.class.const_get(:RESOURCE).const_get(:MAIN_PARAMS).to_array
+
+          main_params.map do |param|
+            other_data[param.to_s] || raw_resource[param.to_s] || nil
+          end
+        end
+
+        def resource_endpoint
+          klass = self.class
+
+          klass.const_defined?(:RESOURCES_ENDPOINT) ? klass.const_get(:RESOURCES_ENDPOINT) : klass.const_get(:ENDPOINT)
+        end
+
+        # Helper method to fetch the next cursor
+        def fetch_cursor(cursor)
+          self.class.new(reinit_endpoint(override_req_params: { cursor: cursor }).do_get)
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/data/resource_attributes.yml

@@ -1,3 +1,23 @@
+audit_log:
+  - class_uid
+  - class_name
+  - category_uid
+  - category_name
+  - activity_id
+  - activity_name
+  - type_uid
+  - type_name
+  - severity_id
+  - severity
+  - status_id
+  - status
+  - time
+  - metadata
+  - actor
+  - src_endpoint
+  - http_request
+  - enrichments
+  - unmapped
 branch:
   - project_id
   - branch_id

data/lib/ruby_lokalise_api/endpoints/v1/audit_logs_endpoint.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    module V1
+      class AuditLogsEndpoint < MainEndpoint
+        private
+
+        def base_query(class_uuid = nil, *_args)
+          {
+            'audit-logs': [class_uuid]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/v1/main_endpoint.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    module V1
+      class MainEndpoint < BaseEndpoint
+        BASE_URL = 'https://api.lokalise.com/v1'
+
+        def initialize(client, params = {})
+          super
+
+          @uri = partial_uri(base_query(*@query_params))
+        end
+
+        private
+
+        def partial_uri(segments, *_args)
+          template = super
+
+          template.expand(
+            segments: segments.to_a.flatten
+          ).to_s
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/oauth2_client.rb

@@ -3,6 +3,8 @@
 module RubyLokaliseApi
   # Client used to perform API requests with an OAuth2 access token
   class OAuth2Client < Client
+    include RubyLokaliseApi::Rest
+
     def initialize(token, params = {})
       super
       @token_header = 'Authorization'

data/lib/ruby_lokalise_api/resources/v1/audit_log.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Resources
+    module V1
+      class AuditLog < ::RubyLokaliseApi::Resources::Base
+        MAIN_PARAMS = %i[class_uid].freeze
+        no_support_for %i[update destroy reload_data]
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest/v1/audit_logs.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Rest
+    module V1
+      module AuditLogs
+        # Returns audit logs
+        #
+        # @see https://developers.lokalise.com/reference/list-audit-logs
+        # @return [RubyLokaliseApi::Collections::V1::AuditLogs]
+        # @param req_params [Hash]
+        def audit_logs(req_params = {})
+          name = 'V1::AuditLogs'
+          params = { req: req_params }
+
+          data = endpoint(name: name, params: params).do_get
+
+          collection name, data
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/rest_v1.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module RestV1
+    include Utils::Loaders
+
+    include Rest::V1::AuditLogs
+  end
+end

data/lib/ruby_lokalise_api/version.rb

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

data/lib/ruby_lokalise_api.rb

@@ -12,11 +12,13 @@ loader.inflector.inflect(
   'oauth2_client' => 'OAuth2Client',
   'oauth2_endpoint' => 'OAuth2Endpoint',
   'oauth2_token' => 'OAuth2Token',
-  'oauth2_refreshed_token' => 'OAuth2RefreshedToken'
+  'oauth2_refreshed_token' => 'OAuth2RefreshedToken',
+  'client_v1' => 'ClientV1',
+  'rest_v1' => 'RestV1'
 )
 loader.setup
 
-# Official Ruby client for Lokalise APIv2
+# Official Ruby client for Lokalise APIv2 and new V1 API
 module RubyLokaliseApi
   class << self
     # Initializes a new Client object
@@ -28,9 +30,19 @@ module RubyLokaliseApi
       @client = RubyLokaliseApi::Client.new token, params
     end
 
+    # Initializes a new Client object for v1 endpoints
+    #
+    # @return [RubyLokaliseApi::ClientV1]
+    # @param token [String]
+    # @param params [Hash]
+    def client_v1(token, params = {})
+      @client_v1 = RubyLokaliseApi::ClientV1.new token, params
+    end
+
     # Reset the currently set client
     def reset_client!
       @client = nil
+      @client_v1 = nil
     end
 
     # Initializes a new OAuth2Client object

data/ruby-lokalise-api.gemspec

@@ -35,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',       '~> 3.0'
-  spec.add_development_dependency 'simplecov',           '~> 0.21'
+  spec.add_development_dependency 'simplecov',           '~> 0.22.0'
   spec.add_development_dependency 'simplecov-lcov',      '~> 0.8'
   spec.add_development_dependency 'webmock',             '~> 3.14'
   spec.metadata = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 9.7.1
+  version: 9.8.0
 platform: ruby
 authors:
 - Ilya Krukowski
@@ -217,14 +217,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -268,6 +268,7 @@ files:
 - lib/ruby_lokalise_api.rb
 - lib/ruby_lokalise_api/base_client.rb
 - lib/ruby_lokalise_api/client.rb
+- lib/ruby_lokalise_api/client_v1.rb
 - lib/ruby_lokalise_api/collections/base.rb
 - lib/ruby_lokalise_api/collections/branches.rb
 - lib/ruby_lokalise_api/collections/contributors.rb
@@ -293,6 +294,8 @@ files:
 - 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/v1/audit_logs.rb
+- lib/ruby_lokalise_api/collections/v1/base.rb
 - lib/ruby_lokalise_api/collections/webhooks.rb
 - lib/ruby_lokalise_api/concerns/attrs_loadable.rb
 - lib/ruby_lokalise_api/concerns/hash_accessible.rb
@@ -330,6 +333,8 @@ files:
 - lib/ruby_lokalise_api/endpoints/translation_providers_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/translations_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/users_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/v1/audit_logs_endpoint.rb
+- lib/ruby_lokalise_api/endpoints/v1/main_endpoint.rb
 - lib/ruby_lokalise_api/endpoints/webhooks_endpoint.rb
 - lib/ruby_lokalise_api/error.rb
 - lib/ruby_lokalise_api/generics.rb
@@ -366,6 +371,7 @@ files:
 - lib/ruby_lokalise_api/resources/translation.rb
 - lib/ruby_lokalise_api/resources/translation_provider.rb
 - lib/ruby_lokalise_api/resources/user.rb
+- lib/ruby_lokalise_api/resources/v1/audit_log.rb
 - lib/ruby_lokalise_api/resources/webhook.rb
 - lib/ruby_lokalise_api/response.rb
 - lib/ruby_lokalise_api/rest.rb
@@ -394,7 +400,9 @@ files:
 - lib/ruby_lokalise_api/rest/translation_providers.rb
 - lib/ruby_lokalise_api/rest/translations.rb
 - lib/ruby_lokalise_api/rest/users.rb
+- lib/ruby_lokalise_api/rest/v1/audit_logs.rb
 - lib/ruby_lokalise_api/rest/webhooks.rb
+- lib/ruby_lokalise_api/rest_v1.rb
 - lib/ruby_lokalise_api/utils/attributes.rb
 - lib/ruby_lokalise_api/utils/classes.rb
 - lib/ruby_lokalise_api/utils/keys.rb
@@ -425,7 +433,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Ruby interface to the Lokalise API
 test_files: []