ruby-lokalise-api 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5258f1c07fdb9ffa68ab473b4bddf714f42874a049fa6657f1c3791f3cad3f6b
-  data.tar.gz: '05957d96074c503f46c49fb0a88292e6b5a30248c643d094b5dbabfa51dbb7b3'
+  metadata.gz: 3917d088f403329a2daf516f1c7ae13ceb58c4afb598f77c7ce5fe71e8b80361
+  data.tar.gz: dd8a1a57656a0826841576c27a0b7d343dbab5b41ff87440f49ec1cc77816df3
 SHA512:
-  metadata.gz: 5539b8cf6ab910c93ffe47b1ffd1b47ac4d323c971560d869fdf7dd0531e81b2312bbc45f1d4c6ea3d30af4fd451726bd14333a440bec0d8fb85ffc5c30caa62
-  data.tar.gz: c02b44af1ca82999d596e278fa65c7831590080f64168ab16b7d9f407e04087fdbe92e4d7177ab41bb56cedde30624277dce8fb2bf22873439c9160372bf83a4
+  metadata.gz: cb7a76b7c937254b86cd6f5ec3398fe8623c44712cb465fc313eaedf1539e28d850e6e71d28282a8dc7131901918c06911fe72437e5aa053b98c7f7d6086f297
+  data.tar.gz: 22905df5254cd09103f79743cdb19bd6f6b2db8c081ffe528ae00f7f35cc4cafab9b3003cb8c04c6fe5ab11403722e228231c1636262921f531ffe342ada3525

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## 1.1.0
+## 2.0.0 (14-Dec-18)
+
+* Major re-write of internal stuff
+* Introduce method chaining
+* Rename all `#delete` interface methods to `#destroy`
+
+## 1.1.0 (11-Dec-18)
 
 * Added methods to work with pagination (`next_page?`, `last_page?`, `prev_page?`, `first_page?`, `next_page`, `prev_page`)
 
@@ -10,4 +16,4 @@
 
 ## 1.0.0 (10-Dec-18)
 
-* Initial release
+* Initial release

data/README.md

@@ -75,6 +75,12 @@ To get access to raw data returned by the API, use `#raw_data`:
 project.raw_data
 ```
 
+Models support method chaining, meaning you can fetch a resource, update and delete it in one line:
+
+```ruby
+@client.project('123').update(name: 'New name').destroy
+```
+
 ### Collections of resources and pagination
 
 Fetching (or creating/updating) multiple objects will return a *collection* of objects. To get access to the actual data, use `#collection` method:
@@ -189,7 +195,7 @@ translations.prev_page # => will load the previous page while preserving the `li
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-comment-delete)
 
 ```ruby
-@client.delete_comment(project_id, key_id, comment_id)    # Input:
+@client.destroy_comment(project_id, key_id, comment_id)   # Input:
                                                           ## project_id (string, required)
                                                           ## key_id (string, required) 
                                                           ## comment_id (string, required)  
@@ -197,6 +203,13 @@ translations.prev_page # => will load the previous page while preserving the `li
                                                           ## Hash with the project's id and "comment_deleted"=>true
 ```
 
+Alternatively:
+
+```ruby
+comment = @client.comment('project_id', 'comment_id')
+comment.destroy
+```
+
 ### Contributors
 
 #### Fetch contributors
@@ -263,18 +276,32 @@ translations.prev_page # => will load the previous page while preserving the `li
                                                                  ## Updated contributor
 ```
 
+Alternatively:
+
+```ruby
+contributor = @client.contributor('project_id', 'contributor_id')
+contributor.update(params)
+```
+
 #### Delete contributor
 
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-contributor-delete)
 
 ```ruby
-@client.delete_contributor(project_id, contributor_id)     # Input:
+@client.destroy_contributor(project_id, contributor_id)    # Input:
                                                            ## project_id (string, required)
                                                            ## contributor_id (string, required)
                                                            # Output:
                                                            ## Hash with the project's id and "contributor_deleted"=>true
 ```
 
+Alternatively:
+
+```ruby
+contributor = @client.contributor('project_id', 'id')
+contributor.destroy
+```
+
 ### Files
 
 [File attributes](https://lokalise.co/api2docs/ruby/#object-files)
@@ -384,6 +411,13 @@ Exports project files as a `.zip` bundle and makes them available to download (t
                                                       ## Updated key
 ```
 
