ruby-lokalise-api 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15e541afdd5e50a0e9317640b872bb04144dcaa717b2390887546b694e308fd
-  data.tar.gz: f34bb8a44f1e8552a0bc83b3f4c15d604500d56ecea503260d6423b047b36dcc
+  metadata.gz: 1e1ed1ea503db64b5bf145288689885a365e35ba9520e692d65b51b311478fb5
+  data.tar.gz: b1636ef5cd3dafb7d1be6ca64ed6c6807c8f6f12f4383039d8312c4ce4f100b2
 SHA512:
-  metadata.gz: dbbc75876ec0e0c9f5a611d54520585759d77cb4f13a81126d7f9a45c89852331801054ec973f94a6c0b4e58c0a8ea8c6cb88167e5b4a4b3ac9521531b911a87
-  data.tar.gz: 2687c66c1fb1ef0012cac50329b87a7c48118cff98a890e06b7764ccce828a850750b6896d5ace0a6810e8cebb86658bbd333794e6bc94cde725c957b1c968f6
+  metadata.gz: 8141fe2f935cf0cc380f9824278235c5d6a0b12bd8daef9d6947556d0b73b9aa9d097f2c9e32833eb2c8261d84331ab476f7ef25b6c69965a2f8781bf3b284ff
+  data.tar.gz: 4bce32a0012e21830e45b12f58fb188395614a2dc64412c2c28fbd95bda4d8519565d0d38eebed1da9b6a2f7976bd0bc61ee28cb49fd466233b03d1843a90fb4

data/README.md

