ruby-lokalise-api 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caa20ece7cfd9bbf173ddd4213d6e30b67bec03a78a28188f473414eea7ae42a
-  data.tar.gz: 99069ccfa82ca5cebd820de4da81d9215d24341899862ad8c2b21c52500d5fa7
+  metadata.gz: ebd0d7d723970806d7d8078803ada29e359b90f6248a34fb17176b55f977f39b
+  data.tar.gz: 5cbc279f312e4021ed6e6028e843013507aad310cc76f3376a206a65ea391726
 SHA512:
-  metadata.gz: fb97f63d412ac981efa9f2b3302b740dbc7ae25a93f6a4637a4e6706f8b5150bfd249915bd80b6279249f4e9298da61d29d53855228b73bdce19206adbef3cef
-  data.tar.gz: 5ee66d9e5bd269c7c0cfefa8e73e34601ff18cf487cf623373240ee4b49344a88991cb4cee91f1250944ec14a0c63491e68cf7aa2f893d462c28fb6213b3ea8d
+  metadata.gz: 99ce24c8248ed892d0a37688a7df26ba661a017be9630f22cac528be128172684e8e3ecc9022d4a94897ef5b2b2fe3cb21182be7b3778eb8f8d8a773984e4b32
+  data.tar.gz: 4688f964ff6d8f9dccede52a9bf9f8e40a31e3674242d49f1329373ca271bb25cd7b1cd204805e9799982028afebf8e97a0ea4a92a7b8f99acbd4a02105c5d17

data/CHANGELOG.md

@@ -1,8 +1,13 @@
 # Changelog
 
