ruby-lokalise-api 7.2.0 → 8.0.0

data/lib/ruby_lokalise_api/connection.rb

@@ -1,40 +1,48 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
+  # Module to setup connection using Faraday
   module Connection
-    def connection(client)
-      Faraday.new(options(client), request_params_for(client)) do |faraday|
+    # Creates a new Faraday object with specified params
+    def connection(endpoint)
+      Faraday.new(options(endpoint), request_params_for(endpoint.client)) do |faraday|
         faraday.adapter Faraday.default_adapter
-        faraday.request(:gzip) if client.compression?
+        faraday.request(:gzip)
       end
     end
 
     private
 
-    def options(client)
-      params = __base_options(client)
+    def options(endpoint)
+      params = __base_options(endpoint)
+      client = endpoint.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[:headers][:accept_encoding] = 'gzip,deflate,br'
 
       params
     end
 
-    def __base_options(client)
+    def __base_options(endpoint)
       {
         headers: {
           accept: 'application/json',
           user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}"
         },
-        url: client.base_url
+        url: endpoint.base_url
       }
     end
 
     # Allows to customize request params per-client
     def request_params_for(client)
-      {request: {timeout: client.timeout, open_timeout: client.open_timeout}}
+      {
+        request: {
+          timeout: client.timeout,
+          open_timeout: client.open_timeout
+        }
+      }
     end
   end
 end

data/lib/ruby_lokalise_api/data/collection_attributes.yml

@@ -0,0 +1,52 @@
+branches:
+  - project_id
+  - branch
+contributors:
+  - project_id
+  - branch
+comments:
+  - project_id
+  - branch
+custom_translation_statuses:
+  - project_id
+  - branch
+files:
+  - project_id
+  - branch
+keys:
+  - project_id
+  - branch
+  - errors
+orders:
+  - team_id
+payment_cards:
+  - user_id
+project_languages:
+  - project_id
+  - branch
+queued_processes:
+  - project_id
+  - branch
+segments:
+  - project_id
+  - key_id
+  - language_iso
+screenshots:
+  - project_id
+  - branch
+  - errors
+snapshots:
+  - project_id
+  - branch
+tasks:
+  - project_id
+  - branch
+team_users:
+  - team_id
+team_user_groups:
+  - team_id
+translations:
+  - project_id
+  - branch
+webhooks:
+  - project_id

data/lib/ruby_lokalise_api/data/{attributes.yml → resource_attributes.yml}

@@ -1,4 +1,5 @@
 branch:
+  - project_id
   - branch_id
   - name
   - created_at
@@ -6,6 +7,8 @@ branch:
   - created_by
   - created_by_email
 comment:
+  - project_id
+  - branch
   - comment_id
   - key_id
   - comment
@@ -14,6 +17,8 @@ comment:
   - added_at
   - added_at_timestamp
 contributor:
+  - project_id
+  - branch
   - user_id
   - email
   - fullname
@@ -24,15 +29,22 @@ contributor:
   - languages
   - admin_rights
 custom_translation_status:
+  - project_id
+  - branch
   - status_id
   - title
   - color
 file:
+  - branch
+  - project_id
+  - file_id
   - filename
   - key_count
 jwt:
   - jwt
 key:
+  - branch
+  - project_id
   - key_id
   - created_at
   - created_at_timestamp
@@ -56,15 +68,21 @@ key:
   - modified_at_timestamp
   - translations_modified_at
   - translations_modified_at_timestamp
-language:
-  - lang_id
-  - lang_iso
-  - lang_name
-  - is_rtl
-  - plural_forms
+o_auth2_token:
+  - access_token
+  - refresh_token
+  - expires_in
+  - token_type
+o_auth2_refreshed_token:
+  - access_token
+  - scope
+  - expires_in
+  - token_type
 order:
+  - team_id
   - order_id
   - project_id
+  - branch
   - card_id
   - status
   - created_at
