ruby-lokalise-api 4.2.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0736dd816b0cc92d92a04277d86aaec283aa9d7f7be024c736e1a6b4c91531c
-  data.tar.gz: 725e7262b0a226db6ae1d20d856eaac895ee11f5b39df15b3167a6b0db1984ec
+  metadata.gz: 1e1ed1ea503db64b5bf145288689885a365e35ba9520e692d65b51b311478fb5
+  data.tar.gz: b1636ef5cd3dafb7d1be6ca64ed6c6807c8f6f12f4383039d8312c4ce4f100b2
 SHA512:
-  metadata.gz: 94f10e17e3290f76b95fef30acddc5ab448dd27c064ea6e306fe69af621e2e25e63ed51fa2f919c6421df1eeea6a230b414054c9ceb23fb120aaa7d587b1c192
-  data.tar.gz: 31d41d8735f06151825eed3db874156ef78bec552e44cb8de8dcdd761878373ed5b6a3c745b918d6474262e681f9166c0e0d551d416254436464248e92821d8e
+  metadata.gz: 8141fe2f935cf0cc380f9824278235c5d6a0b12bd8daef9d6947556d0b73b9aa9d097f2c9e32833eb2c8261d84331ab476f7ef25b6c69965a2f8781bf3b284ff
+  data.tar.gz: 4bce32a0012e21830e45b12f58fb188395614a2dc64412c2c28fbd95bda4d8519565d0d38eebed1da9b6a2f7976bd0bc61ee28cb49fd466233b03d1843a90fb4

data/.github/CONTRIBUTING.md

@@ -4,7 +4,7 @@
 2. [Create a topic branch.][branch]
 3. Implement your feature or bug fix.
 4. Don't forget to add specs and make sure they pass by running `rspec .`.
-5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you. Run `rubocop -A` to make it more aggressive.
 6. If necessary, add documentation for your feature or bug fix.
 7. Commit and push your changes.
 8. [Submit a pull request.][pr]

data/README.md

