transifex-interface-ruby 0.0.1

data/spec/lib/transifex/stats_spec.rb

@@ -0,0 +1,34 @@
+require_relative "../../spec_helper"
+
+describe Transifex::ResourceComponents::Stats 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::Stats.new }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should retrieve the stats for all languages as a hash" do
+      resource_stats = nil
+      resource_details = @project.resource("test").fetch_with_details
+      resource_available_languages = resource_details["available_languages"].map{|language| language["code"]}
+      expect{ resource_stats = @resource.statistics.fetch }.to_not raise_error
+      expect(resource_stats).to be_a_kind_of(Hash)
+      expect(resource_stats.keys).to match_array(resource_available_languages)
+    end 
+    it "should retrieve the stats for a specific language as a hash" do
+      resource_stats = nil
+      expect{ resource_stats = @resource.statistics.fetch("en") }.to_not raise_error
+      expect(resource_stats).to be_a_kind_of(Hash)
+      expect(resource_stats.keys).to contain_exactly("reviewed_percentage", "completed", "untranslated_words", "last_commiter", "reviewed", "translated_entities", "translated_words", "last_update", "untranslated_entities")
+    end
+  end
+
+
+
+end

data/spec/lib/transifex/translation_spec.rb

@@ -0,0 +1,53 @@
+require_relative "../../spec_helper"
+
+describe Transifex::ResourceComponents::Translation 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::Translation.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should raise an error if no language code is provided" do
+      expect{ resource_stats = @resource.translation.fetch }.to raise_error(Transifex::MissingParametersError)
+    end
+    it "should retrieve the translation content as a hash" do
+      translation_content = nil
+      expect{ translation_content = @resource.translation('en').fetch }.to_not raise_error
+      expect(translation_content).to be_a_kind_of(Hash)
+      expect(translation_content.keys).to contain_exactly("content", "mimetype")
+    end
+    it "should retrieve the translation content as a file with default mode" do
+      translation_content = nil
+      path_to_file = File.dirname(__FILE__) + "/../yaml/resource_translation_default_content_test.yml"
+      options = {:path_to_file => path_to_file}
+      expect{ translation_content = @resource.translation('fr').fetch_with_file(options) }.to_not raise_error
+      file_exist = File.file?(path_to_file)
+      expect(file_exist).to eq(true)
+    end      
+    it "should retrieve the translation content as a file with a mode" do
+      translation_content = nil
+      path_to_file = File.dirname(__FILE__) + "/../yaml/resource_translation_reviewed_content_test.yml"
+      options = {:path_to_file => path_to_file, :mode => "reviewed"}      
+      expect{ translation_content = @resource.translation('en').fetch_with_file(options) }.to_not raise_error
+      file_exist = File.file?(path_to_file)
+      expect(file_exist).to eq(true)
+    end
+  end
+
+  describe "Update" do
+    it "sould raise an error if try to update source language" do
+      options = {:i18n_type => "YAML", :content => get_yaml_source_trad_file_path('en')}
+      expect{ translation_content = @resource.translation('en').update(options) }.to raise_error(Transifex::TransifexError)
+    end
+    it "should not raise an error and update the resource translation" do
+      options = {:i18n_type => "YAML", :content => get_yaml_source_trad_file_path('fr')}
+      expect{ @resource.translation('fr').update(options) }.to_not raise_error
+    end
+  end
+end

data/spec/lib/transifex/translation_string_spec.rb

@@ -0,0 +1,33 @@
+require_relative "../../spec_helper"
+
+describe Transifex::ResourceComponents::TranslationComponents::String 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::TranslationComponents::String.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should raise an error if no key provided" do
+      expect{ retrieved_details = @resource.translation('en').string.fetch }.to raise_error(Transifex::MissingParametersError)
+    end
+    it "should not raise an error and retrieve the details of the string" do
+      retrieved_details = nil
+      expect{ retrieved_details = @resource.translation('en').string('routes.mercury_editor').fetch }.to_not raise_error
+      expect(retrieved_details).to be_a_kind_of(Hash)
+      expect(retrieved_details.keys).to contain_exactly("comment", "context", "tags", "character_limit", "user", "key", "reviewed", "pluralized", "source_string", "translation", "last_update", "occurrences")
+    end
+  end
+
+  describe "Update" do
+    it "should not raise an error and update the specified translation string" do
+      params = {:reviewed => true, :translation => "Pouet"}
+      expect{ @resource.translation('fr').string('routes.mercury_editor').update(params) }.to_not raise_error
+    end
+  end
+end

data/spec/lib/transifex/translation_strings_spec.rb