@@ -49,6 +49,8 @@ Alternatively instantiate your client with an [OAuth2 token](http://docs.lokalis
 
 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.

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

@@ -20,6 +20,8 @@ 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

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,15 +21,8 @@ module Lokalise
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
-        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']
         @request_params = params
-        @client = response['client']
-        @path = response['path']
+        popular_common_attrs response
       end
 
       class << self
@@ -91,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
 
@@ -102,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/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/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
@@ -132,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
@@ -156,9 +158,11 @@ 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
         content = response['content']
-        return content[id_key] if content.key?(id_key)
+        return content[id_key] if content.respond_to?(:key?) && content&.key?(id_key)
 
         content[data_key][id_key]
       end
@@ -166,6 +170,8 @@ module Lokalise
       # 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|
@@ -183,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,6 +3,7 @@
 module Lokalise
   module Resources
     class Branch < Base
+      ID_KEY = 'branch_id'
       supports :update, :destroy, [:reload_data, '', :find]
 
       def merge(params = {})

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

data/lib/ruby-lokalise-api/utils/attribute_helpers.rb

@@ -3,6 +3,8 @@
 module Lokalise
   module Utils
     module AttributeHelpers
+      using Lokalise::Utils::StringUtils
+
       UNIFIED_RESOURCES = %w[comment language].freeze
 
       # Returns the name of the API resource for the given class.
@@ -40,7 +42,7 @@ module Lokalise
       # @return [String]
       # @param model_class [String]
       def id_key_for(model_class)
-        "#{get_key(name: 'ID_KEY', model_class: model_class)}_id"
+        get_key name: 'ID_KEY', model_class: model_class
       end
 
       # Loads attributes for the given resource based on its name

data/lib/ruby-lokalise-api/utils/string_utils.rb

@@ -3,25 +3,31 @@
 # Initial code taken from Facets gem by Rubyworks
 # https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
 
-class String
-  # Underscore a string such that camelcase, dashes and spaces are
-  # replaced by underscores.
-  def snakecase
-    base_class_name.
-      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
-      gsub(/([a-z\d])([A-Z])/, '\1_\2').
-      tr('-', '_').
-      gsub(/\s/, '_').
-      gsub(/__+/, '_').
-      downcase
-  end
+module Lokalise
+  module Utils
+    module StringUtils
+      refine String do
+        # Underscore a string such that camelcase, dashes and spaces are
+        # replaced by underscores.
+        def snakecase
+          base_class_name.
+            gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+            gsub(/([a-z\d])([A-Z])/, '\1_\2').
+            tr('-', '_').
+            gsub(/\s/, '_').
+            gsub(/__+/, '_').
+            downcase
+        end
 
-  # Turn `Module::Nested::ClassName` to just `ClassName`
-  def base_class_name
-    split('::').last
-  end
+        # Turn `Module::Nested::ClassName` to just `ClassName`
+        def base_class_name
+          split('::').last
+        end
 
-  def remove_trailing_slash
-    delete_suffix '/'
+        def remove_trailing_slash
+          delete_suffix '/'
+        end
+      end
+    end
   end
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lokalise
-  VERSION = '4.4.0'
+  VERSION = '4.5.0'
 end

data/lib/ruby-lokalise-api.rb

@@ -37,6 +37,8 @@ require 'ruby-lokalise-api/resources/translation_provider'
 require 'ruby-lokalise-api/resources/team_user_group'
 require 'ruby-lokalise-api/resources/custom_translation_status'
 require 'ruby-lokalise-api/resources/webhook'
+require 'ruby-lokalise-api/resources/segment'
+require 'ruby-lokalise-api/resources/team_user_billing_details'
 
 require 'ruby-lokalise-api/collections/base'
 require 'ruby-lokalise-api/collections/branch'
@@ -61,6 +63,7 @@ require 'ruby-lokalise-api/collections/translation_provider'
 require 'ruby-lokalise-api/collections/team_user_group'
 require 'ruby-lokalise-api/collections/custom_translation_status'
 require 'ruby-lokalise-api/collections/webhook'
+require 'ruby-lokalise-api/collections/segment'
 
 require 'ruby-lokalise-api/client'
 require 'ruby-lokalise-api/oauth_client'

data/ruby-lokalise-api.gemspec

@@ -5,7 +5,7 @@ require File.expand_path('lib/ruby-lokalise-api/version', __dir__)
 Gem::Specification.new do |spec|
   spec.name                  = 'ruby-lokalise-api'
   spec.version               = Lokalise::VERSION
-  spec.authors               = ['Ilya Bodrov']
+  spec.authors               = ['Ilya Bodrov-Krukowski']
   spec.email                 = ['golosizpru@gmail.com']
   spec.summary               = 'Ruby interface to the Lokalise API'
   spec.description           = 'Opinionated Ruby client for the Lokalise platform API allowing to work with translations, projects, users and other resources as with Ruby objects.'
@@ -22,19 +22,22 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths    = ['lib']
 
-  spec.add_dependency 'addressable',                   '~> 2.5'
-  spec.add_dependency 'faraday',                       '~> 1.0'
-  spec.add_dependency 'faraday_middleware',            '~> 1.0'
-  spec.add_dependency 'json',                          '>= 1.8.0'
+  spec.add_dependency 'addressable',                     '~> 2.5'
+  spec.add_dependency 'faraday',                         '~> 1.0'
+  spec.add_dependency 'faraday_middleware',              '~> 1.0'
+  spec.add_dependency 'json',                            '>= 1.8.0'
 
-  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'
-  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-rspec',             '~> 2.0'
-  spec.add_development_dependency 'simplecov',                 '~> 0.16'
-  spec.add_development_dependency 'vcr',                       '~> 6.0'
+  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'
+  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-rspec',       '~> 2.0'
+  spec.add_development_dependency 'simplecov',           '~> 0.16'
+  spec.add_development_dependency 'vcr',                 '~> 6.0'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

data/spec/lib/ruby-lokalise-api/rest/segments_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '39066161618d4ecb9fdc12.00274309' }
+  let(:key_id) { 129_358_815 }
+
+  describe '#segments' do
+    it 'returns all segments for a key under lang_iso' do
+      segments = VCR.use_cassette('all_key_segments') do
+        test_client.segments project_id, key_id, 'en'
+      end.collection
+
+      expect(segments.count).to eq(4)
+      expect(segments.first.value).to eq('Hello!')
+    end
+  end
+
+  describe '#segment' do
+    it 'returns a single segment' do
+      lang_iso = 'en'
+      segment_number = 2
+
+      segment = VCR.use_cassette('key_segment') do
+        test_client.segment project_id, key_id, lang_iso, segment_number
+      end
+
+      expect(segment.key_id).to eq(key_id)
+      expect(segment.segment_number).to eq(segment_number)
+      expect(segment.language_iso).to eq(lang_iso)
+      expect(segment.modified_at).to eq('2021-11-22 16:46:50 (Etc/UTC)')
+      expect(segment.modified_at_timestamp).to eq(1_637_599_610)
+      expect(segment.modified_by).to eq(20_181)
+      expect(segment.modified_by_email).to eq('bodrovis@protonmail.com')
+      expect(segment.value).to eq('This is just a simple text.')
+      expect(segment.is_fuzzy).to eq(false)
+      expect(segment.is_reviewed).to eq(false)
+      expect(segment.reviewed_by).to eq(0)
+      expect(segment.words).to eq(6)
+      expect(segment.custom_translation_statuses.first['color']).to eq('#61bd4f')
+    end
+
+    it 'allows to pass params' do
+      lang_iso = 'en'
+      segment_number = 2
+
+      segment = VCR.use_cassette('key_segment_params') do
+        test_client.segment project_id, key_id, lang_iso, segment_number, disable_references: '1'
+      end
+
+      expect(segment.segment_number).to eq(segment_number)
+      expect(segment.value).to eq('This is just a simple text.')
+      expect(segment.language_iso).to eq(lang_iso)
+    end
+  end
+
+  specify '#update_segment' do
+    lang_iso = 'en'
+    segment_number = 3
+
+    segment = VCR.use_cassette('update_key_segment') do
+      test_client.update_segment project_id, key_id, lang_iso, segment_number,
+                                 value: 'Updated via API',
+                                 is_reviewed: true
+    end
+
+    expect(segment.segment_number).to eq(segment_number)
+    expect(segment.value).to eq('Updated via API')
+    expect(segment.language_iso).to eq(lang_iso)
+  end
+
+  context 'when segment methods are chained' do
+    specify '#reload_data' do
+      lang_iso = 'en'
+      segment_number = 2
+
+      segment = VCR.use_cassette('key_segment') do
+        test_client.segment project_id, key_id, lang_iso, segment_number
+      end
+
+      reloaded_segment = VCR.use_cassette('reload_key_segment') do
+        segment.reload_data
+      end
+
+      expect(reloaded_segment.segment_number).to eq(segment_number)
+      expect(reloaded_segment.key_id).to eq(key_id)
+    end
+
+    specify '#update' do
+      lang_iso = 'en'
+      segment_number = 4
+
+      segment = VCR.use_cassette('another_key_segment') do
+        test_client.segment project_id, key_id, lang_iso, segment_number
+      end
+
+      updated_segment = VCR.use_cassette('update_key_segment_chained') do
+        segment.update value: 'Chain Updated',
+                       is_fuzzy: true
+      end
+
+      expect(updated_segment.segment_number).to eq(segment_number)
+      expect(updated_segment.is_fuzzy).to eq(true)
+      expect(updated_segment.value).to eq('Chain Updated')
+    end
+  end
+end

