transifex-interface-ruby 0.0.1 → 0.0.2

data/spec/lib/transifex/translators_spec.rb

@@ -1,32 +1,38 @@
-require_relative '../../spec_helper'
+require "spec_helper"
 
 describe Transifex::ProjectComponents::LanguageComponents::Translators do
-  before(:all) do
-    @project = Transifex::Project.new("projet-de-test-1")
-  end
+  let(:project) { Transifex::Project.new("ruby-client") }
 
-  describe "Instanciation" do
-    it "should raise an error when no parameters given" do
-      expect{ Transifex::ProjectComponents::LanguageComponents::Translators.new }.to raise_error(Transifex::MissingParametersError)
+  describe "Instantiation" do
+    it "raises an error when the project_slug is not provided" do
+      expect { Transifex::ProjectComponents::LanguageComponents::Translators.new }
+        .to raise_error(Transifex::MissingParametersError)
+        .with_message("The following attributes are missing: project_slug")
     end
   end
 
   describe "Fetch" do
-    it "should not raise an error and retrieve the language's informations" do
-      language_coordinators_infos = nil
-      expect{ language_coordinators_infos = @project.language('en').translators.fetch }.to_not raise_error
-      expect(language_coordinators_infos).to be_a_kind_of(Hash)
-      expect(language_coordinators_infos.keys).to contain_exactly("translators")
+    it "retrieves the language translators" do
+      VCR.use_cassette "project/language/fetch_translators" do
+        expect(project.language("en").translators.fetch).to eq({"translators" => []})
+      end
     end
   end
 
   describe "Update" do
-    it "should not raise an error and update the coordinators list" do
-      expect{ @project.language('en').translators.update(['fredericgrais'])}.to_not raise_error
+    it "updates the translators list" do
+      VCR.use_cassette "project/language/update_translators" do
+        expect(project.language("en").translators.update(["mupo"])).to eq "OK"
+        expect(project.language("en").translators.fetch).to eq({"translators" => ["mupo"]})
+      end
     end
 
-    it "should raise an error if the coordinator doesn't exist" do
-      expect{ @project.language('en').translators.update(['grgrgef'])}.to raise_error(Transifex::TransifexError)
+    it "raises an error if the translator doesn't exist" do
+      VCR.use_cassette "project/language/update_non_existing_translator" do
+        expect { project.language("en").translators.update(["not_existing_translator"]) }
+          .to raise_error(Transifex::TransifexError)
+          .with_message("Users not_existing_translator do not exist.")
+      end
     end
   end
-end
+end

data/spec/lib/transifex_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Transifex do
+  describe ".configure" do
+    it "sets the client configuration to access the project" do
+      Transifex.configure do |c|
+        c.client_login = "client_login"
+        c.client_secret = "client_secret"
+      end
+
+      expect(Transifex.configuration.client_login).to eq("client_login")
+      expect(Transifex.configuration.client_secret).to eq("client_secret")
+    end
+  end
+end

data/spec/lib/yaml/eo.yml

@@ -0,0 +1,3 @@
+eo:
+  test_string: "test string"
+  yet_another_string: "yet another string"

data/spec/spec_helper.rb

@@ -3,94 +3,30 @@ Bundler.setup
 
 require_relative '../lib/transifex'
 
-def reset_transifex_configuration
-  Transifex.configure do |c|
-    c.client_login = 'frederic.grais@gmail.com'
-    c.client_secret = 'futur123'    
-  end
-end
-
-def get_yaml_source_trad_file_path(locale)
-  File.dirname(__FILE__) + "/lib/yaml/" + locale + ".yml"
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))].each { |f| require f }
+
+require "webmock/rspec"
+require "vcr"
+
+VCR.configure do |c|
+  c.configure_rspec_metadata!
+  c.cassette_library_dir = "spec/cassettes"
+  c.default_cassette_options = {record: :once}
+  c.hook_into :webmock
 end
-reset_transifex_configuration
 
-
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, make a
-# separate helper file that requires this one and then use it only in the specs
-# that actually need it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+  config.before(:all) do
+    reset_transifex_configuration
   end
 
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-    expectations.syntax = :expect
+  config.after(:suite) do # or :each or :all
+    File.delete("fetched.yml") if File.exists?("fetched.yml")
+    File.delete("translations.yml") if File.exists?("translations.yml")
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Enable only the newer, non-monkey-patching expect syntax.
-    # For more details, see:
-    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-    mocks.syntax = :expect
-
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended.
-    mocks.verify_partial_doubles = true
-  end
-=end
+  config.include ContentHelper
+  config.include ClientHelper
 end