@@ -84,6 +102,7 @@ order:
   - payment_method
   - dry_run
 payment_card:
+  - user_id
   - card_id
   - last4
   - brand
@@ -91,6 +110,7 @@ payment_card:
   - created_at_timestamp
 project:
   - project_id
+  - project_type
   - name
   - description
   - created_at
@@ -102,7 +122,17 @@ project:
   - base_language_iso
   - settings
   - statistics
+project_language:
+  - project_id
+  - branch
+  - lang_id
+  - lang_iso
+  - lang_name
+  - is_rtl
+  - plural_forms
 queued_process:
+  - project_id
+  - branch
   - process_id
   - type
   - status
@@ -113,8 +143,11 @@ queued_process:
   - created_at_timestamp
   - details
 screenshot:
+  - project_id
+  - branch
   - screenshot_id
   - key_ids
+  - keys
   - url
   - title
   - description
@@ -124,6 +157,9 @@ screenshot:
   - created_at
   - created_at_timestamp
 segment:
+  - project_id
+  - key_id
+  - language_iso
   - segment_number
   - language_iso
   - modified_at
@@ -137,13 +173,23 @@ segment:
   - words
   - custom_translation_statuses
 snapshot:
+  - project_id
+  - branch
   - snapshot_id
   - title
   - created_at
   - created_at_timestamp
   - created_by
   - created_by_email
+system_language:
+  - lang_id
+  - lang_iso
+  - lang_name
+  - is_rtl
+  - plural_forms
 task:
+  - branch
+  - project_id
   - task_id
   - title
   - description
@@ -157,6 +203,7 @@ task:
   - created_at_timestamp
   - created_by
   - created_by_email
+  - source_language_iso
   - can_be_parent
   - task_type
   - parent_task_id
@@ -180,6 +227,7 @@ team:
   - quota_usage
   - quota_allowed
 team_user:
+  - team_id
   - user_id
   - email
   - fullname
@@ -187,6 +235,7 @@ team_user:
   - created_at_timestamp
   - role
 team_user_billing_details:
+  - team_id
   - billing_email
   - country_code
   - zip
@@ -198,6 +247,7 @@ team_user_billing_details:
   - company
   - vatnumber
 team_user_group:
+  - team_id
   - group_id
   - name
   - permissions
@@ -207,6 +257,10 @@ team_user_group:
   - projects
   - members
 translation:
+  - project_id
+  - branch
+  - segment_number
+  - reviewed_by
   - translation_id
   - key_id
   - language_iso
@@ -217,10 +271,12 @@ translation:
   - translation
   - is_fuzzy
   - is_reviewed
+  - is_unverified
   - words
   - custom_translation_statuses
   - task_id
 translation_provider:
+  - team_id
   - provider_id
   - name
   - slug
@@ -230,6 +286,8 @@ translation_provider:
   - tiers
   - pairs
 webhook:
+  - project_id
+  - branch
   - webhook_id
   - url
   - secret