data/spec/lib/ruby-lokalise-api/rest/team_user_billing_details_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+RSpec.describe Lokalise::Client do
+  let(:team_id) { 176_692 }
+  let(:team_id2) { 273_879 }
+
+  specify '#team_user_billing_details' do
+    details = VCR.use_cassette('team_user_billing_details') do
+      test_client.team_user_billing_details team_id
+    end
+
+    expect(details.billing_email).to eq('hello@example.com')
+    expect(details.country_code).to eq('LV')
+    expect(details.zip).to eq('LV-6543')
+    expect(details.state_code).to eq('')
+    expect(details.address1).to eq('Sample line 1')
+    expect(details.address2).to eq('Sample line 2')
+    expect(details.city).to eq('Riga')
+    expect(details.phone).to eq('+371123456')
+    expect(details.company).to eq('Self-employed')
+    expect(details.vatnumber).to eq('123')
+  end
+
+  specify '#create_team_user_billing_details' do
+    details = VCR.use_cassette('create_team_user_billing_details') do
+      test_client.create_team_user_billing_details team_id2, billing_email: 'ruby@example.com',
+                                                             country_code: 'LV',
+                                                             zip: 'LV-1111'
+    end
+
+    expect(details.billing_email).to eq('ruby@example.com')
+    expect(details.country_code).to eq('LV')
+    expect(details.address1).to eq('')
+  end
+
+  specify '#update_team_user_billing_details' do
+    details = VCR.use_cassette('update_team_user_billing_details') do
+      test_client.update_team_user_billing_details team_id2, billing_email: 'ruby_rspec@example.com',
+                                                             country_code: 'LV',
+                                                             zip: 'LV-1111',
+                                                             address1: 'Addr line 1'
+    end
+
+    expect(details.billing_email).to eq('ruby_rspec@example.com')
+    expect(details.country_code).to eq('LV')
+    expect(details.address1).to eq('Addr line 1')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
-- Ilya Bodrov
+- Ilya Bodrov-Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -239,6 +239,7 @@ files:
 - lib/ruby-lokalise-api/collections/project_language.rb
 - lib/ruby-lokalise-api/collections/queued_process.rb
 - lib/ruby-lokalise-api/collections/screenshot.rb