+## 2.5.0 (01-Aug-19)
+
+* Added `:timeout` and `:open_timeout` options for the client [to customize request timeouts](https://github.com/lokalise/ruby-lokalise-api#setting-timeouts)
+* [Added explanations](https://github.com/lokalise/ruby-lokalise-api#choosing-adapter) on how to change a default adapter
+
 ## 2.4.0 (31-Jul-19)
 
-* Remove MultiJson dependency and allow to use a custom JSON parser
+* Remove MultiJson dependency and allow to use a [custom JSON parser](https://github.com/lokalise/ruby-lokalise-api#customizing-json-parser)
 
 ## 2.3.0 (17-Jul-19)
 

data/README.md

@@ -31,6 +31,7 @@ Official opinionated Ruby interface for the [Lokalise API](https://lokalise.co/a
   + [Translation Providers](#translation-providers)
   + [Translation Statuses](#translation-statuses)
 * [Additional Info](#additional-info)
+  + [Customizing request](#customizing-request)
   + [Customizing JSON parser](#customizing-json-parser)
   + [Error handling](#error-handling)
   + [API Rate Limits](#api-rate-limits)
@@ -60,7 +61,7 @@ require 'ruby-lokalise-api'
 @client = Lokalise.client 'YOUR_TOKEN_HERE'
 ```
 
-Now the `@client` can be used to perform API requests!
+Now the `@client` can be used to perform API requests! Learn more about additional options in the [Customizing request section](#customizing-request).
 
 ### Objects and models
 
@@ -1470,6 +1471,41 @@ As long as Lokalise supports only very limited array of color hexadecimal codes
 
 ## Additional Info
 
+### Customizing Request
+
+#### Choosing Adapter
+
+This library utilizes [Faraday](https://lostisland.github.io/faraday) to perform requests. The default adapter is built-in [Net::HTTP](https://ruby-doc.org/stdlib-2.6.3/libdoc/net/http/rdoc/Net/HTTP.html) but you may customize it as needed.
+
+For example, to use [Excon](https://github.com/excon/excon):
+
+```ruby
+require 'excon' # somewhere in your code
+
+Faraday.default_adapter = :excon
+```
+
+All supported adapters are listed [on Faraday official website](https://lostisland.github.io/faraday/adapters/).
+
+#### Setting Timeouts
+
+Request timeouts may be adjusted during client initialization:
+
+```ruby
+@client = Lokalise.client('YOUR_TOKEN', open_timeout: 100, timeout: 500)
+@client.open_timeout # => 100
+@client.timeout # => 500
+```
+
+Both values are in *seconds*. They can be adjusted later with simple accessors:
+
+```ruby
+@client.open_timeout = 200
+@client.timeout = 600
+@client.open_timeout # => 200
+@client.timeout # => 600
+```
+
 ### Customizing JSON parser
 
 This gem used to rely on [MultiJson](https://github.com/intridea/multi_json) but it is not maintained anymore. By default we are using a [built-in JSON module](https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html) but you may utilize any other parser by overriding `#custom_dump` and `#custom_load` methods inside `Lokalise::JsonHandler` module.

data/lib/ruby-lokalise-api.rb

@@ -60,8 +60,10 @@ module Lokalise
     # Initializes a new Client object
     #
     # @return [Lokalise::Client]
-    def client(token)
-      @client ||= Lokalise::Client.new token
+    # @param token [String]
+    # @param params [Hash]
+    def client(token, params = {})
+      @client ||= Lokalise::Client.new token, params
     end
 
     # Reset the currently set client

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

@@ -19,9 +19,12 @@ require 'ruby-lokalise-api/rest/custom_translation_statuses'
 module Lokalise
   class Client
     attr_reader :token
+    attr_accessor :timeout, :open_timeout
 
-    def initialize(token)
+    def initialize(token, params = {})
       @token = token
+      @timeout = params.fetch(:timeout) { nil }
+      @open_timeout = params.fetch(:open_timeout) { nil }
     end
 
     def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil)

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

@@ -2,16 +2,22 @@ module Lokalise
   module Connection
     BASE_URL = 'https://api.lokalise.co/api2/'.freeze
 
-    def connection(token)
+    def connection(client)
       options = {
         headers: {
           accept: 'application/json',
           user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}",
-          'x-api-token': token
+          'x-api-token': client.token
         },
         url: BASE_URL
       }
-      Faraday.new(options) { |faraday| faraday.adapter Faraday.default_adapter }
+      Faraday.new(options, request_params_for(client)) { |faraday| faraday.adapter Faraday.default_adapter }
+    end
+
+    private
+
+    def request_params_for(client)
+      {request: {timeout: client.timeout, open_timeout: client.open_timeout}}
     end
   end
 end

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

@@ -7,21 +7,21 @@ module Lokalise
 
     def get(path, client, params = {})
       respond_with(
-        connection(client.token).get(prepare(path), params),
+        connection(client).get(prepare(path), params),
         client
       )
     end
 
     def post(path, client, params = {})
       respond_with(
-        connection(client.token).post(prepare(path), custom_dump(params)),
+        connection(client).post(prepare(path), custom_dump(params)),
         client
       )
     end
 
     def put(path, client, params = {})
       respond_with(
-        connection(client.token).put(prepare(path), custom_dump(params)),
+        connection(client).put(prepare(path), custom_dump(params)),
         client
       )
     end
@@ -30,7 +30,7 @@ module Lokalise
       respond_with(
         # Rubocop tries to replace `delete` with `gsub` but that's a different method here!
         # rubocop:disable Style/CollectionMethods
-        connection(client.token).delete(prepare(path)) do |req|
+        connection(client).delete(prepare(path)) do |req|
           # rubocop:enable Style/CollectionMethods
           req.body = custom_dump params
         end,

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

@@ -1,3 +1,3 @@
 module Lokalise
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/spec/lib/ruby-lokalise-api/connection_spec.rb

@@ -0,0 +1,41 @@
+RSpec.describe Lokalise::Connection do
+  include described_class
+
+  before(:each) { Lokalise.reset_client! }
+  after(:all) do
+    Lokalise.reset_client!
+    Faraday.default_adapter = :net_http
+  end
+
+  it 'timeouts should not be set by default but the token must be present' do
+    conn = connection test_client
+    expect(conn.options.timeout).to be_nil
+    expect(conn.options.open_timeout).to be_nil
+    expect(conn.headers['X-api-token']).to eq(test_client.token)
+  end
+
+  it 'should allow to customize timeouts' do
+    custom_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'],
+                                    open_timeout: 100, timeout: 500)
+    conn = connection custom_client
+    expect(conn.options.timeout).to eq(500)
+    expect(conn.options.open_timeout).to eq(100)
+    expect(conn.headers['X-api-token']).to eq(custom_client.token)
+
+    custom_client.timeout = 300
+    custom_client.open_timeout = 200
+    another_conn = connection custom_client
+    expect(another_conn.options.timeout).to eq(300)
+    expect(another_conn.options.open_timeout).to eq(200)
+  end
+
+  it 'should be possible to customize adapter' do
+    conn = connection test_client
+    expect(conn.builder.handlers).to eq([Faraday::Adapter::NetHttp])
+
+    Faraday.default_adapter = :excon
+
+    another_conn = connection test_client
+    expect(another_conn.builder.handlers).to eq([Faraday::Adapter::Excon])
+  end
+end

data/spec/lib/ruby-lokalise-api/error_spec.rb

@@ -1,9 +1,8 @@
-# TODO: rewrite with raw `get` method
 RSpec.describe Lokalise::Error do
   include Lokalise::Request
 
   before(:each) { Lokalise.reset_client! }
-  after(:each) { Lokalise.reset_client! }
+  after(:all) { Lokalise.reset_client! }
 
   it 'should raise BadRequest when API token is invalid' do
     expect do

data/spec/lib/ruby-lokalise-api_spec.rb

@@ -2,6 +2,8 @@ RSpec.describe Lokalise do
   specify '.client' do
     expect(test_client).to be_an_instance_of(Lokalise::Client)
     expect(test_client.token).to eq(ENV['LOKALISE_API_TOKEN'])
+    expect(test_client.timeout).to be_nil
+    expect(test_client.open_timeout).to be_nil
   end
 
   specify '.reset_client!' do
@@ -10,4 +12,19 @@ RSpec.describe Lokalise do
     current_client = Lokalise.instance_variable_get '@client'
     expect(current_client).to be_nil
   end
+
+  context 'client params' do
+    before(:each) { Lokalise.reset_client! }
+    after(:all) { Lokalise.reset_client! }
+
+    it 'should be possible to customize timeout' do
+      custom_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'], timeout: 600)
+      expect(custom_client.timeout).to eq(600)
+    end
+
+    it 'should be possible to customize open timeout' do
+      custom_client = Lokalise.client(ENV['LOKALISE_API_TOKEN'], open_timeout: 100)
+      expect(custom_client.open_timeout).to eq(100)
+    end
+  end
 end

data/spec/support/test_client.rb

@@ -1,5 +1,5 @@
 module TestClient
-  def test_client(token = nil)
-    Lokalise.client(token || ENV['LOKALISE_API_TOKEN'])
+  def test_client(token = nil, params = {})
+    Lokalise.client(token || ENV['LOKALISE_API_TOKEN'], params)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-31 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -236,6 +236,7 @@ files:
 - lib/ruby-lokalise-api/utils/string_utils.rb
 - lib/ruby-lokalise-api/version.rb
 - ruby-lokalise-api.gemspec
+- spec/lib/ruby-lokalise-api/connection_spec.rb
 - spec/lib/ruby-lokalise-api/custom_json_parser_spec.rb
 - spec/lib/ruby-lokalise-api/error_spec.rb
 - spec/lib/ruby-lokalise-api/rest/comments_spec.rb
@@ -284,6 +285,7 @@ signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API
 test_files:
+- spec/lib/ruby-lokalise-api/connection_spec.rb
 - spec/lib/ruby-lokalise-api/custom_json_parser_spec.rb
 - spec/lib/ruby-lokalise-api/error_spec.rb
 - spec/lib/ruby-lokalise-api/rest/comments_spec.rb