ruby-lokalise-api 1.1.0 → 2.0.0

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class Contributor < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/contributors"
+          path_from projects: [project_id, 'contributors']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class File < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/files"
+          path_from projects: [project_id, 'files']
         end
       end
     end

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

@@ -1,11 +1,16 @@
 module Lokalise
   module Collections
     class Key < Base
-      class << self
-        private
+      # Destroys all keys in the collection
+      # @return [Hash]
+      def destroy_all
+        keys = collection.collect(&:key_id)
+        Lokalise::Resources::Key.destroy @client, @path, keys: keys
+      end
 
+      class << self
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/keys"
+          path_from projects: [project_id, 'keys']
         end
       end
     end

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

@@ -2,10 +2,9 @@ module Lokalise
   module Collections
     class KeyComment < Base
       class << self
-        private
-
         def endpoint(project_id, key_id, *_args)
-          "projects/#{project_id}/keys/#{key_id}/comments"
+          path_from projects: project_id,
+                    keys: [key_id, 'comments']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class Project < Base
       class << self
-        private
-
         def endpoint(*_args)
-          'projects'
+          path_from projects: nil
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class ProjectComment < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/comments"
+          path_from projects: [project_id, 'comments']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class ProjectLanguage < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/languages"
+          path_from projects: [project_id, 'languages']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class Screenshot < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/screenshots"
+          path_from projects: [project_id, 'screenshots']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class Snapshot < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/snapshots"
+          path_from projects: [project_id, 'snapshots']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class SystemLanguage < Base
       class << self
-        private
-
         def endpoint(*_args)
-          'system/languages'
+          path_from system: 'languages'
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class Task < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/tasks"
+          path_from projects: [project_id, 'tasks']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class Team < Base
       class << self
-        private
-
         def endpoint(*_args)
-          'teams'
+          path_from teams: nil
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class TeamUser < Base
       class << self
-        private
-
         def endpoint(team_id, *_args)
-          "teams/#{team_id}/users"
+          path_from teams: [team_id, 'users']
         end
       end
     end

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

@@ -2,10 +2,8 @@ module Lokalise
   module Collections
     class Translation < Base
       class << self
-        private
-
         def endpoint(project_id, *_args)
-          "projects/#{project_id}/translations"
+          path_from projects: [project_id, 'translations']
         end
       end
     end

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

@@ -11,6 +11,7 @@ module Lokalise
     TooManyRequests = Class.new(ClientError)
     Forbidden = Class.new(ClientError)
     Locked = Class.new(ClientError)
+    MethodNowAllowed = Class.new(ClientError)
 
     NotImplemented = Class.new(ServerError)
     BadGateway = Class.new(ServerError)
@@ -22,6 +23,7 @@ module Lokalise
       401 => Lokalise::Error::Unauthorized,
       403 => Lokalise::Error::Forbidden,
       404 => Lokalise::Error::NotFound,
+      405 => Lokalise::Error::MethodNowAllowed,
       406 => Lokalise::Error::NotAcceptable,
       409 => Lokalise::Error::Conflict,
       423 => Lokalise::Error::Locked,

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

@@ -38,18 +38,26 @@ module Lokalise
 
     private
 
+    # Get rid of double slashes in the `path` and leading slash
     def prepare(path)