data/spec/support/client_helper.rb

@@ -0,0 +1,8 @@
+module ClientHelper
+  def reset_transifex_configuration
+    Transifex.configure do |c|
+      c.client_login = ''
+      c.client_secret = ''
+    end
+  end
+end

data/spec/support/content_helper.rb

@@ -0,0 +1,346 @@
+module ContentHelper
+  def get_yaml_source_trad_file_path(locale)
+    "spec/lib/yaml/#{locale}.yml"
+  end
+
+  def resource_content_hash
+    {
+      "content" => %Q{eo:\n  test_string: "test string"\n},
+      "mimetype" => "text/plain"
+    }
+  end
+
+  def all_project_resources_array
+    [
+      {
+        "source_language_code" => "eo",
+        "name" => "JSON file example",
+        "i18n_type" => "KEYVALUEJSON",
+        "priority" => "0",
+        "slug" => "json",
+        "categories" => nil
+      },
+      {
+        "source_language_code" => "eo",
+        "name" => "test",
+        "i18n_type" => "YML",
+        "priority" => "0",
+        "slug" => "test",
+        "categories" => nil
+      }
+    ]
+  end
+
+  def successful_resource_creation
+    [1, 0, 0]
+  end
+
+  def resource_source_string_metadata
+    {
+      "comment" => "",
+      "character_limit" => nil,
+      "tags" => nil
+    }
+  end
+
+  def updated_resource_source_string_metadata
+    {
+      "comment" => "my comment",
+      "character_limit" => 140,
+      "tags" => ["tag1", "tag2"]
+    }
+  end
+
+  def basic_resource_info
+    {
+      "source_language_code" => "eo",
+      "name" => "JSON file example",
+      "i18n_type" => "KEYVALUEJSON",
+      "priority" => "0",
+      "slug" => "json",
+      "categories" => nil
+    }
+  end
+
+  def detailed_resource_info
+    {
+      "source_language_code" => "eo",
+      "name" => "JSON file example",
+      "created" => "2017-04-27T13:36:43.747",
+      "wordcount"=> 2,
+      "i18n_type" => "KEYVALUEJSON",
+      "project_slug" => "ruby-client",
+      "accept_translations" => true,
+      "last_update" => "2017-04-27T13:43:29.019",
+      "priority" => "0",
+      "available_languages" => [
+        {
+          "code_aliases" => " ",
+          "code" => "en",
+          "name" => "English"
+        },
+        {
+          "code_aliases" => " ",
+          "code" => "eo",
+          "name" => "Esperanto"
+        }
+      ],
+      "total_entities" => 1,
+      "slug" => "json",
+      "categories" => nil
+    }
+  end
+
+  def updated_resource_info
+    {
+      "source_language_code" => "eo",
+      "name" => "updated name",
+      "i18n_type" => "YML",
+      "priority" => "0",
+      "slug" => "test",
+      "categories" => ["test1", "test2"]
+    }
+  end
+
+  def language_info
+    {
+      "rtl" => false,
+      "pluralequation" => "language.pluralequation",
+      "code" => "fr",
+      "name" => "French",
+      "nplurals" => 2
+    }
+  end
+
+  def basic_language_info
+    {
+      "coordinators" => ["wirido"],
+      "translators" => [],
+      "reviewers" => []
+    }
+  end
+
+  def detailed_language_info
+    {
+      "coordinators" => ["wirido"],
+      "reviewers" => [],
+      "total_segments" => 4,
+      "untranslated_segments" => 4,
+      "translated_words" => 0,
+      "reviewed_segments" => 0,
+      "translators" => [],
+      "translated_segments" => 0
+    }
+  end
+
+  def project_languages_info
+    [
+      {
+        "coordinators" => ["nirnaeth"],
+        "language_code" => "en",
+        "translators" => [],
+        "reviewers" => ["wirido"]
+      }
+    ]
+  end
+
+  def private_project_info
+    {
+      "description" => "Private Ruby Client",
+      "source_language_code" => "eo",
+      "slug" => "private-ruby-client",
+      "name" => "Private Ruby Client"
+    }
+  end
+
+  def detailed_private_project_info
+    {
+      "archived" => false,
+      "auto_join" => false,
+      "description" => "Private Ruby Client",
+      "fill_up_resources" => false,
+      "homepage" => "",
+      "last_updated" => nil,
+      "long_description" => "",
+      "maintainers" => [{"username" => "nirnaeth"}],
+      "name" => "Private Ruby Client",
+      "organization" => {"slug" => "freego"},
+      "private" => true,
+      "resources" => [],
+      "slug" => "private-ruby-client",
+      "source_language_code" => "eo",
+      "tags" => "",
+      "team" => {"id" => 74153, "name" => "Ruby Client team"},
+      "teams" => ["en", "de"],
+      "trans_instructions" => ""
+    }
+  end
+
+  def public_project_info
+    {
+      "description" => "Public Ruby Client",
+      "source_language_code" => "it",
+      "slug" => "public-ruby-client",
+      "name" => "Public Ruby Client"
+    }
+  end
+
+  def all_projects_info
+    [
+      {
+        "description" => "Private Ruby Client",
+        "source_language_code" => "eo",
+        "slug" => "private-ruby-client",
+        "name" => "Private Ruby Client"
+      },
+      {
+        "description" => "Ruby Client",
+        "source_language_code" => "eo",
+        "slug" => "ruby-client",
+        "name" => "Ruby Client"
+      }
+    ]
+  end
+
+  def all_languages_stats
+    {
+      "eo" => {
+        "reviewed_percentage" => "0%",
+        "completed" => "100%",
+        "untranslated_words" => 0,
+        "last_commiter" => "nirnaeth",
+        "reviewed" => 0,
+        "translated_entities" => 1,
+        "translated_words" => 2,
+        "last_update" => "2017-04-27 14:08:57",
+        "untranslated_entities" => 0
+      },
+      "en" => {
+        "reviewed_percentage" => "0%",
+        "completed" => "0%",
+        "untranslated_words" => 2,
+        "last_commiter" => "nirnaeth",
+        "reviewed" => 0,
+        "translated_entities" => 0,
+        "translated_words" => 0,
+        "last_update" => "2017-04-27 14:08:57",
+        "untranslated_entities" => 1
+      }
+    }
+  end
+
+  def translation_content
+    {
+      "content" => "en: {}\n",
+      "mimetype" => "text/plain"
+    }
+  end
+
+  def file_translation_content
+    "---\nen: {}\n"
+  end
+
+  def file_translation_content_with_mode
+    "---\nen:\n  test_string: ''\n"
+  end
+
+  def updated_translations
+    {
+      "strings_added" => 0,
+      "strings_updated" => 0,
+      "strings_delete" => 0,
+      "redirect" => "/freego/ruby-client/test/"
+    }
+  end
+
+  def string_details
+    {
+      "comment" => "",
+      "context" => "",
+      "tags" => nil,
+      "character_limit" => nil,
+      "reviewed" => false,
+      "user" => "",
+      "key" => "test_string",
+      "source_string" => "test string",
+      "translation" => "",
+      "last_update" => "",
+      "pluralized" => false,
+      "occurrences" => nil
+    }
+  end
+
+  def language_strings
+    [
+      {
+        "comment" => "",
+        "context" => "",
+        "key" => "test_string",
+        "reviewed" => true,
+        "pluralized" => false,
+        "source_string" => "test string",
+        "translation" => "translated test string"
+      }
+    ]
+  end
+
+  def language_strings_with_details
+    [
+      {
+        "comment" => "",
+        "context" => "",
+        "tags" => nil,
+        "character_limit" => nil,
+        "reviewed" => true,
+        "user" => "nirnaeth",
+        "key" => "test_string",
+        "source_string" => "test string",
+        "translation" => "translated test string",
+        "last_update" => "2017-05-04T12:22:46.171",
+        "pluralized" => false,
+        "occurrences" => nil
+      }
+    ]
+  end
+
+  def multiple_language_strings
+    [
+      {
+        "comment" => "",
+        "context" => "",
+        "key" => "yet_another_string",
+        "reviewed" => false,
+        "pluralized" => false,
+        "source_string" => "yet another string",
+        "translation" => "yet another translation"
+      },
+      {
+        "comment" => "",
+        "context" => "",
+        "key" => "test_string",
+        "reviewed" => false,
+        "pluralized" => false,
+        "source_string" => "test string",
+        "translation" => "multiple translations"
+      }
+    ]
+  end
+
+  def updated_resource_with_file
+    {
+      "strings_added" => 1,
+      "strings_updated" => 0,
+      "strings_delete" => 1,
+      "redirect" => "/ruby-client/test/"
+    }
+  end
+
+  def updated_resource_with_json
+    {
+      "strings_added" => 0,
+      "strings_updated" => 1,
+      "strings_delete" => 0,
+      "redirect" => "/ruby-client/json/"
+    }
+  end
+end