ruby-lokalise-api 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebd0d7d723970806d7d8078803ada29e359b90f6248a34fb17176b55f977f39b
-  data.tar.gz: 5cbc279f312e4021ed6e6028e843013507aad310cc76f3376a206a65ea391726
+  metadata.gz: 8345d20376de0aad91a7947b6a9e480683f63dc9538d3ad95e43e3cf8fafbbdb
+  data.tar.gz: 2bfeb6a17148d6572e75580f286e1ac1919e94d850ee8d930d770ca2a3c99695
 SHA512:
-  metadata.gz: 99ce24c8248ed892d0a37688a7df26ba661a017be9630f22cac528be128172684e8e3ecc9022d4a94897ef5b2b2fe3cb21182be7b3778eb8f8d8a773984e4b32
-  data.tar.gz: 4688f964ff6d8f9dccede52a9bf9f8e40a31e3674242d49f1329373ca271bb25cd7b1cd204805e9799982028afebf8e97a0ea4a92a7b8f99acbd4a02105c5d17
+  metadata.gz: 6fd93672adc920b30803b0aa5af977487671dbdd6408147fc6494a303c79f6a52d033c8065931d5a2b43824c2b9147f7470bbb7d0ed31dcfd04b2698f662ede4
+  data.tar.gz: 59333fc1f5f5dae3c6c05a370e0287eaf61e43f1fd7b4cdbe3f1d2e1b4f1d909a2d5c10fdc4d30e57dc1c81a6014df404fe26ec4d91bf6bd884cc251d03c00b3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.6.0 (21-Aug-19)
+
+* Added [`Webhook` endpoint](https://lokalise.co/api2docs/curl/#resource-webhooks) (thanks to [@snkashis](https://github.com/snkashis) for help!)
+
 ## 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)

data/README.md

@@ -30,6 +30,7 @@ Official opinionated Ruby interface for the [Lokalise API](https://lokalise.co/a
   + [Translations](#translations)
   + [Translation Providers](#translation-providers)
   + [Translation Statuses](#translation-statuses)
+  + [Webhooks](#webhooks)
 * [Additional Info](#additional-info)
   + [Customizing request](#customizing-request)
   + [Customizing JSON parser](#customizing-json-parser)
@@ -1446,7 +1447,7 @@ status.update(params)
                                                           ## project_id (string, required)
                                                           ## status_id (string or integer, required)
                                                           # Output:
-                                                          ## Translation status inside the given project
+                                                          ## Result of the delete operation
 ```
 
 Alternatively:
@@ -1469,6 +1470,92 @@ As long as Lokalise supports only very limited array of color hexadecimal codes
                                               ## Array of color codes in HEX format
 ```
 
+### Webhooks
+
+[Webhook attributes](https://lokalise.co/api2docs/ruby/#object-webhooks)
+
+#### Fetch webhooks
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-webhooks-get)
+
+```ruby
+@client.webhooks(project_id, params = {}) # Input:
+                                          ## project_id (string, required)
+                                          ## params (hash)
+                                          ### :page and :limit
+                                          # Output:
+                                          ## Collection of webhooks for the project
+```
+
+#### Fetch a single webhook
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-webhook-get)
+
+```ruby
+@client.webhook(project_id, webhook_id)   # Input:
+                                          ## project_id (string, required)
+                                          ## webhook_id (string or integer, required)
+                                          # Output:
+                                          ## Webhook for the given project
+```
+
+#### Create webhook
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-a-webhook-post)
+
+```ruby
+@client.create_webhook(project_id, params)    # Input:
+                                              ## project_id (string, required)
+                                              ## params (hash, required)
+                                              ### :url (string, required) - webhook URL
+                                              ### :events (array, required) - events to subscribe to. Check the API docs to find the list of supported events
+                                              ### :event_lang_map (array) - map the event with an array of languages iso codes
+                                              # Output:
+                                              ## Created webhook
+```
+
+#### Update webhook
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-webhook-put)
+
+```ruby
+@client.update_webhook(project_id, webhook_id, params)    # Input:
+                                                          ## project_id (string, required)
+                                                          ## webhook_id (string or integer, required)
+                                                          ## params (hash)
+                                                          ### :url (string) - webhook URL
+                                                          ### :events (array) - events to subscribe to. Check the API docs to find the list of supported events
+                                                          ### :event_lang_map (array) - map the event with an array of languages iso codes
+                                                          # Output:
+                                                          ## Updated webhook
+```
+
+Alternatively:
+
+```ruby
+webhook = @client.webhook(project_id, webhook_id)
+webhook.update(params)
+```
+
+#### Delete webhook
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-webhook-delete)
+
+```ruby
+@client.destroy_webhook(project_id, webhook_id)   # Input:
+                                                  ## project_id (string, required)
+                                                  ## webhook_id (string or integer, required)
+                                                  # Output:
+                                                  ## Result of the delete operation
+```
+
+Alternatively:
+
+```ruby
+webhook = @client.webhook(project_id, webhook_id)
+webhook.destroy
+```
+
 ## Additional Info
 
 ### Customizing Request

data/lib/ruby-lokalise-api.rb

@@ -31,6 +31,7 @@ require 'ruby-lokalise-api/resources/payment_card'
 require 'ruby-lokalise-api/resources/translation_provider'
 require 'ruby-lokalise-api/resources/team_user_group'
 require 'ruby-lokalise-api/resources/custom_translation_status'
+require 'ruby-lokalise-api/resources/webhook'
 
 require 'ruby-lokalise-api/collections/base'
 require 'ruby-lokalise-api/collections/project'
@@ -52,6 +53,7 @@ require 'ruby-lokalise-api/collections/payment_card'
 require 'ruby-lokalise-api/collections/translation_provider'
 require 'ruby-lokalise-api/collections/team_user_group'
 require 'ruby-lokalise-api/collections/custom_translation_status'
+require 'ruby-lokalise-api/collections/webhook'
 
 require 'ruby-lokalise-api/client'
 

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

@@ -15,6 +15,7 @@ require 'ruby-lokalise-api/rest/payment_cards'
 require 'ruby-lokalise-api/rest/translation_providers'
 require 'ruby-lokalise-api/rest/team_user_group'
 require 'ruby-lokalise-api/rest/custom_translation_statuses'
+require 'ruby-lokalise-api/rest/webhooks'
 
 module Lokalise
   class Client

data/lib/ruby-lokalise-api/collections/base.rb

@@ -53,12 +53,14 @@ module Lokalise
         !prev_page?
       end
 
+      # @return [Integer]
       def next_page
         return nil if last_page?
 
         fetch_page @current_page + 1
       end
 
+      # @return [Integer]
       def prev_page
         return nil if first_page?
 
@@ -74,6 +76,7 @@ module Lokalise
         @current_page = response['x-pagination-page'].to_i
       end
 
+      # Gets the specified page
       def fetch_page(page_num)
         self.class.all @client,
                        @path,

data/lib/ruby-lokalise-api/collections/webhook.rb

@@ -0,0 +1,11 @@
+module Lokalise
+  module Collections
+    class Webhook < Base
+      class << self
+        def endpoint(project_id, *_args)
+          path_from projects: [project_id, 'webhooks']
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,7 @@ module Lokalise
 
     private
 
+    # Allows to customize request params per-client
     def request_params_for(client)
       {request: {timeout: client.timeout, open_timeout: client.open_timeout}}
     end

data/lib/ruby-lokalise-api/data/attributes.json

@@ -195,5 +195,12 @@
     "description",
     "tiers",
     "pairs"
+  ],
+  "webhook": [
+    "webhook_id",
+    "url",
+    "secret",
+    "events",
+    "event_lang_map"
   ]
 }

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

@@ -3,6 +3,7 @@ module Lokalise
     include Lokalise::Connection
     include Lokalise::JsonHandler
 
+    # Lokalise returns pagination info in special headers
     PAGINATION_HEADERS = %w[x-pagination-total-count x-pagination-page-count x-pagination-limit x-pagination-page].freeze
 
     def get(path, client, params = {})
@@ -55,6 +56,7 @@ module Lokalise
               'path' => uri.path.gsub(%r{/api2/}, ''))
     end
 
+    # Get only pagination headers
     def extract_headers_from(response)
       response.
         headers.

data/lib/ruby-lokalise-api/resources/base.rb

@@ -127,7 +127,7 @@ module Lokalise
         # If path already has id - just return it
         return path if path.match?(/#{id}\z/)
 
-        # Otherwise this seems like a collection path, so append the resource id to it
+        # Otherwise this looks like a collection path, so append the resource id to it
         path.remove_trailing_slash + "/#{id}"
       end
 

data/lib/ruby-lokalise-api/resources/webhook.rb

@@ -0,0 +1,14 @@
+module Lokalise
+  module Resources
+    class Webhook < Base
+      supports :update, :destroy
+
+      class << self
+        def endpoint(project_id, webhook_id = nil)
+          path_from projects: project_id,
+                    webhooks: webhook_id
+        end
+      end
+    end
+  end
+end

data/lib/ruby-lokalise-api/rest/webhooks.rb

@@ -0,0 +1,54 @@
+module Lokalise
+  class Client
+    # Returns all webhooks for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-list-all-webhooks-get
+    # @return [Lokalise::Collection::Webhook<Lokalise::Resources::Webhook>]
+    # @param project_id [String]
+    # @param params [Hash]
+    def webhooks(project_id, params = {})
+      c_r Lokalise::Collections::Webhook, :all, project_id, params
+    end
+
+    # Returns a single webhook for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-retrieve-a-webhook-get
+    # @return [Lokalise::Resources::Webhook]
+    # @param project_id [String]
+    # @param webhook_id [String, Integer]
+    def webhook(project_id, webhook_id)
+      c_r Lokalise::Resources::Webhook, :find, [project_id, webhook_id]
+    end
+
+    # Creates webhook for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-create-a-webhook-post
+    # @return [Lokalise::Resources::Webhook]
+    # @param project_id [String]
+    # @param params [Hash]
+    def create_webhook(project_id, params)
+      c_r Lokalise::Resources::Webhook, :create, project_id, params
+    end
+
+    # Updates webhook for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-update-a-webhook-put
+    # @return [Lokalise::Resources::Webhook]
+    # @param project_id [String]
+    # @param webhook_id [String, Integer]
+    # @param params [Hash]
+    def update_webhook(project_id, webhook_id, params = {})
+      c_r Lokalise::Resources::Webhook, :update, [project_id, webhook_id], params
+    end
+
+    # Deletes webhook for the given project
+    #
+    # @see https://lokalise.co/api2docs/ruby/#transition-delete-a-webhook-delete
+    # @return [Hash]
+    # @param project_id [String]
+    # @param webhook_id [String, Integer]
+    def destroy_webhook(project_id, webhook_id)
+      c_r Lokalise::Resources::Webhook, :destroy, [project_id, webhook_id]
+    end
+  end
+end

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

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

data/spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb

@@ -0,0 +1,74 @@
+RSpec.describe Lokalise::Client do
+  let(:project_id) { '803826145ba90b42d5d860.46800099' }
+  let(:webhook_id) { 'c7eb7e6e3c2fb2b26d0b64d0de083a5a71675b3d' }
+  let(:new_webhook_id) { 'b345ccc6499920c490e8f4fe9487b1378dbf1dbf' }
+
+  describe '#webhooks' do
+    it 'should return all webhooks' do
+      webhooks = VCR.use_cassette('webhooks') do
+        test_client.webhooks project_id
+      end.collection
+
+      expect(webhooks.count).to eq(3)
+      expect(webhooks.first.url).to eq('https://serios.webhook')
+    end
+
+    it 'should support pagination' do
+      webhooks = VCR.use_cassette('all_webhooks_pagination') do
+        test_client.webhooks project_id, limit: 1, page: 2
+      end
+
+      expect(webhooks.collection.count).to eq(1)
+      expect(webhooks.total_results).to eq(3)
+      expect(webhooks.total_pages).to eq(3)
+      expect(webhooks.results_per_page).to eq(1)
+      expect(webhooks.current_page).to eq(2)
+    end
+  end
+
+  specify '#webhook' do
+    webhook = VCR.use_cassette('webhook') do
+      test_client.webhook project_id, webhook_id
+    end
+
+    expect(webhook.webhook_id).to eq(webhook_id)
+    expect(webhook.url).to eq('https://canihaz.hook')
+    expect(webhook.secret).to eq('a62450cd9eeca8dfc84f3c0cf9b7a6a370267d6f')
+    expect(webhook.events).to include('project.snapshot')
+    expect(webhook.event_lang_map.first['event']).to eq('project.translation.updated')
+  end
+
+  specify '#create_webhook' do
+    webhook = VCR.use_cassette('create_webhook') do
+      test_client.create_webhook project_id,
+                                 url: 'http://thatz.ahook',
+                                 events: ['project.imported', 'project.exported']
+    end
+
+    expect(webhook.webhook_id).to eq(new_webhook_id)
+    expect(webhook.url).to eq('http://thatz.ahook')
+    expect(webhook.events).to include('project.imported', 'project.exported')
+  end
+
+  specify '#update_webhook' do
+    webhook = VCR.use_cassette('update_webhook') do
+      test_client.update_webhook project_id,
+                                 new_webhook_id,
+                                 url: 'http://ihaz.cheezburger'
+    end
+
+    expect(webhook.webhook_id).to eq(new_webhook_id)
+    expect(webhook.url).to eq('http://ihaz.cheezburger')
+    expect(webhook.events).to include('project.imported', 'project.exported')
+  end
+
+  specify '#destroy_webhook' do
+    response = VCR.use_cassette('destroy_webhook') do
+      test_client.destroy_webhook project_id,
+                                  new_webhook_id
+    end
+
+    expect(response['project_id']).to eq(project_id)
+    expect(response['webhook_deleted']).to eq(true)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lokalise-api
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -189,6 +189,7 @@ files:
 - lib/ruby-lokalise-api/collections/team_user_group.rb
 - lib/ruby-lokalise-api/collections/translation.rb
 - lib/ruby-lokalise-api/collections/translation_provider.rb
+- lib/ruby-lokalise-api/collections/webhook.rb
 - lib/ruby-lokalise-api/connection.rb
 - lib/ruby-lokalise-api/data/attributes.json
 - lib/ruby-lokalise-api/error.rb
@@ -214,6 +215,7 @@ files:
 - lib/ruby-lokalise-api/resources/team_user_group.rb
 - lib/ruby-lokalise-api/resources/translation.rb
 - lib/ruby-lokalise-api/resources/translation_provider.rb
+- lib/ruby-lokalise-api/resources/webhook.rb
 - lib/ruby-lokalise-api/rest/comments.rb
 - lib/ruby-lokalise-api/rest/contributors.rb
 - lib/ruby-lokalise-api/rest/custom_translation_statuses.rb
@@ -231,6 +233,7 @@ files:
 - lib/ruby-lokalise-api/rest/teams.rb
 - lib/ruby-lokalise-api/rest/translation_providers.rb
 - lib/ruby-lokalise-api/rest/translations.rb
+- lib/ruby-lokalise-api/rest/webhooks.rb
 - lib/ruby-lokalise-api/utils/attribute_helpers.rb
 - lib/ruby-lokalise-api/utils/endpoint_helpers.rb
 - lib/ruby-lokalise-api/utils/string_utils.rb
@@ -256,6 +259,7 @@ files:
 - spec/lib/ruby-lokalise-api/rest/teams_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translation_providers_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translations_spec.rb
+- spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb
 - spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
 - spec/lib/ruby-lokalise-api_spec.rb
 - spec/spec_helper.rb
@@ -305,6 +309,7 @@ test_files:
 - spec/lib/ruby-lokalise-api/rest/team_user_groups_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translations_spec.rb
 - spec/lib/ruby-lokalise-api/rest/translation_providers_spec.rb
+- spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb
 - spec/lib/ruby-lokalise-api/utils/snakecase_spec.rb
 - spec/lib/ruby-lokalise-api_spec.rb
 - spec/spec_helper.rb