ruby-lokalise-api 8.0.0.rc1 → 8.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f5c5e9ee2007a925415b1b823a2d1292c2875a4745faf226090796b4762d40
-  data.tar.gz: 95adfa6da4239686f103ead65616d29d2ad96f4c3df25c402aeb21a0dc120baf
+  metadata.gz: b9dd635ba92d1885a962876708929e92b3d4cf27da08281d37d001090b26059e
+  data.tar.gz: 4360d59c199a2f166fc1ea0a7d6cbe767ff9fef1ad4915c7ea432fe96a5520a6
 SHA512:
-  metadata.gz: 6b8b417199e57e73453a065707529422f4cdcd4b4f173138b01fed63ecc404bf7df9c78c374da40fa4551174406369c7c2b213d2dd557c9465874c15ac87c598
-  data.tar.gz: bfba53bd1b7e8a65bb8e778de4f379f05a4415a43bf16405b2af7f2e6fdece3adacac4a086e20d029523a196248adbaaca04e9ebc71c40fe3a9775cf945c75f8
+  metadata.gz: d5dc497254da7a8b9d887f449880a37c5d3ab71054a23d07aac90cdedb27896103b3ed907fda102c0785da068bc50dccce1b8f1723a0a71c78bb9c6896347fb7
+  data.tar.gz: de6153458925151cfd3ee5640d8dbea226877ba89698faf2e6320776340e5dafd37bb62e8297f04377e50918fdaa40c698020aa0f098466a488410f2fb3ffba3

data/README.md

