ruby-lokalise-api 8.0.0.rc1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f5c5e9ee2007a925415b1b823a2d1292c2875a4745faf226090796b4762d40
-  data.tar.gz: 95adfa6da4239686f103ead65616d29d2ad96f4c3df25c402aeb21a0dc120baf
+  metadata.gz: 95932448d2e531abc5dc2f30a4b7f1052fa9ba7b37a80e57a46117ac7102c453
+  data.tar.gz: d5101a2713268265021177c3bcb1eaa1adcfaaa2afe605d87747d55a5c4a6ec0
 SHA512:
-  metadata.gz: 6b8b417199e57e73453a065707529422f4cdcd4b4f173138b01fed63ecc404bf7df9c78c374da40fa4551174406369c7c2b213d2dd557c9465874c15ac87c598
-  data.tar.gz: bfba53bd1b7e8a65bb8e778de4f379f05a4415a43bf16405b2af7f2e6fdece3adacac4a086e20d029523a196248adbaaca04e9ebc71c40fe3a9775cf945c75f8
+  metadata.gz: 64d290aa2c9844f3e8db8099968104845f7f7b7a52c96843b7f400124819031c3021acec02a318004079548b2666e3253cae845d447825cb5acf04d7cee43234
+  data.tar.gz: f2790492035aa26cd353372008fe8b4d41cecd47382700ec339e57d443cb5e637be24dc299ea7a1c9898f5c2446722a5709e79e684c081b1ee730d595788fb5e

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

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/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.0'
 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.0
 platform: ruby
 authors:
 - Ilya Krukowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-20 00:00:00.000000000 Z
+date: 2023-07-21 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.17
 signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API