+Alternatively:
+
+```ruby
+key = @client.key('project_id', 'key_id')
+key.update(params)
+```
+
 #### Bulk update project keys
 
 [Doc](https://lokalise.co/api2docs/ruby/#transition-bulk-update-put)
@@ -403,25 +437,39 @@ Exports project files as a `.zip` bundle and makes them available to download (t
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-key-delete)
 
 ```ruby
-@client.delete_key(project_id, key_id)  # Input:
+@client.destroy_key(project_id, key_id) # Input:
                                         ## project_id (string, required)
                                         ## key_id (string, required)  
                                         # Output:
                                         ## Hash with project_id and "key_removed" set to "true"
 ```
 
+Alternatively:
+
+```ruby
+key = @client.key('project_id', 'key_id')
+key.destroy
+```
+
 #### Bulk delete project keys
 
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-multiple-keys-delete)
 
 ```ruby
-@client.delete_keys(project_id, key_ids)  # Input:
+@client.destroy_keys(project_id, key_ids) # Input:
                                           ## project_id (string, required)
                                           ## key_ids (array, required)  
                                           # Output:
                                           ## Hash with project_id and "keys_removed" set to "true"
 ```
 
+Alternatively:
+
+```ruby
+keys = @client.keys('project_id')
+keys.destroy_all # => will effectively destroy all keys in the project
+```
+
 ### Languages
 
 [Language attributes](https://lokalise.co/api2docs/ruby/#object-languages)
@@ -495,18 +543,32 @@ Exports project files as a `.zip` bundle and makes them available to download (t
                                                             ## Updated language
 ```
 
+Alternatively:
+
+```ruby
+language = @client.language('project_id', 'lang_id')
+language.update(params)
+```
+
 #### Delete project language
 
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-language-delete)
 
 ```ruby
-@client.delete_language(project_id, language_id)     # Input:
+@client.destroy_language(project_id, language_id)    # Input:
                                                      ## project_id (string, required)
                                                      ## language_id (string, required)
                                                      # Output:
                                                      ## Hash with the project's id and "language_deleted"=>true
 ```
 
+Alternatively:
+
+```ruby
+language = @client.language('project_id', 'lang_id')
+language.destroy
+```
+
 ### Projects
 
 [Project attributes](https://lokalise.co/api2docs/php/#object-projects)
@@ -564,6 +626,13 @@ Exports project files as a `.zip` bundle and makes them available to download (t
                                             ## An updated project
 ```
 
+Alternatively:
+
+```ruby
+project = @client.project('project_id')
+project.update(params)
+```
+
 #### Empty a project
 
 [Doc](https://lokalise.co/api2docs/php/#transition-empty-a-project-put)
@@ -577,17 +646,31 @@ Deletes *all* keys and translations from the project.
                                     ## A project containing its id and a `keys_deleted => true` attribute
 ```
 
+Alternatively:
+
+```ruby
+project = @client.project('project_id')
+project.empty
+```
+
 #### Delete a project
 
 [Doc](https://lokalise.co/api2docs/php/#transition-delete-a-project-delete)
 
 ```ruby
-@client.delete_project(project_id)    # Input:
+@client.destroy_project(project_id)   # Input:
                                       ## project_id (string, required)
                                       # Output:
                                       ## A project containing its id and a `project_deleted => true` attribute
 ```
 
+Alternatively:
+
+```ruby
+project = @client.project('project_id')
+project.destroy
+```
+
 ### Screenshots
 
 [Screenshot attributes](https://lokalise.co/api2docs/ruby/#resource-screenshots)
@@ -652,18 +735,32 @@ Deletes *all* keys and translations from the project.
                                                                   ## Updated screenshot
 ```
 
+Alternatively:
+
+```ruby
+screenshot = @client.screenshot('project_id', 'screen_id')
+screenshot.update(params)
+```
+
 #### Delete screenshot
 
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-screenshot-delete)
 
 ```ruby
-@client.delete_screenshot(project_id, screenshot_id)    # Input:
+@client.destroy_screenshot(project_id, screenshot_id)   # Input:
                                                         ## project_id (string, required)
                                                         ## screenshot_id (string, required)
                                                         # Output:
                                                         ## Hash with the project id and "screenshot_deleted" set to "true"
 ```
 
+Alternatively:
+
+```ruby
+screenshot = @client.screenshot('project_id', 'screen_id')
+screenshot.destroy
+```
+
 ### Snapshots
 
 [Snapshot attributes](https://lokalise.co/api2docs/ruby/#object-snapshots)
@@ -707,18 +804,32 @@ Deletes *all* keys and translations from the project.
                                                     ## Information about the restored project from the specified snapshot
 ```
 
+Alternatively:
+
+```ruby
+snapshot = @client.snapshots('project_id').first # you can't fetch a single snapshot
+snapshot.restore
+```
+
 #### Delete snapshot
 
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-snapshot-delete)
 
 ```ruby
-@client.delete_snapshot(project_id, snapshot_id)    # Input:
+@client.destroy_snapshot(project_id, snapshot_id)   # Input:
                                                     ## project_id (string, required)
                                                     ## snapshot_id (string, required)
                                                     # Output:
                                                     ## Hash with the project id and "snapshot_deleted" set to "true"
 ```
 
+Alternatively:
+
+```ruby
+snapshot = @client.snapshots('project_id').first # you can't fetch a single snapshot
+snapshot.destroy
+```
+
 ### Tasks
 
 [Task attributes](https://lokalise.co/api2docs/ruby/#resource-tasks)
@@ -773,7 +884,29 @@ Deletes *all* keys and translations from the project.
 [Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-task-put)
 
 ```ruby
-@client.delete_task(project_id, task_id)   # Input:
+@client.update_task(project_id, task_id, params = {})  # Input:
+                                                       ## project_id (string, required)
+                                                       ## task_id (string or integer, required) 
+                                                       ## params (hash)
+                                                       ### Find supported params at https://lokalise.co/api2docs/ruby/#transition-update-a-task-put 
+                                                       # Output:
+                                                       ## An updated task 
+
+```
+
+Alternatively:
+
+```ruby
+task = @client.task('project_id', 'task_id')
+task.update(params)
+```
+
+#### Delete task
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-task-delete)
+
+```ruby
+@client.destroy_task(project_id, task_id)  # Input:
                                            ## project_id (string, required)
                                            ## task_id (string, required) 
                                            # Output:
@@ -781,6 +914,13 @@ Deletes *all* keys and translations from the project.
 
 ```
 
+Alternatively:
+
+```ruby
+task = @client.task('project_id', 'task_id')
+task.destroy
+```
+
 ### Teams
 
 #### Fetch teams
@@ -838,18 +978,32 @@ Deletes *all* keys and translations from the project.
                                                     ## Updated team user
 ```
 
+Alternatively:
+
+```ruby
+user = @client.team_user('team_id', 'user_id')
+user.update(params)
+```
+
 #### Delete team user
 
 [Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-team-user-delete)
 
 ```ruby
-@client.delete_team_user(team_id, user_id)  # Input:
+@client.destroy_team_user(team_id, user_id) # Input:
                                             ## team_id (string, required)
                                             ## user_id (string, required)
                                             # Output:
                                             ## Hash with "team_id" and "team_user_deleted" set to "true"
 ```
 
+Alternatively:
+
+```ruby
+user = @client.team_user('team_id', 'user_id')
+user.destroy
+```
+
 ### Translations
 
 [Translation attributes](https://lokalise.co/api2docs/ruby/#resource-translations)
@@ -898,6 +1052,13 @@ Deletes *all* keys and translations from the project.
                                                                       ## Updated translation
 ```
 
+Alternatively:
+
+```ruby
+translation = @client.translation('project_id', 'translation_id')
+translation.update(params)
+```
+
 ## Additional Info
 
 ### Error handling
@@ -910,6 +1071,7 @@ The gem may raise the following custom exceptions:
 * `Lokalise::Error::Unauthorized` (`401`) - token is missing or incorrect
 * `Lokalise::Error::Forbidden` (`403`) - authenticated user does not have sufficient rights to perform the desired action
 * `Lokalise::Error::NotFound` (`404`) - the provided endpoint (resource) cannot be found
+* `Lokalise::Error::MethodNowAllowed` (`405`) - HTTP request with the provided verb is not supported by the endpoint
 * `Lokalise::Error::NotAcceptable` (`406`) - posted resource is malformed
 * `Lokalise::Error::Conflict` (`409`) - request conflicts with another request
 * `Lokalise::Error::Locked` (`423`) - your token is used simultaneously in multiple requests

data/lib/ruby-lokalise-api.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'multi_json'
 require 'yaml'
+require 'addressable'
 
 require 'ruby-lokalise-api/version'
 require 'ruby-lokalise-api/connection'
@@ -8,6 +9,7 @@ require 'ruby-lokalise-api/request'
 require 'ruby-lokalise-api/error'
 require 'ruby-lokalise-api/utils/string_utils'
 require 'ruby-lokalise-api/utils/attribute_helpers'
+require 'ruby-lokalise-api/utils/endpoint_helpers'
 
 require 'ruby-lokalise-api/resources/base'
 require 'ruby-lokalise-api/resources/project'

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

@@ -18,5 +18,23 @@ module Lokalise
     def initialize(token)
       @token = token
     end
+
+    def construct_request(klass, method, endpoint_ids, params = {}, object_key = nil)
+      path = klass.endpoint(*endpoint_ids)
+      klass.send method, self, path, format_params(params, object_key)
+    end
+
+    # Converts `params` to hash with arrays under the `object_key` key.
+    # Used in bulk operations
+    #
+    # @return [Hash]
+    def format_params(params, object_key)
+      return params unless object_key
+
+      params = [params] unless params.is_a?(Array)
+      Hash[object_key, params]
+    end
+
+    alias c_r construct_request
   end
 end

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

@@ -4,17 +4,17 @@ module Lokalise
       extend Lokalise::Request
       extend Lokalise::Utils::AttributeHelpers
       include Lokalise::Utils::AttributeHelpers
+      extend Lokalise::Utils::EndpointHelpers
 
       attr_reader :total_pages, :total_results, :results_per_page, :current_page, :collection,
-                  :project_id, :team_id, :request_params, :client, :ids
+                  :project_id, :team_id, :request_params, :client, :path
 
       # Initializes a new collection based on the response
       #
       # @param response [Hash]
       # @param params [Hash]
-      # @param ids [Array, Integer, String]
       # @return [Lokalise::Collections::Base]
-      def initialize(response, params = {}, *ids)
+      def initialize(response, params = {})
         produce_collection_for response
         populate_pagination_data_for response
         # Project and team id may not be present in some cases
@@ -22,14 +22,14 @@ module Lokalise
         @team_id = response['content']['team_id']
         @request_params = params
         @client = response['client']
-        @ids = ids
+        @path = response['path']
       end
 
       class << self
         # Performs a batch query fetching multiple records
-        def all(client, params = {}, *ids)
-          new get(endpoint(*ids), client, params),
-              params, *ids
+        def all(client, path, params = {})
+          new get(path, client, params),
+              params
         end
       end
 
@@ -76,8 +76,8 @@ module Lokalise
 
       def fetch_page(page_num)
         self.class.all @client,
-                       @request_params.merge(page: page_num),
-                       *@ids
+                       @path,
+                       @request_params.merge(page: page_num)
       end
 
       # Dynamically produces collection of resources based on the given response
@@ -90,7 +90,8 @@ module Lokalise
         # We also preserve the `client` to be able to chain API methods later
         @collection = response['content'][data_key_plural].collect do |raw_model|
           Module.const_get("Lokalise::Resources::#{model_class}").new 'content' => raw_model,
-                                                                      'client' => response['client']
+                                                                      'client' => response['client'],
+                                                                      'base_path' => response['path']
         end
       end
     end