@@ -2,6 +2,7 @@
 
 ![Gem](https://img.shields.io/gem/v/ruby-lokalise-api)
 ![CI](https://github.com/lokalise/ruby-lokalise-api/actions/workflows/ci.yml/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/lokalise/ruby-lokalise-api/badge.svg?branch=master)](https://coveralls.io/github/lokalise/ruby-lokalise-api?branch=master)
 ![Downloads total](https://img.shields.io/gem/dt/ruby-lokalise-api)
 
 Official opinionated Ruby interface for the [Lokalise API](https://developers.lokalise.com/reference/lokalise-rest-api) that represents returned data as Ruby objects.

data/lib/ruby_lokalise_api/base_client.rb

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

data/lib/ruby_lokalise_api/client.rb

@@ -3,8 +3,6 @@
 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(token, params)
 

data/lib/ruby_lokalise_api/concerns/attrs_loadable.rb

@@ -2,6 +2,7 @@
 
 module RubyLokaliseApi
   module Concerns
+    # Allows to set supported attributes for classes
     module AttrsLoadable
       class << self
         def extended(klass)

data/lib/ruby_lokalise_api/connection.rb

@@ -3,10 +3,9 @@
 module RubyLokaliseApi
   # Module to setup connection using Faraday
   module Connection
-
     # Creates a new Faraday object with specified params
-    def connection(endpoint)
-      Faraday.new(options(endpoint), request_params_for(endpoint.client)) do |faraday|
+    def connection(endpoint, params = {})
+      Faraday.new(options(endpoint, params), request_params_for(endpoint.client)) do |faraday|
         faraday.adapter Faraday.default_adapter
         faraday.request(:gzip)
       end
@@ -14,16 +13,21 @@ module RubyLokaliseApi
 
     private
 
-    def options(endpoint)
-      params = __base_options(endpoint)
+    def options(endpoint, params)
+      req_params = __base_options(endpoint)
       client = endpoint.client
 
       if client.respond_to?(:token) && client.respond_to?(:token_header)
-        params[:headers][client.token_header] = client.token
+        req_params[:headers][client.token_header] = client.token
       end
-      params[:headers][:accept_encoding] = 'gzip,deflate,br'
 
-      params
+      # Sending content-type is needed only when the body is actually present
+      # Trying to send this header in other cases seems to result in error 500
+      req_params[:headers]['Content-type'] = 'application/json' if !params[:get_request] && endpoint.req_params
+
+      req_params[:headers][:accept_encoding] = 'gzip,deflate,br'
+
+      req_params
     end
 
     def __base_options(endpoint)

data/lib/ruby_lokalise_api/endpoints/base_endpoint.rb

@@ -10,6 +10,7 @@ module RubyLokaliseApi
 
       BASE_URL = ''
       PARTIAL_URI_TEMPLATE = '{/segments*}'
+      HTTP_METHODS = %i[get post put delete patch].freeze
 
       def initialize(client, params = {})
         @query_params = params[:query].to_array
@@ -34,24 +35,16 @@ module RubyLokaliseApi
         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
+      # Creates methods like `do_post`, `do_get` that proxy calls to the
+      # corresponding methods in the `Request` module
+      HTTP_METHODS.each do |method_postfix|
+        define_method "do_#{method_postfix}" do
+          send method_postfix, self
         end
       end
 
+      private
+
       def base_query(*_args); end
 
       def partial_uri(*_args)

data/lib/ruby_lokalise_api/oauth2/auth.rb

@@ -2,6 +2,7 @@
 
 module RubyLokaliseApi
   module OAuth2
+    # This class defines OAuth2 flow
     class Auth
       attr_reader :client_id, :client_secret, :timeout, :open_timeout
 
@@ -14,10 +15,17 @@ module RubyLokaliseApi
         @open_timeout = params[:open_timeout]
       end
 
+      # Returns OAuth2 endpoint URI
       def oauth2_endpoint
         self.class.const_get(:OAUTH2_ENDPOINT)
       end
 
+      # Builds an OAuth2 link that customers have to visit
+      # in order to obtain a special code
+      # @return [String]
+      # @param scope [Array, String]
+      # @param redirect_uri [String]
+      # @param state [String]
       def auth(scope:, redirect_uri: nil, state: nil)
         get_params = {
           client_id: client_id,
@@ -29,6 +37,10 @@ module RubyLokaliseApi
         oauth2_endpoint.new(self, query: 'auth', get: get_params).full_uri
       end
 
+      # Requests OAuth2 access token. Requires OAuth2 code obtained
+      # using the `.auth` method
+      # @return [RubyLokaliseApi::Resources::OAuth2Token]
+      # @param code [String]
       def token(code)
         endpoint = oauth2_endpoint.new(
           self,
@@ -42,6 +54,9 @@ module RubyLokaliseApi
         RubyLokaliseApi::Resources::OAuth2Token.new endpoint.do_post
       end
 
+      # Refreshes expired OAuth2 access token.
+      # @return [RubyLokaliseApi::Resources::OAuth2RefreshedToken]
+      # @param refresh_token [String]
       def refresh(refresh_token)
         endpoint = oauth2_endpoint.new(
           self,

data/lib/ruby_lokalise_api/oauth2_client.rb

@@ -3,8 +3,6 @@
 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, params)
       @token_header = 'Authorization'

data/lib/ruby_lokalise_api/request.rb

@@ -9,7 +9,7 @@ module RubyLokaliseApi
     # Sends a GET request
     def get(endpoint)
       respond_with(
-        connection(endpoint).get(prepare(endpoint.uri), endpoint.req_params),
+        connection(endpoint, get_request: true).get(prepare(endpoint.uri), endpoint.req_params),
         endpoint
       )
     end

data/lib/ruby_lokalise_api/utils/classes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
+  # Basic utilitiy methods
   module Utils
     module Classes
       refine Object do
@@ -9,10 +10,13 @@ module RubyLokaliseApi
           name.split('::').last
         end
 
+        # Converts object to array unless it is already an array
         def to_array
           is_a?(Array) ? self : [self]
         end
 
+        # Converts object to array and then places this array
+        # inside hash under the provided key
         def to_array_obj(key)
           return self if is_a?(Hash) && (key?(key) || key?(key.to_s))
 

data/lib/ruby_lokalise_api/utils/keys.rb

@@ -5,6 +5,8 @@ module RubyLokaliseApi
     module Keys
       using RubyLokaliseApi::Utils::Strings
 
+      # Reads DATA_KEY for resources. DATA_KEY specifies the name of the key
+      # in the API response that contains the actual data
       def data_key_for(klass:)
         key = if Module.const_defined? "RubyLokaliseApi::Resources::#{klass}::DATA_KEY"
                 Module.const_get "RubyLokaliseApi::Resources::#{klass}::DATA_KEY"
@@ -15,6 +17,8 @@ module RubyLokaliseApi
         key.snakecase
       end
 
+      # Reads DATA_KEY for collections. DATA_KEY specifies the name of the key
+      # in the API response that contains the actual data
       def collection_key_for(klass:)
         key = if Module.const_defined?("RubyLokaliseApi::Collections::#{klass}::DATA_KEY")
                 Module.const_get("RubyLokaliseApi::Collections::#{klass}::DATA_KEY")

data/lib/ruby_lokalise_api/utils/loaders.rb

@@ -5,16 +5,19 @@ module RubyLokaliseApi
     module Loaders
       private
 
+      # Instantiates an endpoint
       def endpoint(name:, client: self, params: {})
         klass = RubyLokaliseApi.const_get "Endpoints::#{name}Endpoint"
         klass.new client, params
       end
 
+      # Instantiates a resource
       def resource(name, data)
         klass = RubyLokaliseApi.const_get "Resources::#{name}"
         klass.new data
       end
 
+      # Instantiates a collection
       def collection(name, data)
         klass = RubyLokaliseApi.const_get "Collections::#{name}"
         klass.new data

data/lib/ruby_lokalise_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyLokaliseApi
-  VERSION = '8.0.0.rc1'
+  VERSION = '8.0.1'
 end

data/ruby-lokalise-api.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable',                     '~> 2.5'
   spec.add_dependency 'faraday',                         '~> 2.0'
-  spec.add_dependency 'faraday-gzip',                    '>= 0.1', '< 2.0'
+  spec.add_dependency 'faraday-gzip',                    '~> 2.0'
   spec.add_dependency 'json',                            '~> 2'
   spec.add_dependency 'zeitwerk',                        '~> 2.4'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 8.0.0.rc1
+  version: 8.0.1
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-20 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -42,20 +42,14 @@ dependencies:
   name: faraday-gzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -399,11 +393,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API