data/lib/ruby_lokalise_api/endpoints/base_endpoint.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class BaseEndpoint
+      using RubyLokaliseApi::Utils::Classes
+      include RubyLokaliseApi::Request
+
+      attr_reader :client, :req_params, :uri
+
+      BASE_URL = ''
+      PARTIAL_URI_TEMPLATE = '{/segments*}'
+
+      def initialize(client, params = {})
+        @query_params = params[:query].to_array
+        @client = client
+        @req_params = params[:req]
+        @uri = nil
+      end
+
+      def reinitialize(query_params: nil, req_params: {})
+        @query_params = query_params || @query_params
+        @req_params = req_params || @req_params
+        @uri = partial_uri(base_query(*@query_params))
+
+        self
+      end
+
+      def base_url
+        self.class.const_get(:BASE_URL)
+      end
+
+      def full_uri
+        base_url + uri
+      end
+
+      private
+
+      HTTP_METHODS_REGEXP = /\Ado_(get|post|put|delete|patch)\z/.freeze
+
+      def respond_to_missing?(method, _include_all)
+        return true if HTTP_METHODS_REGEXP.match?(method.to_s)
+
+        super
+      end
+
+      def method_missing(method, *_args)
+        if method.to_s =~ HTTP_METHODS_REGEXP
+          send Regexp.last_match(1), self
+        else
+          super
+        end
+      end
+
+      def base_query(*_args); end
+
+      def partial_uri(*_args)
+        Addressable::Template.new partial_uri_template
+      end
+
+      def partial_uri_template
+        self.class.const_get(:PARTIAL_URI_TEMPLATE)
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/branches_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class BranchesEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, branch_id = nil, action = nil)
+        {
+          projects: project_id,
+          branches: [branch_id, action]
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/contributors_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class ContributorsEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, contributor_id = nil)
+        {
+          projects: project_id,
+          contributors: contributor_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/custom_translation_statuses_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class CustomTranslationStatusesEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, status_id = nil)
+        {
+          projects: project_id,
+          custom_translation_statuses: status_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/files_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class FilesEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, action = nil)
+        {
+          projects: project_id,
+          files: action
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/jwts_endpoint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class JwtsEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id)
+        {
+          projects: [project_id, :tokens]
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/key_comments_endpoint.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class KeyCommentsEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, key_id, comment_id = nil)
+        {
+          projects: project_id,
+          keys: key_id,
+          comments: comment_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/keys_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class KeysEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, key_id = nil)
+        {
+          projects: project_id,
+          keys: key_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/main_endpoint.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class MainEndpoint < BaseEndpoint
+      BASE_URL = 'https://api.lokalise.com/api2'
+
+      def initialize(client, params = {})
+        super client, params
+
+        @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

data/lib/ruby_lokalise_api/endpoints/oauth2/oauth2_endpoint.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    module OAuth2
+      class OAuth2Endpoint < BaseEndpoint
+        BASE_URL = 'https://app.lokalise.com/oauth2'
+        PARTIAL_URI_TEMPLATE = '{/segments*}{?query*}'
+
+        def initialize(client, params = {})
+          super client, params
+
+          @uri = partial_uri(base_query(*@query_params), params.fetch(:get, []))
+        end
+
+        private
+
+        def partial_uri(segments, query)
+          template = super
+
+          template.expand(
+            segments: segments.to_a.flatten,
+            query: query.filter { |_k, v| !v.nil? }
+          ).to_s
+        end
+
+        def base_query(segment = nil)
+          [segment]
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/orders_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class OrdersEndpoint < MainEndpoint
+      private
+
+      def base_query(team_id, order_id = nil)
+        {
+          teams: team_id,
+          orders: order_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/payment_cards_endpoint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class PaymentCardsEndpoint < MainEndpoint
+      private
+
+      def base_query(card_id = nil, *_args)
+        {
+          payment_cards: card_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/project_comments_endpoint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class ProjectCommentsEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id)
+        {
+          projects: [project_id, :comments]
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/project_languages_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class ProjectLanguagesEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, language_id = nil)
+        {
+          projects: project_id,
+          languages: language_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/projects_endpoint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class ProjectsEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id = nil, action = nil)
+        {
+          projects: [project_id, action]
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/queued_processes_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class QueuedProcessesEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, process_id = nil)
+        {
+          projects: project_id,
+          processes: process_id
+        }
+      end
+    end
+  end
+end

data/lib/ruby_lokalise_api/endpoints/screenshots_endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RubyLokaliseApi
+  module Endpoints
+    class ScreenshotsEndpoint < MainEndpoint
+      private
+
+      def base_query(project_id, screenshots_id = nil)
+        {
+          projects: project_id,
+          screenshots: screenshots_id
+        }
+      end
+    end
+  end
+end