+- lib/ruby-lokalise-api/collections/segment.rb
 - lib/ruby-lokalise-api/collections/snapshot.rb
 - lib/ruby-lokalise-api/collections/system_language.rb
 - lib/ruby-lokalise-api/collections/task.rb
@@ -268,11 +269,13 @@ files:
 - lib/ruby-lokalise-api/resources/project_language.rb
 - lib/ruby-lokalise-api/resources/queued_process.rb
 - lib/ruby-lokalise-api/resources/screenshot.rb
+- lib/ruby-lokalise-api/resources/segment.rb
 - lib/ruby-lokalise-api/resources/snapshot.rb
 - lib/ruby-lokalise-api/resources/system_language.rb
 - lib/ruby-lokalise-api/resources/task.rb
 - lib/ruby-lokalise-api/resources/team.rb
 - lib/ruby-lokalise-api/resources/team_user.rb
+- lib/ruby-lokalise-api/resources/team_user_billing_details.rb
 - lib/ruby-lokalise-api/resources/team_user_group.rb
 - lib/ruby-lokalise-api/resources/translation.rb
 - lib/ruby-lokalise-api/resources/translation_provider.rb
@@ -289,8 +292,10 @@ files:
 - lib/ruby-lokalise-api/rest/projects.rb
 - lib/ruby-lokalise-api/rest/queued_processes.rb
 - lib/ruby-lokalise-api/rest/screenshots.rb
+- lib/ruby-lokalise-api/rest/segments.rb
 - lib/ruby-lokalise-api/rest/snapshots.rb
 - lib/ruby-lokalise-api/rest/tasks.rb
+- lib/ruby-lokalise-api/rest/team_user_billing_details.rb
 - lib/ruby-lokalise-api/rest/team_user_group.rb
 - lib/ruby-lokalise-api/rest/team_users.rb
 - lib/ruby-lokalise-api/rest/teams.rb
@@ -317,15 +322,16 @@ files:
 - spec/lib/ruby-lokalise-api/rest/projects_spec.rb
 - spec/lib/ruby-lokalise-api/rest/queued_processes_spec.rb
 - spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/segments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb
 - spec/lib/ruby-lokalise-api/rest/tasks_spec.rb
+- spec/lib/ruby-lokalise-api/rest/team_user_billing_details_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_user_groups_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
 - spec/lib/ruby-lokalise-api/rest/teams_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translation_providers_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translations_spec.rb
 - spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb
-- spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
 - spec/lib/ruby-lokalise-api_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_client.rb
@@ -333,7 +339,8 @@ files:
 homepage: https://github.com/lokalise/ruby-lokalise-api
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -349,7 +356,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API
@@ -369,15 +376,16 @@ test_files:
 - spec/lib/ruby-lokalise-api/rest/projects_spec.rb
 - spec/lib/ruby-lokalise-api/rest/queued_processes_spec.rb
 - spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb
+- spec/lib/ruby-lokalise-api/rest/segments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb
 - spec/lib/ruby-lokalise-api/rest/tasks_spec.rb
+- spec/lib/ruby-lokalise-api/rest/team_user_billing_details_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_user_groups_spec.rb
 - spec/lib/ruby-lokalise-api/rest/team_users_spec.rb
 - spec/lib/ruby-lokalise-api/rest/teams_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translation_providers_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translations_spec.rb
 - spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb
-- spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
 - spec/lib/ruby-lokalise-api_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_client.rb

data/spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe String do
-  let(:snake_result) { 'snake_case' }
-  let(:bc_result) { 'Klass' }
-
-  specify '#snakecase' do
-    expect('SnakeCase'.snakecase).to eq snake_result
-    expect('Snake-Case'.snakecase).to eq snake_result
-    expect('Snake Case'.snakecase).to eq snake_result
-    expect('Snake  -  Case'.snakecase).to eq snake_result
-  end
-
-  specify '#base_class_name' do
-    expect('Namespace::Nested::Klass'.base_class_name).to eq bc_result
-    expect('Nested::Klass'.base_class_name).to eq bc_result
-    expect('Klass'.base_class_name).to eq bc_result
-  end
-end