ruby-lokalise-api 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f06a31e2619b9aead1f7fe44c4b62557636389c95102757c263672bedef9f19
-  data.tar.gz: 4c76a5505ffca2f4cc6218abddc017439175d11ca689d0e0f5f2a042e94e3bf0
+  metadata.gz: caa20ece7cfd9bbf173ddd4213d6e30b67bec03a78a28188f473414eea7ae42a
+  data.tar.gz: 99069ccfa82ca5cebd820de4da81d9215d24341899862ad8c2b21c52500d5fa7
 SHA512:
-  metadata.gz: f9e28c0ddf96ac41b7658fdf41d277d9a7fc57940c126f16dcc47b2f24d882b998d83f975a6c5a3840bc81eb8ee12bb2d04978f79cca6f52f0a33e81abf0a235
-  data.tar.gz: 58837157151d763e18c4c4f13617dfef4c56e1011e0ce2416832b778fbe6d60719b9c0e3ba10ab0c675239ce9f32ef86b86ddcd8f728bd50187e69625753891e
+  metadata.gz: fb97f63d412ac981efa9f2b3302b740dbc7ae25a93f6a4637a4e6706f8b5150bfd249915bd80b6279249f4e9298da61d29d53855228b73bdce19206adbef3cef
+  data.tar.gz: 5ee66d9e5bd269c7c0cfefa8e73e34601ff18cf487cf623373240ee4b49344a88991cb4cee91f1250944ec14a0c63491e68cf7aa2f893d462c28fb6213b3ea8d

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## 2.3.0 (17-July-19)
+## 2.4.0 (31-Jul-19)
+
+* Remove MultiJson dependency and allow to use a custom JSON parser
+
+## 2.3.0 (17-Jul-19)
 
 * Incorporated latest API changes
 * Added support for [`TranslationStatus` endpoint](https://lokalise.co/api2docs/ruby/#resource-translation-statuses)

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 JSON parser](#customizing-json-parser)
   + [Error handling](#error-handling)
   + [API Rate Limits](#api-rate-limits)
 * [Running Tests](#running-tests)
@@ -1462,13 +1463,37 @@ As long as Lokalise supports only very limited array of color hexadecimal codes
 
 ```ruby
 @client.translation_status_colors(project_id) # Input:
-                                                          ## project_id (string, required)
-                                                          # Output:
-                                                          ## Array of color codes in HEX format
+                                              ## project_id (string, required)
+                                              # Output:
+                                              ## Array of color codes in HEX format
 ```
 
 ## Additional Info
 
+### 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.
+
+For example, to use [Oj](https://github.com/ohler55/oj) you would do the following:
+
+```ruby
+require 'oj'
+
+module Lokalise
+  module JsonHandler  
+    # This method accepts a Ruby object and must return a JSON string
+    def custom_dump(obj)
+      Oj.dump obj
+    end
+
+    # This method accepts JSON and must return Ruby object
+    def custom_load(obj)
+      Oj.load obj
+    end
+  end
+end
+```
+
 ### Error handling
 
 [Error codes](https://lokalise.co/api2docs/curl/#resource-errors)

data/lib/ruby-lokalise-api.rb

@@ -1,9 +1,9 @@
 require 'faraday'
-require 'multi_json'
 require 'yaml'
 require 'addressable'
 
 require 'ruby-lokalise-api/version'
+require 'ruby-lokalise-api/json_handler'
 require 'ruby-lokalise-api/connection'
 require 'ruby-lokalise-api/request'
 require 'ruby-lokalise-api/error'

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

@@ -0,0 +1,15 @@
+module Lokalise
+  module JsonHandler
+    # JSON custom parser. Uses built-in JSON by default but can be overridden to any other parser
+
+    # Converts Ruby object to JSON
+    def custom_dump(obj)
+      JSON.dump obj
+    end
+
+    # Converts JSON to Ruby object
+    def custom_load(obj)
+      JSON.parse obj
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 module Lokalise
   module Request
     include Lokalise::Connection
+    include Lokalise::JsonHandler
 
     PAGINATION_HEADERS = %w[x-pagination-total-count x-pagination-page-count x-pagination-limit x-pagination-page].freeze
 
@@ -13,14 +14,14 @@ module Lokalise
 
     def post(path, client, params = {})
       respond_with(
-        connection(client.token).post(prepare(path), MultiJson.dump(params)),
+        connection(client.token).post(prepare(path), custom_dump(params)),
         client
       )
     end
 
     def put(path, client, params = {})
       respond_with(
-        connection(client.token).put(prepare(path), MultiJson.dump(params)),
+        connection(client.token).put(prepare(path), custom_dump(params)),
         client
       )
     end
@@ -31,7 +32,7 @@ module Lokalise
         # rubocop:disable Style/CollectionMethods
         connection(client.token).delete(prepare(path)) do |req|
           # rubocop:enable Style/CollectionMethods
-          req.body = MultiJson.dump(params)
+          req.body = custom_dump params
         end,
         client
       )
@@ -45,7 +46,7 @@ module Lokalise
     end
 
     def respond_with(response, client)
-      body = MultiJson.load response.body
+      body = custom_load response.body
       uri = Addressable::URI.parse response.env.url
       respond_with_error(response.status, body) if body.respond_to?(:has_key?) && body.key?('error')
       extract_headers_from(response).

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

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

data/ruby-lokalise-api.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'addressable',                   '~> 2.5'
   spec.add_dependency 'faraday',                       '~> 0.13'
-  spec.add_dependency 'multi_json',                    '~> 1.12'
 
   spec.add_development_dependency 'dotenv',                    '~> 2.5'
+  spec.add_development_dependency 'oj',                        '~> 3.8'
   spec.add_development_dependency 'rake',                      '~> 12.1'
   spec.add_development_dependency 'rspec',                     '~> 3.6'
   spec.add_development_dependency 'rubocop',                   '~> 0.60'

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

@@ -0,0 +1,77 @@
+require 'oj'
+
+RSpec.describe 'Custom JSON parser' do
+  let(:loaded_json) do
+    {'projects' => [{'project_id' => '547879415c01a0e6e0b855.29978928',
+                     'name' => 'demo phoenix copy',
+                     'description' => '',
+                     'created_at' => '2018-11-30 20:43:18 (Etc/UTC)',
+                     'created_by' => 20_181,
+                     'created_by_email' => 'bodrovis@protonmail.com',
+                     'team_id' => 176_692,
+                     'statistics' =>
+           {'progress' => 0,
+            'keys' => 1,
+            'team' => 1,
+            'base_words' => 0,
+            'qa_issues' => 1,
+            'languages' =>
+              [{'language_id' => 640, 'language_iso' => 'en', 'progress' => 0, 'words_to_do' => 0},
+               {'language_id' => 597, 'language_iso' => 'ru', 'progress' => 0, 'words_to_do' => 0},
+               {'language_id' => 673, 'language_iso' => 'f_over', 'progress' => 0, 'words_to_do' => 0}]}}]}
+  end
+
+  let(:dumped_json) do
+    '{":name":"rspec proj",":description":"demo project for rspec"}'
+  end
+
+  before :all do
+    module Lokalise
+      module JsonHandler
+        def custom_dump(obj)
+          Oj.dump obj
+        end
+
+        def custom_load(obj)
+          Oj.load obj
+        end
+      end
+    end
+  end
+
+  after :all do
+    module Lokalise
+      module JsonHandler
+        def custom_dump(obj)
+          JSON.dump obj
+        end
+
+        def custom_load(obj)
+          JSON.parse obj
+        end
+      end
+    end
+  end
+
+  it 'should allow to customize #load' do
+    expect(Oj).to receive(:load).and_return(loaded_json)
+    expect(JSON).not_to receive(:parse)
+    projects = VCR.use_cassette('all_projects_pagination') do
+      test_client.projects limit: 1, page: 2
+    end
+
+    expect(projects.collection.count).to eq(1)
+    expect(projects.total_results).to eq(5)
+    expect(projects.collection.first.name).to eq('demo phoenix copy')
+  end
+
+  it 'should allow to customize #dump' do
+    expect(Oj).to receive(:dump).and_return(dumped_json)
+    expect(JSON).not_to receive(:dump)
+    project = VCR.use_cassette('new_project') do
+      test_client.create_project name: 'rspec proj', description: 'demo project for rspec'
+    end
+
+    expect(project.name).to eq('rspec proj')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :runtime
+        version: '2.5'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,7 @@ files:
 - lib/ruby-lokalise-api/connection.rb
 - lib/ruby-lokalise-api/data/attributes.json
 - lib/ruby-lokalise-api/error.rb
+- lib/ruby-lokalise-api/json_handler.rb
 - lib/ruby-lokalise-api/request.rb
 - lib/ruby-lokalise-api/resources/base.rb
 - lib/ruby-lokalise-api/resources/contributor.rb
@@ -235,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/custom_json_parser_spec.rb
 - spec/lib/ruby-lokalise-api/error_spec.rb
 - spec/lib/ruby-lokalise-api/rest/comments_spec.rb
 - spec/lib/ruby-lokalise-api/rest/contributors_spec.rb
@@ -282,6 +284,7 @@ signing_key:
 specification_version: 4
 summary: Ruby interface to the Lokalise API
 test_files:
+- 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
 - spec/lib/ruby-lokalise-api/rest/contributors_spec.rb