ruby-lokalise-api 1.0.1

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new

data/lib/ruby-lokalise-api.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+require 'multi_json'
+require 'yaml'
+
+require 'ruby-lokalise-api/version'
+require 'ruby-lokalise-api/connection'
+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/resources/base'
+require 'ruby-lokalise-api/resources/project'
+require 'ruby-lokalise-api/resources/project_language'
+require 'ruby-lokalise-api/resources/key_comment'
+require 'ruby-lokalise-api/resources/contributor'
+require 'ruby-lokalise-api/resources/file'
+require 'ruby-lokalise-api/resources/translation'
+require 'ruby-lokalise-api/resources/team_user'
+require 'ruby-lokalise-api/resources/task'
+require 'ruby-lokalise-api/resources/snapshot'
+require 'ruby-lokalise-api/resources/screenshot'
+require 'ruby-lokalise-api/resources/key'
+require 'ruby-lokalise-api/resources/project_comment'
+require 'ruby-lokalise-api/resources/system_language'
+require 'ruby-lokalise-api/resources/team'
+
+require 'ruby-lokalise-api/collections/base'
+require 'ruby-lokalise-api/collections/project'
+require 'ruby-lokalise-api/collections/team'
+require 'ruby-lokalise-api/collections/system_language'
+require 'ruby-lokalise-api/collections/project_language'
+require 'ruby-lokalise-api/collections/project_comment'
+require 'ruby-lokalise-api/collections/key_comment'
+require 'ruby-lokalise-api/collections/key'
+require 'ruby-lokalise-api/collections/contributor'
+require 'ruby-lokalise-api/collections/file'
+require 'ruby-lokalise-api/collections/translation'
+require 'ruby-lokalise-api/collections/team_user'
+require 'ruby-lokalise-api/collections/task'
+require 'ruby-lokalise-api/collections/snapshot'
+require 'ruby-lokalise-api/collections/screenshot'
+
+require 'ruby-lokalise-api/client'
+
+module Lokalise
+  class << self
+    # Initializes a new Client object
+    #
+    # @return [Lokalise::Client]
+    def client(token)
+      @client ||= Lokalise::Client.new token
+    end
+
+    # Reset the currently set client
+    def reset_client!
+      @client = nil
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'ruby-lokalise-api/rest/languages'
+require 'ruby-lokalise-api/rest/teams'
+require 'ruby-lokalise-api/rest/projects'
+require 'ruby-lokalise-api/rest/comments'
+require 'ruby-lokalise-api/rest/keys'
+require 'ruby-lokalise-api/rest/contributors'
+require 'ruby-lokalise-api/rest/files'
+require 'ruby-lokalise-api/rest/translations'
+require 'ruby-lokalise-api/rest/team_users'
+require 'ruby-lokalise-api/rest/tasks'
+require 'ruby-lokalise-api/rest/snapshots'
+require 'ruby-lokalise-api/rest/screenshots'
+
+module Lokalise
+  class Client
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Lokalise
+  module Collections
+    class Base
+      extend Lokalise::Request
+      extend Lokalise::Utils::AttributeHelpers
+      include Lokalise::Utils::AttributeHelpers
+
+      attr_reader :raw_data, :total_pages, :total_results, :results_per_page, :current_page, :collection,
+                  :project_id, :team_id
+
+      def initialize(response)
+        produce_collection_for response
+        @total_results = response['x-pagination-total-count'].to_i
+        @total_pages = response['x-pagination-page-count'].to_i
+        @results_per_page = response['x-pagination-limit'].to_i
+        @current_page = response['x-pagination-page'].to_i
+        # Project and team id may not be present in some cases
+        @project_id = response['content']['project_id']
+        @team_id = response['content']['team_id']
+      end
+
+      class << self
+        # Performs a batch query fetching multiple records
+        def all(client, params = {}, *ids)
+          new get(endpoint(*ids), client, params)
+        end
+      end
+
+      private
+
+      # Dynamically produces collection of resources based on the given response
+      # Collection example: `{ "content": {"comments": [ ... ]} }`
+      def produce_collection_for(response)
+        model_class = self.class.name.base_class_name
+        data_key_plural = data_key_for model_class, true
+
+        # Fetch collection data and instantiate an individual resource for each object
+        # 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']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Contributor < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/contributors"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class File < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/files"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Key < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/keys"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class KeyComment < Base
+      class << self
+        private
+
+        def endpoint(project_id, key_id, *_args)
+          "projects/#{project_id}/keys/#{key_id}/comments"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Project < Base
+      class << self
+        private
+
+        def endpoint(*_args)
+          'projects'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class ProjectComment < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/comments"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class ProjectLanguage < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/languages"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Screenshot < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/screenshots"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Snapshot < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/snapshots"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class SystemLanguage < Base
+      class << self
+        private
+
+        def endpoint(*_args)
+          'system/languages'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Task < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/tasks"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Team < Base
+      class << self
+        private
+
+        def endpoint(*_args)
+          'teams'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class TeamUser < Base
+      class << self
+        private
+
+        def endpoint(team_id, *_args)
+          "teams/#{team_id}/users"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Lokalise
+  module Collections
+    class Translation < Base
+      class << self
+        private
+
+        def endpoint(project_id, *_args)
+          "projects/#{project_id}/translations"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Lokalise
+  module Connection
+    BASE_URL = 'https://api.lokalise.co/api2/'.freeze
+
+    def connection(token)
+      options = {
+        headers: {
+          accept: 'application/json',
+          user_agent: "ruby-lokalise-api gem/#{Lokalise::VERSION}",
+          'X-Api-Token': token
+        },
+        url: BASE_URL
+      }
+      Faraday.new(options) { |faraday| faraday.adapter Faraday.default_adapter }
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+{
+  "comment": [
+    "comment_id",
+    "key_id",
+    "comment",
+    "added_by",
+    "added_by_email",
+    "added_at"
+  ],
+  "contributor": [
+    "user_id",
+    "email",
+    "fullname",
+    "created_at",
+    "is_admin",
+    "is_reviewer",
+    "languages",
+    "admin_rights"
+  ],
+  "file": [
+    "filename",
+    "key_count"
+  ],
+  "key": [
+    "key_id",
+    "created_at",
+    "key_name",
+    "filenames",
+    "description",
+    "platforms",
+    "tags",
+    "comments",
+    "screenshots",
+    "translations",
+    "is_plural",
+    "plural_name",
+    "is_hidden",
+    "is_archived",
+    "context",
+    "base_words",
+    "char_limit",
+    "custom_attributes"
+  ],
+  "language": [
+    "lang_id",
+    "lang_iso",
+    "lang_name",
+    "is_rtl",
+    "plural_forms"
+  ],
+  "project": [
+    "project_id",
+    "name",
+    "description",
+    "created_at",
+    "created_by",
+    "created_by_email",
+    "team_id"
+  ],
+  "screenshot": [
+    "screenshot_id",
+    "key_ids",
+    "url",
+    "title",
+    "description",
+    "screenshot_tags",
+    "width",
+    "height"
+  ],
+  "snapshot": [
+    "snapshot_id",
+    "title",
+    "created_at",
+    "created_by",
+    "created_by_email"
+  ],
+  "task": [
+    "task_id",
+    "title",
+    "description",
+    "status",
+    "progress",
+    "due_date",
+    "keys_count",
+    "words_count",
+    "created_at",
+    "created_by",
+    "created_by_email",
+    "can_be_parent",
+    "task_type",
+    "parent_task_id",
+    "closing_tags",
+    "languages",
+    "auto_close_languages",
+    "auto_close_task",
+    "completed_at",
+    "completed_by",
+    "completed_by_email"
+  ],
+  "team": [
+    "team_id",
+    "name",
+    "created_at",
+    "plan",
+    "quota_usage",
+    "quota_allowed"
+  ],
+  "team_user": [
+    "user_id",
+    "email",
+    "fullname",
+    "created_at",
+    "role"
+  ],
+  "translation": [
+    "translation_id",
+    "key_id",
+    "language_iso",
+    "modified_at",
+    "modified_by",
+    "modified_by_email",
+    "translation",
+    "is_fuzzy",
+    "is_reviewed",
+    "words"
+  ]
+}