@@ -7,7 +7,7 @@
 
 Official opinionated Ruby interface for the [Lokalise API](https://app.lokalise.com/api2docs/curl/) that represents returned data as Ruby objects.
 
-Looking for a Rails integration? Try the new [lokalise_rails gem](https://github.com/bodrovis/lokalise_rails).
+Looking for a Rails integration? Try the [lokalise_rails gem](https://github.com/bodrovis/lokalise_rails). Also you can use a [lokalise_manager gem](https://github.com/bodrovis/lokalise_manager) which allows to exchange translation files between Lokalise and *any* Ruby script.
 
 ## Quickstart
 
@@ -39,12 +39,20 @@ process = @client.upload_file project_id,
 process.status
 ```
 
+Alternatively instantiate your client with an [OAuth2 token](http://docs.lokalise.com/en/articles/5574713-oauth-2):
+
+```ruby
+@client = Lokalise.oauth_client 'YOUR_OAUTH_TOKEN_HERE'
+```
+
 ## Usage
 
 Detailed documentation can be found at [lokalise.github.io/ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api/).
 
+You can also check [this repo containing some usage examples](https://github.com/bodrovis-learning/Lokalise-APIv2-Samples) and [this blog post with explanations](https://lokalise.com/blog/lokalise-apiv2-in-practice).
+
 ## License
 
 This gem is licensed under the [BSD 3 Clause license](https://github.com/lokalise/ruby-lokalise-api/blob/master/LICENSE). Prior to version 4 the license type was MIT.
 
-Copyright (c) [Lokalise team](http://lokalise.co), [Ilya Bodrov](http://bodrovis.tech)
+Copyright (c) [Lokalise team](http://lokalise.co) and [Ilya Bodrov](http://bodrovis.tech)

data/lib/ruby-lokalise-api/client.rb

@@ -20,16 +20,20 @@ require 'ruby-lokalise-api/rest/translation_providers'
 require 'ruby-lokalise-api/rest/team_user_group'
 require 'ruby-lokalise-api/rest/custom_translation_statuses'
 require 'ruby-lokalise-api/rest/webhooks'
+require 'ruby-lokalise-api/rest/segments'
+require 'ruby-lokalise-api/rest/team_user_billing_details'
 
 module Lokalise
   class Client
-    attr_reader :token
-    attr_accessor :timeout, :open_timeout
+    attr_reader :token, :token_header
+    attr_accessor :timeout, :open_timeout, :enable_compression
 
     def initialize(token, params = {})
       @token = token
       @timeout = params.fetch(:timeout, nil)
       @open_timeout = params.fetch(:open_timeout, nil)
+      @enable_compression = params.fetch(:enable_compression, false)
+      @token_header = 'x-api-token'
     end
 
     # rubocop:disable Metrics/ParameterLists

data/lib/ruby-lokalise-api/collections/base.rb

@@ -3,6 +3,8 @@
 module Lokalise
   module Collections
     class Base
+      using Lokalise::Utils::StringUtils
+
       extend Lokalise::Request
       extend Lokalise::Utils::AttributeHelpers
       include Lokalise::Utils::AttributeHelpers
@@ -19,14 +21,8 @@ module Lokalise
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
-        # Project, team id, user id, and branch may not be present in some cases
-        @project_id = response['content']['project_id']
-        @team_id = response['content']['team_id']
-        @user_id = response['content']['user_id']
-        @branch = response['content']['branch']
         @request_params = params
-        @client = response['client']
-        @path = response['path']
+        popular_common_attrs response
       end
 
       class << self
@@ -90,6 +86,8 @@ module Lokalise
       # Dynamically produces collection of resources based on the given response
       # Collection example: `{ "content": {"comments": [ ... ]} }`
       def produce_collection_for(response)
+        return unless response['content']
+
         model_class = self.class.name.base_class_name
         data_key_plural = data_key_for model_class: model_class, plural: true, collection: true
 
@@ -101,6 +99,20 @@ module Lokalise
                                                                       'base_path' => response['path']
         end
       end
+
+      def popular_common_attrs(response)
+        @client = response['client']
+        @path = response['path']
+
+        return unless response['content']
+
+        content = response['content']
+        # Project, team id, user id, and branch may not be present in some cases
+        @project_id = content['project_id']
+        @team_id = content['team_id']
+        @user_id = content['user_id']
+        @branch = content['branch']
+      end
     end
   end
 end

data/lib/ruby-lokalise-api/collections/segment.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Lokalise
+  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/connection.rb

@@ -5,19 +5,25 @@ module Lokalise
     BASE_URL = 'https://api.lokalise.com/api2/'
 
     def connection(client)
-      options = {
+      Faraday.new(options(client), request_params_for(client)) do |faraday|
+        faraday.use(:gzip) if client.enable_compression
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def options(client)
+      {
         headers: {
           accept: 'application/json',
           user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}",
-          'x-api-token': client.token
+          client.token_header => client.token
         },
         url: BASE_URL
       }
-      Faraday.new(options, request_params_for(client)) { |faraday| faraday.adapter Faraday.default_adapter }
     end
 
-    private
-
     # Allows to customize request params per-client
     def request_params_for(client)
       {request: {timeout: client.timeout, open_timeout: client.open_timeout}}

data/lib/ruby-lokalise-api/data/attributes.json

@@ -134,6 +134,20 @@
     "created_at",
     "created_at_timestamp"
   ],
+  "segment": [
+    "segment_number",
+    "language_iso",
+    "modified_at",
+    "modified_at_timestamp",
+    "modified_by",
+    "modified_by_email",
+    "value",
+    "is_fuzzy",
+    "is_reviewed",
+    "reviewed_by",
+    "words",
+    "custom_translation_statuses"
+  ],
   "snapshot": [
     "snapshot_id",
     "title",
@@ -188,6 +202,18 @@
     "created_at_timestamp",
     "role"
   ],
+  "team_user_billing_details": [
+    "billing_email",
+    "country_code",
+    "zip",
+    "state_code",
+    "address1",
+    "address2",
+    "city",
+    "phone",
+    "company",
+    "vatnumber"
+  ],
   "team_user_group": [
     "group_id",
     "name",

data/lib/ruby-lokalise-api/error.rb

@@ -39,7 +39,8 @@ module Lokalise
     class << self
       # Create a new error from an HTTP response
       def from_response(body)
-        new body['error']['message'].to_s
+        msg = body.key?('error') ? body['error']['message'] : body['message']
+        new msg.to_s
       end
     end
 

data/lib/ruby-lokalise-api/oauth_client.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Lokalise
+  class OAuthClient < Client
+    def initialize(token, params = {})
+      super(token, params)
+      @token_header = 'Authorization'
+      @token = "Bearer #{@token}"
+    end
+  end
+end

data/lib/ruby-lokalise-api/request.rb

@@ -58,7 +58,8 @@ module Lokalise
     def respond_with(response, client)
       body = custom_load response.body
       uri = Addressable::URI.parse response.env.url
-      respond_with_error(response.status, body) if body.respond_to?(:has_key?) && body.key?('error')
+      status = response.status
+      respond_with_error status, body if status.between?(400, 599) || (body.respond_to?(:has_key?) && body.key?('error'))
       extract_headers_from(response).
         merge('content' => body,
               'client' => client,
@@ -74,7 +75,7 @@ module Lokalise
     end
 
     def respond_with_error(code, body)
-      raise(Lokalise::Error, body['error']) unless Lokalise::Error::ERRORS.key? code
+      raise(Lokalise::Error, body['error'] || body) unless Lokalise::Error::ERRORS.key? code
 
       raise Lokalise::Error::ERRORS[code].from_response(body)
     end

data/lib/ruby-lokalise-api/resources/base.rb

@@ -3,12 +3,14 @@
 module Lokalise
   module Resources
     class Base
+      using Lokalise::Utils::StringUtils
+
       extend Lokalise::Request
       extend Lokalise::Utils::AttributeHelpers
       include Lokalise::Utils::AttributeHelpers
       extend Lokalise::Utils::EndpointHelpers
 
-      attr_reader :raw_data, :project_id, :client, :path, :branch, :user_id, :team_id
+      attr_reader :raw_data, :project_id, :client, :path, :branch, :user_id, :team_id, :key_id
 
       # Initializes a new resource based on the response.
       # `endpoint_generator` is used in cases when a new instance is generated
@@ -107,10 +109,11 @@ module Lokalise
         end
 
         def produce_resource(model_class, response)
+          content = response['content']
           data_key_singular = data_key_for model_class: model_class
-          if response['content'].key? data_key_singular
-            data = response['content'].delete data_key_singular
-            response['content'].merge! data
+          if content.key? data_key_singular
+            data = content.delete data_key_singular
+            content.merge! data
           end
 
           new response
@@ -131,7 +134,7 @@ module Lokalise
 
       def path_with_id(response, id_key, data_key, endpoint_generator = nil)
         # Some resources do not have ids at all
-        return nil unless response['content'].key?(id_key) || response['content'].key?(data_key)
+        return unless response['content'] && (response['content'].key?(id_key) || response['content'].key?(data_key))
 
         # ID of the resource
         id = id_from response, id_key, data_key
@@ -155,15 +158,20 @@ module Lokalise
         # Content may be `{"project_id": '123', ...}` or {"snapshot": {"snapshot_id": '123', ...}}
         # Sometimes there is an `id_key` but it has a value of `null`
         # (for example when we do not place the actual order but only check its price).
+        # In rare cases the actual identifier does not have an "_id" suffix
+        # (for segments that have "segment_number" field instead)
         # Therefore we must explicitly check if the key is present
-        return response['content'][id_key] if response['content'].key?(id_key)
+        content = response['content']
+        return content[id_key] if content.respond_to?(:key?) && content&.key?(id_key)
 
-        response['content'][data_key][id_key]
+        content[data_key][id_key]
       end
 
       # Store all resources attributes under the corresponding instance variables.
       # `ATTRIBUTES` is defined inside resource-specific classes
       def populate_attributes_for(content)
+        return unless content
+
         data_key = data_key_for model_class: self.class.name.base_class_name
 
         self.class.const_get(:ATTRIBUTES).each do |attr|
@@ -181,10 +189,13 @@ module Lokalise
       # Some of them may be absent in certain cases.
       # rubocop:disable Naming/MemoizedInstanceVariableName
       def extract_common_attributes_for(content)
+        return unless content
+
         @raw_data = content
         @project_id ||= content['project_id']
         @user_id ||= content['user_id']
         @team_id ||= content['team_id']
+        @key_id ||= content['key_id']
         @branch ||= content['branch']
       end
       # rubocop:enable Naming/MemoizedInstanceVariableName

data/lib/ruby-lokalise-api/resources/branch.rb

@@ -3,10 +3,12 @@
 module Lokalise
   module Resources
     class Branch < Base
+      ID_KEY = 'branch_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       def merge(params = {})
-        self.class.merge @client, self.class.endpoint(project_id, branch_id, :merge), params
+        klass = self.class
+        klass.merge @client, klass.endpoint(project_id, branch_id, :merge), params
       end
 
       class << self

data/lib/ruby-lokalise-api/resources/contributor.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class Contributor < Base
-      ID_KEY = 'user'
+      ID_KEY = 'user_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/custom_translation_status.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class CustomTranslationStatus < Base
-      ID_KEY = 'status'
+      ID_KEY = 'status_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/key.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Key < Base
+      ID_KEY = 'key_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/key_comment.rb

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class KeyComment < Base
       DATA_KEY = 'Comment'
-      ID_KEY = 'comment'
+      ID_KEY = 'comment_id'
       supports :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/order.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Order < Base
+      ID_KEY = 'order_id'
       supports [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/payment_card.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class PaymentCard < Base
+      ID_KEY = 'card_id'
       supports :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/project.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Project < Base
+      ID_KEY = 'project_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       def empty

data/lib/ruby-lokalise-api/resources/project_comment.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class ProjectComment < Base
+      ID_KEY = 'comment_id'
       DATA_KEY = 'Comment'
     end
   end

data/lib/ruby-lokalise-api/resources/project_language.rb

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class ProjectLanguage < Base
       DATA_KEY = 'Language'
-      ID_KEY = 'lang'
+      ID_KEY = 'lang_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/queued_process.rb

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class QueuedProcess < Base
       DATA_KEY = 'Process'
-      ID_KEY = 'process'
+      ID_KEY = 'process_id'
       supports [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/screenshot.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Screenshot < Base
+      ID_KEY = 'screenshot_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/segment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Resources
+    class Segment < Base
+      DATA_KEY = 'Segment'
+      ID_KEY = 'segment_number'
+      supports :update, [:reload_data, '', :find]
+
+      class << self
+        def endpoint(project_id, key_id, lang_iso, segment_number = nil)
+          path_from projects: project_id,
+                    keys: key_id,
+                    segments: [lang_iso, segment_number]
+        end
+      end
+    end
+  end
+end

data/lib/ruby-lokalise-api/resources/snapshot.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Snapshot < Base
+      ID_KEY = 'snapshot_id'
       supports :destroy
 
       def restore

data/lib/ruby-lokalise-api/resources/task.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Task < Base
+      ID_KEY = 'task_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/team_user.rb

@@ -3,7 +3,7 @@
 module Lokalise
   module Resources
     class TeamUser < Base
-      ID_KEY = 'user'
+      ID_KEY = 'user_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/team_user_billing_details.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Lokalise
+  module Resources
+    class TeamUserBillingDetails < Base
+      class << self
+        def endpoint(team_id)
+          path_from teams: team_id,
+                    billing_details: ''
+        end
+      end
+    end
+  end
+end

data/lib/ruby-lokalise-api/resources/team_user_group.rb

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class TeamUserGroup < Base
       DATA_KEY = 'Group'
-      ID_KEY = 'group'
+      ID_KEY = 'group_id'
       supports :update, :destroy,
                [:add_projects, '/projects/add', :update],
                [:remove_projects, '/projects/remove', :update],

data/lib/ruby-lokalise-api/resources/translation.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Translation < Base
+      ID_KEY = 'translation_id'
       supports :update, [:reload_data, '', :find]
 
       class << self

data/lib/ruby-lokalise-api/resources/translation_provider.rb

@@ -4,7 +4,7 @@ module Lokalise
   module Resources
     class TranslationProvider < Base
       supports [:reload_data, '', :find]
-      ID_KEY = 'provider'
+      ID_KEY = 'provider_id'
 
       class << self
         def endpoint(team_id, provider_id = nil)

data/lib/ruby-lokalise-api/resources/webhook.rb

@@ -3,6 +3,7 @@
 module Lokalise
   module Resources
     class Webhook < Base
+      ID_KEY = 'webhook_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       def regenerate_secret

data/lib/ruby-lokalise-api/rest/segments.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Lokalise
+  class Client
+    # Returns all segments for the given key and language ISO code
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-list-all-segments-for-key-language-get
+    # @return [Lokalise::Collection::Segments<Lokalise::Resources::Segment>]
+    # @param project_id [String]
+    # @param key_id [String, Integer]
+    # @param lang_iso [String]
+    # @param params [Hash]
+    def segments(project_id, key_id, lang_iso, params = {})
+      c_r Lokalise::Collections::Segment, :all, [project_id, key_id, lang_iso], params
+    end
+
+    # Returns a segment under a given number for the given key and language ISO code
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-segment-for-key-language-get
+    # @return [Lokalise::Resources::Segment]
+    # @param project_id [String]
+    # @param key_id [String, Integer]
+    # @param lang_iso [String]
+    # @params segment_number [Integer, String]
+    # @param params [Hash]
+    def segment(project_id, key_id, lang_iso, segment_number, params = {})
+      c_r Lokalise::Resources::Segment, :find, [project_id, key_id, lang_iso, segment_number], params
+    end
+
+    # Updates a segment under a given number for the given key and language ISO code
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-update-a-segment-post
+    # @return [Lokalise::Resources::Segment]
+    # @param project_id [String]
+    # @param key_id [String, Integer]
+    # @param lang_iso [String]
+    # @params segment_number [Integer, String]
+    # @param params [Hash]
+    def update_segment(project_id, key_id, lang_iso, segment_number, params = {})
+      c_r Lokalise::Resources::Segment, :update, [project_id, key_id, lang_iso, segment_number], params
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/team_user_billing_details.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lokalise
+  class Client
+    # Returns team user billing details
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-retrieve-team-user-billing-details-get
+    # @return [Lokalise::Resources::TeamUserBillingDetails]
+    # @param team_id [String]
+    def team_user_billing_details(team_id)
+      c_r Lokalise::Resources::TeamUserBillingDetails, :find, team_id
+    end
+
+    # Creates team user billing details
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-team-user-billing-details-post
+    # @return [Lokalise::Resources::TeamUserBillingDetails]
+    # @param team_id [String]
+    # @param params [Hash]
+    def create_team_user_billing_details(team_id, params)
+      c_r Lokalise::Resources::TeamUserBillingDetails, :create, team_id, params
+    end
+
+    # Updates team user billing details
+    #
+    # @see https://app.lokalise.com/api2docs/curl/#transition-create-team-user-billing-details-post
+    # @return [Lokalise::Resources::TeamUserBillingDetails]
+    # @param team_id [String]
+    # @param params [Hash]
+    def update_team_user_billing_details(team_id, params)
+      c_r Lokalise::Resources::TeamUserBillingDetails, :update, team_id, params
+    end
+  end
+end