crowdin-api 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12f344cc4505d0b72b8aa88ad7be65075b4bd6528b001fcde826b40cf2dee874
-  data.tar.gz: 2164d78e4db36ae2e059a7bb9c26279962eeeb6e9f37937bd81ff00fca51201a
+  metadata.gz: 98a60b3487c1824a37ef3519089f1e48e7de773f35734a54a981365707bbd80a
+  data.tar.gz: 0e5642b1b3446d55602f34ec4820b82e5d686e4002df0158371031141480bde1
 SHA512:
-  metadata.gz: 708f2939ae29fbff6d80afc5e894aeaab6b57289fe1ce851e6ecd2de4570790e9965d325d860e2c7eebb770a592e6db9f90a44c9a4c35ba7c15150cdaa28eb0a
-  data.tar.gz: 85bae25c856683abae92d778987168d591848682679ce6d3db191c884607d208a2838882f9508ff8bc7ab4e29727d9a1791f3b14642e1291a37609334886ce77
+  metadata.gz: a6ee9691d7ce60578c6438bf58874262edaa4dc8100723a2c9ad56b70828c97367a332401a47b9f098408d48dec4324714d83e5a1f73f3a2d683c829f3dc792f
+  data.tar.gz: cc3e2fbdc50836e014496c9990be79492817c878a8758b35044e5cecedf670eeed33390fb42ab1d32e5d52b9873344ee88a3fc11942e4a7513a1e3adf66269d5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crowdin-api (1.13.0)
+    crowdin-api (1.14.0)
       open-uri (>= 0.1.0, < 0.2.0)
       rest-client (>= 2.0.0, < 2.2.0)
 

data/README.md

@@ -35,7 +35,7 @@ Crowdin API is a full-featured RESTful API that helps you to integrate localizat
 Add this line to your application's Gemfile:
 
 ```gemfile
-gem 'crowdin-api', '~> 1.13.0'
+gem 'crowdin-api', '~> 1.14.0'
 ```
 
 And then execute:
@@ -134,6 +134,28 @@ file_revisions = crowdin.list_file_revisions(your_file_id, { limit: 10 }, your_p
 # Note: more examples you can find in spec folder
 ```
 
+### GraphQL API
+
+The client can send GraphQL requests to Crowdin's default API host or to an Enterprise organization endpoint.
+
+```ruby
+query = <<~GRAPHQL
+  query Viewer {
+    viewer {
+      id
+    }
+  }
+GRAPHQL
+
+response = crowdin.graphql({ query: query })
+```
+
+You can also provide a custom endpoint URL for testing.
+
+```ruby
+crowdin.graphql({ query: query }, url: 'http://localhost:3000/api/graphql')
+```
+
 ### Fetch all records
 
 There is a possibility to fetch all records from paginatable methods using `fetch_all` method.

data/lib/crowdin-api/api_resources/applications.rb

@@ -7,7 +7,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.get  API Documentation}
       def get_application_data(application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -21,7 +21,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.put  API Documentation}
       def update_or_restore_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -36,7 +36,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.put  API Documentation}
       def add_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -51,7 +51,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.delete  API Documentation}
       def delete_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,
@@ -66,7 +66,7 @@ module Crowdin
       # * {https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.applications.api.patch  API Documentation}
       def edit_application_data(query = {}, application_identifier = nil, path = nil)
         application_identifier || raise_parameter_is_required_error(:application_identifier)
-        application_identifier || raise_parameter_is_required_error(:path)
+        path || raise_parameter_is_required_error(:path)
 
         request = Web::Request.new(
           connection,

data/lib/crowdin-api/client/client.rb

@@ -31,15 +31,10 @@ module Crowdin
     end
 
     include Web::FetchAllExtensions
+    include Web::GraphqlExtensions
 
-    # Config instance that includes configuration options for the Client
-    attr_reader :config
-    # Instance with established connection through RestClient to the Crowdin API
-    attr_reader :connection
-    # Instance with options and headers for RestClient connection
-    attr_reader :options
-    # Logger instance
-    attr_reader :logger
+    # Client configuration, connection, request options, and logger instances
+    attr_reader :config, :connection, :options, :logger
 
     def initialize(&block)
       build_configuration(&block)

data/lib/crowdin-api/client/version.rb

@@ -2,6 +2,6 @@
 
 module Crowdin
   class Client
-    VERSION = '1.13.0'
+    VERSION = '1.14.0'
   end
 end

data/lib/crowdin-api/core/graphql_extensions.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Crowdin
+  module Web
+    module GraphqlExtensions
+      def graphql(query = nil, **request_options)
+        url = request_options.delete(:url)
+        graphql_query = query || request_options
+
+        response = ::RestClient::Request.execute(
+          {
+            method: :post,
+            url: url || "#{config.base_url}/api/graphql",
+            payload: graphql_query.to_json
+          }.merge(options)
+        ) { |res, _, _| res }
+
+        response.body.empty? ? response.code : JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/crowdin-api.rb

@@ -23,6 +23,7 @@ require 'crowdin-api/core/errors_raisers'
 require 'crowdin-api/core/request'
 require 'crowdin-api/core/send_request'
 require 'crowdin-api/core/fetch_all_extensions'
+require 'crowdin-api/core/graphql_extensions'
 
 # API modules
 Crowdin::API_RESOURCES_MODULES.each do |api_resource|

data/spec/unit/client_spec.rb

@@ -98,6 +98,53 @@ describe 'Crowdin Client' do
     end
   end
 
+  describe 'Crowdin Client graphql' do
+    let(:graphql_request) do
+      {
+        query: 'query Viewer { viewer { id } }',
+        operationName: 'Viewer',
+        variables: { projectId: 1, emptyValue: nil }
+      }
+    end
+    let(:graphql_response) { { 'data' => { 'viewer' => { 'id' => 1 } } } }
+
+    it 'posts to the default GraphQL endpoint', :default do
+      stub_request(:post, 'https://api.crowdin.com/api/graphql')
+        .with(body: graphql_request.to_json)
+        .to_return(body: graphql_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request)).to eq(graphql_response)
+    end
+
+    it 'posts to the Enterprise GraphQL endpoint', :enterprise do
+      stub_request(:post, 'https://domain.api.crowdin.com/api/graphql')
+        .with(body: graphql_request.to_json)
+        .to_return(body: graphql_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request)).to eq(graphql_response)
+    end
+
+    it 'supports a custom GraphQL endpoint URL', :default do
+      custom_url = 'http://localhost:3000/api/graphql'
+
+      stub_request(:post, custom_url)
+        .with(body: graphql_request.to_json)
+        .to_return(body: graphql_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request, url: custom_url)).to eq(graphql_response)
+    end
+
+    it 'returns parsed GraphQL error responses', :default do
+      graphql_error_response = { 'errors' => [{ 'message' => 'Invalid query' }] }
+
+      stub_request(:post, 'https://api.crowdin.com/api/graphql')
+        .with(body: graphql_request.to_json)
+        .to_return(status: 400, body: graphql_error_response.to_json)
+
+      expect(@crowdin.graphql(graphql_request)).to eq(graphql_error_response)
+    end
+  end
+
   describe 'connection' do
     subject(:connection) { crowdin_client.connection }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Crowdin
@@ -237,6 +237,7 @@ files:
 - lib/crowdin-api/core/errors.rb
 - lib/crowdin-api/core/errors_raisers.rb
 - lib/crowdin-api/core/fetch_all_extensions.rb
+- lib/crowdin-api/core/graphql_extensions.rb
 - lib/crowdin-api/core/request.rb
 - lib/crowdin-api/core/send_request.rb
 - spec/api_resources/applications_spec.rb