@@ -0,0 +1,57 @@
+require_relative "../../spec_helper"
+
+describe Transifex::ResourceComponents::TranslationComponents::Strings 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::TranslationComponents::Strings.new }.to raise_error(Transifex::MissingParametersError)
+    end
+  end
+
+  describe "Fetch" do
+    it "should not raise an error and retrieve the strings of the translation without details" do
+      retrieved_strings = nil
+      expect{ retrieved_strings = @resource.translation('en').strings.fetch }.to_not raise_error
+      expect(retrieved_strings).to be_a_kind_of(Array)
+      expect(retrieved_strings.first.keys).to contain_exactly("comment", "context", "key", "reviewed", "pluralized", "source_string", "translation")
+    end
+    it "should not raise an error and retrieve the strings of the translation with details" do
+      retrieved_strings = nil
+      expect{ retrieved_strings = @resource.translation('en').strings.fetch_with_details }.to_not raise_error
+      expect(retrieved_strings).to be_a_kind_of(Array)
+      expect(retrieved_strings.first.keys).to contain_exactly("comment", "context", "tags", "character_limit", "user", "key", "reviewed", "pluralized", "source_string", "translation", "last_update", "occurrences")
+    end
+    it "should not raise an error and retrieve the strings of the translation with the key" do
+      retrieved_strings = nil
+      options = {:key => "routes.mercury_editor"}
+      expect{ retrieved_strings = @resource.translation('en').strings.fetch_with_details(options) }.to_not raise_error
+      expect(retrieved_strings).to be_a_kind_of(Array)
+      expect(retrieved_strings.first.keys).to contain_exactly("comment", "context", "tags", "character_limit", "user", "key", "reviewed", "pluralized", "source_string", "translation", "last_update", "occurrences")
+    end
+    it "should not raise an error and return an empty hash if researched context doesn't exist" do
+      retrieved_strings = nil
+      options = {:context => "notexist"}
+      expect{ retrieved_strings = @resource.translation('en').strings.fetch(options) }.to_not raise_error
+      expect(retrieved_strings).to be_a_kind_of(Array)
+      empty_array = retrieved_strings.empty?      
+      expect(empty_array).to eq(true)
+    end
+  end
+
+  describe "Update" do
+    it "should raise an error if the key parameter is not provided" do
+      expect{ @resource.translation('fr').strings.update({:translation => "lol"}) }.to raise_error(Transifex::MissingParametersError)
+    end
+    it "should not raise an error and update the specified translation string" do
+      expect{ @resource.translation('fr').strings.update({:key => "routes.mercury_editor", :translation => "lol"}) }.to_not raise_error
+    end
+    it "should not raise an error and update multiple translation strings" do
+      params = [{:key => "routes.mercury_editor", :context => "", :translation => "lol"}, {:key => "date.abbr_day_names", :translation => "lol"}]
+      expect{ @resource.translation('fr').strings.update(params) }.to_not raise_error
+    end
+  end
+end

data/spec/lib/transifex/translators_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../../spec_helper'
+
+describe Transifex::ProjectComponents::LanguageComponents::Translators 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::Translators.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').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")
+    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
+    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)
+    end
+  end
+end

data/spec/lib/yaml/en.yml

@@ -0,0 +1,26 @@
+en:  
+  routes:
+    mercury_editor: mercury_editor
+  date:
+    abbr_day_names:
+    - Sun
+    - Mon
+    - Tue
+    - Wed
+    - Thu
+    - Fri
+    - Sat
+    abbr_month_names:
+    -
+    - Jan
+    - Feb
+    - Mar
+    - Apr
+    - May
+    - Jun
+    - Jul
+    - Aug
+    - Sep
+    - Oct
+    - Nov
+    - Dec

data/spec/lib/yaml/fr.yml

@@ -0,0 +1,4 @@
+fr:  
+  test: coucou
+  routes:
+    mercury_editor: éditeur mercury

data/spec/lib/yaml/resource_content_test.yml

@@ -0,0 +1,27 @@
+---
+en:
+  routes:
+    mercury_editor: mercury_editor
+  date:
+    abbr_day_names:
+    - Sun
+    - Mon
+    - Tue
+    - Wed
+    - Thu
+    - Fri
+    - Sat
+    abbr_month_names:
+    - 
+    - Jan
+    - Feb
+    - Mar
+    - Apr
+    - May
+    - Jun
+    - Jul
+    - Aug
+    - Sep
+    - Oct
+    - Nov
+    - Dec

data/spec/lib/yaml/resource_translation_default_content_test.yml

@@ -0,0 +1,4 @@
+---
+fr:
+  routes:
+    mercury_editor: éditeur mercury

data/spec/lib/yaml/resource_translation_reviewed_content_test.yml

@@ -0,0 +1,9 @@
+---
+en:
+  routes:
+    mercury_editor: ''
+  date:
+    abbr_day_names:
+    - ''
+    abbr_month_names:
+    - ''

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+require 'bundler/setup'
+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"
+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'
+  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
+  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
+end

