ruby-lokalise-api 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99a57388157ac9dea3e17b78cf19b27ada718b172b9b5e91230e4b0772073f2
-  data.tar.gz: fff194faef3d317f122987fc866c9358f3169dbf8d5a1d52fdf5d810bff0cb84
+  metadata.gz: 5d5ba084b81ce5556b416a397dcd0cb7e848614e84560bd1ac970275351abc52
+  data.tar.gz: 7d4a692fa26ce75ec6a77ea83d8ddd450ff7f4da268000213493c5ec8d061d49
 SHA512:
-  metadata.gz: 478a91cc6130208809c783ac145270d89d3a059d76d9b011133a2e62b8b82bee8d9011004945cfb02b9cd950699f45d6354522281904aaf61b885935aee28dca
-  data.tar.gz: 15b10938bcfd13534fbcbea1f7f705b74b39e9f9c02895d413f9c859246a389b020ca4abd1d35c59078388564c7c22995bd558b47aad52b5e233229f34e4bec3
+  metadata.gz: 337aed88381630bf1f547dedd002e3081b3ee6100747ea74892cec4a368c559f70c3c008ab9925450ef9859db8f6ec25a00fc87813d74df19bc691eecbc2a34c
+  data.tar.gz: 55768797e44e4c7c416271eab0504cfb5ccb1655c7ae7f9f6f61ae49eb381c3bb49979f6e5fb9493c1fbcbe7d122fc1c8a934658f262ed31e37e2b662a36cbb0

data/README.md