-      path.gsub %r{//}, '/'
+      path.gsub(%r{\A/}, '').gsub %r{//}, '/'
     end
 
     def respond_with(response, client)
       body = MultiJson.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).
+        merge('content' => body,
+              'client' => client,
+              'path' => uri.path.gsub(%r{/api2/}, ''))
+    end
+
+    def extract_headers_from(response)
       response.
         headers.
         to_h.
-        keep_if { |k, _v| PAGINATION_HEADERS.include?(k) }.
-        merge('content' => body, 'client' => client)
+        keep_if { |k, _v| PAGINATION_HEADERS.include?(k) }
     end
 
     def respond_with_error(code, body)

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

@@ -4,8 +4,9 @@ module Lokalise
       extend Lokalise::Request
       extend Lokalise::Utils::AttributeHelpers
       include Lokalise::Utils::AttributeHelpers
+      extend Lokalise::Utils::EndpointHelpers
 
-      attr_reader :raw_data, :project_id, :client
+      attr_reader :raw_data, :project_id, :client, :path
 
       # Initializes a new resource based on the response
       #
@@ -17,6 +18,7 @@ module Lokalise
         @raw_data = response['content']
         @project_id = response['content']['project_id']
         @client = response['client']
+        @path = infer_path_from response
       end
 
       class << self
@@ -33,68 +35,53 @@ module Lokalise
           super
         end
 
+        # Defines common CRUD instance methods
+        # Usage: `supports :update, :destroy`
+        def supports(*methods)
+          methods.each do |method_name|
+            define_method method_name do |params = {}|
+              self.class.send method_name,
+                              instance_variable_get(:@client),
+                              instance_variable_get(:@path),
+                              params
+            end
+          end
+        end
+
         # Fetches a single record
-        def find(client, endpoint_ids, resource_id = '', params = {})
-          new get("#{endpoint(*endpoint_ids)}/#{resource_id}",
-                  client,
-                  params)
+        def find(client, path, params = {})
+          new get(path, client, params)
         end
 
         # Creates one or multiple records
-        def create(client, endpoint_ids, params, object_key = nil)
-          response = post(endpoint(*endpoint_ids),
-                          client,
-                          body_from(params, object_key))
+        def create(client, path, params)
+          response = post path, client, params
 
-          object_from response, params, endpoint_ids
+          object_from response, params
         end
 
         # Updates one or multiple records
-        def update(client, endpoint_ids, resource_id, params, object_key = nil)
-          response = put("#{endpoint(*endpoint_ids)}/#{resource_id}",
-                         client,
-                         body_from(params, object_key))
+        def update(client, path, params)
+          response = put path, client, params
 
-          object_from response, params, endpoint_ids
+          object_from response, params
         end
 
         # Destroys records by given ids
-        #
-        # @param client [Lokalise::Client]
-        # @return [Hash]
-        # @param endpoint_ids [String, Integer, Array]
-        # @param resource_id [String, Integer, Hash<Array>]
-        def destroy(client, endpoint_ids, resource_id)
-          path = endpoint(*endpoint_ids).to_s
-          if resource_id.is_a?(Hash)
-            delete path, client, resource_id
-          else
-            delete "#{path}/#{resource_id}", client
-          end['content']
+        def destroy(client, path, params = {})
+          delete(path, client, params)['content']
         end
 
         private
 
-        # Converts `params` to hash with arrays under the `object_key` key.
-        # Used in bulk operations
-        #
-        # @return [Hash]
-        def body_from(params, object_key)
-          return params unless object_key
-
-          params = [params] unless params.is_a?(Array)
-          Hash[object_key, params]
-        end
-
         # Instantiates a new resource or collection based on the given response
-        def object_from(response, params, endpoint_ids)
+        def object_from(response, params)
           model_class = name.base_class_name
           data_key_plural = data_key_for model_class, true
 
           if response['content'].key? data_key_plural
             Module.const_get("Lokalise::Collections::#{model_class}").new response,
-                                                                          params,
-                                                                          endpoint_ids
+                                                                          params
           else
             new response
           end
@@ -103,6 +90,29 @@ module Lokalise
 
       private
 
+      # Generates path for the individual resource based on the path for the collection
+      def infer_path_from(response)
+        id_key = id_key_for self.class.name.base_class_name
+        data_key = data_key_for self.class.name.base_class_name
+
+        path_with_id response, id_key, data_key
+      end
+
+      def path_with_id(response, id_key, data_key)
+        # Some resources do not have ids at all
+        return nil unless response['content'].key?(id_key) || response['content'].key?(data_key)
+
+        # Content may be `{"project_id": '123', ...}` or {"snapshot": {"snapshot_id": '123', ...}}
+        id = response['content'][id_key] || response['content'][data_key][id_key]
+
+        path = response['path'] || response['base_path']
+        # 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
+        path.remove_trailing_slash + "/#{id}"
+      end
+
       # Store all resources attributes under the corresponding instance variables.
       # `ATTRIBUTES` is defined inside resource-specific classes
       def populate_attributes_for(content)

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

@@ -1,11 +1,13 @@
 module Lokalise
   module Resources
     class Contributor < Base
-      class << self
-        private
+      ID_KEY = 'user'.freeze
+      supports :update, :destroy
 
-        def endpoint(project_id)
-          "projects/#{project_id}/contributors"
+      class << self
+        def endpoint(project_id, contributor_id = nil)
+          path_from projects: project_id,
+                    contributors: contributor_id
         end
       end
     end

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

@@ -2,22 +2,17 @@ module Lokalise
   module Resources
     class File < Base
       class << self
-        def download(client, project_id, params)
-          up_down client, endpoint(project_id), params, 'download'
+        def download(client, path, params)
+          post(path, client, params)['content']
         end
 
-        def upload(client, project_id, params)
-          up_down client, endpoint(project_id), params, 'upload'
+        def upload(client, path, params)
+          post(path, client, params)['content']
         end
 
-        private
-
-        def up_down(client, path, params, action)
-          post("#{path}/#{action}", client, params)['content']
-        end
-
-        def endpoint(project_id)
-          "projects/#{project_id}/files"
+        def endpoint(project_id, action = '')
+          path_from projects: project_id,
+                    files: action
         end
       end
     end

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

@@ -1,11 +1,12 @@
 module Lokalise
   module Resources
     class Key < Base
-      class << self
-        private
+      supports :update, :destroy
 
-        def endpoint(project_id)
-          "projects/#{project_id}/keys"
+      class << self
+        def endpoint(project_id, key_id = nil)
+          path_from projects: project_id,
+                    keys: key_id
         end
       end
     end