data/transifex-interface-ruby.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transifex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transifex-interface-ruby"
+  spec.version       = Transifex::VERSION
+  spec.authors       = ["Fred-grais"]
+  spec.email         = ["frederic.grais@gmail.com"]
+  spec.description   = %q{A Transifex API interface written in Ruby}
+  spec.summary       = %q{This gem allows you to communicate with the Transifex API to perform every possible actions listed in the documentation: http://docs.transifex.com/developer/api/}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency('rails', '~> 4.0.0')
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: transifex-interface-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fred-grais
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: A Transifex API interface written in Ruby
+email:
+- frederic.grais@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transifex.rb
+- lib/transifex/crud_requests.rb
+- lib/transifex/errors.rb
+- lib/transifex/formats.rb
+- lib/transifex/json.rb
+- lib/transifex/language.rb
+- lib/transifex/languages.rb
+- lib/transifex/project.rb
+- lib/transifex/project_components/language.rb
+- lib/transifex/project_components/language_components/coordinators.rb
+- lib/transifex/project_components/language_components/reviewers.rb
+- lib/transifex/project_components/language_components/translators.rb
+- lib/transifex/project_components/languages.rb
+- lib/transifex/projects.rb
+- lib/transifex/resource.rb
+- lib/transifex/resource_components/content.rb
+- lib/transifex/resource_components/source.rb
+- lib/transifex/resource_components/stats.rb
+- lib/transifex/resource_components/translation.rb
+- lib/transifex/resource_components/translation_components/string.rb
+- lib/transifex/resource_components/translation_components/strings.rb
+- lib/transifex/resource_components/translation_components/utilities.rb
+- lib/transifex/resources.rb
+- lib/transifex/version.rb
+- spec/lib/transifex/configuration_spec.rb
+- spec/lib/transifex/coordinators_spec.rb
+- spec/lib/transifex/formats_spec.rb
+- spec/lib/transifex/language_spec.rb
+- spec/lib/transifex/languages_spec.rb
+- spec/lib/transifex/project_language_spec.rb
+- spec/lib/transifex/project_languages_spec.rb
+- spec/lib/transifex/project_spec.rb
+- spec/lib/transifex/projects_spec.rb
+- spec/lib/transifex/resource_content_spec.rb
+- spec/lib/transifex/resource_source_spec.rb
+- spec/lib/transifex/resource_spec.rb
+- spec/lib/transifex/resources_spec.rb
+- spec/lib/transifex/reviewers_spec.rb
+- spec/lib/transifex/stats_spec.rb
+- spec/lib/transifex/translation_spec.rb
+- spec/lib/transifex/translation_string_spec.rb
+- spec/lib/transifex/translation_strings_spec.rb
+- spec/lib/transifex/translators_spec.rb
+- spec/lib/yaml/en.yml
+- spec/lib/yaml/fr.yml
+- spec/lib/yaml/resource_content_test.yml
+- spec/lib/yaml/resource_translation_default_content_test.yml
+- spec/lib/yaml/resource_translation_reviewed_content_test.yml
+- spec/spec_helper.rb
+- transifex-interface-ruby.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ! 'This gem allows you to communicate with the Transifex API to perform every
+  possible actions listed in the documentation: http://docs.transifex.com/developer/api/'
+test_files:
+- spec/lib/transifex/configuration_spec.rb
+- spec/lib/transifex/coordinators_spec.rb
+- spec/lib/transifex/formats_spec.rb
+- spec/lib/transifex/language_spec.rb
+- spec/lib/transifex/languages_spec.rb
+- spec/lib/transifex/project_language_spec.rb
+- spec/lib/transifex/project_languages_spec.rb
+- spec/lib/transifex/project_spec.rb
+- spec/lib/transifex/projects_spec.rb
+- spec/lib/transifex/resource_content_spec.rb
+- spec/lib/transifex/resource_source_spec.rb
+- spec/lib/transifex/resource_spec.rb
+- spec/lib/transifex/resources_spec.rb
+- spec/lib/transifex/reviewers_spec.rb
+- spec/lib/transifex/stats_spec.rb
+- spec/lib/transifex/translation_spec.rb
+- spec/lib/transifex/translation_string_spec.rb
+- spec/lib/transifex/translation_strings_spec.rb
+- spec/lib/transifex/translators_spec.rb
+- spec/lib/yaml/en.yml
+- spec/lib/yaml/fr.yml
+- spec/lib/yaml/resource_content_test.yml
+- spec/lib/yaml/resource_translation_default_content_test.yml
+- spec/lib/yaml/resource_translation_reviewed_content_test.yml
+- spec/spec_helper.rb