transifex-interface-ruby 0.0.1

data/spec/lib/transifex/languages_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../../spec_helper'
+
+describe Transifex::Languages do
+
+  describe "Fetch" do
+    it "should fetch all languages infos without raising an error" do
+      fetched_languages = nil
+      expect{ fetched_languages = Transifex::Languages.fetch }.to_not raise_error
+      expect(fetched_languages).to be_a_kind_of(Array)
+      expect(fetched_languages.first.keys).to contain_exactly("rtl", "pluralequation", "code", "name", "nplurals")
+    end
+  end
+end

data/spec/lib/transifex/project_language_spec.rb

@@ -0,0 +1,49 @@
+require_relative '../../spec_helper'
+
+describe Transifex::ProjectComponents::Language do
+  before(:all) do
+    @project = Transifex::Project.new("projet-de-test-1")
+  end
+
+  describe "Instanciation" do
+    it "should raise an error when no parameters given" do
+      expect{ Transifex::ProjectComponents::Language.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should not raise an error and retrieve the language's informations without details" do
+      project_language_infos = nil
+      expect{ project_language_infos = @project.language('en').fetch }.to_not raise_error
+      expect(project_language_infos).to be_a_kind_of(Hash)
+      expect(project_language_infos.keys).to contain_exactly("coordinators", "translators", "reviewers")
+    end
+
+    it "should not raise an error and retrieve the language's informations with details" do
+      project_language_infos = nil
+      expect{ project_language_infos = @project.language('en').fetch_with_details }.to_not raise_error
+      expect(project_language_infos).to be_a_kind_of(Hash)
+      expect(project_language_infos.keys).to contain_exactly("coordinators", "reviewers", "total_segments", "untranslated_segments", "translated_words", "reviewed_segments", "translators","translated_segments")
+    end
+  end
+
+  describe "Update" do
+    it "should raise an error if language doesn't exist " do
+      expect{ @project.language('dzdzadaz').update({:coordinators => ['fredericgrais'], :translators => ['fredericgrais'], :reviewers => ['fredericgrais']}) }.to raise_error(Transifex::TransifexError)
+    end
+
+    it "should not raise an error and update the language's infos " do
+      expect{ @project.language('fr').update({:coordinators => ['fredericgrais'], :translators => ['fredericgrais'], :reviewers => ['fredericgrais']}) }.to_not raise_error
+    end
+  end
+
+  describe "Delete" do
+    before(:all) do
+      @project.languages.create({:language_code => "it", :coordinators => ['fredericgrais']})
+    end
+
+    it "should delete the resource without raising an error" do
+      expect{ @project.language('it').delete }.to_not raise_error
+    end
+  end
+end

data/spec/lib/transifex/project_languages_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../../spec_helper'
+
+describe Transifex::ProjectComponents::Languages do
+  before(:all) do
+    @project = Transifex::Project.new("projet-de-test-1")
+  end
+
+  describe "Instanciation" do
+    it "should raise an error when no parameters given" do
+      expect{ Transifex::ProjectComponents::Languages.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should not raise an error and retrieve the languages informations" do
+      project_languages = nil
+      expect{ project_languages = @project.languages.fetch }.to_not raise_error
+      expect(project_languages).to be_a_kind_of(Array)
+      expect(project_languages.first.keys).to contain_exactly("coordinators", "language_code", "translators", "reviewers")
+    end
+  end
+
+  describe "Create" do
+    it "should not raise an error and create the new language for the project" do
+      expect{@project.languages.create({:language_code => "el", :coordinators => ['fredericgrais']}) }.to_not raise_error
+    end
+    it "should raise an error if the coordinator doesn't exist" do
+      expect{@project.languages.create({:language_code => "el", :coordinators => ['fredericgrais', 'loiloililoi']}) }.to raise_error(Transifex::TransifexError)
+    end
+
+    after(:all) do
+      @project.language('el').delete
+    end
+  end
+end

data/spec/lib/transifex/project_spec.rb

@@ -0,0 +1,91 @@
+require_relative '../../spec_helper'
+
+describe Transifex::Project do 
+  
+  describe "Manage a project" do
+    before(:all) do
+      @correct_params_private = {:slug => "projet_private", :name => "Projet de test Private", :description => "description", :source_language_code => "en", :private => true}
+      @correct_params_public = {:slug => "projet_public", :name => "Projet de test Public", :description => "description", :source_language_code => "en", :repository_url => "http://en.google.com"} 
+      @private_project = Transifex::Projects.create(@correct_params_private)
+      @public_project = Transifex::Projects.create(@correct_params_public)  
+    end    
+
+    describe "instanciation" do
+      it "should raise an error if a slug is not provided" do
+        expect { Transifex::Project.new }.to raise_error(Transifex::MissingParametersError)
+      end
+    end    
+
+    context "private project" do     
+      describe "fetch" do        
+        it "should retrieve informations about the project without details" do
+          fetched_project = @private_project.fetch
+          expect { fetched_project = @private_project.fetch }.to_not raise_error          
+          expect(fetched_project).to be_a_kind_of(Hash)
+          expect(fetched_project.keys).to contain_exactly("slug", "name", "description","source_language_code")
+        end
+        it "should retrieve informations about the project with details" do
+          fetched_project = nil
+          expect { fetched_project = @private_project.fetch_with_details }.to_not raise_error
+          expect(fetched_project).to be_a_kind_of(Hash)
+          expect(fetched_project.keys).to contain_exactly("archived", "auto_join", "fill_up_resources", "homepage", "last_updated", "long_description", "maintainers", "organization", "private", "resources", "tags", "team", "teams", "trans_instructions", "slug", "name", "description","source_language_code")
+        end
+      end
+      describe "update" do
+        it "should not raise an error and update the project" do
+          updated_project = nil
+          expect { updated_project = @private_project.update({:description => "test"}) }.to_not raise_error
+          expect(updated_project).to eq("OK")
+          fetched_project = @private_project.fetch_with_details
+          expect(fetched_project['description']).to eq('test')
+        end
+        it "should raise an error if updated field is wrong" do
+          expect { @private_project.update({:buttchick => "lol"}) }.to raise_error(Transifex::TransifexError)
+        end
+        it "should raise an error if no paramaters to update are provided" do
+          expect { @private_project.update }.to raise_error(Transifex::Error)
+        end
+      end
+      describe "delete" do
+        it "should not raise an error" do
+          expect { @private_project.delete }.to_not raise_error
+        end
+      end
+    end
+    context "public project" do
+      describe "fetch" do
+        it "should retrieve informations about the project without details" do
+          fetched_project = nil
+          expect { fetched_project = @public_project.fetch }.to_not raise_error
+          expect(fetched_project).to be_a_kind_of(Hash)
+          expect(fetched_project.keys).to contain_exactly("slug", "name", "description","source_language_code")
+        end
+        it "should retrieve informations about the project with details" do
+          fetched_project = nil
+          expect { fetched_project = @public_project.fetch_with_details }.to_not raise_error
+          expect(fetched_project).to be_a_kind_of(Hash)
+          expect(fetched_project.keys).to contain_exactly("archived", "auto_join", "fill_up_resources", "homepage", "last_updated", "long_description", "maintainers", "organization", "private", "resources", "tags", "team", "teams", "trans_instructions", "slug", "name", "description","source_language_code")
+        end
+      end
+      describe "update" do
+        it "should not raise an error and update the project" do
+          updated_project = nil
+          expect { updated_project = @public_project.update({:description => "test"}) }.to_not raise_error
+          expect(updated_project).to eq("OK")
+        end
+        it "should raise an error if updated field is wrong" do
+          updated_project = nil
+          expect { updated_project = @public_project.update({:buttchick => "lol"}) }.to raise_error(Transifex::TransifexError)
+        end
+        it "should raise an error if no paramaters to update are provided" do
+          expect { @public_project.update }.to raise_error(Transifex::Error)
+        end
+      end
+      describe "delete"  do
+        it "should not raise an error" do
+          expect { @public_project.delete }.to_not raise_error
+        end        
+      end
+    end    
+  end  
+end

data/spec/lib/transifex/projects_spec.rb

@@ -0,0 +1,48 @@
+require_relative "../../spec_helper"
+
+describe Transifex::Projects do 
+  before(:all) do
+    @incorrect_params = {:slug => "test"}
+    @correct_params_private = {:slug => "projet_de_test_private", :name => "Projet de test Public", :description => "description", :source_language_code => "en", :private => true}
+    @correct_params_public = {:slug => "projet_de_test_public", :name => "Projet de test Private", :description => "description", :source_language_code => "en", :repository_url => "http://en.google.com"} 
+  end
+
+  describe "create" do 
+    it "should raise an error if required parameters are missing" do
+      expect { Transifex::Projects.create(@incorrect_params) }.to raise_error(Transifex::MissingParametersError)
+    end 
+    context "private project" do
+      it "should not raise an error if required parameters are provided and create the private project" do
+        created_project = nil
+        expect { created_project = Transifex::Projects.create(@correct_params_private) }.to_not raise_error
+        expect(created_project).to be_a_kind_of(Transifex::Project)
+        expect(created_project.project_slug).to eq(@correct_params_private[:slug])
+        created_project.delete
+      end
+    end
+    context "public project" do
+      it "should not raise an error if required parameters are provided and create the project" do
+        created_project = nil
+        expect { created_project = Transifex::Projects.create(@correct_params_public) }.to_not raise_error
+        expect(created_project).to be_a_kind_of(Transifex::Project)
+        expect(created_project.project_slug).to eq(@correct_params_public[:slug])
+        created_project.delete
+      end
+      it "should raise an error if repository_url is not matching the correct format" do
+        incorrect_params_public = @correct_params_public
+        incorrect_params_public[:repository_url] = "www.google.com"
+        expect { Transifex::Projects.create(@correct_params_public) }.to raise_error(Transifex::ParametersFormatError)
+      end
+    end
+  end
+  describe "Fetch" do
+    it "should not raise an error and return an array of hash" do
+      fetched_projects = nil
+      expect{ fetched_projects = Transifex::Projects.fetch}.to_not raise_error
+      expect(fetched_projects).to be_a_kind_of(Array)
+      expect(fetched_projects).not_to match_array([]) 
+      expect(fetched_projects.first).to be_a_kind_of(Hash)
+      expect(fetched_projects.first.keys).to contain_exactly("slug", "name", "description","source_language_code")
+    end
+  end
+end

data/spec/lib/transifex/resource_content_spec.rb

@@ -0,0 +1,40 @@
+require_relative "../../spec_helper"
+
+describe Transifex::ResourceComponents::Content do 
+  before(:all) do
+    @project = Transifex::Project.new("projet-de-test-1")
+    @resource = @project.resource("test")
+  end
+
+  describe "Instanciation" do
+    it "should raise an error when no parameters given" do
+      expect{ Transifex::ResourceComponents::Content.new }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should retrieve the resource content as a hash" do
+      resource_content = nil
+      expect{ resource_content = @resource.content.fetch }.to_not raise_error
+      expect(resource_content).to be_a_kind_of(Hash)
+      expect(resource_content.keys).to contain_exactly("content", "mimetype")
+    end 
+
+    it "should retrieve the resource content as a file" do
+      resource_content = nil
+      path_to_file = File.dirname(__FILE__) + "/../yaml/resource_content_test.yml"
+      expect{ resource_content = @resource.content.fetch_with_file(path_to_file) }.to_not raise_error
+      file_exist = File.file?(path_to_file)
+      expect(file_exist).to eq(true)
+    end 
+  end
+
+  describe "Update" do
+    it "should not raise an error and update the resource content" do
+      expect{ @resource.content.update({:i18n_type => "YAML", :content => get_yaml_source_trad_file_path('en')}) }.to_not raise_error
+    end
+    it "should raise an error if updated resource content is of a different type than the previous" do
+      expect{ @resource.content.update({:i18n_type => "TXT", :content => get_yaml_source_trad_file_path('en')}) }.to raise_error(Transifex::Error)
+    end
+  end
+end

data/spec/lib/transifex/resource_source_spec.rb

@@ -0,0 +1,30 @@
+require_relative "../../spec_helper"
+
+describe Transifex::ResourceComponents::Source do 
+  before(:all) do
+    @project = Transifex::Project.new("projet-de-test-1")
+    @resource = @project.resource("test")
+  end
+
+  describe "Instanciation" do
+    it "should raise an error when no parameters given" do
+      expect{ Transifex::ResourceComponents::Source.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should retrieve the resource source string details as a hash" do
+      source_string_details = nil
+      expect{ source_string_details = @resource.source("routes.mercury_editor").fetch }.to_not raise_error
+      expect(source_string_details).to be_a_kind_of(Hash)
+      expect(source_string_details.keys).to contain_exactly("comment", "character_limit", "tags")
+    end 
+  end
+
+  describe "Update" do
+    it "should not raise an error and update the source string details" do
+      params = {:comment => "test", :character_limit => 140, :tags => ["tag1", "tag2"]}
+      expect{ @resource.source("routes.mercury_editor").update(params) }.to_not raise_error
+    end
+  end
+end

data/spec/lib/transifex/resource_spec.rb

@@ -0,0 +1,66 @@
+require_relative '../../spec_helper'
+
+describe Transifex::Resource do  
+
+  before(:all) do
+    @correct_params_public = {:slug => "resource_test_project", :name => "Projet de test resource", :description => "description", :source_language_code => "en", :repository_url => "http://en.google.com"} 
+    @project = Transifex::Projects.create(@correct_params_public)
+    @project.resources.create({:slug => "resource_test", :name => "resource_test", :i18n_type => "TXT", :content => "test"})   
+  end
+
+  it "should raise an error if project slug or Resource slug are not provided" do
+    expect{ Transifex::Resource.new(nil, "test") }.to raise_error(Transifex::MissingParametersError)
+    expect{ Transifex::Resource.new("test", nil) }.to raise_error(Transifex::MissingParametersError)
+  end
+
+  describe "Fetch" do
+    it "should raise an error if resource doesn't exist" do
+      expect{ @project.resource("wrong_slug").fetch }.to raise_error(Transifex::Error)
+    end
+
+    it "should not raise an error and retrieve the correct infos without details" do
+      fetched_resource = nil
+      expect{ fetched_resource = @project.resource("resource_test").fetch }.to_not raise_error
+      expect(fetched_resource).to be_a_kind_of(Hash)
+      expect(fetched_resource.keys).to contain_exactly("source_language_code", "name", "i18n_type", "priority", "slug", "categories")
+    end
+
+    it "should not raise an error and retrieve the correct infos with details" do
+      fetched_resource = nil
+      expect{ fetched_resource = @project.resource("resource_test").fetch_with_details }.to_not raise_error
+      expect(fetched_resource).to be_a_kind_of(Hash)
+      expect(fetched_resource.keys).to contain_exactly("source_language_code", "name", "created", "wordcount", "i18n_type", "project_slug", "accept_translations", "last_update", "priority", "available_languages", "total_entities", "slug", "categories")
+    end
+  end
+
+  describe "Update" do
+    it "should raise an error if resource doesn't exist" do
+      expect{ @project.resource("wrong_slug").update }.to raise_error(Transifex::Error)
+    end
+
+    it "should update multiple attributes" do
+      expect{ fetched_resource = @project.resource("resource_test").update({name: "new_name", categories: ["test1", "test2"]}) }.to_not raise_error
+      fetched_resource = @project.resource("resource_test").fetch
+      expect(fetched_resource['name']).to eq("new_name")
+      expect(fetched_resource['categories']).to be_a_kind_of(Array)
+      expect(fetched_resource['categories'].join(',')).to eq("test1,test2")
+    end
+  end
+
+  describe "Delete" do
+    it "should raise an error if resource doesn't exist" do
+      expect{ @project.resource("wrong_slug").delete }.to raise_error(Transifex::Error)
+    end
+
+    it "should delete a resource" do
+      @project.resources.create({:slug => "resource_delete_test", :name => "resource_delete_test", :i18n_type => "TXT", :content => "test"})
+      expect{ @project.resource("resource_delete_test").fetch }.to_not raise_error
+      expect{ @project.resource("resource_delete_test").delete }.to_not raise_error
+      expect{ @project.resource("resource_delete_test").fetch }.to raise_error
+    end
+  end
+
+  after(:all) do
+    @project.delete
+  end
+end

data/spec/lib/transifex/resources_spec.rb

@@ -0,0 +1,50 @@
+require_relative "../../spec_helper"
+
+describe Transifex::Resources do 
+
+  before(:all) do 
+    @correct_project = Transifex::Project.new("projet-de-test-1")
+    @wrong_project = Transifex::Project.new("lll")
+  end
+
+  it "should raise an error if instanciated without a project_slug" do
+    expect{ Transifex::Resources.new() }.to raise_error(Transifex::MissingParametersError)
+  end
+
+  describe "Fetch" do
+    it "should not raise any error and return a hash" do
+      resources_instance = @correct_project.resources
+      fetched_resources = nil
+      expect{ fetched_resources = resources_instance.fetch }.to_not raise_error
+      expect(fetched_resources).to be_a_kind_of(Array)
+      expect(fetched_resources.first).to be_a_kind_of(Hash)
+      expect(fetched_resources.first.keys).to contain_exactly("source_language_code", "name", "i18n_type", "priority", "slug", "categories")
+    end
+
+    it "should raise an error if project doesn't exist" do
+      resources_instance = @wrong_project.resources
+      fetched_resources = nil
+      expect{ fetched_resources = resources_instance.fetch }.to raise_error(Transifex::TransifexError)
+    end
+  end
+
+  describe "Create" do
+    it "should raise an error if required parameters are missing" do
+      expect{ @correct_project.resources.create }.to raise_error(Transifex::MissingParametersError)
+    end  
+
+    it "should create a new resource for the project without using a file" do
+      expect{ @correct_project.resources.create({:slug => "p", :name => "without_file", :i18n_type => "TXT", :content => "test"}) }.to_not raise_error
+    end
+
+    it "should create a new resource for the project using a file" do
+      options = {:trad_from_file => true}      
+      expect{ @correct_project.resources.create({:slug => "q", :name => "with_file", :i18n_type => "YAML", :content => get_yaml_source_trad_file_path('en')}, options) }.to_not raise_error
+    end
+  end
+
+  after(:all) do
+    @correct_project.resource("q").delete
+    @correct_project.resource("p").delete
+  end
+end

data/spec/lib/transifex/reviewers_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../../spec_helper'
+
+describe Transifex::ProjectComponents::LanguageComponents::Reviewers do
+  before(:all) do
+    @project = Transifex::Project.new("projet-de-test-1")
+  end
+
+  describe "Instanciation" do
+    it "should raise an error when no parameters given" do
+      expect{ Transifex::ProjectComponents::LanguageComponents::Reviewers.new }.to raise_error(Transifex::MissingParametersError)
+    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').reviewers.fetch }.to_not raise_error
+      expect(language_coordinators_infos).to be_a_kind_of(Hash)
+      expect(language_coordinators_infos.keys).to contain_exactly("reviewers")
+    end
+  end
+
+  describe "Update" do
+    it "should not raise an error and update the coordinators list" do
+      expect{ @project.language('en').reviewers.update(['fredericgrais'])}.to_not raise_error
+    end
+
+    it "should raise an error if the coordinator doesn't exist" do
+      expect{ @project.language('en').reviewers.update(['grgrgef'])}.to raise_error(Transifex::TransifexError)
+    end
+  end
+end