@@ -22,7 +22,7 @@ Obtain an API token in your [personal profile](https://lokalise.com/profile#apit
 ```ruby
 require 'ruby-lokalise-api'
 
-@client = Lokalise.client 'YOUR_TOKEN_HERE'
+@client = RubyLokaliseApi.client 'YOUR_TOKEN_HERE'
 ```
 
 Now the `@client` can be used to perform API requests:
@@ -42,9 +42,11 @@ process.status
 Alternatively instantiate your client with an [OAuth2 token](http://docs.lokalise.com/en/articles/5574713-oauth-2):
 
 ```ruby
-@client = Lokalise.oauth2_client 'YOUR_OAUTH2_TOKEN_HERE'
+@client = RubyLokaliseApi.oauth2_client 'YOUR_OAUTH2_TOKEN_HERE'
 ```
 
+Learn how to generate an OAuth2 token [in the docs](https://lokalise.github.io/ruby-lokalise-api/additional_info/oauth2).
+
 ## Usage
 
 Detailed documentation can be found at [lokalise.github.io/ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api/).

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/base_request.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module BaseRequest
-    include Lokalise::JsonHandler
+    include RubyLokaliseApi::JsonHandler
 
     private
 
@@ -16,9 +16,9 @@ module Lokalise
     end
 
     def respond_with_error(code, body)
-      raise(Lokalise::Error, body['error'] || body) unless Lokalise::Error::ERRORS.key? code
+      raise(RubyLokaliseApi::Error, body['error'] || body) unless RubyLokaliseApi::Error::ERRORS.key? code
 
-      raise Lokalise::Error::ERRORS[code].from_response(body)
+      raise RubyLokaliseApi::Error::ERRORS[code].from_response(body)
     end
   end
 end

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/client.rb

@@ -1,30 +1,30 @@
 # frozen_string_literal: true
 
-require 'ruby-lokalise-api/rest/branches'
-require 'ruby-lokalise-api/rest/languages'
-require 'ruby-lokalise-api/rest/teams'
-require 'ruby-lokalise-api/rest/projects'
-require 'ruby-lokalise-api/rest/queued_processes'
-require 'ruby-lokalise-api/rest/comments'
-require 'ruby-lokalise-api/rest/keys'
-require 'ruby-lokalise-api/rest/contributors'
-require 'ruby-lokalise-api/rest/files'
-require 'ruby-lokalise-api/rest/translations'
-require 'ruby-lokalise-api/rest/team_users'
-require 'ruby-lokalise-api/rest/tasks'
-require 'ruby-lokalise-api/rest/snapshots'
-require 'ruby-lokalise-api/rest/screenshots'
-require 'ruby-lokalise-api/rest/orders'
-require 'ruby-lokalise-api/rest/payment_cards'
-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
+module RubyLokaliseApi
   class Client
+    include RubyLokaliseApi::Rest::Branches
+    include RubyLokaliseApi::Rest::Comments
+    include RubyLokaliseApi::Rest::Contributors
+    include RubyLokaliseApi::Rest::CustomTranslationStatuses
+    include RubyLokaliseApi::Rest::Files
+    include RubyLokaliseApi::Rest::Keys
+    include RubyLokaliseApi::Rest::Languages
+    include RubyLokaliseApi::Rest::Orders
+    include RubyLokaliseApi::Rest::PaymentCards
+    include RubyLokaliseApi::Rest::Projects
+    include RubyLokaliseApi::Rest::QueuedProcesses
+    include RubyLokaliseApi::Rest::Screenshots
+    include RubyLokaliseApi::Rest::Segments
+    include RubyLokaliseApi::Rest::Snapshots
+    include RubyLokaliseApi::Rest::Tasks
+    include RubyLokaliseApi::Rest::TeamUserBillingDetails
+    include RubyLokaliseApi::Rest::TeamUserGroups
+    include RubyLokaliseApi::Rest::TeamUsers
+    include RubyLokaliseApi::Rest::Teams
+    include RubyLokaliseApi::Rest::TranslationProviders
+    include RubyLokaliseApi::Rest::Translations
+    include RubyLokaliseApi::Rest::Webhooks
+
     attr_reader :token, :token_header
     attr_accessor :timeout, :open_timeout
 

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/base.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Base
-      using Lokalise::Utils::StringUtils
+      using RubyLokaliseApi::Utils::StringUtils
 
-      extend Lokalise::Request
-      extend Lokalise::Utils::AttributeHelpers
-      include Lokalise::Utils::AttributeHelpers
-      extend Lokalise::Utils::EndpointHelpers
+      extend RubyLokaliseApi::Request
+      extend RubyLokaliseApi::Utils::AttributeHelpers
+      include RubyLokaliseApi::Utils::AttributeHelpers
+      extend RubyLokaliseApi::Utils::EndpointHelpers
 
       attr_reader :total_pages, :total_results, :results_per_page, :current_page, :collection,
                   :project_id, :team_id, :request_params, :client, :path, :branch, :user_id
@@ -17,7 +17,7 @@ module Lokalise
       #
       # @param response [Hash]
       # @param params [Hash]
-      # @return [Lokalise::Collections::Base]
+      # @return [RubyLokaliseApi::Collections::Base]
       def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
@@ -94,9 +94,9 @@ module Lokalise
         # Fetch collection data and instantiate an individual resource for each object
         # We also preserve the `client` to be able to chain API methods later
         @collection = response['content'][data_key_plural].map do |raw_model|
-          Module.const_get("Lokalise::Resources::#{model_class}").new 'content' => raw_model,
-                                                                      'client' => response['client'],
-                                                                      'base_path' => response['path']
+          Module.const_get("RubyLokaliseApi::Resources::#{model_class}").new 'content' => raw_model,
+                                                                             'client' => response['client'],
+                                                                             'base_path' => response['path']
         end
       end
 

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/branch.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Branch < Base
       DATA_KEY_PLURAL = 'Branches'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/contributor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Contributor < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/custom_translation_status.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class CustomTranslationStatus < Base
       DATA_KEY_PLURAL = 'CustomTranslationStatuses'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class File < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/key.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Key < Base
       # Destroys all keys in the collection
       # @return [Hash]
       def destroy_all
         keys = collection.map(&:key_id)
-        Lokalise::Resources::Key.destroy @client, @path, keys: keys
+        RubyLokaliseApi::Resources::Key.destroy @client, @path, keys: keys
       end
 
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/key_comment.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class KeyComment < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/order.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Order < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/payment_card.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class PaymentCard < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/project.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Project < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/project_comment.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class ProjectComment < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/project_language.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class ProjectLanguage < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/queued_process.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class QueuedProcess < Base
       DATA_KEY_PLURAL = 'Processes'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/screenshot.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Screenshot < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/segment.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Segment < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/snapshot.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Snapshot < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/system_language.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class SystemLanguage < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/task.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Task < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/team.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Team < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/team_user.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class TeamUser < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/team_user_group.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class TeamUserGroup < Base
       DATA_KEY = 'UserGroup'

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/translation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Translation < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/translation_provider.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class TranslationProvider < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/collections/webhook.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Collections
     class Webhook < Base
       class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/connection.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   module Connection
     BASE_URL = 'https://api.lokalise.com/api2/'
 
@@ -17,7 +17,7 @@ module Lokalise
       {
         headers: {
           accept: 'application/json',
-          user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}",
+          user_agent: "ruby-lokalise-api gem/#{RubyLokaliseApi::VERSION}",
           accept_encoding: 'gzip,deflate,br',
           client.token_header => client.token
         },

data/lib/ruby_lokalise_api/data/attributes.yml

@@ -0,0 +1,235 @@
+branch:
+  - branch_id
+  - name
+  - created_at
+  - created_at_timestamp
+  - created_by
+  - created_by_email
+comment:
+  - comment_id
+  - key_id
+  - comment
+  - added_by
+  - added_by_email
+  - added_at
+  - added_at_timestamp
+contributor:
+  - user_id
+  - email
+  - fullname
+  - created_at
+  - created_at_timestamp
+  - is_admin
+  - is_reviewer
+  - languages
+  - admin_rights
+custom_translation_status:
+  - status_id
+  - title
+  - color
+file:
+  - filename
+  - key_count
+key:
+  - key_id
+  - created_at
+  - created_at_timestamp
+  - key_name
+  - filenames
+  - description
+  - platforms
+  - tags
+  - comments
+  - screenshots
+  - translations
+  - is_plural
+  - plural_name
+  - is_hidden
+  - is_archived
+  - context
+  - base_words
+  - char_limit
+  - custom_attributes
+  - modified_at
+  - modified_at_timestamp
+  - translations_modified_at
+  - translations_modified_at_timestamp
+language:
+  - lang_id
+  - lang_iso
+  - lang_name
+  - is_rtl
+  - plural_forms
+order:
+  - order_id
+  - project_id
+  - card_id
+  - status
+  - created_at
+  - created_at_timestamp
+  - created_by
+  - created_by_email
+  - source_language_iso
+  - target_language_isos
+  - keys
+  - source_words
+  - provider_slug
+  - translation_style
+  - translation_tier
+  - translation_tier_name
+  - briefing
+  - total
+  - payment_method
+  - dry_run
+payment_card:
+  - card_id
+  - last4
+  - brand
+  - created_at
+  - created_at_timestamp
+project:
+  - project_id
+  - name
+  - description
+  - created_at
+  - created_at_timestamp
+  - created_by
+  - created_by_email
+  - team_id
+  - base_language_id
+  - base_language_iso
+  - settings
+  - statistics
+queued_process:
+  - process_id
+  - type
+  - status
+  - message
+  - created_by
+  - created_by_email
+  - created_at
+  - created_at_timestamp
+  - details
+screenshot:
+  - screenshot_id
+  - key_ids
+  - url
+  - title
+  - description
+  - screenshot_tags
+  - width
+  - height
+  - 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
+  - created_at
+  - created_at_timestamp
+  - created_by
+  - created_by_email
+task:
+  - task_id
+  - title
+  - description
+  - status
+  - progress
+  - due_date
+  - due_date_timestamp
+  - keys_count
+  - words_count
+  - created_at
+  - created_at_timestamp
+  - created_by
+  - created_by_email
+  - can_be_parent
+  - task_type
+  - parent_task_id
+  - closing_tags
+  - do_lock_translations
+  - languages
+  - auto_close_languages
+  - auto_close_task
+  - auto_close_items
+  - completed_at
+  - completed_at_timestamp
+  - completed_by
+  - completed_by_email
+  - custom_translation_status_ids
+team:
+  - team_id
+  - name
+  - created_at
+  - created_at_timestamp
+  - plan
+  - quota_usage
+  - quota_allowed
+team_user:
+  - user_id
+  - email
+  - fullname
+  - created_at
+  - 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
+  - permissions
+  - created_at
+  - created_at_timestamp
+  - team_id
+  - projects
+  - members
+translation:
+  - translation_id
+  - key_id
+  - language_iso
+  - modified_at
+  - modified_at_timestamp
+  - modified_by
+  - modified_by_email
+  - translation
+  - is_fuzzy
+  - is_reviewed
+  - words
+  - custom_translation_statuses
+  - task_id
+translation_provider:
+  - provider_id
+  - name
+  - slug
+  - price_pair_min
+  - website_url
+  - description
+  - tiers
+  - pairs
+webhook:
+  - webhook_id
+  - url
+  - secret
+  - events
+  - event_lang_map

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Lokalise
+module RubyLokaliseApi
   class Error < StandardError
     ClientError = Class.new(self)
     ServerError = Class.new(self)
@@ -21,19 +21,19 @@ module Lokalise
     GatewayTimeout = Class.new(ServerError)
 
     ERRORS = {
-      400 => Lokalise::Error::BadRequest,
-      401 => Lokalise::Error::Unauthorized,
-      403 => Lokalise::Error::Forbidden,
-      404 => Lokalise::Error::NotFound,
-      405 => Lokalise::Error::MethodNotAllowed,
-      406 => Lokalise::Error::NotAcceptable,
-      409 => Lokalise::Error::Conflict,
-      423 => Lokalise::Error::Locked,
-      429 => Lokalise::Error::TooManyRequests,
-      500 => Lokalise::Error::ServerError,
-      502 => Lokalise::Error::BadGateway,
-      503 => Lokalise::Error::ServiceUnavailable,
-      504 => Lokalise::Error::GatewayTimeout
+      400 => RubyLokaliseApi::Error::BadRequest,
+      401 => RubyLokaliseApi::Error::Unauthorized,
+      403 => RubyLokaliseApi::Error::Forbidden,
+      404 => RubyLokaliseApi::Error::NotFound,
+      405 => RubyLokaliseApi::Error::MethodNotAllowed,
+      406 => RubyLokaliseApi::Error::NotAcceptable,
+      409 => RubyLokaliseApi::Error::Conflict,
+      423 => RubyLokaliseApi::Error::Locked,
+      429 => RubyLokaliseApi::Error::TooManyRequests,
+      500 => RubyLokaliseApi::Error::ServerError,
+      502 => RubyLokaliseApi::Error::BadGateway,
+      503 => RubyLokaliseApi::Error::ServiceUnavailable,
+      504 => RubyLokaliseApi::Error::GatewayTimeout
     }.freeze
 
     class << self

data/lib/{ruby-lokalise-api → ruby_lokalise_api}/json_handler.rb

@@ -2,7 +2,7 @@
 
 require 'json'
 
-module Lokalise
+module RubyLokaliseApi
   module JsonHandler
     # JSON custom parser. Uses built-in JSON by default but can be overridden to any other parser